/
ServiceBusReceiveActions.xml
165 lines (165 loc) · 15.2 KB
/
ServiceBusReceiveActions.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
<Type Name="ServiceBusReceiveActions" FullName="Microsoft.Azure.WebJobs.ServiceBus.ServiceBusReceiveActions">
<TypeSignature Language="C#" Value="public class ServiceBusReceiveActions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ServiceBusReceiveActions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusReceiveActions" />
<TypeSignature Language="VB.NET" Value="Public Class ServiceBusReceiveActions" />
<TypeSignature Language="F#" Value="type ServiceBusReceiveActions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<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>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents the set of receive actions that can be taken from within a function invocation.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ServiceBusReceiveActions ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusReceiveActions.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.15.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusReceiveActions" /> 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="PeekMessagesAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>> PeekMessagesAsync (int maxMessages, long? fromSequenceNumber = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IReadOnlyList`1<class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>> PeekMessagesAsync(int32 maxMessages, valuetype System.Nullable`1<int64> fromSequenceNumber, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusReceiveActions.PeekMessagesAsync(System.Int32,System.Nullable{System.Int64},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function PeekMessagesAsync (maxMessages As Integer, Optional fromSequenceNumber As Nullable(Of Long) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IReadOnlyList(Of ServiceBusReceivedMessage))" />
<MemberSignature Language="F#" Value="abstract member PeekMessagesAsync : int * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>
override this.PeekMessagesAsync : int * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>" Usage="serviceBusReceiveActions.PeekMessagesAsync (maxMessages, fromSequenceNumber, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.15.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="maxMessages" Type="System.Int32" />
<Parameter Name="fromSequenceNumber" Type="System.Nullable<System.Int64>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="maxMessages">The maximum number of messages that will be fetched.</param>
<param name="fromSequenceNumber">An optional sequence number from where to peek the
message. This corresponds to the <see cref="P:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage.SequenceNumber" />.</param>
<param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel
the operation.</param>
<summary>To be added.</summary>
<returns>An <see cref="T:System.Collections.Generic.IReadOnlyList`1" /> of messages that were peeked.</returns>
<remarks>
Unlike a received message, a peeked message will not have a lock token associated with it, and hence it cannot be
Completed/Abandoned/Deferred/Deadlettered/Renewed.
Also, unlike <see cref="M:Azure.Messaging.ServiceBus.ServiceBusReceiver.ReceiveMessageAsync(System.Nullable{System.TimeSpan},System.Threading.CancellationToken)" />, this method will fetch even Deferred messages (but not Deadlettered messages).
</remarks>
</Docs>
</Member>
<Member MemberName="ReceiveDeferredMessagesAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>> ReceiveDeferredMessagesAsync (System.Collections.Generic.IEnumerable<long> sequenceNumbers, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IReadOnlyList`1<class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>> ReceiveDeferredMessagesAsync(class System.Collections.Generic.IEnumerable`1<int64> sequenceNumbers, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusReceiveActions.ReceiveDeferredMessagesAsync(System.Collections.Generic.IEnumerable{System.Int64},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ReceiveDeferredMessagesAsync (sequenceNumbers As IEnumerable(Of Long), Optional cancellationToken As CancellationToken = Nothing) As Task(Of IReadOnlyList(Of ServiceBusReceivedMessage))" />
<MemberSignature Language="F#" Value="abstract member ReceiveDeferredMessagesAsync : seq<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>
override this.ReceiveDeferredMessagesAsync : seq<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>" Usage="serviceBusReceiveActions.ReceiveDeferredMessagesAsync (sequenceNumbers, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.15.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sequenceNumbers" Type="System.Collections.Generic.IEnumerable<System.Int64>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param>
<param name="sequenceNumbers">An <see cref="T:System.Collections.Generic.IEnumerable`1" /> containing the sequence numbers to receive.</param>
<summary>
Receives a list of deferred <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> identified by <paramref name="sequenceNumbers" />.
Messages received using this method are subject to the behavior defined in the <see cref="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.AutoCompleteMessages" />.
When this method is used in a single-dispatch functions, messages received are subject to <see cref="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MaxAutoLockRenewalDuration" />.
</summary>
<returns>Messages identified by sequence number are returned.
Throws if the messages have not been deferred.</returns>
<remarks>To be added.</remarks>
<altmember cref="M:Azure.Messaging.ServiceBus.ProcessMessageEventArgs.DeferMessageAsync(Azure.Messaging.ServiceBus.ServiceBusReceivedMessage,System.Collections.Generic.IDictionary{System.String,System.Object},System.Threading.CancellationToken)" />
<exception cref="T:Azure.Messaging.ServiceBus.ServiceBusException">
The specified sequence number does not correspond to a message that has been deferred.
The <see cref="P:Azure.Messaging.ServiceBus.ServiceBusException.Reason" /> will be set to <see cref="F:Azure.Messaging.ServiceBus.ServiceBusFailureReason.MessageNotFound" /> in this case.
</exception>
</Docs>
</Member>
<Member MemberName="ReceiveMessagesAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>> ReceiveMessagesAsync (int maxMessages, TimeSpan? maxWaitTime = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IReadOnlyList`1<class Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>> ReceiveMessagesAsync(int32 maxMessages, valuetype System.Nullable`1<valuetype System.TimeSpan> maxWaitTime, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusReceiveActions.ReceiveMessagesAsync(System.Int32,System.Nullable{System.TimeSpan},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ReceiveMessagesAsync (maxMessages As Integer, Optional maxWaitTime As Nullable(Of TimeSpan) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IReadOnlyList(Of ServiceBusReceivedMessage))" />
<MemberSignature Language="F#" Value="abstract member ReceiveMessagesAsync : int * Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>
override this.ReceiveMessagesAsync : int * Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>" Usage="serviceBusReceiveActions.ReceiveMessagesAsync (maxMessages, maxWaitTime, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ServiceBus</AssemblyName>
<AssemblyVersion>5.15.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="maxMessages" Type="System.Int32" />
<Parameter Name="maxWaitTime" Type="System.Nullable<System.TimeSpan>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="maxMessages">The maximum number of messages that will be received.</param>
<param name="maxWaitTime">An optional <see cref="T:System.TimeSpan" /> specifying the maximum time to wait for the first message before returning an empty list if no messages are available.
If not specified, the <see cref="P:Azure.Messaging.ServiceBus.ServiceBusRetryOptions.TryTimeout" /> will be used.</param>
<param name="cancellationToken">An optional <see cref="T:System.Threading.CancellationToken" /> instance to signal the request to cancel the operation.</param>
<summary>
Receives a list of <see cref="T:Azure.Messaging.ServiceBus.ServiceBusReceivedMessage" /> from the entity.
This method doesn't guarantee to return exact `maxMessages` messages, even if there are `maxMessages` messages available in the queue or topic.
Messages received using this method are subject to the behavior defined in the <see cref="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.AutoCompleteMessages" />.
When this method is used in a single-dispatch functions, messages received are subject to <see cref="P:Microsoft.Azure.WebJobs.ServiceBus.ServiceBusOptions.MaxAutoLockRenewalDuration" />.
</summary>
<returns>List of messages received. Returns an empty list if no message is found.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>