-
Notifications
You must be signed in to change notification settings - Fork 260
/
IncomingMessage.xml
412 lines (412 loc) · 21.7 KB
/
IncomingMessage.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
<Type Name="IncomingMessage" FullName="Microsoft.Azure.Devices.Client.IncomingMessage">
<TypeSignature Language="C#" Value="public class IncomingMessage" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit IncomingMessage extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Client.IncomingMessage" />
<TypeSignature Language="VB.NET" Value="Public Class IncomingMessage" />
<TypeSignature Language="F#" Value="type IncomingMessage = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The data structure that represents the message that is received from Iot hub.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected internal IncomingMessage (byte[] payload);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig specialname rtspecialname instance void .ctor(unsigned int8[] payload) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Client.IncomingMessage.#ctor(System.Byte[])" />
<MemberSignature Language="VB.NET" Value="Protected Friend Sub New (payload As Byte())" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Client.IncomingMessage : byte[] -> Microsoft.Azure.Devices.Client.IncomingMessage" Usage="new Microsoft.Azure.Devices.Client.IncomingMessage payload" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="payload" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="payload">The payload to be set to the incoming message.</param>
<summary>
Creates an instance of this class.
</summary>
<remarks>
This class can be inherited from and set by unit tests for mocking purposes.
</remarks>
</Docs>
</Member>
<Member MemberName="ContentEncoding">
<MemberSignature Language="C#" Value="public string ContentEncoding { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ContentEncoding" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.IncomingMessage.ContentEncoding" />
<MemberSignature Language="VB.NET" Value="Public Property ContentEncoding As String" />
<MemberSignature Language="F#" Value="member this.ContentEncoding : string with get, set" Usage="Microsoft.Azure.Devices.Client.IncomingMessage.ContentEncoding" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Used to specify the content encoding type of the message.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContentType">
<MemberSignature Language="C#" Value="public string ContentType { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ContentType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.IncomingMessage.ContentType" />
<MemberSignature Language="VB.NET" Value="Public Property ContentType As String" />
<MemberSignature Language="F#" Value="member this.ContentType : string with get, set" Usage="Microsoft.Azure.Devices.Client.IncomingMessage.ContentType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Used to specify the content type of the message.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CorrelationId">
<MemberSignature Language="C#" Value="public string CorrelationId { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string CorrelationId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.IncomingMessage.CorrelationId" />
<MemberSignature Language="VB.NET" Value="Public Property CorrelationId As String" />
<MemberSignature Language="F#" Value="member this.CorrelationId : string with get, set" Usage="Microsoft.Azure.Devices.Client.IncomingMessage.CorrelationId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
A string property that typically contains the MessageId of the request, in request-reply patterns.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreatedOnUtc">
<MemberSignature Language="C#" Value="public DateTimeOffset CreatedOnUtc { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTimeOffset CreatedOnUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.IncomingMessage.CreatedOnUtc" />
<MemberSignature Language="VB.NET" Value="Public Property CreatedOnUtc As DateTimeOffset" />
<MemberSignature Language="F#" Value="member this.CreatedOnUtc : DateTimeOffset with get, set" Usage="Microsoft.Azure.Devices.Client.IncomingMessage.CreatedOnUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Docs>
<summary>
The event creation time when sending one message at a time.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnqueuedOnUtc">
<MemberSignature Language="C#" Value="public DateTimeOffset EnqueuedOnUtc { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTimeOffset EnqueuedOnUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.IncomingMessage.EnqueuedOnUtc" />
<MemberSignature Language="VB.NET" Value="Public Property EnqueuedOnUtc As DateTimeOffset" />
<MemberSignature Language="F#" Value="member this.EnqueuedOnUtc : DateTimeOffset with get, set" Usage="Microsoft.Azure.Devices.Client.IncomingMessage.EnqueuedOnUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Docs>
<summary>
Date and time when the device-to-cloud message was received by the server.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExpiresOnUtc">
<MemberSignature Language="C#" Value="public DateTimeOffset ExpiresOnUtc { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTimeOffset ExpiresOnUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.IncomingMessage.ExpiresOnUtc" />
<MemberSignature Language="VB.NET" Value="Public Property ExpiresOnUtc As DateTimeOffset" />
<MemberSignature Language="F#" Value="member this.ExpiresOnUtc : DateTimeOffset with get, set" Usage="Microsoft.Azure.Devices.Client.IncomingMessage.ExpiresOnUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Docs>
<summary>
The time when this message is considered expired.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="InputName">
<MemberSignature Language="C#" Value="public string InputName { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string InputName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.IncomingMessage.InputName" />
<MemberSignature Language="VB.NET" Value="Public Property InputName As String" />
<MemberSignature Language="F#" Value="member this.InputName : string with get, set" Usage="Microsoft.Azure.Devices.Client.IncomingMessage.InputName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Specifies the input name on which the message was sent, if there was one.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MessageId">
<MemberSignature Language="C#" Value="public string MessageId { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string MessageId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.IncomingMessage.MessageId" />
<MemberSignature Language="VB.NET" Value="Public Property MessageId As String" />
<MemberSignature Language="F#" Value="member this.MessageId : string with get, set" Usage="Microsoft.Azure.Devices.Client.IncomingMessage.MessageId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
An identifier for the message used for request-reply patterns.
Format: A case-sensitive string ( up to 128 char long) of ASCII 7-bit alphanumeric chars
+ {'-', ':', '/', '\', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
Non-alphanumeric characters are from URN RFC.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MessageSchema">
<MemberSignature Language="C#" Value="public string MessageSchema { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string MessageSchema" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.IncomingMessage.MessageSchema" />
<MemberSignature Language="VB.NET" Value="Public Property MessageSchema As String" />
<MemberSignature Language="F#" Value="member this.MessageSchema : string with get, set" Usage="Microsoft.Azure.Devices.Client.IncomingMessage.MessageSchema" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Used to specify the schema of the message content.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PayloadConvention">
<MemberSignature Language="C#" Value="protected internal Microsoft.Azure.Devices.Client.PayloadConvention PayloadConvention { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Devices.Client.PayloadConvention PayloadConvention" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.IncomingMessage.PayloadConvention" />
<MemberSignature Language="VB.NET" Value="Protected Friend Property PayloadConvention As PayloadConvention" />
<MemberSignature Language="F#" Value="member this.PayloadConvention : Microsoft.Azure.Devices.Client.PayloadConvention with get, set" Usage="Microsoft.Azure.Devices.Client.IncomingMessage.PayloadConvention" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.Client.PayloadConvention</ReturnType>
</ReturnValue>
<Docs>
<summary>
The convention to use with this message payload.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary<string,string> Properties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2<string, string> Properties" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.IncomingMessage.Properties" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Properties As IDictionary(Of String, String)" />
<MemberSignature Language="F#" Value="member this.Properties : System.Collections.Generic.IDictionary<string, string>" Usage="Microsoft.Azure.Devices.Client.IncomingMessage.Properties" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the dictionary of user properties which are set when user send the data.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SequenceNumber">
<MemberSignature Language="C#" Value="public ulong SequenceNumber { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int64 SequenceNumber" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.IncomingMessage.SequenceNumber" />
<MemberSignature Language="VB.NET" Value="Public Property SequenceNumber As ULong" />
<MemberSignature Language="F#" Value="member this.SequenceNumber : uint64 with get, set" Usage="Microsoft.Azure.Devices.Client.IncomingMessage.SequenceNumber" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.UInt64</ReturnType>
</ReturnValue>
<Docs>
<summary>
A number (unique per device-queue) assigned by IoT Hub to each cloud-to-device message.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SystemProperties">
<MemberSignature Language="C#" Value="protected internal System.Collections.Generic.IDictionary<string,object> SystemProperties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2<string, object> SystemProperties" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.IncomingMessage.SystemProperties" />
<MemberSignature Language="VB.NET" Value="Protected Friend ReadOnly Property SystemProperties As IDictionary(Of String, Object)" />
<MemberSignature Language="F#" Value="member this.SystemProperties : System.Collections.Generic.IDictionary<string, obj>" Usage="Microsoft.Azure.Devices.Client.IncomingMessage.SystemProperties" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,System.Object></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the dictionary of system properties which are managed internally.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="To">
<MemberSignature Language="C#" Value="public string To { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string To" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.IncomingMessage.To" />
<MemberSignature Language="VB.NET" Value="Public Property To As String" />
<MemberSignature Language="F#" Value="member this.To : string with get, set" Usage="Microsoft.Azure.Devices.Client.IncomingMessage.To" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
A destination specified in the cloud-to-device message.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryGetPayload<T>">
<MemberSignature Language="C#" Value="public bool TryGetPayload<T> (out T payload);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetPayload<T>([out] !!T& payload) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Client.IncomingMessage.TryGetPayload``1(``0@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetPayload(Of T) (ByRef payload As T) As Boolean" />
<MemberSignature Language="F#" Value="member this.TryGetPayload : 'T -> bool" Usage="incomingMessage.TryGetPayload payload" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="payload" Type="T" RefType="out" />
</Parameters>
<Docs>
<typeparam name="T">The type to deserialize <paramref name="payload" /> to.</typeparam>
<param name="payload">When this method returns true, this contains the value of the message payload.
When this method returns false, this contains the default value of the type <c>T</c> passed in.</param>
<summary>
The message payload, deserialized to the specified type.
</summary>
<returns>
<c>true</c> if the message payload can be deserialized to type <c>T</c>; otherwise, <c>false</c>.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UserId">
<MemberSignature Language="C#" Value="public string UserId { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string UserId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.IncomingMessage.UserId" />
<MemberSignature Language="VB.NET" Value="Public Property UserId As String" />
<MemberSignature Language="F#" Value="member this.UserId : string with get, set" Usage="Microsoft.Azure.Devices.Client.IncomingMessage.UserId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
An ID used to specify the origin of messages. When messages are generated by IoT Hub, it is set to {iot hub name}.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>