Info
Content

[Android] 2. API-documentatie

Constructeur


Constructor voor het maken van een CmpManager-object

parameters
Naam Type

Omschrijving

verband Context

De context van de app moet FragmentActivity zijn als u een aangepaste lay-out gebruikt

config CmpConfig

Het configuratieobject voor de consent manager

openListener AanOpenTerugbellen

De callback die moet worden aangeroepen wanneer de toestemmingslaag wordt geopend

sluitenLuister BijSluitenTerugbellen

De callback die moet worden aangeroepen wanneer de toestemmingslaag wordt gesloten

cmpNotOpenedTerugbellen AanCMPNietGeopendTerugbellen

De callback die moet worden aangeroepen wanneer de toestemmingslaag niet kan worden geopend

onErrorTerugbellen OnErrorTerugbellen

De callback die moet worden aangeroepen bij een fout

onButtonClickedCallback
OnButtonClickedCallback

De callback die moet worden aangeroepen om informatie te krijgen over welke knop is ingedrukt om de toestemmingslaag te sluiten

Voorbeeld
            CmpManager.createInstance(
                context = this,
                codeId = config.id,
                serverDomain = config.domain,
                appName = config.appName,
                lang = config.language,
                closeListener = this,
                openListener = this,
                errorCallback = this,
                cmpButtonClickedCallback = this,
                cmpNotOpenedCallback = this
            )

 

initialiseren


Het initialize functie is ontworpen om de CMP SDK in te stellen binnen uw applicatiecontext en indien nodig automatisch de toestemmingslaag te controleren en te openen. De initialize kan worden gekoppeld aan het maken van de instantie

parameters
Naam Type Omschrijving
verband Context  
appInterface CmpLayerAppEventListenerInterface? = nul  
Retourneren

 

Voorbeeld
initialize(context = ...,appInterface = ...)

 

terugbellen instellen


Terugbellen instellen

parameters
Naam Type Omschrijving
openListener AanOpenTerugbellen

De callback die moet worden aangeroepen wanneer de toestemmingslaag wordt geopend

sluitenLuister BijSluitenTerugbellen

De callback die moet worden aangeroepen wanneer de toestemmingslaag wordt gesloten

cmpNotOpenedTerugbellen AanCMPNietGeopendTerugbellen

De callback die moet worden aangeroepen wanneer de toestemmingslaag niet kan worden geopend

onErrorTerugbellen OnErrorTerugbellen

De callback die moet worden aangeroepen bij een fout

onButtonClickedCallback
OnButtonClickedCallback

De callback die moet worden aangeroepen om informatie te krijgen over welke knop is ingedrukt om de toestemmingslaag te sluiten

Retourneren

Geen retourwaarde

Voorbeeld
setCallbacks(openListener = ...,closeListener = ...,cmpNotOpenedCallback = ...,onErrorCallback = ...,onCmpButtonClickedCallback = ...)

setGoogleAnalyticsTerugbellen


Callback instellen voor het ophalen van Google Consentmode-waarden

parameters
Naam Type Omschrijving
analyticsListener CmpGoogleAnalyticsInterface  
Retourneren

Geen retourwaarde

Voorbeeld
 override fun updateGoogleConsent(consentMap: Map<ConsentType, ConsentStatus>) {
     val firebaseConsentMap = consentMap.entries.associate { entry ->
         val firebaseConsentType = when (entry.key) {
             ConsentType.ANALYTICS_STORAGE -> FirebaseAnalytics.ConsentType.ANALYTICS_STORAGE
             ConsentType.AD_STORAGE -> FirebaseAnalytics.ConsentType.AD_STORAGE
             ConsentType.AD_USER_DATA -> FirebaseAnalytics.ConsentType.AD_USER_DATA
             ConsentType.AD_PERSONALIZATION -> FirebaseAnalytics.ConsentType.AD_PERSONALIZATION
       }
         val firebaseConsentStatus = when (entry.value) {
             ConsentStatus.GRANTED -> FirebaseAnalytics.ConsentStatus.GRANTED
             ConsentStatus.DENIED -> FirebaseAnalytics.ConsentStatus.DENIED
       }
         firebaseConsentType to firebaseConsentStatus
   }
     FirebaseAnalytics.getInstance(applicationContext).setConsent(firebaseConsentMap)
 }



setGoogleAnalyticsCallback(consentModeUpdate = ...)

checkAndOpenConsentLayer


Controleer en open de toestemmingslaag

parameters
Naam Type Omschrijving
verband Context Toepassingscontext
appInterface CmpLayerAppEventListenerInterface? = nul  
Retourneren

Geen retourwaarde

Voorbeeld
checkAndOpenConsentLayer(context = ...,appInterface = ...)

 

openCustomLayer


opent de aangepaste toestemmingslaag

parameters
Naam Type Omschrijving
activiteit FragmentActiviteit instantie
containerViewId Int  
Retourneren

Geen retourwaarde

Voorbeeld
openCustomLayer(activity = ...,containerViewId = ...)

 

controle


Check

parameters
Naam Type Omschrijving
onCheckIsConsentRequiredCallback OnCheckIsToestemming vereist fun isConsentRequired(isConsentRequired: Boolean)
is in cache Booleaans = onwaar  
Retourneren

Geen retourwaarde

Voorbeeld
check(onCheckIsConsentRequiredCallback = ...,isCached = ...)

 

openCustomLayer


opent de aangepaste toestemmingslaag

parameters
Naam Type Omschrijving
verband Context Toepassingscontext
appInterface CmpLayerAppEventListenerInterface  
Retourneren

Geen retourwaarde

Voorbeeld
openCustomLayer(context = ...,appInterface = ...)

 

openConsentLayer


opent de toestemmingslaag

Retourneren

Geen retourwaarde

Voorbeeld
openConsentLayer(context)

 

createCustomLayerFragment


Maak een aangepast laagfragment

parameters
Naam Type Omschrijving
activiteit FragmentActiviteit Activiteitscontext
Retourneren

CmpConsentLayerFragment

Voorbeeld
createCustomLayerFragment(activity = ...)

 

heeftToestemming


controleer of de gebruiker toestemming heeft gegeven

Retourneren
Voorbeeld
hasConsent()

 

leverancierslijst inschakelen


Leverancierslijst inschakelen

parameters
Naam Type Omschrijving
vendors Lijst  
onConsentOntvangenCallback OnConsentOntvangenCallback? = nul  
Retourneren

Geen retourwaarde

Voorbeeld
enableVendorList(vendors = ...,onConsentReceivedCallback = ...)

 

leverancierslijst uitschakelen


Leverancierslijst uitschakelen

parameters
Naam Type Omschrijving
vendors Lijst Lijst met leveranciers-ID's die moeten worden ingeschakeld.
onConsentOntvangenCallback OnConsentOntvangenCallback? = nul  
Retourneren

Geen retourwaarde

Voorbeeld
disableVendorList(vendors = ...,onConsentReceivedCallback = ...)

 

SchakelPurposeList in


Lijst met doelen inschakelen

parameters
Naam Type Omschrijving
doeleinden Lijst Lijst met doel-ID's die moeten worden ingeschakeld.
updateVerkoper Booleaans = waar vlag indien waar, schakel ook overeenkomstige leveranciers in
onConsentOntvangenCallback OnConsentOntvangenCallback? = nul  
Retourneren

Geen retourwaarde

Voorbeeld
enablePurposeList(purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)

 

uitschakelenPurposeList


Schakel een lijst met doeleinden uit

parameters
Naam Type Omschrijving
doeleinden Lijst Lijst met doel-ID's die moeten worden uitgeschakeld
updateVerkoper Booleaans = waar vlag indien waar, schakel ook overeenkomstige leveranciers uit
onConsentOntvangenCallback OnConsentOntvangenCallback? = nul  
Retourneren

Geen retourwaarde

Voorbeeld
disablePurposeList(purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)

 

weigerAlles


Alles afwijzen 

Retourneren

Geen retourwaarde

Voorbeeld
rejectAll()

 

accepteer alles


Accepteer alles

Retourneren

Geen retourwaarde

Voorbeeld
acceptAll()

 

getUSPrivacyString


Geef ons een privacystring

Retourneren

Amerikaanse privacystring

Voorbeeld
getUSPrivacyString()

 

heeftVendorConsent


Heeft toestemming van de verkoper

parameters
Naam Type Omschrijving
id Draad verkopers ID
Retourneren
Voorbeeld
hasVendorConsent(id = ...)

 

heeftPurposeConsent


Heeft doeltoestemming

parameters
Naam Type Omschrijving
id Draad doel-id
Retourneren

 

Voorbeeld
hasPurposeConsent(id = ...)

 

getGoogleACString


Google AC-tekenreeks ophalen

Retourneren

Google AC-tekenreeks

Voorbeeld
getGoogleACString()

 

getConsentstring


Haal de laatste tekenreeks voor toestemming op

Retourneren
Voorbeeld
getConsentstring()

 

exportCmpString


Tekenreeks voor toestemming exporteren

Retourneren

opgeslagen Cmp-tekenreeks

Voorbeeld
exportCmpString()

 

importCmpString


Check

parameters
Naam Type Omschrijving
cmpString Draad cmpString om te importeren
importTerugbellen CmpImportCallback fun onImportResult(success: Boolean, message: String)
Retourneren

Geen retourwaarde

Voorbeeld
                    cmpManager?.importCmpString(
                        "..."
                    ) { _, message ->
                        coroutineScope.launch {
                            snackbarHostState.showSnackbar(
                                message = message,
                                actionLabel = "Action",
                                duration = SnackbarDuration.Short
                            )
                        }
                    }

 

getCalledLast


Wordt als laatste gebeld

Retourneren

laatst aangeroepen Cmp Layer Date

Voorbeeld
getCalledLast()

 

genaamdThisDay


Vandaag gebeld

Retourneren

als laag vandaag werd gebeld

Voorbeeld
calledThisDay()

 

GetAllPurposes


retourneert alle doeleinden als een tekenreeks

Retourneren

doel String

Voorbeeld
getAllPurposes()

 

getAllPurposeList


retourneert alle doelen als een lijst met tekenreeksen

Retourneren

doel Lijst

Voorbeeld
getAllPurposeList()

 

getEnabledPurposes


Krijg afgesproken doelen

Retourneren

 

Voorbeeld
getEnabledPurposes()

 

getEnabledPurposeList


Ontvang een lijst met overeengekomen doelen

Retourneren

 

Voorbeeld
getEnabledPurposeList()

 

getDisabledPurposes


Krijg uitgeschakelde doeleinden

Retourneren

 

Voorbeeld
getDisabledPurposes()

 

haalAlleVerkopers


Krijg alle leveranciers

Retourneren

 

Voorbeeld
getAllVendors()

 

getAllVendorsLijst


Krijg alle leverancierslijst

Retourneren

 

Voorbeeld
getAllVendorsList()

 

getEnabledVendors


Krijg overeengekomen leveranciers

Retourneren

 

Voorbeeld
getEnabledVendors()

 

getEnabledVendorList


Ontvang een overeengekomen leverancierslijst

Retourneren

 

Voorbeeld
getEnabledVendorList()

 

getDisabledVendors


Krijg uitgeschakelde leveranciers

Retourneren

 

Voorbeeld
getDisabledVendors()

 

heeft Acceptatie nodig


Heeft acceptatie nodig

Retourneren

als de gebruiker acceptatie nodig heeft

Voorbeeld
needsAcceptance()
Terug naar boven