ANDROID KOTLIN

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.

Method/Property Description
dataLayer Access to persistent storage on the device - items within the data layer are added to each event
consentManager Access to the Consent Manager in order to set the user consent preferences
config The TealiumConfig object that was specified when creating this Tealium instance
events Allows you to provide listener classes to a numerous events throughout the Tealium SDK
key The name of this instance
modules Provides access to the modules within the system
sendQueuedDispatches() Requests that any DispatchValidators be re-evaluated
session Provides information relating to the current session
Tealium Constructor method that creates a Tealium instance
track() Method for tracking your Screen Views or Events
visitorId The current Visitor ID that is stored in the data layer

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)

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

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
    }
})

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

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

Tealium

Constructor method that creates a Tealium instance.

val config = TealiumConfig(key, config);
Parameters Type Description Example
key String New Tealium instance name "abc123"
config Tealium.Config The configuration for the new instance tealConfigObj 
// Assuming execution is within Application.onCreate()
val config = TealiumConfig(this, "ACCOUNT_NAME", "PROFILE_NAME", Environment.PROD)
val tealium = Tealium("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("main", config) {
    events.subscribe(object : VisitorUpdatedListener {
        override fun onVisitorUpdated(visitorProfile: VisitorProfile) {
            Logger.dev("--", "VisitorProfile updated: $visitorProfile")
        }
    })
}

track()

The method used for tracking events within the system such as screen views and events.

tealium.track(TealiumView("SCREEN_NAME", mapOf("key" to "context value")))

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
LocationManager
TealiumConfig