YMMReporterConfiguration class

This class contains the extended immutable configuration of the reporter.

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

Instance methods

-initWithApiKey:

Initializes an instance of the class YMMReporterConfiguration with the specified API key.

-initWithApiKey:

Initializes an instance of the class YMMReporterConfiguration with the specified API key.

Properties

apiKey API key that differs from the main application API key.
logs

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

maxReportsInDatabaseCount

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

sessionTimeout

Session timeout in seconds.

statisticsSending

A flag indicating that sending statistics is enabled.

userProfileID

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

apiKey API key that differs from the main application API key.
logs

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

maxReportsInDatabaseCount

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

sessionTimeout

Session timeout in seconds.

statisticsSending

A flag indicating that sending statistics is enabled.

userProfileID

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

Method descriptions

-initWithApiKey:

- (instancetype)initWithApiKey:(NSString *)apiKey

Initializes an instance of the class YMMReporterConfiguration with the specified API key.

Parameters:
apiKey API key that differs from the main application API key.
apiKey API key that differs from the main application API key.

Returns:

The instance of the YMMReporterConfiguration class.

Property descriptions

apiKey

(nonatomic, copy, nullable, readonly) NSString *apiKey

API key that differs from the main application API key.

logs

(nonatomic, assign, readonly) BOOL logs

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.

maxReportsInDatabaseCount

@property (readonly, assign, nonatomic) NSUInteger maxReportsInDatabaseCount;

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

The allowed range of values is [100; 10000]. 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 YMMYandexMetricaConfiguration.maxReportsInDatabaseCount.

sessionTimeout

(nonatomic, assign, readonly) NSUInteger sessionTimeout

Session timeout in seconds.

The default value is 10 (minimum allowed value).

statisticsSending

(nonatomic, assign, readonly) BOOL statisticsSending

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.

userProfileID

(nonatomic, copy, nullable) NSString *userProfileID

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

Attention. The maximum length of the ProfileID string is 200 characters.