ConsentInformation

interface ConsentInformation


Métodos de utilidad para recopilar el consentimiento de los usuarios.

Resumen

Tipos anidados

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

Valores de estado de consentimiento

Definición de la interfaz para que se invoque una devolución de llamada cuando no se pueda actualizar la información de consentimiento.

Definición de la interfaz para una devolución de llamada que se invoque cuando se actualice correctamente la información de consentimiento.

Estado de los requisitos de las opciones de privacidad

Funciones públicas

Boolean

Indica si el SDK recopiló el consentimiento alineado con los mensajes configurados de la app.

Int

Obtiene el estado de consentimiento actual.

ConsentInformation.PrivacyOptionsRequirementStatus!

Obtiene el estado que indica si se requiere un botón de opciones de privacidad.

Boolean

Muestra true si hay un ConsentForm disponible, y false en caso contrario.

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

Solicita una actualización de la información de consentimiento.

Unit

Restablece ConsentInformation al estado inicializado.

Funciones públicas

canRequestAds

fun canRequestAds(): Boolean

Indica si el SDK recopiló el consentimiento alineado con los mensajes configurados de la app.

Este método muestra false hasta que se llama a requestConsentInfoUpdate.

Una vez que se llama a requestConsentInfoUpdate, este método muestra true cuando getConsentStatus muestra NOT_REQUIRED o OBTAINED.

Muestra
Boolean

Es verdadero si el SDK recopiló el consentimiento alineado con los mensajes configurados de la app.

getConsentStatus

@ConsentInformation.ConsentStatus
fun getConsentStatus(): Int

Obtiene el estado de consentimiento actual.

Muestra
Int

UNKNOWN hasta que se llame a requestConsentInfoUpdate y, de forma predeterminada, se establece en el valor de la sesión anterior hasta que requestConsentInfoUpdate se complete correctamente y se llame a OnConsentInfoUpdateSuccessListener.

getPrivacyOptionsRequirementStatus

fun getPrivacyOptionsRequirementStatus(): ConsentInformation.PrivacyOptionsRequirementStatus!

Obtiene el estado que indica si se requiere un botón de opciones de privacidad.

Muestra
ConsentInformation.PrivacyOptionsRequirementStatus!

UNKNOWN hasta que se llame a requestConsentInfoUpdate y, de forma predeterminada, se establece en el valor de la sesión anterior hasta que se complete requestConsentInfoUpdate de forma correcta y se llame a.

isConsentFormAvailable

fun isConsentFormAvailable(): Boolean

Muestra true si hay un ConsentForm disponible, y false en caso contrario.

requestConsentInfoUpdate

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

Solicita una actualización de la información de consentimiento.

Se debe llamar a esta API en cada sesión de la app antes de llamar a getConsentStatus.

Después de llamar a esta API, el valor que muestra la API de getConsentStatus se actualizará de forma síncrona para conservar el estado de consentimiento de la sesión de la app anterior, si existe uno.

Es posible que getConsentStatus se vuelva a actualizar al estado actualizado después de que se llame a.

Parámetros
activity: Activity!

Es la actividad que se usa para recopilar recortes de pantalla.

consentRequestParameters: ConsentRequestParameters!

Los parámetros de la solicitud.

successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!

El objeto de escucha de éxito de la solicitud de consentimiento

failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!

El objeto de escucha de errores de la solicitud de consentimiento

restablecer

fun reset(): Unit

Restablece ConsentInformation al estado inicializado. Esto solo se debe usar para depurar.