Lifecycle Tracking Module

Install

Install the Lifecycle Tracking module with Maven or manually.

Maven

To install the Lifecycle Tracking module using Maven:

1. In your project’s top-level build.gradle file, add the following Maven repository:

   // Top-level build file where you add configuration options common to all sub-projects/modules.
   allprojects {
       repositories {
         mavenCentral()
         // Tealium Maven repo directive
         maven {
             url "https://maven.tealiumiq.com/android/releases/"
         }
       }
   }
   

2. In your project module’s build.gradle file, add the following Maven dependency:

   dependencies {
       // only add if not already present
       implementation 'com.tealium:kotlin-core:1.6.0'
       // add lifecycle to list of dependencies
       implementation 'com.tealium:kotlin-lifecycle:1.2.0'
   }
   

Manual

To install the Lifecycle Tracking module manually, following these steps:

1. Download the Tealium Lifecycle Tracking Module module.

2. Copy the file tealium-kotlin.lifecycle-1.2.0.aar into your project’s <PROJECT_ROOT>/<MODULE>/libs directory.

3. Add the Tealium library dependency to your project module’s build.gradle file:

   dependencies {
         implementation(name:'tealium-kotlin.lifecycle-1.2.0', ext:'aar')
   }
   

Automatically Tracked Events

The module tracks the following lifecycle events, set by the lifecycle_type variable:

Tealium lifecycle tracking solely associates usage with the activity lifecycle.

The library leverages the Application.ActivityLifecycleCallbacks API and evaluates its conditions on onActivityResumed and onActivityPaused.

It is enabled with the following code:

val config = TealiumConfig(
                applicaiton,
                "accountName",
                "profileName",
                Environment.DEV,
                modules = mutableSetOf(Modules.Lifecycle)
                )

Manually Tracked Events

Available for specific lifecycle paradigms and unconventional lifecycle tracking. This approach is not recommended for most implementations. To allow manual lifecycle tracking update your lifecycle initiation code to set isAutoTrackingEnabled to false.

Configuration Options

val config = TealiumConfig(...)

config.isAutoTrackingEnabled = false

To manually track a launch event, call the trackLaunchEvent() method:

tealium.lifecycle?.trackLaunchEvent()

To manually track a sleep event, call the trackSleepEvent() method:

tealium.lifecycle?.trackSleepEvent()

To manually track a wake event, call the trackWakeEvent() method:

tealium.lifecycle?.trackWakeEvent()

Crash Detection

When a launch event follows a wake event or vice-versa, this indicates a crash has occurred since the app did not successfully sleep. If the aforementioned sequence occurs because of a Tealium library shutdown, this is not considered to be a crash event.

When a crash event is detected, the launch or wake event data has the lifecycle_diddetectcrash variable added.

{
    "lifecycle_type" : "launch",
    "lifecycle_diddetectcrash" : "true",
    //...
}

Data Layer

The Lifecycle Tracking module adds the following additional variables for the listed lifecycle event types (launch, wake, sleep):

API Reference

For the reference of methods used by the Lifecycle Tracking module, see the LifeCycle class in the Tealium SDK for Android API.