/
DequeuedMessageItem.yml
98 lines (98 loc) · 2.83 KB
/
DequeuedMessageItem.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
### YamlMime:TSType
name: DequeuedMessageItem
uid: '@azure/storage-queue.DequeuedMessageItem'
package: '@azure/storage-queue'
summary: >-
The object returned in the QueueMessageList array when calling Get Messages on
a Queue.
fullName: DequeuedMessageItem
remarks: ''
isDeprecated: false
type: interface
properties:
- name: dequeueCount
uid: '@azure/storage-queue.DequeuedMessageItem.dequeueCount'
package: '@azure/storage-queue'
summary: The number of times the message has been dequeued.
fullName: dequeueCount
remarks: ''
isDeprecated: false
syntax:
content: 'dequeueCount: number'
return:
description: ''
type: number
- name: expiresOn
uid: '@azure/storage-queue.DequeuedMessageItem.expiresOn'
package: '@azure/storage-queue'
summary: The time that the Message will expire and be automatically deleted.
fullName: expiresOn
remarks: ''
isDeprecated: false
syntax:
content: 'expiresOn: Date'
return:
description: ''
type: Date
- name: insertedOn
uid: '@azure/storage-queue.DequeuedMessageItem.insertedOn'
package: '@azure/storage-queue'
summary: The time the Message was inserted into the Queue.
fullName: insertedOn
remarks: ''
isDeprecated: false
syntax:
content: 'insertedOn: Date'
return:
description: ''
type: Date
- name: messageId
uid: '@azure/storage-queue.DequeuedMessageItem.messageId'
package: '@azure/storage-queue'
summary: The Id of the Message.
fullName: messageId
remarks: ''
isDeprecated: false
syntax:
content: 'messageId: string'
return:
description: ''
type: string
- name: messageText
uid: '@azure/storage-queue.DequeuedMessageItem.messageText'
package: '@azure/storage-queue'
summary: The content of the Message.
fullName: messageText
remarks: ''
isDeprecated: false
syntax:
content: 'messageText: string'
return:
description: ''
type: string
- name: nextVisibleOn
uid: '@azure/storage-queue.DequeuedMessageItem.nextVisibleOn'
package: '@azure/storage-queue'
summary: The time that the message will again become visible in the Queue.
fullName: nextVisibleOn
remarks: ''
isDeprecated: false
syntax:
content: 'nextVisibleOn: Date'
return:
description: ''
type: Date
- name: popReceipt
uid: '@azure/storage-queue.DequeuedMessageItem.popReceipt'
package: '@azure/storage-queue'
summary: >-
This value is required to delete the Message. If deletion fails using this
popreceipt then the message has been dequeued by another client.
fullName: popReceipt
remarks: ''
isDeprecated: false
syntax:
content: 'popReceipt: string'
return:
description: ''
type: string