EnvironmentClient

interface EnvironmentClient

Client pour accéder aux API liées à l'environnement.

Utilisez EnvironmentClientFactory pour créer une instance.

Résumé

Fonctions publiques
suspend Environment

Renvoie Environment.
ListenableFuture<Environment>

Renvoie Environment.
suspend PrepareEnvironmentResponse
@RequiresApi(value = 28)
prepareEnvironment(
    request: PrepareEnvironmentRequest,
    notificationServiceComponentName: ComponentName?
)

Prépare l'environnement de l'appareil.
ListenableFuture<PrepareEnvironmentResponse>
@RequiresApi(value = 28)
prepareEnvironmentAsync(
    request: PrepareEnvironmentRequest,
    notificationServiceComponentName: ComponentName?
)

Prépare l'environnement de l'appareil.

Fonctions publiques

getEnvironment

@RequiresApi(value = 28)
suspend fun getEnvironment(request: GetEnvironmentRequest): Environment

Renvoie Environment. Il permet à l'appelant de savoir si l'environnement est prêt ou non.

Génère
java.lang.SecurityException

Si l'appelant n'est pas autorisé à appeler cette API.
com.google.android.managementapi.common.exceptions.ApiLevelException

Si le niveau d'API de l'appareil est inférieur à 28.
com.google.android.managementapi.common.exceptions.InvalidArgumentException

Si les rôles demandés ne sont pas valides.
com.google.android.managementapi.common.exceptions.InternalException

Si l'appel a échoué en raison d'une erreur interne.

getEnvironmentAsync

@RequiresApi(value = 28)
fun getEnvironmentAsync(request: GetEnvironmentRequest): ListenableFuture<Environment>

Renvoie Environment. Il permet à l'appelant de savoir si l'environnement est prêt ou non.

Renvoie
ListenableFuture<Environment>

Un ListenableFuture encapsulant le résultat. Il peut s'agir de :

  • Un futur réussi encapsulant un Environment, en cas de succès.

  • Échec d'un futur encapsulant un SecurityException, si l'appelant n'est pas autorisé à appeler cette API.

  • Échec de l'encapsulation d'un ApiLevelException, si le niveau d'API de l'appareil est inférieur à 28.

  • Échec de l'avenir encapsulant un InvalidArgumentException, si les rôles demandés ne sont pas valides.

  • Un futur ayant échoué encapsulant un InternalException, si l'appel a échoué en raison d'une erreur interne.

prepareEnvironment

@RequiresApi(value = 28)
suspend fun prepareEnvironment(
    request: PrepareEnvironmentRequest,
    notificationServiceComponentName: ComponentName?
): PrepareEnvironmentResponse

Prépare l'environnement de l'appareil.

Invite l'utilisateur à installer l'application Android Device Policy nécessaire. Poursuite de l'installation si l'utilisateur accepte l'invite. Une fois l'installation terminée, il effectue des opérations pour s'assurer que l'application Android Device Policy est prête.

Paramètres
notificationServiceComponentName: ComponentName?

ComponentName du service qui étend NotificationReceiverService. Le cas échéant, il doit s'agir d'un composant valide appartenant à l'application appelante et exporté dans le fichier manifeste. Pour recevoir des notifications concernant les événements de préparation de l'environnement, vous devez:

  1. Implémentez l'interface EnvironmentListener dans votre application.

  2. Fournissez une implémentation pour gérer les événements reçus.

  3. Étendez NotificationReceiverService et fournissez une instance EnvironmentListener.

  4. Ajoutez la classe NotificationReceiverService étendue à votre fichier AndroidManifest.xml et assurez-vous qu'elle est exportée.

Exemple :

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

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

PrepareEnvironmentResponse contenant des informations sur l'état final de la préparation de l'environnement.
Génère
com.google.android.managementapi.common.exceptions.InvalidArgumentException

Si :

  • [notificationServiceComponentName] n'est pas un composant valide appartenant à l'application appelante ou n'est pas exporté dans le fichier manifeste.
  • Les rôles demandés ne sont pas valides.
com.google.android.managementapi.common.exceptions.ApiLevelException

Si le niveau d'API de l'appareil est inférieur à 28.
java.lang.SecurityException

Si l'appelant n'est pas autorisé à appeler cette API.

com.google.android.managementapi.environment.exception.GooglePlayServicesAppNotUpdatedException Si les services Google Play ne sont pas à jour.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallOrUpdateUnrecoverableException Si l'installation ou la mise à jour de la stratégie Android pour les appareils échoue et que l'erreur est irrécupérable.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallOrUpdateRecoverableException Si l'application Android Device Policy ne parvient pas à s'installer ou à se mettre à jour, et que l'erreur est récupérable (par exemple, la requête a échoué en raison de problèmes réseau temporaires), la requête peut être réessayée.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallConsentDeclinedException Si l'utilisateur refuse d'installer l'application Android Device Policy.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallConsentDismissedException Si l'utilisateur ignore l'écran de consentement à l'installation.
com.google.android.managementapi.common.exceptions.InternalException

Si l'appel a échoué en raison d'une erreur interne.

prepareEnvironmentAsync

@RequiresApi(value = 28)
fun prepareEnvironmentAsync(
    request: PrepareEnvironmentRequest,
    notificationServiceComponentName: ComponentName?
): ListenableFuture<PrepareEnvironmentResponse>

Prépare l'environnement de l'appareil.

Invite l'utilisateur à installer l'application Android Device Policy nécessaire. Poursuite de l'installation si l'utilisateur accepte l'invite. Une fois l'installation terminée, il effectue des opérations pour s'assurer que l'application Android Device Policy est prête.

Paramètres
notificationServiceComponentName: ComponentName?

ComponentName du service qui étend NotificationReceiverService. Le cas échéant, il doit s'agir d'un composant valide appartenant à l'application appelante et exporté dans le fichier manifeste. Pour recevoir des notifications concernant les événements de préparation de l'environnement, vous devez:

  1. Implémentez l'interface EnvironmentListener dans votre application.

  2. Fournissez une implémentation pour gérer les événements reçus.

  3. Étendez NotificationReceiverService et fournissez une instance EnvironmentListener.

  4. Ajoutez la classe NotificationReceiverService étendue à votre fichier AndroidManifest.xml et assurez-vous qu'elle est exportée.

Exemple :

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

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

Un ListenableFuture encapsulant le résultat. Il peut s'agir de :