Setting Product Edition
The RUISDK.SetProductEdition function allows you to set the edition of your product. An example of this would be when a single product can be licensed/run in different modes such as “Home” and “Business”.
Note:The product data must be set every time the SDK instance is run. This is different than V4 of the Usage Intelligence (Trackerbird) 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.
RUISDK.SetProductEdition can be called between RUISDK.CreateConfig and RUISDK.StopSDK and can be called zero or more times.
RUISDK.SetProductEdition is a synchronous function returning when all functionality is completed.
RUIResult RUISDK.SetProductEdition (String productEdition)¶
Parameters
The RUISDK.SetProductEdition function has the following parameters.
|
Parameter |
Description |
|
productEdition (String) |
The product edition that is to be set. Maximum length of 128 characters. |
Returns
The RUISDK.SetProductEdition function returns a RUIResult enum value with the following possible values:
|
Return |
Description |
|
ok |
Function successful. |
|
sdkInternalErrorFatal |
Irrecoverable internal fatal error. No further API calls should be made. |
|
sdkAborted |
A required New Registration has failed, and hence the SDK is aborted. RUISDK.StopSDK and RUISDK destructor are possible. |
|
sdkSuspended |
The Server has instructed a temporary back-off. |
|
sdkPermantelyDisabled |
The Server has instructed a permanent disable. |
|
sdkOptedOut |
|
|
configNotCreated |
Configuration has not been successfully created. |
|
sdkAlreadyStopped |
SDK has already been successfully stopped. |