UserMessagingPlatform
public final class UserMessagingPlatform
Punkt wejścia do pakietu SDK platformy do personalizowania wiadomości wyświetlanych użytkownikom.
Podsumowanie
Typy zagnieżdżone |
|---|
public interface UserMessagingPlatform.OnConsentFormLoadFailureListenerDefinicja interfejsu wywołania zwrotnego, które ma być wywoływane, gdy nie uda się wczytać formularza zgody. |
public interface UserMessagingPlatform.OnConsentFormLoadSuccessListenerDefinicja interfejsu wywołania zwrotnego, które ma być wywoływane po pomyślnym załadowaniu formularza zgody. |
Metody publiczne |
|
|---|---|
static ConsentInformation |
getConsentInformation(Context context)Pobiera |
static void |
loadAndShowConsentFormIfRequired(Ładuje formularz zgody i natychmiast wyświetla go z podanych danych |
static void |
loadConsentForm(Ładuje |
static void |
showPrivacyOptionsForm(Wyświetla formularz opcji prywatności z podanego |
Metody publiczne
getConsentInformation
public static ConsentInformation getConsentInformation(Context context)
Pobiera ConsentInformation.
loadAndShowConsentFormIfRequired
public static void loadAndShowConsentFormIfRequired(
Activity activity,
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener
)
Ładuje formularz zgody i natychmiast wyświetla go z podanego 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. |
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener |
Listener, który jest wywoływany, gdy formularz zgody zostanie zamknięty. |
loadConsentForm
public static void loadConsentForm(
Context context,
UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener,
UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener
)
Ł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. |
UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener |
Detektor zdarzenia powodzenia dotyczącego załadowania formularza zgody. |
UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener |
Listener dotyczący nieudanego wczytania formularza zgody. |
showPrivacyOptionsForm
public static void showPrivacyOptionsForm(
Activity activity,
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener
)
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 nie zostało wstępnie załadowane żadnego formularza, 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. |
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener |
Listener, który jest wywoływany, gdy użytkownik zamknie formularz opcji prywatności. |