io.didomi.sdk.TCF

Interface TCFRepository

All Known Implementing Classes:

TCFV1Repository

public interface TCFRepository

This interface defines methods which must be provided in classess which implement this interface (namely: TCFV1Repository and TCFV2Repository, depending on configuration provided).

Method Summary

Modifier and Type	Method and Description
void	clearCMPKeys(android.content.SharedPreferences sharedPreferences) Clear keys in SharedPreferences that do not belong to the current TCF version
java.lang.String	getUserConsentString(android.content.SharedPreferences sharedPreferences)
int	getVersion() TCF version implemented by the repository
void	saveConsentInformation(android.content.SharedPreferences sharedPreferences, int vendorListMaxVendorId, int vendorListVersion, ConsentToken consentToken, AppConfiguration appConfiguration, IABConfiguration vendorList, java.util.List<io.didomi.sdk.publisherrestrictions.PublisherRestriction> publisherRestrictions, java.lang.String languageCode) Method used to store consent information based on the io.didomi.sdk.TCF version that's associated to the TCFRepository that implements this interface.
void	setCMPPresent(android.content.SharedPreferences sharedPreferences) Create the required keys in SharedPreferences to indicate that a CMP is present in the app
void	setSubjectToGDPR(android.content.SharedPreferences sharedPreferences, boolean subjectToGDPR) Method used to set the flag associated to the io.didomi.sdk.TCF version being implemented and indicate that the user is subject to GDPR.

Method Detail

getVersion

int getVersion()

TCF version implemented by the repository

Returns:

clearCMPKeys

void clearCMPKeys(android.content.SharedPreferences sharedPreferences)

Clear keys in SharedPreferences that do not belong to the current TCF version

Parameters:

sharedPreferences -

saveConsentInformation

void saveConsentInformation(android.content.SharedPreferences sharedPreferences,
                            int vendorListMaxVendorId,
                            int vendorListVersion,
                            ConsentToken consentToken,
                            AppConfiguration appConfiguration,
                            IABConfiguration vendorList,
                            java.util.List<io.didomi.sdk.publisherrestrictions.PublisherRestriction> publisherRestrictions,
                            java.lang.String languageCode)

Method used to store consent information based on the io.didomi.sdk.TCF version that's associated to the TCFRepository that implements this interface.

Parameters:

sharedPreferences -

vendorListMaxVendorId -

vendorListVersion -

consentToken -

appConfiguration - instance of AppConfiguration

vendorList -

languageCode -

setCMPPresent

void setCMPPresent(android.content.SharedPreferences sharedPreferences)

Create the required keys in SharedPreferences to indicate that a CMP is present in the app

Parameters:

sharedPreferences -

setSubjectToGDPR

void setSubjectToGDPR(android.content.SharedPreferences sharedPreferences,
                      boolean subjectToGDPR)

Method used to set the flag associated to the io.didomi.sdk.TCF version being implemented and indicate that the user is subject to GDPR.

Parameters:

sharedPreferences -

subjectToGDPR -

getUserConsentString

java.lang.String getUserConsentString(android.content.SharedPreferences sharedPreferences)