Tealium

Class: Tealium

The Tealium class provides methods for tracking screen views and events. The following document summarizes the commonly used methods and properties of the Tealium class for Kotlin. Individual modules may also provide their own extensions for the Tealium class if they are enabled.

cancelTimedEvent()

Cancels a previously started timed event. The timed event is not tracked.

tealium.cancelTimedEvent(name: "TIMED_EVENT_NAME")

consentManager

Allows you to set your current consent status and categories, and see the current policy enforced. Learn more in the Consent Management guide.

tealium.consentManager.userConsentStatus = ConsentStatus.CONSENTED

dataLayer

Provides persistent storage on the device for key-value pairs, while also allowing you to set expiry times. Each entry is also added to every dispatch that you send through the track() method. Learn more in the Data Management guide.

tealium.dataLayer.putString("key", "value", Expiry.FOREVER)

endTraceVisitorSession()

Ends the visitor session remotely. Does not terminate the SDK session or reset the session ID.

Tealium["INSTANCE_NAME"]?.endTraceVisitorSession()

events

Provides listener classes to your Tealium instance in order to receive useful information from the SDK.

The following example registers a listener for any consent preference changes. This listener is provided with the new consent preferences and the current policy enforced. Additional listeners available at com.tealium.core.messaging.

tealium.events.subscribe(object: UserConsentPreferencesUpdatedListener {
    override fun onUserConsentPreferencesUpdated(userConsentPreferences: UserConsentPreferences, policy: ConsentManagementPolicy) {
        // take action on consent changes
    }
})

gatherTrackData()

Retrieves track data from data layer and Collectors.

Tealium["INSTANCE_NAME"]?.gatherTrackData()

joinTrace()

Adds the supplied trace ID to the data layer for the current session.

Tealium["INSTANCE_NAME"]?.joinTrace(traceId)

leaveTrace()

Leaves the trace by removing the trace ID.

Tealium["INSTANCE_NAME"]?.leaveTrace()

linkEcidToKnownIdentifier()

Links the current ECID to a known secondary identifier, such as an email address or other internal ID.

linkEcidToKnownIdentifier(
  knownId: String,
  adobeDataProviderId: String,
  authState: Int?,
  adobeResponseListener: ResponseListener<AdobeVisitor>?
  )

Example:

var tealium: Tealium?
...

tealium.adobeVisitorApi?.linkEcidToKnownIdentifier(
  "myidentifier",
  "123456",
  AdobeAuthState.AUTH_STATE_AUTHENTICATED,
  null
  )

modules

Provides access to the Module Manager for the SDK, and used to provide access to specific modules.

tealium.modules.getModule(VisitorService::class.java)?.delegate = myDelegate

resetVisitor()

Resets the visitor ECID by retrieving a new one on the next tracking call.

resetVisitor()

Example:

var tealium: Tealium?
//...
tealium?.adobeVisitorApi?.resetVisitor()

sendQueuedDispatches()

Dispatches are queued for a number of reasons by any DispatchValidator. You may request that they be re-evaluated using this method which ignores the event batching restrictions, but adheres to other DispatchValidators. For example, if there was no connectivity and there is still no connectivity then queued dispatches remain queued.

tealium.sendQueuedDispatches()

session

Contains all data relating to the current Session.

val sessionId = tealium.session.id

startTimedEvent()

Starts a timed event with the given name. If this method is called again with the same event name, it is ignored if the event has not been ended or canceled. The event start time is not persisted.

If optional data is passed along with the event name, it is added to the track call when the timer is stopped with the stopTimedEvent() call.

tealium.startTimedEvent(name: "TIMED_EVENT_NAME", mapOf("custom_value" to "custom_key"))

stopTimedEvent()

Stops the timer for a timed event which triggers the timed_event tracking call.

tealium.stopTimedEvent(name: "TIMED_EVENT_NAME")

Tealium

Constructor method that creates a Tealium instance.

val config = TealiumConfig(key, config);

// Assuming execution is within Application.onCreate()
val config = TealiumConfig(this, "ACCOUNT_NAME", "PROFILE_NAME", Environment.PROD)
val tealium = Tealium.create("main", config)

Modules are initialized on a background Thread and therefore may not be ready directly after creation of the Tealium object. Add a completion block in order to add any subsequent required configuration as soon as the instance is ready:

val tealium = Tealium.create("main", config) {
    events.subscribe(object : VisitorUpdatedListener {
        override fun onVisitorUpdated(visitorProfile: VisitorProfile) {
            Logger.dev("--", "VisitorProfile updated: $visitorProfile")
        }
    })
}

track()

Tracks a screen view or event with optional event data.

tealium.track(tealiumlEvent)

To track events, pass a TealiumView or TealiumEvent object to the track() method:

val tealiumlEvent = TealiumView(
  "purchase", 
  mutableMapOf(
    "customer_id" to "abc123", 
    "order_total" to 10.00, 
    "product_id" to listOf("PROD123", "PROD456"),
    "order_id" to "0123456789"
  )
)
tealium.track(tealiumlEvent);

visitor

Returns the full AdobeVisitor instance.

var tealium: Tealium?
//...
val visitor = tealium.adobeVisitorApi?.visitor?.let { visitor ->
    val ecid = visitor.experienceCloudId
    val nextRefresh = visitor.nextRefresh
    val blob = visitor.blob
    val region = visitor.region
    val idSyncTTL = visitor.idSyncTTL
}

visitorId

The current String for the Visitor ID. It is stored within the data layer, and may be overridden if required.

val visitorId = tealium.visitorId

Interface: TealiumDispatch

An interface that defines the type of dispatch to be tracked. The following classes implement TealiumDispatch:

Class: TealiumEvent

To track a user’s interaction with a screen, pass an instance of TealiumEvent(tealiumEvent, eventData) to the Track() method. TealiumEvent consists of an event name, which appears in the tracking call as tealium_event, and an optional mutable map.

val tealiumEvent = TealiumEvent(tealiumEvent, eventData)
tealium.track(tealiumEvent);

Example:

val tealiumEvent = TealiumEvent(
  "cart_add", 
  mutableMapOf(
    "customer_id" to "abc123", 
    "product_id" to listOf("PROD123", "PROD456"),
    "product_price" to listOf(4.00, 6.00)
  )
)
tealium.track(tealiumEvent);

Class: TealiumView

To track screen views, pass an instance of TealiumView(tealiumEvent, eventData) to the Track() method. TealiumView consists of a view name, which appears in the tracking call as tealium_event, and an optional mutable map.

val tealiumView = TealiumView(tealiumEvent, eventData)
tealium.track(tealiumView);

Example:

val tealiumView = TealiumView(
  "purchase", 
  mutableMapOf(
    "customer_id" to "abc123", 
    "order_total" to 10.00, 
    "product_id" to listOf("PROD123", "PROD456"),
    "order_id" to "0123456789"
  )
)
tealium.track(tealiumView);