consentmanager Android SDK-API
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 |
openCustomLayer
Opent de aangepaste toestemmingslaag
parameters
| Naam | Type |
Omschrijving |
| activiteit | FragmentActiviteit |
De activiteitsinstantie waar de toestemmingslaag moet worden weergegeven |
| containerViewId | @IdRes Int |
De ID van de container-UI waarin de toestemmingslaag moet worden weergegeven |
Retourneren
Een functie zonder retourwaarde
Voorbeeld
val activity = requireActivity()
val containerViewId = R.id.container
openCustomLayer(activity, containerViewId)
checkAndOpenConsentLayer
Controleer en opent uiteindelijk de toestemmingslaag.
parameters
| Naam | Type |
Omschrijving |
| verband | Context |
Het contextobject van de app. |
Voorbeeld
val cmpManager = CmpManager()
cmpManager.checkAndOpenConsentLayer(context)
openCmpLayer
Retourneert als het doel (id) de rechten heeft om cookies in te stellen
parameters
| Naam | Type |
Omschrijving |
| verband | Context |
De context van de app |
| id | Draad |
De id van het doel Let op: Het doel-ID is hetzelfde als getoond in de doellijst en kan een voorvoegsel hebben zoals C |
| checkToestemming | Boolean |
|
Retourneren
| Type | Omschrijving |
| Boolean | Een booleaanse waarde die aangeeft of de leverancier toestemming heeft om cookies in te stellen. |
Voorbeeld
val vendorID = "1234"
val checkConsent = true
val result = hasVendorConsent(context, vendorID, checkConsent)
if (result) {
// Vendor has the rights to set cookies
} else {
// Vendor does not have the rights to set cookies
}
heeftVendorConsent
Retourneert als de verkoper (id) de rechten heeft om cookies in te stellen
parameters
| Naam | Type |
Omschrijving |
| id | Draad: |
De id van de verkoper Let op: de leverancier-ID is hetzelfde als in de lijst met doelen en kan een voorvoegsel hebben zoals C |
Retourneren
| Type | Omschrijving |
| Boolean | Als het doel toestemming heeft om cookies in te stellen |
Voorbeeld
val vendorId = "S123"
consentTool.hasVendor(vendorId)
heeft een doel
Retourneert als het doel (id) de rechten heeft om cookies in te stellen
parameters
| Naam | Type |
Omschrijving |
| id | Draad: |
De id van het doel Let op: Het doel-ID is hetzelfde als getoond in de doellijst en kan een voorvoegsel hebben zoals C |
Retourneren
| Type | Omschrijving |
| Boolean | Als het doel toestemming heeft om cookies in te stellen |
Voorbeeld
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
getVendorString
Retourneert als het doel (id) de rechten heeft om cookies in te stellen
parameters
| Naam | Type |
Omschrijving |
| id | Draad: |
De id van het doel Let op: Het doel-ID is hetzelfde als getoond in de doellijst en kan een voorvoegsel hebben zoals C |
Retourneren
| Type | Omschrijving |
| Boolean | Als het doel toestemming heeft om cookies in te stellen |
Voorbeeld
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
getPurposeString
Retourneert de doelen String, die is ingesteld door consentmanager
parameters
geen parameters
Retourneren
| Type | Omschrijving |
| Draad |
De reeks van doelen die is ingesteld door consentmanager
|
Voorbeeld
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
doelen halen
Retourneert de doelen String, die is ingesteld door consentmanager in een lijstobject
parameters
| Naam | Type |
Omschrijving |
| id | Draad: |
De id van het doel Let op: Het doel-ID is hetzelfde als getoond in de doellijst en kan een voorvoegsel hebben zoals C |
Retourneren
| Type | Omschrijving |
| Boolean | Als het doel toestemming heeft om cookies in te stellen |
Voorbeeld
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
Oud overzicht (tbd)
|
API |
parameters | Retourneren |
Omschrijving
|
|
openCmpConsentToolView( Contextcontext ) |
verband: De context van de app | komen te vervallen | Geeft een modale weergave weer met de webweergave voor toestemming. Als de Compliance wordt geaccepteerd of afgewezen, wordt een close-functie aangeroepen. U kunt deze sluitfunctie overschrijven met uw eigen functie. Implementeer daarom de OnCloseCallback en voeg deze toe als parameter. @apiNote Gebruikersinterface -> voorbeeld: Open Layer by button action |
|
openCmpConsentToolView( Contextcontext, Terugbellen bij OpSluiten ) |
verband: De context van de app
Bel terug: De OnCloseCallback die moet worden aangeroepen wanneer de webview wordt gesloten door actie
|
komen te vervallen | Geeft een modale weergave weer met de webweergave voor toestemming. Als de Compliance wordt geaccepteerd of afgewezen, wordt een close-functie aangeroepen. U kunt deze sluitfunctie overschrijven met uw eigen functie. Implementeer daarom de OnCloseCallback en geef deze aan deze functie. Deze methode stuurt niet opnieuw een verzoek naar de consentTool-server. Het zal de laatste staat gebruiken. Als u alleen de toestemming Tool View opnieuw wilt openen, als de server een responsstatus == 1 geeft, gebruik dan de checkAndProceedConsentUpdate-methode @apiNote Gebruikersinterface -> voorbeeld: Open Layer by button action |
|
setCloseCmpConsentToolViewListener( Terugbellen bij OpSluiten ) |
Bel terug: De OnCloseCallback die moet worden aangeroepen wanneer de webview wordt gesloten door actie | komen te vervallen | Stelt een luisteraar in. Als de Compliance wordt geaccepteerd of afgewezen, wordt deze functie aangeroepen. U kunt deze sluitfunctie overschrijven met uw eigen functie. Implementeer daarom de OnCloseCallback en voeg deze toe als parameter. |
|
setCustomCmpConsentToolViewAction( CustomOpenActionCallback customAction ) |
aangepasteActie: De customAction die moet worden aangeroepen, afgezien van het tonen van de consentTool | komen te vervallen | Stelt een aangepaste actie in op een serverreactie. |
|
setErrorDialogCmpConsentToolViewListener( OnErrorDialogTerugbellen terugbellen ) |
Bel terug: De OnOpenCallback, die moet worden aangeroepen, wanneer de weergave wordt geopend. | komen te vervallen | Stelt een luisteraar in. Als de Compliance View wordt geopend, wordt deze functie aangeroepen. U kunt deze open functie overschrijven met uw eigen. Implementeer daarom de OnOpenCallback en voeg deze toe als parameter. |
|
setNetworkErrorExceptionListener( OnNetworkException Terugbellen terugbellen ) |
Bel terug: De OnErrorNetworkCallback die moet worden aangeroepen. | komen te vervallen | Stelt een listener in die wordt aangeroepen als er een netwerkfout optreedt. |
|
setOnCMPNotOpenedCallback( AanCMPNotOpenedTerugbellen terugbellen ) |
Bel terug: De cmpNotOpenedCallback-actie die wordt aangeroepen | komen te vervallen | Stelt een actie in wanneer de Consentlayer niet gaat openen |
|
setOpenCmpConsentToolViewListener( Contextcontext, Knop gdprKnop ) |
verband: Dan Context van de App gdprKnop: De knop, de openCmpConsentToolViewListener moet worden toegevoegd aan |
komen te vervallen | Stelt een luisteraar in op de gegeven knop. Als op de knop wordt geklikt, wordt een modale weergave weergegeven met de toestemmingswebweergave. Als de Compliance wordt geaccepteerd of afgewezen, wordt een close-functie aangeroepen. U kunt deze sluitfunctie overschrijven met uw eigen functie. Implementeer daarom de OnCloseCallback en voeg deze toe als een andere parameter. Als de parameter niet is ingesteld, maar de setCloseCmpConsentToolViewListener is gebruikt om een listener toe te voegen aan de close-gebeurtenis, wordt deze gebruikt. |
|
setOpenCmpConsentToolViewListener( Contextcontext, Knop gdprKnop, Terugbellen bij OpSluiten ) |
verband: De context van de app gdprKnop: De knop, de openCmpConsentToolViewListener moet worden toegevoegd aan
Bel terug: De OnCloseCallback die moet worden aangeroepen wanneer de webview wordt gesloten door actie |
komen te vervallen | Stelt een luisteraar in op de gegeven knop. Als op de knop wordt geklikt, wordt een modale weergave weergegeven met de toestemmingswebweergave. Als de Compliance wordt geaccepteerd of afgewezen, wordt een close-functie aangeroepen. U kunt deze sluitfunctie overschrijven met uw eigen functie. Implementeer daarom de OnCloseCallback en voeg deze toe als laatste parameter. |
|
setOpenCmpConsentToolViewListener( Terugbellen bij OpSluiten ) |
Bel terug: De OnCloseCallback die moet worden aangeroepen wanneer de webview wordt gesloten door actie |
komen te vervallen | Stelt een luisteraar in. Als de Compliance View wordt geopend, wordt deze functie aangeroepen. U kunt deze open functie overschrijven met uw eigen. Implementeer daarom de OnOpenCallback en voeg deze toe als parameter. |
|
setOpenPlaceHolderViewListener( Contextcontext, Knop knop, Stringverkoper ) |
verband: De context van de app : Een actieknop om de tijdelijke weergave te maken verkoper: De leverancier die is toegewezen aan de tijdelijke aanduiding |
komen te vervallen | Opent de weergave van de tijdelijke aanduiding bij klikken op de knop voor de toegewezen leverancier |
|
|
|||
|
genaamdThisDay( contextcontext) |
verband: De context van de app |
boolean: als de server deze dag al is gecontacteerd | Retourneert als de server deze dag al is gecontacteerd. |
|
clearAllValues(Contextcontext) |
verband: De context van de app |
komen te vervallen | Reset toestemmingsgegevens |
|
creëerPlaceholder( Contextcontext, CMPPlaceholderParams cmpPlaceholderParams, CmpPlaceholderEventListener cmpPlaceholderEventListener) |
verband: De app-context cmpPlaceholderParams: wijs vereiste tijdelijke aanduiding-parameters toe cmpPlaceholderEventListener: EventListener-interface voor aangepaste procesfuncties |
CmpPlaceholder: UIWeergave van de tijdelijke aanduiding | Creëert een tijdelijke aanduiding voor het blokkeren van dynamische inhoud |
|
exportCMPData(Contextcontext) |
verband: De app-context |
Draad: De toestemmingsstring | Een exportfunctie die kan worden aangeroepen om de volledige consentString te exporteren die is gegenereerd door een ConsentWebView en opgeslagen in de gedeelde voorkeuren van dit apparaat. |
|
getCalledLast(Contextcontext) |
verband: De app-context |
Datum: Datum waarop de server voor het laatst is aangeroepen | Geeft informatie over de laatste datum waarop contact is opgenomen met de server |
|
getConfig() |
|
CMPConfig: CMPConfig-object |
Retourneert de CMPConfig die momenteel is ingesteld |
|
getGoogleACString() |
verband: De app-context |
Draad: US Privacy String van leveranciers die is ingesteld door consentmanager |
Retourneert de Amerikaanse privacystring, die is ingesteld door consentmanager |
|
getInstance() |
|
CMPConsentTool: Het geïnitialiseerde singleton-moment van de consentmanager |
Retourneert de CMPConsentTool. Als u de CMPConsentTool eerder, zal de CMPConsentToolInitialisatie-uitzondering worden gegenereerd. |
|
getInstanceUnsafe() |
|
CMPConsentTool: het geïnitialiseerde singleton Instant van de consent Manager, of nul. |
Retourneert de CMPConsentTool, of null als deze niet is geïnitialiseerd. Deze methode is onveilig, omdat het kan leiden tot null-pointeruitzonderingen, maar als u zeker weet dat de ConsentTool eerder is geïnitialiseerd, kunt u deze methode gebruiken zonder dat u de fout hoeft op te vangen. We raden aan om het geretourneerde object van de createInstant-methode op te slaan, om de methoden van de consentManager. |
|
getLastConsentString( contextcontext) |
verband: De app-context |
Draad: De laatst ingestelde toestemmingsstring |
Retourneert de laatst gegeven toestemming, gepresenteerd in base64 door consentManager |
|
getPurposes(contextcontext) |
verband: De app-context |
Draad: De reeks doeleinden die is ingesteld door consentmanager |
Retourneert de doelen String, die is ingesteld door consentmanager |
|
getUSPrivacyString(Contextcontext) |
verband: De app-context |
Draad: De Amerikaanse privacyreeks van leveranciers die is doorgevoerd consentmanager |
Retourneert de Amerikaanse privacystring, die is ingesteld door consentmanager |
|
getVendorsString (contextcontext) |
verband: De app-context |
Draad: De reeks leveranciers die werd doorgevoerd consentmanager |
Retourneert de Vendor String, die is ingesteld door consentmanager |
|
hasPurposeConsent(Contextcontext, String-ID, boolean isIABPurpose) |
verband: de app-context id: De id van het doel isIABDoel: Als het doel is ingesteld door de IAB-standaard (V1/V2) |
boolean: Als het doel toestemming heeft om cookies in te stellen |
Retourneert, als het doel (id) de rechten heeft om cookies in te stellen. Aandacht: Het doel-ID is hetzelfde als getoond in de doellijst en kan een voorvoegsel hebben zoals C |
|
heeftVendorConsent( Contextcontext, String-ID, boolean isIABVendor) |
verband: De app-context id: De id van de leverancier isIABVerkoper: als de leverancier is ingesteld door de IAB-standaard (V1/V2) |
boolean: Als de Verkoper toestemming heeft om cookies in te stellen. |
Retouren, als de Verkoper (id) de rechten heeft om cookies in te stellen
Aandacht: Het leveranciers-ID is hetzelfde als getoond in de leverancierslijst en kan een voorvoegsel hebben zoals C, S |
|
importCMPData( Contextcontext, Tekenreeks cmpData ) |
verband: De app-context cmpData: De tekenreeks die wordt ingesteld. De consentString moet worden doorgegeven als gecodeerde base64 |
boolean: Als het importeren is gelukt, of als er fouten optreden in de String |
Een importmethode die kan worden aangeroepen om de volledige consentString die door een ConsentWebView is gegenereerd, te importeren in de gedeelde voorkeuren van dit apparaat. |
|
behoeftenAcceptatie(Contextcontext) |
verband: De app-context |
boolean: als de gebruiker toestemming moet geven |
Retourneert als de gebruiker toestemming moet geven, omdat hij dit in het verleden niet heeft gedaan, of omdat de toestemmingsserver heeft geretourneerd, dat een nieuwe toestemming is vereist |
|
heeft serverupdate nodig (contextcontext) |
verband: De app-context |
boolean: Als de consentmanager moet worden bijgewerkt |
Als de CMPSettings moeten worden bijgewerkt vanaf de server, omdat ze er op deze dag niet waren. |
|
|
|
|
|
