UserMessagingPlatform

Kotlin |Java

public final class UserMessagingPlatform

---

Ponto de entrada do SDK da plataforma de mensagens de usuários.

Resumo

Tipos aninhados
public interface UserMessagingPlatform.OnConsentFormLoadFailureListener Definição de interface para um callback ser invocado quando um formulário de consentimento não for carregado.
public interface UserMessagingPlatform.OnConsentFormLoadSuccessListener Definição de interface para um callback que será invocado quando um formulário de consentimento for carregado.

Métodos públicos
static ConsentInformation	getConsentInformation(Context context) Recebe o ConsentInformation.
static void	loadAndShowConsentFormIfRequired(     Activity activity,     ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener ) Carrega um formulário de consentimento e o mostra imediatamente do Activity fornecido se getConsentStatus for REQUIRED.
static void	loadConsentForm(     Context context,     UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener,     UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener ) Carrega um ConsentForm.
static void	showPrivacyOptionsForm(     Activity activity,     ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener ) Apresenta um formulário de opções de privacidade do Activity fornecido se getPrivacyOptionsRequirementStatus for REQUIRED.

Métodos públicos

getConsentInformation

public static ConsentInformation getConsentInformation(Context context)

Recebe o ConsentInformation.

loadAndShowConsentFormIfRequired

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

Carrega um formulário de consentimento e o mostra imediatamente do Activity fornecido se getConsentStatus for REQUIRED.

Chama OnConsentFormDismissedListener quando esse método é concluído, o que pode ocorrer por um dos seguintes motivos:

• o usuário recebe o formulário, seleciona uma opção e dispensa o formulário
• o formulário não precisa ser mostrado
• o formulário não carrega, retornando um FormError não nulo;
• o formulário não é mostrado, retornando um FormError não nulo.

Esse método precisa ser chamado na linha de execução principal.

Parâmetros
Activity activity	A atividade que mostra o formulário de consentimento.
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener	O listener que é chamado quando o formulário de consentimento é dispensado.

loadConsentForm

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

Carrega um ConsentForm.

Verifica se isConsentFormAvailable retorna true antes de chamar esse método.

Esse método precisa ser chamado na linha de execução principal.

Parâmetros
Context context	O contexto.
UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener	O listener de êxito de carregamento do formulário de consentimento.
UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener	O listener de falha de carregamento do formulário de consentimento.

showPrivacyOptionsForm

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

Apresenta um formulário de opções de privacidade do Activity fornecido se getPrivacyOptionsRequirementStatus for REQUIRED.

Esse método só deve ser chamado em resposta a uma entrada do usuário para solicitar que um formulário de opções de privacidade seja mostrado.

O SDK carrega automaticamente o formulário de opções de privacidade quando ele fica disponível. Se nenhum formulário tiver sido pré-carregado, o SDK vai tentar carregar um de forma assíncrona.

OnConsentFormDismissedListener é chamado depois que o usuário recebe um formulário, seleciona uma opção e dispensa o formulário.

OnConsentFormDismissedListener também pode retornar de forma assíncrona no próximo ciclo de execução com um FormError não nulo em uma das seguintes condições de erro:

• o formulário não está disponível
• o formulário não aparece
• o formulário ainda está sendo pré-carregado

Esse método precisa ser chamado na linha de execução principal.

Parâmetros
Activity activity	Atividade mostrando o formulário de opções de privacidade.
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener	O listener que é chamado quando o formulário de opções de privacidade é dispensado.