EnvironmentClient

Kotlin |Java

public interface EnvironmentClient

Client to access environment related apis.

Use EnvironmentClientFactory to create an instance.

Summary

Public methods
`abstract @NonNull Environment`	`@RequiresApi(value = 28) getEnvironment(@NonNull GetEnvironmentRequest request)` Returns the `Environment`.
`abstract @NonNull ListenableFuture<@NonNull Environment>`	`@RequiresApi(value = 28) getEnvironmentAsync(@NonNull GetEnvironmentRequest request)` Returns the `Environment`.
`abstract @NonNull PrepareEnvironmentResponse`	`@RequiresApi(value = 28) prepareEnvironment( @NonNull PrepareEnvironmentRequest request, ComponentName notificationServiceComponentName )` Prepares the device environment.
`abstract @NonNull ListenableFuture<@NonNull PrepareEnvironmentResponse>`	`@RequiresApi(value = 28) prepareEnvironmentAsync( @NonNull PrepareEnvironmentRequest request, ComponentName notificationServiceComponentName )` Prepares the device environment.

Public methods

getEnvironment

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

Returns the Environment. It helps the caller to know if environment is ready or not.

Throws
`java.lang.SecurityException`	If the caller is not authorized to call this API.
`com.google.android.managementapi.common.exceptions.ApiLevelException`	If the device API level is less than 28.
`com.google.android.managementapi.common.exceptions.InvalidArgumentException`	If the requested roles are not valid.
`com.google.android.managementapi.common.exceptions.InternalException`	If call failed due to an internal error.

getEnvironmentAsync

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

Returns the Environment. It helps the caller to know if environment is ready or not.

Returns

Returns
`@NonNull ListenableFuture<@NonNull Environment>`	A `ListenableFuture` wrapping the result. This can be: A successful future wrapping a `Environment`, in case of success. A failed future wrapping a `SecurityException`, if the caller is not authorized to call this API. A failed future wrapping a `ApiLevelException`, if the device API level is less than 28. A failed future wrapping a `InvalidArgumentException`, if the requested roles are not valid. A failed future wrapping a `InternalException`, if call failed due to an internal error.

@NonNull ListenableFuture<@NonNull Environment>

A ListenableFuture wrapping the result. This can be:

A successful future wrapping a Environment, in case of success.
A failed future wrapping a SecurityException, if the caller is not authorized to call this API.
A failed future wrapping a ApiLevelException, if the device API level is less than 28.
A failed future wrapping a InvalidArgumentException, if the requested roles are not valid.
A failed future wrapping a InternalException, if call failed due to an internal error.

prepareEnvironment

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

Prepares the device environment.

Prompts the user to install the necessary Android Device Policy application. Proceeds with installation if user accepts the prompt. After successful installation, it performs operations to make sure that the Android Device Policy app is ready.

Parameters

Parameters
`ComponentName notificationServiceComponentName`	The `ComponentName` of the service extending `NotificationReceiverService`. If provided, it must be a valid component belonging to the calling app, and exported in the manifest. To get notified of Environment preparation events, you need to: Implement the `EnvironmentListener` interface in your app. Provide an implementation for how to handle the received events. Extend NotificationReceiverService and provide an `EnvironmentListener` instance. Add the extended NotificationReceiverService class to your AndroidManifest.xml and ensure that it is exported. For example: class MyEnvironmentListener : EnvironmentListener { override fun onEnvironmentEvent(event: EnvironmentEvent) { // Handle the environment event. } } class MyNotificationReceiverService : NotificationReceiverService() { override fun getPrepareEnvironmentListener(): EnvironmentListener? { return MyEnvironmentListener() } }

ComponentName notificationServiceComponentName

The ComponentName of the service extending NotificationReceiverService. If provided, it must be a valid component belonging to the calling app, and exported in the manifest. To get notified of Environment preparation events, you need to:

Implement the EnvironmentListener interface in your app.
Provide an implementation for how to handle the received events.
Extend NotificationReceiverService and provide an EnvironmentListener instance.
Add the extended NotificationReceiverService class to your AndroidManifest.xml and ensure that it is exported.

For example:

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

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

Returns
`@NonNull PrepareEnvironmentResponse`	`PrepareEnvironmentResponse` containing details about the final status of the environment preparation.

Throws
`com.google.android.managementapi.common.exceptions.InvalidArgumentException`	If: [notificationServiceComponentName] is not a valid component belonging to the calling app or not exported in the manifest. The requested roles are not valid.
`com.google.android.managementapi.common.exceptions.ApiLevelException`	If the device API level is less than 28.
`java.lang.SecurityException`	If the caller is not authorized to call this API.
`com.google.android.managementapi.environment.exception.GooglePlayServicesAppNotUpdatedException`	If Google Play Services is not up-to-date.
`com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallOrUpdateUnrecoverableException`	If Android Device Policy app fails to install or update and the error is unrecoverable.
`com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallOrUpdateRecoverableException`	If Android Device Policy app fails to install or update and the error is recoverable (e.g. request failed due to transient network issues), so the request can be retried.
`com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallConsentDeclinedException`	If the user declines to install Android Device Policy app.
`com.google.android.managementapi.environment.exception.AndroidDevicePolicyInstallConsentDismissedException`	If the user dismisses the installation consent screen.
`com.google.android.managementapi.common.exceptions.InternalException`	If call failed due to an internal error.

prepareEnvironmentAsync

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

Prepares the device environment.

Parameters

Parameters
`ComponentName notificationServiceComponentName`	The `ComponentName` of the service extending `NotificationReceiverService`. If provided, it must be a valid component belonging to the calling app, and exported in the manifest. To get notified of environment preparation events, you need to: Implement the `EnvironmentListener` interface in your app. Provide an implementation for how to handle the received events. Extend NotificationReceiverService and provide an `EnvironmentListener` instance. Add the extended NotificationReceiverService class to your AndroidManifest.xml and ensure that it is exported. For example: class MyEnvironmentListener : EnvironmentListener { override fun onEnvironmentEvent(event: EnvironmentEvent) { // Handle the environment event. } } class MyNotificationReceiverService : NotificationReceiverService() { override fun getPrepareEnvironmentListener(): EnvironmentListener? { return MyEnvironmentListener() } }

ComponentName notificationServiceComponentName

Implement the EnvironmentListener interface in your app.
Provide an implementation for how to handle the received events.
Extend NotificationReceiverService and provide an EnvironmentListener instance.
Add the extended NotificationReceiverService class to your AndroidManifest.xml and ensure that it is exported.

For example:

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

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

Returns

Returns
`@NonNull ListenableFuture<@NonNull PrepareEnvironmentResponse>`	A `ListenableFuture` wrapping the result. This can be A successful future wrapping a `PrepareEnvironmentResponse` containing details about the final status of the environment preparation. A failed future wrapping a `InvalidArgumentException` if: [notificationServiceComponentName] is not a valid component belonging to the calling app or not exported in the manifest. The requested roles are not valid. A failed future wrapping a `ApiLevelException` if the device API level is less than 28. A failed future wrapping a `SecurityException`, if the caller is not authorized to call this API. A failed future wrapping a `GooglePlayServicesAppNotUpdatedException` if Google Play Services is not up-to-date. A failed future wrapping a `AndroidDevicePolicyInstallOrUpdateUnrecoverableException` if Android Device Policy fails to install or update and the error is unrecoverable. A failed future wrapping a `AndroidDevicePolicyInstallOrUpdateRecoverableException` if Android Device Policy app fails to install or update and the error is recoverable (e.g. request failed due to transient network issues), so the request can be retried. A failed future wrapping a `AndroidDevicePolicyInstallConsentDeclinedException` if the user declines to install Android Device Policy app. A failed future wrapping a `AndroidDevicePolicyInstallConsentDismissedException` if the user dismisses the installation consent screen. A failed future wrapping a `InternalException`, if call failed due to an internal error.

@NonNull ListenableFuture<@NonNull PrepareEnvironmentResponse>

A ListenableFuture wrapping the result. This can be

A successful future wrapping a PrepareEnvironmentResponse containing details about the final status of the environment preparation.
A failed future wrapping a InvalidArgumentException if:
- [notificationServiceComponentName] is not a valid component belonging to the calling app or not exported in the manifest.
- The requested roles are not valid.
A failed future wrapping a ApiLevelException if the device API level is less than 28.
A failed future wrapping a SecurityException, if the caller is not authorized to call this API.
A failed future wrapping a GooglePlayServicesAppNotUpdatedException if Google Play Services is not up-to-date.
A failed future wrapping a AndroidDevicePolicyInstallOrUpdateUnrecoverableException if Android Device Policy fails to install or update and the error is unrecoverable.
A failed future wrapping a AndroidDevicePolicyInstallOrUpdateRecoverableException if Android Device Policy app fails to install or update and the error is recoverable (e.g. request failed due to transient network issues), so the request can be retried.
A failed future wrapping a AndroidDevicePolicyInstallConsentDeclinedException if the user declines to install Android Device Policy app.
A failed future wrapping a AndroidDevicePolicyInstallConsentDismissedException if the user dismisses the installation consent screen.
A failed future wrapping a InternalException, if call failed due to an internal error.