Getting the State of the Usage Intelligence Instance
The getState() function returns the current state of the SDK instance. The SDK state can change asynchronously..
The getState() function can be called more than once.
The getState() function is a synchronous function, , returning when all functionality is completed.
RUIState getState()ΒΆ
Returns
The getState() function returns one of the RUIState enum values below:
|
Return |
Description |
|
FATAL_ERROR |
Irrecoverable internal fatal error. No further API calls should be made |
|
UNINITIALIZED |
Instance successfully created but not yet successfully configured (createConfig()). |
|
CONFIG_INITIALIZED_NOT_STARTED |
Successfully configured (createConfig()) and not yet started (startSDK()). Will be normal start. |
|
CONFIG_MISSING_OR_CORRUPT_NOT_STARTED |
Successfully configured (createConfig()) and not yet started (startSDK()). Will be a New Registration start. |
|
STARTED_NEW_REG_RUNNING |
Running startSDK() with a New Registration in progress but not yet completed. |
|
RUNNING |
Running startSDK() with no need for New Registration or with successfully completed New Registration. |
|
ABORTED_NEW_REG_PROXY_AUTH_FAILURE |
Aborted run startSDK() due to failed proxy authentication on New Registration (createConfig()). |
|
ABORTED_NEW_REG_NETWORK_FAILURE |
Aborted run (startSDK()) due to failed New Registration (createConfig()). |
|
ABORTED_NEW_REG_FAILED |
Aborted run (startSDK()) due to failed New Registration (createConfig()). |
|
SUSPENDED |
Instance has been instructed by Server to back-off. Will return to running once back-off cleared. |
|
PERMANENTLY_DISABLED |
Instance has been instructed by Server to disable. This is a permanent, irrecoverable state. |
|
OPTED_OUT |
Instance has been instructed by the application to opt-out. |
|
STOPPING_NON_SYNC |
Stop in progress stopSDK(). Stopping non-Sync-related threads. |
|
STOPPING_ALL |
Stop in progress stopSDK(). Stopping Sync-related threads. |
|
STOPPED |
Stop completed stopSDK() |