-
Notifications
You must be signed in to change notification settings - Fork 260
/
WritableProperty.xml
209 lines (209 loc) · 9.82 KB
/
WritableProperty.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
<Type Name="WritableProperty" FullName="Microsoft.Azure.Devices.WritableProperty">
<TypeSignature Language="C#" Value="public class WritableProperty" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WritableProperty extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.WritableProperty" />
<TypeSignature Language="VB.NET" Value="Public Class WritableProperty" />
<TypeSignature Language="F#" Value="type WritableProperty = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
An optional, helper class for deserializing a digital twin.
</summary>
<remarks>
A writable property is one that the service may request a change for from the device.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WritableProperty ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.WritableProperty.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AckCode">
<MemberSignature Language="C#" Value="public int AckCode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 AckCode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.WritableProperty.AckCode" />
<MemberSignature Language="VB.NET" Value="Public Property AckCode As Integer" />
<MemberSignature Language="F#" Value="member this.AckCode : int with get, set" Usage="Microsoft.Azure.Devices.WritableProperty.AckCode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty("ackCode")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty("ackCode")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
The response code of the property update request, usually an HTTP Status Code (e.g. 200).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AckDescription">
<MemberSignature Language="C#" Value="public string AckDescription { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string AckDescription" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.WritableProperty.AckDescription" />
<MemberSignature Language="VB.NET" Value="Public Property AckDescription As String" />
<MemberSignature Language="F#" Value="member this.AckDescription : string with get, set" Usage="Microsoft.Azure.Devices.WritableProperty.AckDescription" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty("ackDescription")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty("ackDescription")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The message response of the property update request.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AckVersion">
<MemberSignature Language="C#" Value="public int AckVersion { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 AckVersion" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.WritableProperty.AckVersion" />
<MemberSignature Language="VB.NET" Value="Public Property AckVersion As Integer" />
<MemberSignature Language="F#" Value="member this.AckVersion : int with get, set" Usage="Microsoft.Azure.Devices.WritableProperty.AckVersion" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty("ackVersion")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty("ackVersion")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
The version of the reported property value.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DesiredValue">
<MemberSignature Language="C#" Value="public object DesiredValue { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance object DesiredValue" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.WritableProperty.DesiredValue" />
<MemberSignature Language="VB.NET" Value="Public Property DesiredValue As Object" />
<MemberSignature Language="F#" Value="member this.DesiredValue : obj with get, set" Usage="Microsoft.Azure.Devices.WritableProperty.DesiredValue" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty("desiredValue")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty("desiredValue")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>
The desired value.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DesiredVersion">
<MemberSignature Language="C#" Value="public int DesiredVersion { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 DesiredVersion" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.WritableProperty.DesiredVersion" />
<MemberSignature Language="VB.NET" Value="Public Property DesiredVersion As Integer" />
<MemberSignature Language="F#" Value="member this.DesiredVersion : int with get, set" Usage="Microsoft.Azure.Devices.WritableProperty.DesiredVersion" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty("desiredVersion")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty("desiredVersion")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
The version of the property with the specified desired value.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LastUpdatedOnUtc">
<MemberSignature Language="C#" Value="public DateTimeOffset LastUpdatedOnUtc { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTimeOffset LastUpdatedOnUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.WritableProperty.LastUpdatedOnUtc" />
<MemberSignature Language="VB.NET" Value="Public Property LastUpdatedOnUtc As DateTimeOffset" />
<MemberSignature Language="F#" Value="member this.LastUpdatedOnUtc : DateTimeOffset with get, set" Usage="Microsoft.Azure.Devices.WritableProperty.LastUpdatedOnUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty("lastUpdateTime")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty("lastUpdateTime")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Docs>
<summary>
The time when this property was last updated.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>