ReporterConfiguration class

This class contains the extended immutable configuration of the reporter.

Use the MutableReporterConfiguration class to change the configuration of a reporter.

Instance methods

init?(apiKey:)

Initializes the instance of the ReporterConfiguration class with the specified API key.

Properties

apiKey

API key that differs from the main application API key.

areLogsEnabled

A flag indicating that the logging of the reporter is enabled.

dataSendingEnabled

A flag indicating that sending statistics is enabled.

dispatchPeriod

Time interval between sending events in seconds.

maxReportsCount

Sending events is triggered when the number of events reaches maxReportsCount.

maxReportsInDatabaseCount

The maximum number of error reports stored in the internal DB.

sessionTimeout

Session timeout in seconds.

userProfileID

Sets the ID of the user profile (ProfileID) when activated.

Method descriptions

init?(apiKey:)

init?(apiKey: String)

Initializes the instance of the ReporterConfiguration class with the specified API key.

Parameters:

apiKey

API key that differs from the main application API key.

Returns:

The ReporterConfiguration class instance.

Property descriptions

apiKey

var apiKey: String? { get }

API key that differs from the main application API key.

areLogsEnabled

var areLogsEnabled: Bool { get }

The flag indicating that the logging of the reporter is enabled.

The default value is NO.

Possible values:

  • YES: Reporter logging is enabled.
  • NO: Reporter logging is disabled.

dataSendingEnabled

var dataSendingEnabled: Bool { get }

A flag indicating that sending statistics is enabled. The default value is YES.

Possible values:

  • YES: Sending statistics is enabled.
  • NO: Sending statistics is disabled.

dispatchPeriod

var dispatchPeriod: UInt { get }

Time interval between sending events in seconds.

maxReportsCount

var maxReportsCount: UInt { get }

Sending events is triggered when the number of events reaches maxReportsCount.

maxReportsInDatabaseCount

var maxReportsInDatabaseCount { get }

The maximum number of error reports stored in the internal DB.

The allowed range of values is [100; 10,000]. Values outside this range are automatically replaced with values from the nearest range limits.

Default value: 1000.

Note

Separate databases are used for various apiKeys and independent limits on the number of events can be set for them. This parameter only affects the limitation for the corresponding apiKey. To change the maximum allowed number of events for other apiKeys, use AppMetricaConfiguration.maxReportsInDatabaseCount.

sessionTimeout

var sessionTimeout: UInt { get }

Session timeout in seconds.

The default value is 10 (minimum allowed value).

userProfileID

var userProfileID: String? { get }

Sets the ID of the user profile (ProfileID) when activated.

Alert

The maximum length of the ProfileID string is 200 characters.