KeyedAppState
@AutoValue
public abstract class KeyedAppState
A keyed app state to be sent to an EMM (enterprise mobility management), with the intention that it is displayed to the management organization.
Summary
Nested types |
|---|
@AutoValue.BuilderThe builder for |
Constants |
|
|---|---|
static final int |
MAX_DATA_LENGTH = 1000This field is deprecated. Use |
static final int |
MAX_KEY_LENGTH = 100This field is deprecated. Use |
static final int |
MAX_MESSAGE_LENGTH = 1000This field is deprecated. |
static final int |
SEVERITY_ERROR = 2 |
static final int |
SEVERITY_INFO = 1 |
Public methods |
|
|---|---|
static @NonNull KeyedAppState.KeyedAppStateBuilder |
builder()Create a |
abstract @Nullable String |
getData()Optionally, a machine-readable value to be read by the EMM. |
abstract @NonNull String |
getKey()The key for the app state. |
static final int |
Get the maximum length of |
static final int |
Get the maximum length of |
static final int |
Get the maximum length of |
abstract @Nullable String |
Optionally, a free-form message string to explain the app state. |
abstract int |
The severity of the app state. |
Constants
MAX_DATA_LENGTH
public static final int MAX_DATA_LENGTH = 1000
MAX_MESSAGE_LENGTH
public static final int MAX_MESSAGE_LENGTH = 1000
Public methods
builder
public static @NonNull KeyedAppState.KeyedAppStateBuilder builder()
Create a KeyedAppStateBuilder.
getData
public abstract @Nullable String getData()
Optionally, a machine-readable value to be read by the EMM. For example, setting values that the admin can choose to query against in the EMM console (e.g. “notify me if the battery_warning data <10”).
getKey
public abstract @NonNull String getKey()
The key for the app state. Acts as a point of reference for what the app is providing state for. For example, when providing managed configuration feedback, this key could be the managed configuration key to allow EMMs to take advantage of the connection in their UI.
getMaxDataLength
public static final int getMaxDataLength()
Get the maximum length of getData.
getMaxKeyLength
public static final int getMaxKeyLength()
Get the maximum length of getKey.
getMaxMessageLength
public static final int getMaxMessageLength()
Get the maximum length of getMessage.
getMessage
public abstract @Nullable String getMessage()
Optionally, a free-form message string to explain the app state. If the state was triggered by a particular value (e.g. a managed configuration value), it should be included in the message.
getSeverity
public abstract int getSeverity()
The severity of the app state. This allows EMMs to choose to notify admins of errors. This should only be set to SEVERITY_ERROR for genuine error conditions that a management organization needs to take action to fix.
When sending an app state containing errors, it is critical that follow-up app states are sent when the errors have been resolved, using the same key and this value set to SEVERITY_INFO.