core/com.tealium.prism.core.api.modules/ModuleFactory

ModuleFactory

interface ModuleFactory

A ModuleFactory is responsible for creating Module implementations. This will occur during initialization of the Tealium instance, but also when new remote settings have been retrieved, if in use, and the module has since been enabled.

See also

Properties

Link copied to clipboard
open val allowsMultipleInstances: Boolean

Determines whether or not this ModuleFactory should support multiple instances of the Module that it creates.

Link copied to clipboard
abstract val moduleType: String

The unique name identifying this ModuleFactory

Functions

Link copied to clipboard
open fun canBeDisabled(): Boolean

Specifies whether or not the Module produced by this ModuleFactory can be disabled by settings from local and remote sources.

Link copied to clipboard
abstract fun create(moduleId: String, context: TealiumContext, configuration: DataObject): Module?

Called when a new instance of the Module is required to be created.

Link copied to clipboard
open fun getEnforcedSettings(): List<DataObject>

Returns any pre-configured settings for this module that will be enforced throughout the lifetime of the Tealium instance that it is loaded in.