-
Notifications
You must be signed in to change notification settings - Fork 256
/
QueryResult.xml
193 lines (191 loc) · 11.6 KB
/
QueryResult.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
<Type Name="QueryResult" FullName="Microsoft.Azure.Devices.Provisioning.Service.QueryResult">
<TypeSignature Language="C#" Value="public class QueryResult" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit QueryResult extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Provisioning.Service.QueryResult" />
<TypeSignature Language="VB.NET" Value="Public Class QueryResult" />
<TypeSignature Language="F#" Value="type QueryResult = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
<AssemblyVersion>1.16.3.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
<AssemblyVersion>1.17.1.0</AssemblyVersion>
<AssemblyVersion>1.17.2.0</AssemblyVersion>
<AssemblyVersion>1.18.0.0</AssemblyVersion>
<AssemblyVersion>1.18.1.0</AssemblyVersion>
<AssemblyVersion>1.18.2.0</AssemblyVersion>
<AssemblyVersion>1.19.0.0</AssemblyVersion>
<AssemblyVersion>1.19.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Representation of a single Device Provisioning Service query response with a JSON deserializer.
</summary>
<remarks>
It is the result of any query for the provisioning service. This class will parse the result and
return it in a best format possible. For the known formats in <see cref="T:Microsoft.Azure.Devices.Provisioning.Service.QueryResultType" />, you can
just cast the items. In case of unknown type, the items will contain a list of string
and you shall parse it by your own.
The provisioning service query result is composed by 2 system properties and a body. This class exposes
it with 3 getters, <see cref="P:Microsoft.Azure.Devices.Provisioning.Service.QueryResult.QueryType" />, <see cref="P:Microsoft.Azure.Devices.Provisioning.Service.QueryResult.Items" />, and <see cref="P:Microsoft.Azure.Devices.Provisioning.Service.QueryResult.ContinuationToken" />.
The system properties are:
<list type="bullet"><item><description>type:
Identify the type of the content in the body. You can use it to cast the objects
in the items list. See <see cref="T:Microsoft.Azure.Devices.Provisioning.Service.QueryResultType" /> for the possible types and classes
to cast.</description></item><item><description>continuationToken:
Contains the token the uniquely identify the next page of information. The
service will return the next page of this query when you send a new query with
this token.</description></item></list></remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected internal QueryResult (string typeString, string bodyString, string continuationToken);" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig specialname rtspecialname instance void .ctor(string typeString, string bodyString, string continuationToken) cil managed" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Service.QueryResult.#ctor(System.String,System.String,System.String)" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Protected Friend Sub New (typeString As String, bodyString As String, continuationToken As String)" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Provisioning.Service.QueryResult : string * string * string -> Microsoft.Azure.Devices.Provisioning.Service.QueryResult" Usage="new Microsoft.Azure.Devices.Provisioning.Service.QueryResult (typeString, bodyString, continuationToken)" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="typeString" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="bodyString" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="continuationToken" Type="System.String" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="typeString">The string with type of the content in the body.
It cannot be null.</param>
<param name="bodyString">The string with the body in a JSON list format.
It cannot be null, or empty, if the type is different than `unknown`.</param>
<param name="continuationToken">The string with the continuation token.
It can be null.</param>
<summary>
CONSTRUCTOR
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">If <paramref name="bodyString" /> is null.</exception>
<exception cref="T:System.ArgumentException">If <paramref name="bodyString" /> is empty or white space.</exception>
</Docs>
</Member>
<Member MemberName="ContinuationToken">
<MemberSignature Language="C#" Value="public string ContinuationToken { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ContinuationToken" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Service.QueryResult.ContinuationToken" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ContinuationToken As String" />
<MemberSignature Language="F#" Value="member this.ContinuationToken : string" Usage="Microsoft.Azure.Devices.Provisioning.Service.QueryResult.ContinuationToken" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
<AssemblyVersion>1.18.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Getter for the query result continuation token.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Items">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<object> Items { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1<object> Items" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Service.QueryResult.Items" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Items As IEnumerable(Of Object)" />
<MemberSignature Language="F#" Value="member this.Items : seq<obj>" Usage="Microsoft.Azure.Devices.Provisioning.Service.QueryResult.Items" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
<AssemblyVersion>1.18.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<System.Object></ReturnType>
</ReturnValue>
<Docs>
<summary>
Getter for the list of query result items.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="QueryType">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.Provisioning.Service.QueryResultType QueryType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Devices.Provisioning.Service.QueryResultType QueryType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Service.QueryResult.QueryType" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property QueryType As QueryResultType" />
<MemberSignature Language="F#" Value="member this.QueryType : Microsoft.Azure.Devices.Provisioning.Service.QueryResultType" Usage="Microsoft.Azure.Devices.Provisioning.Service.QueryResult.QueryType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.Provisioning.Service.QueryResultType</ReturnType>
</ReturnValue>
<Docs>
<summary>
Getter for the query result type.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Service.QueryResult.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="queryResult.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
<AssemblyVersion>1.18.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Convert this object in a pretty print format.
</summary>
<returns>The string with the content of this class in a pretty print format.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.Provisioning.Service.QueryResultType Type { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Devices.Provisioning.Service.QueryResultType Type" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Service.QueryResult.Type" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Type As QueryResultType" />
<MemberSignature Language="F#" Value="member this.Type : Microsoft.Azure.Devices.Provisioning.Service.QueryResultType" Usage="Microsoft.Azure.Devices.Provisioning.Service.QueryResult.Type" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
<AssemblyVersion>1.18.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.Provisioning.Service.QueryResultType</ReturnType>
</ReturnValue>
<Docs>
<summary>
Getter for the query result Type.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>