Info
Content

[Android] 2. API-documentatie

API


 

Constructeur


Constructor voor het maken van een CmpManager-object

parameters
Naam Type

Omschrijving

verband Context

De context van de app

config CMPConfig

Het configuratieobject voor de consent manager

closeListener BijSluitenTerugbellen

De callback die moet worden aangeroepen wanneer de toestemmingslaag wordt gesloten

openListener AanOpenTerugbellen

De callback die moet worden aangeroepen wanneer de toestemmingslaag wordt geopend

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

 

 

initialiseren


initialiseren

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

 

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

 

terugbellen instellen


Terugbellen instellen

parameters
Naam Type Omschrijving
openListener OpOpenTerugbellen?  
closeListener AanSluitenTerugbellen?  
cmpNotOpenedTerugbellen OnCMPNotOpenedCallback?  
onErrorTerugbellen OnErrorTerugbellen?  
onCmpButtonClickedCallback OnCmpButtonClickedCallback?  
Retourneren

Geen retourwaarde

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

 

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
verband Context  
opCmpLayerOpenCallback OnCmpLayerOpenCallback  
is in cache Booleaans = onwaar  
Retourneren

Geen retourwaarde

Voorbeeld
check(context = ...,onCmpLayerOpenCallback = ...,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()

 

createCustomLayerFragment


Maak een aangepast laagfragment

Retourneren

CmpLayerFragment

Voorbeeld
createCustomLayerFragment()

 

heeftToestemming


controleer of de gebruiker toestemming heeft gegeven

Retourneren
Voorbeeld
hasConsent()

 

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()

 

getAllVendors


Krijg alle leveranciers

Retourneren

 

Voorbeeld
getAllVendors()

 

getAllVendorsList


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()

 

leverancierslijst inschakelen


Leverancierslijst inschakelen

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

Geen retourwaarde

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

 

leverancierslijst uitschakelen


Leverancierslijst uitschakelen

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

Geen retourwaarde

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

 

enablePurposeList


Lijst met doelen inschakelen

parameters
Naam Type Omschrijving
verband Context Toepassingscontext
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(context = ...,purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)

 

uitschakelenPurposeList


Schakel een lijst met doeleinden uit

parameters
Naam Type Omschrijving
verband Context Toepassingscontext
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(context = ...,purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)

 

weigerAlles


Rejects

parameters
Naam Type Omschrijving
verband Context Toepassingscontext
Retourneren

Geen retourwaarde

Voorbeeld
rejectAll(context = ...)

 

accepteer alles


Accepteer alles

parameters
Naam Type Omschrijving
verband Context Toepassingscontext
Retourneren

Geen retourwaarde

Voorbeeld
acceptAll(context = ...)

 

getUSPrivacyString


Geef ons een privacystring

Retourneren

Amerikaanse privacystring

Voorbeeld
getUSPrivacyString()

 

heeftVendorConsent


Heeft toestemming van de verkoper

parameters
Naam Type Omschrijving
verband Context Toepassingscontext
id Draad verkopers ID
Retourneren
Voorbeeld
hasVendorConsent(context = ...,id = ...)

 

heeftPurposeConsent


Heeft doeltoestemming

parameters
Naam Type Omschrijving
verband Context Toepassingscontext
id Draad doel-id
isIABDoel Boolean (verouderd) als het doel een IAB-doel is
checkToestemming Booleaans = waar  
Retourneren

 

Voorbeeld
hasPurposeConsent(context = ...,id = ...,isIABPurpose = ...,checkConsent = ...)

 

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()

 

getCalledLast


Wordt als laatste gebeld

Retourneren

laatst aangeroepen Cmp Layer Date

Voorbeeld
getCalledLast()

 

genaamdThisDay


Vandaag gebeld

Retourneren

als laag vandaag werd gebeld

Voorbeeld
calledThisDay()

 

heeft Acceptatie nodig


Heeft acceptatie nodig

Retourneren

als de gebruiker acceptatie nodig heeft

Voorbeeld
needsAcceptance()

 

setOpenCmpConsentToolViewListener


opent de toestemmingslaag

parameters
Naam Type Omschrijving
verband Context Toepassingscontext
gdprKnop Knop actie knop
Bel terug AanSluitenTerugbellen?  
Retourneren

Geen retourwaarde

Voorbeeld
setOpenCmpConsentToolViewListener(context = ...,gdprButton = ...,callback = ...)

 

setOpenPlaceHolderViewListener


Open luisteraar voor plaatshouderweergave instellen

parameters
Naam Type Omschrijving
verband Context Toepassingscontext
actieknop Knop  
Retourneren

Geen retourwaarde

Voorbeeld
setOpenPlaceHolderViewListener(context = ...,actionButton = ...)

 

Terug naar boven