Reference

This section is a comprehensive reference of the methods and events exposed by the Android 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.
Parameters
Name
Type
Description
eventListener
EventListener
The event listener. An instance of a subclass of io.didomi.sdk.events.EventListener
Returns
Nothing
Example
Java
Java
import io.didomi.sdk.events.ConsentChangedEvent;
import io.didomi.sdk.events.EventListener;
import io.didomi.sdk.events.HideNoticeEvent;
import io.didomi.sdk.events.ShowNoticeEvent;
import io.didomi.sdk.events.NoticeClickAgreeEvent;
import io.didomi.sdk.events.NoticeClickMoreInfoEvent;
import io.didomi.sdk.events.PreferencesClickAgreeToAllEvent;
import io.didomi.sdk.events.PreferencesClickDisagreeToAllEvent;
import io.didomi.sdk.events.PreferencesClickPurposeAgreeEvent;
import io.didomi.sdk.events.PreferencesClickPurposeDisagreeEvent;
import io.didomi.sdk.events.PreferencesClickViewVendorsEvent;
import io.didomi.sdk.events.PreferencesClickSaveChoicesEvent;
import io.didomi.sdk.events.PreferencesClickVendorAgreeEvent;
import io.didomi.sdk.events.PreferencesClickVendorDisagreeEvent;
import io.didomi.sdk.events.PreferencesClickVendorSaveChoicesEvent;
​
Didomi.getInstance().addEventListener(new EventListener() {
    @Override
    public void consentChanged(ConsentChangedEvent event) {
        // The consent status of the user has changed
    }
​
    @Override
    public void hideNotice(HideNoticeEvent event) {
        // The notice is being hidden
    }
​
    @Override
    public void showNotice(ShowNoticeEvent event) {
        // The notice is being shown
    }
    
    @Override
    public void noticeClickAgree(NoticeClickAgreeEvent event) {
        // Click on agree on notice
    }
    
    @Override
    public void noticeClickMoreInfo(NoticeClickMoreInfoEvent event) {
        // Click on learn more on notice
    }
    
    @Override
    public void preferencesClickAgreeToAll(PreferencesClickAgreeToAllEvent event) {
        // Click on agree to all on preferences popup
    }
    
    @Override
    public void preferencesClickDisagreeToAll(PreferencesClickDisagreeToAllEvent event) {
        // Click on disagree to all on preferences popup
    }
    
    @Override
    public void preferencesClickPurposeAgree(PreferencesClickPurposeAgreeEvent event) {
        String vendorId = event.getPurposeId();
        // Click on agree to a purpose on preferences popup
    }
    
    @Override
    public void preferencesClickPurposeDisagree(PreferencesClickPurposeDisagreeEvent event) {
        String vendorId = event.getPurposeId();
        // Click on disagree to a purpose on preferences popup
    }
​
    @Override
    public void preferencesClickViewVendors(PreferencesClickViewVendorsEvent event) {
        // Click view vendors on purposes view on preferences popup
    }
    
    @Override
    public void preferencesClickSaveChoices(PreferencesClickSaveChoicesEvent event) {
        // Click on save on the purposes view on preferences popup
    }
    
    @Override
    public void preferencesClickVendorAgree(PreferencesClickVendorAgreeEvent event) {
        String vendorId = event.getVendorId();
        // Click on agree to a vendor on preferences popup
    }
    
    @Override
    public void preferencesClickVendorDisagree(PreferencesClickVendorDisagreeEvent event) {
        String vendorId = event.getVendorId();
        // Click on disagree to a vendor on preferences popup
    }
    
    @Override
    public void preferencesClickVendorSaveChoices(PreferencesClickVendorSaveChoicesEvent event) {
        // Click on save on the vendors view on preferences popup
    }
});
Event types
The following event types are supported by the Didomi SDK:
Method
Event type
Description
consentChanged
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).
hideNotice
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.
showNotice
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.
noticeClickAgree
NoticeClickAgreeEvent
When user clicks on agree on the notice
noticeClickMoreInfo
NoticeClickMoreInfoEvent
When user clicks on learn more on the notice
preferencesClickAgreeToAll
PreferencesClickAgreeToAllEvent
When user clicks on agree to all on the preferences popup
preferencesClickDisagreeToAll
PreferencesClickDisagreeToAllEvent
When user clicks on disagree to all on the preferences popup
preferencesClickPurposeAgree
PreferencesClickPurposeAgreeEvent
When user agree to a purpose on the preferences popup. (purposeId provided as a parameter)
preferencesClickPurposeDisagree
PreferencesClickPurposeDisagreeEvent
When user disagree to a purpose on the preferences popup. (purposeId provided as a parameter)
preferencesClickViewVendors
PreferencesClickViewVendorsEvent
When user clicks on view vendors on the preferences popup
preferencesClickSaveChoices
PreferencesClickSaveChoicesEvent
When user saves his choice on the preferences popup
preferencesClickVendorAgree
PreferencesClickVendorAgreeEvent
When user agree to a vendor on the preferences popup. (vendorId provided as a parameter)
preferencesClickVendorDisagree
PreferencesClickVendorDisagreeEvent
When user disagree to a vendor on the preferences popup. (vendorId provided as a parameter)
preferencesClickVendorSaveChoices
PreferencesClickVendorSaveChoicesEvent
When user saves his choice on the vendors view on the preferences popup
getDisabledPurposes
Get the list of purposes that have been disabled by the user.
Requires SDK to be initialized
Yes.
Parameters
No parameter.
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.
Returns
Type
Description
Set<Purpose>
A set of type Purpose containing the purposes disabled by the user.
Example
Java
Java
Didomi.getInstance().getDisabledPurposes();
getDisabledPurposeIds
Get the list of purpose IDs that have been disabled by the user.
Requires SDK to be initialized
Yes.
Parameters
No parameter.
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.
Returns
Type
Description
Set<String>
A set of type String containing the IDs of purposes disabled by the user.
Example
Java
Java
Didomi.getInstance().getDisabledPurposeIds();
getDisabledVendors
Get the list of vendors that have been disabled by the user.
Requires SDK to be initialized
Yes.
Parameters
No parameter.
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.
Returns
Type
Description
Set<Vendor>
A set of type Vendor containing the vendors disabled by the user.
Example
Java
Java
Didomi.getInstance().getDisabledVendors();
getDisabledVendorIds
Get the list of vendor IDs that have been disabled by the user.
Requires SDK to be initialized
Yes.
Parameters
No parameter.
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.
Returns
Type
Description
Set<String>
A set of type String containing the IDs of vendors disabled by the user.
Example
Java
Java
Didomi.getInstance().getDisabledVendorIds();
getEnabledPurposes
Get the list of purposes that have been enabled by the user.
Requires SDK to be initialized
Yes.
Parameters
No parameter.
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.
Returns
Type
Description
Set<Purpose>
A set of type Purpose containing the purposes enabled by the user.
Example
Java
Java
Didomi.getInstance().getEnabledPurposes();
​
getEnabledPurposeIds
Get the list of purpose IDs that have been enabled by the user.
Requires SDK to be initialized
Yes.
Parameters
No parameter.
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.
Returns
Type
Description
Set<String>
A set of type String containing the IDs of purposes enabled by the user.
Example
Java
Java
Didomi.getInstance().getEnabledPurposeIds();
getEnabledVendors
Get the list of vendors that have been enabled by the user.
Requires SDK to be initialized
Yes.
Parameters
No parameter.
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.
Returns
Type
Description
Set<Vendor>
A set of type Vendor containing the vendors enabled by the user.
Example
Java
Java
Didomi.getInstance().getEnabledVendors();
getEnabledVendorIds
Get the list of vendor IDs that have been enabled by the user.
Requires SDK to be initialized
Yes.
Parameters
No parameter.
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.
Returns
Type
Description
Set<String>
A set of type String containing the IDs of vendors enabled by the user.
Example
Java
Java
Didomi.getInstance().getEnabledVendorIds();
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.
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.
Returns
Type
Description
String
JavaScript code to embed in a WebView
Example
Java
Java
Didomi.getInstance().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.
Requires SDK to be initialized
Yes.
Parameters
No parameter.
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.
Returns
Type
Description
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
Java
Java
Didomi.getInstance().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.
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.
Returns
Type
Description
Purpose
A Purpose with ID purposeId found in the array of required purposes.
Example
Java
Java
Didomi.getInstance().getPurpose("purpose-id");
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.
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.
Returns
Type
Description
Set<Purpose>
A set of type Purpose containing the required purposes.
Example
Java
Java
Didomi.getInstance().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.
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.
Returns
Type
Description
Set<String>
A set of type String containing the IDs of required purposes.
Example
Java
Java
Didomi.getInstance().getRequiredPurposeIds();
getRequiredVendors
Get the list of vendors that are required (determined from the configuration).
Requires SDK to be initialized
Yes.
Parameters
No parameter.
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.
Returns
Type
Description
Set<Vendor>
A set of type Vendor containing the required vendors.
Example
Java
Java
Didomi.getInstance().getRequiredVendors();
getRequiredVendorIds
Get the list of vendor IDs that are required (determined from the configuration).
Requires SDK to be initialized
Yes.
Parameters
No parameter.
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.
Returns
Type
Description
Set<String>
A set of type String containing the IDs of required vendors.
Example
Java
Java
Didomi.getInstance().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
Dictionary/map containing the translations for an specific key in different languages, with the form { "en:" "text in English", "fr": "texte en Français" }
Example
Java
Java
Didomi.getInstance().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:
Custom texts for the consent notice: https://developers.didomi.io/cmp/mobile-sdk/consent-notice/customize-the-notice#texts​
Custom texts for the preferences: https://developers.didomi.io/cmp/mobile-sdk/consent-notice/customize-the-preferences-popup#text​
Custom texts for custom notices: https://developers.didomi.io/cmp/mobile-sdk/consent-notice/build-your-own-custom-notice#translatable-texts-for-custom-notices​
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
Java
Java
Didomi.getInstance().getTranslatedText("key");
getUserConsentStatusForPurpose
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.
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.
Returns
A Boolean that indicates if the user has given consent or not to the specific purpose.
null is returned if the consent status is not known yet. From a GDPR perspective, you'll want to treat null 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
Java
Java
Didomi.getInstance().getUserConsentStatusForPurpose("analytics");
getUserConsentStatusForVendor
Get the user consent status for a given vendor. You must also check that the user has given consent to some or all of the purposes required by a vendor before loading the vendor.
The function getUserConsentStatusForVendorAndRequiredPurposes does all the required checks for you so it might be a better choice.
Parameters
Name
Type
Description
vendorId
String
The ID of the vendor to check the user consent for.
If you are checking an IAB vendor, pass the number as a String.
If you are checking a custom vendor, prefix your vendor ID with c:.
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.
Returns
A Boolean that indicates if the user has given consent or not to the specific vendor.
null is returned if the consent status is not known yet. From a GDPR perspective, you'll want to treat null 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
Java
Java
// IAB vendors
Didomi.getInstance().getUserConsentStatusForVendor("1");
​
// Didomi vendors
Didomi.getInstance().getUserConsentStatusForVendor("google");
​
// Custom vendors (prefix vendor ID with c:)
Didomi.getInstance().getUserConsentStatusForVendor("c:custom-vendor-id");
getUserConsentStatusForVendorAndRequiredPurposes
Get the user consent status for a given vendor. We use the list of purposes declared for the vendor to make sure that it has consent for all of them. The required purposes are automatically setup for IAB or Didomi vendors and you must specify the required purposes for your custom vendors when configuring the tag.
Parameters
Name
Type
Description
vendorId
String
The ID of the vendor to check the user consent for.
If you are checking an IAB vendor, pass the number as a String.
If you are checking a custom vendor, prefix your vendor ID with c:.
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.
Returns
A Boolean that indicates if the user has given consent or not to the specific vendor and all the purposes that require consent for that vendor.
null is returned if the consent status is not known yet. From a GDPR perspective, you'll want to treat null 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
Java
Java
// IAB vendors
Didomi.getInstance().getUserConsentStatusForVendorAndRequiredPurposes("1");
​
// Didomi vendors
Didomi.getInstance().getUserConsentStatusForVendorAndRequiredPurposes("google");
​
// Custom vendors (prefix vendor ID with c:)
Didomi.getInstance().getUserConsentStatusForVendorAndRequiredPurposes("c:custom-vendor-id");
getUserLegitimateInterestStatusForPurpose
Get the user legitimate interest status for a given purpose. 
Parameters
Name
Type
Description
purposeId
String
The ID of the purpose to check the user legitimate interest for.
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.
Returns
A Boolean that indicates if the user has allowed legitimate interest data processing to the specific purpose.
null is returned if the legitimate interest status is not known yet. From a GDPR perspective, you'll want to treat null as false (ie no legitimate interest status given) but it is helpful to know that the user has not interacted with the legitimate interest UI yet so that you can subscribe to events and wait for legitimate interest information to be collected.
Example
Java
Java
Didomi.getInstance().getUserLegitimateInterestStatusForPurpose("measure_ad_performance);
getUserLegitimateInterestForVendor
Get the user legitimate interest status for a given vendor. You must also check that the user has allowed legitimate interest data processing for some or all of the purposes required by a vendor before loading the vendor.
The function getUserLegitimateInterestStatusForVendorAndRequiredPurposes does all the required checks for you so it might be a better choice.
Parameters
Name
Type
Description
vendorId
String
The ID of the vendor to check the user legitimate interest status for.
If you are checking an IAB vendor, pass the number as a String.
If you are checking a custom vendor, prefix your vendor ID with c:.
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.
Returns
A Boolean that indicates if the user has allowed legitimate interest data processing for the specific vendor.
null is returned if the legitimate interest status is not known yet. From a GDPR perspective, you'll want to treat null as false (ie no consent given) but it is helpful to know that the user has not interacted with the legitimate interest UI yet so that you can subscribe to events and wait for legitimate interest information to be collected.
Example
Java
Java
// IAB vendors
Didomi.getInstance().getUserLegitimateInterestStatusForVendor("1");
​
// Didomi vendors
Didomi.getInstance().getUserLegitimateInterestStatusForVendor("google");
​
// Custom vendors (prefix vendor ID with c:)
Didomi.getInstance().getUserLegitimateInterestStatusForVendor("c:custom-vendor-id");
getUserLegitimateInterestStatusForVendorAndRequiredPurposes
Get the user legitimate interest status for a given vendor. We use the list of purposes declared for the vendor to make sure that it has allowed legitimate interest data processing for all of them. The required purposes are automatically setup for IAB or Didomi vendors and you must specify the required purposes for your custom vendors when configuring the tag.
Parameters
Name
Type
Description
vendorId
String
The ID of the vendor to check the user legitimate interest status for.
If you are checking an IAB vendor, pass the number as a String.
If you are checking a custom vendor, prefix your vendor ID with c:.
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.
Returns
A Boolean that indicates if the user has allowed legitimate interest data processing to the specific vendor and all the purposes that require legitimate interest for that vendor.
null is returned if the legitimate interest status is not known yet. From a GDPR perspective, you'll want to treat null as false (ie no legitimate interest given) but it is helpful to know that the user has not interacted with the legitimate interest UI yet so that you can subscribe to events and wait for legitimate interest information to be collected.
Example
Java
Java
// IAB vendors
Didomi.getInstance().getUserLegitimateInterestStatusForVendorAndRequiredPurposes("1");
​
// Didomi vendors
Didomi.getInstance().getUserLegitimateInterestStatusForVendorAndRequiredPurposes("google");
​
// Custom vendors (prefix vendor ID with c:)
Didomi.getInstance().getUserLegitimateInterestStatusForVendorAndRequiredPurposes("c:custom-vendor-id");
getUserStatusForVendor
Get the user consent and legitimate interest status for a given vendor.
Parameters
Name
Type
Description
vendorId
String
The ID of the vendor to check the user status for.
If you are checking an IAB vendor, pass the number as a String.
If you are checking a custom vendor, prefix your vendor ID with c:.
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.
Returns
A Boolean that indicates if the user has allowed both consent and legitimate interest data processing to the specific vendor. 
If one of consent or legitimate interest data processing status is unknown or not allowed, false will be returned. If both are allowed by the user, the function will return true.
Example
Java
Java
// IAB vendors
Didomi.getInstance().getUserStatusForVendor("1");
​
// Didomi vendors
Didomi.getInstance().getUserStatusForVendor("google");
​
// Custom vendors (prefix vendor ID with c:)
Didomi.getInstance().getUserStatusForVendor("c:custom-vendor-id");
​
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.
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.
Returns
Type
Description
Vendor
A Vendor with ID vendorId found in the array of required vendors.
Example
Java
Java
Didomi.getInstance().getVendor("vendor-id");
hideNotice
Hide the consent notice.
Parameters
No parameter.
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.
Returns
Nothing
Example
Java
Java
Didomi.getInstance().hideNotice();
hidePreferences
Hide the preferences popup.
Parameters
No parameter.
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.
Returns
Nothing
Example
Java
Java
Didomi.getInstance().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
Name
Type
Nullable
Description
application
Application
No
A reference to your Application.
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.
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 null.
disableDidomiRemoteConfig
Boolean
No
Prevent the SDK from loading a remote configuration from the Didomi Console. Defaults to true (not 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
Java
Java
Didomi.getInstance().initialize(
    this,
    "<Your API key>",
    null,
    null,
    null,
    null,
    false,
    null
);
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.
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.
Returns
boolean
Example
Java
Java
Didomi.getInstance().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.
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.
Returns
boolean
Example
Java
Java
Didomi.getInstance().isUserConsentStatusPartial();
isNoticeVisible
Check if the consent notice is currently displayed.
Parameters
No parameter.
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.
Returns
boolean
Example
Java
Java
Didomi.getInstance().isNoticeVisible();
isPreferencesVisible
Check if the preferences popup is currently displayed.
Parameters
No parameter.
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.
Returns
boolean
Example
Java
Java
Didomi.getInstance().isPreferencesVisible();
isError
Check if the SDK has encountered an error
Parameters
No parameters
Returns
boolean
Example
Java
Java
Didomi.getInstance().isError();
isReady
Check if the SDK is ready.
Parameters
No parameter.
Returns
boolean
Example
Java
Java
Didomi.getInstance().isReady();
onError
Add an event listener that will be called when the SDK initialization encounters an error. If the event listener is added after the SDK initialization already failed, the listener will be called immediately.
If this listener is called, the SDK initialization will not complete and onReady will not be called.
Parameters
Name
Type
Description
callback
Runnable
An instance of Runnable to run when the SDK initialization encounters an error
Returns
Nothing
Example
Java
Java
Didomi.getInstance().onError(() -> {
    // The SDK has encountered an error
});
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.
Parameters
Name
Type
Description
callback
Runnable
An instance of Runnable to run when the SDK is ready
Returns
Nothing
Example
Java
Java
Didomi.getInstance().onReady(() -> {
    // The SDK is ready
});
setLogLevel
Set the minimum level of messages to log. The SDK will not log messages under that level.
See Logging for more information.
Parameters
Name
Type
Description
minLevel
int
Minimum level of messages to log.
Returns
Nothing
Example
Java
Java
Didomi.getInstance().setLogLevel(android.util.Log.INFO);
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 in the onCreate function of your activities and should be called in every activity where consent can be collected.
Parameters
Name
Type
Description
activity
AppCompatActivity
Activity used to get the Support Fragment Manager to display the consent notice.
Returns
Nothing
Example
Java
Java
Didomi.getInstance().setupUI(this);
setUser
Set custom user information from organization
Parameters
Method without authentication :
Name
Type
Description
organizationUserId
String
Organization ID to associate with the user
Method with authentication :
Name
Type
Description
organizationUserId
String
Organization ID to associate with the user
organizationUserIdAuthAlgorithm
String
Algorithm used for computing the digest
organizationUserIdAuthSid
String
ID of the secret used for computing the digest
organizationUserIdAuthSalt
String
Salt used for computing the digest (optional)
organizationUserIdAuthDigest
String
Digest of the organization user ID and secret
Returns
Nothing
Example
Java
Java
Didomi.getInstance().setUser("e3222031-7c45-4f4a-8851-ffd57dbf0a2a");
​
Didomi.getInstance().setUser(
            "e3222031-7c45-4f4a-8851-ffd57dbf0a2a",
            "hash-md5",
            "secret_id",
            "salt",
            "098f6bcd4621d373cade4e832627b4f6"
);
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).
Parameters
Type
​
AppCompatActivity
Activity used to get the Support Fragment Manager to display the Preferences view.
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.
Returns
Nothing
Example
Java
Java
Didomi.getInstance().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
​
AppCompatActivity
Activity used to get the Support Fragment Manager to display the Preferences view.
String (Optional)
Defines which view is displayed to the user first between the purposes view or the vendors view. We expose the values to provide on the Didomi class as VIEW_PURPOSES and VIEW_VENDORS. If this parameter is not defined or contains an unexpected string, the purposes' view will be displayed.
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.
Returns
Nothing
Example
Java
Java
// We pass "this" as a parameter as this method is called from an Activity.
Didomi.getInstance().showPreferences(this);
Didomi.getInstance().showPreferences(this, Didomi.VIEW_PURPOSES);
Didomi.getInstance().showPreferences(this, Didomi.VIEW_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.
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.
Returns
Nothing
Example
Java
Java
Didomi.getInstance().reset();
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.
Parameters
No parameter.
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.
Returns
boolean
true if the user consent status has changed (ie the user had given different consent information before this function got called).
Example
Java
Java
Didomi.getInstance().setUserAgreeToAll();
setUserConsentStatus
Set the user consent 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 your consent information at once and not one by one.
Parameters
Name
Type
Description
enabledPurposeIds
Set<String>
Set of purpose IDs that the user has given consent to
disabledPurposeIds
Set<String>
Set of purpose IDs that the user has not given consent to
enabledLegIntPurposeIds
Set<String>
Set of purpose IDs that the user has allowed legitimate interest processing to
disabledLegIntPurposeIds
Set<String>
Set of purpose IDs that the user has disallowed legitimate interest processing to
enabledVendorIds
Set<String>
Set of vendor IDs that the user has given consent to.
Prefix custom vendor IDs with c:.
disabledVendorIds
Set<String>
Set of vendor IDs that the user has not given consent to
enabledLegIntVendorIds
Set<String>
Set of vendor IDs that the user has allowed legitimate interest processing to.
Prefix custom vendor IDs with c:.
disabledLegIntVendorIds
Set<String>
Set of vendor IDs that the user has not allowed legitimate interest processing to
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.
Returns
boolean
true if the user consent status has changed (ie the user had given different consent information before this function got called).
Example
Java
Java
Didomi.getInstance().setUserConsentStatus(
    new HashSet<String>(Arrays.asList("cookies")),
    new HashSet<String>(),
    new HashSet<String>(Arrays.asList("123", "c:custom-vendor-id")),
    new HashSet<String>()
);
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.
For vendors, the consent purposes will be denied, but the vendors legitimate interest purposes will still be accepted if the user did not deny them manually.
Parameters
No parameter.
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.
Returns
boolean
true if the user consent status has changed (ie the user had given different consent information before this function got called).
Example
Java
Java
Didomi.getInstance().setUserDisagreeToAll();
shouldConsentBeCollected
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.
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.
Returns
boolean
Example
Java
Java
Didomi.getInstance().shouldConsentBeCollected()
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
Java
Second Tab
Java
Didomi.getInstance().onReady(() -> {
    Didomi.getInstance().updateSelectedLanguage("fr");
});
Second Tab
​

Logging

Versions

Last updated 2 weeks ago

Name	Type	Description
eventListener	`EventListener`	The event listener. An instance of a subclass of `io.didomi.sdk.events.EventListener`

Method	Event type	Description
consentChanged	`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).
hideNotice	`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.
showNotice	`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.
noticeClickAgree	`NoticeClickAgreeEvent`	When user clicks on agree on the notice
noticeClickMoreInfo	`NoticeClickMoreInfoEvent`	When user clicks on learn more on the notice
preferencesClickAgreeToAll	`PreferencesClickAgreeToAllEvent`	When user clicks on agree to all on the preferences popup
preferencesClickDisagreeToAll	`PreferencesClickDisagreeToAllEvent`	When user clicks on disagree to all on the preferences popup
preferencesClickPurposeAgree	`PreferencesClickPurposeAgreeEvent`	When user agree to a purpose on the preferences popup. (`purposeId` provided as a parameter)
preferencesClickPurposeDisagree	`PreferencesClickPurposeDisagreeEvent`	When user disagree to a purpose on the preferences popup. (`purposeId` provided as a parameter)
preferencesClickViewVendors	`PreferencesClickViewVendorsEvent`	When user clicks on view vendors on the preferences popup
preferencesClickSaveChoices	`PreferencesClickSaveChoicesEvent`	When user saves his choice on the preferences popup
preferencesClickVendorAgree	`PreferencesClickVendorAgreeEvent`	When user agree to a vendor on the preferences popup. (`vendorId` provided as a parameter)
preferencesClickVendorDisagree	`PreferencesClickVendorDisagreeEvent`	When user disagree to a vendor on the preferences popup. (`vendorId` provided as a parameter)
preferencesClickVendorSaveChoices	`PreferencesClickVendorSaveChoicesEvent`	When user saves his choice on the vendors view on the preferences popup

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.

Type	Description
`Set<Purpose>`	A set of type `Purpose` containing the purposes disabled by the user.

Type	Description
`Set<String>`	A set of type `String` containing the IDs of purposes disabled by the user.

Type	Description
`Set<Vendor>`	A set of type `Vendor` containing the vendors disabled by the user.

Type	Description
`String`	JavaScript code to embed in a WebView

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

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

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

Name	Type	Nullable	Description
application	Application	No	A reference to your Application.
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.
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 `null`.
disableDidomiRemoteConfig	Boolean	No	Prevent the SDK from loading a remote configuration from the Didomi Console. Defaults to `true` (not 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.

Name	Type	Description
callback	`Runnable`	An instance of Runnable to run when the SDK initialization encounters an error

Type
AppCompatActivity	Activity used to get the Support Fragment Manager to display the Preferences view.

Reference

addEventListener

getDisabledPurposes

getDisabledPurposeIds

getDisabledVendors

getDisabledVendorIds

getEnabledPurposes

​

getEnabledPurposeIds

getEnabledVendors

getEnabledVendorIds

getJavaScriptForWebView

getQueryStringForWebView

getPurpose

getRequiredPurposes

getRequiredPurposeIds

getRequiredVendors

getRequiredVendorIds

getText

getTranslatedText

getUserConsentStatusForPurpose

getUserConsentStatusForVendor

getUserConsentStatusForVendorAndRequiredPurposes

getUserLegitimateInterestStatusForPurpose

getUserLegitimateInterestForVendor

getUserLegitimateInterestStatusForVendorAndRequiredPurposes

getUserStatusForVendor

​

getVendor

hideNotice

hidePreferences

initialize

isConsentRequired

isUserConsentStatusPartial

isNoticeVisible

isPreferencesVisible

isError

isReady

onError

onReady

setLogLevel

setupUI

setUser

showNotice

showPreferences

reset

setUserAgreeToAll

setUserConsentStatus

setUserDisagreeToAll

shouldConsentBeCollected

updateSelectedLanguage