AmqpMessageProperties interface

Package:

@azure/amqp-common

Describes the defined set of standard properties of the message.

Properties

absolute_expiry_time	The time when this message is considered expired.
content_encoding	The content-encoding property is used as a modifier to the content-type. When present, its valueindicates what additional content encodings have been applied to the application-data.
content_type	MIME type for the message.
correlation_id	The id that can be used to mark or identify messages between clients.
creation_time	The time this message was created.
group_id	The group this message belongs to.
group_sequence	The sequence number of this message with its group.
message_id	The application message identifier that uniquely idenitifes a message. The user is responsible for making sure that this is unique in the given context. Guids usually make a good fit.
reply_to	The address of the node to send replies to.
reply_to_group_id	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.
user_id	The identity of the user responsible for producing the message.

Property Details

absolute_expiry_time

The time when this message is considered expired.

absolute_expiry_time?: number

Property Value

number

content_encoding

The content-encoding property is used as a modifier to the content-type. When present, its valueindicates what additional content encodings have been applied to the application-data.

content_encoding?: string

Property Value

string

content_type

MIME type for the message.

content_type?: string

Property Value

string

correlation_id

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

correlation_id?: string | number | Buffer

Property Value

string | number | Buffer

creation_time

The time this message was created.

creation_time?: number

Property Value

number

group_id

The group this message belongs to.

group_id?: string

Property Value

string

group_sequence

The sequence number of this message with its group.

group_sequence?: number

Property Value

number

message_id

The application message identifier that uniquely idenitifes a message. The user is responsible for making sure that this is unique in the given context. Guids usually make a good fit.

message_id?: string | number | Buffer

Property Value

string | number | Buffer

reply_to

The address of the node to send replies to.

reply_to?: string

Property Value

string

reply_to_group_id

The group the reply message belongs to.

reply_to_group_id?: 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

user_id

The identity of the user responsible for producing the message.

user_id?: string

Property Value

string