-
Notifications
You must be signed in to change notification settings - Fork 255
/
Query.xml
216 lines (216 loc) · 11.4 KB
/
Query.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
<Type Name="Query" FullName="Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.Query">
<TypeSignature Language="C#" Value="public class Query" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Query extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.Query" />
<TypeSignature Language="VB.NET" Value="Public Class Query" />
<TypeSignature Language="F#" Value="type Query = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.CustomSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Defines a search query.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Query ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.Query.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.CustomSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the Query class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Query (string text, string displayText = default, string webSearchUrl = default, string searchLink = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string text, string displayText, string webSearchUrl, string searchLink) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.Query.#ctor(System.String,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (text As String, Optional displayText As String = Nothing, Optional webSearchUrl As String = Nothing, Optional searchLink As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.Query : string * string * string * string -> Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.Query" Usage="new Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.Query (text, displayText, webSearchUrl, searchLink)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.CustomSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="text" Type="System.String" />
<Parameter Name="displayText" Type="System.String" />
<Parameter Name="webSearchUrl" Type="System.String" />
<Parameter Name="searchLink" Type="System.String" />
</Parameters>
<Docs>
<param name="searchLink">To be added.</param>
<param name="text">The query string. Use this string as the query
term in a new search request.</param>
<param name="displayText">The display version of the query term.
This version of the query term may contain special characters that
highlight the search term found in the query string. The string
contains the highlighting characters only if the query enabled hit
highlighting</param>
<param name="webSearchUrl">The URL that takes the user to the Bing
search results page for the query.Only related search results
include this field.</param>
<summary>
Initializes a new instance of the Query class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DisplayText">
<MemberSignature Language="C#" Value="public string DisplayText { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DisplayText" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.Query.DisplayText" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property DisplayText As String" />
<MemberSignature Language="F#" Value="member this.DisplayText : string" Usage="Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.Query.DisplayText" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.CustomSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="displayText")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="displayText")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the display version of the query term. This version of the
query term may contain special characters that highlight the search
term found in the query string. The string contains the
highlighting characters only if the query enabled hit highlighting
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SearchLink">
<MemberSignature Language="C#" Value="public string SearchLink { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SearchLink" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.Query.SearchLink" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SearchLink As String" />
<MemberSignature Language="F#" Value="member this.SearchLink : string" Usage="Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.Query.SearchLink" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.CustomSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="searchLink")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="searchLink")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary />
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Text">
<MemberSignature Language="C#" Value="public string Text { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Text" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.Query.Text" />
<MemberSignature Language="VB.NET" Value="Public Property Text As String" />
<MemberSignature Language="F#" Value="member this.Text : string with get, set" Usage="Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.Query.Text" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.CustomSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="text")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="text")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the query string. Use this string as the query term in
a new search request.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public virtual void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.Query.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate ()" />
<MemberSignature Language="F#" Value="abstract member Validate : unit -> unit
override this.Validate : unit -> unit" Usage="query.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.CustomSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Validate the object.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown if validation fails
</exception>
</Docs>
</Member>
<Member MemberName="WebSearchUrl">
<MemberSignature Language="C#" Value="public string WebSearchUrl { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string WebSearchUrl" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.Query.WebSearchUrl" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property WebSearchUrl As String" />
<MemberSignature Language="F#" Value="member this.WebSearchUrl : string" Usage="Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.Query.WebSearchUrl" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.CustomSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="webSearchUrl")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="webSearchUrl")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the URL that takes the user to the Bing search results page
for the query.Only related search results include this field.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>