ConsentInformation
interface ConsentInformation
Metody pomocnicze do uzyskiwania zgody użytkowników.
Podsumowanie
Typy zagnieżdżone |
|---|
@Retention(value = SOURCE)Wartości stanu zgody. |
|
Definicja interfejsu wywołania zwrotnego, które ma być wywołane, gdy nie uda się zaktualizować informacji o zgodzie. |
|
Definicja interfejsu wywołania zwrotnego, które ma być wywoływane po pomyślnym zaktualizowaniu informacji o zgodzie. |
|
Stan wymagań dotyczących opcji prywatności. |
Funkcje publiczne |
|
|---|---|
Boolean |
Wskazuje, czy pakiet SDK uzyskał zgodę zgodną z komunikatami skonfigurowanymi w aplikacji. |
Int |
Pobiera bieżący stan zgody. |
ConsentInformation.PrivacyOptionsRequirementStatus! |
Pobiera stan wskazujący, czy wymagany jest przycisk opcji prywatności. |
Boolean |
Zwraca wartość |
Unit |
requestConsentInfoUpdate(Prośba o zaktualizowanie informacji o zgodzie. |
Unit |
reset()Przywracanie stanu |
Funkcje publiczne
canRequestAds
fun canRequestAds(): Boolean
Wskazuje, czy pakiet SDK uzyskał zgodę zgodną z komunikatami skonfigurowanymi w aplikacji.
Ta metoda zwraca false, dopóki nie zostanie wywołana metoda requestConsentInfoUpdate.
Po wywołaniu requestConsentInfoUpdate ta metoda zwraca true, gdy getConsentStatus zwraca NOT_REQUIRED lub OBTAINED.
| Zwroty | |
|---|---|
Boolean |
wartość Prawda, jeśli pakiet SDK uzyskał zgodę zgodną z wiadomościami skonfigurowanymi w aplikacji. |
getConsentStatus
@ConsentInformation.ConsentStatus
fun getConsentStatus(): Int
Pobiera bieżący stan zgody.
| Zwroty | |
|---|---|
Int |
|
getPrivacyOptionsRequirementStatus
fun getPrivacyOptionsRequirementStatus(): ConsentInformation.PrivacyOptionsRequirementStatus!
Pobiera stan wskazujący, czy wymagany jest przycisk opcji prywatności.
| Zwroty | |
|---|---|
ConsentInformation.PrivacyOptionsRequirementStatus! |
|
isConsentFormAvailable
fun isConsentFormAvailable(): Boolean
Zwraca wartość true, jeśli jest dostępna wartość ConsentForm, a w przeciwnym razie – wartość false.
requestConsentInfoUpdate
fun requestConsentInfoUpdate(
activity: Activity!,
consentRequestParameters: ConsentRequestParameters!,
successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener!,
failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener!
): Unit
Prośba o zaktualizowanie informacji o zgodzie.
Ten interfejs API musi zostać wywołany w każdej sesji aplikacji przed wywołaniem getConsentStatus.
Po wywołaniu tego interfejsu API wartość zwracana przez interfejs API getConsentStatus zostanie zaktualizowana synchronicznie, aby zawierać stan zgody z poprzedniej sesji aplikacji (jeśli taka istnieje).
Po wywołaniu funkcji getConsentStatus może zostać ponownie zaktualizowany do aktualnego stanu.
| Parametry | |
|---|---|
activity: Activity! |
Aktywność służąca do zbierania wycinków ekranu. |
consentRequestParameters: ConsentRequestParameters! |
Parametry żądania. |
successListener: ConsentInformation.OnConsentInfoUpdateSuccessListener! |
Listener na potrzeby obsługi żądania zgody. |
failureListener: ConsentInformation.OnConsentInfoUpdateFailureListener! |
Listener dotyczący błędu prośby o zgodę. |
zresetuj
fun reset(): Unit
Przywracanie stanu ConsentInformation do zainicjowanego. Należy go używać tylko do debugowania.