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

ConsentGranted

class ConsentGranted(expiry: String, documentId: String, documentVersion: String) : AbstractSelfDescribing

A consent granted event.

Parameters

expiry

Consent expiration.

documentId

Identifier of the first document.

documentVersion

Version of the first document.

Constructors

constructor(expiry: String, documentId: String, documentVersion: String)

Functions

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

Adds a list of context entities to the existing ones.

documentDescription

fun documentDescription(documentDescription: String?): ConsentGranted

Description of the first document.

fun documentName(documentName: String?): ConsentGranted

Name of the first document.

fun documents(documents: List<ConsentDocument>): ConsentGranted

Other attached documents.

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

Adds a list of context entities to the existing ones.

fun trueTimestamp(trueTimestamp: Long?): AbstractEvent

Set the custom timestamp of the event.

Properties

consentDocuments

val consentDocuments: MutableList<ConsentDocument>

Other attached documents.

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

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

The payload for the event.

documentDescription

var documentDescription: String?

Description of the first document.

val documentId: String

Identifier of the first document.

var documentName: String?

Name of the first document.

val documents: List<ConsentDocument>

Returns a list of consent documents associated with the event.

documentVersion

val documentVersion: String

Version of the first document.

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

val expiry: String

Expiration of the consent.

open override val schema: String

The event schema

open override var trueTimestamp: Long?