Package-level declarations
Root package and entry point for the Context API module
TODO
Types
Link copied to clipboard
interface ContextApi
The ContextApi module retrieves visitor profile data from Tealium AudienceStream.
Link copied to clipboard
class ContextApiConfigurationException(message: String? = null, cause: Throwable? = null) : TealiumException
Configuration exception for ContextApi module setup errors.
Link copied to clipboard
Represents the available regions for the ContextApi.
Link copied to clipboard
Builder for ContextApi module settings.
Link copied to clipboard
data class EngineResponse(val audiences: List<String>? = null, val badges: List<String>? = null, val flags: Map<String, Boolean>? = null, val dates: Map<String, Long>? = null, val metrics: Map<String, Double>? = null, val properties: Map<String, String>? = null)
Represents the response structure from the ContextApi engine.
Properties
Link copied to clipboard
The Module.id of the ContextApi module.
Link copied to clipboard
Returns the ContextApi instance for a given Tealium instance
Link copied to clipboard
Returns the default ModuleFactory implementation that will not create any instances unless there are settings provided from Local or Remote sources.
Functions
Link copied to clipboard
fun Modules.contextApi(enforcedSettings: (ContextApiSettingsBuilder) -> ContextApiSettingsBuilder? = { it }): ModuleFactory
Returns a configured ModuleFactory for enabling the ContextApi Module.