TrackerController

interface TrackerController : TrackerConfigurationInterface

Controller for managing the tracker.

Functions

Link copied to clipboard
abstract fun decorateLink(uri: Uri, extendedParameters: CrossDeviceParameterConfiguration? = null): Uri?

Adds user and session information to a URI.

Link copied to clipboard
abstract fun pause()

Pause the tracker. The tracker will stop any new activity tracking, but will continue to send any remaining events already tracked but not yet sent. Calling track will not have any effect, and the event tracked will be lost.

Link copied to clipboard
abstract fun resume()

Resume the tracker. The tracker will start tracking again.

Link copied to clipboard
abstract fun track(event: Event): UUID?

Track the event. The tracker will process and send the event.

Properties

Link copied to clipboard
abstract var appId: String

Identifier of the app.

Link copied to clipboard

Whether application context is sent with all the tracked events.

Link copied to clipboard
abstract var base64encoding: Boolean

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

Link copied to clipboard
abstract var deepLinkContext: Boolean

Whether deepLink context is sent with all the ScreenView events.

Link copied to clipboard

It sets the device platform the tracker is running on.

Link copied to clipboard

Whether enable diagnostic reporting.

Link copied to clipboard

Controller for ecommerce Note: don't retain the reference. It may change on tracker reconfiguration.

Link copied to clipboard

EmitterController. Note: don't retain the reference. It may change on tracker reconfiguration.

Link copied to clipboard

Whether enable crash reporting.

Link copied to clipboard
abstract val gdpr: GdprController

GdprController. Note: don't retain the reference. It may change on tracker reconfiguration.

Link copied to clipboard

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

Link copied to clipboard

GlobalContextsController. Note: don't retain the reference. It may change on tracker reconfiguration.

Link copied to clipboard

Whether to enable automatic tracking of install event. In case com.android.installreferrer:installreferrer library is present, an entity with the referrer details will be attached to the install event.

Link copied to clipboard
abstract val isTracking: Boolean

Whether the tracker is running and able to collect/send events.

Link copied to clipboard

Whether enable automatic tracking of background and foreground transitions. Enabled by default.

Link copied to clipboard

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

Link copied to clipboard
abstract var logLevel: LogLevel

It sets the log level of tracker logs.

Link copied to clipboard
abstract val media: MediaController

Media controller for managing media tracking instances and tracking media events.

Link copied to clipboard
abstract val namespace: String

Namespace of the tracker. It is used to identify the tracker when there are multiple trackers running in the same app.

Link copied to clipboard
abstract val network: NetworkController?

NetworkController. Note: don't retain the reference. It may change on tracker reconfiguration.

Link copied to clipboard
abstract var platformContext: Boolean

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

Link copied to clipboard

Controller for managing tracker plugins Note: don't retain the reference. It may change on tracker reconfiguration.

Link copied to clipboard
abstract var screenContext: Boolean

Whether screen context is sent with all the tracked events.

Link copied to clipboard

Whether to enable tracking the screen end event and the screen summary context entity. Make sure that you have lifecycle autotracking enabled for screen summary to have complete information.

Link copied to clipboard

Whether enable automatic tracking of ScreenView events.

Link copied to clipboard
abstract val session: SessionController?

SessionController. Note: don't retain the reference. It may change on tracker reconfiguration.

Link copied to clipboard
abstract var sessionContext: Boolean

Whether session context is sent with all the tracked events.

Link copied to clipboard

SubjectController. Note: don't retain the reference. It may change on tracker reconfiguration.

Link copied to clipboard

Decorate the v_tracker field in the tracker protocol.

Link copied to clipboard

Whether to anonymise client-side user identifiers in session (userId, previousSessionId), subject (userId, networkUserId, domainUserId, ipAddress) and platform context entities (IDFA) Setting this property on a running tracker instance starts a new session (if sessions are tracked).

Link copied to clipboard
abstract val version: String

Version of the tracker.