EnvironmentClient

public interface EnvironmentClient


Es el cliente para acceder a las APIs relacionadas con el entorno.

Usa EnvironmentClientFactory para crear una instancia.

Resumen

Métodos públicos

abstract @NonNull Environment

Devuelve el Environment.

abstract @NonNull ListenableFuture<@NonNull Environment>

Devuelve el Environment.

abstract @NonNull PrepareEnvironmentResponse
prepareEnvironment(
    @NonNull PrepareEnvironmentRequest request,
    ComponentName notificationServiceComponentName
)

Prepara el dispositivo asegurándose de que la app de Android Device Policy esté instalada y lista.

abstract @NonNull ListenableFuture<@NonNull PrepareEnvironmentResponse>
prepareEnvironmentAsync(
    @NonNull PrepareEnvironmentRequest request,
    ComponentName notificationServiceComponentName
)

Prepara el dispositivo asegurándose de que la app de Android Device Policy esté instalada y lista.

Métodos públicos

getEnvironment

abstract @NonNull Environment getEnvironment(@NonNull GetEnvironmentRequest request)

Devuelve el Environment. Ayuda al emisor a saber si el entorno está listo o no.

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

Si los roles solicitados no son válidos o si alguno de ellos tiene configurado extraCapabilities. El administrador de TI otorga funciones adicionales en la política del dispositivo, y la app no puede solicitarlas.

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

Si la llamada falló debido a un error interno.

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

Si el nivel de API del SDK del dispositivo no es suficiente para ciertos roles solicitados (esto puede ser adicional a un requisito general de nivel de API mínimo para la llamada en sí) {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} requiere el nivel de API 23 o uno superior. Cualquier otro rol requiere el nivel de API 28 o uno superior.

getEnvironmentAsync

abstract @NonNull ListenableFuture<@NonNull Environment> getEnvironmentAsync(@NonNull GetEnvironmentRequest request)

Devuelve el Environment. Ayuda al emisor a saber si el entorno está listo o no.

Muestra
@NonNull ListenableFuture<@NonNull Environment>

Un ListenableFuture que une el resultado Puede ser:

  • Un futuro exitoso que une un Environment, en caso de éxito.

  • Un futuro con errores que une un InvalidArgumentException, si los roles solicitados no son válidos.

  • Un futuro con errores que une un InternalException, si la llamada falló debido a un error interno.

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

Si alguno de los roles solicitados tiene configurado extraCapabilities. El administrador de TI otorga funciones adicionales en la política del dispositivo, y la app no puede solicitarlas.

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

Si el nivel de API del SDK del dispositivo no es suficiente para ciertos roles solicitados (esto puede ser adicional a un requisito general de nivel de API mínimo para la llamada en sí) {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} requiere el nivel de API 23 o uno superior. Cualquier otro rol requiere el nivel de API 28 o uno superior.

prepareEnvironment

abstract @NonNull PrepareEnvironmentResponse prepareEnvironment(
    @NonNull PrepareEnvironmentRequest request,
    ComponentName notificationServiceComponentName
)

Prepara el dispositivo asegurándose de que la app de Android Device Policy esté instalada y lista.

El comportamiento depende del contexto:

  • Flujo de confianza del dispositivo: Si la app de política de dispositivo Android no está instalada, se le solicita al usuario que la instale. Si la app ya está instalada, se actualiza de forma silenciosa.

  • Flujo de inscripción de dispositivos: Instala de forma silenciosa la app de Android Device Policy si aún no está instalada y se asegura de que esté lista para usarse, sin interacción del usuario.

Parámetros
ComponentName notificationServiceComponentName

El ComponentName del servicio que extiende NotificationReceiverService. Si se proporciona, debe ser un componente válido que pertenezca a la app de llamadas y que se exporte en el manifiesto. Para recibir notificaciones sobre los eventos de preparación del entorno, debes hacer lo siguiente:

  1. Implementa la interfaz EnvironmentListener en tu app.

  2. Proporciona una implementación para controlar los eventos recibidos.

  3. Extiende NotificationReceiverService y proporciona una instancia de EnvironmentListener.

  4. Agrega la clase NotificationReceiverService extendida a tu AndroidManifest.xml y asegúrate de que se exporte.

Por ejemplo:

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

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

PrepareEnvironmentResponse que contiene detalles sobre el estado final de la preparación del entorno.

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

Si:

  • [notificationServiceComponentName] no es un componente válido que pertenezca a la app que realiza la llamada o no se exportó en el manifiesto.
  • Los roles solicitados incluyen {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} y no se proporciona {@code com.google.android.managementapi.environment.model.PrepareEnvironmentRequest.admin} o no extiende {@code android.app.admin.DeviceAdminReceiver}.
  • Los roles solicitados no son válidos.
  • Cualquiera de los roles solicitados tiene configurado extraCapabilities. El administrador de TI otorga capacidades adicionales en la política del dispositivo, y la app no puede solicitarlas.
SecurityException

Si el emisor no está autorizado para llamar a esta API

GooglePlayServicesAppNotUpdatedException

Si los Servicios de Google Play no están actualizados

AndroidDevicePolicyInstallOrUpdateUnrecoverableException

Si la política de dispositivo Android no se instala o actualiza, y el error es irrecuperable.

AndroidDevicePolicyInstallOrUpdateRecoverableException

Si la app de política de dispositivo Android no se instala o actualiza, y el error es recuperable (p.ej., la solicitud falló debido a problemas de red transitorios), se puede volver a intentar la solicitud.

AndroidDevicePolicyInstallConsentDeclinedException

Si el usuario rechaza instalar la app de política de dispositivo Android.

AndroidDevicePolicyInstallConsentDismissedException

Si el usuario descarta la pantalla de consentimiento de instalación

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

Si la llamada falló debido a un error interno.

PlayStoreUpdateUnrecoverableException

Si se produjo un error en la actualización de Play Store

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

Si el nivel de API del SDK del dispositivo no es suficiente para ciertos roles solicitados (esto puede ser adicional a un requisito general de nivel de API mínimo para la llamada en sí).{@code Role.RoleType.DEVICE_POLICY_CONTROLLER} requiere el nivel de API 23 o uno posterior. Cualquier otro rol requiere el nivel de API 28 o uno superior.

prepareEnvironmentAsync

abstract @NonNull ListenableFuture<@NonNull PrepareEnvironmentResponse> prepareEnvironmentAsync(
    @NonNull PrepareEnvironmentRequest request,
    ComponentName notificationServiceComponentName
)

Prepara el dispositivo asegurándose de que la app de Android Device Policy esté instalada y lista.

El comportamiento depende del contexto:

  • Flujo de confianza del dispositivo: Si la app de política de dispositivo Android no está instalada, se le solicita al usuario que la instale. Si la app ya está instalada, se actualiza de forma silenciosa.

  • Flujo de inscripción de dispositivos: Instala de forma silenciosa la app de Android Device Policy si aún no está instalada y se asegura de que esté lista para usarse, sin interacción del usuario.

Parámetros
ComponentName notificationServiceComponentName

El ComponentName del servicio que extiende NotificationReceiverService. Si se proporciona, debe ser un componente válido que pertenezca a la app de llamadas y que se exporte en el manifiesto. Para recibir notificaciones sobre los eventos de preparación del entorno, debes hacer lo siguiente:

  1. Implementa la interfaz EnvironmentListener en tu app.

  2. Proporciona una implementación para controlar los eventos recibidos.

  3. Extiende NotificationReceiverService y proporciona una instancia de EnvironmentListener.

  4. Agrega la clase NotificationReceiverService extendida a tu AndroidManifest.xml y asegúrate de que se exporte.

Por ejemplo:

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

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

Un ListenableFuture que une el resultado Puede ser uno de los siguientes:

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

Si alguno de los roles solicitados tiene configurado extraCapabilities. El administrador de TI otorga funciones adicionales en la política del dispositivo, y la app no puede solicitarlas.

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

Si el nivel de API del SDK del dispositivo no es suficiente para ciertos roles solicitados {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} requiere el nivel de API 23 o uno superior. Cualquier otro rol requiere el nivel de API 28 o uno superior.