Snowplow Android Tracker 3.1.2
Public Member Functions | Public Attributes | List of all members
com.snowplowanalytics.snowplow.configuration.GlobalContextsConfiguration Class Reference
Inheritance diagram for com.snowplowanalytics.snowplow.configuration.GlobalContextsConfiguration:
com.snowplowanalytics.snowplow.configuration.Configuration com.snowplowanalytics.snowplow.internal.globalcontexts.GlobalContextsConfigurationInterface

Public Member Functions

 GlobalContextsConfiguration (@Nullable Map< String, GlobalContext > contextGenerators)
 
Set< String > getTags ()
 
boolean add (@NonNull String tag, @NonNull GlobalContext contextGenerator)
 
GlobalContext remove (@NonNull String tag)
 
GlobalContextsConfiguration copy ()
 

Public Attributes

final Map< String, GlobalContextcontextGenerators
 

Detailed Description

This class allows the setup of Global Contexts which are attached to selected events.

Definition at line 16 of file GlobalContextsConfiguration.java.

Constructor & Destructor Documentation

◆ GlobalContextsConfiguration()

com.snowplowanalytics.snowplow.configuration.GlobalContextsConfiguration.GlobalContextsConfiguration ( @Nullable Map< String, GlobalContext contextGenerators)

Allows for the creation of a map of tags and associated GlobalContext generators. They are used by the tracker based on the filter settings defined on each GlobalContext.

Parameters
contextGeneratorsMap of Global Contexts generators.

Definition at line 28 of file GlobalContextsConfiguration.java.

Member Function Documentation

◆ add()

boolean com.snowplowanalytics.snowplow.configuration.GlobalContextsConfiguration.add ( @NonNull String  tag,
@NonNull GlobalContext  contextGenerator 
)

Add a GlobalContext generator to the configuration of the tracker.

Parameters
tagThe label identifying the generator in the tracker.
contextGeneratorThe GlobalContext generator.
Returns
Whether the adding operation has succeeded.

Implements com.snowplowanalytics.snowplow.internal.globalcontexts.GlobalContextsConfigurationInterface.

Definition at line 50 of file GlobalContextsConfiguration.java.

◆ copy()

GlobalContextsConfiguration com.snowplowanalytics.snowplow.configuration.GlobalContextsConfiguration.copy ( )

◆ getTags()

Set< String > com.snowplowanalytics.snowplow.configuration.GlobalContextsConfiguration.getTags ( )
Returns
Set of tags associated to added GlobalContexts.

Implements com.snowplowanalytics.snowplow.internal.globalcontexts.GlobalContextsConfigurationInterface.

Definition at line 39 of file GlobalContextsConfiguration.java.

◆ remove()

GlobalContext com.snowplowanalytics.snowplow.configuration.GlobalContextsConfiguration.remove ( @NonNull String  tag)

Remove a GlobalContext generator from the configuration of the tracker.

Parameters
tagThe label identifying the generator in the tracker.
Returns
Whether the removing operation has succeded.

Implements com.snowplowanalytics.snowplow.internal.globalcontexts.GlobalContextsConfigurationInterface.

Definition at line 65 of file GlobalContextsConfiguration.java.

Member Data Documentation

◆ contextGenerators

final Map<String, GlobalContext> com.snowplowanalytics.snowplow.configuration.GlobalContextsConfiguration.contextGenerators

Definition at line 19 of file GlobalContextsConfiguration.java.


The documentation for this class was generated from the following file: