IPWorks IoT 2020 Node.js Edition

Questions / Feedback?

RequestOptionUnsafe Property

Whether the option is unsafe to forward.

Syntax

 coap.getRequestOptionUnsafe(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 getRequestOptionUnsafe([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 setRequestOptionUnsafe([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 unsafe to forward.

This property reflects whether the option is unsafe to forward. This information is generally only needed for 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

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks IoT 2020 Node.js Edition - Version 20.0 [Build 8265]