UserMessagingPlatform

Kotlin |Java

public final class UserMessagingPlatform

---

User Messaging Platform SDK 的入口点。

摘要

嵌套类型
public interface UserMessagingPlatform.OnConsentFormLoadFailureListener 在用户意见征求表单加载失败时要调用的回调的接口定义。
public interface UserMessagingPlatform.OnConsentFormLoadSuccessListener 在用户意见征求表单成功加载时要调用的回调的接口定义。

公共方法
static ConsentInformation	getConsentInformation(Context context) 获取 ConsentInformation。
static void	loadAndShowConsentFormIfRequired(     Activity activity,     ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener ) 如果 getConsentStatus 为 REQUIRED，则加载用户意见征求表单并立即从提供的 Activity 中显示该表单。
static void	loadConsentForm(     Context context,     UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener,     UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener ) 加载 ConsentForm。
static void	showPrivacyOptionsForm(     Activity activity,     ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener ) 如果 getPrivacyOptionsRequirementStatus 为 REQUIRED，则显示提供的 Activity 中的隐私选项表单。

公共方法

getConsentInformation

public static ConsentInformation getConsentInformation(Context context)

获取 ConsentInformation。

loadAndShowConsentFormIfRequired

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

加载用户意见征求表单，并在 getConsentStatus 为 REQUIRED 时立即从提供的 Activity 中显示该表单。

在该方法完成时调用 OnConsentFormDismissedListener，这可能由以下某种原因导致：

• 系统向用户显示表单，用户选择一个选项，然后关闭表单
• 表单无需显示
• 表单未能加载，返回非 null 的 FormError
• 表单未能显示，并返回非 null FormError

必须在主线程上调用此方法。

参数
Activity 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
)

如果 getPrivacyOptionsRequirementStatus 为 REQUIRED，则显示提供的 Activity 中的隐私选项表单。

此方法应仅在响应用户输入以请求显示隐私选项表单时调用。

当有表单可用时，SDK 会自动预加载隐私权选项表单。如果未预加载任何表单，SDK 将尝试异步加载一个表单。

在向用户显示表单、用户选择一个选项并关闭表单后，系统会调用 OnConsentFormDismissedListener。

在以下某种错误条件下，OnConsentFormDismissedListener 还可能会在下一个运行循环中异步返回非 null 的 FormError：

• 表单不可用
• 表单未显示
• 表单仍在预加载中

必须在主线程上调用此方法。

参数
Activity activity	显示隐私权选项表单的 activity。
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener	在关闭隐私权选项表单时调用的监听器。