-
Notifications
You must be signed in to change notification settings - Fork 257
/
FeedbackRecord.xml
275 lines (275 loc) · 17.1 KB
/
FeedbackRecord.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
<Type Name="FeedbackRecord" FullName="Microsoft.Azure.Devices.FeedbackRecord">
<TypeSignature Language="C#" Value="public class FeedbackRecord" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit FeedbackRecord extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.FeedbackRecord" />
<TypeSignature Language="VB.NET" Value="Public Class FeedbackRecord" />
<TypeSignature Language="F#" Value="type FeedbackRecord = 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>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Contains properties of an individual feedback record.
</summary>
<remarks>
Feedback messages are delivery acknowledgments for messages sent to a device from IoT hub.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FeedbackRecord ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.FeedbackRecord.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Description">
<MemberSignature Language="C#" Value="public string Description { get; set; }" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="ILAsm" Value=".property instance string Description" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.FeedbackRecord.Description" />
<MemberSignature Language="VB.NET" Value="Public Property Description As String" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="F#" Value="member this.Description : string with get, set" Usage="Microsoft.Azure.Devices.FeedbackRecord.Description" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="C#" Value="public string Description { get; }" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Description As String" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="F#" Value="member this.Description : string" Usage="Microsoft.Azure.Devices.FeedbackRecord.Description" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="description")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="description")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Description for <see cref="P:Microsoft.Azure.Devices.FeedbackRecord.StatusCode" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeviceGenerationId">
<MemberSignature Language="C#" Value="public string DeviceGenerationId { get; set; }" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="ILAsm" Value=".property instance string DeviceGenerationId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.FeedbackRecord.DeviceGenerationId" />
<MemberSignature Language="VB.NET" Value="Public Property DeviceGenerationId As String" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="F#" Value="member this.DeviceGenerationId : string with get, set" Usage="Microsoft.Azure.Devices.FeedbackRecord.DeviceGenerationId" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="C#" Value="public string DeviceGenerationId { get; }" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property DeviceGenerationId As String" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="F#" Value="member this.DeviceGenerationId : string" Usage="Microsoft.Azure.Devices.FeedbackRecord.DeviceGenerationId" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="deviceGenerationId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="deviceGenerationId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The device generation Id of the target device of the cloud-to-device message to which this piece of feedback relates.
</summary>
<value>To be added.</value>
<remarks>
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.
</remarks>
</Docs>
</Member>
<Member MemberName="DeviceId">
<MemberSignature Language="C#" Value="public string DeviceId { get; set; }" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="ILAsm" Value=".property instance string DeviceId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.FeedbackRecord.DeviceId" />
<MemberSignature Language="VB.NET" Value="Public Property DeviceId As String" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="F#" Value="member this.DeviceId : string with get, set" Usage="Microsoft.Azure.Devices.FeedbackRecord.DeviceId" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="C#" Value="public string DeviceId { get; }" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property DeviceId As String" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="F#" Value="member this.DeviceId : string" Usage="Microsoft.Azure.Devices.FeedbackRecord.DeviceId" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="deviceId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="deviceId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The Id of the target device of the cloud-to-device message to which this piece of feedback relates.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnqueuedOnUtc">
<MemberSignature Language="C#" Value="public DateTimeOffset EnqueuedOnUtc { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTimeOffset EnqueuedOnUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.FeedbackRecord.EnqueuedOnUtc" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EnqueuedOnUtc As DateTimeOffset" />
<MemberSignature Language="F#" Value="member this.EnqueuedOnUtc : DateTimeOffset" Usage="Microsoft.Azure.Devices.FeedbackRecord.EnqueuedOnUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="azure-dotnet-preview">
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="enqueuedTimeUtc")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="enqueuedTimeUtc")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Docs>
<summary>
Date and time that indicates when the outcome of the message happened in UTC (for example, the hub received the feedback message or the original message expired).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnqueuedTimeUtc">
<MemberSignature Language="C#" Value="public DateTime EnqueuedTimeUtc { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime EnqueuedTimeUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.FeedbackRecord.EnqueuedTimeUtc" />
<MemberSignature Language="VB.NET" Value="Public Property EnqueuedTimeUtc As DateTime" />
<MemberSignature Language="F#" Value="member this.EnqueuedTimeUtc : DateTime with get, set" Usage="Microsoft.Azure.Devices.FeedbackRecord.EnqueuedTimeUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="azure-dotnet">
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="enqueuedTimeUtc")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="enqueuedTimeUtc")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>
Date and time that indicates when the outcome of the message happened in UTC (for example, the hub received the feedback message or the original message expired).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OriginalMessageId">
<MemberSignature Language="C#" Value="public string OriginalMessageId { get; set; }" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="ILAsm" Value=".property instance string OriginalMessageId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.FeedbackRecord.OriginalMessageId" />
<MemberSignature Language="VB.NET" Value="Public Property OriginalMessageId As String" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="F#" Value="member this.OriginalMessageId : string with get, set" Usage="Microsoft.Azure.Devices.FeedbackRecord.OriginalMessageId" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="C#" Value="public string OriginalMessageId { get; }" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property OriginalMessageId As String" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="F#" Value="member this.OriginalMessageId : string" Usage="Microsoft.Azure.Devices.FeedbackRecord.OriginalMessageId" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="originalMessageId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="originalMessageId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The Id of the cloud-to-device message to which this feedback message relates.
</summary>
<value>To be added.</value>
<remarks>
Feedback messages are delivery acknowledgments for messages sent to a device from IoT hub.
</remarks>
</Docs>
</Member>
<Member MemberName="StatusCode">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.FeedbackStatusCode StatusCode { get; set; }" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Devices.FeedbackStatusCode StatusCode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.FeedbackRecord.StatusCode" />
<MemberSignature Language="VB.NET" Value="Public Property StatusCode As FeedbackStatusCode" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="F#" Value="member this.StatusCode : Microsoft.Azure.Devices.FeedbackStatusCode with get, set" Usage="Microsoft.Azure.Devices.FeedbackRecord.StatusCode" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.FeedbackStatusCode StatusCode { get; }" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StatusCode As FeedbackStatusCode" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="F#" Value="member this.StatusCode : Microsoft.Azure.Devices.FeedbackStatusCode" Usage="Microsoft.Azure.Devices.FeedbackRecord.StatusCode" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="statusCode")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="statusCode")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.FeedbackStatusCode</ReturnType>
</ReturnValue>
<Docs>
<summary>
The status of feedback messages that are generated by the IoT hub.
</summary>
<value>To be added.</value>
<remarks>
Possible values are:
<list type="bullet"><item><description>Success</description></item><item><description>Expired</description></item><item><description>DeliveryCountExceeded</description></item><item><description>Rejected</description></item><item><description>Purged</description></item></list></remarks>
</Docs>
</Member>
</Members>
</Type>