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 synchronous function, returning when all functionality is completed.

getState:

(RUISTATEOBJC) getState

Returns

The getState: function returns one of the return status constants below.

ruiGetState() Returns

Return

Description

RUI_SDK_STATE_FATAL_ERROR

Irrecoverable internal fatal error. No further API calls should be made.

RUI_SDK_STATE_UNINITIALIZED

Instance successfully created (initRegisterDefaultGraphicalReachOutHandler) but not yet successfully configured (createConfig).

RUI_SDK_STATE_CONFIG_INITIALIZED_NOT_STARTED

Successfully configured (createConfig) and not yet started (startSDK).Will be normal start.

RUI_SDK_STATE_CONFIG_MISSING_OR_CORRUPT_NOT_STARTED

Successfully configured (createConfig) and not yet started (startSDK). Will be a New Registration start.

RUI_SDK_STATE_STARTED_NEW_REG_RUNNING

Running (startSDK) with New Registration in progress, not yet completed.

RUI_SDK_STATE_RUNNING

Running (startSDK) with no need for New Registration or with successfully completed New Registration.

RUI_SDK_STATE_ABORTED_NEW_REG_PROXY_AUTH_FAILURE

Aborted run (startSDK) due to failed New Registration (createConfig).

RUI_SDK_STATE_ABORTED_NEW_REG_NETWORK_FAILURE

Aborted run (startSDK) due to failed New Registration (createConfig).

RUI_SDK_STATE_ABORTED_NEW_REG_FAILED

Aborted run (startSDK) due to failed New Registration (createConfig).

RUI_SDK_STATE_SUSPENDED

Instance has been instructed by Server to back-off. Will return to Running once back-off cleared.

RUI_SDK_STATE_PERMANENTLY_DISABLED

Instance has been instructed by Server to disable. This is permanent, irrecoverable state.

RUI_SDK_STATE_STOPPING_NON_SYNC

Stop in progress (stopSDK:). Stopping non-Sync-related threads.

RUI_SDK_STATE_STOPPING_ALL

Stop in progress (stopSDK:). Stopping Sync-related threads.

RUI_SDK_STATE_STOPPED

Stop completed (stopSDK:).

RUI_SDK_STATE_OPTED_OUT

Instance has been instructed by the application to opt-out.