EnvironmentClient

interface EnvironmentClient

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

Utwórz instancję w aplikacji EnvironmentClientFactory.

Podsumowanie

Funkcje publiczne
suspend Environment

Zwraca wartość Environment.
ListenableFuture<Environment>

Zwraca wartość Environment.
suspend PrepareEnvironmentResponse
prepareEnvironment(
    request: PrepareEnvironmentRequest,
    notificationServiceComponentName: ComponentName?
)

Przygotowuje środowisko urządzenia.
ListenableFuture<PrepareEnvironmentResponse>
prepareEnvironmentAsync(
    request: PrepareEnvironmentRequest,
    notificationServiceComponentName: ComponentName?
)

Przygotowuje środowisko urządzenia.

Funkcje publiczne

getEnvironment

suspend fun getEnvironment(request: GetEnvironmentRequest): Environment

Zwraca wartość Environment. Pomaga to osobie dzwoniącej sprawdzić, czy środowisko jest gotowe.

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

Jeśli żądane role są nieprawidłowe.
com.google.android.managementapi.common.exceptions.InternalException

Jeśli połączenie nie powiodło się z powodu błędu wewnętrznego.
com.google.android.managementapi.common.exceptions.ApiLevelException

Jeśli poziom interfejsu API pakietu SDK na urządzeniu jest niewystarczający w przypadku niektórych żądanych ról (może to być dodatkowe wymaganie 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. W przypadku innych ról wymagany jest interfejs API na poziomie 28 lub wyższym.

getEnvironmentAsync

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

Zwraca wartość Environment. Pomaga to osobie dzwoniącej sprawdzić, czy środowisko jest gotowe.

Zwroty
ListenableFuture<Environment>

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

  • W przypadku powodzenia zwraca przyszłość zawierającą Environment.

  • Nieudana przyszłość opakowująca

  • Nieudane zadanie przyszłe opakowujące InvalidArgumentException, jeśli żądane role są nieprawidłowe.

  • Nieudana przyszłość opakowująca InternalException, jeśli wywołanie nie powiodło się z powodu błędu wewnętrznego.
Rzuty
com.google.android.managementapi.common.exceptions.ApiLevelException

Jeśli poziom interfejsu API pakietu SDK na urządzeniu jest niewystarczający w przypadku niektórych żądanych ról (może to być dodatkowe wymaganie 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. W przypadku innych ról wymagany jest interfejs API na poziomie 28 lub wyższym.

prepareEnvironment

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

Przygotowuje środowisko urządzenia.

Wyświetla prośbę o zainstalowanie niezbędnej aplikacji Android Device Policy. Jeśli użytkownik zaakceptuje prośbę, instalacja zostanie przeprowadzona. Po pomyślnej instalacji wykonuje operacje, które zapewniają gotowość aplikacji Android Device Policy.

Parametry
notificationServiceComponentName: ComponentName?

ComponentName usługi rozszerzającej NotificationReceiverService. Jeśli jest podany, musi to być prawidłowy komponent należący do aplikacji wywołującej i wyeksportowany w pliku manifestu. Aby otrzymywać powiadomienia o zdarzeniach związanych z przygotowaniem środowiska, musisz:

  1. Zaimplementuj w aplikacji interfejs EnvironmentListener.

  2. Podaj implementację sposobu obsługi 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óły dotyczące ostatecznego stanu przygotowania środowiska.
Rzuty
com.google.android.managementapi.common.exceptions.InvalidArgumentException

Jeśli:

  • [notificationServiceComponentName] nie jest prawidłowym komponentem należącym do aplikacji wywołującej lub nie jest eksportowany w manifeście.
  • Wymagane role obejmują {@code Role.RoleType.DEVICE_POLICY_CONTROLLER}, a parametr {@code com.google.android.managementapi.environment.model.PrepareEnvironmentRequest.admin} nie jest podany lub nie rozszerza {@code android.app.admin.DeviceAdminReceiver}.
  • Żądane role są nieprawidłowe.
java.lang.SecurityException

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

com.google.android.managementapi.environment.exception.GooglePlayServicesAppNotUpdatedException Jeśli Usługi Google Play są nieaktualne.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallOrUpdateUnrecoverableException Jeśli nie można zainstalować lub zaktualizować aplikacji Android Device Policy i błąd jest nieodwracalny.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallOrUpdateRecoverableException Jeśli nie uda się zainstalować lub zaktualizować aplikacji Android Device Policy, a błąd jest możliwy do naprawienia (np. żądanie nie powiodło się z powodu przejściowych problemów z siecią), żądanie można ponowić.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallConsentDeclinedException Jeśli użytkownik odmówi zainstalowania aplikacji Android Device Policy.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallConsentDismissedException Jeśli użytkownik zamknie ekran zgody na instalację.
com.google.android.managementapi.common.exceptions.InternalException

Jeśli połączenie nie powiodło się z powodu błędu wewnętrznego.

com.google.android.managementapi.environment.exception.PlayStoreUpdateUnrecoverableException Jeśli aktualizacja Sklepu Play nie powiodła się.
com.google.android.managementapi.common.exceptions.ApiLevelException

Jeśli poziom interfejsu API pakietu SDK na urządzeniu jest niewystarczający w przypadku niektórych żądanych ról (może to być dodatkowe wymaganie oprócz ogólnego minimalnego poziomu interfejsu API dla samego połączenia).{@code Role.RoleType.DEVICE_POLICY_CONTROLLER} wymaga poziomu interfejsu API 23 lub wyższego. W przypadku innych ról wymagany jest interfejs API na poziomie 28 lub wyższym.

prepareEnvironmentAsync

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

Przygotowuje środowisko urządzenia.

Wyświetla prośbę o zainstalowanie niezbędnej aplikacji Android Device Policy. Jeśli użytkownik zaakceptuje prośbę, instalacja zostanie przeprowadzona. Po pomyślnej instalacji wykonuje operacje, które zapewniają gotowość aplikacji Android Device Policy.

Parametry
notificationServiceComponentName: ComponentName?

ComponentName usługi rozszerzającej NotificationReceiverService. Jeśli jest podany, musi to być prawidłowy komponent należący do aplikacji wywołującej i wyeksportowany w pliku manifestu. Aby otrzymywać powiadomienia o zdarzeniach związanych z przygotowaniem środowiska, musisz:

  1. Zaimplementuj w aplikacji interfejs EnvironmentListener.

  2. Podaj implementację sposobu obsługi 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 otaczający wynik. Może to być

  • Wartość Future zawierająca PrepareEnvironmentResponse ze szczegółami o ostatecznym stanie przygotowania środowiska.

  • Nieudana przyszłość obejmująca InvalidArgumentException, jeśli:

    • [notificationServiceComponentName] nie jest prawidłowym komponentem należącym do aplikacji wywołującej lub nie jest eksportowany w pliku manifestu.
    • Żądane role są nieprawidłowe.
  • Wymagane role obejmują {@code Role.RoleType.DEVICE_POLICY_CONTROLLER}, a parametr {@code com.google.android.managementapi.environment.model.PrepareEnvironmentRequest.admin} nie jest podany lub nie rozszerza {@code android.app.admin.DeviceAdminReceiver}.

  • Nieudana przyszłość opakowująca

  • Nieudana przyszłość opakowująca SecurityException, jeśli wywołujący nie jest uprawniony do wywoływania tego interfejsu API.

  • Nieudane przyszłe opakowanie GooglePlayServicesAppNotUpdatedException, jeśli Usługi Google Play są nieaktualne.

  • Nieudane zadanie Future opakowujące AndroidDevicePolicyInstallOrUpdateUnrecoverableException, jeśli nie udało się zainstalować lub zaktualizować zasad dotyczących urządzeń z Androidem, a błąd jest nieodwracalny.

  • Nieudane przyszłe opakowanie AndroidDevicePolicyInstallOrUpdateRecoverableException, jeśli nie udało 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ą), więc można ponowić próbę.

  • Nieudane zadanie Future, które zawiera AndroidDevicePolicyInstallConsentDeclinedException, jeśli użytkownik odmówi zainstalowania aplikacji Android Device Policy.

  • Nieudane zadanie Future opakowujące wartość AndroidDevicePolicyInstallConsentDismissedException, jeśli użytkownik zamknie ekran zgody na instalację.

  • Nieudana przyszłość opakowująca InternalException, jeśli wywołanie nie powiodło się z powodu błędu wewnętrznego.

  • Nieudana przyszłość opakowująca PlayStoreUpdateUnrecoverableException, jeśli aktualizacja Sklepu Play się nie powiodła.

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

    Jeśli poziom interfejsu API pakietu SDK urządzenia jest niewystarczający w przypadku niektórych żądanych ról. {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} wymaga interfejsu API na poziomie 23 lub wyższym. W przypadku innych ról wymagany jest interfejs API na poziomie 28 lub wyższym.