lifecycle/com.tealium.prism.lifecycle

Package-level declarations

Root package and entry point for the Lifecycle module

Types

class InvalidEventOrderException(message: String? = null, cause: Throwable? = null) : TealiumException

Exception class thrown when a lifecycle event was not tracked in an appropriate order. e.g. multiple launch events consecutively

Lifecycle

interface Lifecycle

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

LifecycleDataTarget

enum LifecycleDataTarget : Enum<LifecycleDataTarget> , DataItemConvertible

LifecycleData target defines what targets the lifecycle event data is added to. LifecycleDataTarget.LifecycleEventsOnly is selected by default, and will only add related data to lifecycle events.

LifecycleEvent

enum LifecycleEvent : Enum<LifecycleEvent> , DataItemConvertible

LifecycleEvent defines trackable events related to the application lifecycle.

LifecycleSettingsBuilder

class LifecycleSettingsBuilder : CollectorSettingsBuilder<LifecycleSettingsBuilder>

Enables the configuration, at runtime, of Lifecycle Settings.

ManualTrackingException

class ManualTrackingException(message: String? = null, cause: Throwable? = null) : TealiumException

Exception class thrown when a lifecycle event was tracked manually, but autotracking is enabled.

Properties

DEFAULT_FACTORY

@JvmField

val DEFAULT_FACTORY: ModuleFactory

Returns the default ModuleFactory implementation that will not create any instances unless there are settings provided from Local or Remote sources.

LIFECYCLE

val Modules.Types.LIFECYCLE: String

The Module.id of the Lifecycle module.

lifecycle

val Tealium.lifecycle: Lifecycle

Returns the Lifecycle instance for a given Tealium instance

Functions

lifecycle

fun Modules.lifecycle(): ModuleFactory

Returns a configured ModuleFactory for enabling the Lifecycle Module.

fun Modules.lifecycle(enforcedSettings: (LifecycleSettingsBuilder) -> LifecycleSettingsBuilder? = { it }): ModuleFactory

Returns a configured ModuleFactory for enabling Lifecycle.