UserMessagingPlatform

class UserMessagingPlatform

نقطة دخول حزمة تطوير البرامج (SDK) لمنصّة User Messaging Platform

ملخّص

الأنواع المتداخلة

تعريف واجهة لطلب استدعاء يتمّ تنفيذه عند تعذّر تحميل نموذج موافقة.

تعريف واجهة لطلب استدعاء يتمّ تنفيذه عند تحميل نموذج موافقة بنجاح.

الوظائف العامة
java-static ConsentInformation!

الحصول على ConsentInformation
java-static Unit
loadAndShowConsentFormIfRequired(
    activity: Activity!,
    onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!
)

تحمِّل هذه السمة نموذج موافقة وتعرضه على الفور من Activity المقدَّمة إذا كان getConsentStatus يساوي REQUIRED.
java-static Unit

تحميل 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
  • تعذُّر عرض النموذج، ما يؤدي إلى عرض FormError غير فارغ.

يجب استدعاء هذه الطريقة في سلسلة التعليمات الرئيسية.

المعلمات
activity: Activity!

النشاط الذي يعرض نموذج الموافقة
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!

أداة الاستماع التي يتمّ استدعاؤها عند إغلاق نموذج الموافقة.

loadConsentForm

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

تحميل ConsentForm

تتحقّق من أنّ 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 غير صفري في إحدى حالات الخطأ التالية:

  • النموذج غير متاح
  • تعذُّر عرض النموذج
  • لا يزال النموذج قيد التحميل المُسبَق.

يجب استدعاء هذه الطريقة في سلسلة التعليمات الرئيسية.

المعلمات
activity: Activity!

النشاط الذي يعرض نموذج خيارات الخصوصية
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!

أداة المعالجة التي يتمّ استدعاؤها عند إغلاق نموذج خيارات الخصوصية.