Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Reference

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

Always use Didomi.GetInstance() to get a reference to the Didomi SDK. 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.

At the moment, on iOS, only one event listener is supported at the same time. If additional callbacks are required, they should be appended to the event handlers as in the example below.

Requires SDK to be initialized

No.

Parameters

Name
Type
Description

eventListener

DidomiEventListener

The event listener. An instance or a subclass of DidomiEventListener. Contains handlers for the different possible events.

Returns

Nothing

Example

   
    private void RegisterEventHandlers()
    {
        DidomiEventListener eventListener = new DidomiEventListener();
        eventListener.ConsentChanged += EventListener_ConsentChanged;
        eventListener.Ready += EventListener_Ready;
        eventListener.ShowNotice += EventListener_ShowNotice;
        eventListener.HideNotice += EventListener_HideNotice;
        eventListener.NoticeClickAgree += EventListener_NoticeClickAgree;
        eventListener.NoticeClickMoreInfo += EventListener_NoticeClickMoreInfo;
        eventListener.NoticeClickViewSPIPurposes += EventListener_NoticeClickViewSPIPurposes;
        eventListener.PreferencesClickAgreeToAll += EventListener_PreferencesClickAgreeToAll;
        eventListener.PreferencesClickDisagreeToAll += EventListener_PreferencesClickDisagreeToAll;
        eventListener.PreferencesClickViewVendors += EventListener_PreferencesClickViewVendors;
        eventListener.PreferencesClickViewSPIPurposes += EventListener_PreferencesClickViewSPIPurposes;
        eventListener.PreferencesClickSaveChoices += EventListener_PreferencesClickSaveChoices;
        eventListener.PreferencesClickPurposeAgree += EventListener_PreferencesClickPurposeAgree;
        eventListener.PreferencesClickPurposeDisagree += EventListener_PreferencesClickPurposeDisagree;
        eventListener.PreferencesClickCategoryAgree += EventListener_PreferencesClickCategoryAgree;
        eventListener.PreferencesClickCategoryDisagree += EventListener_PreferencesClickCategoryDisagree;
        eventListener.PreferencesClickSPIPurposeAgree += EventListener_PreferencesClickSPIPurposeAgree;
        eventListener.PreferencesClickSPIPurposeDisagree += EventListener_PreferencesClickSPIPurposeDisagree;
        eventListener.PreferencesClickSPICategoryAgree += EventListener_PreferencesClickSPICategoryAgree;
        eventListener.PreferencesClickSPICategoryDisagree += EventListener_PreferencesClickSPICategoryDisagree;
        eventListener.PreferencesClickSPIPurposeSaveChoices += EventListener_PreferencesClickSPIPurposeSaveChoices;
        eventListener.PreferencesClickVendorAgree += EventListener_PreferencesClickVendorAgree;
        eventListener.PreferencesClickVendorDisagree += EventListener_PreferencesClickVendorDisagree;
        eventListener.PreferencesClickVendorSaveChoices += EventListener_PreferencesClickVendorSaveChoices;
        eventListener.HidePreferences += EventListener_HidePreferences;
        eventListener.ShowPreferences += EventListener_ShowPreferences;
        eventListener.SyncReady += EventListener_SyncReady;
        eventListener.SyncDone += EventListener_SyncDone;
        eventListener.SyncError += EventListener_SyncError;
        eventListener.LanguageUpdated += EventListener_LanguageUpdated;
        eventListener.LanguageUpdateFailed += EventListener_LanguageUpdateFailed;

        Didomi.GetInstance().AddEventListener(eventListener);
    }

    private void EventListener_ConsentChanged(object sender, ConsentChangedEvent e)
    {
        // The consent status of the user has changed
    }
    
    private void EventListener_Ready(object sender, ReadyEvent e)
    {
        // The Didomi SDK is ready
    }

    private void EventListener_ShowNotice(object sender, ShowNoticeEvent e)
    {
        // The notice is being shown or needs to be shown
    }
    
   private void EventListener_HideNotice(object sender, HideNoticeEvent e)
    {
        // The notice is being hidden
    }
    
    private void EventListener_NoticeClickAgree(object sender, NoticeClickAgreeEvent e)
    {
        // Click on agree on notice
    }

    private void EventListener_NoticeClickMoreInfo(object sender, NoticeClickMoreInfoEvent e)
    {
        // Click on learn more on notice
    }
    
    private void EventListener_NoticeClickViewSPIPurposes(object sender, NoticeClickViewSPIPurposesEvent e)
    {
        // Click on "Limit the use of my Sensitive Personal Information" on notice
    }
    
    private void EventListener_PreferencesClickAgreeToAll(object sender, PreferencesClickAgreeToAllEvent e)
    {
        // Click on agree to all on preferences popup
    }
    
    private void EventListener_PreferencesClickDisagreeToAll(object sender, PreferencesClickDisagreeToAllEvent e)
    {
        // Click on disagree to all on preferences popup
    }
  
    private void EventListener_PreferencesClickViewSPIPurposes(object sender, PreferencesClickViewSPIPurposesEvent e)
    {
        // Click on "Limit the use of my Sensitive Personal Information" on preferences screen
    }
      
    private void EventListener_PreferencesClickViewVendors(object sender, PreferencesClickViewVendorsEvent e)
    {
        // Click view vendors on purposes view on preferences popup
    }
    
    private void EventListener_PreferencesClickSaveChoices(object sender, PreferencesClickSaveChoicesEvent e)
    {
        // Click on save on the purposes view on preferences popup
    }
    
    private void EventListener_PreferencesClickPurposeAgree(object sender, PreferencesClickPurposeAgreeEvent e)
    {
        // Click on agree to a purpose on preferences popup
    }
    
    private void EventListener_PreferencesClickPurposeDisagree(object sender, PreferencesClickPurposeDisagreeEvent e)
    {
        // Click on disagree to a purpose on preferences popup
    }
    
    private void EventListener_PreferencesClickCategoryAgree(object sender, PreferencesClickCategoryAgreeEvent e)
    {
        // Click on agree to a purposes category on preferences popup
    }
    
    private void EventListener_PreferencesClickCategoryDisagree(object sender, PreferencesClickCategoryDisagreeEvent e)
    {
        // Click on disagree to a purposes category on preferences popup
    }
    
    private void EventListener_PreferencesClickSPIPurposeAgree(object sender, PreferencesClickSPIPurposeAgreeEvent e)
    {
        // Click on agree to a purpose on sensitive personal information screen
    }
    
    private void EventListener_PreferencesClickSPIPurposeDisagree(object sender, PreferencesClickSPIPurposeDisagreeEvent e)
    {
        // Click on disagree to a purpose on sensitive personal information screen
    }
    
    private void EventListener_PreferencesClickSPICategoryAgree(object sender, PreferencesClickSPICategoryAgreeEvent e)
    {
        // Click on agree to a purposes category on sensitive personal information screen
    }
    
    private void EventListener_PreferencesClickCategoryDisagree(object sender, PreferencesClickSPICategoryDisagreeEvent e)
    {
        // Click on disagree to a purposes category on sensitive personal information screen
    }
    
    private void EventListener_PreferencesClickSPIPurposeSaveChoices(object sender, PreferencesClickSPIPurposeSaveChoicesEvent e)
    {
        // Click on save on the sensitive personal information screen
    }

    private void EventListener_PreferencesClickVendorAgree(object sender, PreferencesClickVendorAgreeEvent e)
    {
        // Click on agree to a vendor on preferences popup
    }

    private void EventListener_PreferencesClickVendorDisagree(object sender, PreferencesClickVendorDisagreeEvent e)
    {
        // Click on disagree to a vendor on preferences popup
    }
    
    private void EventListener_PreferencesClickVendorSaveChoices(object sender, PreferencesClickVendorSaveChoicesEvent e)
    {
        // Click on save on the vendors view on preferences popup
    }
    
    private void EventListener_ShowPreferences(object sender, ShowPreferencesEvent e)
    {
        // The preferences screen is being shown
    }
    
    private void EventListener_HidePreferences(object sender, HidePreferencesEvent e)
    {
        // The preferences screen is being hidden
    }
    
    private void EventListener_SyncReady(object sender, SyncReadyEvent e)
    {
        // Synchronization process is complete
    }
    
    private void EventListener_SyncDone(object sender, SyncDoneEvent e)
    {
        // Synchronization was done successfully
    }
    
    private void EventListener_SyncError(object sender, SyncErrorEvent e)
    {
        // An error occurred during synchronization
    }
    
    private void EventListener_LanguageUpdated(object sender, LanguageUpdatedEvent e)
    {
        // Language update was completed
    }
    
    private void EventListener_LanguageUpdateFailed(object sender, LanguageUpdateFailedEvent e)
    {
        // Language update was not completed
    }

Event types

The following events are supported by the Didomi SDK:

Event
Description

ConsentChangedEvent

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).

HideNoticeEvent

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.

ShowNoticeEvent

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.

NoticeClickAgreeEvent

When user clicks on agree on the notice

NoticeClickMoreInfoEvent

When user clicks on learn more on the notice

NoticeClickViewSPIPurposesEvent

When user clicks on "Limit the use of my personal information" on the notice

PreferencesClickAgreeToAllEvent

When user clicks on agree to all on the preferences popup

PreferencesClickDisagreeToAllEvent

When user clicks on disagree to all on the preferences popup

PreferencesClickPurposeAgreeEvent

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

PreferencesClickPurposeDisagreeEvent

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

PreferencesClickCategoryAgreeEvent

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

PreferencesClickCategoryDisagreeEvent

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

PreferencesClickViewSPIPurposesEvent

When user clicks on "Limit the use of my personal information" on the preferences popup

PreferencesClickViewVendorsEvent

When user clicks on view vendors on the preferences popup

PreferencesClickSaveChoicesEvent

When user saves his choice on the preferences popup

PreferencesClickSPIPurposeAgreeEvent

When user agrees to a purpose on the sensitive personal information screen. (purposeId provided as a parameter)

PreferencesClickSPIPurposeDisagreeEvent

When user disagrees to a purpose on the sensitive personal information screen. (purposeId provided as a parameter)

PreferencesClickSPICategoryAgreeEvent

When user agrees to a purposes category on the sensitive personal information screen. (categoryId provided as a parameter)

PreferencesClickSPICategoryDisagreeEvent

When user disagrees to a purposes category on the sensitive personal information screen. (categoryId provided as a parameter)

PreferencesClickSPIPurposeSaveChoicesEvent

When user saves his choice on the sensitive personal information screen

PreferencesClickVendorAgreeEvent

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

PreferencesClickVendorDisagreeEvent

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

PreferencesClickVendorSaveChoicesEvent

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

HidePreferencesEvent

When preferences screen is hidden

ShowPreferencesEvent

When preferences screen is shown

SyncReadyEvent

When synchronization is complete.

Provides the methods GetOrganizationUserId, IsStatusApplied and SyncAcknowledged (see below)

SyncReadyEvent.OrganizationUserId

organizationUserId of the user that was synchronized

SyncReadyEvent.IsStatusApplied

bool indicating 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.

SyncDoneEvent

Deprecated, use SyncReady instead.

When synchronization is complete (synchronized organizationUserId provided as parameter)

SyncErrorEvent

When synchronization encountered an error (errorMessage provided as parameter)

LanguageUpdatedEvent

When selected language update was completed (selected languageCode provided as parameter)

LanguageUpdateFailedEvent

When language selection update was not able to complete (reason provided as parameter)

addVendorStatusListener

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

At the moment, on iOS, only one listener per vendor is supported at the same time. If additional callbacks are required, they should be appended to the vendor status listener handler, as in the example below.

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.

vendorStatusListener

DidomiVendorStatusListener

An instance or a subclass of DidomiVendorStatusListener. Contains a handler called when vendor status is changed.

When this callback is executed, the status linked to the specified vendor will be passed.

Returns

Nothing

Example

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

DisableMockUI

Disable or enable the mock UI when testing in Unity Editor.

Android and iOS platform builds

This function has no effect for iOS or Android platform builds. It can safely be called in all environments and will only impact the Unity Editor.

Requires SDK to be initialized

No

Parameters

Name
Type
Description

disable

boolean

true to disable the mock UI

Returns

No return value

Example

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

string

JavaScript code to embed in a WebView

Example

GetPurpose

Get a purpose based on its ID.

Not available for IOS platform builds

This function is only exposed to Unity Android platform builds. It cannot be called from Unity IOS platform builds.

Requires SDK to be initialized

Yes.

Parameters

Name
Type
Description

purposeId

string

ID of the purpose we want to get.

Returns

Type
Description

Purpose

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

Example

GetRequiredPurposes

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

Not available for IOS platform builds

This function is only exposed to Unity Android platform builds. It cannot be called from Unity IOS platform builds.

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

Type
Description

ISet<Purpose>

A set of type Purpose containing the required purposes.

Example

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

ISet<string>

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

Example

GetRequiredVendors

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

Not available for IOS platform builds

This function is only exposed to Unity Android platform builds. It cannot be called from Unity IOS platform builds.

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

Type
Description

ISet<Vendor>

A set of type Vendor containing the required vendors.

Example

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

ISet<string>

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

Example

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

IDictionary<string,string>

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

Example

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

GetCurrentUserStatus

Exposes the user status for the current regulation that applies.

Requires SDK to be initialized

Yes.

Parameters

No parameters.

Returns

The user status containing the computed global status for Vendors and purposes:

  • A vendor's global status is enabled, if and only if:

    • the vendor is enabled directly in the vendors layer in all legal basis

    • AND all its related purposes are enabled or essential.

  • A purpose's global status is enabled in one of the two conditions:

    • the purpose is enabled for all the legal basis that it is configured for.

    • OR when the purpose is essential.

Parameter
Type
Description

didomiDcs

string

Didomi Consent String that stores end-user choices for custom and Google ATP vendors, and custom and global purposes across all regulations. Click here for more information.

Vendors

object

  • Dictionary that maps the ID of a vendor to an object representing its status.

  • The IDs used in this dictionary correspond to the Didomi IDs i.e.: without the c: or any other prefix.

  • Vendors with undefined user status are included in the response with enabled: false.

  • Vendors with ONLY essential purposes are automatically set with enable: true

Purposes

object

  • Dictionary that maps the ID of a purpose to an object representing its status.

  • Purposes with undefined user status are included in the response with enabled: false.

  • Essential purposes are automatically set with enable: true

Regulation

String

  • Representation of the current regulation as a Regulation enum value, such as GDPR, CCPA, CPRA, or NONE.

  • Note that some regulations present as enum values are not available yet.

UserId

String

Didomi user id.

Created

String

User choices creation date.

Updated

String

User choices update date.

ConsentString

String

TCF consent as string

AdditionalConsent

String

Additional consent.

GppString

String

GPP string.

Throws

Type

Description

DidomiNotReadyException

Exception thrown when a method that requires the Didomi SDK to be ready is called before that. Developers can call this method within a try/catch or within a lambda expression passed into the onReady method.

Example

GetVendor

Get a vendor based on its ID.

Not available for IOS platform builds

This function is only exposed to Unity Android platform builds. It cannot be called from Unity IOS platform builds.

Requires SDK to be initialized

Yes.

Parameters

Name
Type
Description

vendorId

string

ID of the vendor we want to get.

Returns

Type
Description

Vendor

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

Example

HideNotice

Hide the consent notice.

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

Nothing

Example

HidePreferences

Hide the preferences popup.

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

Nothing

Example

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

Name

Type

Description

initializeParameters

DidomiInitializeParameters

Object containing the application parameters, see below

The DidomiInitializeParameters object contains all the information needed to initialize the SDK.

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 null.

remoteConfigurationURL

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 null.

disableDidomiRemoteConfig (deprecated)

bool

Yes

Prevent the SDK from loading a remote configuration from the Didomi Console. Defaults to false (allows 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", "en-US", "zh-HK", 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.

tvNoticeId (only used on Android TV

string

Yes

TV notice ID to load the configuration from. If provided and SDK is initialized on Android TV, the SDK bypasses the app ID targeting and directly loads the configuration from the notice ID.

androidTvEnabled (only used on Android TV)

bool

Yes

Enable the Android TV SDK. Defaults to false (Android TV is not enabled).

This parameter will be checked if sdk is initialized from a TV device.

If set to false, the sdk initialization will fail with an error.

If set to true, the sdk will try to initialize in TV mode, using the API key and the optional tvNoticeId parameter.

Please note that the TV notice option must be enabled on Didomi side. Please reach out to your dedicated customer success manager to know more.

countryCode

string

Yes

Override user country code when determining the privacy regulation to apply.

Keep null to let the Didomi SDK determine the user country.

regionCode

string

Yes

Override user region code when determining the privacy regulation to apply.

Keep null to let the Didomi SDK determine the user region.

Ignored if countryCode is not set.

isUnderage

bool

Yes

Whether the user is underage or not. Defaults to False. This parameters can only be used if the Underage feature has been configured in your notice. (Underage is currently in beta version).

Returns

Nothing

Example

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.

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

bool

Example

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.

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

bool

Example

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

bool

Example

IsNoticeVisible

Check if the consent notice is currently displayed.

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

bool

Example

IsPreferencesVisible

Check if the preferences popup is currently displayed.

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

bool

Example

IsReady

Check if the SDK is ready.

Requires SDK to be initialized

No.

Parameters

No parameter.

Returns

bool

Example

OnReady

Add an event listener that will be called when the SDK is ready (ie fully initialized). If the event listener is added after the SDK initialization, the listener will be called immediately.

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

Requires SDK to be initialized

No.

Parameters

Name
Type
Description

callback

Action

An action to call when the SDK is ready

Returns

Nothing

Example

OnError

Add an event listener that will be called when the SDK initialization encounters an error or if an unexpected situation occurs. Note that the behavior of the callback may slightly differ between Android and iOS platforms.

Requires SDK to be initialized

No.

Parameters

Name
Type
Description

callback

Action

An action to call when the SDK encounters an error

Returns

Nothing

Example

OpenCurrentUserStatusTransaction

Definition

Create an instance of the CurrentUserStatusTransaction class.

This class 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

An instance of the CurrentUserStatusTransaction class.

Description of the CurrentUserStatusTransaction class

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.

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

Commit the changes that have been made through other methods.

Examples

SetupUI

Internally, the setupUI method calls the showNotice method, which calls the shouldUserStatusBeCollected method. Therefore, by calling the setupUI method, the notice or preferences view will be displayed only if required.

Setup the SDK UI workflows. By calling this method the notice or the preferences views will be displayed only once the SDK is ready and if consent should be collected.

For IOS platformsUIViewController returned by UnityGetGLViewController at Unity is used as base UI. For Android platforms Activity returned by com.unity3d.player.UnityPlayer.currentActivity is used as base UI.

Requires SDK to be initialized

No.

Parameters

No parameter.

Returns

Nothing

Example

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 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).

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

Nothing

Example

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 can be used to allow the user to update their preferences after the banner has been closed. We suggest adding a link with this function call somewhere in your app.

Requires SDK to be initialized

Yes.

Parameters

Name
Type
Description

view

Didomi.Views

Optional, specify which view to open. Can be Didomi.Views.Purposes or Didomi.View.Vendors. By default, opens the Purposes screen.

Returns

Nothing

Example

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.

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

Nothing

Example

SetUser

Set custom user information from organization. More information about the organization user information behavior: Share consents across devices

Parameter

Name
Type
Description

userParameters

DidomiUserParameters

Object containing properties required to set a user.

Description for DidomiUserParameters:

Name
Type
Description

userAuth

UserAuth

User authentication object. Can be either UserAuthWithoutParams, UserAuthWithEncryptionParams or UserAuthWithHashParams.

dcsUserAuth

UserAuthParams

Optional. Dedicated user with encryption or hash used for Didomi Consent String signature. Can be either UserAuthWithEncryptionParams or UserAuthWithHashParams. This parameter can only be used if you are using the Didomi Consent String feature (This feature is currently in beta version)

isUnderage

bool?

Optional. Whether the user is underage or not. This parameter can only be used if the Underage feature has been configured in your notice. (Underage is currently in beta version).

Parameters for UserAuthWithoutParams :

Name
Type
Description

id

string

Organization ID to associate with the user.

Parameters for UserAuthWithEncryptionParams :

Name
Type
Description

id

string

Organization ID to associate with the user.

algorithm

string

Algorithm used for computing the user ID.

secretId

string

ID of the secret used for the computing the user ID.

initializationVector

string

Initialization Vector used for encrypting the message.

expiration

long?

Optional. Expiration time as UNIX timestamp (must be > 0).

Parameters for UserAuthWithHashParams :

Name
Type
Description

id

string

Organization ID to associate with the user.

algorithm

string

Algorithm used for computing the user ID.

secretId

string

ID of the secret used for the computing the user ID.

digest

string

Digest used for representing the user ID

salt

string?

Optional. Salt used for computing the user ID.

expiration

long?

Optional. Expiration time as UNIX timestamp (must be > 0)

Other signatures for SetUser are deprecated and should not be used.

Returns

Nothing

Example

SetUserAndSetupUI

Set custom user information from organization, and call SetupUI after synchronization if sdk was initialized

Parameters

See SetUser

Returns

Nothing

Example

ClearUser

Remove custom user information from organization

Requires SDK to be initialized

No.

Parameters

No parameter.

Returns

Nothing

Example

SetUserAgreeToAll

Report that the user has given consent to all purposes and vendors setup for your app programmatically. This function will log the consent on our platform and close the notice.

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

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

bool

true if the user consent status has changed (ie the user had given different consent information before this function got called).

Example

SetCurrentUserStatus

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

Add the desired global status for each vendor and each purpose:

  • the vendor status specified in this function will be reflected on the vendor’s layer.

    • vendor enabled : true → means the vendor is enabled in all the legal basis that this vendor uses.

    • vendor enabled : false → means the vendor is disabled in all the legal basis that this vendor uses

  • the purposes status specified in this function will be reflected on the preferences layer.

    • purpose enabled : true → means the purpose is enabled in all the legal basis in which it’s defined.

    • purpose enabled : false → means the purpose is disabled in all the legal basis in which it’s defined.

Returns

boolean

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

Example

SetUserDisagreeToAll

Report that the user has denied consent to all purposes and vendors setup for your app programmatically. This function will log the consent information on our platform and close the banner.

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

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

bool

true if the user consent status has changed (ie the user had given different consent information before this function got called).

Example

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.

Requires SDK to be initialized

Yes.

Parameters

No parameter.

Returns

bool

Example

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

bool

Example

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.

The language update is performed asynchronously. If you need to make sure the update is done, you can listen to the events LanguageUpdated / LanguageUpdateFailed.

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

PreviousSetupNextDeprecated

Last updated