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

VisitorIdSettingsBuilder

class VisitorIdSettingsBuilder : CollectorSettingsBuilder<VisitorIdSettingsBuilder>

A ModuleSettingsBuilder implementation to configure visitor ID handling, exposed at runtime through Tealium.visitorId.

See also

VisitorIdManager

Constructors

VisitorIdSettingsBuilder

constructor()

Functions

fun build(): DataObject

Returns the complete Module settings as configured by this ModuleSettingsBuilder.

fun setEnabled(enabled: Boolean): VisitorIdSettingsBuilder

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

fun setOrder(order: Int): VisitorIdSettingsBuilder

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

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

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

setVisitorIdentityKey

fun setVisitorIdentityKey(key: String): VisitorIdSettingsBuilder

Sets the data layer key that holds the current user's identity, enabling Visitor Switching.