AppMetricaCrashes class

This class provides functions for sending error and crash messages for AppMetrica integration.

Instance methods

Method descriptions

crashes(crashes())

class crashes(crashes()) as? Self!

Accesses the AppMetricaCrashes singleton.

Returns:

The AppMetricaCrashes singleton.

setConfiguration()

class func setConfiguration(_ configuration: AppMetricaCrashesConfiguration?)

Configures the error messaging mechanism for the app. To enable or disable specific types of error messages and configure associated parameters, use the properties of the AppMetricaCrashesConfiguration class. Once set up, the configuration controls how the app handles different types of errors and issues.

Parameter:

Example:

let config = AppMetricaCrashesConfiguration()
config.autoCrashTracking = true
config.probablyUnhandledCrashReporting = false
config.applicationNotRespondingDetection = true
config.applicationNotRespondingWatchdogInterval = 5.0
AppMetricaCrashes().configuration = config

reportNSError(_:onFailure:)

class func reportNSError(_ error: (any Error)?, onFailure: ((_ error: (any Error)?) -> Void)? = nil)

Sends an NSError message that is subject to certain restrictions on domain, userInfo, and other properties.

You can enable NSError backtracing by using the BacktraceErrorKey constant in the userInfo property.

Restrictions:

• domain: No more than 200 characters.
• userInfo: No more than 50 key-value pairs with keys no longer than 100 characters and values no longer than 2000 characters.
• NSUnderlyingErrorKey: Using this key in userInfo enables you to include up to 10 errors.
• BacktraceErrorKey: Using this key in userInfo allows you to include up to 200 stack frames in the backtrace.

AppMetrica truncates the value if it exceeds the specified limit.

Parameters:

reportNSError(_:options:onFailure:)

class func reportNSError(_ error: (any Error)?, options: ErrorReportingOptions, onFailure: ((_ error: (any Error)?) -> Void)? = nil)

Sends a custom NSError message that adheres to the restrictions on domain, userInfo, and other properties.

You can enable NSError backtracing by using the BacktraceErrorKey constant in the userInfo property.

Restrictions:

• domain: No more than 200 characters.
• userInfo: No more than 50 key-value pairs with keys no longer than 100 characters and values no longer than 2000 characters.
• NSUnderlyingErrorKey: Using this key in userInfo enables you to include up to 10 errors.
• BacktraceErrorKey: Using this key in userInfo allows you to include up to 200 stack frames in the backtrace.

AppMetrica truncates the value if it exceeds any of these limits.

Parameters:

reportError(_:onFailure:)

class func reportError(_ error: (any ErrorRepresentable)?, onFailure: ((_ error: (any Error)?) -> Void)? = nil)

Sends a message about an error matching the ErrorRepresentable protocol.

Parameters:

reportError(_:options:onFailure:)

class func reportError(_ error: (any ErrorRepresentable)?, options: ErrorReportingOptions, onFailure: ((_ error: (any Error)?) -> Void)? = nil)

Sends a message about an error matching the ErrorRepresentable protocol, with additional options for message customization.

Parameters:

setErrorEnvironmentValue(_:forKey:)

class func setErrorEnvironmentValue(_ value: String?, forKey key: String?)

Sets the key-value pair that will be associated with errors and crashes. AppMetrica uses it as additional information for unhandled exceptions.

Parameters:

clearErrorEnvironment()

class func clearErrorEnvironment()

Deletes all previously set key-value pairs associated with errors and crashes.

This method ensures that future unhandled exceptions won't have any extra information added, unless you set new key-value pairs.

To set a key-value pair, use -setErrorEnvironmentValue:forKey:.

requestCrashReportingState(WithCompletionQueue:completionBlock:)

class func requestCrashReportingState(withCompletionQueue completionQueue: DispatchQueue, completionBlock: CrashReportingStateCompletionBlock)

This method asynchronously fetches the current status of error messages and returns it via the completion block.

For more information about the dictionary with keys and their associated values, see CrashReportingStateCompletionBlock.

Parameters:

enableANRMonitoring()

class func enableANRMonitoring()

Enables "Application Not Responding" (ANR) status monitoring with default parameters.

Use this method to enable ANR monitoring after activation only. To enable ANR monitoring during activation, use the applicationNotRespondingDetection property in AppMetricaCrashesConfiguration.

Default parameters:

• watchdog: 4 seconds
• ping: 0.1 seconds

enableANRMonitoring(WithWatchdogInterval:pingInterval:)

class func enableANRMonitoring(withWatchdogInterval watchdog: TimeInterval, pingInterval ping: TimeInterval)

Enables "Application Not Responding" (ANR) status monitoring after activation only. To enable ANR monitoring during activation, use the applicationNotRespondingDetection property in AppMetricaCrashesConfiguration.

Parameters:

reporter(ForAPIKey:)

class func reporter(forAPIKey apiKey: String?) -> (any AppMetricaCrashReporting)?

Returns an id<AppMetricaCrashReporting> that can send messages to a specific API key.

Parameter:

Returns:

An id<AppMetricaCrashReporting> that matches the AppMetricaCrashReporting protocol and allows sending messages to a specific API key.

pluginExtension()

class func pluginExtension() -> (any AppMetricaPlugins)?

Creates an AppMetricaPlugins instance that can send plugin events to the main API key. You can request it every time or store a reference for future use. To use this extension, first activate AppMetrica with the [AppMetrica activateWithConfiguration:] method.

Returns:

A plugin extension instance.