ConsentInformation

Kotlin |Java

public interface ConsentInformation

---

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

ملخّص

الأنواع المتداخلة
@Retention(value = SOURCE) @IntDef(value = [ConsentStatus.UNKNOWN, ConsentStatus.NOT_REQUIRED, ConsentStatus.REQUIRED, ConsentStatus.OBTAINED]) public annotation ConsentInformation.ConsentStatus قيم حالة الموافقة
public interface ConsentInformation.OnConsentInfoUpdateFailureListener تعريف واجهة للرجوع إليها عند تعذُّر تعديل معلومات الموافقة
public interface ConsentInformation.OnConsentInfoUpdateSuccessListener تعريف واجهة لردّ الاتصال الذي سيتمّ استدعاؤه عند تعديل معلومات الموافقة بنجاح.
public enum ConsentInformation.PrivacyOptionsRequirementStatus حالة متطلبات خيارات الخصوصية

الطرق العامة
abstract boolean	canRequestAds() تشير هذه السمة إلى ما إذا كانت حزمة تطوير البرامج (SDK) قد جمعت موافقة متوافقة مع الرسائل التي تم ضبطها في التطبيق.
abstract int	@ConsentInformation.ConsentStatus getConsentStatus() الحصول على حالة الموافقة الحالية
abstract ConsentInformation.PrivacyOptionsRequirementStatus	getPrivacyOptionsRequirementStatus() تحصل على الحالة التي تشير إلى ما إذا كان زر خيارات الخصوصية مطلوبًا.
abstract boolean	isConsentFormAvailable() تعرِض هذه الدالة القيمة true إذا كانت القيمة ConsentForm متاحة، وتعرض القيمة false في حال عدم توفّر القيمة ConsentForm.
abstract void	requestConsentInfoUpdate(     Activity activity,     ConsentRequestParameters consentRequestParameters,     ConsentInformation.OnConsentInfoUpdateSuccessListener successListener,     ConsentInformation.OnConsentInfoUpdateFailureListener failureListener ) طلب تعديل معلومات الموافقة
abstract void	reset() تؤدي إلى إعادة ضبط ConsentInformation على الحالة المُنشأة.

الطرق العامة

canRequestAds

abstract boolean canRequestAds()

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

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

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

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

getConsentStatus

@ConsentInformation.ConsentStatus
abstract int getConsentStatus()

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

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

getPrivacyOptionsRequirementStatus

abstract ConsentInformation.PrivacyOptionsRequirementStatus getPrivacyOptionsRequirementStatus()

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

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

isConsentFormAvailable

abstract boolean isConsentFormAvailable()

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

requestConsentInfoUpdate

abstract void requestConsentInfoUpdate(
    Activity activity,
    ConsentRequestParameters consentRequestParameters,
    ConsentInformation.OnConsentInfoUpdateSuccessListener successListener,
    ConsentInformation.OnConsentInfoUpdateFailureListener failureListener
)

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

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

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

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

المعلمات
Activity activity	النشاط المستخدَم لجمع لقطات الشاشة
ConsentRequestParameters consentRequestParameters	مَعلمات الطلب.
ConsentInformation.OnConsentInfoUpdateSuccessListener successListener	مستمع نجاح طلب الموافقة
ConsentInformation.OnConsentInfoUpdateFailureListener failureListener	مستمع تعذُّر طلب الموافقة

إعادة ضبط

abstract void reset()

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