IPWorks IoT 2020 Node.js Edition

Questions / Feedback?

MessageUserId Property

The identity of the user responsible for producing this message.

Syntax

 amqp.getMessageUserId([callback])
 amqp.setMessageUserId( messageUserId, [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 getMessageUserId([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 setMessageUserId([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 identity of the user responsible for producing this message.

This property specifies the identity of the user responsible for producing this message. It may be empty if no specific user was responsible for creating this message.

A message's user Id may be used for verification or authentication by intermediates and/or the final receiver.

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]