snowplow-android-tracker/com.snowplowanalytics.snowplow.event/ConsentDocument

ConsentDocument

class ConsentDocument(documentId: String, documentVersion: String) : AbstractSelfDescribing

A consent document event.

Parameters

documentId

identifier of the document.

documentVersion

version of the document.

Constructors

ConsentDocument

fun ConsentDocument(documentId: String, documentVersion: String)

Functions

beginProcessing

open override fun beginProcessing(tracker: Tracker)

Hook method called just before the event processing in order to execute special operations.

contexts

fun ~~contexts~~(contexts: List<SelfDescribingJson>?): AbstractEvent

Adds a list of contexts.

documentDescription

fun documentDescription(documentDescription: String?): ConsentDocument

Description of the document.

documentName

fun documentName(documentName: String?): ConsentDocument

Name of the document.

endProcessing

open override fun endProcessing(tracker: Tracker)

Hook method called just after the event processing in order to execute special operations.

entities

fun entities(entities: List<SelfDescribingJson>?): AbstractEvent

Adds a list of contexts.

trueTimestamp

fun trueTimestamp(trueTimestamp: Long?): AbstractEvent

Set the custom timestamp of the event.

Properties

contexts

open override val contexts: List<SelfDescribingJson>

customContexts

val customContexts: MutableList<SelfDescribingJson>

List of custom contexts associated with the event.

dataPayload

open override val dataPayload: Map<String, Any?>

documentDescription

var documentDescription: String? = null

Description of the document.

documentId

val documentId: String

Identifier of the document.

documentName

var documentName: String? = null

Name of the document.

documentVersion

val documentVersion: String

Version of the document.

entities

open override val entities: List<SelfDescribingJson>

schema

open override val schema: String

trueTimestamp

open override var trueTimestamp: Long? = null