UserMessagingPlatform

Kotlin |Java

class UserMessagingPlatform

---

User Messaging Platform SDK टूल का एंट्री पॉइंट.

खास जानकारी

नेस्ट किए गए टाइप
interface UserMessagingPlatform.OnConsentFormLoadFailureListener सहमति फ़ॉर्म लोड न होने पर, कॉलबैक को ट्रिगर करने के लिए इंटरफ़ेस की परिभाषा.
interface UserMessagingPlatform.OnConsentFormLoadSuccessListener सहमति फ़ॉर्म के लोड होने पर, कॉलबैक को ट्रिगर करने के लिए इंटरफ़ेस की परिभाषा.

सार्वजनिक फ़ंक्शन
java-static ConsentInformation!	getConsentInformation(context: Context!) ConsentInformation मिलता है.
java-static Unit	loadAndShowConsentFormIfRequired(     activity: Activity!,     onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener! ) सहमति फ़ॉर्म लोड करता है और अगर getConsentStatus REQUIRED है, तो उसे तुरंत दिए गए Activity से दिखाता है.
java-static Unit	loadConsentForm(     context: Context!,     successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener!,     failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener! ) ConsentForm लोड करता है.
java-static Unit	showPrivacyOptionsForm(     activity: Activity!,     onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener! ) अगर getPrivacyOptionsRequirementStatus REQUIRED है, तो दिए गए Activity से निजता के विकल्पों का फ़ॉर्म दिखाता है.

सार्वजनिक फ़ंक्शन

getConsentInformation

java-static fun getConsentInformation(context: Context!): ConsentInformation!

ConsentInformation मिलता है.

loadAndShowConsentFormIfRequired

java-static fun loadAndShowConsentFormIfRequired(
    activity: Activity!,
    onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!
): Unit

सहमति फ़ॉर्म लोड करता है और अगर getConsentStatus REQUIRED है, तो उसे तुरंत दिए गए Activity से दिखाता है.

यह तरीका पूरा होने पर, OnConsentFormDismissedListener को कॉल करता है. ऐसा इनमें से किसी एक वजह से हो सकता है:

• उपयोगकर्ता को फ़ॉर्म दिखता है, वह कोई विकल्प चुनता है, और फ़ॉर्म को खारिज कर देता है
• फ़ॉर्म दिखाना ज़रूरी नहीं है
• फ़ॉर्म लोड नहीं हो पाता और नॉन-नल FormError दिखाता है
• फ़ॉर्म नहीं दिखता है और नॉन-नल FormError दिखाता है

इस तरीके को मुख्य थ्रेड पर कॉल किया जाना चाहिए.

पैरामीटर
activity: Activity!	सहमति फ़ॉर्म दिखाने वाली गतिविधि.
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!	सहमति फ़ॉर्म खारिज किए जाने पर कॉल होने वाला लिसनर.

loadConsentForm

java-static fun loadConsentForm(
    context: Context!,
    successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener!,
    failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener!
): Unit

ConsentForm लोड करता है.

इस तरीके को कॉल करने से पहले, यह जांच करता है कि isConsentFormAvailable, true दिखाता है या नहीं.

इस तरीके को मुख्य थ्रेड पर कॉल किया जाना चाहिए.

पैरामीटर
context: Context!	कॉन्टेक्स्ट.
successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener!	सहमति फ़ॉर्म लोड होने की सूचना देने वाला लिसनर.
failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener!	सहमति फ़ॉर्म लोड न हो पाने की जानकारी देने वाला लिसनर.

showPrivacyOptionsForm

java-static fun showPrivacyOptionsForm(
    activity: Activity!,
    onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!
): Unit

अगर getPrivacyOptionsRequirementStatus REQUIRED है, तो दिए गए Activity से निजता के विकल्पों का फ़ॉर्म दिखाता है.

इस तरीके को सिर्फ़ तब इस्तेमाल किया जाना चाहिए, जब उपयोगकर्ता ने निजता के विकल्पों वाला फ़ॉर्म दिखाने का अनुरोध किया हो.

जब कोई फ़ॉर्म उपलब्ध होता है, तो SDK उसे अपने-आप पहले से लोड कर लेता है. अगर कोई फ़ॉर्म पहले से लोड नहीं किया गया है, तो SDK टूल, एक फ़ॉर्म को असिंक्रोनस तरीके से लोड करने की कोशिश करेगा.

OnConsentFormDismissedListener को तब कॉल किया जाता है, जब उपयोगकर्ता को कोई फ़ॉर्म दिखाया जाता है, वह कोई विकल्प चुनता है, और फ़ॉर्म को खारिज कर देता है.

OnConsentFormDismissedListener, गड़बड़ी की इनमें से किसी एक स्थिति में, अगले रन लूप पर असींक्रोनस तरीके से नॉन-नल FormError के साथ भी लौट सकता है:

• फ़ॉर्म उपलब्ध नहीं है
• फ़ॉर्म नहीं दिखता
• फ़ॉर्म अब भी पहले से लोड किया जा रहा है

इस तरीके को मुख्य थ्रेड पर कॉल किया जाना चाहिए.

पैरामीटर
activity: Activity!	निजता के विकल्पों वाला फ़ॉर्म दिखाने वाली गतिविधि.
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!	निजता विकल्पों का फ़ॉर्म खारिज किए जाने पर कॉल होने वाला लिसनर.