UserMessaging Platform

کاتلین | جاوا

public final class UserMessagingPlatform

---

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

خلاصه

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

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

روش های عمومی

getConsentInformation

public static ConsentInformation getConsentInformation(Context context)

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

loadAndShowConsentFormIfRequired

public static void loadAndShowConsentFormIfRequired(
    Activity activity,
    ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener
)

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

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

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

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

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

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

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

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

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

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