RequestOptionNoCacheKey Property

Whether the option is to be excluded from the cache-key.

Syntax

 coap.getRequestOptionNoCacheKey(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 getRequestOptionNoCacheKey([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 setRequestOptionNoCacheKey([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 option is to be excluded from the cache-key.

This property reflects whether the option should be excluded from any cache-key calculations. This information is generally only needed for caching and proxying.

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

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

Data Type

Boolean