UserMessagingPlatform

Kotlin |Java

class UserMessagingPlatform

---

Titik entri untuk User Messaging Platform SDK.

Ringkasan

Jenis bertingkat
interface UserMessagingPlatform.OnConsentFormLoadFailureListener Definisi antarmuka untuk callback yang akan dipanggil saat formulir izin gagal dimuat.
interface UserMessagingPlatform.OnConsentFormLoadSuccessListener Definisi antarmuka untuk callback yang akan dipanggil saat formulir izin berhasil dimuat.

Fungsi publik
java-static ConsentInformation!	getConsentInformation(context: Context!) Mendapatkan ConsentInformation.
java-static Unit	loadAndShowConsentFormIfRequired(     activity: Activity!,     onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener! ) Memuat formulir izin dan langsung menampilkannya dari Activity yang disediakan jika getConsentStatus adalah REQUIRED.
java-static Unit	loadConsentForm(     context: Context!,     successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener!,     failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener! ) Memuat ConsentForm.
java-static Unit	showPrivacyOptionsForm(     activity: Activity!,     onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener! ) Menampilkan formulir opsi privasi dari Activity yang disediakan jika getPrivacyOptionsRequirementStatus adalah REQUIRED.

Fungsi publik

getConsentInformation

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

Mendapatkan ConsentInformation.

loadAndShowConsentFormIfRequired

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

Memuat formulir izin dan langsung menampilkannya dari Activity yang disediakan jika getConsentStatus adalah REQUIRED.

Memanggil OnConsentFormDismissedListener saat metode ini selesai, yang dapat terjadi karena salah satu hal berikut:

• pengguna melihat formulir, memilih opsi, dan menutup formulir
• formulir tidak wajib ditampilkan
• formulir gagal dimuat, menampilkan FormError non-null
• formulir gagal ditampilkan, menampilkan FormError non-null

Metode ini harus dipanggil di thread utama.

Parameter
activity: Activity!	Aktivitas yang menampilkan formulir izin.
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!	Pemroses yang dipanggil saat formulir izin ditutup.

loadConsentForm

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

Memuat ConsentForm.

Memeriksa apakah isConsentFormAvailable menampilkan true sebelum memanggil metode ini.

Metode ini harus dipanggil di thread utama.

Parameter
context: Context!	Konteks.
successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener!	Pemroses peristiwa sukses pemuatan formulir izin.
failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener!	Pemroses kegagalan pemuatan formulir izin.

showPrivacyOptionsForm

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

Menampilkan formulir opsi privasi dari Activity yang disediakan jika getPrivacyOptionsRequirementStatus adalah REQUIRED.

Metode ini hanya boleh dipanggil sebagai respons terhadap input pengguna untuk meminta formulir opsi privasi ditampilkan.

Formulir opsi privasi dimuat otomatis oleh SDK saat formulir tersedia. Jika tidak ada formulir yang telah dimuat sebelumnya, SDK akan mencoba memuat formulir secara asinkron.

OnConsentFormDismissedListener dipanggil setelah pengguna melihat formulir, memilih opsi, dan menutup formulir.

OnConsentFormDismissedListener juga dapat ditampilkan secara asinkron pada loop run berikutnya dengan FormError non-null dalam salah satu kondisi error berikut:

• formulir tidak tersedia
• formulir gagal ditampilkan
• formulir masih dimuat sebelumnya

Metode ini harus dipanggil di thread utama.

Parameter
activity: Activity!	Aktivitas yang menampilkan formulir opsi privasi.
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!	Pemroses yang dipanggil saat formulir opsi privasi ditutup.