UserMessagingPlatform

Kotlin |Java

class UserMessagingPlatform

---

נקודת הכניסה ל-User Messaging Platform SDK.

סיכום

סוגי עץ
interface UserMessagingPlatform.OnConsentFormLoadFailureListener הגדרת ממשק לקריאה חוזרת (callback) שתופעל כשטופס ההסכמה לא נטען.
interface UserMessagingPlatform.OnConsentFormLoadSuccessListener הגדרת ממשק לקריאה חוזרת (callback) שתופעל כשטופס ההסכמה ייטען בהצלחה.

פונקציות ציבוריות
java-static ConsentInformation!	getConsentInformation(context: Context!) הפונקציה מקבלת את ConsentInformation.
java-static Unit	loadAndShowConsentFormIfRequired(     activity: Activity!,     onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener! ) המערכת טוענת טופס הסכמה ומציגה אותו באופן מיידי מה-Activity שצוין, אם הערך של getConsentStatus הוא REQUIRED.
java-static Unit	loadConsentForm(     context: Context!,     successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener!,     failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener! ) טעינת ConsentForm.
java-static Unit	showPrivacyOptionsForm(     activity: Activity!,     onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener! ) הצגת טופס של אפשרויות פרטיות מה-Activity שצוין, אם הערך של getPrivacyOptionsRequirementStatus הוא REQUIRED.

פונקציות ציבוריות

getConsentInformation

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

הפונקציה מקבלת את ConsentInformation.

loadAndShowConsentFormIfRequired

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

המערכת טוענת טופס הסכמה ומציגה אותו באופן מיידי מה-Activity שצוין, אם הערך של getConsentStatus הוא REQUIRED.

השיטה קורא ל-OnConsentFormDismissedListener כשהיא מסתיימת. הסיבה לכך יכולה להיות אחת מהסיבות הבאות:

• המשתמש מוצג הטופס, בוחר אפשרות וסוגר את הטופס
• הטופס לא חייב להופיע
• הטופס לא נטען ומוחזר FormError שאינו null
• הטופס לא מוצג ומוחזר FormError שאינו null

צריך להפעיל את השיטה הזו בשרשור הראשי.

פרמטרים
activity: Activity!	הפעילות שבה מוצג טופס ההסכמה.
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!	ה-listener שנקרא כשטופס ההסכמה נסגר.

loadConsentForm

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

טעינת ConsentForm.

לפני קריאה ל-method הזה, הבדיקה מוודאת ש-isConsentFormAvailable מחזיר את הערך true.

צריך להפעיל את השיטה הזו בשרשור הראשי.

פרמטרים
context: Context!	ההקשר.
successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener!	הקשיב לטעינה של טופס ההסכמה.
failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener!	הקשיב לכישלון בטעינת טופס ההסכמה.

showPrivacyOptionsForm

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

הצגת טופס של אפשרויות פרטיות מה-Activity שצוין, אם הערך של getPrivacyOptionsRequirementStatus הוא REQUIRED.

צריך להפעיל את השיטה הזו רק בתגובה להזנת משתמש שמבקשת להציג טופס של אפשרויות פרטיות.

ערכת ה-SDK טוענת מראש את טופס אפשרויות הפרטיות באופן אוטומטי כשהטופס הופך לזמין. אם לא נטען מראש טופס, ה-SDK ינסה לטעון טופס באופן אסינכררוני.

OnConsentFormDismissedListener נקראת אחרי שהמשתמש מוצג לו טופס, בוחר אפשרות וסוגר את הטופס.

OnConsentFormDismissedListener יכול גם לחזור באופן אסינכרוני בלול ההפעלה הבא עם FormError שאינו null באחת מתנאי השגיאה הבאים:

• הטופס לא זמין
• הטופס לא מוצג
• הטופס עדיין נטען מראש

צריך להפעיל את השיטה הזו בשרשור הראשי.

פרמטרים
activity: Activity!	הפעילות שבה מוצג טופס אפשרויות הפרטיות.
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!	ה-listener שנקרא כשהטופס של אפשרויות הפרטיות נסגר.