AmqpAnnotatedMessage interface

Package:

@azure/core-amqp

Describes the AmqpAnnotatedMessage, part of the ServiceBusReceivedMessage(as amqpAnnotatedMessage property).

Properties

applicationProperties	A dictionary containing application specific message properties.
body	The message body.
bodyType	The AMQP section where the data was decoded from.
deliveryAnnotations	A dictionary used for delivery-specific non-standard properties at the head of the message.
footer	Describes set of footer properties of the message.
header	Describes the defined set of standard header properties of the message.
messageAnnotations	A dictionary containing message attributes that will be held in the message header
properties	Describes the defined set of standard properties of the message.

Property Details

applicationProperties

A dictionary containing application specific message properties.

applicationProperties?: {[key: string]: any}

Property Value

{[key: string]: any}

body

The message body.

body: any

Property Value

any

bodyType

The AMQP section where the data was decoded from.

bodyType?: "data" | "sequence" | "value"

Property Value

"data" | "sequence" | "value"

deliveryAnnotations

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

deliveryAnnotations?: {[key: string]: any}

Property Value

{[key: string]: any}

footer

Describes set of footer properties of the message.

footer?: {[key: string]: any}

Property Value

{[key: string]: any}

header

Describes the defined set of standard header properties of the message.

header?: AmqpMessageHeader

Property Value

AmqpMessageHeader

messageAnnotations

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

messageAnnotations?: {[key: string]: any}

Property Value

{[key: string]: any}

properties

Describes the defined set of standard properties of the message.

properties?: AmqpMessageProperties

Property Value

AmqpMessageProperties