Modules

The list of modules factories that can be used to instantiate and pass modules to the TealiumConfig.

The Context API module retrieves visitor profile data from Tealium AudienceStream.

A storage where the application can insert some data to be added to each tracking call.

You can potentially also extract data that was previously added via various getters. If you want to add several read and writes in a transaction, you can use transactionally and execute the transaction synchronously via the provided DataStoreTransaction, which also offers all the typed getters of DataItemExtractor.

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

The Lifecycle Module sends events related to application lifecycle - launch, wake, and sleep.

The Trace is responsible for handling Tealium trace registration.

Joining a trace will add the trace id to each event for filtering server side. Users can leave the trace when finished.

The anonymous visitor ID of this device, and the Visitor Switching state behind it.

This object is itself subscribable: subscribing emits the current visitor ID first, then again on every change, whether caused by regenerate(), eraseLocalHistory(), or an identity-driven switch when Visitor Switching is configured. Emissions are delivered on the Tealium queue.

Visitor Switching is driven entirely by the data layer. An identity is present when the visitor identity key (see VisitorIdSettingsBuilder.setVisitorIdentityKey(_:)) holds a value in the data layer, and absent when that key has been removed or has expired. The SDK has no notion of login or logout: a login is the app writing the identity to that key, a logout is the app removing it.

Operations below that depend on an identity being present read the data layer at the time of the call.

Visitor ID handling can be disabled through settings. While visitor ID handling is disabled, subscribers receive a .failure instead of a value, both at subscription time and if it becomes disabled later; successes resume if it is re-enabled. These failures do not complete the subscription. If the Tealium instance failed to initialize, or is later shut down, subscribers receive a single ModuleError.tealiumError(_:) failure and the subscription completes.

Every method returns a failure result while visitor ID handling is disabled, and after the Tealium instance failed to initialize or was shut down.