/
QueueMessage.xml
256 lines (256 loc) · 13 KB
/
QueueMessage.xml
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
<Type Name="QueueMessage" FullName="Azure.Storage.Queues.Models.QueueMessage">
<TypeSignature Language="C#" Value="public class QueueMessage" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit QueueMessage extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Storage.Queues.Models.QueueMessage" />
<TypeSignature Language="VB.NET" Value="Public Class QueueMessage" />
<TypeSignature Language="F#" Value="type QueueMessage = class" />
<AssemblyInfo>
<AssemblyName>Azure.Storage.Queues</AssemblyName>
<AssemblyVersion>12.6.1.0</AssemblyVersion>
<AssemblyVersion>12.6.2.0</AssemblyVersion>
<AssemblyVersion>12.7.0.0</AssemblyVersion>
<AssemblyVersion>12.8.0.0</AssemblyVersion>
<AssemblyVersion>12.9.0.0</AssemblyVersion>
<AssemblyVersion>12.10.0.0</AssemblyVersion>
<AssemblyVersion>12.11.0.0</AssemblyVersion>
<AssemblyVersion>12.11.1.0</AssemblyVersion>
<AssemblyVersion>12.12.0.0</AssemblyVersion>
<AssemblyVersion>12.13.0.0</AssemblyVersion>
<AssemblyVersion>12.13.1.0</AssemblyVersion>
<AssemblyVersion>12.14.0.0</AssemblyVersion>
<AssemblyVersion>12.15.0.0</AssemblyVersion>
<AssemblyVersion>12.16.0.0</AssemblyVersion>
<AssemblyVersion>12.17.0.0</AssemblyVersion>
<AssemblyVersion>12.17.1.0</AssemblyVersion>
<AssemblyVersion>12.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> A Message object which can be stored in a Queue. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Body">
<MemberSignature Language="C#" Value="public BinaryData Body { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.BinaryData Body" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Queues.Models.QueueMessage.Body" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Body As BinaryData" />
<MemberSignature Language="F#" Value="member this.Body : BinaryData" Usage="Azure.Storage.Queues.Models.QueueMessage.Body" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Queues</AssemblyName>
<AssemblyVersion>12.17.1.0</AssemblyVersion>
<AssemblyVersion>12.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.BinaryData</ReturnType>
</ReturnValue>
<Docs>
<summary>
The content of the Message.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DequeueCount">
<MemberSignature Language="C#" Value="public long DequeueCount { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 DequeueCount" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Queues.Models.QueueMessage.DequeueCount" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property DequeueCount As Long" />
<MemberSignature Language="F#" Value="member this.DequeueCount : int64" Usage="Azure.Storage.Queues.Models.QueueMessage.DequeueCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Queues</AssemblyName>
<AssemblyVersion>12.17.1.0</AssemblyVersion>
<AssemblyVersion>12.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
The number of times the message has been dequeued.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExpiresOn">
<MemberSignature Language="C#" Value="public DateTimeOffset? ExpiresOn { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTimeOffset> ExpiresOn" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Queues.Models.QueueMessage.ExpiresOn" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ExpiresOn As Nullable(Of DateTimeOffset)" />
<MemberSignature Language="F#" Value="member this.ExpiresOn : Nullable<DateTimeOffset>" Usage="Azure.Storage.Queues.Models.QueueMessage.ExpiresOn" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Queues</AssemblyName>
<AssemblyVersion>12.17.1.0</AssemblyVersion>
<AssemblyVersion>12.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTimeOffset></ReturnType>
</ReturnValue>
<Docs>
<summary>
The time that the Message will expire and be automatically deleted.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="InsertedOn">
<MemberSignature Language="C#" Value="public DateTimeOffset? InsertedOn { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTimeOffset> InsertedOn" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Queues.Models.QueueMessage.InsertedOn" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property InsertedOn As Nullable(Of DateTimeOffset)" />
<MemberSignature Language="F#" Value="member this.InsertedOn : Nullable<DateTimeOffset>" Usage="Azure.Storage.Queues.Models.QueueMessage.InsertedOn" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Queues</AssemblyName>
<AssemblyVersion>12.17.1.0</AssemblyVersion>
<AssemblyVersion>12.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTimeOffset></ReturnType>
</ReturnValue>
<Docs>
<summary>
The time the Message was inserted into the Queue.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MessageId">
<MemberSignature Language="C#" Value="public string MessageId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string MessageId" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Queues.Models.QueueMessage.MessageId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MessageId As String" />
<MemberSignature Language="F#" Value="member this.MessageId : string" Usage="Azure.Storage.Queues.Models.QueueMessage.MessageId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Queues</AssemblyName>
<AssemblyVersion>12.17.1.0</AssemblyVersion>
<AssemblyVersion>12.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The Id of the Message.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MessageText">
<MemberSignature Language="C#" Value="public string MessageText { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string MessageText" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Queues.Models.QueueMessage.MessageText" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MessageText As String" />
<MemberSignature Language="F#" Value="member this.MessageText : string" Usage="Azure.Storage.Queues.Models.QueueMessage.MessageText" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Queues</AssemblyName>
<AssemblyVersion>12.17.1.0</AssemblyVersion>
<AssemblyVersion>12.18.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The content of the Message.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NextVisibleOn">
<MemberSignature Language="C#" Value="public DateTimeOffset? NextVisibleOn { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTimeOffset> NextVisibleOn" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Queues.Models.QueueMessage.NextVisibleOn" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property NextVisibleOn As Nullable(Of DateTimeOffset)" />
<MemberSignature Language="F#" Value="member this.NextVisibleOn : Nullable<DateTimeOffset>" Usage="Azure.Storage.Queues.Models.QueueMessage.NextVisibleOn" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Queues</AssemblyName>
<AssemblyVersion>12.17.1.0</AssemblyVersion>
<AssemblyVersion>12.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTimeOffset></ReturnType>
</ReturnValue>
<Docs>
<summary>
The time that the message will again become visible in the Queue.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PopReceipt">
<MemberSignature Language="C#" Value="public string PopReceipt { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string PopReceipt" />
<MemberSignature Language="DocId" Value="P:Azure.Storage.Queues.Models.QueueMessage.PopReceipt" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PopReceipt As String" />
<MemberSignature Language="F#" Value="member this.PopReceipt : string" Usage="Azure.Storage.Queues.Models.QueueMessage.PopReceipt" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Queues</AssemblyName>
<AssemblyVersion>12.17.1.0</AssemblyVersion>
<AssemblyVersion>12.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
This value is required to delete the Message. If deletion fails using this popreceipt then the message has been dequeued by another client.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Update">
<MemberSignature Language="C#" Value="public Azure.Storage.Queues.Models.QueueMessage Update (Azure.Storage.Queues.Models.UpdateReceipt updated);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Azure.Storage.Queues.Models.QueueMessage Update(class Azure.Storage.Queues.Models.UpdateReceipt updated) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Storage.Queues.Models.QueueMessage.Update(Azure.Storage.Queues.Models.UpdateReceipt)" />
<MemberSignature Language="VB.NET" Value="Public Function Update (updated As UpdateReceipt) As QueueMessage" />
<MemberSignature Language="F#" Value="member this.Update : Azure.Storage.Queues.Models.UpdateReceipt -> Azure.Storage.Queues.Models.QueueMessage" Usage="queueMessage.Update updated" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Storage.Queues</AssemblyName>
<AssemblyVersion>12.17.1.0</AssemblyVersion>
<AssemblyVersion>12.18.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Storage.Queues.Models.QueueMessage</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="updated" Type="Azure.Storage.Queues.Models.UpdateReceipt" />
</Parameters>
<Docs>
<param name="updated">The message details.</param>
<summary>
Update a <see cref="T:Azure.Storage.Queues.Models.UpdateReceipt" /> after calling
<see cref="M:Azure.Storage.Queues.QueueClient.UpdateMessageAsync(System.String,System.String,System.BinaryData,System.TimeSpan,System.Threading.CancellationToken)" /> with the resulting
<see cref="T:Azure.Storage.Queues.Models.UpdateReceipt" />.
</summary>
<returns>The updated <see cref="T:Azure.Storage.Queues.Models.QueueMessage" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>