IPWorks IoT 2020 Node.js Edition

Questions / Feedback?

ReceivedMessageTTL Property

The time-to-live value for this message.

Syntax

 amqp.getReceivedMessageTTL([callback])

Default Value

-1

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 getReceivedMessageTTL([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 setReceivedMessageTTL([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 time-to-live value for this message.

This property specifies the time-to-live (TTL) value, in milliseconds, for this message. It may be -1 if this message does not have a TTL.

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

Data Type

Long64

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