-
Notifications
You must be signed in to change notification settings - Fork 263
/
MessagesClient.xml
279 lines (277 loc) · 19.4 KB
/
MessagesClient.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
<Type Name="MessagesClient" FullName="Microsoft.Azure.Devices.MessagesClient">
<TypeSignature Language="C#" Value="public class MessagesClient : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MessagesClient extends System.Object implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.MessagesClient" />
<TypeSignature Language="VB.NET" Value="Public Class MessagesClient
Implements IDisposable" />
<TypeSignature Language="F#" Value="type MessagesClient = class
 interface IDisposable" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Subclient of <see cref="T:Microsoft.Azure.Devices.IotHubServiceClient" /> for sending cloud-to-device and cloud-to-module messages.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected MessagesClient ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.MessagesClient.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Creates an instance of this class. Provided for unit testing purposes only.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CloseAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task CloseAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task CloseAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.MessagesClient.CloseAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CloseAsync (Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member CloseAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.CloseAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="messagesClient.CloseAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">To be added.</param>
<summary>
Close the connection.
</summary>
<returns>To be added.</returns>
<remarks>
The instance can be re-opened after closing.
</remarks>
<exception cref="T:Microsoft.Azure.Devices.IotHubServiceException">If an error occurs when communicating with IoT hub service.</exception>
<exception cref="T:System.OperationCanceledException">If the provided <paramref name="cancellationToken" /> has requested cancellation.</exception>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.MessagesClient.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="messagesClient.Dispose " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="ErrorProcessor">
<MemberSignature Language="C#" Value="public Action<Microsoft.Azure.Devices.ErrorContext> ErrorProcessor { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Action`1<class Microsoft.Azure.Devices.ErrorContext> ErrorProcessor" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.MessagesClient.ErrorProcessor" />
<MemberSignature Language="VB.NET" Value="Public Property ErrorProcessor As Action(Of ErrorContext)" />
<MemberSignature Language="F#" Value="member this.ErrorProcessor : Action<Microsoft.Azure.Devices.ErrorContext> with get, set" Usage="Microsoft.Azure.Devices.MessagesClient.ErrorProcessor" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Action<Microsoft.Azure.Devices.ErrorContext></ReturnType>
</ReturnValue>
<Docs>
<summary>
The callback to be executed when the connection is lost.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<example>
serviceClient.Messaging.ErrorProcessor = OnConnectionLost;
serviceClient.Messaging.OpenAsync();
//...
public void OnConnectionLost(ErrorContext errorContext)
{
// Add reconnection logic as needed
Console.WriteLine("Messaging client connection lost")
}
</example>
</Docs>
</Member>
<Member MemberName="OpenAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task OpenAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task OpenAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.MessagesClient.OpenAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function OpenAsync (Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member OpenAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.OpenAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="messagesClient.OpenAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">To be added.</param>
<summary>
Open the connection. Must be done before any cloud-to-device messages can be sent.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.Devices.IotHubServiceException">If an error occurs when communicating with IoT hub service.</exception>
<exception cref="T:System.OperationCanceledException">If the provided <paramref name="cancellationToken" /> has requested cancellation.</exception>
</Docs>
</Member>
<Member MemberName="PurgeMessageQueueAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.PurgeMessageQueueResult> PurgeMessageQueueAsync (string deviceId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Azure.Devices.PurgeMessageQueueResult> PurgeMessageQueueAsync(string deviceId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.MessagesClient.PurgeMessageQueueAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function PurgeMessageQueueAsync (deviceId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of PurgeMessageQueueResult)" />
<MemberSignature Language="F#" Value="abstract member PurgeMessageQueueAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.PurgeMessageQueueResult>
override this.PurgeMessageQueueAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.PurgeMessageQueueResult>" Usage="messagesClient.PurgeMessageQueueAsync (deviceId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.Devices.PurgeMessageQueueResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="deviceId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="deviceId">The device identifier for the target device.</param>
<param name="cancellationToken">A cancellation token to cancel the operation.</param>
<summary>
Removes all cloud-to-device messages from a device's queue.
</summary>
<returns>The <see cref="T:Microsoft.Azure.Devices.PurgeMessageQueueResult" />.</returns>
<remarks>
This call is made over HTTP. There is no need to call <see cref="M:Microsoft.Azure.Devices.MessagesClient.OpenAsync(System.Threading.CancellationToken)" /> before calling this method.
</remarks>
<exception cref="T:System.ArgumentNullException">When the provided <paramref name="deviceId" /> is null.</exception>
<exception cref="T:System.ArgumentException">If the <paramref name="deviceId" /> is empty or white space.</exception>
<exception cref="T:Microsoft.Azure.Devices.IotHubServiceException">If IoT hub responded to the request with a non-successful status code.
For example, if the provided request was throttled, <see cref="T:Microsoft.Azure.Devices.IotHubServiceException" /> wit.
<see cref="F:Microsoft.Azure.Devices.IotHubServiceErrorCode.ThrottlingException" /> is thrown.</exception>
<see cref="T:Microsoft.Azure.Devices.IotHubServiceErrorCode" />
<exception cref="T:System.Net.Http.HttpRequestException">If the HTTP request fails due to an underlying issue such as network connectivity,
DNS failure, or server certificate validation.</exception>
<exception cref="T:System.OperationCanceledException">If the provided <paramref name="cancellationToken" /> has requested cancellation.</exception>
</Docs>
</Member>
<Member MemberName="SendAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task SendAsync (string deviceId, Microsoft.Azure.Devices.Message message, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SendAsync(string deviceId, class Microsoft.Azure.Devices.Message message, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.MessagesClient.SendAsync(System.String,Microsoft.Azure.Devices.Message,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function SendAsync (deviceId As String, message As Message, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member SendAsync : string * Microsoft.Azure.Devices.Message * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.SendAsync : string * Microsoft.Azure.Devices.Message * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="messagesClient.SendAsync (deviceId, message, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="deviceId" Type="System.String" />
<Parameter Name="message" Type="Microsoft.Azure.Devices.Message" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="deviceId">The device identifier for the target device.</param>
<param name="message">The cloud-to-device message.</param>
<param name="cancellationToken">Task cancellation token.</param>
<summary>
Send a cloud-to-device message to the specified device.
</summary>
<returns>To be added.</returns>
<remarks>
In order to receive feedback messages on the service client, set the <see cref="P:Microsoft.Azure.Devices.Message.Ack" /> property to an appropriate value
and use <see cref="P:Microsoft.Azure.Devices.IotHubServiceClient.MessageFeedback" />.
</remarks>
<exception cref="T:System.ArgumentNullException">When the provided <paramref name="deviceId" /> or <paramref name="message" /> is null.</exception>
<exception cref="T:System.ArgumentException">If the provided <paramref name="deviceId" /> is empty or whitespace.</exception>
<exception cref="T:Microsoft.Azure.Devices.IotHubServiceException">
If IoT hub responded to the request with a non-successful status code. For example, if the provided
request was throttled, <see cref="T:Microsoft.Azure.Devices.IotHubServiceException" /> with <see cref="F:Microsoft.Azure.Devices.IotHubServiceErrorCode.ThrottlingException" /> is thrown.</exception>
<see cref="T:Microsoft.Azure.Devices.IotHubServiceErrorCode" />
<exception cref="T:System.OperationCanceledException">If the provided <paramref name="cancellationToken" /> has requested cancellation.</exception>
</Docs>
</Member>
<Member MemberName="SendAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task SendAsync (string deviceId, string moduleId, Microsoft.Azure.Devices.Message message, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SendAsync(string deviceId, string moduleId, class Microsoft.Azure.Devices.Message message, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.MessagesClient.SendAsync(System.String,System.String,Microsoft.Azure.Devices.Message,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function SendAsync (deviceId As String, moduleId As String, message As Message, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member SendAsync : string * string * Microsoft.Azure.Devices.Message * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.SendAsync : string * string * Microsoft.Azure.Devices.Message * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="messagesClient.SendAsync (deviceId, moduleId, message, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="deviceId" Type="System.String" />
<Parameter Name="moduleId" Type="System.String" />
<Parameter Name="message" Type="Microsoft.Azure.Devices.Message" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="deviceId">The device identifier for the target device.</param>
<param name="moduleId">The module identifier for the target module.</param>
<param name="message">The cloud-to-module message.</param>
<param name="cancellationToken">Task cancellation token.</param>
<summary>
Send a cloud-to-device message to the specified module.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">When the provided <paramref name="deviceId" /> or <paramref name="moduleId" /> or <paramref name="message" /> is null.</exception>
<exception cref="T:System.ArgumentException">If the provided <paramref name="deviceId" /> or <paramref name="moduleId" /> is empty or whitespace.</exception>
<exception cref="T:Microsoft.Azure.Devices.IotHubServiceException">
If IoT hub responded to the request with a non-successful status code. For example, if the provided
request was throttled, <see cref="T:Microsoft.Azure.Devices.IotHubServiceException" /> with <see cref="F:Microsoft.Azure.Devices.IotHubServiceErrorCode.ThrottlingException" /> is thrown.</exception>
<see cref="T:Microsoft.Azure.Devices.IotHubServiceErrorCode" />
<exception cref="T:System.OperationCanceledException">If the provided <paramref name="cancellationToken" /> has requested cancellation.</exception>
</Docs>
</Member>
</Members>
</Type>