UserMessagingPlatform
public final class UserMessagingPlatform
User Messaging Platform SDK のエントリ ポイント。
概要
ネストされた型 |
|---|
public interface UserMessagingPlatform.OnConsentFormLoadFailureListener同意フォームの読み込みに失敗したときに呼び出されるコールバックのインターフェース定義。 |
public interface UserMessagingPlatform.OnConsentFormLoadSuccessListener同意フォームが正常に読み込まれたときに呼び出されるコールバックのインターフェース定義。 |
パブリック メソッド |
|
|---|---|
static ConsentInformation |
getConsentInformation(Context context)
|
static void |
loadAndShowConsentFormIfRequired(同意フォームを読み込み、 |
static void |
loadConsentForm(
|
static void |
showPrivacyOptionsForm(
|
パブリック メソッド
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 |
同意フォームを表示するアクティビティ。 |
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 |
プライバシー オプション フォームを表示するアクティビティ。 |
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener |
プライバシー オプション フォームが閉じられたときに呼び出されるリスナー。 |