UserMessagingPlatform

Kotlin |Java

public final class UserMessagingPlatform

---

Point d'entrée du SDK User Messaging Platform.

Résumé

Types imbriqués
public interface UserMessagingPlatform.OnConsentFormLoadFailureListener Définition d'interface pour un rappel à appeler en cas d'échec du chargement d'un formulaire de consentement.
public interface UserMessagingPlatform.OnConsentFormLoadSuccessListener Définition d'interface pour un rappel à appeler lorsqu'un formulaire de consentement se charge correctement.

Méthodes publiques
static ConsentInformation	getConsentInformation(Context context) Récupère les ConsentInformation.
static void	loadAndShowConsentFormIfRequired(     Activity activity,     ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener ) Charge un formulaire de consentement et l'affiche immédiatement à partir du Activity fourni si getConsentStatus est REQUIRED.
static void	loadConsentForm(     Context context,     UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener,     UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener ) Charge un ConsentForm.
static void	showPrivacyOptionsForm(     Activity activity,     ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener ) Présente un formulaire d'options de confidentialité à partir de l'Activity fourni si getPrivacyOptionsRequirementStatus est REQUIRED.

Méthodes publiques

getConsentInformation

public static ConsentInformation getConsentInformation(Context context)

Récupère les ConsentInformation.

loadAndShowConsentFormIfRequired

public static void loadAndShowConsentFormIfRequired(
    Activity activity,
    ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener
)

Charge un formulaire de consentement et l'affiche immédiatement à partir du Activity fourni si getConsentStatus est REQUIRED.

Appels OnConsentFormDismissedListener à la fin de cette méthode, ce qui peut se produire pour l'une des raisons suivantes:

• L'utilisateur voit le formulaire, sélectionne une option et ferme le formulaire.
• le formulaire n'est pas obligatoire
• Le chargement du formulaire échoue et renvoie un FormError non nul.
• Le formulaire ne s'affiche pas et renvoie un FormError non nul.

Cette méthode doit être appelée dans le thread principal.

Paramètres
Activity activity	Activité affichant le formulaire de consentement.
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener	L'écouteur appelé lorsque le formulaire de consentement est fermé.

loadConsentForm

public static void loadConsentForm(
    Context context,
    UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener,
    UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener
)

Charge un ConsentForm.

Vérifie que isConsentFormAvailable renvoie true avant d'appeler cette méthode.

Cette méthode doit être appelée dans le thread principal.

Paramètres
Context context	Contexte.
UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener	Écouteur de réussite de la charge du formulaire de consentement.
UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener	Écouteur d'échec du chargement du formulaire de consentement.

showPrivacyOptionsForm

public static void showPrivacyOptionsForm(
    Activity activity,
    ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener
)

Présente un formulaire d'options de confidentialité à partir de l'Activity fourni si getPrivacyOptionsRequirementStatus est REQUIRED.

Cette méthode ne doit être appelée que pour demander l'affichage d'un formulaire d'options de confidentialité en réponse à une entrée utilisateur.

Le formulaire d'options de confidentialité est préchargé automatiquement par le SDK lorsqu'un formulaire devient disponible. Si aucun formulaire n'a été préchargé, le SDK tentera d'en charger un de manière asynchrone.

OnConsentFormDismissedListener est appelé une fois qu'un formulaire est présenté à l'utilisateur, qu'il sélectionne une option et qu'il ferme le formulaire.

OnConsentFormDismissedListener peut également renvoyer de manière asynchrone la boucle d'exécution suivante avec un FormError non nul dans l'une des conditions d'erreur suivantes:

• le formulaire n'est pas disponible ;
• le formulaire ne s'affiche pas ;
• le formulaire est toujours en cours de préchargement ;

Cette méthode doit être appelée dans le thread principal.

Paramètres
Activity activity	Activité montrant le formulaire d'options de confidentialité.
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener	Écouteur appelé lorsque le formulaire d'options de confidentialité est fermé.