Get Consent

This API allows you to retrieve the consent value provided through the consent function.

Parameters

Name	Type	Required	Description
callback	(consent: Record<string, boolean | Record<string | boolean>> | null, error?: Error, consentCategories: Record<string, boolean>) => void	Yes	Callback function that gives you the consent value of the user. If consent is set to null in the callback which indicates that something went wrong, and access error param for more details.
options	{ destination?: string }	No

Options

Destination: We recommend specifying the destination, especially if multiple EdgeTag instances exist on the website. If you do not, we will trigger the same event to multiple destinations. The destination value should be the EdgeTag URL.

Examples

When consent exists

edgetag('getConsent', (consent, error, consentCategories) => {
  console.log(consent) // { all: false, facebook: { facebook1: true, facebook2: false }}
  console.log(error) // undefined
  console.log(consentCategories) // { all: false, marketing: true}
})

No consent set yet

edgetag('getConsent', (consent, error, consentCategories) => {
  console.log(consent) // null
  console.log(error) // "Error: Consent Not Found for current user"
  console.log(consentCategories) // null
})