-
Notifications
You must be signed in to change notification settings - Fork 265
/
ServiceBusMessageActions.xml
448 lines (448 loc) · 37.5 KB
/
ServiceBusMessageActions.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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
<Type Name="ServiceBusMessageActions" FullName="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusMessageActions">
<TypeSignature Language="C#" Value="public class ServiceBusMessageActions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ServiceBusMessageActions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusMessageActions" />
<TypeSignature Language="VB.NET" Value="Public Class ServiceBusMessageActions" />
<TypeSignature Language="F#" Value="type ServiceBusMessageActions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>5.1.0.0</AssemblyVersion>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
<AssemblyVersion>5.3.0.0</AssemblyVersion>
<AssemblyVersion>5.4.0.0</AssemblyVersion>
<AssemblyVersion>5.5.0.0</AssemblyVersion>
<AssemblyVersion>5.5.1.0</AssemblyVersion>
<AssemblyVersion>5.6.0.0</AssemblyVersion>
<AssemblyVersion>5.7.0.0</AssemblyVersion>
<AssemblyVersion>5.8.0.0</AssemblyVersion>
<AssemblyVersion>5.8.1.0</AssemblyVersion>
<AssemblyVersion>5.9.0.0</AssemblyVersion>
<AssemblyVersion>5.10.0.0</AssemblyVersion>
<AssemblyVersion>5.11.0.0</AssemblyVersion>
<AssemblyVersion>5.12.0.0</AssemblyVersion>
<AssemblyVersion>5.13.0.0</AssemblyVersion>
<AssemblyVersion>5.13.3.0</AssemblyVersion>
<AssemblyVersion>5.13.4.0</AssemblyVersion>
<AssemblyVersion>5.13.5.0</AssemblyVersion>
<AssemblyVersion>5.13.6.0</AssemblyVersion>
<AssemblyVersion>5.14.0.0</AssemblyVersion>
<AssemblyVersion>5.15.1.0</AssemblyVersion>
<AssemblyVersion>5.16.0.0</AssemblyVersion>
<AssemblyVersion>5.16.1.0</AssemblyVersion>
<AssemblyVersion>5.16.2.0</AssemblyVersion>
<AssemblyVersion>5.16.3.0</AssemblyVersion>
<AssemblyVersion>5.16.4.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents the set of message actions that can be performed on a <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ServiceBusMessageActions ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusMessageActions.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.4.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusMessageActions" /> class for mocking use in testing.
</summary>
<remarks>
This constructor exists only to support mocking. When used, class state is not fully initialized, and
will not function correctly; virtual members are meant to be mocked.
</remarks>
</Docs>
</Member>
<Member MemberName="AbandonMessageAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task AbandonMessageAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, System.Collections.Generic.IDictionary<string,object> propertiesToModify = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task AbandonMessageAsync(class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, class System.Collections.Generic.IDictionary`2<string, object> propertiesToModify, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusMessageActions.AbandonMessageAsync(Azure.Messaging.ServiceBus.ServiceBusReceivedMessage,System.Collections.Generic.IDictionary{System.String,System.Object},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AbandonMessageAsync (message As ServiceBusReceivedMessage, Optional propertiesToModify As IDictionary(Of String, Object) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member AbandonMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.AbandonMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="serviceBusMessageActions.AbandonMessageAsync (message, propertiesToModify, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.4.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" />
<Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> to abandon.</param>
<param name="propertiesToModify">The properties of the message to modify while abandoning the message.</param>
<param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param>
<summary>
Abandons a <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" />.This will make the message available again for immediate processing as the lock on the message held by the receiver will be released.
</summary>
<returns>A task to be resolved on when the operation has completed.</returns>
<remarks>
Abandoning a message will increase the delivery count on the message.
This operation can only be performed on messages that were received by this receiver
when <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> is set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusReceiveMode.PeekLock" />.
</remarks>
<exception cref="T:Azure.Messaging.ServiceBus.ServiceBusException">
<list type="bullet">
<item>
<description>
The lock for the message has expired or the message has already been completed. This does not apply for session-enabled entities.
The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.MessageLockLost" /> in this case.
</description>
</item>
<item>
<description>
The lock for the session has expired or the message has already been completed. This only applies for session-enabled entities.
The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.SessionLockLost" /> in this case.
</description>
</item>
</list>
</exception>
</Docs>
</Member>
<Member MemberName="CompleteMessageAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task CompleteMessageAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task CompleteMessageAsync(class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusMessageActions.CompleteMessageAsync(Azure.Messaging.ServiceBus.ServiceBusReceivedMessage,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CompleteMessageAsync (message As ServiceBusReceivedMessage, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member CompleteMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.CompleteMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="serviceBusMessageActions.CompleteMessageAsync (message, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.4.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="message">The message to complete.</param>
<param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param>
<summary>
Completes a <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" />. This will delete the message from the service.
</summary>
<returns>A task to be resolved on when the operation has completed.</returns>
<remarks>
This operation can only be performed on a message that was received by this receiver
when <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> is set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusReceiveMode.PeekLock" />.
</remarks>
<exception cref="T:Azure.Messaging.ServiceBus.ServiceBusException">
<list type="bullet">
<item>
<description>
The lock for the message has expired or the message has already been completed. This does not apply for session-enabled entities.
The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.MessageLockLost" /> in this case.
</description>
</item>
<item>
<description>
The lock for the session has expired or the message has already been completed. This only applies for session-enabled entities.
The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.SessionLockLost" /> in this case.
</description>
</item>
</list>
</exception>
</Docs>
</Member>
<Member MemberName="DeadLetterMessageAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task DeadLetterMessageAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, System.Collections.Generic.IDictionary<string,object> propertiesToModify = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task DeadLetterMessageAsync(class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, class System.Collections.Generic.IDictionary`2<string, object> propertiesToModify, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusMessageActions.DeadLetterMessageAsync(Azure.Messaging.ServiceBus.ServiceBusReceivedMessage,System.Collections.Generic.IDictionary{System.String,System.Object},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DeadLetterMessageAsync (message As ServiceBusReceivedMessage, Optional propertiesToModify As IDictionary(Of String, Object) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member DeadLetterMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeadLetterMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="serviceBusMessageActions.DeadLetterMessageAsync (message, propertiesToModify, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.4.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" />
<Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> to dead-letter.</param>
<param name="propertiesToModify">The properties of the message to modify while moving to subqueue.</param>
<param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param>
<summary>
Moves a message to the dead-letter subqueue.
</summary>
<returns>To be added.</returns>
<remarks>
In order to receive a message from the dead-letter queue or transfer dead-letter queue,
set the <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiverOptions.SubQueue" /> property to <see cref="F:Azure.Messaging.ServiceBus.SubQueue.DeadLetter" />
or <see cref="F:Azure.Messaging.ServiceBus.SubQueue.TransferDeadLetter" /> when calling
<see cref="M:Azure.Messaging.ServiceBus.ServiceBusClient.CreateReceiver(System.String,Azure.Messaging.ServiceBus.ServiceBusReceiverOptions)" /> or
<see cref="M:Azure.Messaging.ServiceBus.ServiceBusClient.CreateReceiver(System.String,System.String,Azure.Messaging.ServiceBus.ServiceBusReceiverOptions)" />.
This operation can only be performed when <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> is set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusReceiveMode.PeekLock" />.
</remarks>
<exception cref="T:Azure.Messaging.ServiceBus.ServiceBusException">
<list type="bullet">
<item>
<description>
The lock for the message has expired or the message has already been completed. This does not apply for session-enabled entities.
The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.MessageLockLost" /> in this case.
</description>
</item>
<item>
<description>
The lock for the session has expired or the message has already been completed. This only applies for session-enabled entities.
The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.SessionLockLost" /> in this case.
</description>
</item>
</list>
</exception>
</Docs>
</Member>
<Member MemberName="DeadLetterMessageAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task DeadLetterMessageAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, string deadLetterReason, string deadLetterErrorDescription = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task DeadLetterMessageAsync(class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, string deadLetterReason, string deadLetterErrorDescription, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusMessageActions.DeadLetterMessageAsync(Azure.Messaging.ServiceBus.ServiceBusReceivedMessage,System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DeadLetterMessageAsync (message As ServiceBusReceivedMessage, deadLetterReason As String, Optional deadLetterErrorDescription As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member DeadLetterMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeadLetterMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="serviceBusMessageActions.DeadLetterMessageAsync (message, deadLetterReason, deadLetterErrorDescription, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.4.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" />
<Parameter Name="deadLetterReason" Type="System.String" />
<Parameter Name="deadLetterErrorDescription" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> to dead-letter.</param>
<param name="deadLetterReason">The reason for dead-lettering the message.</param>
<param name="deadLetterErrorDescription">The error description for dead-lettering the message.</param>
<param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param>
<summary>
Moves a message to the dead-letter subqueue.
</summary>
<returns>To be added.</returns>
<remarks>
In order to receive a message from the dead-letter queue or transfer dead-letter queue,
set the <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiverOptions.SubQueue" /> property to <see cref="F:Azure.Messaging.ServiceBus.SubQueue.DeadLetter" />
or <see cref="F:Azure.Messaging.ServiceBus.SubQueue.TransferDeadLetter" /> when calling
<see cref="M:Azure.Messaging.ServiceBus.ServiceBusClient.CreateReceiver(System.String,Azure.Messaging.ServiceBus.ServiceBusReceiverOptions)" /> or
<see cref="M:Azure.Messaging.ServiceBus.ServiceBusClient.CreateReceiver(System.String,System.String,Azure.Messaging.ServiceBus.ServiceBusReceiverOptions)" />.
This operation can only be performed when <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> is set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusReceiveMode.PeekLock" />.
</remarks>
<exception cref="T:Azure.Messaging.ServiceBus.ServiceBusException">
<list type="bullet">
<item>
<description>
The lock for the message has expired or the message has already been completed. This does not apply for session-enabled entities.
The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.MessageLockLost" /> in this case.
</description>
</item>
<item>
<description>
The lock for the session has expired or the message has already been completed. This only applies for session-enabled entities.
The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.SessionLockLost" /> in this case.
</description>
</item>
</list>
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<list type="bullet">
<item>
<description>
The dead letter reason or dead letter error description exceeded the maximum length of 4096.
</description>
</item>
</list>
</exception>
</Docs>
</Member>
<Member MemberName="DeadLetterMessageAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task DeadLetterMessageAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, System.Collections.Generic.Dictionary<string,object> propertiesToModify, string deadLetterReason, string deadLetterErrorDescription = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task DeadLetterMessageAsync(class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, class System.Collections.Generic.Dictionary`2<string, object> propertiesToModify, string deadLetterReason, string deadLetterErrorDescription, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusMessageActions.DeadLetterMessageAsync(Azure.Messaging.ServiceBus.ServiceBusReceivedMessage,System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DeadLetterMessageAsync (message As ServiceBusReceivedMessage, propertiesToModify As Dictionary(Of String, Object), deadLetterReason As String, Optional deadLetterErrorDescription As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member DeadLetterMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.Dictionary<string, obj> * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeadLetterMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.Dictionary<string, obj> * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="serviceBusMessageActions.DeadLetterMessageAsync (message, propertiesToModify, deadLetterReason, deadLetterErrorDescription, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.4.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" />
<Parameter Name="propertiesToModify" Type="System.Collections.Generic.Dictionary<System.String,System.Object>" />
<Parameter Name="deadLetterReason" Type="System.String" />
<Parameter Name="deadLetterErrorDescription" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> to dead-letter.</param>
<param name="deadLetterReason">The reason for dead-lettering the message.</param>
<param name="deadLetterErrorDescription">The error description for dead-lettering the message.</param>
<param name="propertiesToModify">The properties of the message to modify while moving to subqueue.</param>
<param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param>
<summary>
Moves a message to the dead-letter subqueue.
</summary>
<returns>To be added.</returns>
<remarks>
In order to receive a message from the dead-letter queue or transfer dead-letter queue,
set the <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiverOptions.SubQueue" /> property to <see cref="F:Azure.Messaging.ServiceBus.SubQueue.DeadLetter" />
or <see cref="F:Azure.Messaging.ServiceBus.SubQueue.TransferDeadLetter" /> when calling
<see cref="M:Azure.Messaging.ServiceBus.ServiceBusClient.CreateReceiver(System.String,Azure.Messaging.ServiceBus.ServiceBusReceiverOptions)" /> or
<see cref="M:Azure.Messaging.ServiceBus.ServiceBusClient.CreateReceiver(System.String,System.String,Azure.Messaging.ServiceBus.ServiceBusReceiverOptions)" />.
This operation can only be performed when <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMode" /> is set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusReceiveMode.PeekLock" />.
The dead letter reason and error description can only be specified either through the method parameters or hard coded
using this properties.
</remarks>
<exception cref="T:Azure.Messaging.ServiceBus.ServiceBusException">
<list type="bullet">
<item>
<description>
The lock for the message has expired or the message has already been completed. This does not apply for session-enabled entities.
The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.MessageLockLost" /> in this case.
</description>
</item>
<item>
<description>
The lock for the session has expired or the message has already been completed. This only applies for session-enabled entities.
The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.SessionLockLost" /> in this case.
</description>
</item>
</list>
</exception>
<exception cref="T:System.InvalidOperationException">
<list type="bullet">
<item>
<description>
The dead letter reason or dead letter error exception was specified in both the parameter and the properties dictionary.
</description>
</item>
</list>
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<list type="bullet">
<item>
<description>
The dead letter reason or dead letter error description exceeded the maximum length of 4096.
</description>
</item>
</list>
</exception>
</Docs>
</Member>
<Member MemberName="DeferMessageAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task DeferMessageAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, System.Collections.Generic.IDictionary<string,object> propertiesToModify = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task DeferMessageAsync(class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, class System.Collections.Generic.IDictionary`2<string, object> propertiesToModify, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusMessageActions.DeferMessageAsync(Azure.Messaging.ServiceBus.ServiceBusReceivedMessage,System.Collections.Generic.IDictionary{System.String,System.Object},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DeferMessageAsync (message As ServiceBusReceivedMessage, Optional propertiesToModify As IDictionary(Of String, Object) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member DeferMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeferMessageAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Collections.Generic.IDictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="serviceBusMessageActions.DeferMessageAsync (message, propertiesToModify, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.4.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" />
<Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> to defer.</param>
<param name="propertiesToModify">The properties of the message to modify while deferring the message.</param>
<param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param>
<summary> Indicates that the receiver wants to defer the processing for the message.</summary>
<returns>A task to be resolved on when the operation has completed.</returns>
<remarks>
In order to receive this message again in the future, you will need to save the
<see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage.SequenceNumber" />
and receive it using <see cref="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveDeferredMessageAsync(System.Int64,System.Threading.CancellationToken)" />.
Deferring messages does not impact message's expiration, meaning that deferred messages can still expire.
This operation can only be performed on messages that were received by this receiver.
</remarks>
<exception cref="T:Azure.Messaging.ServiceBus.ServiceBusException">
<list type="bullet">
<item>
<description>
The lock for the message has expired or the message has already been completed. This does not apply for session-enabled entities.
The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.MessageLockLost" /> in this case.
</description>
</item>
<item>
<description>
The lock for the session has expired or the message has already been completed. This only applies for session-enabled entities.
The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.SessionLockLost" /> in this case.
</description>
</item>
</list>
</exception>
</Docs>
</Member>
<Member MemberName="RenewMessageLockAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task RenewMessageLockAsync (Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task RenewMessageLockAsync(class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusMessageActions.RenewMessageLockAsync(Azure.Messaging.ServiceBus.ServiceBusReceivedMessage,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function RenewMessageLockAsync (message As ServiceBusReceivedMessage, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member RenewMessageLockAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.RenewMessageLockAsync : Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="serviceBusMessageActions.RenewMessageLockAsync (message, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.16.4.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="message">The <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> to renew the lock for.</param>
<param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param>
<summary>
Renews the lock on the message. The lock will be renewed based on the setting specified on the queue.
</summary>
<returns>To be added.</returns>
<remarks>
When a message is received in <see cref="F:Azure.Messaging.ServiceBus.ServiceBusReceiveMode.PeekLock" /> mode, the message is locked on the server for this
receiver instance for a duration as specified during the Queue/Subscription creation (LockDuration).
If processing of the message requires longer than this duration, the lock needs to be renewed.
For each renewal, it resets the time the message is locked by the LockDuration set on the Entity.
</remarks>
<exception cref="T:Azure.Messaging.ServiceBus.ServiceBusException">
The lock for the message has expired or the message has already been completed.
The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.MessageLockLost" /> in this case.
</exception>
</Docs>
</Member>
</Members>
</Type>