info
Contenu

[Android] 2. Documentation de l'API

API


 

Constructeur


Constructeur pour créer un objet CmpManager

Paramètres
Nom et Prénom Type

Description du problème

contexte Comportementale

Le contexte de l'application

config CMPConfig

L'objet de configuration pour le consent manager

closeÉcouteur OnCloseCallback

Le rappel à invoquer lorsque la couche de consentement est fermée

ouvertListener SurOpenCallback

Le rappel à invoquer lorsque la couche de consentement est ouverte

cmpNotOpenedCallback SurCMPNotOpenedCallback

Le rappel à invoquer lorsque la couche de consentement n'a pas pu être ouverte

onErrorCallback SurErreurRappel

Le rappel à invoquer lorsqu'une erreur

 

 

initialiser


Initialiser

Paramètres
Nom et Prénom Type Description du problème
contexte Comportementale  
interface d'application CmpLayerAppEventListenerInterface ? = nul  
Retour

 

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

 

setCallbacks


Définir des rappels

Paramètres
Nom et Prénom Type Description du problème
ouvertListener OnOpenCallback ?  
closeÉcouteur OnCloseCallback ?  
cmpNotOpenedCallback SurCMPNotOpenedCallback ?  
onErrorCallback OnErrorCallback ?  
onCmpButtonClickedCallback OnCmpButtonClickedCallback ?  
Retour

Aucune valeur de retour

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

 

checkAndOpenConsentLayer


Vérifier et ouvrir la couche de consentement

Paramètres
Nom et Prénom Type Description du problème
contexte Comportementale Contexte de l'application
interface d'application CmpLayerAppEventListenerInterface ? = nul  
Retour

Aucune valeur de retour

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

 

ouvrirCustomLayer


ouvre la couche de consentement personnalisée

Paramètres
Nom et Prénom Type Description du problème
activité FragmentActivité instance
conteneurViewId Int  
Retour

Aucune valeur de retour

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

 

vérifier


Visite

Paramètres
Nom et Prénom Type Description du problème
contexte Comportementale  
onCmpLayerOpenCallback OnCmpLayerOpenCallback  
est en cache booléen = faux  
Retour

Aucune valeur de retour

Exemple
check(context = ...,onCmpLayerOpenCallback = ...,isCached = ...)

 

ouvrirCustomLayer


ouvre la couche de consentement personnalisée

Paramètres
Nom et Prénom Type Description du problème
contexte Comportementale Contexte de l'application
interface d'application CmpLayerAppEventListenerInterfaceCmpLayerAppEventListenerInterface  
Retour

Aucune valeur de retour

Exemple
openCustomLayer(context = ...,appInterface = ...)

 

ouvrirConsentLayer


ouvre la couche de consentement

Retour

Aucune valeur de retour

Exemple
openConsentLayer()

 

createCustomLayerFragment


Créer un fragment de calque personnalisé

Retour

CmpLayerFragmentCmpLayerFragment

Exemple
createCustomLayerFragment()

 

a le consentement


vérifier si l'utilisateur a donné son consentement

Retour
Exemple
hasConsent()

 

getAllPurposes


renvoie tous les objectifs sous forme de chaîne

Retour

chaîne de but

Exemple
getAllPurposes()

 

getAllPurposeList


renvoie tous les objectifs sous la forme d'une liste de chaînes

Retour

Liste des objectifs

Exemple
getAllPurposeList()

 

getEnabledPurposes


Obtenir des objectifs convenus

Retour

 

Exemple
getEnabledPurposes()

 

getEnabledPurposeList


Obtenir une liste d'objectifs convenus

Retour

 

Exemple
getEnabledPurposeList()

 

getDisabledPurposes


Obtenir des objectifs désactivés

Retour

 

Exemple
getDisabledPurposes()

 

getAllVendors


Obtenir tous les fournisseurs

Retour

 

Exemple
getAllVendors()

 

getAllVendorsList


Obtenir la liste de tous les fournisseurs

Retour

 

Exemple
getAllVendorsList()

 

getEnabledVendorsgetEnabledVendors


Obtenir des fournisseurs agréés

Retour

 

Exemple
getEnabledVendors()

 

getEnabledVendorListgetEnabledVendorList


Obtenir une liste de fournisseurs convenue

Retour

 

Exemple
getEnabledVendorList()

 

getDisabledVendors


Obtenir des fournisseurs désactivés

Retour

 

Exemple
getDisabledVendors()

 

activerVendorList


Activer la liste des fournisseurs

Paramètres
Nom et Prénom Type Description du problème
contexte Comportementale Contexte de l'application
vendeurs Liste  
onConsentReceivedCallback OnConsentReceivedCallback ? = nul  
Retour

Aucune valeur de retour

Exemple
enableVendorList(context = ...,vendors = ...,onConsentReceivedCallback = ...)

 

désactiverVendorList


Désactiver la liste des fournisseurs

Paramètres
Nom et Prénom Type Description du problème
contexte Comportementale Contexte de l'application
vendeurs Liste Liste des ID de fournisseur à activer.
onConsentReceivedCallback OnConsentReceivedCallback ? = nul  
Retour

Aucune valeur de retour

Exemple
disableVendorList(context = ...,vendors = ...,onConsentReceivedCallback = ...)

 

activerListeObjectifs


Activer la liste d'objectifs

Paramètres
Nom et Prénom Type Description du problème
contexte Comportementale Contexte de l'application
des fins Liste Liste des identifiants d'objectif à activer.
mettre à jour le fournisseur booléen = vrai indicateur si vrai active également les fournisseurs correspondants
onConsentReceivedCallback OnConsentReceivedCallback ? = nul  
Retour

Aucune valeur de retour

Exemple
enablePurposeList(context = ...,purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)

 

désactiverPurposeList


Désactiver une liste d'objectifs

Paramètres
Nom et Prénom Type Description du problème
contexte Comportementale Contexte de l'application
des fins Liste Liste des identifiants d'objectifs à désactiver
mettre à jour le fournisseur booléen = vrai indicateur si vrai désactiver également les fournisseurs correspondants
onConsentReceivedCallback OnConsentReceivedCallback ? = nul  
Retour

Aucune valeur de retour

Exemple
disablePurposeList(context = ...,purposes = ...,updateVendor = ...,onConsentReceivedCallback = ...)

 

rejeter tout


Rejects

Paramètres
Nom et Prénom Type Description du problème
contexte Comportementale Contexte de l'application
Retour

Aucune valeur de retour

Exemple
rejectAll(context = ...)

 

accepter tout


Accepter tout

Paramètres
Nom et Prénom Type Description du problème
contexte Comportementale Contexte de l'application
Retour

Aucune valeur de retour

Exemple
acceptAll(context = ...)

 

getUSPrivacyString


Obtenez-nous la chaîne de confidentialité

Retour

Chaîne de confidentialité américaine

Exemple
getUSPrivacyString()

 

hasVendorConsent


A le consentement du vendeur

Paramètres
Nom et Prénom Type Description du problème
contexte Comportementale Contexte de l'application
id Chaîne fournisseur ID
Retour
Exemple
hasVendorConsent(context = ...,id = ...)

 

aPurposeConsent


A le consentement du but

Paramètres
Nom et Prénom Type Description du problème
contexte Comportementale Contexte de l'application
id Chaîne ID d'objectif
estIABPonjet Boolean (obsolète) si l'objectif est un objectif IAB
checkConsentement booléen = vrai  
Retour

 

Exemple
hasPurposeConsent(context = ...,id = ...,isIABPurpose = ...,checkConsent = ...)

 

getGoogleACString


Obtenir la chaîne Google AC

Retour

Chaîne Google AC

Exemple
getGoogleACString()

 

getConsentstring


Obtenir la dernière chaîne de consentement

Retour
Exemple
getConsentstring()

 

exportCmpString


Exporter la chaîne de consentement

Retour

Chaîne Cmp enregistrée

Exemple
exportCmpString()

 

getCalledLast


Être appelé en dernier

Retour

Date du dernier appel Cmp Layer

Exemple
getCalledLast()

 

appeléCeJour


Appelé ce jour

Retour

si la couche a été appelée aujourd'hui

Exemple
calledThisDay()

 

BesoinsAcceptation


Besoin d'acceptation

Retour

si l'utilisateur a besoin d'acceptation

Exemple
needsAcceptance()

 

setOpenCmpConsentToolViewListener


ouvre la couche de consentement

Paramètres
Nom et Prénom Type Description du problème
contexte Comportementale Contexte de l'application
bouton gdpr Bouton Bouton d'action
rappeler OnCloseCallback ?  
Retour

Aucune valeur de retour

Exemple
setOpenCmpConsentToolViewListener(context = ...,gdprButton = ...,callback = ...)

 

setOpenPlaceHolderViewListener


Définir un écouteur de vue d'espace réservé ouvert

Paramètres
Nom et Prénom Type Description du problème
contexte Comportementale Contexte de l'application
bouton d'action Bouton  
Retour

Aucune valeur de retour

Exemple
setOpenPlaceHolderViewListener(context = ...,actionButton = ...)

 

Retour en haut de la page