ControlStatus Enum
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Specifies the result of retrieving a control's current device state.
public enum ControlStatustype ControlStatus = - Inheritance
-
ControlStatus
Fields
| Name | Value | Description |
|---|---|---|
| Unknown | 0 | Reserved for use with the StatelessBuilder, and while loading. When state is requested via ControlsProviderService.createPublisherFor, use other status codes to indicate the proper device state. Android reference for Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. |
| Ok | 1 | Used to indicate that the state of the device was successfully retrieved. This includes all scenarios where the device may have a warning for the user, such as "Lock jammed", or "Vacuum stuck". Any information for the user should be set through StatefulBuilder.setStatusText. Android reference for Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. |
| NotFound | 2 | The device corresponding to the Control cannot be found or was removed. The user will be alerted and directed to the application to resolve. Android reference for Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. |
| Error | 3 | Used to indicate that there was a temporary error while loading the device state. A default error message will be displayed in place of any custom text that was set through StatefulBuilder.setStatusText. Android reference for Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. |
| Disabled | 4 | The Control is currently disabled. A default error message will be displayed in place of any custom text that was set through StatefulBuilder.setStatusText. Android reference for Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. |
Remarks
These values correspond to the Android Control.STATUS_* constants. Unknown is used for stateless controls and loading. Ok means the state was retrieved; it does not mean the device has no warning for the user.
See the Android implementation.