Info
Innehåll

[Android] 2. API-dokumentation

Konstruktör


Konstruktör för att skapa ett CmpManager-objekt

parametrar
Företag Typ

Beskrivning

sammanhang Sammanhang

Appens sammanhang bör vara FragmentActivity när du använder anpassad layout

config CmpConfig

Konfigurationsobjektet för consent manager

openListener OnOpenCallback

Återuppringningen som ska anropas när samtyckeslagret öppnas

closeListener Vid StängÅteruppringning

Återuppringningen som ska anropas när samtyckeslagret stängs

cmpNotOpenedCallback OnCPMNotOpenedCallback

Återuppringningen som ska anropas när samtyckeslagret inte kunde öppnas

vid Felåteruppringning Vid feluppringning

Återuppringningen som ska anropas vid ett fel

onButtonClickedCallback
OnButtonClickedCallback

Återuppringningen som ska anropas för att få information om vilken knapp som trycktes för att stänga samtyckesskiktet

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

 

initialisera


initialisera

parametrar
Företag Typ Beskrivning
sammanhang Sammanhang  
appgränssnitt CmpLayerAppEventListenerInterface? = null  
Retur

 

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

 

setCallbacks


Ställ in återuppringningar

parametrar
Företag Typ Beskrivning
openListener OnOpenCallback

Återuppringningen som ska anropas när samtyckeslagret öppnas

closeListener Vid StängÅteruppringning

Återuppringningen som ska anropas när samtyckeslagret stängs

cmpNotOpenedCallback OnCPMNotOpenedCallback

Återuppringningen som ska anropas när samtyckeslagret inte kunde öppnas

vid Felåteruppringning Vid feluppringning

Återuppringningen som ska anropas vid ett fel

onButtonClickedCallback
OnButtonClickedCallback

Återuppringningen som ska anropas för att få information om vilken knapp som trycktes för att stänga samtyckesskiktet

Retur

Inget returvärde

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

setGoogleAnalyticsCallback


Ställ in återuppringning för att hämta Google Consentmode-värden

parametrar
Företag Typ Beskrivning
analyticsListener CmpGoogleAnalyticsInterface  
Retur

Inget returvärde

Exempelvis
 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


Kontrollera och öppna samtyckesskiktet

parametrar
Företag Typ Beskrivning
sammanhang Sammanhang Applikationskontext
appgränssnitt CmpLayerAppEventListenerInterface? = null  
Retur

Inget returvärde

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

 

openCustomLayer


öppnar det anpassade samtyckeslagret

parametrar
Företag Typ Beskrivning
aktivitet FragmentActivity exempel
containerViewId Int  
Retur

Inget returvärde

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

 

ta


Kolla upp

parametrar
Företag Typ Beskrivning
onCheckIsConsentRequiredCallback OnCheckIsConsentRequired roligt ärConsentRequired(erConsentRequired: Boolean)
är cachad Boolean = falskt  
Retur

Inget returvärde

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

 

openCustomLayer


öppnar det anpassade samtyckeslagret

parametrar
Företag 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(context)

 

skapa CustomLayerFragment


Skapa anpassat lagerfragment

parametrar
Företag Typ Beskrivning
aktivitet FragmentActivity Aktivitetskontext
Retur

CmpConsentLayerFragment

Exempelvis
createCustomLayerFragment(activity = ...)

 

har samtycke


kontrollera om användaren har gett sitt samtycke

Retur
Exempelvis
hasConsent()

 

aktiveraVendorList


Aktivera leverantörslista

parametrar
Företag Typ Beskrivning
försäljare Lista  
onConsentReceivedCallback OnConsentReceivedCallback? = null  
Retur

Inget returvärde

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

 

inaktiveraVendorList


Inaktivera leverantörslista

parametrar
Företag Typ Beskrivning
försäljare Lista Lista över leverantörs-ID som ska aktiveras.
onConsentReceivedCallback OnConsentReceivedCallback? = null  
Retur

Inget returvärde

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

 

enablePurposeList


Aktivera syfteslista

parametrar
Företag Typ Beskrivning
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(purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)

 

disablePurposeList


Inaktivera en lista med syften

parametrar
Företag Typ Beskrivning
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(purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)

 

avvisaAlla


Avvisa allt 

Retur

Inget returvärde

Exempelvis
rejectAll()

 

acceptera alla


Acceptera alla

Retur

Inget returvärde

Exempelvis
acceptAll()

 

getUSPrivacyString


Få oss sekretesssträng

Retur

USA:s sekretesssträng

Exempelvis
getUSPrivacyString()

 

har säljarens samtycke


Har säljarens samtycke

parametrar
Företag Typ Beskrivning
id Sträng Leverantörs-ID
Retur
Exempelvis
hasVendorConsent(id = ...)

 

hasPurposeConsent


Har syftesmedgivande

parametrar
Företag Typ Beskrivning
id Sträng syfte id
Retur

 

Exempelvis
hasPurposeConsent(id = ...)

 

getGoogleACString


Skaffa Google AC-sträng

Retur

Google AC-sträng

Exempelvis
getGoogleACString()

 

getConsentstring


Få den senaste samtyckessträngen

Retur
Exempelvis
getConsentstring()

 

exportCmpString


Exportera samtyckessträng

Retur

sparad Cmp String

Exempelvis
exportCmpString()

 

importCmpString


Kolla upp

parametrar
Företag Typ Beskrivning
cmpString Sträng cmpString att importera
importCallback CmpImportCallback kul påImportResult(framgång: Boolean, meddelande: String)
Retur

Inget returvärde

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

 

getCalledLast


Bli uppringd sist

Retur

senast kallad Cmp Layer Date

Exempelvis
getCalledLast()

 

kallas ThisDay


Ringde denna dag

Retur

om lager kallades idag

Exempelvis
calledThisDay()

 

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

 

behöver Acceptans


Behöver acceptans

Retur

om användaren behöver godkännande

Exempelvis
needsAcceptance()
Tillbaka till toppen