UserMessagingPlatform

Kotlin |Java

public final class UserMessagingPlatform

---

Punto di contatto per l'SDK User Messaging Platform.

Riepilogo

Tipi nidificati
public interface UserMessagingPlatform.OnConsentFormLoadFailureListener Definizione dell'interfaccia per un callback da chiamare quando non è stato possibile caricare un modulo per il consenso.
public interface UserMessagingPlatform.OnConsentFormLoadSuccessListener Definizione dell'interfaccia per un callback da chiamare quando un modulo per il consenso viene caricato correttamente.

Metodi pubblici
static ConsentInformation	getConsentInformation(Context context) Riceve il ConsentInformation.
static void	loadAndShowConsentFormIfRequired(     Activity activity,     ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener ) Carica un modulo di consenso e lo mostra immediatamente dal Activity fornito se getConsentStatus è REQUIRED.
static void	loadConsentForm(     Context context,     UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener,     UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener ) Carica un ConsentForm.
static void	showPrivacyOptionsForm(     Activity activity,     ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener ) Mostra un modulo di opzioni per la privacy da Activity se getPrivacyOptionsRequirementStatus è REQUIRED.

Metodi pubblici

getConsentInformation

public static ConsentInformation getConsentInformation(Context context)

Riceve il ConsentInformation.

loadAndShowConsentFormIfRequired

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

Carica un modulo di consenso e lo mostra immediatamente dal Activity fornito se getConsentStatus è REQUIRED.

Chiama OnConsentFormDismissedListener al termine di questo metodo, il che può verificarsi per uno dei seguenti motivi:

• L'utente viene presentato con il modulo, seleziona un'opzione e chiude il modulo
• non è necessario mostrare il modulo
• il caricamento del modulo non va a buon fine e viene restituito un valore FormError non nullo
• il modulo non viene visualizzato e restituisce un valore non nullo FormError

Questo metodo deve essere chiamato nel thread principale.

Parametri
Activity activity	L'attività che mostra il modulo per il consenso.
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener	L'ascoltatore che viene chiamato quando il modulo di consenso viene ignorato.

loadConsentForm

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

Carica un ConsentForm.

Verifica che isConsentFormAvailable restituisca true prima di chiamare questo metodo.

Questo metodo deve essere chiamato nel thread principale.

Parametri
Context context	Il contesto.
UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener	L'ascoltatore di caricamento del modulo per il consenso.
UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener	L'ascoltatore di errori di caricamento del modulo di consenso.

showPrivacyOptionsForm

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

Mostra un modulo di opzioni per la privacy da Activity se getPrivacyOptionsRequirementStatus è REQUIRED.

Questo metodo deve essere chiamato solo in risposta a un input dell'utente per richiedere la visualizzazione di un modulo di opzioni della privacy.

Il modulo delle opzioni della privacy viene precaricato automaticamente dall'SDK quando diventa disponibile. Se non è stato precaricato alcun modulo, l'SDK proverà a caricarne uno in modo asincrono.

OnConsentFormDismissedListener viene chiamato dopo che all'utente viene presentato un modulo, seleziona un'opzione e chiude il modulo.

OnConsentFormDismissedListener può anche restituire in modo asincrono nel ciclo di esecuzione successivo un FormError non nullo in una delle seguenti condizioni di errore:

• il modulo non è disponibile
• il modulo non viene visualizzato
• il prelievo del modulo è ancora in corso

Questo metodo deve essere chiamato nel thread principale.

Parametri
Activity activity	L'attività che mostra il modulo delle opzioni per la privacy.
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener	L'ascoltatore che viene chiamato quando il modulo delle opzioni sulla privacy viene chiuso.