ConsentInformation

public interface ConsentInformation


Metody pomocnicze do uzyskiwania zgody użytkowników.

Podsumowanie

Typy zagnieżdżone

@Retention(value = SOURCE)
@IntDef(value = [ConsentStatus.UNKNOWN, ConsentStatus.NOT_REQUIRED, ConsentStatus.REQUIRED, ConsentStatus.OBTAINED])
public annotation ConsentInformation.ConsentStatus

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.

Metody publiczne

abstract boolean

Wskazuje, czy pakiet SDK uzyskał zgodę zgodną z komunikatami skonfigurowanymi w aplikacji.

abstract int

Pobiera bieżący stan zgody.

abstract ConsentInformation.PrivacyOptionsRequirementStatus

Pobiera stan wskazujący, czy wymagany jest przycisk opcji prywatności.

abstract boolean

Zwraca wartość true, jeśli jest dostępna wartość ConsentForm, a w przeciwnym razie – wartość false.

abstract void

Prośba o zaktualizowanie informacji o zgodzie.

abstract void

Przywracanie stanu ConsentInformation do zainicjowanego.

Metody publiczne

canRequestAds

abstract boolean canRequestAds()

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
abstract int getConsentStatus()

Pobiera bieżący stan zgody.

Zwroty
int

UNKNOWN do momentu wywołania requestConsentInfoUpdate, a domyślnie przyjmuje wartość z poprzedniej sesji, dopóki requestConsentInfoUpdate nie zostanie zakończone i wywołane OnConsentInfoUpdateSuccessListener.

getPrivacyOptionsRequirementStatus

abstract ConsentInformation.PrivacyOptionsRequirementStatus getPrivacyOptionsRequirementStatus()

Pobiera stan wskazujący, czy wymagany jest przycisk opcji prywatności.

Zwroty
ConsentInformation.PrivacyOptionsRequirementStatus

UNKNOWN do momentu wywołania requestConsentInfoUpdate, a domyślnie przyjmuje wartość z poprzedniej sesji, dopóki requestConsentInfoUpdate nie zostanie zakończone i wywołane.

isConsentFormAvailable

abstract boolean isConsentFormAvailable()

Zwraca wartość true, jeśli jest dostępna wartość ConsentForm, a w przeciwnym razie – wartość false.

requestConsentInfoUpdate

abstract void requestConsentInfoUpdate(
    Activity activity,
    ConsentRequestParameters consentRequestParameters,
    ConsentInformation.OnConsentInfoUpdateSuccessListener successListener,
    ConsentInformation.OnConsentInfoUpdateFailureListener failureListener
)

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.

ConsentInformation.OnConsentInfoUpdateSuccessListener successListener

Listener na potrzeby obsługi żądania zgody.

ConsentInformation.OnConsentInfoUpdateFailureListener failureListener

Listener dotyczący błędu prośby o zgodę.

zresetuj

abstract void reset()

Przywracanie stanu ConsentInformation do zainicjowanego. Należy go używać tylko do debugowania.