-
Notifications
You must be signed in to change notification settings - Fork 256
/
MessageSystemPropertyNames.xml
424 lines (424 loc) · 22.1 KB
/
MessageSystemPropertyNames.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
<Type Name="MessageSystemPropertyNames" FullName="Microsoft.Azure.Devices.MessageSystemPropertyNames">
<TypeSignature Language="C#" Value="public static class MessageSystemPropertyNames" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit MessageSystemPropertyNames extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.MessageSystemPropertyNames" />
<TypeSignature Language="VB.NET" Value="Public Class MessageSystemPropertyNames" />
<TypeSignature Language="F#" Value="type MessageSystemPropertyNames = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.31.0.0</AssemblyVersion>
<AssemblyVersion>1.32.0.0</AssemblyVersion>
<AssemblyVersion>1.33.0.0</AssemblyVersion>
<AssemblyVersion>1.34.0.0</AssemblyVersion>
<AssemblyVersion>1.35.0.0</AssemblyVersion>
<AssemblyVersion>1.36.0.0</AssemblyVersion>
<AssemblyVersion>1.37.0.0</AssemblyVersion>
<AssemblyVersion>1.37.1.0</AssemblyVersion>
<AssemblyVersion>1.38.0.0</AssemblyVersion>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The names of the system properties in the <see cref="T:Microsoft.Azure.Devices.Message" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Ack">
<MemberSignature Language="C#" Value="public const string Ack;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string Ack" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.MessageSystemPropertyNames.Ack" />
<MemberSignature Language="VB.NET" Value="Public Const Ack As String " />
<MemberSignature Language="F#" Value="val mutable Ack : string" Usage="Microsoft.Azure.Devices.MessageSystemPropertyNames.Ack" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
A feedback message generator. This property is used in cloud-to-device messages to request IoT hub to generate feedback messages as a result of the consumption of the message by the device.
</summary>
<remarks>
Possible values:
<list type="bullet"><item><description>none (default): no feedback message is generated.</description></item><item><description>positive: receive a feedback message if the message was completed.</description></item><item><description>negative: receive a feedback message if the message expired (or maximum delivery count was reached) without being completed by the device.</description></item><item><description>full: both positive and negative.</description></item></list></remarks>
</Docs>
</Member>
<Member MemberName="ConnectionAuthMethod">
<MemberSignature Language="C#" Value="public const string ConnectionAuthMethod;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string ConnectionAuthMethod" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.MessageSystemPropertyNames.ConnectionAuthMethod" />
<MemberSignature Language="VB.NET" Value="Public Const ConnectionAuthMethod As String " />
<MemberSignature Language="F#" Value="val mutable ConnectionAuthMethod : string" Usage="Microsoft.Azure.Devices.MessageSystemPropertyNames.ConnectionAuthMethod" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The connection authentication method value is ignored for cloud-to-device messages.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ConnectionDeviceGenerationId">
<MemberSignature Language="C#" Value="public const string ConnectionDeviceGenerationId;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string ConnectionDeviceGenerationId" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.MessageSystemPropertyNames.ConnectionDeviceGenerationId" />
<MemberSignature Language="VB.NET" Value="Public Const ConnectionDeviceGenerationId As String " />
<MemberSignature Language="F#" Value="val mutable ConnectionDeviceGenerationId : string" Usage="Microsoft.Azure.Devices.MessageSystemPropertyNames.ConnectionDeviceGenerationId" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The device generation Id of the target device of the cloud-to-device message.
DeviceGenerationId is an IoT hub generated, case-sensitive string. This value is used to distinguish devices with the
same device Id when they have been deleted and re-created.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ConnectionDeviceId">
<MemberSignature Language="C#" Value="public const string ConnectionDeviceId;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string ConnectionDeviceId" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.MessageSystemPropertyNames.ConnectionDeviceId" />
<MemberSignature Language="VB.NET" Value="Public Const ConnectionDeviceId As String " />
<MemberSignature Language="F#" Value="val mutable ConnectionDeviceId : string" Usage="Microsoft.Azure.Devices.MessageSystemPropertyNames.ConnectionDeviceId" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Specifies the device Id from which this message was sent, if there is one.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContentEncoding">
<MemberSignature Language="C#" Value="public const string ContentEncoding;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string ContentEncoding" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.MessageSystemPropertyNames.ContentEncoding" />
<MemberSignature Language="VB.NET" Value="Public Const ContentEncoding As String " />
<MemberSignature Language="F#" Value="val mutable ContentEncoding : string" Usage="Microsoft.Azure.Devices.MessageSystemPropertyNames.ContentEncoding" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Used to specify the content encoding type of the message.
Possible values are: utf-8, utf-16, utf-32.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContentType">
<MemberSignature Language="C#" Value="public const string ContentType;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string ContentType" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.MessageSystemPropertyNames.ContentType" />
<MemberSignature Language="VB.NET" Value="Public Const ContentType As String " />
<MemberSignature Language="F#" Value="val mutable ContentType : string" Usage="Microsoft.Azure.Devices.MessageSystemPropertyNames.ContentType" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Used to specify the content type of the message.
Possible values are: application/json, application/json-patch+json.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CorrelationId">
<MemberSignature Language="C#" Value="public const string CorrelationId;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string CorrelationId" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.MessageSystemPropertyNames.CorrelationId" />
<MemberSignature Language="VB.NET" Value="Public Const CorrelationId As String " />
<MemberSignature Language="F#" Value="val mutable CorrelationId : string" Usage="Microsoft.Azure.Devices.MessageSystemPropertyNames.CorrelationId" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
A string property in a response message that typically contains the MessageId of the request, in request-reply patterns.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreationTimeUtc">
<MemberSignature Language="C#" Value="public const string CreationTimeUtc;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string CreationTimeUtc" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.MessageSystemPropertyNames.CreationTimeUtc" />
<MemberSignature Language="VB.NET" Value="Public Const CreationTimeUtc As String " />
<MemberSignature Language="F#" Value="val mutable CreationTimeUtc : string" Usage="Microsoft.Azure.Devices.MessageSystemPropertyNames.CreationTimeUtc" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Custom date property set by the originator of the message.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeliveryCount">
<MemberSignature Language="C#" Value="public const string DeliveryCount;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string DeliveryCount" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.MessageSystemPropertyNames.DeliveryCount" />
<MemberSignature Language="VB.NET" Value="Public Const DeliveryCount As String " />
<MemberSignature Language="F#" Value="val mutable DeliveryCount : string" Usage="Microsoft.Azure.Devices.MessageSystemPropertyNames.DeliveryCount" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The number of times a message can transition between the Enqueued and Invisible states.
After the maximum number of transitions, the IoT hub sets the state of the message to dead-lettered.
For more information, see <see href="https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messages-c2d#the-cloud-to-device-message-life-cycle" /></summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnqueuedTime">
<MemberSignature Language="C#" Value="public const string EnqueuedTime;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string EnqueuedTime" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.MessageSystemPropertyNames.EnqueuedTime" />
<MemberSignature Language="VB.NET" Value="Public Const EnqueuedTime As String " />
<MemberSignature Language="F#" Value="val mutable EnqueuedTime : string" Usage="Microsoft.Azure.Devices.MessageSystemPropertyNames.EnqueuedTime" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Date and time when the message was received by the server in UTC.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExpiryTimeUtc">
<MemberSignature Language="C#" Value="public const string ExpiryTimeUtc;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string ExpiryTimeUtc" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.MessageSystemPropertyNames.ExpiryTimeUtc" />
<MemberSignature Language="VB.NET" Value="Public Const ExpiryTimeUtc As String " />
<MemberSignature Language="F#" Value="val mutable ExpiryTimeUtc : string" Usage="Microsoft.Azure.Devices.MessageSystemPropertyNames.ExpiryTimeUtc" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Date and time of message expiration in UTC.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LockToken">
<MemberSignature Language="C#" Value="public const string LockToken;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string LockToken" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.MessageSystemPropertyNames.LockToken" />
<MemberSignature Language="VB.NET" Value="Public Const LockToken As String " />
<MemberSignature Language="F#" Value="val mutable LockToken : string" Usage="Microsoft.Azure.Devices.MessageSystemPropertyNames.LockToken" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Lock token of the received message.
A unique identifier for a cloud-to-device message used to complete, reject or abandon the message.
This value is provided to resolve race conditions when completing, rejecting, or abandoning messages.
</summary>
<remarks>
If the lock token expires, the cloud-to-device message needs to be received again to complete, reject or abandon
the message without errors.
</remarks>
</Docs>
</Member>
<Member MemberName="MessageId">
<MemberSignature Language="C#" Value="public const string MessageId;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string MessageId" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.MessageSystemPropertyNames.MessageId" />
<MemberSignature Language="VB.NET" Value="Public Const MessageId As String " />
<MemberSignature Language="F#" Value="val mutable MessageId : string" Usage="Microsoft.Azure.Devices.MessageSystemPropertyNames.MessageId" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
A user-settable identifier for the messages. If this value is not supplied by the user,
the service client will set this to a new GUID only if you set <see cref="P:Microsoft.Azure.Devices.ServiceClientOptions.SdkAssignsMessageId" />
property in <see cref="T:Microsoft.Azure.Devices.ServiceClientOptions" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MessageSchema">
<MemberSignature Language="C#" Value="public const string MessageSchema;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string MessageSchema" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.MessageSystemPropertyNames.MessageSchema" />
<MemberSignature Language="VB.NET" Value="Public Const MessageSchema As String " />
<MemberSignature Language="F#" Value="val mutable MessageSchema : string" Usage="Microsoft.Azure.Devices.MessageSystemPropertyNames.MessageSchema" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The message schema is set internally by IoTHub when it generates Twin Change notification message.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Operation">
<MemberSignature Language="C#" Value="public const string Operation;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string Operation" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.MessageSystemPropertyNames.Operation" />
<MemberSignature Language="VB.NET" Value="Public Const Operation As String " />
<MemberSignature Language="F#" Value="val mutable Operation : string" Usage="Microsoft.Azure.Devices.MessageSystemPropertyNames.Operation" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
IoT hub operation
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SequenceNumber">
<MemberSignature Language="C#" Value="public const string SequenceNumber;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string SequenceNumber" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.MessageSystemPropertyNames.SequenceNumber" />
<MemberSignature Language="VB.NET" Value="Public Const SequenceNumber As String " />
<MemberSignature Language="F#" Value="val mutable SequenceNumber : string" Usage="Microsoft.Azure.Devices.MessageSystemPropertyNames.SequenceNumber" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
A number (unique per device-queue) assigned by IoT hub to each cloud-to-device message.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="To">
<MemberSignature Language="C#" Value="public const string To;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string To" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.MessageSystemPropertyNames.To" />
<MemberSignature Language="VB.NET" Value="Public Const To As String " />
<MemberSignature Language="F#" Value="val mutable To : string" Usage="Microsoft.Azure.Devices.MessageSystemPropertyNames.To" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
A destination specified in cloud-to-device messages.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UserId">
<MemberSignature Language="C#" Value="public const string UserId;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string UserId" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Devices.MessageSystemPropertyNames.UserId" />
<MemberSignature Language="VB.NET" Value="Public Const UserId As String " />
<MemberSignature Language="F#" Value="val mutable UserId : string" Usage="Microsoft.Azure.Devices.MessageSystemPropertyNames.UserId" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.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 name of the IoT hub.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>