ConsentInformation

public 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])
public 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.

Métodos públicos

abstract boolean

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

abstract int

Recebe o status de consentimento atual.

abstract ConsentInformation.PrivacyOptionsRequirementStatus

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

abstract boolean

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

abstract void

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

abstract void

Redefine o ConsentInformation para o status inicializado.

Métodos públicos

canRequestAds

abstract boolean canRequestAds()

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
abstract int getConsentStatus()

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

abstract ConsentInformation.PrivacyOptionsRequirementStatus getPrivacyOptionsRequirementStatus()

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

abstract boolean isConsentFormAvailable()

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

requestConsentInfoUpdate

abstract void requestConsentInfoUpdate(
    Activity activity,
    ConsentRequestParameters consentRequestParameters,
    ConsentInformation.OnConsentInfoUpdateSuccessListener successListener,
    ConsentInformation.OnConsentInfoUpdateFailureListener failureListener
)

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.

ConsentInformation.OnConsentInfoUpdateSuccessListener successListener

O listener de êxito da solicitação de consentimento.

ConsentInformation.OnConsentInfoUpdateFailureListener failureListener

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

redefinir

abstract void reset()

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