IPWorks IoT 2020 Node.js Edition

Questions / Feedback?

MessageCorrelationId Property

The correlation Id of the message.

Syntax

 amqpclassic.getMessageCorrelationId([callback])
 amqpclassic.setMessageCorrelationId( messageCorrelationId, [callback])

Default Value

""

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 getMessageCorrelationId([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 setMessageCorrelationId([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 correlation Id of the message.

This property holds the correlation Id of the message. It may be empty if the message does not have a correlation Id set.

This value must be specified as a string no longer than 255 characters.

This property is not available at design time.

Data Type

String

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