ConsentInformation

interface ConsentInformation

Métodos de utilitário para coletar o consentimento dos usuários.

Resumo

Tipos aninhados
@Retention(value = SOURCE)
@IntDef(value = [ConsentStatus.UNKNOWN, ConsentStatus.NOT_REQUIRED, ConsentStatus.REQUIRED, ConsentStatus.OBTAINED])
annotation ConsentInformation.ConsentStatus

Valores de status de consentimento.

Definição de interface para um callback ser invocado quando as informações de consentimento não puderem ser atualizadas.

Definição de interface para um callback que será invocado quando as informações de consentimento forem atualizadas.

Status do requisito de opções de privacidade.

Funções públicas
Boolean

Indica se o SDK coletou o consentimento alinhado às mensagens configuradas do app.
Int

Recebe o status de consentimento atual.
ConsentInformation.PrivacyOptionsRequirementStatus!

Recebe o status indicando se um botão de opções de privacidade é necessário.
Boolean

Retorna true se um ConsentForm estiver disponível. Caso contrário, retorna false.
Unit
requestConsentInfoUpdate(
    activity: Activity!,
    consentRequestParameters: ConsentRequestParameters!,
    successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!,
    failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!
)

Solicita uma atualização das informações de consentimento.
Unit

Redefine o ConsentInformation para o status inicializado.

Funções públicas

canRequestAds

fun canRequestAds(): Boolean

Indica se o SDK coletou o consentimento alinhado às mensagens configuradas do app.

Esse método retorna false até que requestConsentInfoUpdate seja chamado.

Quando requestConsentInfoUpdate é chamado, esse método retorna true quando getConsentStatus retorna NOT_REQUIRED ou OBTAINED.

Retorna
Boolean

"true" se o SDK coletou o consentimento alinhado às mensagens configuradas do app.

getConsentStatus

@ConsentInformation.ConsentStatus
fun getConsentStatus(): Int

Recebe o status de consentimento atual.

Retorna
Int

UNKNOWN até que requestConsentInfoUpdate seja chamado, e o padrão é o valor da sessão anterior até que requestConsentInfoUpdate seja concluído e OnConsentInfoUpdateSuccessListener seja chamado.

getPrivacyOptionsRequirementStatus

fun getPrivacyOptionsRequirementStatus(): ConsentInformation.PrivacyOptionsRequirementStatus!

Recebe o status indicando se um botão de opções de privacidade é necessário.

Retorna
ConsentInformation.PrivacyOptionsRequirementStatus!

UNKNOWN até que requestConsentInfoUpdate seja chamado e, por padrão, é o valor da sessão anterior até que requestConsentInfoUpdate seja concluído e chamado.

isConsentFormAvailable

fun isConsentFormAvailable(): Boolean

Retorna true se um ConsentForm estiver disponível. Caso contrário, retorna false.

requestConsentInfoUpdate

fun requestConsentInfoUpdate(
    activity: Activity!,
    consentRequestParameters: ConsentRequestParameters!,
    successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!,
    failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!
): Unit

Solicita uma atualização das informações de consentimento.

Essa API precisa ser chamada em cada sessão do app antes de chamar getConsentStatus.

Depois que essa API for chamada, o valor de retorno da API getConsentStatus será atualizado de forma síncrona para manter o estado de consentimento da sessão anterior do app, se houver uma.

getConsentStatus pode ser atualizado novamente para o status atualizado após a chamada.

Parâmetros
activity: Activity!

A atividade usada para coletar recortes de tela.
consentRequestParameters: ConsentRequestParameters!

Os parâmetros de solicitação.
successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!

O listener de êxito da solicitação de consentimento.
failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!

O listener de falha de solicitação de consentimento.

redefinir

fun reset(): Unit

Redefine o ConsentInformation para o status inicializado. Ele só deve ser usado para depuração.