com.snowplowanalytics.snowplow.configuration

Class TrackerConfiguration

java.lang.Object

com.snowplowanalytics.snowplow.configuration.TrackerConfiguration

All Implemented Interfaces:

Configuration, com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface, Serializable

public class TrackerConfiguration
extends Object
implements com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface, Configuration

This class represents the configuration of the tracker and the core tracker properties. The TrackerConfiguration can be used to setup the tracker behaviour indicating what should be tracked in term of automatic tracking and contexts/entities to track with the events.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	appId
boolean	applicationContext
boolean	base64encoding
boolean	deepLinkContext
DevicePlatform	devicePlatform
boolean	diagnosticAutotracking
boolean	exceptionAutotracking
boolean	geoLocationContext
boolean	installAutotracking
boolean	lifecycleAutotracking
LoggerDelegate	loggerDelegate
LogLevel	logLevel
boolean	platformContext
boolean	screenContext
boolean	screenViewAutotracking
boolean	sessionContext
static String	TAG
String	trackerVersionSuffix

Constructor Summary

Constructors

Constructor and Description
TrackerConfiguration(String appId) It sets a default TrackerConfiguration.
TrackerConfiguration(String appId, JSONObject jsonObject)

Method Summary

Modifier and Type	Method and Description
TrackerConfiguration	appId(String appId) Identifer of the app.
TrackerConfiguration	applicationContext(boolean applicationContext) Whether application context is sent with all the tracked events.
TrackerConfiguration	base64encoding(boolean base64encoding) It indicates whether the JSON data in the payload should be base64 encoded.
Configuration	copy()
TrackerConfiguration	deepLinkContext(boolean deepLinkContext) Whether deepLink context is sent with all the ScreenView events.
TrackerConfiguration	devicePlatform(DevicePlatform devicePlatform) It sets the device platform the tracker is running on.
TrackerConfiguration	diagnosticAutotracking(boolean diagnosticAutotracking) Whether enable diagnostic reporting.
TrackerConfiguration	exceptionAutotracking(boolean exceptionAutotracking) Whether enable crash reporting.
TrackerConfiguration	geoLocationContext(boolean geoLocationContext) Whether geo-location context is sent with all the tracked events.
String	getAppId()
DevicePlatform	getDevicePlatform()
LoggerDelegate	getLoggerDelegate()
LogLevel	getLogLevel()
String	getTrackerVersionSuffix()
TrackerConfiguration	installAutotracking(boolean installAutotracking) Whether enable automatic tracking of install event.
boolean	isApplicationContext()
boolean	isBase64encoding()
boolean	isDeepLinkContext()
boolean	isDiagnosticAutotracking()
boolean	isExceptionAutotracking()
boolean	isGeoLocationContext()
boolean	isInstallAutotracking()
boolean	isLifecycleAutotracking()
boolean	isPlatformContext()
boolean	isScreenContext()
boolean	isScreenViewAutotracking()
boolean	isSessionContext()
TrackerConfiguration	lifecycleAutotracking(boolean lifecycleAutotracking) Whether enable automatic tracking of background and foreground transitions.
TrackerConfiguration	loggerDelegate(LoggerDelegate loggerDelegate) It sets the logger delegate that receive logs from the tracker.
TrackerConfiguration	logLevel(LogLevel logLevel) It sets the log level of tracker logs.
TrackerConfiguration	platformContext(boolean platformContext) Whether mobile/platform context is sent with all the tracked events.
TrackerConfiguration	screenContext(boolean screenContext) Whether screen context is sent with all the tracked events.
TrackerConfiguration	screenViewAutotracking(boolean screenViewAutotracking) Whether enable automatic tracking of ScreenView events.
TrackerConfiguration	sessionContext(boolean sessionContext) Whether session context is sent with all the tracked events.
void	setAppId(String appId)
void	setApplicationContext(boolean applicationContext)
void	setBase64encoding(boolean base64encoding)
void	setDeepLinkContext(boolean deepLinkContext)
void	setDevicePlatform(DevicePlatform devicePlatform)
void	setDiagnosticAutotracking(boolean diagnosticAutotracking)
void	setExceptionAutotracking(boolean exceptionAutotracking)
void	setGeoLocationContext(boolean geoLocationContext)
void	setInstallAutotracking(boolean installAutotracking)
void	setLifecycleAutotracking(boolean lifecycleAutotracking)
void	setLoggerDelegate(LoggerDelegate loggerDelegate)
void	setLogLevel(LogLevel logLevel)
void	setPlatformContext(boolean platformContext)
void	setScreenContext(boolean screenContext)
void	setScreenViewAutotracking(boolean screenViewAutotracking)
void	setSessionContext(boolean sessionContext)
void	setTrackerVersionSuffix(String trackerVersionSuffix)
TrackerConfiguration	trackerVersionSuffix(String trackerVersionSuffix) Decorate the v_tracker field in the tracker protocol.

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final String TAG

appId

@NonNull
public String appId

See Also:

appId(String)

devicePlatform

@NonNull
public DevicePlatform devicePlatform

See Also:

devicePlatform(DevicePlatform)

base64encoding

public boolean base64encoding

See Also:

base64encoding(boolean)

logLevel

@NonNull
public LogLevel logLevel

See Also:

logLevel(LogLevel)

loggerDelegate

@Nullable
public LoggerDelegate loggerDelegate

See Also:

loggerDelegate(LoggerDelegate)

applicationContext

public boolean applicationContext

See Also:

applicationContext(boolean)

platformContext

public boolean platformContext

See Also:

platformContext(boolean)

geoLocationContext

public boolean geoLocationContext

See Also:

geoLocationContext(boolean)

sessionContext

public boolean sessionContext

See Also:

sessionContext(boolean)

deepLinkContext

public boolean deepLinkContext

See Also:

deepLinkContext(boolean)

screenContext

public boolean screenContext

See Also:

screenContext(boolean)

screenViewAutotracking

public boolean screenViewAutotracking

See Also:

screenViewAutotracking(boolean)

lifecycleAutotracking

public boolean lifecycleAutotracking

See Also:

lifecycleAutotracking(boolean)

installAutotracking

public boolean installAutotracking

See Also:

installAutotracking(boolean)

exceptionAutotracking

public boolean exceptionAutotracking

See Also:

exceptionAutotracking(boolean)

diagnosticAutotracking

public boolean diagnosticAutotracking

See Also:

diagnosticAutotracking(boolean)

trackerVersionSuffix

@Nullable
public String trackerVersionSuffix

See Also:

trackerVersionSuffix(String)

Constructor Detail

TrackerConfiguration

public TrackerConfiguration(@NonNull
                            String appId)

It sets a default TrackerConfiguration. Default values: devicePlatform = DevicePlatform.Mobile; base64encoding = true; logLevel = LogLevel.OFF; loggerDelegate = null; sessionContext = true; applicationContext = true; platformContext = true; geoLocationContext = false; screenContext = true; deepLinkContext = true; screenViewAutotracking = true; lifecycleAutotracking = false; installAutotracking = true; exceptionAutotracking = true; diagnosticAutotracking = false;

Parameters:

appId - Identifier of the app.

TrackerConfiguration

public TrackerConfiguration(@NonNull
                            String appId,
                            @NonNull
                            JSONObject jsonObject)

Method Detail

getAppId

@NonNull
public String getAppId()

Specified by:

getAppId in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

setAppId

public void setAppId(@NonNull
                     String appId)

Specified by:

setAppId in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

getDevicePlatform

@NonNull
public DevicePlatform getDevicePlatform()

Specified by:

getDevicePlatform in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

setDevicePlatform

public void setDevicePlatform(@NonNull
                              DevicePlatform devicePlatform)

Specified by:

setDevicePlatform in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

isBase64encoding

public boolean isBase64encoding()

Specified by:

isBase64encoding in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

setBase64encoding

public void setBase64encoding(boolean base64encoding)

Specified by:

setBase64encoding in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

getLogLevel

@NonNull
public LogLevel getLogLevel()

Specified by:

getLogLevel in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

setLogLevel

public void setLogLevel(@NonNull
                        LogLevel logLevel)

Specified by:

setLogLevel in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

getLoggerDelegate

@Nullable
public LoggerDelegate getLoggerDelegate()

Specified by:

getLoggerDelegate in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

setLoggerDelegate

public void setLoggerDelegate(@Nullable
                              LoggerDelegate loggerDelegate)

Specified by:

setLoggerDelegate in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

isApplicationContext

public boolean isApplicationContext()

Specified by:

isApplicationContext in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

setApplicationContext

public void setApplicationContext(boolean applicationContext)

Specified by:

setApplicationContext in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

isPlatformContext

public boolean isPlatformContext()

Specified by:

isPlatformContext in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

setPlatformContext

public void setPlatformContext(boolean platformContext)

Specified by:

setPlatformContext in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

isGeoLocationContext

public boolean isGeoLocationContext()

Specified by:

isGeoLocationContext in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

setGeoLocationContext

public void setGeoLocationContext(boolean geoLocationContext)

Specified by:

setGeoLocationContext in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

isSessionContext

public boolean isSessionContext()

Specified by:

isSessionContext in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

setSessionContext

public void setSessionContext(boolean sessionContext)

Specified by:

setSessionContext in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

isDeepLinkContext

public boolean isDeepLinkContext()

Specified by:

isDeepLinkContext in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

setDeepLinkContext

public void setDeepLinkContext(boolean deepLinkContext)

Specified by:

setDeepLinkContext in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

isScreenContext

public boolean isScreenContext()

Specified by:

isScreenContext in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

setScreenContext

public void setScreenContext(boolean screenContext)

Specified by:

setScreenContext in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

isScreenViewAutotracking

public boolean isScreenViewAutotracking()

Specified by:

isScreenViewAutotracking in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

setScreenViewAutotracking

public void setScreenViewAutotracking(boolean screenViewAutotracking)

Specified by:

setScreenViewAutotracking in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

isLifecycleAutotracking

public boolean isLifecycleAutotracking()

Specified by:

isLifecycleAutotracking in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

setLifecycleAutotracking

public void setLifecycleAutotracking(boolean lifecycleAutotracking)

Specified by:

setLifecycleAutotracking in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

isInstallAutotracking

public boolean isInstallAutotracking()

Specified by:

isInstallAutotracking in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

setInstallAutotracking

public void setInstallAutotracking(boolean installAutotracking)

Specified by:

setInstallAutotracking in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

isExceptionAutotracking

public boolean isExceptionAutotracking()

Specified by:

isExceptionAutotracking in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

setExceptionAutotracking

public void setExceptionAutotracking(boolean exceptionAutotracking)

Specified by:

setExceptionAutotracking in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

isDiagnosticAutotracking

public boolean isDiagnosticAutotracking()

Specified by:

isDiagnosticAutotracking in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

setDiagnosticAutotracking

public void setDiagnosticAutotracking(boolean diagnosticAutotracking)

Specified by:

setDiagnosticAutotracking in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

getTrackerVersionSuffix

@Nullable
public String getTrackerVersionSuffix()

Specified by:

getTrackerVersionSuffix in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

setTrackerVersionSuffix

public void setTrackerVersionSuffix(@Nullable
                                    String trackerVersionSuffix)

Specified by:

setTrackerVersionSuffix in interface com.snowplowanalytics.snowplow.internal.tracker.TrackerConfigurationInterface

appId

@NonNull
public TrackerConfiguration appId(@NonNull
                                           String appId)

Identifer of the app.

devicePlatform

@NonNull
public TrackerConfiguration devicePlatform(@NonNull
                                                    DevicePlatform devicePlatform)

It sets the device platform the tracker is running on.

base64encoding

@NonNull
public TrackerConfiguration base64encoding(boolean base64encoding)

It indicates whether the JSON data in the payload should be base64 encoded.

logLevel

@NonNull
public TrackerConfiguration logLevel(@NonNull
                                              LogLevel logLevel)

It sets the log level of tracker logs.

loggerDelegate

@NonNull
public TrackerConfiguration loggerDelegate(@Nullable
                                                    LoggerDelegate loggerDelegate)

It sets the logger delegate that receive logs from the tracker.

applicationContext

@NonNull
public TrackerConfiguration applicationContext(boolean applicationContext)

Whether application context is sent with all the tracked events.

platformContext

@NonNull
public TrackerConfiguration platformContext(boolean platformContext)

Whether mobile/platform context is sent with all the tracked events.

geoLocationContext

@NonNull
public TrackerConfiguration geoLocationContext(boolean geoLocationContext)

Whether geo-location context is sent with all the tracked events.

sessionContext

@NonNull
public TrackerConfiguration sessionContext(boolean sessionContext)

Whether session context is sent with all the tracked events.

deepLinkContext

@NonNull
public TrackerConfiguration deepLinkContext(boolean deepLinkContext)

Whether deepLink context is sent with all the ScreenView events.

screenContext

@NonNull
public TrackerConfiguration screenContext(boolean screenContext)

Whether screen context is sent with all the tracked events.

screenViewAutotracking

@NonNull
public TrackerConfiguration screenViewAutotracking(boolean screenViewAutotracking)

Whether enable automatic tracking of ScreenView events.

lifecycleAutotracking

@NonNull
public TrackerConfiguration lifecycleAutotracking(boolean lifecycleAutotracking)

Whether enable automatic tracking of background and foreground transitions.

installAutotracking

@NonNull
public TrackerConfiguration installAutotracking(boolean installAutotracking)

Whether enable automatic tracking of install event.

exceptionAutotracking

@NonNull
public TrackerConfiguration exceptionAutotracking(boolean exceptionAutotracking)

Whether enable crash reporting.

diagnosticAutotracking

@NonNull
public TrackerConfiguration diagnosticAutotracking(boolean diagnosticAutotracking)

Whether enable diagnostic reporting.

trackerVersionSuffix

@NonNull
public TrackerConfiguration trackerVersionSuffix(@Nullable
                                                          String trackerVersionSuffix)

Decorate the v_tracker field in the tracker protocol.

copy

@NonNull
public Configuration copy()

Specified by:

copy in interface Configuration