ConsentInformation

Kotlin |Java

public 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]) public annotation ConsentInformation.ConsentStatus Valeurs de l'état du consentement.
public interface ConsentInformation.OnConsentInfoUpdateFailureListener Définition d'interface pour un rappel à appeler en cas d'échec de la mise à jour des informations sur le consentement.
public interface ConsentInformation.OnConsentInfoUpdateSuccessListener Définition de l'interface d'un rappel à appeler lorsque les informations sur le consentement sont correctement mises à jour.
public enum ConsentInformation.PrivacyOptionsRequirementStatus État des exigences concernant les options de confidentialité.

Méthodes publiques
abstract boolean	canRequestAds() Indique si le SDK a recueilli le consentement conformément aux messages configurés de l'application.
abstract int	@ConsentInformation.ConsentStatus getConsentStatus() Récupère l'état actuel du consentement.
abstract ConsentInformation.PrivacyOptionsRequirementStatus	getPrivacyOptionsRequirementStatus() Récupère l'état indiquant si un bouton d'options de confidentialité est requis.
abstract boolean	isConsentFormAvailable() Renvoie true si un ConsentForm est disponible, ou false dans le cas contraire.
abstract void	requestConsentInfoUpdate(     Activity activity,     ConsentRequestParameters consentRequestParameters,     ConsentInformation.OnConsentInfoUpdateSuccessListener successListener,     ConsentInformation.OnConsentInfoUpdateFailureListener failureListener ) Demande la mise à jour des informations sur le consentement.
abstract void	reset() Réinitialise l'état de ConsentInformation sur "initialisé".

Méthodes publiques

canRequestAds

abstract boolean canRequestAds()

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
abstract int getConsentStatus()

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

abstract ConsentInformation.PrivacyOptionsRequirementStatus getPrivacyOptionsRequirementStatus()

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

abstract boolean isConsentFormAvailable()

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

requestConsentInfoUpdate

abstract void requestConsentInfoUpdate(
    Activity activity,
    ConsentRequestParameters consentRequestParameters,
    ConsentInformation.OnConsentInfoUpdateSuccessListener successListener,
    ConsentInformation.OnConsentInfoUpdateFailureListener failureListener
)

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 mis à jour à nouveau pour afficher 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.
ConsentInformation.OnConsentInfoUpdateSuccessListener successListener	Écouteur de réussite de la demande de consentement.
ConsentInformation.OnConsentInfoUpdateFailureListener failureListener	Écouteur d'échec de la demande de consentement.

réinitialiser

abstract void reset()

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