ConsentInformation

interface ConsentInformation


Méthodes utilitaires permettant de recueillir le consentement des utilisateurs.

Résumé

Types imbriqués

@Retention(value = SOURCE)
@IntDef(value = [ConsentStatus.UNKNOWN, ConsentStatus.NOT_REQUIRED, ConsentStatus.REQUIRED, ConsentStatus.OBTAINED])
annotation ConsentInformation.ConsentStatus

Valeurs de l'état du consentement.

Définition d'interface pour un rappel à appeler en cas d'échec de la mise à jour des informations sur le consentement.

Définition de l'interface d'un rappel à appeler lorsque les informations sur le consentement sont correctement mises à jour.

État des exigences concernant les options de confidentialité.

Fonctions publiques

Boolean

Indique si le SDK a recueilli le consentement conformément aux messages configurés de l'application.

Int

Récupère l'état actuel du consentement.

ConsentInformation.PrivacyOptionsRequirementStatus!

Récupère l'état indiquant si un bouton d'options de confidentialité est requis.

Boolean

Renvoie true si un ConsentForm est disponible, ou false dans le cas contraire.

Unit
requestConsentInfoUpdate(
    activity: Activity!,
    consentRequestParameters: ConsentRequestParameters!,
    successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!,
    failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!
)

Demande la mise à jour des informations sur le consentement.

Unit

Réinitialise l'état de ConsentInformation sur "initialisé".

Fonctions publiques

canRequestAds

fun canRequestAds(): Boolean

Indique si le SDK a recueilli le consentement conformément aux messages configurés de l'application.

Cette méthode renvoie false jusqu'à ce que requestConsentInfoUpdate soit appelé.

Une fois requestConsentInfoUpdate appelé, cette méthode renvoie true lorsque getConsentStatus renvoie NOT_REQUIRED ou OBTAINED.

Renvoie
Boolean

"true" si le SDK a recueilli le consentement conformément aux messages configurés de l'application.

getConsentStatus

@ConsentInformation.ConsentStatus
fun getConsentStatus(): Int

Récupère l'état actuel du consentement.

Renvoie
Int

UNKNOWN jusqu'à l'appel de requestConsentInfoUpdate, et par défaut la valeur de la session précédente jusqu'à ce que requestConsentInfoUpdate se termine correctement et que OnConsentInfoUpdateSuccessListener soit appelé.

getPrivacyOptionsRequirementStatus

fun getPrivacyOptionsRequirementStatus(): ConsentInformation.PrivacyOptionsRequirementStatus!

Récupère l'état indiquant si un bouton d'options de confidentialité est requis.

Renvoie
ConsentInformation.PrivacyOptionsRequirementStatus!

UNKNOWN jusqu'à ce que requestConsentInfoUpdate soit appelé, et par défaut, la valeur de la session précédente jusqu'à ce que requestConsentInfoUpdate se termine correctement et soit appelée.

isConsentFormAvailable

fun isConsentFormAvailable(): Boolean

Renvoie true si un ConsentForm est disponible, ou false dans le cas contraire.

requestConsentInfoUpdate

fun requestConsentInfoUpdate(
    activity: Activity!,
    consentRequestParameters: ConsentRequestParameters!,
    successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!,
    failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!
): Unit

Demande la mise à jour des informations sur le consentement.

Cette API doit être appelée dans chaque session d'application avant d'appeler getConsentStatus.

Une fois cette API appelée, la valeur renvoyée par l'API getConsentStatus sera mise à jour de manière synchrone pour contenir l'état du consentement de la session d'application précédente, le cas échéant.

getConsentStatus peut être à nouveau mis à jour avec l'état à jour après l'appel de.

Paramètres
activity: Activity!

Activité utilisée pour collecter les découpages d'écran.

consentRequestParameters: ConsentRequestParameters!

Paramètres de la requête.

successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!

Écouteur de réussite de la demande de consentement.

failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!

Écouteur d'échec de la demande de consentement.

réinitialiser

fun reset(): Unit

Réinitialise l'état de ConsentInformation sur "initialisé". Cette option ne doit être utilisée que pour le débogage.