Платформа UserMessaging 

public final class UserMessagingPlatform

Точка входа для SDK платформы обмена сообщениями пользователей.

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

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

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

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

Публичные методы

static ConsentInformation

Получает ConsentInformation .

static void

Загружает форму согласия и немедленно отображает ее из предоставленного Activity если getConsentStatus REQUIRED .

static void

Загружает форму ConsentForm .

static void
showPrivacyOptionsForm (
Activity activity,
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener
)

Представляет форму параметров конфиденциальности из предоставленного Activity , если getPrivacyOptionsRequirementStatus является REQUIRED .

Публичные методы

getConsentInformation 

public static ConsentInformation getConsentInformation(Context context)

Получает ConsentInformation .

ЗагрузитьАндШовКонсентФормифрекуайред 

public static void loadAndShowConsentFormIfRequired(
    Activity activity,
    ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener
)

Загружает форму согласия и немедленно отображает ее из предоставленного Activity если getConsentStatus REQUIRED .

Вызывает OnConsentFormDismissedListener после завершения работы этого метода, что может произойти по одной из следующих причин:

  • пользователю предоставляется форма, он выбирает вариант и закрывает форму
  • форму не обязательно показывать
  • форма не загружается, возвращая ненулевое значение FormError
  • форма не отображается, возвращается ненулевое значение FormError

Этот метод должен вызываться в основном потоке.

Параметры
Activity activity

Действие, показывающее форму согласия.

ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener

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

loadConsentForm 

public static void loadConsentForm(
    Context context,
    UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener,
    UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener
)

Загружает форму ConsentForm .

Проверяет, что isConsentFormAvailable возвращает true перед вызовом этого метода.

Этот метод должен вызываться в основном потоке.

Параметры
Context context

Контекст.

UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener

Форма согласия загружает прослушиватель успешной загрузки.

UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener

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

Форма showPrivacyOptionsForm 

public static void showPrivacyOptionsForm(
    Activity activity,
    ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener
)

Представляет форму параметров конфиденциальности из предоставленного Activity , если getPrivacyOptionsRequirementStatus является REQUIRED .

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

Форма параметров конфиденциальности предварительно загружается SDK автоматически, когда форма становится доступной. Если форма не была предварительно загружена, SDK попытается загрузить ее асинхронно.

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

OnConsentFormDismissedListener также может асинхронно вернуться в следующем цикле выполнения с ненулевым FormError при одном из следующих состояний ошибки:

  • форма недоступна
  • форма не отображается
  • форма все еще загружается предварительно

Этот метод должен вызываться в основном потоке.

Параметры
Activity activity

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

ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener

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