[Android] 2. API-dokumentation
API
Konstruktör
Konstruktör för att skapa ett CmpManager-objekt
parametrar
| Namn | Typ |
Beskrivning |
| sammanhang | Sammanhang |
Appens sammanhang |
| config | CMPConfig |
Konfigurationsobjektet för consent manager |
| closeListener | Vid StängÅteruppringning |
Återuppringningen som ska anropas när samtyckeslagret stängs |
| openListener | OnOpenCallback |
Återuppringningen som ska anropas när samtyckeslagret öppnas |
| cmpNotOpenedCallback | OnCPMNotOpenedCallback |
Återuppringningen som ska anropas när samtyckeslagret inte kunde öppnas |
| vid Felåteruppringning | Vid feluppringning |
Återuppringningen som ska anropas vid ett fel |
initialisera
initialisera
parametrar
| Namn | Typ | Beskrivning |
| sammanhang | Sammanhang | |
| appgränssnitt | CmpLayerAppEventListenerInterface? = null |
Retur
Exempelvis
initialize(context = ...,appInterface = ...)
setCallbacks
Ställ in återuppringningar
parametrar
| Namn | Typ | Beskrivning |
| openListener | OnOpenCallback? | |
| closeListener | På StängÅteruppringning? | |
| cmpNotOpenedCallback | OnCPMNotOpenedCallback? | |
| vid Felåteruppringning | Vid feluppringning? | |
| onCmpButtonClickedCallback | OnCmpButtonClickedCallback? |
Retur
Inget returvärde
Exempelvis
setCallbacks(openListener = ...,closeListener = ...,cmpNotOpenedCallback = ...,onErrorCallback = ...,onCmpButtonClickedCallback = ...)
checkAndOpenConsentLayer
Kontrollera och öppna samtyckesskiktet
parametrar
| Namn | Typ | Beskrivning |
| sammanhang | Sammanhang | Applikationskontext |
| appgränssnitt | CmpLayerAppEventListenerInterface? = null |
Retur
Inget returvärde
Exempelvis
checkAndOpenConsentLayer(context = ...,appInterface = ...)
openCustomLayer
öppnar det anpassade samtyckeslagret
parametrar
| Namn | Typ | Beskrivning |
| aktivitet | FragmentActivity | exempel |
| containerViewId | Int |
Retur
Inget returvärde
Exempelvis
openCustomLayer(activity = ...,containerViewId = ...)
ta
Kolla upp
parametrar
| Namn | Typ | Beskrivning |
| sammanhang | Sammanhang | |
| onCmpLayerOpenCallback | OnCmpLayerOpenCallback | |
| är cachad | Boolean = falskt |
Retur
Inget returvärde
Exempelvis
check(context = ...,onCmpLayerOpenCallback = ...,isCached = ...)
openCustomLayer
öppnar det anpassade samtyckeslagret
parametrar
| Namn | Typ | Beskrivning |
| sammanhang | Sammanhang | Applikationskontext |
| appgränssnitt | CmpLayerAppEventListenerInterface |
Retur
Inget returvärde
Exempelvis
openCustomLayer(context = ...,appInterface = ...)
openConsentLayer
öppnar samtyckesskiktet
Retur
Inget returvärde
Exempelvis
openConsentLayer()
skapa CustomLayerFragment
Skapa anpassat lagerfragment
Retur
CmpLayerFragment
Exempelvis
createCustomLayerFragment()
har samtycke
kontrollera om användaren har gett sitt samtycke
Retur
appen har samtycke eller inte
Exempelvis
hasConsent()
getAllPurposes
returnerar alla ändamål som en sträng
Retur
syfte Sträng
Exempelvis
getAllPurposes()
getAllPurposeList
returnerar alla ändamål som en lista över strängar
Retur
syfteslista
Exempelvis
getAllPurposeList()
getEnabledPurposes
Få överenskomna syften
Retur
Exempelvis
getEnabledPurposes()
getEnabledPurposeList
Få överenskommen syfteslista
Retur
Exempelvis
getEnabledPurposeList()
getDisabledPurposes
Få funktionshindrade syften
Retur
Exempelvis
getDisabledPurposes()
getAllVendors
Få alla leverantörer
Retur
Exempelvis
getAllVendors()
getAllVendorsList
Hämta listan över alla leverantörer
Retur
Exempelvis
getAllVendorsList()
getEnabledVendors
Skaffa överenskomna leverantörer
Retur
Exempelvis
getEnabledVendors()
getEnabledVendorList
Få överenskommen leverantörslista
Retur
Exempelvis
getEnabledVendorList()
getDisabledVendors
Skaffa funktionshindrade leverantörer
Retur
Exempelvis
getDisabledVendors()
aktiveraVendorList
Aktivera leverantörslista
parametrar
| Namn | Typ | Beskrivning |
| sammanhang | Sammanhang | Applikationskontext |
| försäljare | Lista | |
| onConsentReceivedCallback | OnConsentReceivedCallback? = null |
Retur
Inget returvärde
Exempelvis
enableVendorList(context = ...,vendors = ...,onConsentReceivedCallback = ...)
inaktiveraVendorList
Inaktivera leverantörslista
parametrar
| Namn | Typ | Beskrivning |
| sammanhang | Sammanhang | Applikationskontext |
| försäljare | Lista | Lista över leverantörs-ID som ska aktiveras. |
| onConsentReceivedCallback | OnConsentReceivedCallback? = null |
Retur
Inget returvärde
Exempelvis
disableVendorList(context = ...,vendors = ...,onConsentReceivedCallback = ...)
enablePurposeList
Aktivera syfteslista
parametrar
| Namn | Typ | Beskrivning |
| sammanhang | Sammanhang | Applikationskontext |
| syfte | Lista | Lista över ändamåls-ID att aktivera. |
| uppdatera leverantör | Boolean = sant | flagga om sant aktiverar även motsvarande leverantörer |
| onConsentReceivedCallback | OnConsentReceivedCallback? = null |
Retur
Inget returvärde
Exempelvis
enablePurposeList(context = ...,purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)
disablePurposeList
Inaktivera en lista med syften
parametrar
| Namn | Typ | Beskrivning |
| sammanhang | Sammanhang | Applikationskontext |
| syfte | Lista | Lista över ändamåls-id:n att inaktivera |
| uppdatera leverantör | Boolean = sant | flagga om sant inaktiverar också motsvarande leverantörer |
| onConsentReceivedCallback | OnConsentReceivedCallback? = null |
Retur
Inget returvärde
Exempelvis
disablePurposeList(context = ...,purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)
avvisaAlla
Rejects
parametrar
| Namn | Typ | Beskrivning |
| sammanhang | Sammanhang | Applikationskontext |
Retur
Inget returvärde
Exempelvis
rejectAll(context = ...)
acceptera alla
Acceptera alla
parametrar
| Namn | Typ | Beskrivning |
| sammanhang | Sammanhang | Applikationskontext |
Retur
Inget returvärde
Exempelvis
acceptAll(context = ...)
getUSPrivacyString
Få oss sekretesssträng
Retur
USA:s sekretesssträng
Exempelvis
getUSPrivacyString()
har säljarens samtycke
Har säljarens samtycke
parametrar
| Namn | Typ | Beskrivning |
| sammanhang | Sammanhang | Applikationskontext |
| id | Sträng | Leverantörs-ID |
Retur
Boolean om samtycke har gett säljaren
Exempelvis
hasVendorConsent(context = ...,id = ...)
hasPurposeConsent
Har syftesmedgivande
parametrar
| Namn | Typ | Beskrivning |
| sammanhang | Sammanhang | Applikationskontext |
| id | Sträng | syfte id |
| ärIABPurpose | Boolean | (utfasad) om syftet är ett IAB-syfte |
| kontrollera Samtycke | Boolean = sant |
Retur
Exempelvis
hasPurposeConsent(context = ...,id = ...,isIABPurpose = ...,checkConsent = ...)
getGoogleACString
Skaffa Google AC-sträng
Retur
Google AC-sträng
Exempelvis
getGoogleACString()
getConsentstring
Få den senaste samtyckessträngen
Retur
sparad samtyckessträng
Exempelvis
getConsentstring()
exportCmpString
Exportera samtyckessträng
Retur
sparad Cmp String
Exempelvis
exportCmpString()
getCalledLast
Bli uppringd sist
Retur
senast kallad Cmp Layer Date
Exempelvis
getCalledLast()
kallas ThisDay
Ringde denna dag
Retur
om lager kallades idag
Exempelvis
calledThisDay()
behöver Acceptans
Behöver acceptans
Retur
om användaren behöver godkännande
Exempelvis
needsAcceptance()
setOpenCmpConsentToolViewListener
öppnar samtyckesskiktet
parametrar
| Namn | Typ | Beskrivning |
| sammanhang | Sammanhang | Applikationskontext |
| gdprButton | Knappen | åtgärdsknapp |
| ring tillbaka | På StängÅteruppringning? |
Retur
Inget returvärde
Exempelvis
setOpenCmpConsentToolViewListener(context = ...,gdprButton = ...,callback = ...)
setOpenPlaceHolderViewListener
Ställ in öppen platshållare view listener
parametrar
| Namn | Typ | Beskrivning |
| sammanhang | Sammanhang | Applikationskontext |
| åtgärdsknapp | Knappen |
Retur
Inget returvärde
Exempelvis
setOpenPlaceHolderViewListener(context = ...,actionButton = ...)
