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

ConsentWithdrawn

class ConsentWithdrawn(all: Boolean, documentId: String, documentVersion: String) : AbstractSelfDescribing

A consent withdrawn event.

Parameters

all

Whether to withdraw consent for all consent documents.

documentId

Identifier of the first document.

documentVersion

Version of the first document.

Constructors

ConsentWithdrawn

fun ConsentWithdrawn(all: Boolean, 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.

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

Adds a list of contexts.

documentDescription

fun documentDescription(documentDescription: String?): ConsentWithdrawn

Description of the first document.

fun documentName(documentName: String?): ConsentWithdrawn

Name of the first document.

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

Other attached documents.

open override fun endProcessing(tracker: Tracker)

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

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

Adds a list of contexts.

fun trueTimestamp(trueTimestamp: Long?): AbstractEvent

Set the custom timestamp of the event.

Properties

val all: Boolean

Whether to withdraw consent for all consent documents.

consentDocuments

val consentDocuments: MutableList<ConsentDocument>

Other attached documents.

open override val contexts: List<SelfDescribingJson>

val customContexts: MutableList<SelfDescribingJson>

List of custom contexts associated with the event.

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

documentDescription

var documentDescription: String? = null

Description of the first document.

val documentId: String

Identifier of the first document.

var documentName: String? = null

Name of the first document.

val documents: List<ConsentDocument>

documentVersion

val documentVersion: String

Version of the first document.

open override val entities: List<SelfDescribingJson>

open override val schema: String

open override var trueTimestamp: Long? = null