API Reference

Class: Tealium

The methods and constants of the Tealium class for the Tealium Xamarin library.

AddRemoteCommand()

Adds a remote command to the remote command manager.

void AddRemoteCommand(IRemoteCommand remoteCommand);

Example:

public class MyRemoteCommand : IRemoteCommand
    {
        public string CommandId => "my_remote_command";
        public string Description => "description of my remote command";
        public string Path => null;
        public string Url => null;

        public void Dispose()
        {
            //
        }

        public void HandleResponse(IRemoteCommandResponse response)
        {
            var str = response.Payload.GetValueForKey<String>("key");
            if (str == "")
            {
                // etc
            }
        }
    }

tealium.AddRemoteCommand(new MyRemoteCommand());

AddToDataLayer()

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

void AddToDataLayer(IDictionary<string, object> data, Expiry expiry);

tealium.AddToDataLayer(new Dictionary<string, object> {
  { "user_language", lang }
}, Expiry.Forever);

ClearStoredVisitorIds()

Clears the stored visitor IDs and generates a new one. Primarily used for legal compliance.

Visitor IDs will contiue to be stored based on the config setting visitorIdentityKey, if the data layer contains that key.

tealium.ClearStoredVisitorIds();

To avoid storing the newly reset visitorId with the current identity after the storage is cleared, the identity key must be previously deleted from the data layer (see RemoveFromDataLayer()).

ConsentCategory

The consent category values. For use with GetConsentCategories and SetConsentCategories.

The consent categories are:

• ConsentManager.ConsentCategory.Analytics
• ConsentManager.ConsentCategory.Affiliates
• ConsentManager.ConsentCategory.BigData
• ConsentManager.ConsentCategory.Cdp
• ConsentManager.ConsentCategory.CookieMatch
• ConsentManager.ConsentCategory.Crm
• ConsentManager.ConsentCategory.DisplayAds
• ConsentManager.ConsentCategory.Email
• ConsentManager.ConsentCategory.Engagement
• ConsentManager.ConsentCategory.Misc
• ConsentManager.ConsentCategory.Mobile
• ConsentManager.ConsentCategory.Monitoring
• ConsentManager.ConsentCategory.Personalization
• ConsentManager.ConsentCategory.Search
• ConsentManager.ConsentCategory.Social

ConsentStatus

The consent status values. For use with SetConsentStatus().

Environment

The environment is one of three default environments (Dev, QA, Prod) or any custom environment that you publish to.

Expiry

Defines the expiration of persistent or volatile data. For use with AddToDataLayer().

GetFromDataLayer()

Retrieves the value for a specified key in the persistent data layer.

object? GetFromDataLayer(string key);

string myString = (string)tealium.GetFromDataLayer("user_language");

GetConsentCategories()

Get the list of categories that the user consented to.

List<ConsentCategory>? GetConsentCategories();

Example:

tealium.GetConsentCategories().ForEach((c) =>
{
    if (c == ConsentManager.ConsentCategory.Analytics)
    {
        // consented to Analytics
    }
});

GetConsentStatus()

Gets the current state of the user’s consent. Returns a ConsentStatus value.

ConsentStatus GetConsentStatus();

Example:

switch (tealium.GetConsentStatus()) {
    case ConsentManager.ConsentStatus.Unknown:
        break;
    case ConsentManager.ConsentStatus.Consented:
        break;
    case ConsentManager.ConsentStatus.NotConsented:
        break;
}

GetVisitorId()

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

string? visitorId = tealium.GetVisitorId();

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();

RemoveFromDataLayer()

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

void RemoveFromDataLayer(ICollection<string> keys);

tealium.RemoveFromDataLayer(new string[] { "key1", "key2" });

RemoveRemoteCommand()

Removes a remote command from the remote command manager.

void RemoveRemoteCommand(string id);

tealium.RemoveRemoteCommand("firebase");

ResetVisitorId()

Resets the visitor ID and generates a new one.

tealium.ResetVisitorId();

SetConsentCategories()

Sets the list of categories that the user consented to. For use with ConsentCategory.

void SetConsentCategories(List<ConsentCategory> categories);

tealium.SetConsentCategories(new List<ConsentManager.ConsentCategory>()
{
    ConsentManager.ConsentCategory.DisplayAds,
    ConsentManager.ConsentCategory.Analytics
});

SetConsentExpiryListener()

Sets a callback method to execute when the consent preferences have expired.

void SetConsentExpiryListener(Action callback);

tealium.SetConsentExpiryListener(() =>
{
    System.Diagnostics.Debug.WriteLine("Consent Expired");
});

SetConsentStatus()

Sets the consent status for a user. Default value is .Unknown until it’s set.

void SetConsentStatus(ConsentStatus status);

tealium.SetConsentStatus(ConsentManager.ConsentStatus.NotConsented);

SetVisitorServiceListener()

Sets a callback function to execute when the visitor profile has been updated. The updated VisitorProfile is provided in the callback response. For use when visitorServiceEnabled is set to true.

Use this feature if you are licensed for Tealium AudienceStream and you want to use the visitor profile to enhance the user experience in your mobile application.

void SetVisitorServiceListener(Action callback);

tealium.SetVisitorServiceListener((visitorProfile) =>
{
    System.Diagnostics.Debug.WriteLine("Visitor Updated");
    System.Diagnostics.Debug.WriteLine($"Visitor: {visitorProfile}");
});

TerminateIntance()

Disables the Tealium library and removes all module references.

tealium.TerminateIntance();

Track()

Track an event with either a TealiumEvent or TealiumView dispatch.

tealium.Track(tealEvent);

To track events, create a TealiumEvent object, and pass it to the track() method:

tealium.Track(new TealiumEvent("cart_add", new Dictionary<string, object> {
    { "customer_id", "abc123" }, 
    { "product_id", ["PROD123", "PROD456"] },
    { "product_price", [4.00, 6.00] }
}));

Class: TealiumConfig

The following summarizes the properties of the TealiumConfig class.

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 Collectors property set in TealiumConfig.

TealiumConfig tealConfig = new TealiumConfig(
    // ...
    new List<Collectors> {
        Collectors.LifeCycle, Collectors.Device
    }
    // ...
);

ConsentExpiry

Sets the expiration of consent preferences on the TealiumConfig object.

TealiumConfig config = new TealiumConfig(
  //...
  consentExpiry = new TimeUnit(90, TimeUnit.Days)),
  //...
);

ConsentPolicy

Sets the consent policy to use on the TealiumConfig object. If a consent policy is not set, the consent manager is disabled.

TealiumConfig config = new TealiumConfig(
  //...
  consentPolicy = ConsentPolicy.GDPR,
  //...
);

Consent values:

• ConsentPolicy.GDPR
• ConsentPolicy.CCPA

Dispatchers

Dispatchers are modules that send the data to a Tealium endpoint. These are set on the TealiumConfig object.

TealiumConfig tealConfig = new TealiumConfig(
    // ...
    new List<Dispatchers> {
        Dispatchers.Collect, Dispatchers.RemoteCommands
    }
    // ...
);

The following dispatchers are available:

• Dispatchers.Collect
• Dispatchers.RemoteCommands
• Dispatchers.TagManagement

At least one dispatcher is required.

LogLevel

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

IRemoteCommand

An interface that defines a configured remote command.

IVisitorProfile

(For use with TealiumConfig.visitorServiceEnabled.)

The visitor profile object contains visitor attributes returned from the visitor service. The currentVisit property contains attributes scoped to the current visit. Access each attribute value by ID using a subscript. If the attribute does not exist, null is returned.

ICurrentVisit

The object that contains attributes scoped to the current visit.

Interface: TealiumDispatch

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

Class: TealiumEvent

To track a user’s interaction with a screen or a screen view, 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 data dictionary.

tealium.Track(new TealiumEvent("tealiumEvent", new Dictionary<string, object> {
    eventData
}));

Example:

tealium.Track(new TealiumEvent("cart_add", new Dictionary<string, object> {
    { "customer_id", "abc123" }, 
    { "product_id", ["PROD123", "PROD456"] },
    { "product_price", [4.00, 6.00] }
}));

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.

tealium.Track(new TealiumView("tealiumEvent", new Dictionary<string, object> {
    eventData
}));

Example:

tealium.Track(new TealiumView("purchase", new Dictionary<string, object> {
    { "customer_id", "abc123" },
    { "order_total", 10.00 },
    { "product_id", ["PROD123", "PROD456"] },
    { "order_id", "0123456789" }
}));