EnvironmentClient

Öffentliche Funktionen
`suspend Environment`	`getEnvironment(request: GetEnvironmentRequest)` Gibt die `Environment` zurück.
`ListenableFuture<Environment>`	`getEnvironmentAsync(request: GetEnvironmentRequest)` Gibt die `Environment` zurück.
`suspend PrepareEnvironmentResponse`	`prepareEnvironment( request: PrepareEnvironmentRequest, notificationServiceComponentName: ComponentName? )` Bereitet die Geräteumgebung vor.
`ListenableFuture<PrepareEnvironmentResponse>`	`prepareEnvironmentAsync( request: PrepareEnvironmentRequest, notificationServiceComponentName: ComponentName? )` Bereitet die Geräteumgebung vor.

getEnvironment

suspend fun getEnvironment(request: GetEnvironmentRequest): Environment

Gibt die Environment zurück. So kann der Anrufer erkennen, ob die Umgebung bereit ist oder nicht.

Löst
`com.google.android.managementapi.common.exceptions.InvalidArgumentException`	Wenn die angeforderten Rollen ungültig sind.
`com.google.android.managementapi.common.exceptions.InternalException`	Wenn der Anruf aufgrund eines internen Fehlers fehlgeschlagen ist.
`com.google.android.managementapi.common.exceptions.ApiLevelException`	Das SDK-API-Level des Geräts ist für bestimmte angeforderte Rollen nicht ausreichend. Dies kann zusätzlich zu einer allgemeinen Mindest-API-Level-Anforderung für den Aufruf selbst gelten. {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} erfordert API-Level 23 oder höher. Für alle anderen Rollen ist API‑Level 28 oder höher erforderlich.

getEnvironmentAsync

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

Gibt die Environment zurück. So kann der Anrufer erkennen, ob die Umgebung bereit ist oder nicht.

Ausgabe

Ausgabe
`ListenableFuture<Environment>`	Ein `ListenableFuture`, das das Ergebnis umschließt. Dieser kann folgendermaßen lauten: Ein erfolgreiches Future, das ein `Environment` umschließt, falls der Vorgang erfolgreich ist. Ein fehlgeschlagenes Future, das `InvalidArgumentException` umschließt, wenn die angeforderten Rollen ungültig sind. Ein fehlgeschlagenes Future, das ein `InternalException` umschließt, wenn der Aufruf aufgrund eines internen Fehlers fehlgeschlagen ist.

ListenableFuture<Environment>

Ein ListenableFuture, das das Ergebnis umschließt. Dieser kann folgendermaßen lauten:

Ein erfolgreiches Future, das ein Environment umschließt, falls der Vorgang erfolgreich ist.
Ein fehlgeschlagenes Future, das InvalidArgumentException umschließt, wenn die angeforderten Rollen ungültig sind.
Ein fehlgeschlagenes Future, das ein InternalException umschließt, wenn der Aufruf aufgrund eines internen Fehlers fehlgeschlagen ist.

Löst
`com.google.android.managementapi.common.exceptions.ApiLevelException`	Das SDK-API-Level des Geräts ist für bestimmte angeforderte Rollen nicht ausreichend. Dies kann zusätzlich zu einer allgemeinen Mindest-API-Level-Anforderung für den Aufruf selbst gelten. {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} erfordert API-Level 23 oder höher. Für alle anderen Rollen ist API‑Level 28 oder höher erforderlich.

prepareEnvironment

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

Bereitet die Geräteumgebung vor.

Der Nutzer wird aufgefordert, die erforderliche Android Device Policy App zu installieren. Die Installation wird fortgesetzt, wenn der Nutzer die Aufforderung akzeptiert. Nach der erfolgreichen Installation werden Vorgänge ausgeführt, um sicherzustellen, dass die Android Device Policy App bereit ist.

Parameter

Parameter
`notificationServiceComponentName: ComponentName?`	Die `ComponentName` des Dienstes, der `NotificationReceiverService` erweitert. Falls angegeben, muss es sich um eine gültige Komponente der aufrufenden App handeln, die im Manifest exportiert wird. Damit Sie Benachrichtigungen zu Ereignissen zur Vorbereitung der Umgebung erhalten, müssen Sie Folgendes tun: Implementieren Sie die `EnvironmentListener`-Schnittstelle in Ihrer App. Geben Sie eine Implementierung für die Verarbeitung der empfangenen Ereignisse an. Erweitern Sie NotificationReceiverService und stellen Sie eine `EnvironmentListener`-Instanz bereit. Fügen Sie die erweiterte NotificationReceiverService-Klasse zu Ihrer Datei „AndroidManifest.xml“ hinzu und sorgen Sie dafür, dass sie exportiert wird. Beispiel: class MyEnvironmentListener : EnvironmentListener { override fun onEnvironmentEvent(event: EnvironmentEvent) { // Handle the environment event. } } class MyNotificationReceiverService : NotificationReceiverService() { override fun getPrepareEnvironmentListener(): EnvironmentListener? { return MyEnvironmentListener() } }

notificationServiceComponentName: ComponentName?

Die ComponentName des Dienstes, der NotificationReceiverService erweitert. Falls angegeben, muss es sich um eine gültige Komponente der aufrufenden App handeln, die im Manifest exportiert wird. Damit Sie Benachrichtigungen zu Ereignissen zur Vorbereitung der Umgebung erhalten, müssen Sie Folgendes tun:

Implementieren Sie die EnvironmentListener-Schnittstelle in Ihrer App.
Geben Sie eine Implementierung für die Verarbeitung der empfangenen Ereignisse an.
Erweitern Sie NotificationReceiverService und stellen Sie eine EnvironmentListener-Instanz bereit.
Fügen Sie die erweiterte NotificationReceiverService-Klasse zu Ihrer Datei „AndroidManifest.xml“ hinzu und sorgen Sie dafür, dass sie exportiert wird.

Beispiel:

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

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

Ausgabe
`PrepareEnvironmentResponse`	`PrepareEnvironmentResponse` mit Details zum endgültigen Status der Umgebungsvorbereitung.

Löst
`com.google.android.managementapi.common.exceptions.InvalidArgumentException`	Wenn: [notificationServiceComponentName] ist keine gültige Komponente der aufrufenden App oder wurde nicht im Manifest exportiert. Die angeforderten Rollen enthalten {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} und {@code com.google.android.managementapi.environment.model.PrepareEnvironmentRequest.admin} wird nicht bereitgestellt oder erweitert nicht {@code android.app.admin.DeviceAdminReceiver}. Die angeforderten Rollen sind ungültig.
`java.lang.SecurityException`	Wenn der Aufrufer nicht berechtigt ist, diese API aufzurufen.
`com.google.android.managementapi.environment.GooglePlayServicesAppNotUpdatedException`	Wenn die Google Play-Dienste nicht auf dem neuesten Stand sind.
`com.google.android.managementapi.environment.AndroidDevicePolicyInstallOrUpdateUnrecoverableException`	Wenn die Android Device Policy App nicht installiert oder aktualisiert werden kann und der Fehler nicht behoben werden kann.
`com.google.android.managementapi.environment.AndroidDevicePolicyInstallOrUpdateRecoverableException`	Wenn die Android Device Policy App nicht installiert oder aktualisiert werden kann und der Fehler behoben werden kann (z.B. wenn die Anfrage aufgrund vorübergehender Netzwerkprobleme fehlgeschlagen ist), kann die Anfrage noch einmal gesendet werden.
`com.google.android.managementapi.environment.AndroidDevicePolicyInstallConsentDeclinedException`	Wenn der Nutzer die Installation der Android Device Policy App ablehnt.
`com.google.android.managementapi.environment.AndroidDevicePolicyInstallConsentDismissedException`	Wenn der Nutzer den Bildschirm für die Einwilligung zur Installation schließt.
`com.google.android.managementapi.common.exceptions.InternalException`	Wenn der Anruf aufgrund eines internen Fehlers fehlgeschlagen ist.
`com.google.android.managementapi.environment.PlayStoreUpdateUnrecoverableException`	Wenn das Play Store-Update fehlgeschlagen ist.
`com.google.android.managementapi.common.exceptions.ApiLevelException`	Wenn das SDK-API-Level des Geräts für bestimmte angeforderte Rollen nicht ausreicht (dies kann zusätzlich zu einer allgemeinen Mindest-API-Level-Anforderung für den Aufruf selbst gelten).{@code Role.RoleType.DEVICE_POLICY_CONTROLLER} erfordert API-Level 23 oder höher. Für alle anderen Rollen ist API‑Level 28 oder höher erforderlich.

prepareEnvironmentAsync

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

Bereitet die Geräteumgebung vor.

Der Nutzer wird aufgefordert, die erforderliche Android Device Policy App zu installieren. Die Installation wird fortgesetzt, wenn der Nutzer die Aufforderung akzeptiert. Nach der erfolgreichen Installation werden Vorgänge ausgeführt, um sicherzustellen, dass die Android Device Policy App bereit ist.

Parameter

Parameter
`notificationServiceComponentName: ComponentName?`	Die `ComponentName` des Dienstes, der `NotificationReceiverService` erweitert. Falls angegeben, muss es sich um eine gültige Komponente der aufrufenden App handeln, die im Manifest exportiert wird. Damit Sie über Ereignisse zur Vorbereitung der Umgebung benachrichtigt werden, müssen Sie Folgendes tun: Implementieren Sie die `EnvironmentListener`-Schnittstelle in Ihrer App. Geben Sie eine Implementierung für die Verarbeitung der empfangenen Ereignisse an. Erweitern Sie NotificationReceiverService und stellen Sie eine `EnvironmentListener`-Instanz bereit. Fügen Sie die erweiterte NotificationReceiverService-Klasse zu Ihrer Datei „AndroidManifest.xml“ hinzu und sorgen Sie dafür, dass sie exportiert wird. Beispiel: class MyEnvironmentListener : EnvironmentListener { override fun onEnvironmentEvent(event: EnvironmentEvent) { // Handle the environment event. } } class MyNotificationReceiverService : NotificationReceiverService() { override fun getPrepareEnvironmentListener(): EnvironmentListener? { return MyEnvironmentListener() } }

notificationServiceComponentName: ComponentName?

Die ComponentName des Dienstes, der NotificationReceiverService erweitert. Falls angegeben, muss es sich um eine gültige Komponente der aufrufenden App handeln, die im Manifest exportiert wird. Damit Sie über Ereignisse zur Vorbereitung der Umgebung benachrichtigt werden, müssen Sie Folgendes tun:

Implementieren Sie die EnvironmentListener-Schnittstelle in Ihrer App.
Geben Sie eine Implementierung für die Verarbeitung der empfangenen Ereignisse an.
Erweitern Sie NotificationReceiverService und stellen Sie eine EnvironmentListener-Instanz bereit.
Fügen Sie die erweiterte NotificationReceiverService-Klasse zu Ihrer Datei „AndroidManifest.xml“ hinzu und sorgen Sie dafür, dass sie exportiert wird.

Beispiel:

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

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

Ausgabe

Ausgabe
`ListenableFuture<PrepareEnvironmentResponse>`	Ein `ListenableFuture`, das das Ergebnis umschließt. Das kann Ein erfolgreiches Future, das ein `PrepareEnvironmentResponse` mit Details zum endgültigen Status der Umgebungsvorbereitung enthält. Ein fehlgeschlagenes Future, das `InvalidArgumentException` umschließt, wenn: [notificationServiceComponentName] ist keine gültige Komponente der aufrufenden App oder wurde nicht im Manifest exportiert. Die angeforderten Rollen sind ungültig. Die angeforderten Rollen enthalten {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} und {@code com.google.android.managementapi.environment.model.PrepareEnvironmentRequest.admin} wird nicht bereitgestellt oder erweitert nicht {@code android.app.admin.DeviceAdminReceiver}. Ein fehlgeschlagenes Future, das `SecurityException` umschließt, wenn der Aufrufer nicht berechtigt ist, diese API aufzurufen. Ein fehlgeschlagenes zukünftiges Wrapping von `GooglePlayServicesAppNotUpdatedException`, wenn die Google Play-Dienste nicht auf dem neuesten Stand sind. Ein fehlgeschlagenes Future, das `AndroidDevicePolicyInstallOrUpdateUnrecoverableException` umschließt, wenn die Android Device Policy nicht installiert oder aktualisiert werden kann und der Fehler nicht behoben werden kann. Ein fehlgeschlagenes Future, das `AndroidDevicePolicyInstallOrUpdateRecoverableException` umschließt, wenn die Android Device Policy App nicht installiert oder aktualisiert werden kann und der Fehler behoben werden kann (z.B. wenn die Anfrage aufgrund vorübergehender Netzwerkprobleme fehlgeschlagen ist), sodass die Anfrage noch einmal versucht werden kann. Ein fehlgeschlagenes zukünftiges Wrapping einer `AndroidDevicePolicyInstallConsentDeclinedException`, wenn der Nutzer die Installation der Android Device Policy App ablehnt. Ein fehlgeschlagenes Future, das `AndroidDevicePolicyInstallConsentDismissedException` umschließt, wenn der Nutzer den Bildschirm mit der Installationszustimmung schließt. Ein fehlgeschlagenes Future, das ein `InternalException` umschließt, wenn der Aufruf aufgrund eines internen Fehlers fehlgeschlagen ist. Ein fehlgeschlagenes Future, das `PlayStoreUpdateUnrecoverableException` umschließt, wenn das Play Store-Update fehlgeschlagen ist.

ListenableFuture<PrepareEnvironmentResponse>

Ein ListenableFuture, das das Ergebnis umschließt. Das kann

Ein erfolgreiches Future, das ein PrepareEnvironmentResponse mit Details zum endgültigen Status der Umgebungsvorbereitung enthält.
Ein fehlgeschlagenes Future, das InvalidArgumentException umschließt, wenn:
- [notificationServiceComponentName] ist keine gültige Komponente der aufrufenden App oder wurde nicht im Manifest exportiert.
- Die angeforderten Rollen sind ungültig.
- Die angeforderten Rollen enthalten {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} und {@code com.google.android.managementapi.environment.model.PrepareEnvironmentRequest.admin} wird nicht bereitgestellt oder erweitert nicht {@code android.app.admin.DeviceAdminReceiver}.
Ein fehlgeschlagenes Future, das SecurityException umschließt, wenn der Aufrufer nicht berechtigt ist, diese API aufzurufen.
Ein fehlgeschlagenes zukünftiges Wrapping von GooglePlayServicesAppNotUpdatedException, wenn die Google Play-Dienste nicht auf dem neuesten Stand sind.
Ein fehlgeschlagenes Future, das AndroidDevicePolicyInstallOrUpdateUnrecoverableException umschließt, wenn die Android Device Policy nicht installiert oder aktualisiert werden kann und der Fehler nicht behoben werden kann.
Ein fehlgeschlagenes Future, das AndroidDevicePolicyInstallOrUpdateRecoverableException umschließt, wenn die Android Device Policy App nicht installiert oder aktualisiert werden kann und der Fehler behoben werden kann (z.B. wenn die Anfrage aufgrund vorübergehender Netzwerkprobleme fehlgeschlagen ist), sodass die Anfrage noch einmal versucht werden kann.
Ein fehlgeschlagenes zukünftiges Wrapping einer AndroidDevicePolicyInstallConsentDeclinedException, wenn der Nutzer die Installation der Android Device Policy App ablehnt.
Ein fehlgeschlagenes Future, das AndroidDevicePolicyInstallConsentDismissedException umschließt, wenn der Nutzer den Bildschirm mit der Installationszustimmung schließt.
Ein fehlgeschlagenes Future, das ein InternalException umschließt, wenn der Aufruf aufgrund eines internen Fehlers fehlgeschlagen ist.
Ein fehlgeschlagenes Future, das PlayStoreUpdateUnrecoverableException umschließt, wenn das Play Store-Update fehlgeschlagen ist.

Löst
`com.google.android.managementapi.common.exceptions.ApiLevelException`	Wenn das SDK-API-Level des Geräts für bestimmte angeforderte Rollen nicht ausreicht. {@code Role.RoleType.DEVICE_POLICY_CONTROLLER} erfordert API-Level 23 oder höher. Für alle anderen Rollen ist API‑Level 28 oder höher erforderlich.

Zusammenfassung

Öffentliche Funktionen

Öffentliche Funktionen

getEnvironment

getEnvironmentAsync

prepareEnvironment

prepareEnvironmentAsync