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

PluginConfiguration

class PluginConfiguration(val identifier: String) : Configuration, PluginIdentifiable, PluginEntitiesCallable, PluginAfterTrackCallable, PluginFilterCallable

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

Constructors

PluginConfiguration

constructor(identifier: String)

Functions

afterTrack

fun afterTrack(schemas: List<String>? = null, closure: Consumer<InspectableEvent>): PluginConfiguration

Add a closure that is called after the events are tracked. The closure is called after the events are added to event queue in Emitter, not necessarily after they are sent to the Collector.

copy

open override fun copy(): Configuration

entities

fun entities(schemas: List<String>? = null, closure: Function<InspectableEvent, List<SelfDescribingJson>>)

Add a closure that generates entities for a given tracked event.

filter

fun filter(schemas: List<String>? = null, closure: Function<InspectableEvent, Boolean>): PluginConfiguration

Add a closure that is called to decide whether to track a given event or not.

Properties

afterTrackConfiguration

open override var afterTrackConfiguration: PluginAfterTrackConfiguration?

Closure configuration that is called after events are tracked.

entitiesConfiguration

open override var entitiesConfiguration: PluginEntitiesConfiguration?

Closure configuration that is called when events are tracked to generate context entities to enrich the events.

filterConfiguration

open override var filterConfiguration: PluginFilterConfiguration?

Closure configuration that is called to decide whether to track a given event or not.

identifier

open override val identifier: String

Unique identifier of the plugin within the tracker.