JWTClaimDataType Property

The data type of the claim value.

Syntax

 jwt.getJWTClaimDataType(index, [callback])
 jwt.setJWTClaimDataType(index,  JWTClaimDataType, [callback])

Possible Values

  0 (dtObject), 
  1 (dtArray), 
  2 (dtString), 
  3 (dtNumber), 
  4 (dtBool), 
  5 (dtNull)

Default Value

2

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 getJWTClaimDataType([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 setJWTClaimDataType([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

The data type of the claim value.

This property specifies the JSON type of the claim value. Possible values are:

• 0 (Object)
• 1 (Array)
• 2 (String)
• 3 (Number)
• 4 (Bool)
• 5 (Null)

The index parameter specifies the index of the item in the array. The size of the array is controlled by the JWTClaimCount property.

This property is not available at design time.

Data Type

Integer