Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AmqpMessageProperties

Package version

Describes the defined set of standard properties of the message.

Hierarchy

  • AmqpMessageProperties

Index

Properties

Optional absoluteExpiryTime

absoluteExpiryTime: undefined | number
property

{number} [absoluteExpiryTime] The time when this message is considered expired.

Optional contentEncoding

contentEncoding: undefined | string
property

{string} [contentEncoding] The content-encoding property is used as a modifier to the content-type. When present, its value indicates what additional content encodings have been applied to the application-data.

Optional contentType

contentType: undefined | string
property

{string} [contentType] MIME type for the message.

Optional correlationId

correlationId: string | number | Buffer
property

{string | number | Buffer} [correlationId] The id that can be used to mark or identify messages between clients.

Optional creationTime

creationTime: undefined | number
property

{number} [creationTime] The time this message was created.

Optional groupId

groupId: undefined | string
property

{string} [groupId] The group this message belongs to.

Optional groupSequence

groupSequence: undefined | number
property

{number} [groupSequence] The sequence number of this message with its group.

Optional messageId

messageId: string | number | Buffer
property

{string | number | Buffer} [messageId] The application message identifier that uniquely identifies a message. The user is responsible for making sure that this is unique in the given context. Guids usually make a good fit.

Optional replyTo

replyTo: undefined | string
property

{string} [replyTo] The address of the node to send replies to.

Optional replyToGroupId

replyToGroupId: undefined | string
property

{string} [replyToGroupId] The group the reply message belongs to.

Optional subject

subject: undefined | string
property

{string} [subject] A common field for summary information about the message content and purpose.

Optional to

to: undefined | string
property

{string} [to] The address of the node the message is destined for.

Generated using TypeDoc