Module Protocol Reference
public protocol Module : AnyObjectA Module is the generic protocol that any plugin added to tealium must conform.
Each module, then, can conform to each of the following protocols as well to add extra functionality:
Collector: To enrich the collectedDispatches with extra data.Dispatcher: To send theDispatches and their data outside of this SDK, potentially the Tealium Platform or a 3rd party Vendor.Transformer: To change or drop theDispatches and their data before reaching theDispatchers.
A module used by the Tealium SDK to provide some plugin functionality.
-
The version of this module
Declaration
Swift
var version: String { get } -
The unique id for this module, used to uniquely identify each module instance.
Declaration
Swift
var id: String { get } -
canBeDisabledDefault implementationReturns true if the module is optional and can be disabled, or false otherwise. Default is true.
Default Implementation
Declaration
Swift
static var canBeDisabled: Bool { get } -
updateConfiguration(_:Default implementation) Updates the configuration and, if the configuration is valid, return the same class otherwise return nil and the module is considered disabled.
Default Implementation
Declaration
Swift
func updateConfiguration(_ configuration: DataObject) -> Self? -
shutdown()Default implementationCalled when a previously created module needs to shut down, to allow it to perform some final cleanup before removing it form the available modules.
Default Implementation
Declaration
Swift
func shutdown()