Target filter
Search Kotlin docs
  • Platforms
  • Tealium Prism Kotlin
core/com.tealium.prism.core.api/Modules

Modules

object Modules

An object used for configuring available modules and retrieving them as a ModuleFactory to be passed into the TealiumConfig.

This object will by default have accessors for all ModuleFactory implementations provided by the Tealium Core SDK. External modules are expected to register extension functions on the Modules object for creating/configuring them. For Java users, non-core modules will have their own documented entry points.

Any methods that accept code blocks for configuration will supply the relevant configuration builder which must be returned at the end of the block, with no further updates after the fact. It should also be noted that configuration set using these methods will override any that come from local or remote settings sources.

Example usage:

val config = TealiumConfig.Builder(app, ..., modules = listOf(
Modules.collect(),
// other optional modules
)
).build()
Content copied to clipboard

Types

Types
Link copied to clipboard
object Types

Object to hold the ModuleFactory.moduleType constants.

Properties

defaultModules
Link copied to clipboard
@JvmStatic
val defaultModules: List<ModuleFactory>

A list of all ModuleFactory's that are eligible for automatic registration.

Functions

addDefaultModules
Link copied to clipboard
@JvmStatic
fun addDefaultModules(modules: List<ModuleFactory>)

Adds additional ModuleFactorys to the list of default factories that are added to each Tealium instance.

appData
Link copied to clipboard
@JvmStatic
@JvmOverloads
fun appData(enforcedSettings: (AppDataSettingsBuilder) -> AppDataSettingsBuilder? = defaultSettings()): ModuleFactory

Collects data related to the app package.

collect
Link copied to clipboard
@JvmStatic
@JvmOverloads
fun collect(enforcedSettings: (CollectSettingsBuilder) -> CollectSettingsBuilder? = defaultSettings()): ModuleFactory
@JvmStatic
fun collect(enforcedSettings: (CollectSettingsBuilder) -> CollectSettingsBuilder, vararg otherEnforcedSettings: (CollectSettingsBuilder) -> CollectSettingsBuilder): ModuleFactory

Returns a configured ModuleFactory for enabling the Collect Module.

connectivityData
Link copied to clipboard
@JvmStatic
@JvmOverloads
fun connectivityData(enforcedSettings: (ConnectivityDataSettingsBuilder) -> ConnectivityDataSettingsBuilder? = defaultSettings()): ModuleFactory

Collects data related to the current connectivity type of the device.

dataLayer
Link copied to clipboard
@JvmStatic
@JvmOverloads
fun dataLayer(enforcedSettings: (DataLayerSettingsBuilder) -> DataLayerSettingsBuilder = defaultSettings()): ModuleFactory

Collects data that has been persisted into the Tealium data layer

deepLink
Link copied to clipboard
@JvmStatic
@JvmOverloads
fun deepLink(enforcedSettings: (DeepLinkSettingsBuilder) -> DeepLinkSettingsBuilder? = defaultSettings()): ModuleFactory

Returns a configured ModuleFactory for enabling the DeepLink Module.

deviceData
Link copied to clipboard
@JvmStatic
@JvmOverloads
fun deviceData(enforcedSettings: (DeviceDataSettingsBuilder) -> DeviceDataSettingsBuilder? = defaultSettings()): ModuleFactory

Collects data related to the user's device.

tealiumData
Link copied to clipboard
@JvmStatic
@JvmOverloads
fun tealiumData(enforcedSettings: (TealiumDataSettingsBuilder) -> TealiumDataSettingsBuilder = defaultSettings()): ModuleFactory

Collects the Tealium required data (Account, profile etc)

timeData
Link copied to clipboard
@JvmStatic
@JvmOverloads
fun timeData(enforcedSettings: (TimeDataSettingsBuilder) -> TimeDataSettingsBuilder? = defaultSettings()): ModuleFactory

Returns a factory for creating the TimeData module, used to add a variety of additional time-based data to each Dispatch

trace
Link copied to clipboard
@JvmStatic
@JvmOverloads
fun trace(enforcedSettings: (TraceSettingsBuilder) -> TraceSettingsBuilder? = defaultSettings()): ModuleFactory

Collects the Trace Id to support Tealium Trace

Generated by Dokka
(c) Tealium 2026