ConsentInformation

Kotlin |Java

interface ConsentInformation

---

Dienstmethoden zum Einholen der Einwilligung von Nutzern.

Zusammenfassung

Verschachtelte Typen
@Retention(value = SOURCE) @IntDef(value = [ConsentStatus.UNKNOWN, ConsentStatus.NOT_REQUIRED, ConsentStatus.REQUIRED, ConsentStatus.OBTAINED]) annotation ConsentInformation.ConsentStatus Werte für den Einwilligungsstatus
interface ConsentInformation.OnConsentInfoUpdateFailureListener Schnittstellendefinition für einen Rückruf, der aufgerufen wird, wenn die Einwilligungsinformationen nicht aktualisiert werden konnten.
interface ConsentInformation.OnConsentInfoUpdateSuccessListener Schnittstellendefinition für einen Callback, der aufgerufen wird, wenn die Einwilligungsinformationen erfolgreich aktualisiert wurden.
enum ConsentInformation.PrivacyOptionsRequirementStatus Status der Anforderungen an die Datenschutzoptionen

Öffentliche Funktionen
Boolean	canRequestAds() Gibt an, ob das SDK eine Einwilligung gemäß den konfigurierten Mitteilungen der App eingeholt hat.
Int	@ConsentInformation.ConsentStatus getConsentStatus() Ruft den aktuellen Einwilligungsstatus ab.
ConsentInformation.PrivacyOptionsRequirementStatus!	getPrivacyOptionsRequirementStatus() Ruft den Status ab, der angibt, ob eine Schaltfläche für Datenschutzoptionen erforderlich ist.
Boolean	isConsentFormAvailable() Gibt true zurück, wenn eine ConsentForm verfügbar ist, andernfalls false.
Unit	requestConsentInfoUpdate(     activity: Activity!,     consentRequestParameters: ConsentRequestParameters!,     successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!,     failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener! ) Es wird eine Aktualisierung der Einwilligungsinformationen angefordert.
Unit	reset() Setzt ConsentInformation auf den Status „Initialisiert“ zurück.

Öffentliche Funktionen

canRequestAds

fun canRequestAds(): Boolean

Gibt an, ob das SDK eine Einwilligung gemäß den konfigurierten Mitteilungen der App eingeholt hat.

Diese Methode gibt false zurück, bis requestConsentInfoUpdate aufgerufen wird.

Wenn requestConsentInfoUpdate aufgerufen wird, gibt diese Methode true zurück, wenn getConsentStatus NOT_REQUIRED oder OBTAINED zurückgibt.

Ausgabe
Boolean	„wahr“, wenn das SDK eine Einwilligung gemäß den konfigurierten Mitteilungen der App eingeholt hat.

getConsentStatus

@ConsentInformation.ConsentStatus
fun getConsentStatus(): Int

Ruft den aktuellen Einwilligungsstatus ab.

Ausgabe
Int	UNKNOWN, bis requestConsentInfoUpdate aufgerufen wird, und standardmäßig der Wert der vorherigen Sitzung, bis requestConsentInfoUpdate erfolgreich abgeschlossen und OnConsentInfoUpdateSuccessListener aufgerufen wird.

getPrivacyOptionsRequirementStatus

fun getPrivacyOptionsRequirementStatus(): ConsentInformation.PrivacyOptionsRequirementStatus!

Ruft den Status ab, der angibt, ob eine Schaltfläche für Datenschutzoptionen erforderlich ist.

Ausgabe
ConsentInformation.PrivacyOptionsRequirementStatus!	UNKNOWN, bis requestConsentInfoUpdate aufgerufen wird. Standardmäßig ist der Wert der vorherigen Sitzung, bis requestConsentInfoUpdate erfolgreich abgeschlossen und aufgerufen wird.

isConsentFormAvailable

fun isConsentFormAvailable(): Boolean

Gibt true zurück, wenn eine ConsentForm verfügbar ist, andernfalls false.

requestConsentInfoUpdate

fun requestConsentInfoUpdate(
    activity: Activity!,
    consentRequestParameters: ConsentRequestParameters!,
    successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!,
    failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!
): Unit

Es wird eine Aktualisierung der Einwilligungsinformationen angefordert.

Diese API muss in jeder App-Sitzung aufgerufen werden, bevor getConsentStatus aufgerufen wird.

Nach dem Aufruf dieser API wird der Rückgabewert der getConsentStatus API synchron aktualisiert, um den Einwilligungsstatus aus der vorherigen App-Sitzung zu speichern, sofern vorhanden.

getConsentStatus wird möglicherweise nach dem Aufruf von noch einmal auf den aktuellen Status aktualisiert.

Parameter
activity: Activity!	Die Aktivität, mit der Bildschirmausschnitte erfasst werden.
consentRequestParameters: ConsentRequestParameters!	Die Anfrageparameter.
successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!	Der Listener für den Erfolg der Einwilligungsanfrage.
failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!	Der Listener für fehlgeschlagene Einwilligungsanfragen.

Zurücksetzen

fun reset(): Unit

Setzt ConsentInformation auf den Status „Initialisiert“ zurück. Diese Option sollte nur zur Fehlerbehebung verwendet werden.