EnvironmentClient

interface EnvironmentClient

Cliente para acessar APIs relacionadas ao ambiente.

Use EnvironmentClientFactory para criar uma instância.

Resumo

Funções públicas
suspend Environment

Retorna o Environment.
ListenableFuture<Environment>

Retorna o Environment.
suspend PrepareEnvironmentResponse
prepareEnvironment(
    request: PrepareEnvironmentRequest,
    notificationServiceComponentName: ComponentName?
)

Prepara o ambiente do dispositivo.
ListenableFuture<PrepareEnvironmentResponse>
prepareEnvironmentAsync(
    request: PrepareEnvironmentRequest,
    notificationServiceComponentName: ComponentName?
)

Prepara o ambiente do dispositivo.

Funções públicas

getEnvironment

suspend fun getEnvironment(request: GetEnvironmentRequest): Environment

Retorna o Environment. Ajuda o autor da chamada a saber se o ambiente está pronto ou não.

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

Se as funções solicitadas não forem válidas.
com.google.android.managementapi.common.exceptions.InternalException

Se a chamada falhou devido a um erro interno.
com.google.android.managementapi.common.exceptions.ApiLevelException

Se o nível da API do SDK do dispositivo for insuficiente para determinadas funções solicitadas (além de um requisito geral de nível mínimo de API para a própria chamada). {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} exige o nível 23 da API ou mais recente. Todas as outras funções exigem o nível 28 da API ou mais recente.

getEnvironmentAsync

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

Retorna o Environment. Ajuda o autor da chamada a saber se o ambiente está pronto ou não.

Retorna
ListenableFuture<Environment>

Um ListenableFuture que envolve o resultado. Pode ser o seguinte:

  • Um futuro bem-sucedido que envolve um Environment, em caso de sucesso.

  • Um futuro com falha que envolve um

  • Um futuro com falha que envolve um InvalidArgumentException, se as funções solicitadas não forem válidas.

  • Um futuro com falha que envolve um InternalException, se a chamada falhar devido a um erro interno.
Gera
com.google.android.managementapi.common.exceptions.ApiLevelException

Se o nível da API do SDK do dispositivo for insuficiente para determinadas funções solicitadas (além de um requisito geral de nível mínimo de API para a própria chamada). {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} exige o nível 23 da API ou mais recente. Todas as outras funções exigem o nível 28 da API ou mais recente.

prepareEnvironment

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

Prepara o ambiente do dispositivo.

Solicita que o usuário instale o aplicativo Android Device Policy necessário. Continua com a instalação se o usuário aceitar a solicitação. Após a instalação, ele realiza operações para garantir que o app Android Device Policy esteja pronto.

Parâmetros
notificationServiceComponentName: ComponentName?

O ComponentName do serviço que estende NotificationReceiverService. Se fornecido, ele precisa ser um componente válido pertencente ao app de chamada e exportado no manifesto. Para receber notificações sobre eventos de preparação do ambiente, você precisa:

  1. Implemente a interface EnvironmentListener no seu app.

  2. Forneça uma implementação de como processar os eventos recebidos.

  3. Estenda o NotificationReceiverService e forneça uma instância EnvironmentListener.

  4. Adicione a classe NotificationReceiverService estendida ao AndroidManifest.xml e verifique se ela foi exportada.

Exemplo:

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

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

PrepareEnvironmentResponse que contém detalhes sobre o status final da preparação do ambiente.
Gera
com.google.android.managementapi.common.exceptions.InvalidArgumentException

Se:

  • [notificationServiceComponentName] não é um componente válido do app de chamada ou não foi exportado no manifesto.
  • As funções solicitadas incluem {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} e o {@code com.google.android.managementapi.environment.model.PrepareEnvironmentRequest.admin} não é fornecido ou não estende {@code android.app.admin.DeviceAdminReceiver}.
  • As funções solicitadas não são válidas.
java.lang.SecurityException

Se o autor da chamada não tiver autorização para chamar essa API.

com.google.android.managementapi.environment.exception.GooglePlayServicesAppNotUpdatedException Se o Google Play Services não estiver atualizado.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallOrUpdateUnrecoverableException Se a Política de dispositivo Android não for instalada ou atualizada e o erro for irrecuperável.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallOrUpdateRecoverableException Se o app Android Device Policy não for instalado ou atualizado e o erro for recuperável (por exemplo, a solicitação falhou devido a problemas de rede temporários), a solicitação poderá ser repetida.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallConsentDeclinedException Se o usuário recusar a instalação do app Android Device Policy.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallConsentDismissedException Se o usuário dispensar a tela de consentimento de instalação.
com.google.android.managementapi.common.exceptions.InternalException

Se a chamada falhou devido a um erro interno.

com.google.android.managementapi.environment.exception.PlayStoreUpdateUnrecoverableException Se a atualização da Play Store falhou.
com.google.android.managementapi.common.exceptions.ApiLevelException

Se o nível da API do SDK do dispositivo for insuficiente para determinadas funções solicitadas (além de um requisito geral de nível mínimo da API para a própria chamada).{@code Role.RoleType.DEVICE_POLICY_CONTROLLER} exige o nível 23 da API ou mais recente. Todas as outras funções exigem o nível 28 da API ou mais recente.

prepareEnvironmentAsync

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

Prepara o ambiente do dispositivo.

Solicita que o usuário instale o aplicativo Android Device Policy necessário. Continua com a instalação se o usuário aceitar a solicitação. Após a instalação, ele realiza operações para garantir que o app Android Device Policy esteja pronto.

Parâmetros
notificationServiceComponentName: ComponentName?

O ComponentName do serviço que estende NotificationReceiverService. Se fornecido, ele precisa ser um componente válido pertencente ao app de chamada e exportado no manifesto. Para receber notificações sobre eventos de preparação do ambiente, você precisa:

  1. Implemente a interface EnvironmentListener no seu app.

  2. Forneça uma implementação de como processar os eventos recebidos.

  3. Estenda o NotificationReceiverService e forneça uma instância EnvironmentListener.

  4. Adicione a classe NotificationReceiverService estendida ao AndroidManifest.xml e verifique se ela foi exportada.

Exemplo:

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

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

Um ListenableFuture que envolve o resultado. Isso pode ser

  • Um futuro bem-sucedido que envolve um PrepareEnvironmentResponse com detalhes sobre o status final da preparação do ambiente.

  • Um futuro com falha que envolve um InvalidArgumentException se:

    • [notificationServiceComponentName] não é um componente válido do app de chamada ou não foi exportado no manifesto.
    • As funções solicitadas não são válidas.
  • As funções solicitadas incluem {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} e o {@code com.google.android.managementapi.environment.model.PrepareEnvironmentRequest.admin} não é fornecido ou não estende {@code android.app.admin.DeviceAdminReceiver}.

  • Um futuro com falha que envolve um

  • Um futuro com falha que envolve um SecurityException, se o autor da chamada não tiver autorização para chamar essa API.

  • Um futuro com falha que envolve um GooglePlayServicesAppNotUpdatedException se o Google Play Services não estiver atualizado.

  • Um futuro com falha que envolve um AndroidDevicePolicyInstallOrUpdateUnrecoverableException se a Política de dispositivo Android não for instalada ou atualizada e o erro for irrecuperável.

  • Um futuro com falha que envolve um AndroidDevicePolicyInstallOrUpdateRecoverableException se o app Android Device Policy não for instalado ou atualizado e o erro for recuperável (por exemplo, a solicitação falhou devido a problemas transitórios de rede), para que a solicitação possa ser repetida.

  • Um futuro com falha que envolve um AndroidDevicePolicyInstallConsentDeclinedException se o usuário recusar a instalação do app Android Device Policy.

  • Um futuro com falha que envolve um AndroidDevicePolicyInstallConsentDismissedException se o usuário dispensar a tela de consentimento de instalação.

  • Um futuro com falha que envolve um InternalException, se a chamada falhar devido a um erro interno.

  • Um futuro com falha que envolve um PlayStoreUpdateUnrecoverableException se a atualização da Play Store falhar.

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

    Se o nível da API do SDK do dispositivo for insuficiente para determinadas funções solicitadas. {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} exige o nível 23 da API ou mais recente. Todas as outras funções exigem o nível 28 da API ou mais recente.