API Reference

This is the previous version (1.x) of Tealium for React Native.
For the current version, see Tealium for React Native 2.x.

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.

addRemoteCommand(commandID, description, callback);

Example:

Tealium.addRemoteCommand("firebase", "Firebase remote command", function(payload) {

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

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

addRemoteCommandForInstanceName()

Adds a remote command to the remote command manager, for a specific Tealium instance.

addRemoteCommandForInstanceName(instanceName, commandID, description, callback);

Example:

Tealium.addRemoteCommand("instance-2", "survey", "Display feedback survey", function(payload) {

	var title = payload["survey_title"];
	var question = payload["survey_question"];

	Alert.alert(title, question, [{text: 'Yes', onPress: () => surveyHandler()},
								  {text: 'No', onPress: () => surveyHandler()}]);

});

getPersistentData()

Gets the value for a specific key.

Tealium.getPersistentData(key, value);

getPersistentDataForInstanceName()

Get a persistent data value, for a specific Tealium instance and key. For use if you have multiple instances of Tealium in your app.

Tealium.getPersistentDataForInstanceName(instanceName, key, value);

getUserConsentCategories()

Gets the consent categories of a user. Pass in a callback to use the userConsentCategories.

Tealium.getUserConsentCategories(userConsentCategories);

getUserConsentCatgoriesForInstanceName()

Gets the consent categories of a user, for a specific Tealium instance. Pass in a callback to use the userConsentCategories. For use if you have multiple instances of Tealium in your app.

Tealium.getUserConsentCategoriesForInstanceName(name, userConsentCategories);

getUserConsentStatus()

Gets the consent status of a user. Pass in a callback to use the userConsentStatus.

Tealium.getUserConsentStatus(userConsentStatus);

getUserConsentStatusForInstanceName()

Gets the consent status of a user, for a specific Tealium instance. Pass in a callback to use the userConsentStatus. For use if you have multiple instances of Tealium in your app.

Tealium.getUserConsentStatusForInstanceName(name, userConsentStatus);

getVisitorID()

Gets the visitorID of a user. Pass in a callback to use the visitorID.

Tealium.getVisitorID(visitorID);

getVisitorIDForInstanceName()

Gets the visitorID of a user, for a specific Tealium instance. Pass in a callback to use the visitorID. For use if you have multiple instances of Tealium in your app.

Tealium.getVisitorIDForInstanceName(name, visitorID);

getVolatileData()

Gets the value for the key passed in.

Tealium.getVolatileData(key, value);

getVolatileDataForInstanceName()

Get a volatile data value, for a specific Tealium instance and key. For use if you have multiple instances of Tealium in your app.

Tealium.getVolatileDataForInstanceName(instanceName, key, value);

initialize()

Initialize Tealium before calling any other method.

initialize(account,
    profile,
    environment,
    iosDatasource,
    androidDatasource,
    instance,
    isLifecycleEnabled);

initializeCustom()

Initialize Tealium with all options before calling any other method.

initializeCustom(account,
        profile,
        environment,
        iosDatasource,
        androidDatasource,
        instance,
        isLifecycleEnabled,
        overridePublishSettingsURL,
        overrideTagManagementURL,
        collectURL,
        enableConsentManager,
        overrideCollectDispatchURL
    );

initializeWithConsentManager()

Initialize Tealium with consent management before calling any other method.

initializeWithConsentManager(account,
  profile,
  environment,
  iosDatasource,
  androidDatasource,
  instance,
  isLifecycleEnabled);

isConsentLoggingEnabled()

Checks if consent logging is enabled for a user. Pass in a callback to use the value of consent logging.

isConsentLoggingEnabled(enabled);

isConsentLoggingEnabledForInstanceName()

Checks if user’s consent logging is enabled, for a specific Tealium instance. Pass in a callback to use the value of consent logging. For use if you have multiple instances of Tealium in your app.

Tealium.isConsentLoggingEnabledForInstanceName(name, enabled);

removePersistentData()

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

Tealium.removePersistentData(keys);

removePersistentDataForInstanceName()

Remove persistent data that has been previously set using Tealium.setPersistentData(), for a specific Tealium instance. For use if you have multiple instances of Tealium in your app.

Tealium.removePersistentDataForInstanceName(instanceName, keys);

removeRemoteCommand()

Removes a remote command from the remote command manager.

removeRemoteCommand(commandID);

Example:

Tealium.removeRemoteCommand("firebase");

removeRemoteCommandForInstanceName()

Removes a remote command from the remote command manager, for a specific Tealium instance.

removeRemoteCommandForInstanceName(instanceName, commandID);

Example:

Tealium.removeRemoteCommand("instance-2", "firebase");

removeVolatileData()

Remove volatile data that has been previously set using Tealium.setVolatileData().

Tealium.removeVolatileData(keys);

removeVolatileDataForInstanceName()

Remove volatile data for provided instance names. For use if you have multiple instances of Tealium in your app.

Tealium.removeVolatileDataForInstanceName(name, keys);

resetUserConsentPreferences()

Resets the user consent status and categories of a user.

Tealium.resetUserConsentPreferences();

resetUserConsentPreferencesForInstanceName()

Resets the user consent status and categories of a user, for a specific Tealium instance. For use if you have multiple instances of Tealium in your app.

Tealium.resetUserConsentPreferencesForInstanceName(name);

setConsentLoggingEnabled()

Sets consent logging for a user.

Tealium.setConsentLoggingEnabled(enabled);

setConsentLoggingEnabledForInstanceName()

Sets user’s consent logging, for a specific Tealium instance. For use if you have multiple instances of Tealium in your app.

Tealium.setConsentLoggingEnabledForInstanceName(name, enabled);

setPersistentData()

Set persistent data to be sent with each subsequent event or view, even between app restarts.

Tealium.setPersistentData(data);

setPersistentDataForInstanceName()

Set persistent data to be sent with each subsequent event or view, even between app restarts, for a specific Tealium instance. For use if you have multiple instances of Tealium in your app.

Tealium.setPersistentDataForInstanceName(instanceName, data);

setUserConsentCategories()

Sets the consent categories of a user. Pass in an array of Strings to set the categories.

Tealium.setUserConsentCategories(userConsentCategories);

setUserConsentCategoriesForInstanceName()

Sets the consent ;categories of a user, for a specific Tealium instance. Pass in an array of Strings to set the categories. For use if you have multiple instances of Tealium in your app.

Tealium.setUserConsentCategoriesForInstanceName(name, userConsentCategories);

setUserConsentStatus()

Sets the consent status of a user.

Tealium.setUserConsentStatus(userConsentStatus);

setUserConsentStatusForInstanceName()

Sets the consent status of a user, for a specific Tealium instance. For use if you have multiple instances of Tealium in your app.

Tealium.setUserConsentStatusForInstanceName(name, userConsentStatus);

setVolatileData()

Set volatile data to be sent with each subsequent event or view until the app is terminated, where data is a JSON object of key-value pairs where keys are strings and the values are either a string or array of strings.

Tealium.setVolatileData(data);

setVolatileDataForInstanceName()

Set volatile data to be included with each subsequent tracking call until the app is terminated, for a specific Tealium instance. For use if you have multiple instances of Tealium in your app.

Tealium.setVolatileDataForInstanceName(name, data);

trackEvent()

Track an event with an event name and event data.

trackEvent(stringTitle, data);

trackEventForInstanceName()

Track an event when you have multiple instances of Tealium in your app, for a specific Tealium instance.

trackEvent(name, stringTitle, data);

trackView()

Track a view with a screen name and view data.

trackView(screenName, data);

trackViewForInstanceName()

Track a view when you have multiple instances of Tealium in your app, for a specific Tealium instance.

Tealium.trackViewForInstanceName(instanceName, screenName, data);