UserMessagingPlatform

Kotlin |Java

class UserMessagingPlatform

---

Einstiegspunkt für das User Messaging Platform SDK.

Zusammenfassung

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

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

Öffentliche Funktionen

getConsentInformation

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

Gets the ConsentInformation.

loadAndShowConsentFormIfRequired

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

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.
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!	Der Listener, der aufgerufen wird, wenn das Einwilligungsformular geschlossen wird.

loadConsentForm

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

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.
successListener: UserMessagingPlatform.OnConsentFormLoadSuccessListener!	Der Listener für den erfolgreichen Ladevorgang des Einwilligungsformulars.
failureListener: UserMessagingPlatform.OnConsentFormLoadFailureListener!	Der Listener für das Laden des Einwilligungsformulars ist fehlgeschlagen.

showPrivacyOptionsForm

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

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.
onConsentFormDismissedListener: ConsentForm.OnConsentFormDismissedListener!	Der Listener, der aufgerufen wird, wenn das Formular mit den Datenschutzoptionen geschlossen wird.