snowplow-android-tracker/com.snowplowanalytics.core.tracker/Tracker

Tracker

class Tracker(emitter: Emitter, val namespace: String, var appId: String, context: Context, builder: (Tracker) -> Unit? = null)

Builds a Tracker object which is used to send events to a Snowplow Collector.

Parameters

emitter

Emitter to which events will be sent

namespace

Identifier for the Tracker instance

appId

Application ID

context

The Android application context

builder

A closure to set Tracker configuration

Constructors

fun Tracker(emitter: Emitter, namespace: String, appId: String, context: Context, builder: (Tracker) -> Unit? = null)

Types

object Companion

Functions

addOrReplaceStateMachine

fun addOrReplaceStateMachine(stateMachine: StateMachineInterface)

fun close()

disableGdprContext

fun disableGdprContext()

Disable GDPR context.

enableGdprContext

fun enableGdprContext(basisForProcessing: Basis, documentId: String?, documentVersion: String?, documentDescription: String?)

Enables GDPR context to be sent with every event.

fun getScreenState(): ScreenState?

pauseEventTracking

fun pauseEventTracking()

Stops event collection and ends all concurrent processes.

pauseSessionChecking

fun pauseSessionChecking()

Ends session checking.

removeStateMachine

fun removeStateMachine(identifier: String)

resumeEventTracking

fun resumeEventTracking()

Starts event collection processes again.

resumeSessionChecking

fun resumeSessionChecking()

Starts session checking.

startNewSession

fun startNewSession()

Convenience function for starting a new session.

fun track(event: Event): UUID?

Handles tracking the different types of events that the Tracker can encounter.

Properties

var appId: String

applicationContext

var applicationContext: Boolean

backgroundTimeout

var backgroundTimeout: Long

var base64Encoded: Boolean

val dataCollection: Boolean

deepLinkContext

var deepLinkContext: Boolean = false

Internal use only

diagnosticAutotracking

var diagnosticAutotracking: Boolean

var emitter: Emitter

exceptionAutotracking

var exceptionAutotracking: Boolean

foregroundTimeout

var foregroundTimeout: Long

var gdprContext: Gdpr? = null

geoLocationContext

var geoLocationContext: Boolean

installAutotracking

var installAutotracking: Boolean

lifecycleAutotracking

var lifecycleAutotracking: Boolean

var loggerDelegate: LoggerDelegate? = null

var logLevel: LogLevel

val namespace: String

var platform: DevicePlatform

platformContextEnabled

var platformContextEnabled: Boolean

var screenContext: Boolean = false

Internal use only

screenViewAutotracking

var screenViewAutotracking: Boolean

var session: Session? = null

sessionCallbacks

var sessionCallbacks: Array<Runnable?>

This configuration option is not published in the TrackerConfiguration class. Create a Tracker directly, not via the Snowplow interface, to configure sessionCallbacks.

@set:Synchronized

var sessionContext: Boolean

Whether the session context should be sent with events

var subject: Subject? = null

var threadCount: Int

This configuration option is not published in the TrackerConfiguration class. Create a Tracker directly, not via the Snowplow interface, to configure threadCount.

var timeUnit: TimeUnit

This configuration option is not published in the TrackerConfiguration class. Create a Tracker directly, not via the Snowplow interface, to configure timeUnit.

trackerVersionSuffix

var trackerVersionSuffix: String? = null

Internal use only. Decorate the tv (tracker version) field in the tracker protocol.

userAnonymisation

var userAnonymisation: Boolean

Internal use only