AccountSetupClient

Kotlin |Java

public interface AccountSetupClient

---

Klient do zarządzania konfiguracją zarządzanego konta na urządzeniu.

Wymagania dotyczące integracji cyklu życia: aby prawidłowo obsługiwać wywołania zwrotne wyników wymagane przez operacje takie jak launchAuthenticationActivity, ten klient korzysta z interfejsów API wyników działania AndroidX. Wywołujący musi zintegrować tego klienta z cyklem życia komponentu Androida (Activity lub Fragment) przez:

1. Pobieranie obserwatora za pomocą metody getLifecycleObserver.

2. Rejestrowanie tego obserwatora w Lifecycle hostującego działania lub fragmentu, zwykle w onCreate (np. lifecycle.addObserver(client.lifecycleObserver)).

Aktualizacje stanu: aby otrzymywać powiadomienia o asynchronicznych zmianach stanu konfiguracji konta, aplikacja do połączeń musi:

1. Zaimplementuj interfejs AccountSetupListener.

2. Zaimplementuj obsługę otrzymywanych aktualizacji stanu.

3. Rozszerz NotificationReceiverService i podaj instancję AccountSetupListener.

4. Dodaj rozszerzoną klasę NotificationReceiverService do pliku AndroidManifest.xml i upewnij się, że jest ona wyeksportowana.

Użyj AccountSetupClientFactory, aby utworzyć instancję tego klienta.

Podsumowanie

Metody publiczne
abstract @NonNull AccountSetupAttempt	cancelAccountSetupAttempt(     @NonNull CancelAccountSetupAttemptRequest cancelAccountSetupAttemptRequest ) Anuluje określoną próbę konfiguracji konta.
abstract @NonNull ListenableFuture<@NonNull AccountSetupAttempt>	cancelAccountSetupAttemptFuture(     @NonNull CancelAccountSetupAttemptRequest cancelAccountSetupAttemptRequest ) Anuluje określoną próbę konfiguracji konta.
abstract @NonNull LifecycleObserver	getLifecycleObserver() LifecycleObserver, który obsługuje konfigurację zależną od cyklu życia tego klienta.
abstract @NonNull AccountSetupAttempt	launchAuthenticationActivity(     @NonNull LaunchAuthenticationActivityRequest launchAuthenticationActivityRequest ) Uruchamia aktywność Minute Maid, aby uwierzytelnić użytkownika, lub selektor kont, jeśli konto jest już obecne na urządzeniu.
abstract @NonNull ListenableFuture<@NonNull AccountSetupAttempt>	launchAuthenticationActivityFuture(     @NonNull LaunchAuthenticationActivityRequest launchAuthenticationActivityRequest ) Uruchamia aktywność Minute Maid, aby uwierzytelnić użytkownika, lub selektor kont, jeśli konto jest już obecne na urządzeniu.
abstract @NonNull List<@NonNull AccountSetupAttempt>	listAccountSetupAttempts() Zawiera listę wszystkich prób konfiguracji konta.
abstract @NonNull ListenableFuture<@NonNull List<@NonNull AccountSetupAttempt>>	listAccountSetupAttemptsFuture() Zawiera listę wszystkich prób konfiguracji konta.
abstract @NonNull AccountSetupAttempt	startAccountSetup(     @NonNull StartAccountSetupRequest startAccountSetupRequest ) Rozpoczyna konfigurację konta.
abstract @NonNull ListenableFuture<@NonNull AccountSetupAttempt>	startAccountSetupFuture(     @NonNull StartAccountSetupRequest startAccountSetupRequest ) Rozpoczyna konfigurację konta.

Metody publiczne

cancelAccountSetupAttempt

abstract @NonNull AccountSetupAttempt cancelAccountSetupAttempt(
    @NonNull CancelAccountSetupAttemptRequest cancelAccountSetupAttemptRequest
)

Anuluje określoną próbę konfiguracji konta.

Parametry
@NonNull CancelAccountSetupAttemptRequest cancelAccountSetupAttemptRequest	Prośba o anulowanie próby konfiguracji konta.

Zwroty
@NonNull AccountSetupAttempt	Próba zaktualizowania konfiguracji konta.

cancelAccountSetupAttemptFuture

abstract @NonNull ListenableFuture<@NonNull AccountSetupAttempt> cancelAccountSetupAttemptFuture(
    @NonNull CancelAccountSetupAttemptRequest cancelAccountSetupAttemptRequest
)

Anuluje określoną próbę konfiguracji konta.

Parametry
@NonNull CancelAccountSetupAttemptRequest cancelAccountSetupAttemptRequest	Prośba o anulowanie próby konfiguracji konta.

Zwroty
@NonNull ListenableFuture<@NonNull AccountSetupAttempt>	Znak ListenableFuture otaczający wynik. Może to być Future, który zakończy się powodzeniem i zawiera zaktualizowaną próbę konfiguracji konta. Nieudane zadanie Future, jeśli próba konfiguracji konta nie zostanie znaleziona lub jest już w stanie końcowym (błąd lub powodzenie).

getLifecycleObserver

abstract @NonNull LifecycleObserver getLifecycleObserver()

LifecycleObserver, który obsługuje konfigurację zależną od cyklu życia tego klienta.

Ten obserwator musi być zarejestrowany w Lifecycle aktywności lub fragmentu, który hostuje tę instancję klienta (np. lifecycle.addObserver(...) (zwykle w onCreate).

Zarejestrowanie tego obserwatora umożliwia klientowi prawidłowe zainicjowanie komponentów wewnętrznych, w szczególności androidx.activity.result.ActivityResultLauncher potrzebnego do przetworzenia wyniku launchAuthenticationActivity. Jeśli nie zarejestrujesz tego obserwatora, podczas próby uruchomienia działania uwierzytelniania wystąpią błędy.

launchAuthenticationActivity

abstract @NonNull AccountSetupAttempt launchAuthenticationActivity(
    @NonNull LaunchAuthenticationActivityRequest launchAuthenticationActivityRequest
)

Uruchamia aktywność Minute Maid, aby uwierzytelnić użytkownika, lub selektor kont, jeśli konto jest już obecne na urządzeniu.

Parametry
@NonNull LaunchAuthenticationActivityRequest launchAuthenticationActivityRequest	Żądanie uruchomienia aktywności uwierzytelniania. Żądanie musi zawierać próbę konfiguracji konta w stanie AUTHENTICATION_ACTIVITY_LAUNCH_REQUIRED_INFORMATION.

Zgłasza
java.lang.SecurityException	Jeśli dzwoniący nie jest właścicielem urządzenia ani właścicielem profilu.
com.google.android.managementapi.accountsetup.AccountSetupInvalidStateException	Jeśli próba założenia konta nie jest w stanie AUTHENTICATION_ACTIVITY_LAUNCH_REQUIRED_INFORMATION.

launchAuthenticationActivityFuture

abstract @NonNull ListenableFuture<@NonNull AccountSetupAttempt> launchAuthenticationActivityFuture(
    @NonNull LaunchAuthenticationActivityRequest launchAuthenticationActivityRequest
)

Uruchamia aktywność Minute Maid, aby uwierzytelnić użytkownika, lub selektor kont, jeśli konto jest już obecne na urządzeniu.

Parametry
@NonNull LaunchAuthenticationActivityRequest launchAuthenticationActivityRequest	Żądanie uruchomienia aktywności uwierzytelniania. Żądanie musi zawierać próbę konfiguracji konta w stanie AUTHENTICATION_ACTIVITY_LAUNCH_REQUIRED_INFORMATION.

Zwroty

@NonNull ListenableFuture<@NonNull AccountSetupAttempt>

Znak ListenableFuture otaczający wynik. Może to być W przypadku powodzenia zwraca przyszłość opakowującą próbę konfiguracji konta w stanie IN_PROGRESS. Nieudane przyszłe opakowanie SecurityException, jeśli wywołujący nie jest właścicielem urządzenia ani właścicielem profilu. Nieudane zadanie Future opakowujące AccountSetupInvalidStateException, jeśli próba konfiguracji konta nie jest w stanie AUTHENTICATION_ACTIVITY_LAUNCH_REQUIRED_INFORMATION.

listAccountSetupAttempts

abstract @NonNull List<@NonNull AccountSetupAttempt> listAccountSetupAttempts()

Zawiera listę wszystkich prób konfiguracji konta. Zwracanych jest tylko 20 ostatnich prób założenia konta.

Zwroty
@NonNull List<@NonNull AccountSetupAttempt>	Lista wszystkich prób konfiguracji konta.

listAccountSetupAttemptsFuture

abstract @NonNull ListenableFuture<@NonNull List<@NonNull AccountSetupAttempt>> listAccountSetupAttemptsFuture()

Zawiera listę wszystkich prób konfiguracji konta. Zwracanych jest tylko 20 ostatnich prób założenia konta.

Zwroty
@NonNull ListenableFuture<@NonNull List<@NonNull AccountSetupAttempt>>	Znak ListenableFuture otaczający wynik.

startAccountSetup

abstract @NonNull AccountSetupAttempt startAccountSetup(
    @NonNull StartAccountSetupRequest startAccountSetupRequest
)

Rozpoczyna konfigurację konta.

UWAGA: ta metoda deleguje zakres android.app.admin.DevicePolicyManager.DELEGATION_APP_RESTRICTIONS na aplikację Android Device Policy, co umożliwia jej zarządzanie ograniczeniami aplikacji w imieniu wywołującego administratora. Po zakończeniu konfigurowania konta ten zakres delegowania do aplikacji Android Device Policy zostanie usunięty.

Parametry
@NonNull StartAccountSetupRequest startAccountSetupRequest	Prośba o rozpoczęcie konfiguracji konta.

Zwroty
@NonNull AccountSetupAttempt	Próba założenia konta.

Zgłasza
com.google.android.managementapi.environment.exception.EnvironmentNotReadyException	jeśli środowisko nie jest przygotowane.
com.google.android.managementapi.accountsetup.AccountSetupUnknownException	jeśli podczas konfigurowania konta wystąpi nieznany błąd.
com.google.android.managementapi.accountsetup.AccountSetupInvalidEnrollmentTokenException	jeśli token rejestracji jest pusty lub nie jest ustawiony w żądaniu.
com.google.android.managementapi.accountsetup.AccountSetupInvalidAdminComponentException	jeśli komponent administratora DeviceAdminReceiver nie jest aktywnym administratorem na urządzeniu.
com.google.android.managementapi.accountsetup.AccountSetupInvalidNotificationReceiverComponentException	jeśli na urządzeniu nie ma komponentu odbiornika powiadomień.

startAccountSetupFuture

abstract @NonNull ListenableFuture<@NonNull AccountSetupAttempt> startAccountSetupFuture(
    @NonNull StartAccountSetupRequest startAccountSetupRequest
)

Rozpoczyna konfigurację konta.

UWAGA: ta metoda deleguje zakres android.app.admin.DevicePolicyManager.DELEGATION_APP_RESTRICTIONS na aplikację Android Device Policy, co umożliwia jej zarządzanie ograniczeniami aplikacji w imieniu wywołującego administratora. Po zakończeniu konfigurowania konta ten zakres delegowania do aplikacji Android Device Policy zostanie usunięty.

Parametry
@NonNull StartAccountSetupRequest startAccountSetupRequest	Prośba o rozpoczęcie konfiguracji konta.

Zwroty

@NonNull ListenableFuture<@NonNull AccountSetupAttempt>

Znak ListenableFuture otaczający wynik. Może to być Pomyślna przyszłość obejmująca próbę konfiguracji konta. Nieudana przyszłość obejmująca wyjątek EnvironmentNotReadyException, jeśli środowisko nie jest przygotowane. Nieudane przyszłe opakowanie com.google.android.managementapi.accountsetup.AccountSetupUnknownException, jeśli podczas konfigurowania konta wystąpi nieznany błąd. Nieudane zadanie Future zawierające com.google.android.managementapi.accountsetup.AccountSetupInvalidEnrollmentTokenException, jeśli token rejestracji jest pusty lub nie został ustawiony w żądaniu. Nieudane zadanie Future opakowujące com.google.android.managementapi.accountsetup.AccountSetupInvalidAdminComponentException, jeśli komponent DeviceAdminReceiver administratora nie jest aktywnym administratorem na urządzeniu. Nieudane przyszłe opakowanie com.google.android.managementapi.accountsetup.AccountSetupInvalidNotificationReceiverComponentException, jeśli na urządzeniu nie ma komponentu odbiornika powiadomień.