Changing ReachOut on Autosync Setting

The flag to determine whether or not a ReachOut should be requested as part of each SDK Automatic Sync is initially set in the ruiCreateConfig() call. There may be certain cases when the application wants to either enable or disable this functionality during the application lifetime.

The ruiSetReachOutOnAutoSync() function allows the application to enable or disable this capability after ruiCreateConfig() has been called.

The ruiSetReachOutOnAutoSync() function enables (true) or disables (false) the ReachOut on Autosync capability. Note if the call does not change the existing setting, the API will still return RUI_OK.

The ruiSetReachOutOnAutoSync() function can be called between ruiCreateConfig() and ruiStopSDK() and can be called zero or more times.

ruiSetReachOutOnAutoSync()

RUIRESULT ruiSetReachOutOnAutoSync(RUIINSTANCE* ruiInstance, bool reachOutOnAutoSyncSetting)

Parameters

The ruiSetReachOutOnAutoSync() function has the following parameters.

ruiSetReachOutOnAutoSync() Parameters

Parameter

Description

ruiInstance (RUIINSTANCE*)

Pointer to the RUI instance created via ruiCreateInstance().

reachOutOnAutoSyncSetting (bool*)

Enable (true) or disable (false) the ReachOut on Autosync capability.

Returns

The ruiSetReachOutOnAutoSync() function returns one of the return status constants below.

ruiSetReachOutOnAutoSync() Returns

Return

Description

RUI_OK

Function successful.

RUI_INVALID_SDK_OBJECT

SDK Instance parameter is NULL or invalid.

RUI_SDK_INTERNAL_ERROR_FATAL

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

RUI_SDK_ABORTED

A required New Registration has failed, and hence the SDK is aborted. ruiStopSDK() and ruiDestroyInstance() are possible.

RUI_SDK_SUSPENDED

The Server has instructed a temporary back-off.

RUI_SDK_PERMANENTLY_DISABLED

The Server has instructed a permanent disable.

RUI_SDK_OPTED_OUT

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

RUI_CONFIG_NOT_CREATED

Configuration has not been successfully created.

RUI_SDK_ALREADY_STOPPED

SDK has already been successfully stopped.