Информация о согласии

interface ConsentInformation


Служебные методы для сбора согласия пользователей.

Краткое содержание

Вложенные типы

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

Значения статуса согласия.

Определение интерфейса для обратного вызова, который будет вызываться, если не удалось обновить информацию о согласии.

Определение интерфейса для обратного вызова, который будет вызываться при успешном обновлении информации о согласии.

Статус требований к параметрам конфиденциальности.

Общественные функции

Boolean

Указывает, получил ли SDK согласие, соответствующее настроенным сообщениям приложения.

Int

Получает текущий статус согласия.

ConsentInformation.PrivacyOptionsRequirementStatus !

Получает статус, указывающий, требуется ли кнопка параметров конфиденциальности.

Boolean

Возвращает true , если ConsentForm доступен, в противном случае false .

Unit

Запрашивает обновление информации о согласии.

Unit
reset ()

Сбрасывает ConsentInformation в инициализированное состояние.

Общественные функции

canRequestAds

fun canRequestAds(): Boolean

Указывает, получил ли SDK согласие, соответствующее настроенным сообщениям приложения.

Этот метод возвращает false до тех пор, пока не будет вызван requestConsentInfoUpdate .

После вызова requestConsentInfoUpdate этот метод возвращает true , когда getConsentStatus возвращает NOT_REQUIRED или OBTAINED .

Возврат
Boolean

true, если SDK собрал согласие, соответствующее настроенным сообщениям приложения.

getConsentStatus

@ConsentInformation.ConsentStatus
fun getConsentStatus(): Int

Получает текущий статус согласия.

Возврат
Int

UNKNOWN до тех пор, пока не будет вызван requestConsentInfoUpdate , и по умолчанию используется значение предыдущего сеанса, пока requestConsentInfoUpdate не завершится успешно и не будет вызван OnConsentInfoUpdateSuccessListener .

getPrivacyOptionsRequirementStatus

fun getPrivacyOptionsRequirementStatus(): ConsentInformation.PrivacyOptionsRequirementStatus!

Получает статус, указывающий, требуется ли кнопка параметров конфиденциальности.

Возврат
ConsentInformation.PrivacyOptionsRequirementStatus !

UNKNOWN до тех пор, пока не будет вызван requestConsentInfoUpdate , и по умолчанию используется значение предыдущего сеанса, пока requestConsentInfoUpdate не завершится успешно и не будет вызван.

isConsentFormAvailable

fun isConsentFormAvailable(): Boolean

Возвращает true , если ConsentForm доступен, в противном случае false .

запросконсентинформофдате

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

Запрашивает обновление информации о согласии.

Этот API необходимо вызывать в каждом сеансе приложения перед вызовом getConsentStatus .

После вызова этого API возвращаемое значение API getConsentStatus будет обновляться синхронно, чтобы сохранить состояние согласия из предыдущего сеанса приложения, если таковое существует.

getConsentStatus может быть снова обновлен до актуального статуса после вызова.

Параметры
activity: Activity !

Занятие, используемое для сбора вырезок экрана.

consentRequestParameters: ConsentRequestParameters !

Параметры запроса.

successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener !

Прослушиватель успешного запроса согласия.

failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener !

Прослушиватель ошибок запроса согласия.

перезагрузить

fun reset(): Unit

Сбрасывает ConsentInformation в инициализированное состояние. Это следует использовать только для отладки.