EnvironmentClient

interface EnvironmentClient


Klient do uzyskiwania dostępu do interfejsów API związanych ze środowiskiem.

Użyj EnvironmentClientFactory, aby utworzyć instancję.

Podsumowanie

Funkcje publiczne

suspend Environment

Zwraca Environment.

ListenableFuture<Environment>

Zwraca Environment.

suspend PrepareEnvironmentResponse
prepareEnvironment(
    request: PrepareEnvironmentRequest,
    notificationServiceComponentName: ComponentName?
)

przygotowuje urządzenie, sprawdzając, czy aplikacja Android Device Policy jest zainstalowana i gotowa do działania;

ListenableFuture<PrepareEnvironmentResponse>
prepareEnvironmentAsync(
    request: PrepareEnvironmentRequest,
    notificationServiceComponentName: ComponentName?
)

przygotowuje urządzenie, sprawdzając, czy aplikacja Android Device Policy jest zainstalowana i gotowa do działania;

Funkcje publiczne

getEnvironment

suspend fun getEnvironment(request: GetEnvironmentRequest): Environment

Zwraca Environment. Pomaga rozmówcy dowiedzieć się, czy środowisko jest gotowe.

Rzuty
com.google.android.managementapi.common.exceptions.InvalidArgumentException

Jeśli żądane role są nieprawidłowe lub jeśli któraś z nich ma ustawioną wartość extraCapabilities. Dodatkowe uprawnienia są przyznawane przez administratora IT w zasadach dotyczących urządzeń i aplikacja nie może o nie prosić.

com.google.android.managementapi.common.exceptions.InternalException

Jeśli wywołanie nie powiodło się z powodu błędu wewnętrznego.

com.google.android.managementapi.common.exceptions.ApiLevelException

Jeśli poziom interfejsu API pakietu SDK urządzenia jest niewystarczający dla niektórych żądanych ról (może to być dodatkowy wymóg oprócz ogólnego minimalnego poziomu interfejsu API dla samego wywołania). {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} wymaga interfejsu API na poziomie 23 lub wyższym. Inne role wymagają interfejsu API na poziomie 28 lub wyższym.

getEnvironmentAsync

fun getEnvironmentAsync(request: GetEnvironmentRequest): ListenableFuture<Environment>

Zwraca Environment. Pomaga rozmówcy dowiedzieć się, czy środowisko jest gotowe.

Zwroty
ListenableFuture<Environment>

ListenableFuture zawierający wynik. Może to być:

  • Obiekt Future zawierający obiekt Environment, jeśli operacja się powiedzie.

  • Niepowodzenie przyszłego opakowania InvalidArgumentException, jeśli żądane role są nieprawidłowe.

  • Niepowodzenie przyszłego opakowania InternalException, jeśli połączenie nie powiodło się z powodu błędu wewnętrznego.

Rzuty
com.google.android.managementapi.common.exceptions.InvalidArgumentException

Jeśli dowolna z żądanych ról ma ustawioną wartość extraCapabilities. Dodatkowe uprawnienia są przyznawane przez administratora IT w zasadach dotyczących urządzeń i aplikacja nie może o nie prosić.

com.google.android.managementapi.common.exceptions.ApiLevelException

Jeśli poziom interfejsu API pakietu SDK urządzenia jest niewystarczający dla niektórych żądanych ról (może to być dodatkowy wymóg oprócz ogólnego minimalnego poziomu interfejsu API dla samego wywołania). {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} wymaga interfejsu API na poziomie 23 lub wyższym. Inne role wymagają interfejsu API na poziomie 28 lub wyższym.

prepareEnvironment

suspend fun prepareEnvironment(
    request: PrepareEnvironmentRequest,
    notificationServiceComponentName: ComponentName?
): PrepareEnvironmentResponse

przygotowuje urządzenie, sprawdzając, czy aplikacja Android Device Policy jest zainstalowana i gotowa do działania;

Działanie zależy od kontekstu:

  • Device Trust Flow: jeśli aplikacja Android Device Policy nie jest zainstalowana, użytkownik zostanie poproszony o jej zainstalowanie. Jeśli aplikacja jest już zainstalowana, zostanie zaktualizowana w tle.

  • Proces rejestracji urządzenia: dyskretnie instaluje aplikację Zasady dotyczące urządzeń z Androidem, jeśli nie jest jeszcze zainstalowana, i upewnia się, że jest gotowa do użycia, bez interakcji ze strony użytkownika.

Parametry
notificationServiceComponentName: ComponentName?

ComponentName usługi rozszerzającej NotificationReceiverService. Jeśli jest podany, musi być prawidłowym komponentem należącym do aplikacji do dzwonienia i wyeksportowanym w pliku manifestu. Aby otrzymywać powiadomienia o zdarzeniach związanych z przygotowywaniem środowiska:

  1. Zaimplementuj interfejs EnvironmentListener w aplikacji.

  2. Zaimplementuj obsługę otrzymanych zdarzeń.

  3. Rozszerz NotificationReceiverService i podaj instancję EnvironmentListener.

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

Na przykład:

class MyEnvironmentListener : EnvironmentListener {
override fun onEnvironmentEvent(event: EnvironmentEvent) {
// Handle the environment event.
}
}

class MyNotificationReceiverService : NotificationReceiverService() {
override fun getPrepareEnvironmentListener(): EnvironmentListener? {
return MyEnvironmentListener()
}
}
Zwroty
PrepareEnvironmentResponse

PrepareEnvironmentResponse zawierający szczegółowe informacje o ostatecznym stanie przygotowania środowiska.

Rzuty
com.google.android.managementapi.common.exceptions.InvalidArgumentException

Jeśli:

  • [notificationServiceComponentName] nie jest prawidłowym komponentem należącym do aplikacji do dzwonienia lub nie został wyeksportowany w pliku manifestu.
  • Żądane role obejmują {@code Role.RoleType.DEVICE_POLICY_CONTROLLER}, a parametr {@code com.google.android.managementapi.environment.model.PrepareEnvironmentRequest.admin} nie został podany lub nie rozszerza {@code android.app.admin.DeviceAdminReceiver}.
  • Żądane role są nieprawidłowe.
  • Dowolna z żądanych ról ma ustawioną wartość extraCapabilities. Dodatkowe uprawnienia są przyznawane przez administratora IT w zasadach dotyczących urządzeń i nie można o nie prosić w aplikacji.
SecurityException

Jeśli element wywołujący nie ma uprawnień do wywołania tego interfejsu API.

GooglePlayServicesAppNotUpdatedException

Jeśli Usługi Google Play są nieaktualne.

AndroidDevicePolicyInstallOrUpdateUnrecoverableException

Jeśli nie uda się zainstalować lub zaktualizować aplikacji Android Device Policy i błąd jest nie do naprawienia.

AndroidDevicePolicyInstallOrUpdateRecoverableException

Jeśli nie uda się zainstalować lub zaktualizować aplikacji Android Device Policy, a błąd można naprawić (np. żądanie nie powiodło się z powodu przejściowych problemów z siecią), można ponowić żądanie.

AndroidDevicePolicyInstallConsentDeclinedException

Jeśli użytkownik odmówi zainstalowania aplikacji Android Device Policy.

AndroidDevicePolicyInstallConsentDismissedException

Jeśli użytkownik zamknie ekran zgody na instalację.

com.google.android.managementapi.common.exceptions.InternalException

Jeśli wywołanie nie powiodło się z powodu błędu wewnętrznego.

PlayStoreUpdateUnrecoverableException

Jeśli nie udało się zaktualizować Sklepu Play.

com.google.android.managementapi.common.exceptions.ApiLevelException

Jeśli poziom interfejsu API pakietu SDK urządzenia jest niewystarczający dla niektórych żądanych ról (może to być dodatkowy wymóg dotyczący ogólnego minimalnego poziomu interfejsu API dla samego wywołania).{@code Role.RoleType.DEVICE_POLICY_CONTROLLER} wymaga interfejsu API na poziomie 23 lub wyższym. Inne role wymagają interfejsu API na poziomie 28 lub wyższym.

prepareEnvironmentAsync

fun prepareEnvironmentAsync(
    request: PrepareEnvironmentRequest,
    notificationServiceComponentName: ComponentName?
): ListenableFuture<PrepareEnvironmentResponse>

przygotowuje urządzenie, sprawdzając, czy aplikacja Android Device Policy jest zainstalowana i gotowa do działania;

Działanie zależy od kontekstu:

  • Device Trust Flow: jeśli aplikacja Android Device Policy nie jest zainstalowana, użytkownik zostanie poproszony o jej zainstalowanie. Jeśli aplikacja jest już zainstalowana, zostanie zaktualizowana w tle.

  • Proces rejestracji urządzenia: dyskretnie instaluje aplikację Zasady dotyczące urządzeń z Androidem, jeśli nie jest jeszcze zainstalowana, i upewnia się, że jest gotowa do użycia, bez interakcji ze strony użytkownika.

Parametry
notificationServiceComponentName: ComponentName?

ComponentName usługi rozszerzającej NotificationReceiverService. Jeśli jest podany, musi być prawidłowym komponentem należącym do aplikacji do dzwonienia i wyeksportowanym w pliku manifestu. Aby otrzymywać powiadomienia o zdarzeniach związanych z przygotowywaniem środowiska:

  1. Zaimplementuj interfejs EnvironmentListener w aplikacji.

  2. Zaimplementuj obsługę otrzymanych zdarzeń.

  3. Rozszerz NotificationReceiverService i podaj instancję EnvironmentListener.

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

Na przykład:

class MyEnvironmentListener : EnvironmentListener {
override fun onEnvironmentEvent(event: EnvironmentEvent) {
// Handle the environment event.
}
}

class MyNotificationReceiverService : NotificationReceiverService() {
override fun getPrepareEnvironmentListener(): EnvironmentListener? {
return MyEnvironmentListener()
}
}
Zwroty
ListenableFuture<PrepareEnvironmentResponse>

ListenableFuture zawierający wynik. Może to być:

  • Pomyślny obiekt Future zawierający obiekt PrepareEnvironmentResponse ze szczegółowymi informacjami o ostatecznym stanie przygotowania środowiska.

  • Niepowodzenie przyszłego opakowania InvalidArgumentException, jeśli:

    • [notificationServiceComponentName] nie jest prawidłowym komponentem należącym do aplikacji do dzwonienia lub nie został wyeksportowany w pliku manifestu.
    • Żądane role są nieprawidłowe.
    • Żądane role obejmują {@code Role.RoleType.DEVICE_POLICY_CONTROLLER}, a parametr {@code com.google.android.managementapi.environment.model.PrepareEnvironmentRequest.admin} nie został podany lub nie rozszerza {@code android.app.admin.DeviceAdminReceiver}.
  • Nieudany obiekt Future opakowujący błąd SecurityException, jeśli element wywołujący nie ma uprawnień do wywołania tego interfejsu API.

  • Jeśli Usługi Google Play są nieaktualne, zwracany jest nieudany obiekt Future zawierający GooglePlayServicesAppNotUpdatedException.

  • Niepowodzenie w przyszłości, które spowoduje błąd AndroidDevicePolicyInstallOrUpdateUnrecoverableException, jeśli nie uda się zainstalować lub zaktualizować Android Device Policy, a błąd będzie nie do naprawienia.

  • Nieudany obiekt future opakowujący błąd AndroidDevicePolicyInstallOrUpdateRecoverableException, jeśli nie uda się zainstalować lub zaktualizować aplikacji Android Device Policy, a błąd można naprawić (np. żądanie nie powiodło się z powodu przejściowych problemów z siecią), dzięki czemu można ponowić żądanie.

  • Niepowodzenie w przyszłości, które spowoduje błąd AndroidDevicePolicyInstallConsentDeclinedException, jeśli użytkownik odmówi zainstalowania aplikacji Zasady dotyczące urządzeń z Androidem.

  • Niepowodzenie przyszłego opakowania AndroidDevicePolicyInstallConsentDismissedException, jeśli użytkownik odrzuci ekran zgody na instalację.

  • Niepowodzenie przyszłego opakowania InternalException, jeśli połączenie nie powiodło się z powodu błędu wewnętrznego.

  • Niepowodzenie przyszłego opakowania PlayStoreUpdateUnrecoverableException, jeśli nie udało się zaktualizować Sklepu Play.

Rzuty
com.google.android.managementapi.common.exceptions.InvalidArgumentException

Jeśli dowolna z żądanych ról ma ustawioną wartość extraCapabilities. Dodatkowe uprawnienia są przyznawane przez administratora IT w zasadach dotyczących urządzeń i aplikacja nie może o nie prosić.

com.google.android.managementapi.common.exceptions.ApiLevelException

Jeśli poziom interfejsu API pakietu SDK urządzenia jest niewystarczający dla niektórych żądanych ról. {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} wymaga interfejsu API na poziomie 23 lub wyższym. Inne role wymagają interfejsu API na poziomie 28 lub wyższym.