UserMessaging Platform

کاتلین | جاوا

class UserMessagingPlatform

---

نقطه ورود برای SDK بستر پیام‌رسانی کاربر.

خلاصه

انواع تو در تو
interface UserMessagingPlatform.OnConsentFormLoadFailureListener تعریف واسط برای فراخوانی مجدد زمانی که فرم رضایت بارگیری نشد.
interface UserMessagingPlatform.OnConsentFormLoadSuccessListener تعریف واسط برای فراخوانی تماس پس از بارگیری موفقیت آمیز فرم رضایت.

توابع عمومی
java-static ConsentInformation !	getConsentInformation (context: Context !) ConsentInformation را دریافت می کند.
java-static Unit	loadAndShowConsentFormIfRequired ( activity: Activity !, onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener ! ) اگر getConsentStatus REQUIRED است، فرم رضایت را بارگیری می‌کند و فوراً آن را از Activity ارائه‌شده نشان می‌دهد.
java-static Unit	loadConsentForm ( context: Context !, successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener !, failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener ! ) یک ConsentForm بارگیری می شود.
java-static Unit	showPrivacyOptionsForm ( activity: Activity !, onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener ! ) اگر getPrivacyOptionsRequirementStatus REQUIRED باشد، یک فرم گزینه های حریم خصوصی را از Activity ارائه شده ارائه می دهد.

توابع عمومی

getConsentInformation

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

ConsentInformation را دریافت می کند.

loadAndShowConsentFormIfRequired

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

اگر getConsentStatus REQUIRED است، فرم رضایت را بارگیری می‌کند و فوراً آن را از Activity ارائه‌شده نشان می‌دهد.

هنگامی که این روش تمام می شود، 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

اگر getPrivacyOptionsRequirementStatus REQUIRED باشد، یک فرم گزینه های حریم خصوصی را از Activity ارائه شده ارائه می دهد.

این روش فقط باید در پاسخ به ورودی کاربر برای درخواست فرم گزینه های حریم خصوصی برای نمایش فراخوانی شود.

هنگامی که فرمی در دسترس قرار می گیرد، فرم گزینه های حریم خصوصی توسط SDK به طور خودکار بارگیری می شود. اگر هیچ فرمی از قبل بارگیری نشده باشد، SDK سعی می کند یکی را به صورت ناهمزمان بارگیری کند.

OnConsentFormDismissedListener پس از ارائه فرم به کاربر، انتخاب یک گزینه و رد کردن فرم فراخوانی می شود.

OnConsentFormDismissedListener همچنین ممکن است به صورت ناهمزمان در حلقه اجرای بعدی با یک FormError غیر تهی تحت یکی از شرایط خطای زیر برگردد:

• فرم موجود نیست
• فرم نمایش داده نمی شود
• فرم هنوز از قبل در حال بارگذاری است

این متد باید در رشته اصلی فراخوانی شود.

پارامترها
activity: Activity !	فعالیتی که گزینه‌های حریم خصوصی را نشان می‌دهد.
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener !	شنونده ای که وقتی فرم گزینه های حریم خصوصی رد می شود، فراخوانی می شود.