TEALConfiguration Class Reference

Inherits from NSObject
Declared in TEALConfiguration.h

Overview

Configuration Class for the Tealium Mobile Library An instance of this is passed to Tealium enableWithConfiguration: to start the Collect Library

Other Methods

  accountName

Tealium iQ account name

@property (nonatomic, copy) NSString *accountName

Declared In

TEALConfiguration.h

  profileName

Tealium iQ profile name, this should be the TiQ profile where the mobile publish settings have been configured for Tealium collect.

@property (nonatomic, copy) NSString *profileName

Discussion

Note: This is usually not the same profile used for Collect which defaults to “main”

Declared In

TEALConfiguration.h

  environmentName

Tealium iQ evnvironment name.

@property (nonatomic, copy) NSString *environmentName

Discussion

@example dev/qa/prod

Declared In

TEALConfiguration.h

  datasourceId

Tealium UDH Data source Id.

@property (nonatomic, copy) NSString *datasourceId

Discussion

@example abc123

Declared In

TEALConfiguration.h

  logLevel

Debug log level to use. Default ‘silent’ (none)

@property (nonatomic) TEALLogLevel logLevel

Declared In

TEALConfiguration.h

  overridePublishSettingsURL

If assigned, will replace the default mobile publish setting source location with an alternate address. Example - “https://my.domain.com/app/publish.html”

@property (nonatomic) NSString *overridePublishSettingsURL

Declared In

TEALConfiguration.h

  overrideTagManagementURL

If assigned, will replace the default address used to retrieve the tag management UTAG.js file. Example - “https://my.domain.com/app/mobile.html”

@property (nonatomic) NSString *overrideTagManagementURL

Declared In

TEALConfiguration.h

Core Methods

+ configurationWithAccount:profile:environment:

Creates a default configration instance for a given account / profile / environment combination. The TiQ information is used to fetch the profile’s mobile publish settings used

+ (instancetype _Nonnull)configurationWithAccount:(NSString *_Nonnull)accountName profile:(NSString *_Nonnull)profileName environment:(NSString *_Nonnull)environmentName

Parameters

accountName

String of TiQ / AudienceStream account name. Required.
profileName

String of TiQ Profile name. Required.
environmentName

String of TiQ Environment name. Typically dev/qa/prod. Required.

Return Value

Valid configuration instance to pass to the enableWithConfiguration: method.

Declared In

TEALConfiguration.h

+ configurationWithAccount:profile:environment:datasource:

Creates a default configration instance for a given account / profile / environment combination. The TiQ information is used to fetch the profile’s mobile publish settings used

+ (instancetype _Nonnull)configurationWithAccount:(NSString *_Nonnull)accountName profile:(NSString *_Nonnull)profileName environment:(NSString *_Nonnull)environmentName datasource:(NSString *_Nullable)datasourceId

Parameters

accountName

String of TiQ / AudienceStream account name. Required.
profileName

String of TiQ Profile name. Required.
environmentName

String of target environment, typically dev, qa, or prod. Required.
datasource

String data source id for UDH. 6 alphanumerics long. Optional.

Return Value

Valid configuration instance to pass to the enableWithConfiguration: method.

Declared In

TEALConfiguration.h

+ isValidConfiguration:

Checks to see if configuration is populated with the minimum required properties.

+ (BOOL)isValidConfiguration:(TEALConfiguration *_Nonnull)configuration

Parameters

configuration

TEALConfiguration to check.

Return Value

Boolean of whether the argument configuration is valid.

Declared In

TEALConfiguration.h

– instanceID

A unique identifier generated from the account-profile-environment.

- (NSString *_Nonnull)instanceID

Return Value

instanceID NSString identifier

Declared In

TEALConfiguration.h

TagManagement Methods

– remoteCommandsEnabled

Read-only flag for remote commands triggerablilty status.

- (BOOL)remoteCommandsEnabled

Discussion

@default YES

Declared In

TEALConfiguration+TagManagement.h

– tagManagementPublishURL

The url source point for retrieving the UTAG.js embedded mobile.html produced by the TIQ system

- (NSString *_Nullable)tagManagementPublishURL

Return Value

NSString String representation of the target address.

Declared In

TEALConfiguration+TagManagement.h

– setOverrideTagManagementPublishURL:

Override the default publishURL source point with another address.

- (void)setOverrideTagManagementPublishURL:(NSString *_Nonnull)publishURL

Parameters

publishURL

The replacement URL to use.

Declared In

TEALConfiguration+TagManagement.h

– setRemoteCommandsEnabled:

Enable or disable the remote command triggerability.

- (void)setRemoteCommandsEnabled:(BOOL)enabled

Parameters

enabled

BOOL to switch remoteCommandEnabled to.

Declared In

TEALConfiguration+TagManagement.h

Collect Methods

– overrideCollectDispatchURL

If assigned, will replace the destination endpoint for Collect dispatch calls.

- (NSString *_Nullable)overrideCollectDispatchURL

Declared In

TEALConfiguration+Collect.h

– overrideS2SLegacyDispatchURL

If assigned, will replace the destination endpoint for S2S Legacy dispatch calls.

- (NSString *_Nullable)overrideS2SLegacyDispatchURL

Declared In

TEALConfiguration+Collect.h

– collectPollingFrequency

Frequency at which visitor profile should be polled.

- (TEALVisitorProfilePollingFrequency)collectPollingFrequency

Declared In

TEALConfiguration+Collect.h

– setOverrideCollectDispatchURL:

Set the destination endpoint for Collect dispatch calls.

- (void)setOverrideCollectDispatchURL:(NSString *_Nonnull)overrideURL

Parameters

overrideURL

The NSString representation of the target URL address to use.

Declared In

TEALConfiguration+Collect.h

– setOverrideS2SLegacyDispatchURL:

Set the destination endpoint for Legacy S2S dispatch calls.

- (void)setOverrideS2SLegacyDispatchURL:(NSString *_Nonnull)overrideURL

Parameters

overrideURL

The NSString representation of the target URL address to use.

Declared In

TEALConfiguration+Collect.h

– setCollectPollingFrequency:

Set the visitor profile polling frequency mode.

- (void)setCollectPollingFrequency:(TEALVisitorProfilePollingFrequency)frequency

Discussion

By default after each sendEventWithData: and sendViewWithData: call an updated visitor profile will be requested. If set to on request, the library will only requery the profile when asked for using fetchVisitorProfileWithCompletion:

@default TEALVisitorProfilePollingFrequencyAfterEveryEvent

See Also

Declared In

TEALConfiguration+Collect.h

Lifecycle Methods

– isAutotrackingLifecycleEnabled

Read-only flag for lifecycle autotracking status.

- (BOOL)isAutotrackingLifecycleEnabled

Discussion

@default YES

Declared In

TEALConfiguration+Lifecycle.h

– setAutotrackingLifecycleEnabled:

Enable or disable the lifecycle autotracking system.

- (void)setAutotrackingLifecycleEnabled:(BOOL)enable

Parameters

enable

BOOL whether autotracking should be on or off.

Declared In

TEALConfiguration+Lifecycle.h