Share via

DequeuedMessageItem interface

Package:
@azure/storage-queue

The object returned in the QueueMessageList array when calling Get Messages on a Queue.

Properties

dequeueCount

The number of times the message has been dequeued.
expiresOn

The time that the Message will expire and be automatically deleted.
insertedOn

The time the Message was inserted into the Queue.
messageId

The Id of the Message.
messageText

The content of the Message.
nextVisibleOn

The time that the message will again become visible in the Queue.
popReceipt

This value is required to delete the Message. If deletion fails using this popreceipt then the message has been dequeued by another client.

Property Details

dequeueCount

The number of times the message has been dequeued.

dequeueCount: number

Property Value

number

expiresOn

The time that the Message will expire and be automatically deleted.

expiresOn: Date

Property Value

Date

insertedOn

The time the Message was inserted into the Queue.

insertedOn: Date

Property Value

Date

messageId

The Id of the Message.

messageId: string

Property Value

string

messageText

The content of the Message.

messageText: string

Property Value

string

nextVisibleOn

The time that the message will again become visible in the Queue.

nextVisibleOn: Date

Property Value

Date

popReceipt

This value is required to delete the Message. If deletion fails using this popreceipt then the message has been dequeued by another client.

popReceipt: string

Property Value

string