A C D F G H I L O R S T U V
All Classes All Packages

A

addEventListener(EventListener) - Method in class io.didomi.sdk.Didomi

Add an event listener

addEventListener(DidomiEventListener) - Method in class io.didomi.sdk.Didomi

Add an event listener

apiEventsRepository - Variable in class io.didomi.sdk.Didomi

C

clearInstance() - Static method in class io.didomi.sdk.Didomi

Internal use only. Clear the Didomi instance so it is possible to initialize it again.

configurationRepository - Variable in class io.didomi.sdk.Didomi

connectivityHelper - Variable in class io.didomi.sdk.Didomi

consentRepository - Variable in class io.didomi.sdk.Didomi

contextHelper - Variable in class io.didomi.sdk.Didomi

countryHelper - Variable in class io.didomi.sdk.Didomi

D

Didomi - Class in io.didomi.sdk

Main class exposed to apps

didomiInitializeParameters - Variable in class io.didomi.sdk.Didomi

F

forceShowNotice(FragmentActivity) - Method in class io.didomi.sdk.Didomi

Force show the consent notice without checking if consent is required

G

getApiEventsRepository() - Method in class io.didomi.sdk.Didomi

Getter method for apiEventsRepository property.

getConfigurationRepository() - Method in class io.didomi.sdk.Didomi

Getter for configurationRepository property.

getCountryHelper() - Method in class io.didomi.sdk.Didomi

Getter method for countryHelper property.

getDeviceType() - Method in class io.didomi.sdk.Didomi

Get the device type determined by Didomi SDK

getDisabledPurposeIds() - Method in class io.didomi.sdk.Didomi

Deprecated.

use getUserStatus() instead. The result of this method has been replaced by getUserStatus().getPurposes().getConsent().getDisabled().

getDisabledPurposes() - Method in class io.didomi.sdk.Didomi

Deprecated.

use getUserStatus() instead. The result of this method has been replaced by getUserStatus().getPurposes().getConsent().getDisabled().

getDisabledVendorIds() - Method in class io.didomi.sdk.Didomi

Deprecated.

use getUserStatus() instead. The result of this method has been replaced by getUserStatus().getVendors().getConsent().getDisabled().

getDisabledVendors() - Method in class io.didomi.sdk.Didomi

Deprecated.

use getUserStatus() instead. The result of this method has been replaced by getUserStatus().getVendors().getConsent().getDisabled().

getEnabledPurposeIds() - Method in class io.didomi.sdk.Didomi

Deprecated.

use getUserStatus() instead. The result of this method has been replaced by getUserStatus().getPurposes().getGlobal().getEnabled().

getEnabledPurposes() - Method in class io.didomi.sdk.Didomi

Deprecated.

use getUserStatus() instead. The result of this method has been replaced by getUserStatus().getPurposes().getGlobal().getEnabled().

getEnabledVendorIds() - Method in class io.didomi.sdk.Didomi

Deprecated.

use getUserStatus() instead. The result of this method has been replaced by getUserStatus().getVendors().getConsent().getEnabled().

getEnabledVendors() - Method in class io.didomi.sdk.Didomi

Deprecated.

use getUserStatus() instead. The result of this method has been replaced by getUserStatus().getVendors().getConsent().getEnabled().

getEventsRepository() - Method in class io.didomi.sdk.Didomi

Getter method for eventsRepository.

getInstance() - Static method in class io.didomi.sdk.Didomi

Get the global singleton instance of the Didomi SDK.

getJavaScriptForWebView() - Method in class io.didomi.sdk.Didomi

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

getJavaScriptForWebView(String) - Method in class io.didomi.sdk.Didomi

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

getLanguagesHelper() - Method in class io.didomi.sdk.Didomi

Method used to get the language helper.

getLogoResourceId() - Method in class io.didomi.sdk.Didomi

Get the logo resource id

getOrganizationUserRepository() - Method in class io.didomi.sdk.Didomi

Getter method for organizationUserRepository

getPurpose(String) - Method in class io.didomi.sdk.Didomi

Get a purpose from its ID

getQueryStringForWebView() - Method in class io.didomi.sdk.Didomi

Get a query-string to add to the URL of a WebView or Chrome Custom Tab to pass the consent status from the app to the Didomi Web SDK embedded on the target URL.

getRequiredPurposeIds() - Method in class io.didomi.sdk.Didomi

Get the configured purpose IDs

getRequiredPurposes() - Method in class io.didomi.sdk.Didomi

Get the configured purposes

getRequiredVendorIds() - Method in class io.didomi.sdk.Didomi

Get the configured vendor IDs

getRequiredVendors() - Method in class io.didomi.sdk.Didomi

Get the configured vendors

getResourcesHelper() - Method in class io.didomi.sdk.Didomi

Retrieve ResourcesHelper used to handle device resources

getText(String) - Method in class io.didomi.sdk.Didomi

Method used to get a dictionary/map for a given key in the form of { en: "Value in English", fr: "Value in French" } from the didomi_config.json file containing translations in different languages.

getTranslatedText(String) - Method in class io.didomi.sdk.Didomi

Method used to get a translated string for a given key from the didomi_config.json file based on the currently selected language.

getUiStateRepository() - Method in class io.didomi.sdk.Didomi

Internal use only. Used to handle some UI state parameters.

getUserConsentStatusForPurpose(String) - Method in class io.didomi.sdk.Didomi

Deprecated.

use getUserStatus() instead. Search the purposeId in getUserStatus().getPurposes().getConsent().getEnabled() or getUserStatus().getPurposes().getConsent().getDisabled().

getUserConsentStatusForVendor(String) - Method in class io.didomi.sdk.Didomi

Deprecated.

use getUserStatus() instead. Search the vendorId in getUserStatus().getVendors().getGlobalConsent().getEnabled() or getUserStatus().getVendors().getConsent().getDisabled().

getUserConsentStatusForVendorAndRequiredPurposes(String) - Method in class io.didomi.sdk.Didomi

Deprecated.

use getUserStatus() instead. The result of this method has been replaced by getUserStatus().getVendors().getGlobalConsent().getEnabled() or getUserStatus().getVendors().getGlobalConsent().getDisabled().

getUserLegitimateInterestStatusForPurpose(String) - Method in class io.didomi.sdk.Didomi

Deprecated.

use getUserStatus() instead. Search the purposeId in getUserStatus().getPurposes().getLegitimateInterest().getEnabled() or getUserStatus().getPurposes().getLegitimateInterest().getDisabled().

getUserLegitimateInterestStatusForVendor(String) - Method in class io.didomi.sdk.Didomi

Deprecated.

use getUserStatus() instead. Search the vendorId in getUserStatus().getVendors().getGlobalLegitimateInterest().getEnabled() or getUserStatus().getVendors().getLegitimateInterest().getDisabled().

getUserLegitimateInterestStatusForVendorAndRequiredPurposes(String) - Method in class io.didomi.sdk.Didomi

Deprecated.

use getUserStatus() instead. Search the purposeId in getUserStatus().getVendors().getGlobalLegitimateInterest().getEnabled() or getUserStatus().getVendors().getGlobalLegitimateInterest().getDisabled().

getUserStatus() - Method in class io.didomi.sdk.Didomi

Get the user consent status

getUserStatusForVendor(String) - Method in class io.didomi.sdk.Didomi

Deprecated.

use getUserStatus() instead. Search the vendorId in getUserStatus().getVendors().getGlobal().getEnabled() or getUserStatus().getVendors().getGlobal().getDisabled().

getVendor(String) - Method in class io.didomi.sdk.Didomi

Get a vendor from its ID

H

hasAnyStatus() - Method in class io.didomi.sdk.Didomi

Check if we have collected any status (consent or legitimate interest) from the user

hideNotice() - Method in class io.didomi.sdk.Didomi

Hide the notice if it is currently displayed

hidePreferences() - Method in class io.didomi.sdk.Didomi

Hide the Preferences dialog

httpRequestHelper - Variable in class io.didomi.sdk.Didomi

I

initialize(Application, DidomiInitializeParameters) - Method in class io.didomi.sdk.Didomi

Initialize the Didomi SDK and load its configuration.

initialize(Application, String, String, String, String) - Method in class io.didomi.sdk.Didomi

Deprecated.

Use initialize(Application, DidomiInitializeParameters) instead

initialize(Application, String, String, String, String, Boolean) - Method in class io.didomi.sdk.Didomi

Deprecated.

Use initialize(Application, DidomiInitializeParameters) instead

initialize(Application, String, String, String, String, Boolean, String) - Method in class io.didomi.sdk.Didomi

Deprecated.

Use initialize(Application, DidomiInitializeParameters) instead

initialize(Application, String, String, String, String, Boolean, String, String) - Method in class io.didomi.sdk.Didomi

Deprecated.

Use initialize(Application, DidomiInitializeParameters) instead

io.didomi.sdk - package io.didomi.sdk

isConsentRequired() - Method in class io.didomi.sdk.Didomi

Determine if consent is required for the user.

isError() - Method in class io.didomi.sdk.Didomi

Has the Didomi SDK encountered an error ?

isInitialized() - Method in class io.didomi.sdk.Didomi

Is the Didomi SDK initialized? This is set to `true` immediately after the call to `initialize()`.

isNoticeVisible() - Method in class io.didomi.sdk.Didomi

Check if the consent notice is currently displayed

isPreferencesVisible() - Method in class io.didomi.sdk.Didomi

Check if the Preferences view is currently displayed

isReady() - Method in class io.didomi.sdk.Didomi

Is the Didomi SDK ready?

isUserConsentStatusPartial() - Method in class io.didomi.sdk.Didomi

Determine if consent information is available for all purposes and vendors that are required

isUserLegitimateInterestStatusPartial() - Method in class io.didomi.sdk.Didomi

Determine if legitimate interest information is available for all purposes and vendors that are required

isUserStatusPartial() - Method in class io.didomi.sdk.Didomi

Check if consent or legitimate interest status is partial

L

languageReceiver - Variable in class io.didomi.sdk.Didomi

languagesHelper - Variable in class io.didomi.sdk.Didomi

O

onError(DidomiCallable) - Method in class io.didomi.sdk.Didomi

Provide a function that needs to be called if the SDK encounters an error during initialization.

onReady(DidomiCallable) - Method in class io.didomi.sdk.Didomi

Provide a function that needs to be called once the SDK is ready Automatically call the function if the SDK is already ready (that's why this is not a standard event)

R

remoteFilesHelper - Variable in class io.didomi.sdk.Didomi

removeEventListener(DidomiEventListener) - Method in class io.didomi.sdk.Didomi

Remove a previously added event listener

reset() - Method in class io.didomi.sdk.Didomi

Remove all consents for the user

resourcesHelper - Variable in class io.didomi.sdk.Didomi

S

setLogLevel(int) - Method in class io.didomi.sdk.Didomi

Set the minimum level of messages to log

setupUI(FragmentActivity) - Method in class io.didomi.sdk.Didomi

Show the consent notice if required (ie if consent information is missing)

setUser(UserAuthParams) - Method in class io.didomi.sdk.Didomi

Set user information with authentication

setUser(String) - Method in class io.didomi.sdk.Didomi

Set user information

setUser(String, String, String, String, String) - Method in class io.didomi.sdk.Didomi

Deprecated.

Use setUser(UserAuthParams) instead

setUserAgent(String, String) - Method in class io.didomi.sdk.Didomi

Set custom user agent name and version

setUserAgreeToAll() - Method in class io.didomi.sdk.Didomi

Enable all purposes and vendors for the user.

setUserConsentStatus(Set<String>, Set<String>, Set<String>, Set<String>, Set<String>, Set<String>, Set<String>, Set<String>) - Method in class io.didomi.sdk.Didomi

Deprecated.

Use setUserStatus(Set, Set, Set, Set, Set, Set, Set, Set) instead

setUserConsentStatusFromObjects(Set<Purpose>, Set<Purpose>, Set<Purpose>, Set<Purpose>, Set<Vendor>, Set<Vendor>, Set<Vendor>, Set<Vendor>) - Method in class io.didomi.sdk.Didomi

Deprecated.

Use setUserStatusFromObjects(Set, Set, Set, Set, Set, Set, Set, Set) instead

setUserDisagreeToAll() - Method in class io.didomi.sdk.Didomi

Update user status to disagree : disable consent and legitimate interest purposes, disable consent vendors, but still enable legitimate interest vendors.

setUserStatus(boolean, boolean, boolean, boolean) - Method in class io.didomi.sdk.Didomi

Set the user status globally

setUserStatus(Set<String>, Set<String>, Set<String>, Set<String>, Set<String>, Set<String>, Set<String>, Set<String>) - Method in class io.didomi.sdk.Didomi

Set the user status

setUserStatus(Set<String>, Set<String>, Set<String>, Set<String>, Set<String>, Set<String>, Set<String>, Set<String>, boolean) - Method in class io.didomi.sdk.Didomi

Deprecated.

This internal function should not be used, use setUserStatus(Set, Set, Set, Set, Set, Set, Set, Set) instead

setUserStatusFromObjects(Set<Purpose>, Set<Purpose>, Set<Purpose>, Set<Purpose>, Set<Vendor>, Set<Vendor>, Set<Vendor>, Set<Vendor>) - Method in class io.didomi.sdk.Didomi

Deprecated.

This internal function should not be used, use setUserStatus(Set, Set, Set, Set, Set, Set, Set, Set) instead

setUserStatusFromObjects(Set<Purpose>, Set<Purpose>, Set<Purpose>, Set<Purpose>, Set<Vendor>, Set<Vendor>, Set<Vendor>, Set<Vendor>, boolean) - Method in class io.didomi.sdk.Didomi

Deprecated.

This internal function should not be used, use setUserStatus(Set, Set, Set, Set, Set, Set, Set, Set) instead

sharedPreferences - Variable in class io.didomi.sdk.Didomi

shouldConsentBeCollected() - Method in class io.didomi.sdk.Didomi

Check if the consent should be collected depending on if we have any consents or if we have some consents but the number of days before displaying the notice again has not expired yet

showNotice(FragmentActivity) - Method in class io.didomi.sdk.Didomi

Show the consent notice (if required, not disabled in the config and not already displayed)

showPreferences(FragmentActivity) - Method in class io.didomi.sdk.Didomi

Show the Preferences dialog on the Purposes view

showPreferences(FragmentActivity, String) - Method in class io.didomi.sdk.Didomi

Method used to show the preferences view, by previously updating the fragment manager property based on an activity.

syncRepository - Variable in class io.didomi.sdk.Didomi

T

tcfRepository - Variable in class io.didomi.sdk.Didomi

U

uiProvider - Variable in class io.didomi.sdk.Didomi

uiStateRepository - Variable in class io.didomi.sdk.Didomi

updateSelectedLanguage(String) - Method in class io.didomi.sdk.Didomi

Update the selected language of the Didomi SDK and any property that depends on it.

userChoicesInfoProvider - Variable in class io.didomi.sdk.Didomi

userRepository - Variable in class io.didomi.sdk.Didomi

userStatusRepository - Variable in class io.didomi.sdk.Didomi

V

vendorRepository - Variable in class io.didomi.sdk.Didomi

VIEW_PURPOSES - Static variable in class io.didomi.sdk.Didomi

VIEW_VENDORS - Static variable in class io.didomi.sdk.Didomi

A C D F G H I L O R S T U V
All Classes All Packages