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 createConfig() call. There may be certain cases when the application wants to either enable or disable this functionality during the application lifetime.
The setReachOutOnAutoSync() function allows the application to enable or disable this capability after createConfig() has been called.
The setReachOutOnAutoSync() 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 OK.
The setReachOutOnAutoSync() function can be called between createConfig() and stopSDK() and can be called zero or more times.
RUIResult setReachOutOnAutoSync(boolean reachOutOnAutoSyncSetting)
Parameters
The setReachOutOnAutoSync() function has the following parameters.
|
Parameter |
Description |
|
reachOutOnAutoSyncSetting (boolean) |
Enable (true) or disable (false) the ReachOut on Autosync capability. |
Returns
The setReachOutOnAutoSync() function returns RUIResult enum value with the following possible values:
|
Return |
Description |
|
OK |
Function successful. |
|
INVALID_SDK_OBJECT |
SDK Instance parameter is NULL or invalid. |
|
SDK_INTERNAL_ERROR_FATAL |
Irrecoverable internal fatal error. No further API calls should be made. |
|
SDK_ABORTED |
A required New Registration has failed, and hence the SDK is aborted. stopSDK() is possible. |
|
SDK_SUSPENDED |
The Server has instructed a temporary back-off. |
|
SDK_PERMANENTLY_DISABLED |
The Server has instructed a permanent disable. |
|
SDK_OPTED_OUT |
Instance has been instructed by the application to opt-out. |
|
CONFIG_NOT_CREATED |
Configuration has not been successfully created. |
|
SDK_ALREADY_STOPPED |
SDK has already been successfully stopped. |