API Reference

Class: Config

The following summarizes the commonly used methods of the C# Config class.

Method	Description
Config()	Tealium configuration constructor

Config()

Constructor to configure the Tealium instance

Config tealConfig = new Config(account, profile, environment,
                               visitorID, modules, dataSourceKey,
                               overrideCollectUrl, optionalData, method);

Parameters	Type	Description	Example
account	string	Tealium Account name	"companyXYZ"
profile	string	Tealium profile name	"main"
environment	string	(Optional) Tealium environment name	["dev", "qa", "prod"]
visitorID	string	32-char alphanumeric string ID, unique to a user, app instance, or device (null ok)	"t3aL...1uM"
modules	[string]	(Optional) Modules to be initialized with Collect library	See Available Modules
dataSourceKey	string	(Optional) Data source key
overrideCollectUrl	string	(Optional) Override Collect URL (custom destination URL for data)
optionalData	Dictionary<string, object>	(Optional) Data as key-value pairs for module use (null acceptable - not needed for most setups)
method	Method enum	(Optional) Determines HTTP method used to send data to the Tealium Collect Endpoint	[Method.POST, Method.GET]

Class: Tealium

The following summarizes the commonly used methods of the C# Tealium class.

Method	Description
Disable()	Disable Tealium library modules
Enable()	Enable Tealium library modules
JoinTrace()	Join a trace
KillTraceSession()	Kill/end a trace
LeaveTrace()	Leave a trace
Tealium()	Tealium constructor
Track()	Track events

Enable()

Enable the Tealium instance, after a Disable() call. Automatically called with the initial initialization. Re-enable the Tealium instance and any internal modules if the library had been disabled prior.

tealium.Enable()

Disable()

Diable the Tealium instance. Disables library modules from temporarily processing events. It may de-initialize internal class objects.

tealium.Disable()

JoinTrace()

Join a trace identified by the traceId parameter. traceId will be sent on all subsequent events as the key, allowing you to debug your events, until the LeaveTrace() method is called. The traceId parameter should be generated in advance within Tealium Customer Data Hub.

tealium.JoinTrace(traceId);

Parameters	Type	Description	Example
traceId	string	Trace ID to join	"12345"

KillTraceSession()

Kill a trace. Issues a specific event that kills the trace visitor session at the server. This is useful for testing end-of-session behavior in Customer Data Hub.

tealiumObj.KillTraceSession();

LeaveTrace()

Leave a trace, if one has been joined.

tealiumObj.LeaveTrace();

Tealium()

Constructor method of the Tealium class.

Tealium tealium = new Tealium(tealConfig);

Parameters	Type	Description
tealConfig	Config	Config instance

Track()

Track Events.

tealium.Track(title, customData, completion);

Parameters	Type	Description
title	string	Event identifier
customData	Dictionary<string, object>	(Optional) Event data as key-value pairs (set to null if none)
completion	TrackCompletion (set to null if none)	(Optional) Completion block to trigger after track call

Available Modules

The following constant string values are used to enable modules with the current build:

config.Modules = new string[] { AppDataModule.Name,
                                CollectModule.Name,
                                LoggerModule.Name };

Module Name	Description
AppDataModule	Adds automatic data points to calls
CollectModule	Delivers processed events to Tealium Collect endpoint
LoggerModule	Provides debug output

Use the .Name constant of each Module class.