Setting Product Edition

The setProductEdition() function sets or clears the product data.

Note:The product data must be set every time the RUI SDK instance is run. This is different than V4 of the RUI (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.

setProductEdition() can be called between createConfig() and stopSDK()and can be called zero or more times.

setProductEdition()is a synchronous function returning when all functionality is completed.

setProductEdition()

RUIResult setProductEdition(String productEdition)ΒΆ

Parameters

The setProductEdition() function has the following parameters.

setProductEdition() Parameters

Parameter

Description

productEdition (String)

The product edition that is to be set. Maximum length of 128 characters.

Returns

The setProductEdition() function returns a RUIResult enum value with the following possible values:

ruiSetProductEdition() Returns

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.