EnvironmentClient

public interface EnvironmentClient

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
@RequiresApi(value = 28)
prepareEnvironment(
    @NonNull PrepareEnvironmentRequest request,
    ComponentName notificationServiceComponentName
)

Prepara el entorno del dispositivo.
abstract @NonNull ListenableFuture<@NonNull PrepareEnvironmentResponse>
@RequiresApi(value = 28)
prepareEnvironmentAsync(
    @NonNull PrepareEnvironmentRequest request,
    ComponentName notificationServiceComponentName
)

Prepara el entorno del dispositivo.

Métodos públicos

getEnvironment

@RequiresApi(value = 28)
abstract @NonNull Environment getEnvironment(@NonNull GetEnvironmentRequest request)

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

Arroja
java.lang.SecurityException

Si el emisor no está autorizado para llamar a esta API.
com.google.android.managementapi.common.exceptions.ApiLevelException

Si el nivel de API del dispositivo es inferior a 28.
com.google.android.managementapi.common.exceptions.InvalidArgumentException

Si los roles solicitados no son válidos.
com.google.android.managementapi.common.exceptions.InternalException

Si la llamada falló debido a un error interno.

getEnvironmentAsync

@RequiresApi(value = 28)
abstract @NonNull ListenableFuture<@NonNull Environment> getEnvironmentAsync(@NonNull GetEnvironmentRequest request)

Devuelve el Environment. Ayuda al llamador 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 une un Environment, en caso de éxito.

  • Un futuro fallido que une un SecurityException, si el llamador no está autorizado para llamar a esta API.

  • Un error de unión futura de un ApiLevelException si el nivel de API del dispositivo es inferior a 28

  • Un futuro que une un InvalidArgumentException falló 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.

prepareEnvironment

@RequiresApi(value = 28)
abstract @NonNull PrepareEnvironmentResponse prepareEnvironment(
    @NonNull PrepareEnvironmentRequest request,
    ComponentName notificationServiceComponentName
)

Prepara el entorno del dispositivo.

Le solicita al usuario que instale la aplicación de Android Device Policy necesaria. Continúa con la instalación si el usuario acepta el mensaje. Después de una instalación correcta, realiza operaciones para asegurarse de que la app de Android Device Policy esté lista.

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 que realiza la llamada y que se haya exportado 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 no son válidos.
com.google.android.managementapi.common.exceptions.ApiLevelException

Si el nivel de API del dispositivo es inferior a 28.
java.lang.SecurityException

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

com.google.android.managementapi.environment.exception.GooglePlayServicesAppNotUpdatedException Si los Servicios de Google Play no están actualizados.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallOrUpdateUnrecoverableException Si la política de dispositivos Android no se instala o no se actualiza, y el error no se puede recuperar.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallOrUpdateRecoverableException Si la app de la Política de dispositivos Android no se instala o no se actualiza, y el error se puede recuperar (p.ej., la solicitud falló debido a problemas transitorios de red), se puede volver a intentar la solicitud.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallConsentDeclinedException Si el usuario rechaza instalar la app de Android Device Policy.

com.google.android.managementapi.environment.exception.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.

prepareEnvironmentAsync

@RequiresApi(value = 28)
abstract @NonNull ListenableFuture<@NonNull PrepareEnvironmentResponse> prepareEnvironmentAsync(
    @NonNull PrepareEnvironmentRequest request,
    ComponentName notificationServiceComponentName
)

Prepara el entorno del dispositivo.

Le solicita al usuario que instale la aplicación de Android Device Policy necesaria. Continúa con la instalación si el usuario acepta el mensaje. Después de una instalación correcta, realiza operaciones para asegurarse de que la app de Android Device Policy esté lista.

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 que realiza la llamada y que se haya exportado 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