[Android] 2. API-dokumentation

Utfasad SDK/uppgradera till v3: Den här dokumentationen beskriver version 2.x av vår SDK. 2.x SDK är utfasad och kommer att tas bort av EOY 2025. Uppgradera till SDK version 3.x. Se hjälpavsnittet om SDK v3 här.

acceptera alla

Accepterar samtyckesskiktet och beter sig på samma sätt när användaren accepterar samtycket. Denna metod förbrukar en sidvisning. 

parametrar

Retur

Inget returvärde.

Exempelvis

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

ta

Kontrollerar om samtycke krävs från användaren och returnerar eventuellt cachade resultat. Den här metoden förbrukar en sidvisning om parametern isCached() är TRUE och det cachade samtycket har löpt ut, en sidvisning om parametrarna för isCached() är FALSE och inga sidvisningar om det cachade samtycket inte har löpt ut. Det cachade samtycket upphör att gälla och rensas var 24:e timme. 

parametrar

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. Denna metod förbrukar en sidvisning. 

parametrar

Retur

Inget returvärde

Exempelvis

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

kallas ThisDay

Kontrollerar om samtyckeslagret begärdes idag. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

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

FALSK annars.

Exempelvis

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. Denna metod förbrukar en sidvisning. 

parametrar

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. Denna metod förbrukar en sidvisning. 

parametrar

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. Denna metod förbrukar en sidvisning. 

parametrar

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. Denna metod förbrukar en sidvisning. 

parametrar

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. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

CMP-samtyckessträngen.

Exempelvis

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

getAllPurposes

Returnerar ID:n för alla ändamål. Denna metod förbrukar inga sidvisningar. 

parametrar

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. Denna metod förbrukar inga sidvisningar. 

parametrar

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. Denna metod förbrukar inga sidvisningar. 

parametrar

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. Denna metod förbrukar inga sidvisningar. 

parametrar

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. Denna metod förbrukar inga sidvisningar. 

parametrar

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. Denna metod förbrukar inga sidvisningar. 

parametrar

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 för en given CMP. Denna metod förbrukar inga sidvisningar. 

parametrar

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. Denna metod förbrukar inga sidvisningar. 

parametrar

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. Denna metod förbrukar inga sidvisningar. 

parametrar

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. Denna metod förbrukar inga sidvisningar. 

parametrar

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. Denna metod förbrukar inga sidvisningar. 

parametrar

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.  

Denna metod förbrukar inga sidvisningar. 

parametrar

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. Denna metod förbrukar inga sidvisningar. 

parametrar

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. Denna metod förbrukar inga sidvisningar. 

parametrar

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.")
    }
}

hasPurpose (från version 2.5.1 och framåt)

hasPurposeConsent (utfasad)

Kontrollerar om ändamåls-ID är aktiverat baserat på användarens samtycke. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

SANT om användaren har gett sitt samtycke till det angivna syftet.

FALSK annars.

Observera att om, av någon anledning relaterad till dålig eller ingen internetanslutning på enheten eller i fall av frånvaro av ett samtycke, värdet som ställts in via defaultReturn parameter kommer att returneras.

Smakämnen defaultReturn parameter existerar inte i versioner äldre än 2.5.1.

Exempelvis

fun getHasPurposeConsentAction() {
    val purposeId = "purposeID" // Replace with actual purpose ID
    val hasPurposeConsent = cmpManager?.hasPurpose(purposeId, false)
    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.")
    }
}

hasVendor (från version 2.5.1 och framåt)

hasVendorConsent (utfasad)

Kontrollerar om leverantörs-ID är aktiverat baserat på användarens samtycke. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

TRUE om användaren har gett sitt samtycke till den angivna leverantören.

FALSK annars.

Observera att om, av någon anledning relaterad till dålig eller ingen internetanslutning på enheten, samtycket för ändamålet inte kunde hämtas, värdet som sattes via defaultReturn parameter kommer att returneras.

Smakämnen defaultReturn parameter existerar inte i versioner äldre än 2.5.1.

Exempelvis

fun getHasVendorConsentAction() {
    val vendorId = "vendorID" // Replace with actual vendor ID
    val hasVendorConsent = cmpManager?.hasVendor(vendorId, false)
    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 informeras AS-IS, när den hämtas via exportCmpString()-metoden. Denna metod förbrukar en sidvisning. 

parametrar

Retur

Inga.

Exempelvis

val cmpString = "YourConsentStringHere"

  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. Denna metod förbrukar en sidvisning. 

parametrar

Retur

CMPManager-objektet.

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. Denna metod förbrukar en sidvisning. 

parametrar

Retur

Inget returvärde.

Exempelvis

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

behöver Acceptans

Kontrollerar om samtycke måste lämnas av den aktuella appanvändaren. Denna metod förbrukar inga sidvisningar. 

parametrar

Retur

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

FALSK annars.

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

Avvisar samtyckeslagret och beter sig på samma sätt när användaren inte accepterade samtycket. Denna metod förbrukar en sidvisning. 

parametrar

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

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

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