EnvironmentClient

interface EnvironmentClient

Client per accedere alle API relative all'ambiente.

Usa EnvironmentClientFactory per creare un'istanza.

Riepilogo

Funzioni pubbliche
suspend Environment

Restituisce il Environment.
ListenableFuture<Environment>

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

Prepara l'ambiente del dispositivo.
ListenableFuture<PrepareEnvironmentResponse>
@RequiresApi(value = 28)
prepareEnvironmentAsync(
    request: PrepareEnvironmentRequest,
    notificationServiceComponentName: ComponentName?
)

Prepara l'ambiente del dispositivo.

Funzioni pubbliche

getEnvironment

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

Restituisce il Environment. Aiuta il chiamante a sapere se l'ambiente è pronto o meno.

Lanci
java.lang.SecurityException

Se il chiamante non è autorizzato a chiamare questa API.
com.google.android.managementapi.common.exceptions.ApiLevelException

Se il livello API del dispositivo è inferiore a 28.
com.google.android.managementapi.common.exceptions.InvalidArgumentException

Se i ruoli richiesti non sono validi.
com.google.android.managementapi.common.exceptions.InternalException

Se la chiamata non è andata a buon fine a causa di un errore interno.

getEnvironmentAsync

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

Restituisce il Environment. Aiuta il chiamante a sapere se l'ambiente è pronto o meno.

Resi
ListenableFuture<Environment>

Un ListenableFuture che racchiude il risultato. ad esempio:

  • Un futuro riuscito che racchiude un Environment, in caso di esito positivo.

  • Un futuro non riuscito che avvolge un SecurityException, se chi chiama non è autorizzato a chiamare questa API.

  • Un wrapping futuro non riuscito di un ApiLevelException, se il livello API del dispositivo è inferiore a 28.

  • Un futuro non riuscito che racchiude un InvalidArgumentException, se i ruoli richiesti non sono validi.

  • Un futuro non riuscito che avvolge un InternalException, se la chiamata non è riuscita a causa di un errore interno.

prepareEnvironment

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

Prepara l'ambiente del dispositivo.

Chiede all'utente di installare l'applicazione Android Device Policy necessaria. Procede con l'installazione se l'utente accetta la richiesta. Dopo l'installazione, esegue operazioni per assicurarsi che l'app Android Device Policy sia pronta.

Parametri
notificationServiceComponentName: ComponentName?

Il ComponentName del servizio che estende NotificationReceiverService. Se fornito, deve essere un componente valido appartenente all'app chiamante ed esportato nel manifest. Per ricevere notifiche sugli eventi di preparazione dell'ambiente, devi:

  1. Implementa l'interfaccia EnvironmentListener nella tua app.

  2. Fornisci un'implementazione per la gestione degli eventi ricevuti.

  3. Estendi NotificationReceiverService e fornisci un'istanza EnvironmentListener.

  4. Aggiungi la classe NotificationReceiverService estesa ad AndroidManifest.xml e assicurati che sia esportata.

Ad esempio:

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

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

PrepareEnvironmentResponse contenente i dettagli sullo stato finale della preparazione dell'ambiente.
Lanci
com.google.android.managementapi.common.exceptions.InvalidArgumentException

Se:

  • [notificationServiceComponentName] non è un componente valido appartenente all'app chiamante o non esportato nel file manifest.
  • I ruoli richiesti non sono validi.
com.google.android.managementapi.common.exceptions.ApiLevelException

Se il livello API del dispositivo è inferiore a 28.
java.lang.SecurityException

Se il chiamante non è autorizzato a chiamare questa API.

com.google.android.managementapi.environment.exception.GooglePlayServicesAppNotUpdatedException Se Google Play Services non è aggiornato.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallOrUpdateUnrecoverableException Se l'installazione o l'aggiornamento di Android Device Policy non va a buon fine e l'errore non è recuperabile.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallOrUpdateRecoverableException Se l'app Android Device Policy non riesce a installarsi o aggiornarsi e l'errore è recuperabile (ad es. la richiesta non è riuscita a causa di problemi temporanei di rete), la richiesta può essere riprovata.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallConsentDeclinedException Se l'utente rifiuta di installare l'app Android Device Policy.

com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallConsentDismissedException Se l'utente ignora la schermata per il consenso all'installazione.
com.google.android.managementapi.common.exceptions.InternalException

Se la chiamata non è andata a buon fine a causa di un errore interno.

prepareEnvironmentAsync

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

Prepara l'ambiente del dispositivo.

Chiede all'utente di installare l'applicazione Android Device Policy necessaria. Procede con l'installazione se l'utente accetta la richiesta. Dopo l'installazione, esegue operazioni per assicurarsi che l'app Android Device Policy sia pronta.

Parametri
notificationServiceComponentName: ComponentName?

Il ComponentName del servizio che estende NotificationReceiverService. Se fornito, deve essere un componente valido appartenente all'app chiamante ed esportato nel manifest. Per ricevere notifiche sugli eventi di preparazione dell'ambiente, devi:

  1. Implementa l'interfaccia EnvironmentListener nella tua app.

  2. Fornisci un'implementazione per la gestione degli eventi ricevuti.

  3. Estendi NotificationReceiverService e fornisci un'istanza EnvironmentListener.

  4. Aggiungi la classe NotificationReceiverService estesa ad AndroidManifest.xml e assicurati che sia esportata.

Ad esempio:

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

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

Un ListenableFuture che racchiude il risultato. Può essere