Info
Content

[Android] 2. API-documentatie

accepteer alles

parameters
Naam Type Omschrijving
onConsentReceivedCallback Bij ToestemmingOntvangenTerugbellen? Terugbellen voor het afhandelen van de gebeurtenis 'Toestemming ontvangen'.
Retourneren

Geen retourwaarde

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


controle

parameters
Naam Type Omschrijving
onCheckIsConsentRequiredCallback OnCheckIsToestemming vereist fun isConsentRequired(isConsentRequired: Boolean) terugbellen om te bepalen of toestemming vereist is of niet
isCached Booleaans = onwaar indien waar, wordt het resultaat één dag in de cache bewaard
Retourneren

Geen.

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


checkAndOpenConsentLayer

Controleert of toestemming van de gebruiker vereist is en opent, als dat het geval is, de gebruikersinterface van de toestemmingslaag.

parameters
Naam Type Omschrijving
context Context Toepassingscontext
appInterface CmpLayerAppEventListenerInterface? = nul  
Retourneren

Geen retourwaarde

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


genaamdThisDay

Controleert of de toestemmingslaag vandaag is aangevraagd.

parameters
Geen.
Retourneren

WAAR als de toestemming van de gebruiker vandaag al is gevraagd.

Anders ONWAAR.

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

uitschakelenPurposeList

Schakelt een lijst met doeleinden uit en werkt de gegeven toestemming bij.

parameters
Naam Type Omschrijving
purposes Lijst Lijst met doel-ID's die moeten worden uitgeschakeld
updateVendor Boolean vlag indien waar, schakel ook overeenkomstige leveranciers uit
onConsentReceivedCallback Bij ToestemmingOntvangenTerugbellen?  
Retourneren

Geen retourwaarde

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

leverancierslijst uitschakelen

Schakelt een lijst met leveranciers uit en werkt de gegeven toestemming bij.

parameters
Naam Type Omschrijving
vendors Lijst Lijst met leveranciers-ID's die moeten worden ingeschakeld.
onConsentReceivedCallback Bij ToestemmingOntvangenTerugbellen?  Terugbellen voor het afhandelen van de gebeurtenis 'Toestemming ontvangen'. het wordt opgeroepen wanneer toestemming is ontvangen en verwerkt
Retourneren

Geen retourwaarde.

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


leverancierslijst inschakelen

Maakt een lijst met doeleinden mogelijk en werkt de gegeven toestemming bij.

parameters
Naam Type Omschrijving
vendors Lijst Lijst met doel-ID's die moeten worden ingeschakeld.
onConsentReceivedCallback functie (optioneel) Terugbellen voor het afhandelen van de gebeurtenis 'Toestemming ontvangen'. Het wordt opgeroepen wanneer de toestemming is ontvangen en verwerkt
Retourneren

Geen retourwaarde.

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


SchakelPurposeList in

Maakt een lijst met leveranciers mogelijk en werkt de gegeven toestemming bij.

parameters
Naam Type Omschrijving
purposes Lijst Lijst met doel-ID's die moeten worden ingeschakeld.
updateVendor Boolean vlag indien waar, schakel ook overeenkomstige leveranciers in
onConsentReceivedCallback Functie (optioneel)  
Retourneren

Geen retourwaarde.

Voorbeeld
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

Exporteert de huidige CMP-tekenreeks die de toestemmingsvoorkeuren van de gebruiker vertegenwoordigt.  

parameters
Geen.
Retourneren

De CMP base64-gecodeerde tekenreeks.

Voorbeeld

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

GetAllPurposes

Retourneert de ID's van alle doeleinden.

parameters
Geen.
Retourneren

Een door komma's gescheiden tekenreeks die ID's voor alle doeleinden bevat.

Voorbeeld
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

Retourneert een lijst met alle doel-ID's voor een bepaald CMP.

Retourneren

Lijst

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


haalAlleVerkopers

Retourneert de ID's van alle leveranciers voor een bepaald CMP.

parameters
Geen.
Retourneren

Een door komma's gescheiden tekenreeks die alle leveranciers-ID's bevat.

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


getAllVendorsLijst

Retourneert een lijst met de ID's van alle leveranciers voor een bepaald CMP.

parameters
Geen.
Retourneren

Een lijst met alle leveranciers-ID's.

Voorbeeld

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


getConsentstring

Retourneert een tekenreeks met de laatst gegeven toestemming.

parameters
Geen.
Retourneren

Een tekenreeks waarvan de laatste toestemming door de gebruiker is bevestigd.

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


getDisabledPurposes

Retourneert de ID's van alle uitgeschakelde doeleinden voor een bepaald CMP.

parameters
Geen.
Retourneren

Een door komma's gescheiden tekenreeks met de ID's van alle uitgeschakelde doeleinden.

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

getDisabledVendors

Retourneert alle uitgeschakelde leveranciers-ID's voor een bepaald CMP.

parameters
Geen.
Retourneren

Een door komma's gescheiden tekenreeks met de ID's van alle uitgeschakelde leveranciers.

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

getEnabledPurposes

Retourneert alle ingeschakelde leveranciers-ID's voor een bepaald CMP.

parameters
Geen.
Retourneren

Een door komma's gescheiden tekenreeks met de ID's van alle ingeschakelde leveranciers.

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

getEnabledPurposeList

Retourneert een lijst met de ID's van alle ingeschakelde doeleinden voor een bepaald CMP.

parameters
Geen.
Retourneren

Een lijst met de ID's van alle ingeschakelde doeleinden.

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

getEnabledVendors

Retourneert alle ingeschakelde leveranciers-ID's voor een bepaald CMP.

parameters
Geen.
Retourneren

Een door komma's gescheiden tekenreeks met de ID's van alle ingeschakelde leveranciers.

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

getEnabledVendorList

Retourneert een lijst met alle ingeschakelde leveranciers-ID's voor een bepaald CMP.

parameters
Geen.
Retourneren

Een lijst met alle ingeschakelde leveranciers-ID's.

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

getGoogleACString

Haalt de Google-tekenreeks voor aanvullende toestemmings-ID (`addtlConsent`) op die is ingesteld door de consent manager.

Voor meer informatie, kijk op de Technische specificatie voor aanvullende toestemming van Google.  

parameters
Geen.
Retourneren

Een lijst met alle ingeschakelde leveranciers-ID's.

Voorbeeld
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

Haalt de Amerikaanse privacystring op. Deze Amerikaanse privacystring is een cookie die informatie opslaat over de door de websitebezoeker gemaakte openbaarmakingen en keuzes met betrekking tot zijn consumentenrechten.

parameters
Geen.
Retourneren

Een string met de Amerikaanse privacygegevens die zijn ingesteld door consentmanager.

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

heeftToestemming

Controleert of de gebruiker al toestemming heeft gegeven. De toestemmingslaag kan de optie hebben om de laag gewoon te sluiten. In dat geval heeft de gebruiker geen toestemming gegeven.

parameters
Geen.
Retourneren

Een string met de Amerikaanse privacygegevens die zijn ingesteld door consentmanager.

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

heeftPurposeConsent

Controleert of de doel-ID is ingeschakeld op basis van de toestemming van de gebruiker.

parameters
Naam Type Omschrijving
purposeId Draad doel-id
Retourneren

WAAR als

  • de gebruiker heeft toestemming gegeven voor het aangegeven doel OF
  • om welke reden dan ook die verband houdt met een slechte of geen internetverbinding op het apparaat, kon de toestemming voor het doel niet worden opgehaald. Raadpleeg de withErrorListener om deze voorwaarden af ​​te handelen tijdens het starten van de app, vooral voor nieuwe gebruikers die nog geen toestemming hebben gegeven

Anders ONWAAR.

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

heeftVendorConsent

Controleert of de leveranciers-ID is ingeschakeld op basis van de toestemming van de gebruiker.

parameters
Naam Type Omschrijving
vendorId Draad verkopers ID
Retourneren
  • de gebruiker heeft toestemming gegeven aan de opgegeven leverancier OF
  • om welke reden dan ook die verband houdt met een slechte of geen internetverbinding op het apparaat, kon de toestemming van de verkoper niet worden opgehaald. Raadpleeg de withErrorListener om deze voorwaarden af ​​te handelen tijdens het starten van de app, vooral voor nieuwe gebruikers die nog geen toestemming hebben gegeven

Anders ONWAAR.

Voorbeeld
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

Importeert een CMP-tekenreeks die de toestemmingsvoorkeuren van de gebruiker vertegenwoordigt. De tekenreeks moet base64-gecodeerd zijn

parameters
Naam Type Omschrijving
toestemmingString  Draad Base64-gecodeerde tekenreeks die de toestemming vertegenwoordigt
voltooiingHandler functie (optioneel) Callback-voltooiingshandler naar de methode.
Retourneren

Geen.

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


initialiseren

De functie Initialize initialiseert de toestemmingslaag en controleert automatisch of de gebruiker toestemming nodig heeft of niet. Deze functie opent uiteindelijk de toestemmingslaag en communiceert met de Apple Tracking Transparency API om de gebruiker om toestemming te vragen

parameters
Naam Type Omschrijving
context Context App-context
cmpConfig CmpConfig Het CmpConfig-object wordt doorgegeven met de informatie over de appId, Domain, appName en taal (optioneel)
Retourneren

Het CMPManager-object.

Voorbeeld

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

Opent geforceerd de webweergave van de CMP-toestemmingslaag.

parameters
Naam Type Omschrijving
context Context App-context.
Retourneren

Geen retourwaarde.

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


heeft Acceptatie nodig

parameters
Geen.
Retourneren

TRUE als de gebruiker toestemming moet geven.

Anders ONWAAR.

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

weigerAlles

parameters
Naam Type Omschrijving
onFinish functie Optioneel. Terugbellen voor het afhandelen van de gebeurtenis 'Toestemming ontvangen'. het wordt opgeroepen wanneer toestemming is ontvangen en verwerkt.
Retourneren

Geen retourwaarde.

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

cmpManager?.rejectAll(::onFinish)

terugbellen instellen

Configureert de beschikbare terugbelverzoeken.

parameters
Naam Type Omschrijving
openListener AanOpenTerugbellen

De callback die moet worden aangeroepen wanneer de toestemmingslaag wordt geopend.

closeListener BijSluitenTerugbellen

De callback die moet worden aangeroepen wanneer de toestemmingslaag wordt gesloten.

cmpNotOpenedCallback AanCMPNietGeopendTerugbellen

De callback die moet worden aangeroepen wanneer de toestemmingslaag niet kan worden geopend.

onErrorCallback OnErrorTerugbellen

De callback die moet worden aangeroepen bij een fout.

onButtonClickedCallback
OnButtonClickedCallback

De callback die moet worden aangeroepen om informatie te krijgen over welke knop is ingedrukt om de toestemmingslaag te sluiten.

Retourneren

Geen retourwaarde

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

met GoogleAnalyticsTerugbellen

Callback instellen voor het ophalen van Google Consentmode-waarden.

parameters
Naam Type Omschrijving
analyticsListener CmpGoogleAnalyticsInterface De interface-implementatie om updates te ontvangen over de toestemmingsmodus van Google Analytics.
Retourneren

Het huidige exemplaar van CmpManagerInterface voor ketenvorming.

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


 

 

Terug naar boven