com.tealium.library

Class Tealium.Config

java.lang.Object

com.tealium.library.Tealium.Config

Enclosing class:

Tealium

public abstract static class Tealium.Config
extends java.lang.Object

Configuration for Tealium

Field Summary

Fields

Modifier and Type	Field and Description
protected static ConsentManager	DEFAULT_CONSENT_MANAGER
protected static java.lang.String	DEFAULT_DATASOURCE_ID
protected static java.lang.String	DEFAULT_FORCE_OVERRIDE_LOGLEVEL
protected static boolean	DEFAULT_IS_CONSENT_MANAGER_ENABLED
protected static boolean	DEFAULT_IS_COOKIE_MANAGER_ENABLED
protected static boolean	DEFAULT_IS_REMOTE_COMMAND_ENABLED
protected static java.lang.String	DEFAULT_OVERRIDE_COLLECT_DISPATCH_URL
protected static java.lang.String	DEFAULT_OVERRIDE_PUBLISH_SETTINGS_URL
protected static java.lang.String	DEFAULT_OVERRIDE_TAG_MANAGEMENT_URL

Method Summary

Modifier and Type	Method and Description
static Tealium.Config	create(android.app.Application application, java.lang.String accountName, java.lang.String profileName, java.lang.String environmentName) Create instance of the Config object
Tealium.Config	enableConsentManager(java.lang.String instanceId) Enable Consent Manager
boolean	equals(java.lang.Object o)
java.lang.String	getAccountName()
android.app.Application	getApplication() Internal use only
VisitorProfile	getCachedVisitorProfile()
ConsentManager	getConsentManager()
java.lang.String	getDatasourceId()
java.lang.String	getDefaultTagManagementUrl() Internal Use Only
java.util.List<DispatchValidator>	getDispatchValidators() Add/Remove DispatchValidators by modifying the collection returned by this method
java.lang.String	getEnvironmentName()
java.util.List<java.util.EventListener>	getEventListeners() Add/Remove EventListeners defined in com.tealium.internal.listeners by modifying the collection returned by this method
java.lang.String	getForceOverrideLogLevel()
com.tealium.internal.Logger	getLogger() Internal use only
long	getMinutesBetweenSessionId()
java.lang.String	getOverrideCollectDispatchUrl()
java.lang.String	getOverridePublishSettingsUrl()
java.lang.String	getOverrideS2SLegacyDispatchUrl()
java.lang.String	getOverrideTagManagementUrl()
java.lang.String	getProfileName()
PublishSettings	getPublishSettings() Internal use only
java.io.File	getTealiumDir() Internal use only
boolean	isConsentManagerEnabled()
boolean	isCookieManagerEnabled()
boolean	isRemoteCommandEnabled()
Tealium.Config	setCookieManagerEnabled(boolean isCookieManagerEnabled) Set to enable/disable CookieManager for WebView - enabled by default
Tealium.Config	setDatasourceId(java.lang.String dataSourceId) Set Datasource ID from UDH
Tealium.Config	setForceOverrideLogLevel(java.lang.String forceOverrideLogLevel) Set to force a specific log level at init time
Tealium.Config	setMinutesBetweenSessionId(long minutesBetweenSessionId) Set custom minutes between session id.
Tealium.Config	setOverrideCollectDispatchUrl(java.lang.String overrideDispatchURL) Set the Collect URL Default is https://datacloud.tealiumiq.com/vdata/i.gif?tealium_vid={visitor id}&tealium_account={account}&tealium_profile=main
Tealium.Config	setOverridePublishSettingsUrl(java.lang.String overridePublishSettingsURL) Set the URL for a Publish Settings JSON object instead of parsing from the URL provided by getDefaultTagManagementUrl()
Tealium.Config	setOverrideS2SLegacyDispatchUrl(java.lang.String overrideS2SLegacyURL) Set the Server-to-Server URL using the legacy system Default is https://collect.tealiumiq.com/{account}/{profile}/8/i.gif?data=
Tealium.Config	setOverrideTagManagementUrl(java.lang.String overrideTagManagementUrl) Set the URL for downloading and running UTag Default is https://tags.tiqcdn.com/utag/{account}/{profile}/{environment}/mobile.html
Tealium.Config	setRemoteCommandEnabled(boolean isRemoteCommandEnabled) Set whether reserved RemoteCommands and those added by Tealium.addRemoteCommand(RemoteCommand) can be fireable by TealiumIQ
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_IS_REMOTE_COMMAND_ENABLED

protected static final boolean DEFAULT_IS_REMOTE_COMMAND_ENABLED

See Also:

Constant Field Values

DEFAULT_IS_COOKIE_MANAGER_ENABLED

protected static final boolean DEFAULT_IS_COOKIE_MANAGER_ENABLED

See Also:

Constant Field Values

DEFAULT_IS_CONSENT_MANAGER_ENABLED

protected static final boolean DEFAULT_IS_CONSENT_MANAGER_ENABLED

See Also:

Constant Field Values

DEFAULT_OVERRIDE_TAG_MANAGEMENT_URL

protected static final java.lang.String DEFAULT_OVERRIDE_TAG_MANAGEMENT_URL

DEFAULT_OVERRIDE_PUBLISH_SETTINGS_URL

protected static final java.lang.String DEFAULT_OVERRIDE_PUBLISH_SETTINGS_URL

DEFAULT_OVERRIDE_COLLECT_DISPATCH_URL

protected static final java.lang.String DEFAULT_OVERRIDE_COLLECT_DISPATCH_URL

DEFAULT_DATASOURCE_ID

protected static final java.lang.String DEFAULT_DATASOURCE_ID

DEFAULT_FORCE_OVERRIDE_LOGLEVEL

protected static final java.lang.String DEFAULT_FORCE_OVERRIDE_LOGLEVEL

DEFAULT_CONSENT_MANAGER

protected static final ConsentManager DEFAULT_CONSENT_MANAGER

Method Detail

getTealiumDir

public final java.io.File getTealiumDir()

Internal use only

getApplication

public final android.app.Application getApplication()

Internal use only

getAccountName

public final java.lang.String getAccountName()

Returns:

the account name provided in create(Application, String, String, String)

getProfileName

public final java.lang.String getProfileName()

Returns:

the profile name provided in create(Application, String, String, String)

getEnvironmentName

public final java.lang.String getEnvironmentName()

Returns:

the environment name provided in create(Application, String, String, String)

getDatasourceId

public final java.lang.String getDatasourceId()

Returns:

null or the datasource Id

getMinutesBetweenSessionId

public final long getMinutesBetweenSessionId()

Returns:

minutes between session id interval

getConsentManager

public final ConsentManager getConsentManager()

Returns:

null or consent manager

getDefaultTagManagementUrl

public final java.lang.String getDefaultTagManagementUrl()

Internal Use Only

Returns:

the tiqcdn mobile.html location based on account-profile-environment.

getOverrideTagManagementUrl

public final java.lang.String getOverrideTagManagementUrl()

Returns:

null or URL set by setOverrideTagManagementUrl(String)

getOverridePublishSettingsUrl

public final java.lang.String getOverridePublishSettingsUrl()

Returns:

null or URL set by setOverridePublishSettingsUrl(String) L(String)}

getDispatchValidators

public final java.util.List<DispatchValidator> getDispatchValidators()

Add/Remove DispatchValidators by modifying the collection returned by this method

Returns:

List of DispatchValidators to be used by the library (empty by default)

getEventListeners

public final java.util.List<java.util.EventListener> getEventListeners()

Add/Remove EventListeners defined in com.tealium.internal.listeners by modifying the collection returned by this method

Returns:

List of EventListeners to be used by the library (empty by default)

isRemoteCommandEnabled

public final boolean isRemoteCommandEnabled()

Returns:

true if RemoteCommands are enabled

isCookieManagerEnabled

public final boolean isCookieManagerEnabled()

Returns:

true if Cookie Manager is enabled

getForceOverrideLogLevel

public final java.lang.String getForceOverrideLogLevel()

Returns:

current log level set by setForceOverrideLogLevel method

getCachedVisitorProfile

public final VisitorProfile getCachedVisitorProfile()

Returns:

last fetched VisitorProfile or null if never fetched

getOverrideCollectDispatchUrl

public final java.lang.String getOverrideCollectDispatchUrl()

Returns:

null or URL set by setOverrideCollectDispatchUrl(String) }

getLogger

public final com.tealium.internal.Logger getLogger()

Internal use only

getOverrideS2SLegacyDispatchUrl

public final java.lang.String getOverrideS2SLegacyDispatchUrl()

Returns:

null or URL set by setOverrideS2SLegacyDispatchUrl(String)

enableConsentManager

public Tealium.Config enableConsentManager(java.lang.String instanceId)

Enable Consent Manager

Returns:

instance of the config object for method chaining

isConsentManagerEnabled

public boolean isConsentManagerEnabled()

Returns:

setDatasourceId

public Tealium.Config setDatasourceId(java.lang.String dataSourceId)

Set Datasource ID from UDH

Parameters:

dataSourceId - unique identifier of datasource

Returns:

setMinutesBetweenSessionId

public Tealium.Config setMinutesBetweenSessionId(long minutesBetweenSessionId)

Set custom minutes between session id. Default interval is 30 mins.

Parameters:

minutesBetweenSessionId -

Returns:

setOverrideS2SLegacyDispatchUrl

public Tealium.Config setOverrideS2SLegacyDispatchUrl(java.lang.String overrideS2SLegacyURL)

Set the Server-to-Server URL using the legacy system

Default is

https://collect.tealiumiq.com/{account}/{profile}/8/i.gif?data=

Parameters:

overrideS2SLegacyURL - new URL or null

Returns:

instance of the config object for method chaining

setOverrideCollectDispatchUrl

public Tealium.Config setOverrideCollectDispatchUrl(java.lang.String overrideDispatchURL)

Set the Collect URL

Default is

https://datacloud.tealiumiq.com/vdata/i.gif?tealium_vid={visitor id}&tealium_account={account}&tealium_profile=main

Parameters:

overrideDispatchURL - new URL or null

Returns:

instance of the config object for method chaining

setRemoteCommandEnabled

public Tealium.Config setRemoteCommandEnabled(boolean isRemoteCommandEnabled)

Set whether reserved RemoteCommands and those added by Tealium.addRemoteCommand(RemoteCommand) can be fireable by TealiumIQ

Parameters:

isRemoteCommandEnabled - true for RemoteCommands to be fireable

Returns:

instance of the config object for method chaining

setCookieManagerEnabled

public Tealium.Config setCookieManagerEnabled(boolean isCookieManagerEnabled)

Set to enable/disable CookieManager for WebView - enabled by default

Parameters:

isCookieManagerEnabled - true if Cookie Manager is enabled

Returns:

instance of the config object for method chaining

setForceOverrideLogLevel

public Tealium.Config setForceOverrideLogLevel(java.lang.String forceOverrideLogLevel)

Set to force a specific log level at init time

Parameters:

forceOverrideLogLevel - - options: dev, qa, prod, silent

Returns:

instance of the config object for method chaining

setOverridePublishSettingsUrl

public Tealium.Config setOverridePublishSettingsUrl(java.lang.String overridePublishSettingsURL)

Set the URL for a Publish Settings JSON object instead of parsing from the URL provided by getDefaultTagManagementUrl()

Parameters:

overridePublishSettingsURL - new URL or null

Returns:

instance of the config object for method chaining

setOverrideTagManagementUrl

public Tealium.Config setOverrideTagManagementUrl(java.lang.String overrideTagManagementUrl)

Set the URL for downloading and running UTag

Default is

https://tags.tiqcdn.com/utag/{account}/{profile}/{environment}/mobile.html

Parameters:

overrideTagManagementUrl - new URL or null

Returns:

instance of the config object for method chaining

getPublishSettings

public final PublishSettings getPublishSettings()

Internal use only

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

create

public static Tealium.Config create(android.app.Application application,
                                    java.lang.String accountName,
                                    java.lang.String profileName,
                                    java.lang.String environmentName)

Create instance of the Config object

Parameters:

application - the application instance

accountName - non-empty Tealium-provided account name

profileName - non-empty TealiumIQ profile name

environmentName - "dev", "qa", or "prod"

Returns:

new config instance