Getting the State of the Usage Intelligence Instance

The RUISDK.GetState function returns a RUISTATE value that contains the state of the Usage Intelligence instance. The SDK state can change asynchronously.

RUISDK.GetState can be called more than once.

RUISDK.GetState is a synchronous function, returning when all functionality is completed.

RUISDK.GetState

RUIState RUISDK.GetState ()

Returns

The RUISDK.GetState function returns a RUIResult enum value with the following possible values.

RUISDK.GetState Returns

Return

Description

fatalError

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

uninitialized

Instance successfully created but not yet successfully configured (RUISDK.CreateConfig).

configInitializedNotStarted

Successfully configured (RUISDK.CreateConfig) and not yet started (RUISDK.StartSDK). Will be normal start.

configMissingOrCorruptNotStarted

Successfully configured (RUISDK.CreateConfig) and not yet started (RUISDK.StartSDK). Will be a New Registration start.

startedNewRegRunning

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

running

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

abortedNewRegProxyAuthFailure

Aborted run (RUISDK.StartSDK) due to failed proxy authentication on New Registration (RUISDK.CreateConfig).

abortedNewRegNetworkFailure

Aborted run (RUISDK.StartSDK) due to failed New Registration (RUISDK.CreateConfig).

abortedNewRegFailed

Aborted run (RUISDK.StartSDK) due to failed New Registration (RUISDK.CreateConfig).

suspended

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

permanentlyDisabled

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

optedOut

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

stoppingNonSync

Stop in progress (RUISDK.StopSDK). Stopping non-Sync-related threads.

stoppingAll

Stop in progress (RUISDK.StopSDK). Stopping Sync-related threads.

stopped

Stop completed (RUISDK.StopSDK).