Setting Custom Property Data
The setCustomProperty() function sets the value of a custom property.
RUIResult setCustomProperty(int customPropertyID, String customValue)
Parameters
The setCustomProperty() function has the following parameters.
|
Parameter |
Description |
|
customPropertyId (int) |
This is a numeric index between 1 and 20. On the Usage Intelligence dashboard, custom properties are given an ID ranging from C01 to C20. This ID is used to identify which of the 20 possible custom properties is being set. |
|
customValue (String) |
The custom property value to use in Server reports; null clears the value. |
Returns
The setCustomProperty() function returns a RUIResult enum value with the following possible values:
|
Return |
Description |
|
OK |
Function successful. |
|
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. |
|
INVALID_CUSTOM_PROPERTY_ID |
The 1-based customPropertyID violates its allowable range. |