UserMessagingPlatform

Kotlin |Java

public final class UserMessagingPlatform

---

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

खास जानकारी

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

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

सार्वजनिक तरीके

getConsentInformation

public static ConsentInformation getConsentInformation(Context context)

ConsentInformation मिलता है.

loadAndShowConsentFormIfRequired

public static void loadAndShowConsentFormIfRequired(
    Activity activity,
    ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener
)

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

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

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

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

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

loadConsentForm

public static void loadConsentForm(
    Context context,
    UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener,
    UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener
)

ConsentForm लोड करता है.

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

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

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

showPrivacyOptionsForm

public static void showPrivacyOptionsForm(
    Activity activity,
    ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener
)

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

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

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

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

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

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

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

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