AmqpMessageProperties interface

Package:

@azure/core-amqp

Describes the defined set of standard properties of the message.

Properties

absoluteExpiryTime	The time when this message is considered expired.
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.
contentType	MIME type for the message.
correlationId	The id that can be used to mark or identify messages between clients.
creationTime	The time this message was created.
groupId	The group this message belongs to.
groupSequence	The sequence number of this message with its group.
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.
replyTo	The address of the node to send replies to.
replyToGroupId	The group the reply message belongs to.
subject	A common field for summary information about the message content and purpose.
to	The address of the node the message is destined for.

Property Details

absoluteExpiryTime

The time when this message is considered expired.

absoluteExpiryTime?: number

Property Value

number

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.

contentEncoding?: string

Property Value

string

contentType

MIME type for the message.

contentType?: string

Property Value

string

correlationId

The id that can be used to mark or identify messages between clients.

correlationId?: string | number | Buffer

Property Value

string | number | Buffer

creationTime

The time this message was created.

creationTime?: number

Property Value

number

groupId

The group this message belongs to.

groupId?: string

Property Value

string

groupSequence

The sequence number of this message with its group.

groupSequence?: number

Property Value

number

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.

messageId?: string | number | Buffer

Property Value

string | number | Buffer

replyTo

The address of the node to send replies to.

replyTo?: string

Property Value

string

replyToGroupId

The group the reply message belongs to.

replyToGroupId?: string

Property Value

string

subject

A common field for summary information about the message content and purpose.

subject?: string

Property Value

string

to

The address of the node the message is destined for.

to?: string

Property Value

string