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

Dispatcher

interface Dispatcher : Module

A Dispatcher is a specialized Module that is the destination for any Dispatches tracked through the SDK.

Properties

Link copied to clipboard
open val dispatchLimit: Int

Sets the maximum number of Dispatches that can safely be processed by the dispatch implementation. Default is 1

Link copied to clipboard
abstract val id: String

The unique id identifying this Module

Link copied to clipboard
abstract val version: String

A string describing the version of this Module.

Functions

Link copied to clipboard
abstract fun dispatch(dispatches: List<Dispatch>, callback: Callback<List<Dispatch>>): Disposable

Called when a new Dispatch is ready to be processed by this Dispatcher.

Link copied to clipboard
open fun onShutdown()

Called when this Module has been determined to be shutdown. This could happen for the following reasons:

Link copied to clipboard
open fun updateConfiguration(configuration: DataObject): Module?

Called whenever updated configuration has been made available for this specific Module.