UserMessagingPlatform

Kotlin |Java

public final class UserMessagingPlatform

---

Einstiegspunkt für das User Messaging Platform SDK.

Zusammenfassung

Verschachtelte Typen
public interface UserMessagingPlatform.OnConsentFormLoadFailureListener Schnittstellendefinition für einen Rückruf, der aufgerufen wird, wenn ein Einwilligungsformular nicht geladen werden konnte.
public interface UserMessagingPlatform.OnConsentFormLoadSuccessListener Schnittstellendefinition für einen Callback, der aufgerufen wird, wenn ein Einwilligungsformular erfolgreich geladen wurde.

Öffentliche Methoden
static ConsentInformation	getConsentInformation(Context context) Gets the ConsentInformation.
static void	loadAndShowConsentFormIfRequired(     Activity activity,     ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener ) Es wird ein Einwilligungsformular geladen und sofort über die angegebene Activity angezeigt, wenn getConsentStatus REQUIRED ist.
static void	loadConsentForm(     Context context,     UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener,     UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener ) Lädt einen ConsentForm.
static void	showPrivacyOptionsForm(     Activity activity,     ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener ) Wenn getPrivacyOptionsRequirementStatus = REQUIRED ist, wird ein Formular mit Datenschutzoptionen aus dem angegebenen Activity angezeigt.

Öffentliche Methoden

getConsentInformation

public static ConsentInformation getConsentInformation(Context context)

Gets the ConsentInformation.

loadAndShowConsentFormIfRequired

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

Es wird ein Einwilligungsformular geladen und sofort über die angegebene Activity angezeigt, wenn getConsentStatus REQUIRED ist.

Ruft OnConsentFormDismissedListener auf, wenn diese Methode beendet ist. Das kann aus einem der folgenden Gründe passieren:

• dem Nutzer das Formular angezeigt wird, er eine Option auswählt und das Formular schließt
• das Formular nicht angezeigt werden muss
• das Formular nicht geladen wird und eine nicht nullwertige FormError zurückgegeben wird
• das Formular nicht angezeigt wird und ein nicht nullwertiger Wert für FormError zurückgegeben wird

Diese Methode muss im Hauptthread aufgerufen werden.

Parameter
Activity activity	Die Aktivität, bei der das Einwilligungsformular angezeigt wird.
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener	Der Listener, der aufgerufen wird, wenn das Einwilligungsformular geschlossen wird.

loadConsentForm

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

Lädt einen ConsentForm.

Prüft, ob isConsentFormAvailable true zurückgibt, bevor diese Methode aufgerufen wird.

Diese Methode muss im Hauptthread aufgerufen werden.

Parameter
Context context	Der Kontext.
UserMessagingPlatform.OnConsentFormLoadSuccessListener successListener	Der Listener für den erfolgreichen Ladevorgang des Einwilligungsformulars.
UserMessagingPlatform.OnConsentFormLoadFailureListener failureListener	Der Listener für das Laden des Einwilligungsformulars ist fehlgeschlagen.

showPrivacyOptionsForm

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

Wenn getPrivacyOptionsRequirementStatus = REQUIRED ist, wird ein Formular mit Datenschutzoptionen aus dem angegebenen Activity angezeigt.

Diese Methode sollte nur als Reaktion auf eine Nutzereingabe aufgerufen werden, um ein Formular mit Datenschutzoptionen anzufordern.

Das Formular mit den Datenschutzoptionen wird vom SDK automatisch vorab geladen, sobald ein Formular verfügbar ist. Wenn kein Formular vorab geladen wurde, versucht das SDK, es asynchron zu laden.

OnConsentFormDismissedListener wird aufgerufen, nachdem dem Nutzer ein Formular angezeigt wurde, er eine Option ausgewählt und das Formular geschlossen hat.

OnConsentFormDismissedListener kann auch bei einer der folgenden Fehlerbedingungen asynchron in der nächsten Ausführungsschleife mit einem nicht nullwertigen FormError zurückgegeben werden:

• das Formular nicht verfügbar ist
• das Formular nicht angezeigt wird.
• das Formular wird noch vorab geladen

Diese Methode muss im Hauptthread aufgerufen werden.

Parameter
Activity activity	Die Aktivität, bei der das Formular mit den Datenschutzoptionen angezeigt wird.
ConsentForm.OnConsentFormDismissedListener onConsentFormDismissedListener	Der Listener, der aufgerufen wird, wenn das Formular mit den Datenschutzoptionen geschlossen wird.