TealiumPaid

Improve this doc

This plugin might require a paid license, or might take a share of your app's earnings. Check the plugin's repo for more information.

This plugin provides a TypeScript wrapper around the Tealium Cordova plugin for Ionic Native.

For full documentation, see https://community.tealiumiq.com/t5/Mobile-Libraries/Tealium-for-Cordova/ta-p/17618

Repo: https://github.com/Tealium/cordova-plugin

Installation

1. Install the Cordova and Ionic Native plugins:
   

   $ ''
   $ npm install --save @ionic-native/tealium@4
   

2. Add this plugin to your app's module

Supported platforms

• Android
• iOS

Usage

import { Tealium, TealConfig } from '@ionic-native/tealium';


constructor(private tealium: Tealium) { }

...

let tealConfig: TealConfig = {
 account: "<your-account>",
 profile: "<your-profile>",
 environment: "<your-environment>", // usually "dev", "qa" or "prod"
 isLifecycleEnabled: "true", // pass "false" to disable lifecycle tracking
 isCrashReporterEnabled: "false", // pass "true" to enable crash reporter (Android only)
 instance: "<your-instance-name" // an arbitrary instance name. use the same instance name for all subsequent API calls
}

this.tealium.init(tealConfig).then(()=>{
  this.tealium.trackView({"screen_name": "homescreen"});
});

Instance Members

init(config)

This function initializes the Tealium Cordova plugin. This should usually be done inside the “deviceReady” handler.

trackView(dataObject, instanceName)

This function tracks a view event in the Tealium Cordova plugin

trackEvent(dataObject, instanceName)

This function tracks a link event in the Tealium Cordova plugin

track(eventType, dataObject, instanceName)

This function tracks a custom event in the Tealium Cordova plugin

addPersistent(keyName, value, instanceName)

This function adds data to the Tealium persistent data store

addVolatile(keyName, value, instanceName)

This function adds data to the Tealium volatile data store

removeVolatile(keyName, instanceName)

This function removes data from the Tealium volatile data store

removePersistent(keyName, instanceName)

This function removes data from the Tealium persistent data store

getPersistent(keyName, instanceName, callback)

This function retrieves a value from the Tealium Persistent data store

getVolatile(keyName, instanceName, callback)

This function retrieves a value from the Tealium Volatile data store

addRemoteCommand(commandName, instanceName, callback)

This function adds a remote command for later execution

getVisitorId()

This function retrieves the Tealium Visitor ID

TealConfig