AmqpMessage interface

Package:

@azure/amqp-common

Describes the AMQP message that is sent or received on the wire.

Extends

AmqpMessageProperties,AmqpMessageHeader

Properties

application_properties	A dictionary containing application specific message properties.
body	The message body.
delivery_annotations	A dictionary used for delivery-specific non-standard properties at the head of the message.
message_annotations	A dictionary containing message attributes that will be held in the message header

Inherited 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.
delivery_count	The number of prior unsuccessful delivery attempts.
durable	Specifies durability requirements.
first_acquirer	If this value is true, then this message has not been acquired by any other link. Ifthis value is false, then this message MAY have previously been acquired by another link or links.
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.
priority	The relative message priority. Higher numbers indicate higher priority messages.
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.
ttl	time to live in ms.
user_id	The identity of the user responsible for producing the message.

Property Details

application_properties

A dictionary containing application specific message properties.

application_properties?: Dictionary<any>

Property Value

Dictionary<any>

body

The message body.

body: any

Property Value

any

delivery_annotations

A dictionary used for delivery-specific non-standard properties at the head of the message.

delivery_annotations?: DeliveryAnnotations

Property Value

DeliveryAnnotations

message_annotations

A dictionary containing message attributes that will be held in the message header

message_annotations?: MessageAnnotations

Property Value

MessageAnnotations

Inherited Property Details

absolute_expiry_time

The time when this message is considered expired.

absolute_expiry_time?: number

Property Value

number

Inherited From MessageProperties.absolute_expiry_time

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

Inherited From MessageProperties.content_encoding

content_type

MIME type for the message.

content_type?: string

Property Value

string

Inherited From MessageProperties.content_type

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

Inherited From MessageProperties.correlation_id

creation_time

The time this message was created.

creation_time?: number

Property Value

number

Inherited From MessageProperties.creation_time

delivery_count

The number of prior unsuccessful delivery attempts.

delivery_count?: number

Property Value

number

Inherited From MessageHeader.delivery_count

durable

Specifies durability requirements.

durable?: boolean

Property Value

boolean

Inherited From MessageHeader.durable

first_acquirer

If this value is true, then this message has not been acquired by any other link. Ifthis value is false, then this message MAY have previously been acquired by another link or links.

first_acquirer?: boolean

Property Value

boolean

Inherited From MessageHeader.first_acquirer

group_id

The group this message belongs to.

group_id?: string

Property Value

string

Inherited From MessageProperties.group_id

group_sequence

The sequence number of this message with its group.

group_sequence?: number

Property Value

number

Inherited From MessageProperties.group_sequence

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

Inherited From MessageProperties.message_id

priority

The relative message priority. Higher numbers indicate higher priority messages.

priority?: number

Property Value

number

Inherited From MessageHeader.priority

reply_to

The address of the node to send replies to.

reply_to?: string

Property Value

string

Inherited From MessageProperties.reply_to

reply_to_group_id

The group the reply message belongs to.

reply_to_group_id?: string

Property Value

string

Inherited From MessageProperties.reply_to_group_id

subject

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

subject?: string

Property Value

string

Inherited From MessageProperties.subject

to

The address of the node the message is destined for.

to?: string

Property Value

string

Inherited From MessageProperties.to

ttl

time to live in ms.

ttl?: number

Property Value

number

Inherited From MessageHeader.ttl

user_id

The identity of the user responsible for producing the message.

user_id?: string

Property Value

string

Inherited From MessageProperties.user_id