SignOnClientUIdReq Property

Indicates whether the Client Unique Identifier is required to be included in the signon.

Syntax

 fiprofile.getSignOnClientUIdReq(index, [callback])

Default Value

FALSE

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 getSignOnClientUIdReq([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 setSignOnClientUIdReq([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

Indicates whether the Client Unique Identifier is required to be included in the signon.

If this is True, then the ClientUId is required to be set and included in the request.

The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean