API Reference

Class: Tealium

The following summarizes the commonly used methods of the Tealium class for React Native library.

addRemoteCommand()

Adds a remote command to the remote command manager.

Tealium.addRemoteCommand(id, callback);

Example:

Tealium.addRemoteCommand("firebase", payload => {

  var eventName = payload["firebase_event_name"];
  var eventProperties = payload["firebase_event_properties"];

  analytics.logEvent(eventName, eventProperties);
});

addData()

Adds data to the persistent data storage for the given expiration.

Tealium.addData(data, expiry);

Collectors

Collectors are modules that gather supplemental information from the device and append it to the data layer before it’s transmitted to the Tealium Customer Data Hub. Some collectors are included in the core library, while others are optional and installed as separate modules.

The following table lists the available collectors. Default collectors are denoted by a * next to the collector name.

These modules are enabled or disabled using the TealiumConfig collectors property as described below

ConsentExpiry

Defines the consent preferences expiration

Example:

ConsentExpiry(90, TimeUnit.days)

TimeUnit

ConsentPolicy

Defines the consent policy to adhere to. If no consent policy is defined on the TealiumConfig object, the consent manager will be disabled.

Example:

ConsentPolicy.gdpr

Dispatchers

Dispatchers are modules that send the data from your data layer and send it to a Tealium endpoint. The following dispatchers are currently available:

At least one dispatcher is required. If no dispatchers are specified, your data is not sent anywhere.

Expiry

Defines the custom data expiration

Example:

Expiry.session

Example:

ConsentExpiry(90, TimeUnit.days)

TimeUnit

gatherTrackData()

Gathers all track data from Collectors and data layer.

Tealium.gatherTrackData(callback);

Example:

Tealium.gatherTrackData(value => {
   console.log("Track data: " + JSON.stringify(value))
});

getData()

Retrieves the value for a specified key in the persistent data layer, then returns in the form of a callback function.

Tealium.getData(key, callback);

Example:

Tealium.getData('test_session_key', value => {
   console.log("Value: " + value)
});

getConsentCategories()

Retrieves the user’s consented categories.

Tealium.getConsentCategories(callback);

Example:

Tealium.getConsentCategories(categories => {
    console.log("Consent Categories: " + categories)
});

getConsentStatus()

Retrieves the user consent status and returns in the form of a callback function.

Tealium.getConsentStatus(callback);

Example:

Tealium.getConsentStatus(status => {
    console.log("Consent Status: " + status)
});

getSessionId()

Retrieves the current Session ID and returns in the form of a callback function.

Tealium.getSessionId(callback);

Example:

Tealium.getSessionId(value => {
    console.log("Sesssion ID: " + value)
});

getVisitorId()

Retrieves the user’s visitor ID and returns in the form of a callback function.

Tealium.getVisitorId(callback);

Example:

Tealium.getVisitorId(value => {
    console.log("Visitor ID: " + value)
});

initialize()

Initialize Tealium before calling any other method.

Tealium.initialize(config);

Example:

let config: TealiumConfig =
{
	account: 'tealiummobile',
	profile: 'demo',
	environment: TealiumEnvironment.dev,
	dispatchers: [Dispatchers.Collect,
	 			  Dispatchers.TagManagement,
	  			  Dispatchers.RemoteCommands],
	collectors: [Collectors.AppData,
				 Collectors.DeviceData,
				 Collectors.Lifecycle,
				 Collectors.Connectivity],
	consentLoggingEnabled: true,
	consentPolicy: ConsentPolicy.gdpr,
	visitorServiceEnabled: true
};

Tealium.initialize(config, success => {
    if (!success) {
        // error creating instance.
    }
    // do something on-ready
});

joinTrace()

Joins a trace with the specified ID. Learn more about the Trace feature in the Tealium Customer Data Hub.

Tealium.joinTrace(id);

leaveTrace()

A trace remains active for the duration of the app session until the leaveTrace() method is called, which leaves a previously joined trace and ends the visitor session.

Tealium.leaveTrace();

LogLevel

Sets the log level property, which controls how much information is logged, to one of the following values:

Example:

LogLevel.dev

setConsentCategories()

Sets the consent categories of a user. Pass in an array of Strings to set the categories. Default is an empty array until ConsentStatus is set to .consented. If the consent status is .consented and no categories are specified with the setConsentCategories() method, then all categories are set.

Tealium.setConsentCategories(categories);

Example:

Tealium.setConsentCategories([ConsentCategories.analytics, ConsentCategories.email]);

ConsentCategories

setConsentExpiryListener()

Defines a callback to execute after the user’s consent preferences have expired according the ConsentExpiry.

Tealium.setConsentExpiryListener(callback);

Example:

Tealium.setConsentExpiryListener(() => {
    console.log("Consent Expired");
});

setConsentStatus()

Sets the consent status of a user. Default is .unknown until changed.

Tealium.setConsentStatus(status);

Example:

Tealium.setConsentStatus(ConsentStatus.consented);

ConsentStatus

setVisitorServiceListener()

Defines a callback to execute when the visitor profile has been updated. The updated VisitorProfile is provided in the callback response.

The VisitorService module implements the Data Layer Enrichment feature of the Tealium Customer Data Hub.

Usage of this module is recommended if you are licensed for Tealium AudienceStream and you want to use the visitor profile to enhance the user experience in your mobile application. If you are not licensed for AudienceStream, usage of this module is not recommended as no visitor profile is returned.

Tealium.setVisitorServiceListener(callback);

Example:

Tealium.setVisitorServiceListener(profile => {
    console.log(JSON.stringify(profile["audiences"]));
});

removeData()

Remove persistent data that has been previously set using Tealium.setPersistentData().

Tealium.removeData(keys);

removeRemoteCommand()

Removes a remote command from the remote command manager.

Tealium.removeRemoteCommand(id);

Example:

Tealium.removeRemoteCommand("firebase");

TealiumEnvironment

The environment is one of three default environments (Dev, QA, Prod) or any custom environments that Tealium publishes to. Select one of these environments.

Example:

TealiumEnvironment.dev

TealiumConfig

The following summarizes the properties of the TealiumConfig class.

terminateIntance()

Disables the Tealium library and removes all module references. Re-enable by creating a new Tealium instance if required.

Tealium.terminateIntance();

track()

Track an event with either a TealiumEvent or TealiumView dispatch.

Tealium.track(dispatch);

let tealEvent = new TealiumEvent(
    'cart_add', 
    {
        "customer_id": "abc123", 
        "product_id": ["PROD123", "PROD456"], 
        "product_price": [4.00, 6.00]
    }
);
Tealium.track(tealEvent);

VisitorProfile

The visitor profile is an object that contains friendly names for each attribute. There is a currentVisit property that lets you distinguish visitor/visit attribute types. Access each attribute value by ID using a subscript. If the attribute does not exist, null is returned. See the below list for examples.

Attribute Types

RemoteCommand

An interface that defines a configured Remote Command

The path and URL are optional, but either provide only one or the other, or omit both in the case where the mappings are handled by a tag in Tealium iQ Tag Management.

Provide the callback if the command is to be handled within the scope of your React Native app. Omit the callback if the handler has already been registered natively.

The following example is a local mappings file for a command handled by Javascript:

let localCommand: RemoteCommand = {
    id: "hello-world",
    path: "hello-mappings.json",
    callback: (payload) => {
        //...
    }
}

The following example is a remote mappings file for a command handled natively:

let remoteNativeCommand: RemoteCommand = {
    id: "hello-world",
    url: "https://you.domain.com/hello-mappings.json"
}

Interface: TealiumDispatch

An interface that defines the type of event to be tracked. The following classes implement TealiumDispatch:

Class: TealiumEvent

To track a user’s interaction with a screen, pass an instance of TealiumEvent(tealiumEvent, dataLayer) to the track() method. TealiumEvent consists of an event name, which appears in the tracking call as tealium_event, and an optional event data object.

let tealEvent = TealiumEvent(tealiumEvent, {eventData})
tealium?.track(tealEvent)

Example:

let tealEvent = new TealiumEvent(
    'cart_add', 
    {
        "customer_id": "abc123", 
        "product_id": ["PROD123", "PROD456"], 
        "product_price": [4.00, 6.00]
    }
);
Tealium.track(tealEvent);

Class: TealiumView

To track screen views, pass an instance of TealiumView(tealiumEvent, dataLayer) to the Track() method. TealiumView consists of a view name, which appears in the tracking call as tealium_event, and an optional data dictionary.

let screenView = TealiumView(tealiumEvent, {eventData})
tealium?.track(screenView)

Example:

let screenView = new TealiumView(
    'purchase', 
    {
        "customer_id": "abc123", 
        "order_total": 10.00, 
        "product_id": ["PROD123", "PROD456"], 
        "order_id": "0123456789"
    }
);
Tealium.track(screenView);