Manage consent programmatically

This chapter will teach you how to manage the consents of our cookie widget programmatically.

Where are the consents stored?

The entire proof of user consent is stored in the browser's localStorage (the storage key is named dastra-consents) in json format. The propagation of consents depends on it, that's why it's not recommended to directly modify the data of this key

It's not recommended to directly modify the data in the localStorage. Preferably use the Javascript SDK of dastra.

Access to the consent service

The dastra consent service can be accessed in this way:

<script>
  window.dastra = window.dastra || [];
  window.dastra.push(['cookieReady',function(manager)
  {console.log(manager.consent)}]);
</script>

List of methods available in the consent manager

In manager.consent, you have the following methods:

• open(): opens the consent widget

• close(): closes the consent widget

• getAllConsents(): retrieve all consents

• hasConsented(): returns true if the user has already recorded an explicit consent

• getPurposeConsent(purposeLabel:string): get consent for a cookie category

• setPurposeConsent(purposeLabel:string, consent:bool): set the consent for a category

• getServiceConsent(serviceShortName:string): retrieves consent for a particular service

• setServiceConsent(serviceShortName:string, consent:bool): sets the consent for a particular service

Get the list of user's consents (getAllConsents)

Once you access the consent manager, it is very easy to retrieve the consents of the current user:

<script>
window.dastra = window.dastra || [];
window.dastra.push(['cookieReady', function(manager){
    // Get the complete consent services list
    var consents = manager.consent.getAllConsents()
}]);
</script>

To call getAllConsents() outside the cookieReady callback (for example from your own code after the widget has loaded), use the full path:

var consents = window.dastra.cookieConsent.consent.getAllConsents();

The old top-level syntax dastra.getAllConsents() is no longer supported.

The above method returns a list of all the user's consents

[
  {
    "id":"000000-0000000-000000",
    "name": "Service name",
    "purpose": 1,
    "logoUrl": "https://logo-url/img.jpg",
    "privacyPolicyUrl":"",
    "description": "Short description",
    "defaultConsent": true,
    "requiredConsent":true
  },
  ...
]

Query consents by category (getPurposeConsent/setPurposeConsent)

Cookie categories are identified by the following string labels:

Category	Label
Necessary	Necessary
Preferences	Preference
Analytics	Analytical
Marketing	Marketing
Other	Other
Unclassified	Unclassified

Always use the string labels (e.g. 'Analytical') — numeric values are not supported by the API.

<script>
window.dastra = window.dastra || [];
window.dastra.push(['cookieReady',function(manager){
    let consents = manager.consent.getPurposeConsent('Analytical');
    manager.consent.setPurposeConsent('Analytical', false);

    // persist consent
    manager.consent.save();
}]);
</script>

Handle consents by service

To manipulate consents by service, you will need the simplified service name available in the service management interface of your widget.

How to find the simplified name of the service? Go to the service management interface, when editing a service, the simplified name (slug) of the service appears below the cookie name.

Location of simplified cookie name

<script>
window.dastra = window.dastra || [];
window.dastra.push(['cookieReady',function(manager){
    // Get the complete consent services list
    let cookiePurpose = 'google-analytics'; // 2 = Analytic
    let consents = manager.consent.getServiceConsent(cookiePurpose );
    manager.consent.setServicePurpose(cookiePurpose, false)
}]);
</script>

Example of use

The following example shows how to apply a full opt-out programmatically — for instance when the user clicks a "Reject all" button you have built yourself, or when honouring a browser privacy signal.

<script>
window.dastra = window.dastra || [];
window.dastra.push(['cookieReady', function(manager) {

  // Only act if the user hasn't already made an explicit choice
  if (!manager.consent.hasConsented()) {

    // Opt out of all non-essential categories
    manager.consent.setPurposeConsent('Preference',   false);
    manager.consent.setPurposeConsent('Analytical',   false);
    manager.consent.setPurposeConsent('Marketing',    false);
    manager.consent.setPurposeConsent('Other',        false);
    manager.consent.setPurposeConsent('Unclassified', false);

    // Persist the choice in the browser
    manager.consent.save();
  }

}]);
</script>

You can equally opt-in selectively — for example to accept analytics only:

Reacting to consent updates (the dastra:consents:updated event)

Every time a user changes their consent choices — through the widget or programmatically via save() — Dastra dispatches a dastra:consents:updated event on window. You can subscribe to it to trigger your own logic: loading third-party scripts, updating the UI, firing an analytics event, etc.

window.addEventListener('dastra:consents:updated', function(event) {
  // event.detail contains the updated consents
  console.log('Consents updated', event.detail);

  // Example: reload Google Analytics if the user just accepted analytics
  if (window.dastra.cookieConsent.consent.getPurposeConsent('Analytical')) {
    // load or re-enable your analytics scripts here
  }
});

This event fires only when save() is called — it does not fire after dispatchEvent() (session-only application without persistence).

<script>
window.dastra = window.dastra || [];
window.dastra.push(['cookieReady', function(manager) {

  manager.consent.setPurposeConsent('Analytical', true);
  manager.consent.setPurposeConsent('Marketing',  false);
  manager.consent.save();

}]);
</script>