# KeyedAppStatesReporter

Artifact: [androidx.enterprise:enterprise-feedback](https://developer.android.com/jetpack/androidx/releases/enterprise) [View Source](https://cs.android.com/search?q=file:androidx/enterprise/feedback/KeyedAppStatesReporter.java+class:androidx.enterprise.feedback.KeyedAppStatesReporter) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/enterprise#1.0.0)

*** ** * ** ***


```
public abstract class KeyedAppStatesReporter
```

<br />

Known direct subclasses [FakeKeyedAppStatesReporter](https://developer.android.com/reference/androidx/enterprise/feedback/FakeKeyedAppStatesReporter)

|---|---|
| `https://developer.android.com/reference/androidx/enterprise/feedback/FakeKeyedAppStatesReporter` | A fake `https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter` for testing. |

*** ** * ** ***

A reporter of keyed app states to enable communication between an app and an EMM (enterprise mobility management). For production, create an instance using `https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter#create(android.content.Context)`. For testing see the `FakeKeyedAppStatesReporter` class in the `enterprise-feedback-testing` artifact.

## Summary

| ### Public methods |
|---|---|
| `static @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter` | `https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter#create(android.content.Context)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context)` Create a reporter that binds to device owners, profile owners, and the Play store. |
| `static @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter` | `https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter#create(android.content.Context,java.util.concurrent.Executor)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/content/Context.html context, @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/concurrent/Executor.html executor)` Create a reporter using the specified executor. |
| `abstract void` | `[setStates](https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter#setStates(java.util.Collection<androidx.enterprise.feedback.KeyedAppState>))(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/Collection.html<https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppState> states)` **This method is deprecated.** use `https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter#setStates(java.util.Collection<androidx.enterprise.feedback.KeyedAppState>,androidx.enterprise.feedback.KeyedAppStatesCallback)` which reports errors. <br /> |
| `void` | `https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter#setStates(java.util.Collection<androidx.enterprise.feedback.KeyedAppState>,androidx.enterprise.feedback.KeyedAppStatesCallback)( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/Collection.html<https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppState> states, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesCallback callback )` Set app states to be sent to an EMM (enterprise mobility management). |
| `abstract void` | `[setStatesImmediate](https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter#setStatesImmediate(java.util.Collection<androidx.enterprise.feedback.KeyedAppState>))(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/Collection.html<https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppState> states)` **This method is deprecated.** use `https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter#setStatesImmediate(java.util.Collection<androidx.enterprise.feedback.KeyedAppState>,androidx.enterprise.feedback.KeyedAppStatesCallback)` which reports errors. <br /> |
| `void` | `https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter#setStatesImmediate(java.util.Collection<androidx.enterprise.feedback.KeyedAppState>,androidx.enterprise.feedback.KeyedAppStatesCallback)( @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/Collection.html<https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppState> states, @https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesCallback callback )` Performs the same function as `https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter#setStates(java.util.Collection<androidx.enterprise.feedback.KeyedAppState>,androidx.enterprise.feedback.KeyedAppStatesCallback)`, except it also requests that the states are immediately uploaded to be accessible via server APIs. |

## Public methods

### create

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/enterprise#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](https://developer.android.com/jetpack/androidx/releases/enterprise#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 `https://developer.android.com/reference/java/lang/Runnable.html` instances on the same thread, serially.

### setStates

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/enterprise#1.0.0) Deprecated in [1.1.0](https://developer.android.com/jetpack/androidx/releases/enterprise#1.1.0)

```
public abstract void [setStates](https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter#setStates(java.util.Collection<androidx.enterprise.feedback.KeyedAppState>))(@NonNull Collection<KeyedAppState> states)
```

> [!CAUTION]
> **This method is deprecated.**   
>
> use `https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter#setStates(java.util.Collection<androidx.enterprise.feedback.KeyedAppState>,androidx.enterprise.feedback.KeyedAppStatesCallback)` which reports errors.

### setStates

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/enterprise#1.1.0)

```
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.

`https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesCallback#onResult(int,java.lang.Throwable)` will be called when an error occurs.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter#setStatesImmediate(java.util.Collection<androidx.enterprise.feedback.KeyedAppState>,androidx.enterprise.feedback.KeyedAppStatesCallback)` |   |

### setStatesImmediate

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/enterprise#1.0.0) Deprecated in [1.1.0](https://developer.android.com/jetpack/androidx/releases/enterprise#1.1.0)

```
public abstract void [setStatesImmediate](https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter#setStatesImmediate(java.util.Collection<androidx.enterprise.feedback.KeyedAppState>))(@NonNull Collection<KeyedAppState> states)
```

> [!CAUTION]
> **This method is deprecated.**   
>
> use `https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter#setStatesImmediate(java.util.Collection<androidx.enterprise.feedback.KeyedAppState>,androidx.enterprise.feedback.KeyedAppStatesCallback)` which reports errors.

### setStatesImmediate

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/enterprise#1.1.0)

```
public void setStatesImmediate(
    @NonNull Collection<KeyedAppState> states,
    @Nullable KeyedAppStatesCallback callback
)
```

Performs the same function as `https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter#setStates(java.util.Collection<androidx.enterprise.feedback.KeyedAppState>,androidx.enterprise.feedback.KeyedAppStatesCallback)`, 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.

`https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesCallback#onResult(int,java.lang.Throwable)` will be called when an error occurs.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/enterprise/feedback/KeyedAppStatesReporter#setStates(java.util.Collection<androidx.enterprise.feedback.KeyedAppState>,androidx.enterprise.feedback.KeyedAppStatesCallback)` |   |