UserMessagingPlatform

Kotlin |Java

public final class UserMessagingPlatform

---

Punto de entrada del SDK de User Messaging Platform.

Resumen

Tipos anidados
public interface UserMessagingPlatform.OnConsentFormLoadFailureListener Definición de interfaz para que se invoque una devolución de llamada cuando no se pueda cargar un formulario de consentimiento.
public interface UserMessagingPlatform.OnConsentFormLoadSuccessListener Definición de interfaz para que se invoque una devolución de llamada cuando se cargue correctamente un formulario de consentimiento.

Métodos públicos
static ConsentInformation	getConsentInformation(Context context) Obtiene el ConsentInformation.
static void	loadAndShowConsentFormIfRequired(     Activity activity,     ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener ) Carga un formulario de consentimiento y lo muestra de inmediato desde el Activity proporcionado si getConsentStatus es REQUIRED.
static void	loadConsentForm(     Context context,     UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener,     UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener ) Carga un ConsentForm.
static void	showPrivacyOptionsForm(     Activity activity,     ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener ) Presenta un formulario de opciones de privacidad del Activity proporcionado si getPrivacyOptionsRequirementStatus es REQUIRED.

Métodos públicos

getConsentInformation

public static ConsentInformation getConsentInformation(Context context)

Obtiene el ConsentInformation.

loadAndShowConsentFormIfRequired

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

Carga un formulario de consentimiento y lo muestra de inmediato desde el Activity proporcionado si getConsentStatus es REQUIRED.

Llama a OnConsentFormDismissedListener cuando finaliza este método, lo que puede ocurrir por una de las siguientes razones:

• se le presenta el formulario al usuario, selecciona una opción y lo descarta
• no es obligatorio mostrar el formulario
• No se puede cargar el formulario y se muestra un FormError no nulo.
• El formulario no se muestra y muestra un FormError no nulo.

Se debe llamar a este método en el subproceso principal.

Parámetros
Activity activity	La actividad que muestra el formulario de consentimiento
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener	Es el objeto de escucha al que se llama cuando se descarta el formulario de consentimiento.

loadConsentForm

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

Carga un ConsentForm.

Verifica que isConsentFormAvailable muestre true antes de llamar a este método.

Se debe llamar a este método en el subproceso principal.

Parámetros
Context context	El contexto.
UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener	Objeto de escucha de carga correcta del formulario de consentimiento
UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener	El objeto de escucha de error de carga del formulario de consentimiento

showPrivacyOptionsForm

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

Presenta un formulario de opciones de privacidad del Activity proporcionado si getPrivacyOptionsRequirementStatus es REQUIRED.

Solo se debe llamar a este método en respuesta a una entrada del usuario para solicitar que se muestre un formulario de opciones de privacidad.

El SDK precarga automáticamente el formulario de opciones de privacidad cuando este está disponible. Si no se precargó ningún formulario, el SDK intentará cargar uno de forma asíncrona.

Se llama a OnConsentFormDismissedListener después de que se le presenta un formulario al usuario, este selecciona una opción y lo descarta.

OnConsentFormDismissedListener también puede mostrarse de forma asíncrona en el siguiente bucle de ejecución con un FormError no nulo en una de las siguientes condiciones de error:

• el formulario no está disponible
• no se muestra el formulario
• el formulario aún se está precargando

Se debe llamar a este método en el subproceso principal.

Parámetros
Activity activity	La actividad que muestra el formulario de opciones de privacidad
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener	Es el objeto de escucha al que se llama cuando se descarta el formulario de opciones de privacidad.