io.didomi.sdk

Class ConsentRepository

java.lang.Object

io.didomi.sdk.ConsentRepository

public class ConsentRepository
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ConsentRepository(android.content.SharedPreferences sharedPreferences, VendorRepository vendorRepository, ConfigurationRepository configurationRepository, io.didomi.sdk.user.UserRepository userRepository, TCFRepository tcfRepository, io.didomi.sdk.resources.LanguagesHelper languagesHelper)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConsentString()
ConsentToken	getConsentToken()
java.util.Set<java.lang.String>	getEnabledPurposeIds() Method used to get a set of enabled purpose IDs.
java.util.Set<Purpose>	getEnabledPurposes() Method used to get a set of enabled purposes.
java.lang.String	getGoogleAdditionalConsent()
java.util.Set<java.lang.String>	getRequiredEssentialPurposesIds()
java.lang.Integer	getTCFVersion()
boolean	hasAllConsentStatus(java.util.Set<Purpose> purposes, java.util.Set<Vendor> vendors) Check if all consent information is available (ie not consent status != unknown) for a set of purpose and vendor IDs
boolean	hasAllLegitimateInterestStatus(java.util.Set<Purpose> purposes, java.util.Set<Vendor> vendors) Check if all consent information is available (ie not consent status != unknown) for a set of purpose and vendor IDs
boolean	hasAnyConsentStatus() Check if we have collected any consent status from the user
boolean	isEssentialPurpose(java.lang.String purposeID) Method used to detect if a purpose ID corresponds to an essential purpose.
ConsentToken	loadConsentToken(int tcfVersion, java.util.Date ignoreConsentBefore, long consentDurationInSeconds, long deniedConsentDurationInSeconds) Load the consent token from the shared preferences
boolean	numberOfDaysHasExceeded() Determine if the number of days given by the client on the configuration before we could display the banner again if we need new consents has been exceeded:
java.util.Set<Purpose>	removeEssentialPurposes(java.util.Set<Purpose> purposeSet) Method used to remove essential purposes from an set of purposes.
void	resetConsentToken() Create a new consent token and store it
void	saveConsentToken() Save the consent token to the local storage
void	setLastSyncDate(java.util.Date lastSyncDate) Set the last sync date
boolean	setUserConsentStatus(java.util.Set<Purpose> enabledPurposes, java.util.Set<Purpose> disabledPurposes, java.util.Set<Purpose> enabledLegitimatePurposes, java.util.Set<Purpose> disabledLegitimatePurposes, java.util.Set<Vendor> enabledVendors, java.util.Set<Vendor> disabledVendors, java.util.Set<Vendor> enabledLegIntVendors, java.util.Set<Vendor> disabledLegIntVendors) Update the user consent status

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConsentRepository

public ConsentRepository(android.content.SharedPreferences sharedPreferences,
                         VendorRepository vendorRepository,
                         ConfigurationRepository configurationRepository,
                         io.didomi.sdk.user.UserRepository userRepository,
                         TCFRepository tcfRepository,
                         io.didomi.sdk.resources.LanguagesHelper languagesHelper)

Method Detail

getRequiredEssentialPurposesIds

public java.util.Set<java.lang.String> getRequiredEssentialPurposesIds()

resetConsentToken

public void resetConsentToken()

Create a new consent token and store it

loadConsentToken

public ConsentToken loadConsentToken(int tcfVersion,
                                     java.util.Date ignoreConsentBefore,
                                     long consentDurationInSeconds,
                                     long deniedConsentDurationInSeconds)
                              throws java.lang.Exception

Load the consent token from the shared preferences

Parameters:

tcfVersion - Version of the TCF to load

ignoreConsentBefore - If token was updated before this date, it will not be loaded

consentDurationInSeconds - If token update date is older than this duration, it will not be loaded

Returns:

the stored consent token, or null if it must be reset

Throws:

java.lang.Exception

saveConsentToken

public void saveConsentToken()

Save the consent token to the local storage

setLastSyncDate

public void setLastSyncDate(java.util.Date lastSyncDate)

Set the last sync date

Parameters:

lastSyncDate -

isEssentialPurpose

public boolean isEssentialPurpose(java.lang.String purposeID)

Method used to detect if a purpose ID corresponds to an essential purpose.

Parameters:

purposeID: - purpose ID.

Returns:

**true** if purpose ID belongs to an essential purpose, **false** otherwise.

setUserConsentStatus

public boolean setUserConsentStatus(java.util.Set<Purpose> enabledPurposes,
                                    java.util.Set<Purpose> disabledPurposes,
                                    java.util.Set<Purpose> enabledLegitimatePurposes,
                                    java.util.Set<Purpose> disabledLegitimatePurposes,
                                    java.util.Set<Vendor> enabledVendors,
                                    java.util.Set<Vendor> disabledVendors,
                                    java.util.Set<Vendor> enabledLegIntVendors,
                                    java.util.Set<Vendor> disabledLegIntVendors)

Update the user consent status

removeEssentialPurposes

public java.util.Set<Purpose> removeEssentialPurposes(java.util.Set<Purpose> purposeSet)

Method used to remove essential purposes from an set of purposes.

Parameters:

purposeSet - set of purposes.

Returns:

a array of purposes where essential purposes have been removed.

hasAllConsentStatus

public boolean hasAllConsentStatus(java.util.Set<Purpose> purposes,
                                   java.util.Set<Vendor> vendors)

Check if all consent information is available (ie not consent status != unknown) for a set of purpose and vendor IDs

Parameters:

purposes -

vendors -

Returns:

hasAllLegitimateInterestStatus

public boolean hasAllLegitimateInterestStatus(java.util.Set<Purpose> purposes,
                                              java.util.Set<Vendor> vendors)

Check if all consent information is available (ie not consent status != unknown) for a set of purpose and vendor IDs

Parameters:

purposes -

vendors -

Returns:

hasAnyConsentStatus

public boolean hasAnyConsentStatus()

Check if we have collected any consent status from the user

Returns:

true of it has at least one consent, positive of negative

getConsentToken

public ConsentToken getConsentToken()

numberOfDaysHasExceeded

public boolean numberOfDaysHasExceeded()

Determine if the number of days given by the client on the configuration before we could display the banner again if we need new consents has been exceeded:

Returns:

True if it has been exceeded, false if not.

getEnabledPurposes

public java.util.Set<Purpose> getEnabledPurposes()

Method used to get a set of enabled purposes. The purposes that we consider as **enabled** from this point on, are those that have been enabled by the user (that are stored in the form of the consent token) and those that are essential purposes.

getEnabledPurposeIds

public java.util.Set<java.lang.String> getEnabledPurposeIds()

Method used to get a set of enabled purpose IDs. The purposes that we consider as **enabled** from this point on, are those that have been enabled by the user (that are stored in the form of the consent token) and those that are essential purposes.

getConsentString

public java.lang.String getConsentString()

getTCFVersion

public java.lang.Integer getTCFVersion()

getGoogleAdditionalConsent

public java.lang.String getGoogleAdditionalConsent()