Package io.appmetrica.analytics

Class ReporterConfig

java.lang.Object

io.appmetrica.analytics.ReporterConfig

public class ReporterConfig
extends Object

Contains configuration of analytic processing in IReporter. Configuration created by ReporterConfig.Builder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReporterConfig.Builder	Builds a new ReporterConfig object.

Field Summary

Fields

Modifier and Type	Field	Description
final Map<String,Object>	additionalConfig	Additional configs
final String	apiKey	Unique identifier of app in AppMetrica.
final Map<String,String>	appEnvironment	Application environment to be set after initialization
final Boolean	dataSendingEnabled	Indicates whether data should be sent to the AppMetrica server.
final Integer	dispatchPeriodSeconds	Timeout for sending reports
final Boolean	logs	Indicates whether logging for appropriate IReporter enabled
final Integer	maxReportsCount	Maximum buffer size for reports
final Integer	maxReportsInDatabaseCount	Maximum number of reports to store in database.
final Integer	sessionTimeout	Duration of AppMetrica foreground session timeout.
final String	userProfileID	The ID of the user profile.

Method Summary

Modifier and Type	Method	Description
static ReporterConfig.Builder	newConfigBuilder(String apiKey)	Creates the new instance of ReporterConfig.Builder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

apiKey

@NonNull
public final String apiKey

Unique identifier of app in AppMetrica.

See Also:

• newConfigBuilder(String)

sessionTimeout

@Nullable
public final Integer sessionTimeout

Duration of AppMetrica foreground session timeout.

See Also:

• ReporterConfig.Builder.withSessionTimeout(int)

dataSendingEnabled

@Nullable
public final Boolean dataSendingEnabled

Indicates whether data should be sent to the AppMetrica server.

See Also:

• ReporterConfig.Builder.withDataSendingEnabled(boolean)

maxReportsInDatabaseCount

@Nullable
public final Integer maxReportsInDatabaseCount

Maximum number of reports to store in database. Default value is 1000. Must be in range [100; 10000]. If not, closest possible value will be used.

See Also:

• ReporterConfig.Builder.withMaxReportsInDatabaseCount(int)

userProfileID

@Nullable
public final String userProfileID

The ID of the user profile. NOTE: The string value can contain up to 200 characters.

See Also:

• ReporterConfig.Builder.withUserProfileID(String)

logs

@Nullable
public final Boolean logs

Indicates whether logging for appropriate IReporter enabled

true if enabled, false if not

See Also:

• ReporterConfig.Builder.withLogs()

dispatchPeriodSeconds

@Nullable
public final Integer dispatchPeriodSeconds

Timeout for sending reports

See Also:

• ReporterConfig.Builder.withDispatchPeriodSeconds(int)

maxReportsCount

@Nullable
public final Integer maxReportsCount

Maximum buffer size for reports

See Also:

• ReporterConfig.Builder.withMaxReportsCount(int)

appEnvironment

public final Map<String,String> appEnvironment

Application environment to be set after initialization

See Also:

• ReporterConfig.Builder.withAppEnvironmentValue(String, String)

additionalConfig

@NonNull
public final Map<String,Object> additionalConfig

Additional configs

See Also:

• ReporterConfig.Builder.withAdditionalConfig(String, Object)

Method Details

newConfigBuilder

@NonNull
public static ReporterConfig.Builder newConfigBuilder(@NonNull
 String apiKey)

Creates the new instance of ReporterConfig.Builder

Parameters:

apiKey - API_KEY - unique identifier of app in AppMetrica.

Returns:

builder of ReporterConfig

Throws:

IllegalArgumentException - if apiKey is null, empty or has invalid format.

See Also:

• AppMetrica SDK documentation