ConsentInformation

interface ConsentInformation

طرق مساعدة لجمع الموافقات من المستخدمين

ملخّص

الأنواع المتداخلة
@Retention(value = SOURCE)
@IntDef(value = [ConsentStatus.UNKNOWN, ConsentStatus.NOT_REQUIRED, ConsentStatus.REQUIRED, ConsentStatus.OBTAINED])
annotation ConsentInformation.ConsentStatus

قيم حالة الموافقة

تعريف واجهة للرجوع إليها عند تعذُّر تعديل معلومات الموافقة

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

حالة متطلبات خيارات الخصوصية

الوظائف العامة
Boolean

تشير هذه السمة إلى ما إذا كانت حزمة تطوير البرامج (SDK) قد جمعت موافقة متوافقة مع الرسائل التي تم ضبطها في التطبيق.
Int

الحصول على حالة الموافقة الحالية
ConsentInformation.PrivacyOptionsRequirementStatus!

تحصل على الحالة التي تشير إلى ما إذا كان زر خيارات الخصوصية مطلوبًا.
Boolean

تعرِض هذه الدالة القيمة true إذا كانت القيمة ConsentForm متاحة، وتعرض القيمة false في حال عدم توفّر القيمة ConsentForm.
Unit
requestConsentInfoUpdate(
    activity: Activity!,
    consentRequestParameters: ConsentRequestParameters!,
    successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!,
    failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!
)

طلب تعديل معلومات الموافقة
Unit

تؤدي إلى إعادة ضبط ConsentInformation على الحالة المُنشأة.

الوظائف العامة

canRequestAds

fun canRequestAds(): Boolean

تشير هذه السمة إلى ما إذا كانت حزمة تطوير البرامج (SDK) قد جمعت موافقة متوافقة مع الرسائل التي تم ضبطها في التطبيق.

تعرض هذه الطريقة القيمة false إلى أن يتم استدعاء requestConsentInfoUpdate.

بعد استدعاء requestConsentInfoUpdate، تُرجع هذه الطريقة true عندما تُرجع getConsentStatus NOT_REQUIRED أو OBTAINED.

المرتجعات
Boolean

صحيح إذا جمعت حزمة تطوير البرامج (SDK) موافقة متوافقة مع الرسائل التي تم ضبطها في التطبيق.

getConsentStatus

@ConsentInformation.ConsentStatus
fun getConsentStatus(): Int

الحصول على حالة الموافقة الحالية

المرتجعات
Int

UNKNOWN إلى أن يتم استدعاء requestConsentInfoUpdate، ويتم ضبطه تلقائيًا على قيمة الجلسة السابقة إلى أن تكتمل requestConsentInfoUpdate بنجاح ويتم استدعاء OnConsentInfoUpdateSuccessListener.

getPrivacyOptionsRequirementStatus

fun getPrivacyOptionsRequirementStatus(): ConsentInformation.PrivacyOptionsRequirementStatus!

تحصل على الحالة التي تشير إلى ما إذا كان زر خيارات الخصوصية مطلوبًا.

المرتجعات
ConsentInformation.PrivacyOptionsRequirementStatus!

UNKNOWN إلى أن يتم استدعاء requestConsentInfoUpdate، ويتم ضبطه تلقائيًا على قيمة الجلسة السابقة إلى أن تكتمل requestConsentInfoUpdate بنجاح ويتم استدعاء.

isConsentFormAvailable

fun isConsentFormAvailable(): Boolean

تعرِض هذه الدالة القيمة true إذا كانت القيمة ConsentForm متاحة، وتعرض القيمة false في حال عدم توفّر القيمة ConsentForm.

requestConsentInfoUpdate

fun requestConsentInfoUpdate(
    activity: Activity!,
    consentRequestParameters: ConsentRequestParameters!,
    successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!,
    failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!
): Unit

طلب تعديل معلومات الموافقة

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

بعد استدعاء واجهة برمجة التطبيقات هذه، سيتم تعديل القيمة التي تعرضها واجهة برمجة التطبيقات getConsentStatus بشكل متزامن للاحتفاظ بحالة الموافقة من جلسة التطبيق السابقة، في حال توفّرت.

قد يتم تعديل getConsentStatus مرة أخرى إلى الحالة المحدّثة بعد استدعاء.

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

النشاط المستخدَم لجمع لقطات الشاشة
consentRequestParameters: ConsentRequestParameters!

مَعلمات الطلب.
successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!

مستمع نجاح طلب الموافقة
failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!

مستمع تعذُّر طلب الموافقة

إعادة ضبط

fun reset(): Unit

تؤدي إلى إعادة ضبط ConsentInformation على الحالة المُنشأة. يجب استخدام هذا الإجراء لتصحيح الأخطاء فقط.