UserMessagingPlatform

public final class UserMessagingPlatform


จุดแรกเข้าสําหรับ SDK สําหรับแพลตฟอร์มการรับส่งข้อความกับผู้ใช้

สรุป

ประเภทที่ซ้อนกัน

คําจํากัดความอินเทอร์เฟซสําหรับการเรียกใช้การเรียกกลับเมื่อโหลดแบบฟอร์มความยินยอมไม่สําเร็จ

คําจํากัดความอินเทอร์เฟซสําหรับการเรียกใช้การเรียกกลับเมื่อโหลดแบบฟอร์มความยินยอมสําเร็จ

เมธอดสาธารณะ

static ConsentInformation

รับ ConsentInformation

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

โหลดแบบฟอร์มความยินยอมและแสดงจาก Activity ที่ระบุทันทีหาก getConsentStatus เป็น REQUIRED

static void

โหลด ConsentForm

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

แสดงแบบฟอร์มตัวเลือกความเป็นส่วนตัวจาก Activity ที่ระบุ หาก getPrivacyOptionsRequirementStatus เป็น REQUIRED

เมธอดสาธารณะ

getConsentInformation

public static ConsentInformation getConsentInformation(Context context)

รับ ConsentInformation

loadAndShowConsentFormIfRequired

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

โหลดแบบฟอร์มความยินยอมและแสดงจาก Activity ที่ระบุทันทีหาก getConsentStatus เป็น REQUIRED

เรียก OnConsentFormDismissedListener เมื่อเมธอดนี้เสร็จสิ้น ซึ่งอาจเกิดขึ้นจากสาเหตุข้อใดข้อหนึ่งต่อไปนี้

  • ผู้ใช้เห็นแบบฟอร์ม เลือกตัวเลือก แล้วปิดแบบฟอร์ม
  • ไม่จำเป็นต้องแสดงแบบฟอร์ม
  • โหลดแบบฟอร์มไม่สำเร็จ โดยแสดงผล FormError ที่ไม่ใช่ค่า Null
  • แบบฟอร์มแสดงไม่สําเร็จ โดยแสดงผล FormError ที่ไม่ใช่ค่าว่าง

วิธีการนี้ต้องเรียกใช้ในเธรดหลัก

พารามิเตอร์
Activity activity

กิจกรรมที่แสดงแบบฟอร์มความยินยอม

ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener

Listener ที่เรียกใช้เมื่อปิดแบบฟอร์มความยินยอม

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
)

แสดงแบบฟอร์มตัวเลือกความเป็นส่วนตัวจาก Activity ที่ระบุ หาก getPrivacyOptionsRequirementStatus เป็น REQUIRED

ควรเรียกใช้เมธอดนี้เมื่อผู้ใช้ป้อนข้อมูลเพื่อขอให้แสดงแบบฟอร์มตัวเลือกความเป็นส่วนตัวเท่านั้น

SDK จะโหลดแบบฟอร์มตัวเลือกความเป็นส่วนตัวไว้ล่วงหน้าโดยอัตโนมัติเมื่อแบบฟอร์มพร้อมใช้งาน หากไม่ได้โหลดแบบฟอร์มไว้ล่วงหน้า SDK จะพยายามโหลดแบบฟอร์มแบบไม่พร้อมกัน

OnConsentFormDismissedListener จะเรียกใช้หลังจากที่ระบบแสดงแบบฟอร์มต่อผู้ใช้ ผู้ใช้เลือกตัวเลือก และปิดแบบฟอร์ม

OnConsentFormDismissedListener อาจแสดงผลแบบไม่พร้อมกันในลูปการเรียกใช้ถัดไปด้วย FormError ที่ไม่ใช่ค่า Null ภายใต้เงื่อนไขข้อผิดพลาดข้อใดข้อหนึ่งต่อไปนี้

  • แบบฟอร์มไม่พร้อมใช้งาน
  • แบบฟอร์มแสดงไม่สำเร็จ
  • ระบบยังคงโหลดแบบฟอร์มล่วงหน้าอยู่

วิธีการนี้ต้องเรียกใช้ในเธรดหลัก

พารามิเตอร์
Activity activity

กิจกรรมที่แสดงแบบฟอร์มตัวเลือกความเป็นส่วนตัว

ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener

Listener ที่ได้รับการเรียกใช้เมื่อปิดแบบฟอร์มตัวเลือกความเป็นส่วนตัว