Class default

Retrieve explicit notice status of ccpa

Retrieve optout status of ccpa

Don't perform any changes on consent level. Stores the timestamp, the privacy strings and sets userActionPerformed

Set optout status in cookie for user and save string in backend

Mark the GPP Display as being hidden

Mark the GPP Display as being visible

Return if the user accepted all consents

Change the language. All upcoming SDK calls will return information in this language (e.g. getSettingsCore(),getCategories(), getTCFData(), ...). Pay attention that the language needs to be set up in your Usercentrics Admin Interface before!

Retrieve aria labels

Retrieve the controllerId, that's generated for the user.

Checks if consent is required (not given yet/resurface of banner)

Returns

true: consent is required, false: consent is not required, null: consent requirement is not known (yet)

Retrieve settings Core

Retrieve settings Data

Retrieve settings Labels

Retrieve settings Data

Return the number of third party ervices

Returns

the count of third party services

Initializes the Usercentrics framework. This method must be called when loading your website. The return value defines which UI layer & variant you should initially show for your users.

Set user action performed. Only needed if a user action is performed without the need for an explicit consent (e.g. CCPA first layer implementation)

Mark all services as "Consent given" (e.g. an "Accept All" button was clicked). The SDK will store the consent information and trigger events depending on your Usercentrics Settings.

Mark all services as "Consent denied" (e.g. a "Deny All" button was clicked). Essential services will still be marked as "Consent given". The SDK will store the consent information and trigger events depending on your Usercentrics Settings.

Retrieve boolean, that can be used to decide if the user is inside the EU or not.

Retrieve the user's country information.

Retrieve the categories and their base services info to display this information in your UI.

Retrieve the categories and their full services info to display this information in your UI.

Retrieve all services without fetching the aggregator.

Retrieve all services fetching the aggregator if necessary.

Restore a session for an end user with the given controllerId.

Mark given services as "Consent given / denied". Essential services will still be marked as "Consent given". The SDK will store the consent information and trigger events depending on your Usercentrics Settings.

Accept all services for AMP

Clear the storage from all buckets

Reject all services for AMP

Dismiss UI for AMP - this closes the AMP UI and also don't change the consent. If a consent has already been given, AMP uses that as the current state.

Needed for enabling dynamically loaded script.

Enter fullscreen mode on AMP UI

Retrieve ab testing variant in use.

Fetch service data from the aggregator if the data wasn't fetched already

This method sends the message to the parent iframe to communicate the user's decisions

Save current TCF data based on user decisions according to the rules below:

• if there are only TCF vendors and no non-IAB-service - we signal accept
• if the are non-IAB services and ALL of them have a consent we signal accept
• if the are non-IAB services and at least ONE of them has NO consent we signal reject

Sends the ready message to display the AMP UI

Mark all disclosed TCF vendors, purposes, specialFeatures as "consent given" and if applicable "legitimate interest given". The SDK will store the consent information and trigger TCF events. NOTE: This function will also mark the TCF UI as being closed! No need to call the setTCFUIAsClosed() method.

Mark all disclosed TCF vendors, purposes, specialFeatures as "consent denied" and if applicable "legitimate interest denied". The SDK will store the consent information and trigger TCF events. NOTE: This function will also mark the TCF UI as being closed! No need to call the setTCFUIAsClosed() method.

Retrieve all TCF data, including consents and descriptions for TCF vendors, purposes, special purposes, features, special features, and stacks Only vendors and stacks that have been selected in the admin interface will be returned. Only purposes, features, special features, special purposes that are used by one or more of the selected vendors (and/or selected stacks) will re returned.

A method to return TCF disclosed vendors as an encoded segment

Returns

the TCF disclosed vendors segment or undefined

Inject a tcString

Returns

boolean true if injected successfully, false otherwise

Mark the TCF UI as being closed and trigger related TCF events. NOTE: Remember to call this ALWAYS when an end-user closes your TCF UI without making any changes!

Mark the TCF UI as being open and trigger related TCF events. NOTE: Remember to call this ALWAYS when an end-user opens up your TCF UI!

Mark given TCF vendors, purposes, specialFeatures as "consent given / denied" and if applicable "legitimate interest given denied". The SDK will store the consent information and trigger TCF events. NOTE: This function will also mark the TCF UI as being closed! No need to call the setTCFUIAsClosed() method.