UserMessagingPlatform
public final class UserMessagingPlatform
نقطة دخول حزمة تطوير البرامج (SDK) لمنصّة User Messaging Platform
ملخّص
الأنواع المتداخلة |
|---|
public interface UserMessagingPlatform.OnConsentFormLoadFailureListenerتعريف واجهة لطلب استدعاء يتمّ تنفيذه عند تعذّر تحميل نموذج موافقة. |
public interface UserMessagingPlatform.OnConsentFormLoadSuccessListenerتعريف واجهة لطلب استدعاء يتمّ تنفيذه عند تحميل نموذج موافقة بنجاح. |
الطرق العامة |
|
|---|---|
static ConsentInformation |
getConsentInformation(Context context)الحصول على |
static void |
loadAndShowConsentFormIfRequired(تحمِّل هذه السمة نموذج موافقة وتعرضه على الفور من |
static void |
loadConsentForm(تحميل |
static void |
showPrivacyOptionsForm(تعرِض هذه السمة نموذج خيارات الخصوصية من |
الطرق العامة
getConsentInformation
public static ConsentInformation getConsentInformation(Context context)
الحصول على ConsentInformation
loadAndShowConsentFormIfRequired
public static void loadAndShowConsentFormIfRequired(
Activity activity,
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener
)
تحمِّل هذه السمة نموذج موافقة وتعرضه على الفور من Activity المقدَّمة إذا كان getConsentStatus يساوي REQUIRED.
تتصل OnConsentFormDismissedListener عند انتهاء هذه الطريقة، وقد يحدث ذلك لأحد الأسباب التالية:
- يتم عرض النموذج على المستخدم الذي يختار أحد الخيارات ويغلق النموذج.
- النموذج غير مطلوب عرضه
- تعذّر تحميل النموذج، ما يؤدي إلى عرض قيمة غير فارغة لسمة
FormError - تعذُّر عرض النموذج، ما يؤدي إلى عرض
FormErrorغير فارغ.
يجب استدعاء هذه الطريقة في سلسلة التعليمات الرئيسية.
| المعلمات | |
|---|---|
Activity activity |
النشاط الذي يعرض نموذج الموافقة |
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener |
أداة الاستماع التي يتمّ استدعاؤها عند إغلاق نموذج الموافقة. |
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 غير صفري في إحدى حالات الخطأ التالية:
- النموذج غير متاح
- تعذُّر عرض النموذج
- لا يزال النموذج قيد التحميل المُسبَق.
يجب استدعاء هذه الطريقة في سلسلة التعليمات الرئيسية.
| المعلمات | |
|---|---|
Activity activity |
النشاط الذي يعرض نموذج خيارات الخصوصية |
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener |
أداة المعالجة التي يتمّ استدعاؤها عند إغلاق نموذج خيارات الخصوصية. |