Consent state API

Retrieving the cookie consent state
When users have selected their preferences for consent, Openli will store a record of their consent choices. 
In some cases, you might want to have a look at the given consent, so you can do (or not do) certain actions related to consent choices. We've made an easy way for you to get access to the cookie consent state by using a simple JavaScript command (which can be used in all scripts with access to the browser'swindow object): 
1
window.legal.getCookieConsentState(); 
2
// Returns an object like:
3
// { analytics: true|false, marketing: true|false }
Copied!
Use cases
Google Tag Manager
A common use case for this API call is with Google Tag Manager, e.g. making triggers fire only under certain conditions. For an in-depth example, check out Prevent triggers from firing in Google Tag Manager.
Listening for consent-change events
It is also possible to register standard JavaScript DOM event-listeners to enable your own code to respond when a user changes their consent preferences.
To ensure that your code is run as you intend, you must register listeners before your call tolegal.widget(...) for the cookie widget on your page.
Event name
Event description
openli.cookie.analytics.accepted
Triggered whenever a user gives consent to the analytics category. Can occur more than once.
openli.cookie.analytics.rejected
Triggered whenever a user rejects consent to the analytics category. Can occur more than once.
openli.cookie.marketing.accepted
Triggered whenever a user gives consent to the marketing category. Can occur more than once.
openli.cookie.marketing.rejected
Triggered whenever a user rejects consent to the marketing category. Can occur more than once.
Here is an example of using one of these events to invoke some custom code:
1
function handleAnalyticsAccepted() {
2
    console.log("User accepted analytics.");
3
    // Take any other action you want to.
4
}
5
​
6
window.addEventListener(
7
    // The event name to listen for.
8
    "legalmonster.cookie.analytics.accepted",
9
    // A reference to your custom function.
10
    handleAnalyticsAccepted,
11
    // Optional: remove the listener after the first instance of the event.
12
    { once: true }
13
);
Copied!

Cookie-widget options

Next - Technical documentation

API

Last modified 6mo ago

Copy link

Contents

Retrieving the cookie consent state

Use cases

Listening for consent-change events