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

ModuleSettingsBuilder

open class ModuleSettingsBuilder<T : ModuleSettingsBuilder<T>>(moduleType: String)

Base class to extend from when creating a settings builder for a new module.

Module settings are expected to be DataObjects and as such, this class becomes a wrapper around a standard DataObject.Builder, but allows for implementations to provide more user-friendly method names.

Therefore it also doesn't require users to know which json key any particular setting needs to be set at.

Inheritors

RuleModuleSettingsBuilder

Constructors

ModuleSettingsBuilder

constructor(moduleType: String)

Functions

build

fun build(): DataObject

Returns the complete Module settings as configured by this ModuleSettingsBuilder.

setEnabled

fun setEnabled(enabled: Boolean): T

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

setOrder

fun setOrder(order: Int): T

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