Package version:

Interface DequeuedMessageItem

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

interface DequeuedMessageItem {
    dequeueCount: number;
    expiresOn: Date;
    insertedOn: Date;
    messageId: string;
    messageText: string;
    nextVisibleOn: Date;
    popReceipt: string;
}

Properties

dequeueCount: number

The number of times the message has been dequeued.

expiresOn: Date

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

insertedOn: Date

The time the Message was inserted into the Queue.

messageId: string

The Id of the Message.

messageText: string

The content of the Message.

nextVisibleOn: Date

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

popReceipt: string

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