UserMessagingPlatform

Kotlin |Java

class UserMessagingPlatform

---

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

Resumo

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

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

Funções públicas

getConsentInformation

java-static fun getConsentInformation(context: Context!): ConsentInformation!

Recebe o ConsentInformation.

loadAndShowConsentFormIfRequired

java-static fun loadAndShowConsentFormIfRequired(
    activity: Activity!,
    onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!
): Unit

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.
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!	O listener que é chamado quando o formulário de consentimento é dispensado.

loadConsentForm

java-static fun loadConsentForm(
    context: Context!,
    successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener!,
    failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener!
): Unit

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.
successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener!	O listener de êxito de carregamento do formulário de consentimento.
failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener!	O listener de falha de carregamento do formulário de consentimento.

showPrivacyOptionsForm

java-static fun showPrivacyOptionsForm(
    activity: Activity!,
    onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!
): Unit

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.
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!	O listener que é chamado quando o formulário de opções de privacidade é dispensado.