Info
Innehåll

[Android] 2. API-dokumentation

acceptera alla

parametrar
Namn Typ Beskrivning
onConsentReceivedCallback OnConsentReceivedCallback? Återuppringning för hantering av samtycke mottaget händelse.
Retur

Inget returvärde

Exempelvis
func acceptAll(onFinish: @escaping () -> Void) {
  cmpManager?.acceptAll(onFinish: onFinish)
}


ta

parametrar
Namn Typ Beskrivning
onCheckIsConsentRequiredCallback OnCheckIsConsentRequired roligt ärConsentRequired(erConsentRequired: Boolean) återuppringning för att avgöra om ett samtycke krävs eller inte
isCached Boolean = falskt om sant är resultatet cachelagrat i en dag
Retur

Inga.

Exempelvis
cmpManager.acceptAll {
  coroutineScope.launch {
    snackbarHostState.showSnackbar(
      message = "All consents accepted",
      duration = SnackbarDuration.Short
    )
    consentStatus.value = showConsentStatus(cmpManager)
  }
}


checkAndOpenConsentLayer

Kontrollerar om användarens samtycke krävs och, i så fall, öppnar användargränssnittet för samtyckeslagret.

parametrar
Namn Typ Beskrivning
context Sammanhang Applikationskontext
appInterface CmpLayerAppEventListenerInterface? = null  
Retur

Inget returvärde

Exempelvis
context.getActivity()?.let { activity ->
                cmpManager.checkAndOpenConsentLayer(activity)
            }


kallas ThisDay

Kontrollerar om samtyckeslagret begärdes idag.

parametrar
Inga.
Retur

TRUE om användarens samtycke begärdes redan idag.

FALSK annars.

fun consentRequestedTodayAction() {
    val calledToday = cmpManager?.calledThisDay()
    if (calledToday != null) {
        println("Consent requested today: $calledToday")
    } else {
        println("Failed to retrieve consent request status for today.")
    }
}

disablePurposeList

Inaktiverar en lista med syften och uppdaterar det givna samtycket.

parametrar
Namn Typ Beskrivning
purposes Lista Lista över ändamåls-id:n att inaktivera
updateVendor Boolean flagga om sant inaktiverar också motsvarande leverantörer
onConsentReceivedCallback OnConsentReceivedCallback?  
Retur

Inget returvärde

Exempelvis
fun onFinish() {
    println("Notification: New consent received")
}

val purposes = listOf("1", "2")

// Option with callback
cmpManager?.disablePurposeList(purposes, ::onFinish)

// Option without callback
cmpManager?.disablePurposeList(purposes)

inaktiveraVendorList

Inaktiverar en lista över leverantörer och uppdaterar det givna samtycket.

parametrar
Namn Typ Beskrivning
vendors Lista Lista över leverantörs-ID som ska aktiveras.
onConsentReceivedCallback OnConsentReceivedCallback?  Återuppringning för hantering av samtycke mottaget händelse. det kommer att anropas när samtycke tas emot och behandlas
Retur

Inget returvärde.

Exempelvis
fun onFinish() {
    println("Notification: New consent received")
}

val vendors = listOf("1", "2")

// Option with callback
cmpManager?.disableVendorList(vendors, ::onFinish)

// Option without callback
cmpManager?.disableVendorList(vendors)


aktiveraVendorList

Aktiverar en lista över syften och uppdaterar det givna samtycket.

parametrar
Namn Typ Beskrivning
vendors Lista Lista över ändamåls-ID att aktivera.
onConsentReceivedCallback funktion (valfritt) Återuppringning för hantering av samtycke mottaget händelse. Det kommer att anropas när samtycke tas emot och behandlas
Retur

Inget returvärde.

Exempelvis
fun onFinish() {
    println("Notification: New consent received")
}

val vendors = listOf("1", "2")

// Option with callback
cmpManager?.enableVendorList(vendors, ::onFinish)

// Option without callback
cmpManager?.enableVendorList(vendors)


enablePurposeList

Aktiverar en lista över leverantörer och uppdaterar det givna samtycket.

parametrar
Namn Typ Beskrivning
purposes Lista Lista över ändamåls-ID att aktivera.
updateVendor Boolean flagga om sant aktiverar även motsvarande leverantörer
onConsentReceivedCallback Funktion (valfritt)  
Retur

Inget returvärde.

Exempelvis
fun onFinish() {
    println("Notification: New consent received")
}

val purposes = listOf("1", "2")

// Option with callback
cmpManager?.enablePurposeList(purposes, ::onFinish)

// Option without callback
cmpManager?.enablePurposeList(purposes)


exportCmpString

Exporterar den aktuella CMP-strängen som representerar användarens samtyckespreferenser.  

parametrar
Inga.
Retur

Den CMP base64-kodade strängen.

Exempelvis

fun exportConsentStringAction() {
    val exportString = cmpManager?.exportCmpString()
    println(exportString ?: "No string to export.")
}

getAllPurposes

Returnerar ID:n för alla ändamål.

parametrar
Inga.
Retur

En kommaseparerad sträng som innehåller ID:n för alla ändamål.

Exempelvis
fun getAllPurposesAction() {
    val allPurposes = cmpManager?.getAllPurposes()
    if (allPurposes != null) {
        println("All purposes: $allPurposes")
        // Additional actions for getAllPurposes function can be added here
    } else {
        println("Failed to retrieve all purposes.")
    }
}


getAllPurposeList

Returnerar en lista över ID:n för alla ändamål för en given CMP.

Retur

Lista

Exempelvis
fun getAllPurposeListAction() {
  // Action for getAllPurposeList function
  val allPurposes = cmpManager?.getAllPurposesList()
  if (allPurposes != null) {
    println("All purposes list: ${allPurposes.joinToString(", ")}")
  } else {
    println("Failed to retrieve all purposes list.")
  }
}


getAllVendors

Returnerar alla leverantörers ID för en given CMP.

parametrar
Inga.
Retur

En kommaseparerad sträng som innehåller alla leverantörs-ID:n.

Exempelvis
fun getAllVendorsAction() {
  // Action for getAllVendors function
  val allVendors = cmpManager?.getAllVendors()
  if (allVendors != null) {
    println("Printing all Vendors: $allVendors")
  } else {
    println("Failed to retrieve all vendors.")
  }
}


getAllVendorsList

Returnerar en lista över alla leverantörers ID:n för en given CMP.

parametrar
Inga.
Retur

En lista som innehåller alla leverantörs-ID:n.

Exempelvis

fun getAllVendorsListAction() {
    val allVendors = cmpManager?.getAllVendorsList()
    if (allVendors != null) {
        println("All vendors list: ${allVendors.joinToString(", ")}")
    } else {
        println("Failed to retrieve all vendors list.")
    }
}


getConsentstring

Returnerar en sträng med det senaste samtycket.

parametrar
Inga.
Retur

En sträng med det senaste samtycket som har bekräftats av användaren.

Exempelvis
fun getAllVendorsListAction() {
    val allVendors = cmpManager?.getAllVendorsList()
    if (allVendors != null) {
        println("All vendors list: ${allVendors.joinToString(", ")}")
    } else {
        println("Failed to retrieve all vendors list.")
    }
}


getDisabledPurposes

Returnerar ID:n för alla inaktiverade ändamål för en given CMP.

parametrar
Inga.
Retur

En kommaseparerad sträng som innehåller ID:n för alla inaktiverade ändamål.

Exempelvis
fun getDisabledPurposesAction() {
    val disabledPurposes = cmpManager?.getDisabledPurposes()
    if (disabledPurposes != null) {
        println("Disabled purposes: $disabledPurposes")
    } else {
        println("Failed to retrieve disabled purposes.")
    }
}

getDisabledVendors

Returnerar alla inaktiverade leverantörers ID:n för en given CMP.

parametrar
Inga.
Retur

En kommaseparerad sträng som innehåller alla inaktiverade leverantörers ID:n.

Exempelvis
fun getDisabledVendorsAction() {
    val disabledVendors = cmpManager?.getDisabledVendors()
    if (disabledVendors != null) {
        println("Disabled vendors: $disabledVendors")
    } else {
        println("Failed to retrieve disabled vendors.")
    }
}

getEnabledPurposes

Returnerar alla aktiverade leverantörers ID:n för en given CMP.

parametrar
Inga.
Retur

En kommaseparerad sträng som innehåller alla aktiverade leverantörers ID:n.

Exempelvis
fun getEnabledPurposesAction() {
    val enabledPurposes = cmpManager?.getEnabledPurposes()
    if (enabledPurposes != null) {
        println("Disabled purposes: $enabledPurposes")
    } else {
        println("Failed to retrieve enabled purposes.")
    }
}

getEnabledPurposeList

Returnerar en lista över alla aktiverade ändamåls ID:n för en given CMP.

parametrar
Inga.
Retur

En lista som innehåller ID:n för alla aktiverade ändamål.

Exempelvis
fun getEnabledPurposesAction() {
    val enabledPurposes = cmpManager?.getEnabledPurposes()
    if (enabledPurposes != null) {
        println("Enabled purposes: ${enabledPurposes.joinToString(", ")}")
    } else {
        println("Failed to retrieve enabled purposes list.")
    }
}

getEnabledVendors

Returnerar alla aktiverade leverantörers ID:n för en given CMP.

parametrar
Inga.
Retur

En kommaseparerad sträng som innehåller alla aktiverade leverantörers ID:n.

Exempelvis
fun getEnabledVendorsAction() {
    val enabledVendors = cmpManager?.getEnabledVendors()
    if (enabledVendors != null) {
        println("Enabled vendors: $enabledVendors")
    } else {
        println("Failed to retrieve enabled vendors.")
    }
}

getEnabledVendorList

Returnerar en lista med alla aktiverade leverantörers ID:n för en given CMP.

parametrar
Inga.
Retur

En lista som innehåller alla aktiverade leverantörers ID:n.

Exempelvis
fun getEnabledVendorsAction() {
    val enabledVendors = cmpManager?.getEnabledVendors()
    if (enabledVendors != null) {
        println("Enabled vendors: ${enabledVendors.joinToString(", ")}")
    } else {
        println("Failed to retrieve enabled vendors.")
    }
}

getGoogleACString

Hämtar Googles extra samtyckes-ID (`addtlConsent`)-strängen som ställts in av consent manager.

För ytterligare information, kolla Teknisk specifikation för Google Ytterligare samtycke.  

parametrar
Inga.
Retur

En lista som innehåller alla aktiverade leverantörers ID:n.

Exempelvis
fun getGoogleConsentStringAction() {
    val googleACString = cmpManager?.getGoogleACString()
    if (googleACString != null) {
        println("Google Additional Consent String: $googleACString")
    } else {
        println("Failed to retrieve Google Additional Consent String.")
    }
}

getUSPrivacyString

Hämtar US Privacy String. Denna amerikanska integritetssträng är en cookie som lagrar information om avslöjande som gjorts och val som webbplatsbesökaren valt angående deras konsumenträttigheter.

parametrar
Inga.
Retur

En sträng med USA:s sekretessdata satt av consentmanager.

Exempelvis
fun getUSPrivacyStringAction() {
    val usPrivacyString = cmpManager?.getUSPrivacyString()
    if (usPrivacyString != null) {
        println("US Privacy string contents: $usPrivacyString")
    } else {
        println("Failed to retrieve US Privacy string.")
    }
}

har samtycke

Kontrollerar om användaren redan gett sitt samtycke. Samtyckeslagret kan ha möjlighet att bara stänga lagret. I så fall lämnade användaren inget samtycke.

parametrar
Inga.
Retur

En sträng med USA:s sekretessdata satt av consentmanager.

Exempelvis
fun getHasConsentAction() {
    val hasConsent = cmpManager?.hasConsent()
    if (hasConsent != null) {
        val consentStatus = if (hasConsent) "Yes" else "No"
        println("Consent provided by the user? $consentStatus")
    } else {
        println("Failed to retrieve user consent.")
    }
}

hasPurposeConsent

Kontrollerar om ändamåls-ID är aktiverat baserat på användarens samtycke.

parametrar
Namn Typ Beskrivning
purposeId Sträng syfte id
Retur

SANT om

  • användaren har gett sitt samtycke till det angivna syftet ELLER
  • av någon anledning relaterad till dålig eller ingen internetanslutning på enheten, kunde samtycket för ändamålet inte hämtas. Se withErrorListener för att hantera dessa villkor under applansering, särskilt för nya användare som ännu inte har gett något samtycke

FALSK annars.

Exempelvis
fun getHasPurposeConsentAction() {
    val purposeId = "purposeID" // Replace with actual purpose ID
    val hasPurposeConsent = cmpManager?.hasPurposeConsent(purposeId)
    if (hasPurposeConsent != null) {
        val consentStatus = if (hasPurposeConsent) "Yes" else "No"
        println("Purpose has consent provided by the user? $consentStatus")
    } else {
        println("Failed to retrieve user purpose consent.")
    }
}

har säljarens samtycke

Kontrollerar om leverantörs-ID är aktiverat baserat på användarens samtycke.

parametrar
Namn Typ Beskrivning
vendorId Sträng Leverantörs-ID
Retur
  • användaren har gett sitt samtycke till den angivna leverantören ELLER
  • av någon anledning relaterad till dålig eller ingen internetanslutning på enheten kunde leverantörens samtycke inte hämtas. Se withErrorListener för att hantera dessa villkor under applansering, särskilt för nya användare som ännu inte har gett något samtycke

FALSK annars.

Exempelvis
fun getHasVendorConsentAction() {
    val vendorId = "vendorID" // Replace with actual vendor ID
    val hasVendorConsent = cmpManager?.hasVendorConsent(vendorId)
    if (hasVendorConsent != null) {
        val consentStatus = if (hasVendorConsent) "Yes" else "No"
        println("Vendor has consent provided by the user? $consentStatus")
    } else {
        println("Failed to retrieve user vendor consent.")
    }
}

importCmpString

Importerar en CMP-sträng som representerar användarens samtyckespreferenser. Strängen måste vara base64-kodad

parametrar
Namn Typ Beskrivning
consentString  Sträng Base64-kodad sträng som representerar samtycket
kompletteringHandler funktion (valfritt) Hanterare för återuppringning av metoden.
Retur

Inga.

Exempelvis
val cmpString = "YourBase64EncodedConsentStringHere"

  typealias CmpImportCompletionHandler = (Error?) -> Unit

// Define the completion handler function
val completionHandler: CmpImportCompletionHandler = { error ->
    if (error != null) {
        println("Failed to import CMP string: ${error.message}")
    } else {
        println("CMP string imported successfully")
    }
}

cmpManager?.importCmpString(cmpString, completion = completionHandler)


initialisera

Initialiseringsfunktionen initierar samtyckesskiktet och kontrollerar automatiskt om användaren behöver ett samtycke eller inte. Denna funktion kommer så småningom att öppna samtyckeslagret och kommer att interagera med Apple Tracking Transparency API för att be användaren om samtycke

parametrar
Namn Typ Beskrivning
context Sammanhang Appkontext
cmpConfig CmpConfig CmpConfig-objektet skickas med information om appId, Domain, appName och språk (valfritt)
Retur

CMPManagerobjektet.

Exempelvis

private fun initializeCmpManager() {
    CmpConfig.apply {
    id = cmpId
    domain = CMP_DOMAIN
    appName = cmpAppName
    language = cmpLanguage
    domainWhitelist = cmpDomainWhitelist
    timeout = 2000
    isDebugMode = true
  }
  CmpLog.setLogLevel(Log.VERBOSE)

  cmpManager = CmpManager.createInstance(this, CmpConfig)
}

openConsentLayer

Öppnar CMP-samtyckesskiktets webbvy med kraft.

parametrar
Namn Typ Beskrivning
context Sammanhang Appkontext.
Retur

Inget returvärde.

Exempelvis
ActionButtonsRow("Open", "Check", "Open?") { action ->
  when (action) {
  "Open" -> context.getActivity()?.let {
    	cmpManager.openConsentLayer(it.applicationContext)
    }
  	.
  	.
    .
}


behöver Acceptans

parametrar
Inga.
Retur

SANT om användaren behöver ge ett samtycke.

FALSK annars.

Exempelvis
fun showConsentStatus(cmpManager: CmpManager?): String {
    return buildString {
        append("Cmp ID: ${CmpConfig.id}\n")
        append("Need Acceptance: ${cmpManager?.needsAcceptance()}\n")  // <=========
        append("ConsentString: ${cmpManager?.getConsentString()}\n")
        append("Has Consent: ${cmpManager?.hasConsent()}\n")
    }
}

avvisaAlla

parametrar
Namn Typ Beskrivning
onFinish fungera Frivillig. Återuppringning för hantering av samtycke mottaget händelse. det kommer att anropas när samtycke tas emot och behandlas.
Retur

Inget returvärde.

Exempelvis
// Define the onFinish function
fun onFinish() {
    println("Notification: New consent has been received with a Reject All response.")
}

cmpManager?.rejectAll(::onFinish)

setCallbacks

Konfigurerar tillgängliga återuppringningar.

parametrar
Namn 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.

onErrorCallback 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 ned för att stänga samtyckeslagret.

Retur

Inget returvärde

Exempelvis
val existingInstance = instance?.get()
    existingInstance.setCallbacks(
      openListener = openListener,
      closeListener = closeListener,
      cmpNotOpenedCallback = cmpNotOpenedCallback,
      onErrorCallback = errorCallback,
      onButtonClickedCallback = cmpButtonClickedCallback
    )

med GoogleAnalyticsCallback

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

parametrar
Namn Typ Beskrivning
analyticsListener CmpGoogleAnalyticsInterface Gränssnittsimplementeringen för att ta emot uppdateringar om Google Analytics samtyckesläge.
Retur

Den aktuella instansen av CmpManagerInterface för kedja.

Exempelvis
private fun initializeCmpManager() {
  cmpManager = CmpManager.createInstance(this, CmpConfig).apply {
    withOpenListener(this@ConsentActivity)
    withCloseListener(this@ConsentActivity)
    withNotOpenedCallback(this@ConsentActivity)
    withErrorCallback(this@ConsentActivity)
    withButtonClickedCallback(this@ConsentActivity)
    withOnClickLinkCallback(this@ConsentActivity)
    withGoogleAnalyticsCallback(this@ConsentActivity) // <=============
    initialize(this@ConsentActivity)
  }
}


 

 

Tillbaka till toppen