core/com.tealium.prism.core.api.settings.modules/CollectSettingsBuilder

CollectSettingsBuilder

class CollectSettingsBuilder : DispatcherSettingsBuilder<Mappings, CollectSettingsBuilder> , MultipleInstancesModuleSettingsBuilder<CollectSettingsBuilder>

Enables the configuration, at runtime, of the Collect Module.

Note. Any configuration set here will override any configuration provided by the local or remote settings files and will no longer be overridable remotely.

Constructors

constructor()

Functions

build

fun build(): DataObject

Returns the complete Module settings as configured by this ModuleSettingsBuilder.

setBatchUrl

fun setBatchUrl(url: String): CollectSettingsBuilder

Sets the url to use when sending batches of events

setDomain

fun setDomain(domain: String): CollectSettingsBuilder

Sets the domain to use in place of the default single and batch URLs.

setEnabled

fun setEnabled(enabled: Boolean): CollectSettingsBuilder

Sets the resulting Module to be permanently enabled/disabled. Local/Remote settings sources will be overridden by this

setMappings

fun setMappings(mappings: Callback<Mappings>): CollectSettingsBuilder

fun setMappings(mappings: Mappings.() -> Unit): CollectSettingsBuilder

Set the mappings for this module.

setModuleId

open override fun setModuleId(moduleId: String): CollectSettingsBuilder

Overrides the Module.id for cases where multiple instances of a Module are supported.

setOrder

fun setOrder(order: Int): CollectSettingsBuilder

Sets the order in which the Module needs to be initialized.

setProfile

fun setProfile(profile: String): CollectSettingsBuilder

Sets the Tealium profile to use when sending the event. Use this when the profile differs to the one configured in the TealiumConfig

setRules

fun setRules(rules: Rule<String>): CollectSettingsBuilder

Sets the rules that this Module needs to match in order to process an event (e.g. collection or dispatching)

setUrl

fun setUrl(url: String): CollectSettingsBuilder

Sets the url to use when sending individual events