Платформа UserMessaging
class UserMessagingPlatform
Точка входа для SDK платформы обмена сообщениями пользователей.
Краткое содержание
Вложенные типы |
|---|
Определение интерфейса для обратного вызова, который будет вызываться, если не удалось загрузить форму согласия. |
Определение интерфейса для обратного вызова, который будет вызываться при успешной загрузке формы согласия. |
Общественные функции | |
|---|---|
java-static ConsentInformation ! | getConsentInformation (context: Context !) Получает |
java-static Unit | loadAndShowConsentFormIfRequired ( Загружает форму согласия и немедленно отображает ее из предоставленного |
java-static Unit | loadConsentForm ( Загружает форму |
java-static Unit | showPrivacyOptionsForm ( Представляет форму параметров конфиденциальности из предоставленного |
Общественные функции
getConsentInformation
java-static fun getConsentInformation(context: Context!): ConsentInformation!
Получает ConsentInformation .
ЗагрузитьАндШовКонсентФормифрекуайред
java-static fun loadAndShowConsentFormIfRequired(
activity: Activity!,
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!
): Unit
Загружает форму согласия и немедленно отображает ее из предоставленного Activity если getConsentStatus REQUIRED .
Вызывает OnConsentFormDismissedListener после завершения работы этого метода, что может произойти по одной из следующих причин:
- пользователю предоставляется форма, он выбирает вариант и закрывает форму
- форму не обязательно показывать
- форма не загружается, возвращая ненулевое значение
FormError - форма не отображается, возвращается ненулевое значение
FormError
Этот метод должен вызываться в основном потоке.
| Параметры | |
|---|---|
activity: Activity ! | Действие, показывающее форму согласия. |
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener ! | Прослушиватель, который вызывается при отклонении формы согласия. |
loadConsentForm
java-static fun loadConsentForm(
context: Context!,
successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener!,
failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener!
): Unit
Загружает форму ConsentForm .
Проверяет, что isConsentFormAvailable возвращает true перед вызовом этого метода.
Этот метод должен вызываться в основном потоке.
| Параметры | |
|---|---|
context: Context ! | Контекст. |
successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener ! | Форма согласия загружает прослушиватель успешной загрузки. |
failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener ! | Прослушиватель сбоев загрузки формы согласия. |
Форма showPrivacyOptionsForm
java-static fun showPrivacyOptionsForm(
activity: Activity!,
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!
): Unit
Представляет форму параметров конфиденциальности из предоставленного Activity , если getPrivacyOptionsRequirementStatus является REQUIRED .
Этот метод следует вызывать только в ответ на ввод пользователя для запроса отображения формы параметров конфиденциальности.
Форма параметров конфиденциальности предварительно загружается SDK автоматически, когда форма становится доступной. Если форма не была предварительно загружена, SDK попытается загрузить ее асинхронно.
OnConsentFormDismissedListener вызывается после того, как пользователю предоставляется форма, он выбирает параметр и закрывает форму.
OnConsentFormDismissedListener также может асинхронно вернуться в следующем цикле выполнения с ненулевым FormError при одном из следующих состояний ошибки:
- форма недоступна
- форма не отображается
- форма все еще загружается предварительно
Этот метод должен вызываться в основном потоке.
| Параметры | |
|---|---|
activity: Activity ! | Действие, показывающее форму параметров конфиденциальности. |
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener ! | Прослушиватель, который вызывается при закрытии формы параметров конфиденциальности. |