com.tealium.library

Class Tealium

java.lang.Object

com.tealium.library.Tealium

public final class Tealium
extends java.lang.Object

Principle interface for interacting with Tealium

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tealium.Config Configuration for Tealium

Method Summary

Modifier and Type	Method and Description
void	addRemoteCommand(RemoteCommand remoteCommand) Add a remote command after Tealium has been initialized.
static Tealium	createInstance(java.lang.String key, Tealium.Config config) Create a new Tealium Multiton Instances are accessible by getInstance(String) and destroyable by destroyInstance(String)
static void	destroyInstance(java.lang.String key) Destroy an active Tealium instance created by createInstance(String, Config)
void	disableConsentManager() Disable consent manager
java.lang.String	getAccountName()
VisitorProfile	getCachedVisitorProfile()
ConsentManager	getConsentManager()
java.lang.String	getDatasourceId()
DataSources	getDataSources()
java.lang.String	getEnvironmentName()
static Tealium	getInstance(java.lang.String key) Get a Tealium instance created by createInstance(String, Config)
java.lang.String	getProfileName()
void	joinTrace(java.lang.String traceId) Join an active trace
void	leaveTrace() Leave an active trace
void	removeRemoteCommand(RemoteCommand remoteCommand) Remove a previously added remote command after Tealium has been initialized.
void	track(java.util.Map<java.lang.String,?> data) (Advanced) Track data
void	trackEvent(java.lang.String eventTitle, java.util.Map<java.lang.String,?> data) Track an event (such as a button click)
void	trackEventType(java.lang.String eventType, java.lang.String eventTitle, java.util.Map<java.lang.String,?> data) Track a Custom Event Type
void	trackView(java.lang.String screenTitle, java.util.Map<java.lang.String,?> data) Track a presented view

Methods inherited from class java.lang.Object

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

Method Detail

getAccountName

public java.lang.String getAccountName()

Returns:

account name set by Tealium.Config.create(Application, String, String, String)

getProfileName

public java.lang.String getProfileName()

Returns:

profile name set by Tealium.Config.create(Application, String, String, String)

getEnvironmentName

public java.lang.String getEnvironmentName()

Returns:

environment name set by Tealium.Config.create(Application, String, String, String)

getDatasourceId

public java.lang.String getDatasourceId()

Returns:

datasource id set by Tealium.Config.setDatasourceId(String)

getConsentManager

public ConsentManager getConsentManager()

Returns:

consent manager set by Tealium.Config.enableConsentManager(String) ()}

disableConsentManager

public void disableConsentManager()

Disable consent manager

trackView

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

Track a presented view

Parameters:

screenTitle - the view's screen title which will be mapped to DataSources.Key.SCREEN_TITLE or null

data - any additional data to be added to the data layer or null

trackEvent

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

Track an event (such as a button click)

Parameters:

eventTitle - the event's id which will be mapped to DataSources.Key.LINK_ID or null

data - any additional data to be added to the data layer or null

trackEventType

public void trackEventType(java.lang.String eventType,
                           java.lang.String eventTitle,
                           java.util.Map<java.lang.String,?> data)

Track a Custom Event Type

Parameters:

eventType - event type label to be mapped to DataSources.Key.TEALIUM_EVENT_TYPE

eventTitle - the title given to the event which will be mapped to DataSources.Key.TEALIUM_EVENT

track

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

(Advanced) Track data

Parameters:

data - contextual data or null

See Also:

#trackView(String, Map)} or {@link #trackEvent(String, Map)}

joinTrace

public void joinTrace(java.lang.String traceId)

Join an active trace

Parameters:

traceId - the active trace id

addRemoteCommand

public void addRemoteCommand(RemoteCommand remoteCommand)

Add a remote command after Tealium has been initialized.

Parameters:

remoteCommand - a remoteCommand instance.

Throws:

java.lang.IllegalArgumentException - when remoteCommand is null.

removeRemoteCommand

public void removeRemoteCommand(RemoteCommand remoteCommand)

Remove a previously added remote command after Tealium has been initialized.

Parameters:

remoteCommand - a remoteCommand instance.

Throws:

java.lang.IllegalArgumentException - when remoteCommand is null.

leaveTrace

public void leaveTrace()

Leave an active trace

getDataSources

public DataSources getDataSources()

Returns:

the DataSources for this instance

getCachedVisitorProfile

public VisitorProfile getCachedVisitorProfile()

Returns:

the last fetched VisitorProfile or null if never fetched

createInstance

public static Tealium createInstance(java.lang.String key,
                                     Tealium.Config config)

Create a new Tealium Multiton

Instances are accessible by getInstance(String) and destroyable by destroyInstance(String)

Parameters:

key - the identifier for the new Tealium instance

config - the configuration for the new instance

Returns:

the newly created instance

getInstance

public static Tealium getInstance(java.lang.String key)

Get a Tealium instance created by createInstance(String, Config)

Parameters:

key - the key used to create the instance

Returns:

instance, if created; or null if never created or was destroyed

destroyInstance

public static void destroyInstance(java.lang.String key)

Destroy an active Tealium instance created by createInstance(String, Config)

Parameters:

key - used to create the instance