UserMessagingPlatform

class UserMessagingPlatform


User Messaging Platform SDK のエントリ ポイント。

概要

ネストされた型

同意フォームの読み込みに失敗したときに呼び出されるコールバックのインターフェース定義。

同意フォームが正常に読み込まれたときに呼び出されるコールバックのインターフェース定義。

パブリック関数

java-static ConsentInformation!

ConsentInformation を取得しましす。

java-static Unit
loadAndShowConsentFormIfRequired(
    activity: Activity!,
    onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!
)

同意フォームを読み込み、getConsentStatusREQUIRED の場合、指定された Activity からすぐに表示します。

java-static Unit

ConsentForm を読み込みます。

java-static Unit
showPrivacyOptionsForm(
    activity: Activity!,
    onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!
)

getPrivacyOptionsRequirementStatusREQUIRED の場合、指定された Activity からプライバシー オプション フォームを表示します。

パブリック関数

getConsentInformation

java-static fun getConsentInformation(context: Context!): ConsentInformation!

ConsentInformation を取得しましす。

loadAndShowConsentFormIfRequired

java-static fun loadAndShowConsentFormIfRequired(
    activity: Activity!,
    onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!
): Unit

同意フォームを読み込み、getConsentStatusREQUIRED の場合、指定された Activity からすぐに表示します。

このメソッドが終了すると OnConsentFormDismissedListener を呼び出します。これは、次のいずれかの理由で発生する可能性があります。

  • ユーザーにフォームが表示され、ユーザーがオプションを選択してフォームを閉じる
  • フォームに
  • フォームの読み込みに失敗し、null 以外の FormError が返される
  • フォームが表示されず、null 以外の FormError が返される

このメソッドはメインスレッドで呼び出す必要があります。

パラメータ
activity: Activity!

同意フォームを表示するアクティビティ。

onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!

同意フォームが閉じられたときに呼び出されるリスナー。

loadConsentForm

java-static fun loadConsentForm(
    context: Context!,
    successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener!,
    failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener!
): Unit

ConsentForm を読み込みます。

このメソッドを呼び出す前に、isConsentFormAvailabletrue を返すことを確認します。

このメソッドはメインスレッドで呼び出す必要があります。

パラメータ
context: Context!

コンテキスト。

successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener!

同意フォームの読み込み成功リスナー。

failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener!

同意フォームの読み込みエラー リスナー。

showPrivacyOptionsForm

java-static fun showPrivacyOptionsForm(
    activity: Activity!,
    onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!
): Unit

getPrivacyOptionsRequirementStatusREQUIRED の場合、指定された Activity からプライバシー オプション フォームを表示します。

このメソッドは、プライバシー オプション フォームの表示をリクエストするユーザー入力に応答してのみ呼び出す必要があります。

プライバシー オプション フォームは、フォームが利用可能になると SDK によって自動的にプリロードされます。フォームがプリロードされていない場合、SDK は非同期でフォームを読み込もうとします。

OnConsentFormDismissedListener は、ユーザーにフォームが表示され、ユーザーがオプションを選択してフォームを閉じた後に呼び出されます。

OnConsentFormDismissedListener は、次のいずれかのエラー条件で、null 以外の FormError とともに、次の実行ループで非同期的に返されることもあります。

  • フォームを利用できない
  • フォームが表示されない
  • フォームがまだプリロード中である

このメソッドはメインスレッドで呼び出す必要があります。

パラメータ
activity: Activity!

プライバシー オプション フォームを表示するアクティビティ。

onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!

プライバシー オプション フォームが閉じられたときに呼び出されるリスナー。