snowplow-android-tracker/com.snowplowanalytics.snowplow.configuration/GlobalContextsConfiguration

GlobalContextsConfiguration

class GlobalContextsConfiguration(contextGenerators: MutableMap<String, GlobalContext>?) : Configuration, GlobalContextsConfigurationInterface

This class allows the setting up of Global Contexts. Global Contexts are entities which are attached to selected events. Provide a GlobalContextsConfiguration when creating a tracker to use them. GlobalContext can also be added and removed at runtime. Multiple GlobalContexts can be set along with their identifying tags (i.e. name).

Constructors

constructor(contextGenerators: MutableMap<String, GlobalContext>?)

Functions

add

open override fun add(tag: String, contextGenerator: GlobalContext): Boolean

Add a GlobalContext generator to the tracker at runtime.

copy

open override fun copy(): GlobalContextsConfiguration

remove

open override fun remove(tag: String): GlobalContext?

Remove a GlobalContext generator from the tracker at runtime.

Properties

contextGenerators

val contextGenerators: MutableMap<String, GlobalContext>

The component GlobalContexts with their tags.