Setting Custom Property Data
The setCustomProperty: function sets or clears the custom property data.
Note:The custom property data must be set every time the SDK instance is run. This is different than V4 of the Usage Intelligence SDK where the supplied product data was stored in the SDK configuration file and if it was not supplied, the values in the configuration file were used.
setCustomProperty: can be called between createConfig and stopSDK:, and can be called zero or more times.
setCustomProperty: is a synchronous function, returning when all functionality is completed.
(RUIRESULTOBJC) setCustomProperty: (uint32_t)customPropertyID value: (NSString*)customValue;
Parameters
The setCustomProperty: function has the following parameters.
|
Parameter |
Description |
|
customPropertyID (unsigned short) |
This is a numeric index between 1 and 20. On the Revulytics 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 property is being set. |
|
customValue (NSString*) |
The value to be assigned to the custom property. |
Returns
The setCustomProperty: function returns one of the return status constants below.
|
Return |
Description |
|
RUI_OK |
Function successful. |
|
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. stopSDK: and Objective-C instance release 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. |
|
RUI_INVALID_CUSTOM_PROPERTY_ID |
Parameter validation: The 1-based customPropertyID violates its allowable range. |