Setting Product Build Number

The setProductBuildNumber: method is used to set the build number of the application being run. In most cases, this property would already have been set when initiating createConfig. So, this function normally only needs to be used if the build number changes during runtime such as after an update.

setProductBuildNumber:

(RUIRESULTOBJC) setProductBuildNumber: (NSString*)productBuildNumber

Parameters

The setProductBuildNumber: method has the following parameters.

setProductBuildNumber: Parameters

Parameter

Description

productBuildNumber (NSString*)

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

Returns

The setProductBuildNumber: method returns one of the return status constants below.

setProductBuildNumber: Returns

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.