ConsentInformation

Kotlin |Java

interface ConsentInformation

---

שיטות שירות לאיסוף הסכמה מהמשתמשים.

סיכום

סוגי עץ
@Retention(value = SOURCE) @IntDef(value = [ConsentStatus.UNKNOWN, ConsentStatus.NOT_REQUIRED, ConsentStatus.REQUIRED, ConsentStatus.OBTAINED]) annotation ConsentInformation.ConsentStatus ערכים של סטטוס הסכמה.
interface ConsentInformation.OnConsentInfoUpdateFailureListener הגדרת ממשק להפעלת קריאה חוזרת (callback) כשלא ניתן לעדכן את פרטי ההסכמה.
interface ConsentInformation.OnConsentInfoUpdateSuccessListener הגדרת ממשק לקריאה חוזרת (callback) שתופעל כשפרטי ההסכמה יתעדכנו בהצלחה.
enum ConsentInformation.PrivacyOptionsRequirementStatus סטטוס הדרישה של אפשרויות הפרטיות.

פונקציות ציבוריות
Boolean	canRequestAds() הסטטוס הזה מציין אם ה-SDK אסף הסכמה בהתאם להודעות שהוגדרו באפליקציה.
Int	@ConsentInformation.ConsentStatus getConsentStatus() אחזור סטטוס ההסכמה הנוכחי.
ConsentInformation.PrivacyOptionsRequirementStatus!	getPrivacyOptionsRequirementStatus() הפונקציה מקבלת את הסטטוס שמציין אם נדרש לחצן של אפשרויות פרטיות.
Boolean	isConsentFormAvailable() הפונקציה מחזירה את הערך true אם יש ConsentForm זמין, ואת הערך false אם לא.
Unit	requestConsentInfoUpdate(     activity: Activity!,     consentRequestParameters: ConsentRequestParameters!,     successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!,     failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener! ) בקשה לעדכון פרטי ההסכמה.
Unit	reset() איפוס ConsentInformation לסטטוס מופעל.

פונקציות ציבוריות

canRequestAds

fun canRequestAds(): Boolean

הסטטוס הזה מציין אם ה-SDK אסף הסכמה בהתאם להודעות שהוגדרו באפליקציה.

השיטה הזו מחזירה את הערך false עד שמפעילים את requestConsentInfoUpdate.

אחרי שמפעילים את requestConsentInfoUpdate, השיטה הזו מחזירה את הערך true כשהערך שמוחזר על ידי getConsentStatus הוא NOT_REQUIRED או OBTAINED.

החזרות
Boolean	הערך true אם ה-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 אם לא.

requestConsentInfoUpdate

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

בקשה לעדכון פרטי ההסכמה.

חובה לבצע קריאה ל-API הזה בכל סשן של האפליקציה לפני שמפעילים את getConsentStatus.

אחרי הקריאה ל-API הזה, ערך ההחזרה של ה-API getConsentStatus יתעדכן באופן סינכרוני כדי להכיל את סטטוס ההסכמה מהסשן הקודם באפליקציה, אם קיים כזה.

ייתכן ש-getConsentStatus יתעדכן שוב לסטטוס העדכני אחרי הקריאה ל-.

פרמטרים
activity: Activity!	הפעילות שמשמשת לאיסוף קטעי מסך.
consentRequestParameters: ConsentRequestParameters!	הפרמטרים של הבקשה.
successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!	הקשבת האירוע של הצלחת בקשת ההסכמה.
failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!	הקשבת לכשלים בבקשות להסכמה.

אפס

fun reset(): Unit

איפוס ConsentInformation לסטטוס מופעל. יש להשתמש באפשרות הזו רק לצורך ניפוי באגים.