Skip to content

node-tracker.buildconsentgranted.md

Latest commit

 

History

History
32 lines (21 loc) · 957 Bytes

node-tracker.buildconsentgranted.md

File metadata and controls

32 lines (21 loc) · 957 Bytes
Raw

Home > @snowplow/node-tracker > buildConsentGranted

buildConsentGranted() function

Build a Consent Granted Event Used for tracking when a user grants their consent

Signature:

declare function buildConsentGranted(event: ConsentGrantedEvent): {
    event: PayloadBuilder;
    context: {
        schema: string;
        data: Record<string, unknown>;
    }[];
};

Parameters

Parameter Type Description
event ConsentGrantedEvent Contains the properties for the Consent Granted event

Returns:

{ event: PayloadBuilder; context: { schema: string; data: Record<string, unknown>; }[]; }

An object containing the PayloadBuilder to be sent to and a 'consent_document' context