UserMessagingPlatform

public final class UserMessagingPlatform

User Messaging Platform SDK 的進入點。

摘要

巢狀類型

在同意聲明表單載入失敗時，要叫用的回呼介面定義。

在同意聲明表單成功載入時，要叫用的回呼介面定義。

公用方法
static ConsentInformation

可取得 ConsentInformation。
static void
loadAndShowConsentFormIfRequired(
    Activity activity,
    ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener
)

如果 getConsentStatus 為 REQUIRED，則會載入同意聲明表單，並立即從提供的 Activity 顯示。
static void

載入 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，這可能會因為下列其中一個原因而發生：

  • 使用者看到表單、選取選項，然後關閉表單
  • 表單不必顯示
  • 表單載入失敗，傳回非空值的 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
)

如果 getPrivacyOptionsRequirementStatus 為 REQUIRED，則會顯示來自提供的 Activity 的隱私權選項表單。

這個方法應只在回應使用者輸入內容時呼叫，以便要求顯示隱私權選項表單。

表單可用時，SDK 會自動預先載入隱私權選項表單。如果尚未預先載入任何表單，SDK 會嘗試以非同步方式載入表單。

使用者看到表單、選取選項並關閉表單後，系統會呼叫 OnConsentFormDismissedListener。

在下列其中一種錯誤情況下，OnConsentFormDismissedListener 也可能在下一個執行迴圈中以非空值 FormError 以非同步方式傳回：

  • 表單無法使用
  • 表單無法顯示
  • 表單仍在預先載入

這個方法必須在主執行緒上呼叫。

參數
Activity activity

顯示隱私權選項表單的活動。
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener

在隱私權選項表單關閉時呼叫的事件監聽器。