com.snowplowanalytics.snowplow.event

Class ConsentGranted

java.lang.Object

com.snowplowanalytics.snowplow.event.AbstractEvent

com.snowplowanalytics.snowplow.event.AbstractSelfDescribing

com.snowplowanalytics.snowplow.event.ConsentGranted

All Implemented Interfaces:

Event

public class ConsentGranted
extends AbstractSelfDescribing

A consent granted event.

Field Summary

Fields

Modifier and Type	Field and Description
List<ConsentDocument>	consentDocuments Other attached documents.
String	documentDescription Description of the first document.
String	documentId Identifier of the first document.
String	documentName Name of the first document.
String	documentVersion Version of the first document.
String	expiry Expiration of the consent.

Fields inherited from class com.snowplowanalytics.snowplow.event.AbstractEvent

customContexts, trueTimestamp

Constructor Summary

Constructors

Constructor and Description
ConsentGranted(String expiry, String documentId, String documentVersion) Creates a consent granted event with a first document.

Method Summary

Modifier and Type	Method and Description
void	beginProcessing(com.snowplowanalytics.snowplow.internal.tracker.Tracker tracker) Hook method called just before the event processing in order to execute special operations.
ConsentGranted	documentDescription(String documentDescription) Description of the first document.
ConsentGranted	documentName(String documentName) Name of the first document.
ConsentGranted	documents(List<ConsentDocument> documents) Other attached documents.
Map<String,Object>	getDataPayload()
List<ConsentDocument>	getDocuments() Returns a list of consent documents associated with the event.
String	getSchema()

Methods inherited from class com.snowplowanalytics.snowplow.event.AbstractEvent

contexts, endProcessing, getContexts, getTrueTimestamp, trueTimestamp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

expiry

@NonNull
public final String expiry

Expiration of the consent.

documentId

@NonNull
public final String documentId

Identifier of the first document.

documentVersion

@NonNull
public final String documentVersion

Version of the first document.

documentName

@Nullable
public String documentName

Name of the first document.

documentDescription

@Nullable
public String documentDescription

Description of the first document.

consentDocuments

@NonNull
public final List<ConsentDocument> consentDocuments

Other attached documents.

Constructor Detail

ConsentGranted

public ConsentGranted(@NonNull
                      String expiry,
                      @NonNull
                      String documentId,
                      @NonNull
                      String documentVersion)

Creates a consent granted event with a first document.

Parameters:

expiry - Consent expiration.

documentId - Identifier of the first document.

documentVersion - Version of the first document.

Method Detail

documentName

@NonNull
public ConsentGranted documentName(@Nullable
                                            String documentName)

Name of the first document.

documentDescription

@NonNull
public ConsentGranted documentDescription(@Nullable
                                                   String documentDescription)

Description of the first document.

documents

@NonNull
public ConsentGranted documents(@NonNull
                                         List<ConsentDocument> documents)

Other attached documents.

getDocuments

@NonNull
public List<ConsentDocument> getDocuments()

Returns a list of consent documents associated with the event.

getDataPayload

@NonNull
public Map<String,Object> getDataPayload()

Returns:

the event data payload

getSchema

@NonNull
public String getSchema()

Specified by:

getSchema in class AbstractSelfDescribing

Returns:

The schema of the event.

beginProcessing

public void beginProcessing(@NonNull
                            com.snowplowanalytics.snowplow.internal.tracker.Tracker tracker)

Description copied from interface: Event

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

Specified by:

beginProcessing in interface Event

Overrides:

beginProcessing in class AbstractEvent