com.tealium.lifecycle

Class LifeCycle

java.lang.Object

com.tealium.lifecycle.LifeCycle

public final class LifeCycle
extends java.lang.Object

Module for managing application lifecycle. When used, this module populates the lifecycle_* events defined in DataSources.Key.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getCurrentState() Populated a map with
static LifeCycle	getInstance(java.lang.String instanceId) When manually tracking (isAutoTracking() is false) this method will return an instance previously setup by setupInstance(String, Tealium.Config, boolean).
boolean	isAutoTracking()
static LifeCycle	setupInstance(java.lang.String instanceId, Tealium.Config config, boolean isAutoTracking) This method needs to be called before calling Tealium.createInstance(String, Tealium.Config) in order for the data to track correctly.
void	trackLaunchEvent(java.util.Map<java.lang.String,?> data) Manually track a launch event
void	trackSleepEvent(java.util.Map<java.lang.String,?> data) Manually track a sleep event
void	trackWakeEvent(java.util.Map<java.lang.String,?> data) Manually track a wake event

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isAutoTracking

public boolean isAutoTracking()

Returns:

whether the module was configured for auto-tracking life cycle events.

trackLaunchEvent

public void trackLaunchEvent(java.util.Map<java.lang.String,?> data)

Manually track a launch event

Parameters:

data - OPTIONAL additional data if desired

Throws:

java.lang.UnsupportedOperationException - if isAutoTracking() is true

trackWakeEvent

public void trackWakeEvent(java.util.Map<java.lang.String,?> data)

Manually track a wake event

Parameters:

data - OPTIONAL additional data if desired

Throws:

java.lang.UnsupportedOperationException - if isAutoTracking() is true

trackSleepEvent

public void trackSleepEvent(java.util.Map<java.lang.String,?> data)

Manually track a sleep event

Parameters:

data - OPTIONAL additional data if desired

Throws:

java.lang.UnsupportedOperationException - if isAutoTracking() is true

getCurrentState

public java.util.Map<java.lang.String,java.lang.Object> getCurrentState()

Populated a map with

• DataSources.Key.LIFECYCLE_DAYSSINCELAUNCH
• DataSources.Key.LIFECYCLE_DAYOFWEEK_LOCAL
• DataSources.Key.LIFECYCLE_HOUROFDAY_LOCAL
• DataSources.Key.LIFECYCLE_TOTALSECONDSAWAKE
• DataSources.Key.LIFECYCLE_FIRSTLAUNCHDATE
• DataSources.Key.LIFECYCLE_FIRSTLAUNCHDATE_MMDDYYYY
• DataSources.Key.LIFECYCLE_LASTLAUNCHDATE
• DataSources.Key.LIFECYCLE_TOTALCRASHCOUNT
• DataSources.Key.LIFECYCLE_TOTALLAUNCHCOUNT
• DataSources.Key.LIFECYCLE_LAUNCHCOUNT
• DataSources.Key.LIFECYCLE_TOTALWAKECOUNT
• DataSources.Key.LIFECYCLE_WAKECOUNT
• DataSources.Key.LIFECYCLE_TOTALSLEEPCOUNT
• DataSources.Key.LIFECYCLE_SLEEPCOUNT

when isAutoTracking() is true, this data is added to every track call.

Returns:

populated map

setupInstance

public static LifeCycle setupInstance(java.lang.String instanceId,
                                      Tealium.Config config,
                                      boolean isAutoTracking)

This method needs to be called before calling Tealium.createInstance(String, Tealium.Config) in order for the data to track correctly.

Parameters:

instanceId - Tealium instance id

config - Tealium.Config of the Tealium instance

isAutoTracking - whether the module should handle its own LifeCycle tracking

getInstance

public static LifeCycle getInstance(java.lang.String instanceId)

When manually tracking (isAutoTracking() is false) this method will return an instance previously setup by setupInstance(String, Tealium.Config, boolean).

Returns:

an instance if created, otherwise null.