Reference

Reference

This section is a comprehensive reference of the methods and events exposed by the react-native SDK that you can leverage in your application.

These methods are accessible in the Didomi class. Also make sure to always call the SDK after it is fully initialized (see onReady).

addEventListener

Add an event listener to catch events triggered by the SDK. Events listeners allow you to react to different events of interest. This function is safe to call before the READY event has been triggered.

Requires SDK to be initialized

No.

Parameters

Name
Type
Description

eventType

DidomiEventType

The type of event to listen to

callback

(data: any) => void

Callback to call when event occurs. data is an optional parameter sent with some events.

Event types

DidomiEventType is an enum with the following values:

export enum DidomiEventType {
    // Consent
    CONSENT_CHANGED = "on_consent_changed",
    // SDK lifecycle events
    ERROR = "on_error",
    READY = "on_ready",
    // Notice
    HIDE_NOTICE = "on_hide_notice",
    SHOW_NOTICE = "on_show_notice",
    NOTICE_CLICK_AGREE = "on_notice_click_agree",
    NOTICE_CLICK_DISAGREE = "on_notice_click_disagree",
    NOTICE_CLICK_VIEW_VENDORS = "on_notice_click_view_vendors",
    NOTICE_CLICK_VIEW_SPI_PURPOSES = "on_notice_click_view_spi_purposes",
    NOTICE_CLICK_MORE_INFO = "on_notice_click_more_info",
    NOTICE_CLICK_PRIVACY_POLICY = "on_notice_click_privacy_policy",
    // Preferences
    HIDE_PREFERENCES = "on_hide_preferences",
    SHOW_PREFERENCES = "on_show_preferences",
    // Preferences - Views
    PREFERENCES_CLICK_VIEW_PURPOSES = "on_preferences_click_view_purposes",
    PREFERENCES_CLICK_VIEW_VENDORS = "on_preferences_click_view_vendors",
    PREFERENCES_CLICK_VIEW_SPI_PURPOSES = "on_preferences_click_view_spi_purposes",
    // Preferences - Purpose
    PREFERENCES_CLICK_AGREE_TO_ALL = "on_preferences_click_agree_to_all",
    PREFERENCES_CLICK_DISAGREE_TO_ALL = "on_preferences_click_disagree_to_all",
    PREFERENCES_CLICK_AGREE_TO_ALL_PURPOSES = "on_preferences_click_agree_to_all_purposes",
    PREFERENCES_CLICK_DISAGREE_TO_ALL_PURPOSES = "on_preferences_click_disagree_to_all_purposes",
    PREFERENCES_CLICK_RESET_ALL_PURPOSES = "on_preferences_click_reset_all_purposes",
    PREFERENCES_CLICK_PURPOSE_AGREE = "on_preferences_click_purpose_agree",
    PREFERENCES_CLICK_PURPOSE_DISAGREE = "on_preferences_click_purpose_disagree",
    PREFERENCES_CLICK_CATEGORY_AGREE = "on_preferences_click_category_agree",
    PREFERENCES_CLICK_CATEGORY_DISAGREE = "on_preferences_click_category_disagree",
    PREFERENCES_CLICK_SAVE_CHOICES = "on_preferences_click_save_choices",
    // Preferences - Vendor
    PREFERENCES_CLICK_AGREE_TO_ALL_VENDORS = "on_preferences_click_agree_to_all_vendors",
    PREFERENCES_CLICK_DISAGREE_TO_ALL_VENDORS = "on_preferences_click_disagree_to_all_vendors",
    PREFERENCES_CLICK_VENDOR_AGREE = "on_preferences_click_vendor_agree",
    PREFERENCES_CLICK_VENDOR_DISAGREE = "on_preferences_click_vendor_disagree",
    PREFERENCES_CLICK_VENDOR_SAVE_CHOICES = "on_preferences_click_vendor_save_choices",
    // Preferences - Sensitive Personal Information
    PREFERENCES_CLICK_SPI_PURPOSE_AGREE = "on_preferences_click_spi_purpose_agree",
    PREFERENCES_CLICK_SPI_PURPOSE_DISAGREE = "on_preferences_click_spi_purpose_disagree",
    PREFERENCES_CLICK_SPI_CATEGORY_AGREE = "on_preferences_click_spi_category_agree",
    PREFERENCES_CLICK_SPI_CATEGORY_DISAGREE = "on_preferences_click_spi_category_disagree",
    PREFERENCES_CLICK_SPI_PURPOSE_SAVE_CHOICES = "on_preferences_click_spi_purpose_save_choices",
    // Sync
    SYNC_READY = "on_sync_ready",
    SYNC_DONE = "on_sync_done", // Deprecated
    SYNC_ERROR = "on_sync_error",
    // Language
    LANGUAGE_UPDATED = "on_language_updated",
    LANGUAGE_UPDATE_FAILED = "on_language_update_failed",
}

These events are supported by the Didomi SDK:

Value

Description

CONSENT_CHANGED

When a consent is given or withdrawn by the user. Only triggered when the consent status actually changes (ie if the user saves consents without adding/removing any consent then this does not get called).

ERROR

When the SDK encountered an error (message provided as parameter).

READY

When the SDK is ready.

HIDE_NOTICE

When the consent notice is hidden. If you have disabled our default consent notice to replace it with your own, you need to hide your custom notice when this event gets triggered.

SHOW_NOTICE

When the consent notice gets displayed. If you have disabled our default consent notices to replace them with your own, you need to show your custom notice when this event gets triggered.

NOTICE_CLICK_AGREE

When user clicks on agree on the notice.

NOTICE_CLICK_DISAGREE

When user clicks on disagree on the notice.

NOTICE_CLICK_VIEW_VENDORS

When user clicks on Partners on the notice.

NOTICE_CLICK_VIEW_SPI_PURPOSES

When user clicks on Sensitive Personal Information on the notice.

NOTICE_CLICK_MORE_INFO

When user clicks on learn more on the notice.

NOTICE_CLICK_PRIVACY_POLICY

When user clicks on privacy policy on the notice.

HIDE_PREFERENCES

When the preferences screen is hidden.

SHOW_PREFERENCES

When the preferences screen is displayed.

PREFERENCES_CLICK_VIEW_PURPOSES

When user clicks on view purposes on the preferences popup.

PREFERENCES_CLICK_VIEW_VENDORS

When user clicks on view vendors on the preferences popup.

PREFERENCES_CLICK_VIEW_SPI_PURPOSES

When user clicks on view Sensitive Personal Information on the preferences popup.

PREFERENCES_CLICK_AGREE_TO_ALL

When user clicks on agree to all on the preferences popup.

PREFERENCES_CLICK_DISAGREE_TO_ALL

When user clicks on disagree to all on the preferences popup.

PREFERENCES_CLICK_AGREE_TO_ALL_PURPOSES

When user flips ON all purposes switch on the preferences popup.

PREFERENCES_CLICK_DISAGREE_TO_ALL_PURPOSES

When user flips OFF all purposes switch on the preferences popup.

PREFERENCES_CLICK_RESET_ALL_PURPOSES

When user resets all purposes switch on the preferences popup.

PREFERENCES_CLICK_PURPOSE_AGREE

When user agree to a purpose on the preferences popup. (purposeId provided as parameter).

PREFERENCES_CLICK_PURPOSE_DISAGREE

When user disagree to a purpose on the preferences popup. (purposeId provided as parameter)

PREFERENCES_CLICK_CATEGORY_AGREE

When user agree to a category on the preferences popup (categoryId provided as parameter).

PREFERENCES_CLICK_CATEGORY_DISAGREE

When user disagree to a category on the preferences popup (categoryId provided as parameter).

PREFERENCES_CLICK_SAVE_CHOICES

When user saves his choice on the preferences popup.

PREFERENCES_CLICK_AGREE_TO_ALL_VENDORS

When user flips ON all vendors switch on the preferences popup.

PREFERENCES_CLICK_DISAGREE_TO_ALL_VENDORS

When user flips OFF all vendors switch on the preferences popup.

PREFERENCES_CLICK_VENDOR_AGREE

When user agree to a vendor on the preferences popup (vendorId provided as parameter).

PREFERENCES_CLICK_VENDOR_DISAGREE

When user disagree to a vendor on the preferences popup (vendorId provided as parameter).

PREFERENCES_CLICK_VENDOR_SAVE_CHOICES

When user saves his choice on the vendors view from the preferences popup.

PREFERENCES_CLICK_SPI_PURPOSE_AGREE

When user agree to a purpose on the Sensitive Personal Information view from preferences popup. (purposeId provided as parameter).

PREFERENCES_CLICK_SPI_PURPOSE_DISAGREE

When user disagree to a purpose on Sensitive Personal Information view from the preferences popup. (purposeId provided as parameter)

PREFERENCES_CLICK_SPI_CATEGORY_AGREE

When user agree to a category on the Sensitive Personal Information view from preferences popup (categoryId provided as parameter).

PREFERENCES_CLICK_SPI_CATEGORY_DISAGREE

When user disagree to a category on the Sensitive Personal Information view from preferences popup (categoryId provided as parameter).

PREFERENCES_CLICK_SPI_PURPOSE_SAVE_CHOICES

When user saves his choice on the Sensitive Personal Information view from preferences popup.

SYNC_READY

When the consent synchronization process is over.

data parameter is a SyncReadyEvent object that contains the fields statusApplied and syncAcknowledged (see below)

SyncReadyEvent.statusApplied

Whether the user status was applied

SyncReadyEvent.syncAcknowledged

Function that triggers a sync.acknowledged API event when called. It returns true if the API event was sent successfully.

SYNC_DONE

Deprecated, use SYNC_READY instead.

When the consent synchronization is successful (organizationUserId provided as parameter).

SYNC_ERROR

When the consent synchronization has failed (error provided as parameter).

LANGUAGE_UPDATED

When the language has changed (languageCode provided as parameter).

LANGUAGE_UPDATE_FAILED

When the language change has failed (reason provided as parameter).

Returns

Nothing

Example

const registerListener = (eventType: DidomiEventType) => {
  Didomi.addEventListener(eventType, (data: any) => {
    console.log('Event received: ' + eventType + ', data:' + data);
  });
};
  
registerListener(DidomiEventType.READY);
registerListener(DidomiEventType.CONSENT_CHANGED);
registerListener(DidomiEventType.SHOW_NOTICE);
registerListener(DidomiEventType.HIDE_NOTICE);

addVendorStatusListener

Listen for changes on the user status linked to a specific vendor.

Requires SDK to be initialized

No.

Parameters

Name
Type
Description

vendorId

string

The ID of the vendor for which we want to start listening for changes.

This ID should be the ID provided by Didomi, which doesn't contain prefixes.

callback

callback: (VendorStatus) => void

Callback that will be executed whenever changes are detected on the specified vendor. When this callback is executed, the status linked to the specified vendor will be passed.

Returns

Nothing

Example

Didomi.addVendorStatusListener('vendorId', (vendorStatus: VendorStatus) => {
    console.log("Event received: Vendor status for " + vendorStatus.id + " is " + vendorStatus.enabled);
});

removeVendorStatusListener

Stop listening for changes on the user status linked to a specific vendor.

Requires SDK to be initialized

No.

Parameters

Name
Type
Description

vendorId

string

The ID of the vendor for which we want to stop listening for changes.

This ID should be the ID provided by Didomi, which doesn't contain prefixes.

Returns

Nothing

Example

Didomi.removeVendorStatusListener('vendorId');

getDisabledPurposes

Removed since version 2.0.0, use getUserStatus instead.

The result of this method has been replaced by getUserStatus().purposes.consent.disabled.

getDisabledPurposeIds

Removed since version 2.0.0, use getUserStatus instead.

The result of this method has been replaced by getUserStatus().purposes.consent.disabled.

getDisabledVendors

Removed since version 2.0.0, use getUserStatus instead.

The result of this method has been replaced by getUserStatus().vendors.consent.disabled.

getDisabledVendorIds

Removed since version 2.0.0, use getUserStatus instead.

The result of this method has been replaced by getUserStatus().vendors.consent.disabled.

getEnabledPurposes

Removed since version 2.0.0, use getUserStatus instead.

The result of this method has been replaced by getUserStatus().purposes.global.enabled.

getEnabledPurposeIds

Removed since version 2.0.0, use getUserStatus instead.

The result of this method has been replaced by getUserStatus().purposes.global.enabled.

getEnabledVendors

Removed since version 2.0.0, use getUserStatus instead.

The result of this method has been replaced by getUserStatus().vendors.consent.enabled.

getEnabledVendorIds

Removed since version 2.0.0, use getUserStatus instead.

The result of this method has been replaced by getUserStatus().vendors.consent.enabled.

getJavaScriptForWebView

Get JavaScript to embed into a WebView to pass the consent status from the app to the Didomi Web SDK embedded into the WebView.

Inject the returned tag into a WebView with evaluateJavaScript.

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

Type
Description

Promise<string>

JavaScript code to embed in a WebView

Example

await Didomi.getJavaScriptForWebView();

getQueryStringForWebView

Get a query string parameter to append to the URL of a WebView to pass the consent status from the app to the Didomi Web SDK embedded into the WebView.

Read our article on sharing consent with WebViews for more information.

This method is currently available on Android platform only.

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

Type
Description

Promise<string>

Query string parameter with the format didomiConfig.user.externalConsent.value=.... It can be appended to your URL after a ? or a & if your URL already contains a query string.

Example

await Didomi.getQueryStringForWebView();

getPurpose

Get a purpose based on its ID.

Requires SDK to be initialized

Yes.

Parameters

Name
Type
Description

purposeId

string

ID of the purpose we want to get.

Returns

Type
Description

Promise<Purpose>

A Purpose with ID purposeId found in the array of required purposes, or undefined.

Purpose interface is defined in DidomiTypes.ts

Example

await Didomi.getPurpose("purpose-id") as Purpose;

getRequiredPurposes

Get the list of purpose that are required (automatically determined from the list of required vendors).

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

Type
Description

Promise<Purpose[]>

A list of type Purpose containing the required purposes.

Purpose interface is defined in DidomiTypes.ts

Example

await Didomi.getRequiredPurposes();

getRequiredPurposeIds

Get the list of purpose IDs that are required (automatically determined from the list of required vendors).

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

Type
Description

Promise<string[]>

A list of type string containing the IDs of required purposes.

Example

await Didomi.getRequiredPurposeIds();

getRequiredVendors

Get the list of vendors that are required (determined from the configuration).

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

Type
Description

Promise<Vendor[]>

A list of type Vendor containing the required vendors.

Example

await Didomi.getRequiredVendors();

getRequiredVendorIds

Get the list of vendor IDs that are required (determined from the configuration).

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

Type
Description

Promise<string[]>

A list of type string containing the IDs of required vendors.

Example

await Didomi.getRequiredVendorIds();

getText

Method used to get a dictionary/map based on the key being passed. These keys and texts are extracted from the notice content, preferences content and the texts property specified in the didomi_config.json file as described here https://developers.didomi.io/cmp/mobile-sdk/consent-notice/customize-the-theme#translatable-texts-for-custom-notices.

Requires SDK to be initialized

Yes.

Parameters

Name
Type
Description

key

String

key associated to the dictionary that we want to get.

Returns

Type
Description

Dictionary/map: Promise<any[]>

Dictionary/map containing the translations for a specific key in different languages, with the form { "en:" "text in English", "fr": "texte en Français" }

Example

await Didomi.getText("key");

getTranslatedText

Method used to get a translated text based on the key being passed.

The language and the source of this translated text will depend on the availability of the translation for the specific key.

The language being used will be either the selected language of the SDK (based on device Locale and other parameters) or the language specified by app developers as the default language being used by the SDK. The source can be either the didomi_config.json file, which can be either local or remote, or a file that is bundled within the SDK.

These are the attempts performed by the SDK to try to find a translation for the specific key:

  • Get translated value in user locale (selected language) from didomi_config.json (either local or remote).

  • Get translated value in default locale (from the config) from didomi_config.json (either local or remote).

  • Get translated value in user locale (selected language) from the Didomi-provided translations (bundled within the Didomi SDK).

  • Get translated value in default locale (from the config) from the Didomi-provided translations (bundled within the Didomi SDK).

If no translation can be found after these 4 attempts, the key will be returned.

App developers can provide these translated texts through the didomi_config.json file (locally or remotely) in 3 different ways:

Requires SDK to be initialized

Yes.

Parameters

Name
Type
Description

key

string

key associated to the text that we want to get translated.

Returns

Translated text.

Example

await Didomi.getTranslatedText("key");

getUserConsentStatusForPurpose

Deprecated, use getUserStatus instead.

Search the purposeId in getUserStatus().purposes.consent.enabled or getUserStatus().purposes.consent.disabled.

Get the user consent status for a given purpose. You must also check that the user has given consent to a vendor before being able to load a vendor.

Parameters

Name
Type
Description

purposeId

string

The ID of the purpose to check the user consent for

Returns

A Promise<boolean> that indicates if the user has given consent or not to the specific purpose.

undefined is returned if the consent status is not known yet. From a GDPR perspective, you'll want to treat undefined as false (ie no consent given) but it is helpful to know that the user has not interacted with the consent UI yet so that you can subscribe to events and wait for consent information to be collected.

If consent is not required because GDPR does not apply to that user, this function will return true.

Example

await Didomi.getUserConsentStatusForPurpose("analytics");

getUserConsentStatusForVendor

Removed since version 2.0.0, use getUserStatus instead.

Search the vendorId in getUserStatus().vendors.consent.enabled or getUserStatus().vendors.consent.disabled.

getUserConsentStatusForVendorAndRequiredPurposes

Removed since version 2.0.0, use getUserStatus instead.

Search the purposeId in getUserStatus().vendors.global_consent.enabled or getUserStatus().vendors.global_consent.disabled.

getUserLegitimateInterestStatusForPurpose

Removed since version 2.0.0, use getUserStatus instead.

Search the purposeId in getUserStatus().purposes.legitimate_interest.enabled or getUserStatus().purposes.legitimate_interest.disabled.

getUserLegitimateInterestForVendor

Removed since version 2.0.0, use getUserStatus instead.

Search the vendorId in getUserStatus().vendors.legitimate_interest.enabled or getUserStatus().vendors.legitimate_interest.disabled.

getUserLegitimateInterestStatusForVendorAndRequiredPurposes

Removed since version 2.0.0, use getUserStatus instead.

Search the vendorId in getUserStatus().vendors.global_legitimate_interest.enabled or getUserStatus().vendors.global_legitimate_interest.disabled.

getUserStatus

Get all the user consent status.

Returns

A UserStatus object describing all the available and computed user information.

Parameter
Type
Description

purposes.global.disabled

string[]

Computed sets/lists of disabled IDs of purposes that have been chosen by the user regarding the consent or legitimate interest Legal Basis.

purposes.global.enabled

string[]

Computed sets/lists of enabled IDs of purposes that have been chosen by the user regarding the consent or legitimate interest Legal Basis. Purposes considered as essential will be part of the enabled IDs.

purposes.consent.disabled

string[]

Disabled IDs of purposes that have been explicitly chosen by the user regarding the consent Legal Basis.

purposes.consent.enabled

string[]

Enabled IDs of purposes that have been explicitly chosen by the user regarding the consent Legal Basis.

purposes.legitimate_interest.disabled

string[]

Disabled IDs of purposes that have been explicitly chosen by the user regarding the legitimate interest Legal Basis.

purposes.legitimate_interest.enabled

string[]

Enabled IDs of purposes that have been explicitly chosen by the user regarding the legitimate interest Legal Basis.

purposes.essential

string[]

IDs of purposes that are considered essential.

vendors.global.disabled

string[]

Computed sets/lists of disabled IDs of vendors that have been chosen by the user regarding the consent or legitimate interest Legal Basis. This takes into account the consent and legitimate interest required purposes linked to vendors. When computing this property, essential purposes will be considered as enabled.

vendors.global.enabled

string[]

Computed sets/lists of enabled IDs of vendors that have been chosen by the user regarding the consent or legitimate interest Legal Basis. This takes into account the consent and legitimate interest required purposes linked to vendors. When computing this property, essential purposes will be considered as enabled.

vendors.global_consent.disabled

string[]

Computed sets/lists of disabled IDs of vendors that have been chosen by the user regarding the consent Legal Basis. This takes into account the consent required purposes linked to vendors. When computing this property, essential purposes will be considered as enabled.

vendors.global_consent.enabled

string[]

Computed sets/lists of enabled IDs of vendors that have been chosen by the user regarding the consent Legal Basis. This takes into account the consent required purposes linked to vendors. When computing this property, essential purposes will be considered as enabled.

vendors.global_legitimate_interest.disabled

string[]

Computed sets/lists of disabled IDs of vendors that have been chosen by the user regarding the legitimate interest Legal Basis. This takes into account the legitimate interest required purposes linked to vendors. When computing this property, essential purposes will be considered as enabled.

vendors.global_legitimate___interest.enabled

string[]

Computed sets/lists of enabled IDs of vendors that have been chosen by the user regarding the legitimate interest Legal Basis. This takes into account the legitimate interest required purposes linked to vendors. When computing this property, essential purposes will be considered as enabled.

vendors.consent.disabled

string[]

Disabled IDs of vendors that have been explicitly chosen by the user regarding the consent Legal Basis.

vendors.consent.enabled

string[]

Enabled IDs of vendors that have been explicitly chosen by the user regarding the consent Legal Basis.

vendors.legitimate_interest.disabled

string[]

Disabled IDs of vendors that have been explicitly chosen by the user regarding the legitimate interest Legal Basis.

vendors.legitimate_interest.enabled

string[]

Enabled IDs of vendors that have been explicitly chosen by the user regarding the legitimate interest Legal Basis.

user_id

String

Didomi user id.

created

String

User choices creation date.

updated

String

User choices update date.

consent_string

String

TFC consent as string.

additional_consent

String

Additional consent for Google Additional Consent Mode.

Example

let userStatus = await Didomi.getUserStatus();

// Enabled consent ids for vendors
let enabledVendorsConsentIds = userStatus.vendors.consent.enabled;

getUserStatusForVendor

Removed since version 2.0.0, use getUserStatus instead.

Search the vendorId in getUserStatus().vendors.global.enabled or getUserStatus().vendors.global.disabled.

getVendor

Get a vendor based on its ID.

Requires SDK to be initialized

Yes.

Parameters

Name
Type
Description

vendorId

string

ID of the vendor we want to get.

Returns

Type
Description

Promise<any>

A Vendor with ID vendorId found in the array of required vendors, or undefined.

Vendor interface is defined in DidomiTypes.ts

Example

await Didomi.getVendor("vendor-id") as Vendor;

hideNotice

Hide the consent notice.

Parameters

No parameter.

Returns

Nothing

Example

await Didomi.hideNotice();

hidePreferences

Hide the preferences popup.

Parameters

No parameter.

Returns

Nothing

Example

await Didomi.hidePreferences();

initialize

Initialize the SDK. The initialization runs on a background thread to avoid blocking your UI. Use the onReady function to know when the initialization is done and the SDK is ready to be used.

Parameters

The parameter disableDidomiRemoteConfig is deprecated, we strongly suggest you to create your notice from the console (see Setup from the Console for more information).

Name
Type
Optional
Description

apiKey

string

No

Your API key

localConfigurationPath

string

Yes

The path to your local config file in your assets/ folder. Defaults to didomi_config.json if undefined.

remoteConfigurationPath

string

Yes

The URL to a remote configuration file to load during initialization. When provided, the file at the URL will be downloaded and cached to be used instead of the local assets/didomi_config.json. If there is no Internet connection available and no previously cached file, the local file will be used as fallback.

providerId

string

Yes

Your provider ID (if any). A provider ID is assigned when you work with Didomi through a third-party. If are not sure if you have one, set this to undefined.

disableDidomiRemoteConfig

boolean

Yes

Prevent the SDK from loading a remote configuration from the Didomi Console. Defaults to false (loading remote config).

Set this parameter to false to use a remote consent notice configuration loaded from the Didomi Console.

Set this parameter to true to disable loading configurations from the Didomi Console.

languageCode

string

Yes

Language in which the consent UI should be displayed. By default, the consent UI is displayed in the language configured in the device settings. This property allows you to override the default setting and specify a language to display the UI in. String containing the language code e.g.: "es", "fr", etc.

noticeId

string

Yes

Notice ID to load the configuration from. If provided, the SDK bypasses the app ID targeting and directly loads the configuration from the notice ID.

Returns

Nothing

Example

await Didomi.initialize(
    '465ca0b2-b96f-43b4-a864-f87e18d2fd38',
    undefined,
    undefined,
    undefined,
    false,
    undefined,
    undefined
  );

isConsentRequired

Determine if consent is required for the user. This takes into account the location of the user and the configuration of the SDK:

  • If your app is configured to apply GDPR to all users then this function always returns true.

  • If your app is configured to apply GDPR to EU users only then this function returns true only if the user in the EU.

Parameters

No parameter.

Returns

Promise<boolean>

Example

await Didomi.isConsentRequired();

isUserConsentStatusPartial

Determine if all consent information is available for the user.

This function returns true if and only if:

  • Consent is required for the user (ie the user is in the EU or your tag is configured to apply GDPR to all users)

  • At least one vendor is configured (if there is no vendor configured, this function always returns false as there is no consent to collect)

  • We miss consent information for some vendors or purposes

If there is at least one piece of consent information missing for a single vendor/purpose, this function will return true. The consent notice is usually displayed when this function returns true although there is no guarantee of the direct mapping between the two.

An important edge case is when you add new vendors or if configured vendors ask for new purposes: the consent notice will be displayed again and this function will return true until the user has given or denied consent. Vendors that already had consent before will still operate normally as we only recollect consent for additional vendors/purposes.

Parameters

No parameter.

Returns

Promise<boolean>

Example

await Didomi.isUserConsentStatusPartial();

isNoticeVisible

Check if the consent notice is currently displayed.

Parameters

No parameter.

Returns

Promise<boolean>

Example

await Didomi.isNoticeVisible();

isPreferencesVisible

Check if the preferences popup is currently displayed.

Parameters

No parameter.

Returns

Promise<boolean>

Example

await Didomi.isPreferencesVisible();

isReady

Check if the SDK is ready.

Parameters

No parameter.

Returns

Promise<boolean>

Example

await Didomi.isReady();

isUserStatusPartial

Determine if the user has provided a choice for all vendors selected for the regulation and linked data processing.

This function returns true if the user has not expressed a choice for all the required vendors and data processing.

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

Promise<boolean>

Example

await Didomi.isUserStatusPartial();

onError

Add a callback that will be called when the SDK initialization encounters an error. If the callback is added after the SDK initialization already failed, it will be called immediately.

Parameters

Type
Description

(): Promise<any>

A callback to run when the SDK initialization encounters an error

Returns

Nothing

Example

Didomi.onError().then((err: any) => {
    console.log('Error: ' + err);
});

onReady

Add a callback that will be called when the SDK is ready (ie fully initialized). If the callback is added after the SDK initialization, it will be called immediately.

All calls to other functions of this API must only be made in a callback to the ready event to make sure that the SDK is initialized before it is used.

Parameters

Type
Description

(): Promise<void>

A callback to run when the SDK is ready

Returns

Nothing

Example

Didomi.onReady().then(() => {
    // SDK is ready
});

openCurrentUserStatusTransaction

Definition

Create a CurrentUserStatusTransaction object.

This object provides mechanisms to stage updates to the user status regarding purposes and vendors, allowing for batch operations.

Updates made through its methods are queued and applied simultaneously to the user status only once the commit method of the returned object is called.

Additional details:

  • The status of vendors and purposes whose IDs are not not specified through the methods provided by CurrentUserStatusTransaction are kept unchanged.

  • Essential purposes are always set to enabled and can’t be updated by the methods provided by CurrentUserStatusTransaction.

  • When the regulation applied for a user is none, the methods provided by CurrentUserStatusTransaction should not update the status of any vendor or purpose which will always remain as enabled. When the commit method is called it will return false.

  • If the IDs that are passed through the methods provided by CurrentUserStatusTransaction don’t correspond to vendors or purposes required by the Notice Config, they will be ignored.

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

AnCurrentUserStatusTransaction object.

Description of a CurrentUserStatusTransaction object

Method
Parameters
Returns
Description

enablePurpose

id (string): ID of the purpose to be enabled.

Current CurrentUserStatusTransaction object.

Enable a single purpose based on its ID.

enablePurposes

ids (string[]): IDs of the purposes to be enabled.

Current CurrentUserStatusTransaction object.

Enable multiple purposes based on their IDs.

disablePurpose

id (string): ID of the purpose to be disabled.

Current CurrentUserStatusTransaction object.

Disable a single purpose based on its ID.

disablePurposes

ids (string[]): IDs of the purposes to be disabled.

Current CurrentUserStatusTransaction object.

Disable multiple purposes based on their IDs.

enableVendor

id (string): Didomi ID of the vendor to be enabled.

Current CurrentUserStatusTransaction object.

Enable a single vendor based on its Didomi ID.

enableVendors

ids (string[]): Didomi IDs of the vendors to be enabled.

Current CurrentUserStatusTransaction object.

Enable multiple vendors based on their Didomi IDs.

disableVendor

id (string): Didomi ID of the vendor to be disabled.

Current CurrentUserStatusTransaction object.

Disable a single vendor based on its Didomi ID.

disableVendors

ids (string[]): Didomi IDs of the vendors to be disabled.

Current CurrentUserStatusTransaction object.

Disable multiple vendors based on their Didomi IDs.

commit

No parameters.

boolean: true if user status has been updated, false otherwise.

Commit the changes that have been made through other methods.

Examples

const transaction = Didomi.openCurrentUserStatusTransaction();

// enable a purpose
transaction.enablePurpose("cookies");
// enable purposes
transaction.enablePurpose(["cookies", "analytics"]);
// disable a purpose
transaction.enablePurpose("analytics");
// disable purposes
transaction.disablePurposes(["cookies", "analytics"]);
// enable a vendor
transaction.enableVendor("vendor-1");
// enable vendors
transaction.enableVendors(["vendor-1","vendor-2"]);
// disable a vendor
transaction.disableVendor("vendor-1");
// disable vendors
transaction.disableVendors(["vendor-1", "vendor-1"]);

// Chain multiple calls
transaction.enablePurpose("cookies").disablePurpose("analytics");

// Save user choices
let updated = await transaction.commit();

setLogLevel

Set the minimum level of messages to log. The SDK will not log messages under that level.

It uses a number argument which can have different values on Android and iOS platforms., for example:

iOS

Level
Value

info

1

debug

2

error

16

fault

17

Android

Level
Value

debug

3

info

4

warn

5

error

6

For more information see

Parameters

Name
Type
Description

level

number

Minimum level of messages to log.

Returns

Nothing

Example

// "Debug" log level is 2 on iOS, 3 on Android
let level = Platform.OS === 'ios' ? 2 : 3
Didomi.setLogLevel(level);

setupUI

Setup the SDK UI. By calling this method, the consent notice will be displayed once the SDK is ready and if consent should be collected. It does not show any view if consent was already collected or is not required. This method should be called only from your contexts where the application starts.

Returns

Nothing

Example

Didomi.setupUI();

setUser

Set custom user information from organization

Parameters

Name

Name
Type
Description

organizationUserId

string

Organization ID to associate with the user

Returns

Nothing

Example

await DidomiSdk.setUser("e3222031-7c45-4f4a-8851-ffd57dbf0a2a");

setUser

Set custom user information from organization, with optional authentication parameters.

Name

Name
Type
Optional
Description

organizationUserId

string

No

Organization ID to associate with the user

organizationUserIdAuthAlgorithm

string

Yes

Algorithm used for computing the digest

organizationUserIdAuthSid

string

Yes

ID of the secret used for computing the digest

organizationUserIdAuthSalt

string

Yes

Salt used for computing the digest (optional)

organizationUserIdAuthDigest

string

Yes

Digest of the organization user ID and secret

Returns

Nothing

Example

await Didomi.setUser(
            "e3222031-7c45-4f4a-8851-ffd57dbf0a2a",
            "hash-md5",
            "secret_id",
            "salt",
            "098f6bcd4621d373cade4e832627b4f6"
);

clearUser

Remove custom user information from organization

Parameters

No parameter.

Returns

Nothing

Example

await Didomi.clearUser();

showNotice

In most cases this method should be called if the notice should be displayed in response to a user action (e.g.: select the privacy settings section within your app). By calling the setupUI method, the notice will be automatically displayed if required.

Show the consent notice. The consent notice actually only gets shown if needed (consent is required and we are missing consent information for some vendor or purpose).

Returns

Nothing

Example

await Didomi.showNotice();

showPreferences

In most cases this method should be called if you want to show the Preferences screen in response to a user action (the user pressing a "Consent Preferences" button in your app menu, for instance).

Show the Preferences view to the user. This method can be used to allow the user to update their preferences after the banner has been closed. We suggest adding a link/button/item that calls this method somewhere in your app, for example from your settings menu. By default, the Purposes view is displayed first. By calling this method, users will have the opportunity to modify the choices previously made.

Parameters

Type

view (Optional)

Defines which view is displayed to the user first between the purposes view or the vendors view.

Can be purposes , sensitive-personal-information or vendors.

If this parameter is not defined or contains an unexpected string, the purposes' view will be displayed.

Returns

Nothing

Example

await Didomi.showPreferences();
await Didomi.showPreferences("purposes");
await Didomi.showPreferences("sensitive-personal-information");
await Didomi.showPreferences("vendors");

reset

Reset all the consent information for the current user. This will remove all consent information stored on the device by Didomi and will trigger re-collection of consent. The consent notice will be displayed again.

Parameters

No parameter.

Returns

Nothing

Example

await Didomi.reset();

setUserAgreeToAll

Report that the user has enabled consents and legitimate interests for all purposes and vendors configured for your app.

This function will log the user choice on our platform and close the notice.

Consent statuses for essential purposes are not stored.

Please read our article on what to expect from your analytics when setting a custom behavior for your consent notice.

Parameters

No parameter.

Returns

Promise<boolean>

true if the user choices have changed (i.e. the user had made different choices before this function got called).

Example

await Didomi.setUserAgreeToAll();

setUserDisagreeToAll

Report that the user has disabled consents and legitimate interests for all purposes and vendors configured for your app.

This function will log the user choice on our platform and close the notice.

Consent statuses for essential purposes are not stored.

Please read our article on what to expect from your analytics when setting a custom behavior for your consent notice.

Parameters

No parameter.

Returns

Promise<boolean>

true if the user choices have changed (i.e. the user had made different choices before this function got called).

Example

Didomi.setUserDisagreeToAll();

setUserStatusSets

Set the user status for purposes and vendors. This function will trigger events and API calls every time it is called (and the user status changes) so make sure to push all user choices at once and not one by one.

Please read our article on what to expect from your analytics when setting a custom behavior for your consent notice.

Parameters

Name
Type
Description

enabledConsentPurposeIds

string[]

List of purpose IDs that the user has given consent to

disabledConsentPurposeIds

string[]

List of purpose IDs that the user has not given consent to

enabledLIPurposeIds

string[]

List of purpose IDs that the user has allowed legitimate interest processing to

disabledLIPurposeIds

string[]

List of purpose IDs that the user has disallowed legitimate interest processing to

enabledConsentVendorIds

string[]

List of vendor IDs that the user has given consent to.

Prefix custom vendor IDs with c:.

disabledConsentVendorIds

string[]

List of vendor IDs that the user has not given consent to

enabledLIVendorIds

string[]

List of vendor IDs that the user has allowed legitimate interest processing to.

Prefix custom vendor IDs with c:.

disabledLIVendorIds

string[]

List of vendor IDs that the user has not allowed legitimate interest processing to

Returns

Promise<boolean>

true if the user choices have changed (i.e. the user had made different choices before this function got called).

Example

let result = await Didomi.setUserStatus(
    ["cookies", "advertising_personalization"],
    ["ad_delivery"],
    ["advertising_personalization"],
    ["ad_delivery"],
    ["123", "c:custom-vendor-id"],
    [],
    ["123", "c:custom-vendor-id"],
    []
);

setUserStatus

Set the global status for consent purposes, legitimate interest purposes, consent vendors, legitimate interest vendors. This function will trigger events and API calls every time it is called.

Please read our article on what to expect from your analytics when setting a custom behavior for your consent notice.

Name
Type
Description

purposesConsentStatus

boolean

true if purposes on a consent basis should be enabled, false if they should be disabled

purposesLIStatus

boolean

true if purposes on a legitimate interest basis should be enabled, false if they should be disabled

vendorsConsentStatus

boolean

true if vendors on a consent basis should be enabled, false if they should be disabled

vendorsLIStatus

boolean

true if vendors on a legitimate interest basis should be enabled, false if they should be disabled

Returns

Promise<boolean>

true if the user choices have changed (i.e. the user had made different choices before this function got called).

Example

// Disable everything except vendors legitimate interest
let result = await DidomiSdk.setUserStatus(
    false, false, false, true
);

shouldConsentBeCollected

Deprecated, use shouldUserStatusBeCollected instead.

Determine if consent should be collected for the visitor. Returns true if consent is required for the current user and one of following two conditions is met:

  • Consent has never been collected for this visitor yet

  • New consents should be collected (as new vendors have been added) AND the number of days before recollecting them has exceeded

If none of these two conditions is met, the function returns false. This function is mainly present to allow you to know when to display your own notice if you have disabled our standard notice.

Parameters

No parameter.

Returns

Promise<boolean>

Example

await Didomi.shouldConsentBeCollected()

shouldUserStatusBeCollected

Determine if user status (consent) should be collected for the user. Returns true if status is required for the current user and one of following two conditions is met:

  • User status has never been collected for this user yet

  • New user status should be collected (as new vendors have been added) AND the number of days before recollecting them has exceeded

If none of these two conditions is met, the function returns False. This function is mainly present to allow you to know when to display your own notice if you have disabled our standard notice.

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

Promise<boolean>

Example

await Didomi.shouldUserStatusBeCollected()

updateSelectedLanguage

Method used to update the selected language of the Didomi SDK and any property that depends on it.

In most cases this method doesn't need to be called. It would only be required for those apps that allow language change on-the-fly, i.e.: from within the app rather than from the device settings.

In order to update the language of the views displayed by the Didomi SDK, this method needs to be called before these views are displayed.

Requires SDK to be initialized

Yes.

Parameters

Name
Type
Description

languageCode

string

string containing the 2-letter language code e.g. en, es, fr, etc.

Returns

Nothing

Example

Didomi.onReady().then(() => {
    Didomi.updateSelectedLanguage("fr");
});
PreviousSetupNextVersions

Last updated