UserMessagingPlatform

Kotlin |Java

public final class UserMessagingPlatform

---

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

סיכום

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

שיטות ציבוריות
static ConsentInformation	getConsentInformation(Context context) הפונקציה מקבלת את ConsentInformation.
static void	loadAndShowConsentFormIfRequired(     Activity activity,     ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener ) המערכת טוענת טופס הסכמה ומציגה אותו באופן מיידי מה-Activity שצוין, אם הערך של getConsentStatus הוא REQUIRED.
static void	loadConsentForm(     Context context,     UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener,     UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener ) טעינת 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 שאינו null

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

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

loadConsentForm

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

טעינת ConsentForm.

לפני קריאה ל-method הזה, הבדיקה מוודאת ש-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 שנקרא כשהטופס של אפשרויות הפרטיות נסגר.