IncomingMessageSettled Property
Whether this message is settled.
Syntax
amqp.getIncomingMessageSettled(index, [callback])
Default Value
TRUE
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 getIncomingMessageSettled([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 setIncomingMessageSettled([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 this message is settled.
This property specifies whether this message is settled or not.
Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not Mixed (2).
The index parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
Boolean