core/com.tealium.prism.core.api/TealiumConfig/Builder

Builder

class Builder(val application: Application, val accountName: String, val profileName: String, val environment: String, modules: List<ModuleFactory>)

A builder class for configuring a Tealium instance.

Parameters

application

The android Application object

accountName

The Tealium account name

profileName

The Tealium profile name

environment

The Tealium environment

modules

A list of unique ModuleFactory's each one for creating a specific Module

Constructors

Builder

constructor(application: Application, accountName: String, profileName: String, environment: String, modules: List<ModuleFactory>)

Properties

accountName

val accountName: String

application

val application: Application

environment

val environment: String

profileName

val profileName: String

Functions

addBarrier

fun addBarrier(barrier: BarrierFactory): TealiumConfig.Builder

Adds a BarrierFactory that will create a ConfigurableBarrier to control the flow of dispatches to the Dispatchers.

addLoadRule

fun addLoadRule(id: String, rule: Rule<Condition>): TealiumConfig.Builder

Sets a load rule to be used by any of the modules by the rule's id.

addModule

fun addModule(module: ModuleFactory): TealiumConfig.Builder

Adds a ModuleFactory to the list of modules that need to be instantiated by the SDK.

addTransformation

fun addTransformation(transformation: TransformationSettings): TealiumConfig.Builder

Sets a transformation to be used by a specific transformer.

build

fun build(): TealiumConfig

Takes an immutable copy of any configured settings

configureCoreSettings

fun configureCoreSettings(enforcingCoreSettings: (CoreSettingsBuilder) -> CoreSettingsBuilder): TealiumConfig.Builder

Configures core settings related to the SDK.

enableConsentIntegration

@JvmOverloads

fun enableConsentIntegration(cmpAdapter: CmpAdapter, enforcedSettings: (ConsentConfigurationBuilder) -> ConsentConfigurationBuilder? = null): TealiumConfig.Builder

Enable consent integration with a CmpAdapter.

setDataSource

fun setDataSource(datasource: String): TealiumConfig.Builder

Sets the data source id used to identify data coming from this SDK.

setExistingVisitorId

fun setExistingVisitorId(existingVisitorId: String): TealiumConfig.Builder

A known existing visitor id to use on first launch instead of our anonymous id

setLogHandler

fun setLogHandler(logHandler: LogHandler): TealiumConfig.Builder

The LogHandler to delegate logging events to; default will write to android.util.Log

setSettingsFile

fun setSettingsFile(filename: String): TealiumConfig.Builder

The name of the file in the Assets folder that contains local JSON Settings.

setSettingsUrl

fun setSettingsUrl(url: String): TealiumConfig.Builder

The url to download Remote JSON Settings from.