KeyedAppStatesReporter

public abstract class KeyedAppStatesReporter


A reporter of keyed app states to enable communication between an app and an EMM (enterprise mobility management). For production, create an instance using create. For testing see the FakeKeyedAppStatesReporter class in the enterprise-feedback-testing artifact.

Summary

Public methods

static @NonNull KeyedAppStatesReporter

Create a reporter that binds to device owners, profile owners, and the Play store.

static @NonNull KeyedAppStatesReporter
create(@NonNull Context context, @NonNull Executor executor)

Create a reporter using the specified executor.

abstract void

This method is deprecated.

use setStates which reports errors.

void

Set app states to be sent to an EMM (enterprise mobility management).

abstract void

This method is deprecated.

use setStatesImmediate which reports errors.

void

Performs the same function as setStates, except it also requests that the states are immediately uploaded to be accessible via server APIs.

Public methods

create

Added in 1.0.0
public static @NonNull KeyedAppStatesReporter create(@NonNull Context context)

Create a reporter that binds to device owners, profile owners, and the Play store.

Each instance maintains bindings, so it's recommended that you maintain a single instance for your whole app, rather than creating instances as needed.

create

Added in 1.0.0
public static @NonNull KeyedAppStatesReporter create(@NonNull Context context, @NonNull Executor executor)

Create a reporter using the specified executor.

Each instance maintains bindings, so it's recommended that you maintain a single instance for your whole app, rather than creating instances as needed.

The executor must run all Runnable instances on the same thread, serially.

setStates

Added in 1.0.0
Deprecated in 1.1.0-rc01
public abstract void setStates(@NonNull Collection<KeyedAppState> states)

setStates

Added in 1.1.0-rc01
public void setStates(
    @NonNull Collection<KeyedAppState> states,
    @Nullable KeyedAppStatesCallback callback
)

Set app states to be sent to an EMM (enterprise mobility management). The EMM can then display this information to the management organization.

Do not send personally-identifiable information with this method.

Each provided keyed app state will replace any previously set keyed app states with the same key for this package name.

If multiple keyed app states are set with the same key, only one will be received by the EMM. Which will be received is not defined.

This information is sent immediately to all device owner and profile owner apps on the device. It is also sent immediately to the app with package name com.android.vending if it exists, which is the Play Store on GMS devices.

EMMs can access these states either directly in a custom DPC (device policy manager), via Android Management APIs, or via Play EMM APIs.

onResult will be called when an error occurs.

setStatesImmediate

Added in 1.0.0
Deprecated in 1.1.0-rc01
public abstract void setStatesImmediate(@NonNull Collection<KeyedAppState> states)

setStatesImmediate

Added in 1.1.0-rc01
public void setStatesImmediate(
    @NonNull Collection<KeyedAppState> states,
    @Nullable KeyedAppStatesCallback callback
)

Performs the same function as setStates, except it also requests that the states are immediately uploaded to be accessible via server APIs.

The receiver is not obligated to meet this immediate upload request. For example, Play and Android Management APIs have daily quotas.

onResult will be called when an error occurs.

See also
setStates