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

अगर ConsentForm उपलब्ध है, तो true दिखाता है. अगर ConsentForm उपलब्ध नहीं है, तो false दिखाता है.

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

अगर ConsentForm उपलब्ध है, तो true दिखाता है. अगर ConsentForm उपलब्ध नहीं है, तो false दिखाता है.

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 को शुरू की गई स्थिति पर रीसेट करता है. इसका इस्तेमाल सिर्फ़ डीबग करने के लिए किया जाना चाहिए.