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 הגדרת ממשק להפעלת קריאה חוזרת (callback) כשלא ניתן לעדכן את פרטי ההסכמה.
public interface ConsentInformation.OnConsentInfoUpdateSuccessListener הגדרת ממשק לקריאה חוזרת (callback) שתופעל כשפרטי ההסכמה יתעדכנו בהצלחה.
public enum ConsentInformation.PrivacyOptionsRequirementStatus סטטוס הדרישה של אפשרויות הפרטיות.

שיטות ציבוריות
abstract boolean	canRequestAds() הסטטוס הזה מציין אם ה-SDK אסף הסכמה בהתאם להודעות שהוגדרו באפליקציה.
abstract int	@ConsentInformation.ConsentStatus getConsentStatus() אחזור סטטוס ההסכמה הנוכחי.
abstract ConsentInformation.PrivacyOptionsRequirementStatus	getPrivacyOptionsRequirementStatus() הפונקציה מקבלת את הסטטוס שמציין אם נדרש לחצן של אפשרויות פרטיות.
abstract boolean	isConsentFormAvailable() הפונקציה מחזירה את הערך true אם יש ConsentForm זמין, ואת הערך false אם לא.
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	הערך true אם ה-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 אם לא.

requestConsentInfoUpdate

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

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

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

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

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

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

אפס

abstract void reset()

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