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

Package-level declarations

Types

class ConfigurationBundle @JvmOverloads constructor(val namespace: String, networkConfiguration: NetworkConfiguration? = null) : Configuration

ConfigurationState

enum ConfigurationState : Enum<ConfigurationState>

State of retrieved remote configuration that states where the configuration was retrieved from.

EmitterConfiguration

open class EmitterConfiguration : Configuration, EmitterConfigurationInterface

It allows the tracker configuration from the emission perspective. The EmitterConfiguration can be used to setup details about how the tracker should treat the events to emit to the collector.

GdprConfiguration

open class GdprConfiguration(val basisForProcessing: Basis, val documentId: String?, val documentVersion: String?, val documentDescription: String?) : Configuration, GdprConfigurationInterface

This class allows the GDPR configuration of the tracker.

GlobalContextsConfiguration

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

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

NetworkConfiguration

class NetworkConfiguration : NetworkConfigurationInterface, Configuration

Represents the network communication configuration allowing the tracker to be able to send events to the Snowplow collector.

PluginAfterTrackConfiguration

class PluginAfterTrackConfiguration(val schemas: List<String>? = null, val closure: Consumer<InspectableEvent>)

Provides a block closure to be called after events are tracked. Optionally, you can specify the event schemas for which the block should be called.

PluginConfiguration

class PluginConfiguration(val identifier: String) : Configuration, PluginConfigurationInterface

Configuration for a custom tracker plugin. Enables you to add closures to be called when and after events are tracked in the tracker.

PluginConfigurationInterface

interface PluginConfigurationInterface

Interface for tracker plugin definition. Specifies configurations for the closures called when and after events are tracked.

PluginEntitiesConfiguration

class PluginEntitiesConfiguration(val schemas: List<String>? = null, val closure: Function<InspectableEvent, List<SelfDescribingJson>>)

Provides a block closure that returns a list of context entities and is called when events are tracked. Optionally, you can specify the event schemas for which the block should be called.

RemoteConfiguration

class RemoteConfiguration(endpoint: String, method: HttpMethod) : Configuration

Represents the configuration for fetching configurations from a remote source.

SessionConfiguration

open class SessionConfiguration(var foregroundTimeout: TimeMeasure, var backgroundTimeout: TimeMeasure) : SessionConfigurationInterface, Configuration

This class represents the configuration of the applications session. The SessionConfiguration can be used to setup the behaviour of sessions.

SubjectConfiguration

open class SubjectConfiguration : Configuration, SubjectConfigurationInterface

This class represents the configuration of the subject. The SubjectConfiguration can be used to setup the tracker with the basic information about the user and the app which will be attached on all the events as contexts. The contexts to track can be enabled in the TrackerConfiguration class.

TrackerConfiguration

open class TrackerConfiguration(var appId: String) : TrackerConfigurationInterface, Configuration

This class represents the configuration of the tracker and the core tracker properties. The TrackerConfiguration can be used to setup the tracker behaviour indicating what should be tracked in term of automatic tracking and contexts/entities to track with the events.