UserMessagingPlatform

Kotlin |Java

public final class UserMessagingPlatform

---

Titik entri untuk User Messaging Platform SDK.

Ringkasan

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

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

Metode publik

getConsentInformation

public static ConsentInformation getConsentInformation(Context context)

Mendapatkan ConsentInformation.

loadAndShowConsentFormIfRequired

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

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.
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener	Pemroses yang dipanggil saat formulir izin ditutup.

loadConsentForm

public static void loadConsentForm(
    Context context,
    UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener,
    UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener
)

Memuat ConsentForm.

Memeriksa apakah isConsentFormAvailable menampilkan true sebelum memanggil metode ini.

Metode ini harus dipanggil di thread utama.

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

showPrivacyOptionsForm

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

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.
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener	Pemroses yang dipanggil saat formulir opsi privasi ditutup.