API Reference

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

Class: Tealium

The following summarizes the commonly used methods of the Cordova Tealium class.

addPersistent()

Adds persistent data to the Tealium persistent data store.

tealium.addPersistent(key, data, instance);

addVolatile()

Adds data to the Tealium volatile data store.

tealium.addVolatile(key, data, instance);

init()

Initializes the Tealium Cordova plugin.

tealium.init(config, successCallBack, errorCallback);

The config object is passed as the first argument, and contains the following data:

tealium.init({account, profile, environment, instance,
                isLifecycleEnabled,
                collectDispatchURL,
                collectDispatchProfile,
                isCrashReporterEnabled,
                logLevel,
                dataSourceId});

getPersistent()

Returns a value from the Tealium persistent data. Returns null on the JavaScript side if the requested data could not be found.

tealium.getPersistent(key, instance, callback);

getVisitorID()

Returns the current Tealium visitor ID for the current user.

getVolatile()

Returns a value from the Tealium volatile data store. Returns null on the JavaScript side if the requested data could not be found.

tealium.getVolatile(key, instance, callback);

removePersistent()

Removes persistent data from the Tealium persistent data store.

tealium.removePersistent(key, instance);

removeVolatile()

Removes volatile data from the Tealium volatile data store.

tealium.removeVolatile(key, instance);

track()

Track views by passing "view" as the first argument type, or track events by passing "link" as the first argument type.

tealium.track(type, data, instance);

trackEvent()

Tracks all non-view activity.

tealium.trackEvent(data, instance);

trackView()

Tracks every time a user opens or changes a screen in the app.

tealium.trackView(data, instance);