core/com.tealium.prism.core.api/Tealium

Tealium

The main class for the Tealium SDK.

This class provides the primary interface for interacting with the Tealium SDK. It handles initialization, tracking events, managing visitor IDs, and accessing various modules like data layer, deep linking, and tracing.

Types

Companion

object Companion : InstanceManager

TealiumShutdownException

class TealiumShutdownException(message: String?) : TealiumException

An Exception to signify that the Tealium instance has already been shutdown.

Properties

dataLayer

abstract val dataLayer: DataLayer

The DataLayer is available to store key-value data that should be present on every event tracked through the Tealium SDK.

deeplink

abstract val deeplink: DeepLinkHandler

The DeepLinkHandler is responsible for tracking incoming deep links, managing attribution, and handling trace parameters when present in the URL.

key

abstract val key: String

The identifying key for this instance.

trace

abstract val trace: Trace

Returns an object for managing traces. The Trace module is responsible for handling Tealium trace registration.

Functions

clearStoredVisitorIds

abstract fun clearStoredVisitorIds(): SingleResult<String>

Removes all stored visitor identifiers as hashed identities, and generates a new anonymous visitor id.

createModuleProxy

abstract fun <T : Module> createModuleProxy(clazz: Class<T>): ModuleProxy<T>

Creates a ModuleProxy for the given module clazz to allow for an easy creation of Module Wrappers.

flushEventQueue

abstract fun flushEventQueue(): SingleResult<Unit>

Flushes any queued events from the system when it is considered safe to do so by any Barriers that may be blocking.

onReady

abstract fun onReady(callback: Callback<Tealium>)

Executes the provided callback when Tealium is ready for use, from the Tealium internal thread.

resetVisitorId

abstract fun resetVisitorId(): SingleResult<String>

Resets the current visitor id to a new anonymous one.

shutdown

abstract fun shutdown()

Shuts this instance of Tealium down and frees up all memory usage.

track

abstract fun track(name: String, data: DataObject): SingleResult<TrackResult>

Tracks an event with the specified name, and data. The event type will be DispatchType.Event

abstract fun track(name: String, type: DispatchType, data: DataObject): SingleResult<TrackResult>

Tracks an event with the specified name, type, and data.