momentsapi/com.tealium.prism.momentsapi

Package-level declarations

Root package and entry point for the Moments API module

TODO

Types

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 MomentsApi engine.

interface MomentsApi

The MomentsApi module retrieves visitor profile data from Tealium AudienceStream.

MomentsApiConfigurationException

class MomentsApiConfigurationException(message: String? = null, cause: Throwable? = null) : TealiumException

Configuration exception for MomentsApi module setup errors.

MomentsApiRegion

sealed class MomentsApiRegion : DataItemConvertible

Represents the available regions for the MomentsApi.

MomentsApiSettingsBuilder

class MomentsApiSettingsBuilder : ModuleSettingsBuilder<MomentsApiSettingsBuilder>

Builder for MomentsApi module settings.

Properties

DEFAULT_FACTORY

val DEFAULT_FACTORY: ModuleFactory

Returns the default ModuleFactory implementation that will not create any instances unless there are settings provided from Local or Remote sources.

val Modules.Types.MOMENTS_API: String

The Module.id of the MomentsApi module.

val Tealium.momentsApi: MomentsApi

Returns the MomentsApi instance for a given Tealium instance

Functions

fun Modules.momentsApi(enforcedSettings: (MomentsApiSettingsBuilder) -> MomentsApiSettingsBuilder? = { it }): ModuleFactory

Returns a configured ModuleFactory for enabling the MomentsApi Module.