ExtensionCritical Property

Whether the extension is critical.

Syntax

 client.getExtensionCritical(index, [callback])
 client.setExtensionCritical(index,  extensionCritical, [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 getExtensionCritical([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 setExtensionCritical([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

Whether the extension is critical.

This setting specifies whether the recipient must understand the contents of the extension to interpret the entire message.

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

This property is not available at design time.

Data Type

Boolean