UserMessagingPlatform

Kotlin |Java

class UserMessagingPlatform

---

Punkt wejścia do pakietu SDK platformy do personalizowania wiadomości wyświetlanych użytkownikom.

Podsumowanie

Typy zagnieżdżone
interface UserMessagingPlatform.OnConsentFormLoadFailureListener Definicja interfejsu wywołania zwrotnego, które ma być wywoływane, gdy nie uda się wczytać formularza zgody.
interface UserMessagingPlatform.OnConsentFormLoadSuccessListener Definicja interfejsu wywołania zwrotnego, które ma być wywoływane po pomyślnym załadowaniu formularza zgody.

Funkcje publiczne
java-static ConsentInformation!	getConsentInformation(context: Context!) Pobiera ConsentInformation.
java-static Unit	loadAndShowConsentFormIfRequired(     activity: Activity!,     onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener! ) Ładuje formularz zgody i natychmiast wyświetla go z podanych danych Activity, jeśli getConsentStatus to REQUIRED.
java-static Unit	loadConsentForm(     context: Context!,     successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener!,     failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener! ) Ładuje ConsentForm.
java-static Unit	showPrivacyOptionsForm(     activity: Activity!,     onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener! ) Wyświetla formularz opcji prywatności z podanego Activity, jeśli getPrivacyOptionsRequirementStatus to REQUIRED.

Funkcje publiczne

getConsentInformation

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

Pobiera ConsentInformation.

loadAndShowConsentFormIfRequired

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

Ładuje formularz zgody i natychmiast wyświetla go z podanych danych Activity, jeśli getConsentStatus to REQUIRED.

Wywołuje OnConsentFormDismissedListener po zakończeniu tej metody, co może nastąpić z jednego z tych powodów:

• użytkownikowi wyświetla się formularz, wybiera opcję i zamyka formularz.
• formularz nie jest wymagany do wyświetlenia;
• formularz nie wczytuje się i zwraca wartość inną niż null FormError
• formularz nie wyświetla się i zwraca wartość inną niż null FormError

Ta metoda musi być wywoływana w wątku głównym.

Parametry
activity: Activity!	Aktywność pokazująca formularz zgody.
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!	Listener, który jest wywoływany, gdy formularz zgody zostanie zamknięty.

loadConsentForm

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

Ładuje ConsentForm.

Przed wywołaniem tej metody sprawdza, czy isConsentFormAvailable zwraca wartość true.

Ta metoda musi być wywoływana w wątku głównym.

Parametry
context: Context!	Kontekst.
successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener!	Detektor zdarzenia „consent form load success”.
failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener!	Listener dotyczący nieudanego wczytania formularza zgody.

showPrivacyOptionsForm

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

Wyświetla formularz opcji prywatności z podanego Activity, jeśli getPrivacyOptionsRequirementStatus to REQUIRED.

Ta metoda powinna być wywoływana tylko w odpowiedzi na dane wejściowe użytkownika, które wskazują na potrzebę wyświetlenia formularza z opcjami dotyczącymi prywatności.

Gdy formularz stanie się dostępny, pakiet SDK automatycznie go wstępnie załaduje. Jeśli żaden formularz nie został wstępnie załadowany, pakiet SDK spróbuje załadować formularz asynchronicznie.

OnConsentFormDismissedListener jest wywoływany po wyświetleniu użytkownikowi formularza, wybraniu przez niego opcji i zamknięciu formularza.

OnConsentFormDismissedListener może też powrócić asynchronicznie w ramach następnego cyklu wykonywania z wartością FormError inną niż null, gdy wystąpi jeden z tych warunków błędu:

• formularz jest niedostępny,
• formularz się nie wyświetla;
• formularz jest nadal wczytywany,

Ta metoda musi być wywoływana w wątku głównym.

Parametry
activity: Activity!	Aktywność pokazująca formularz z opcjami dotyczącymi prywatności.
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!	Listener, który jest wywoływany, gdy użytkownik zamknie formularz opcji prywatności.