SDKAppId Property

The unique SDK App Id.

Syntax

 client.getSDKAppId([callback])
 client.setSDKAppId( SDKAppId, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getSDKAppId([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setSDKAppId([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property must be set to a universally unique Id created for a specific installation of the app on a consumer device. The app is responsible for generating and storing the SDKAppId for each installation or update. This property must be set before calling GetAuthRequest.

The value assigned here must be 36 characters and be in the format defined in IETF RFC 4122. For example: 8a880dc0-d2d2-4067-bcb1-b08d1690b26e.

Data Type

String