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

constructor(documentId: String, documentVersion: String)

Functions

contexts

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

Adds a list of context entities to the existing ones.

documentDescription

fun documentDescription(documentDescription: String?): ConsentDocument

Description of the document.

documentName

fun documentName(documentName: String?): ConsentDocument

Name of the document.

entities

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

Adds a list of context entities to the existing ones.

trueTimestamp

fun trueTimestamp(trueTimestamp: Long?): AbstractEvent

Set the custom timestamp of the event.

Properties

contexts

open override var ~~contexts~~: List<SelfDescribingJson>

dataPayload

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

The payload for the event.

documentDescription

var documentDescription: String?

Description of the document.

documentId

val documentId: String

Identifier of the document.

documentName

var documentName: String?

Name of the document.

documentVersion

val documentVersion: String

Version of the document.

entities

open override var entities: MutableList<SelfDescribingJson>

entitiesForProcessing

open val entitiesForProcessing: List<SelfDescribingJson>?

Used for events whose properties are added as entities, e.g. Ecommerce events

schema

open override val schema: String

The event schema

trueTimestamp

open override var trueTimestamp: Long?