/
NewsOperations.yml
262 lines (247 loc) · 9.32 KB
/
NewsOperations.yml
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
### YamlMime:TSType
name: NewsOperations
uid: '@azure/cognitiveservices-newssearch.NewsOperations'
package: '@azure/cognitiveservices-newssearch'
summary: Class representing a NewsOperations.
fullName: NewsOperations
remarks: ''
isDeprecated: false
type: class
constructors:
- name: NewsOperations(NewsSearchClientContext)
uid: '@azure/cognitiveservices-newssearch.NewsOperations.constructor'
package: '@azure/cognitiveservices-newssearch'
summary: Create a NewsOperations.
remarks: ''
isDeprecated: false
syntax:
content: 'new NewsOperations(client: NewsSearchClientContext)'
parameters:
- id: client
type: >-
<xref
uid="@azure/cognitiveservices-newssearch.NewsSearchClientContext" />
description: Reference to the service client.
methods:
- name: category(NewsCategoryOptionalParams)
uid: '@azure/cognitiveservices-newssearch.NewsOperations.category'
package: '@azure/cognitiveservices-newssearch'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function category(options?: NewsCategoryOptionalParams):
Promise<NewsCategoryResponse>
parameters:
- id: options
type: >-
<xref
uid="@azure/cognitiveservices-newssearch.NewsSearchModels.NewsCategoryOptionalParams"
/>
description: The optional parameters
return:
description: Promise<Models.NewsCategoryResponse>
type: >-
Promise<<xref
uid="@azure/cognitiveservices-newssearch.NewsSearchModels.NewsCategoryResponse"
/>>
- name: category(NewsCategoryOptionalParams, ServiceCallback<News>)
uid: '@azure/cognitiveservices-newssearch.NewsOperations.category_2'
package: '@azure/cognitiveservices-newssearch'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function category(options: NewsCategoryOptionalParams, callback:
ServiceCallback<News>)
parameters:
- id: options
type: >-
<xref
uid="@azure/cognitiveservices-newssearch.NewsSearchModels.NewsCategoryOptionalParams"
/>
description: The optional parameters
- id: callback
type: >-
<xref uid="@azure/ms-rest-js.ServiceCallback" /><<xref
uid="@azure/cognitiveservices-newssearch.NewsSearchModels.News"
/>>
description: The callback
- name: category(ServiceCallback<News>)
uid: '@azure/cognitiveservices-newssearch.NewsOperations.category_1'
package: '@azure/cognitiveservices-newssearch'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'function category(callback: ServiceCallback<News>)'
parameters:
- id: callback
type: >-
<xref uid="@azure/ms-rest-js.ServiceCallback" /><<xref
uid="@azure/cognitiveservices-newssearch.NewsSearchModels.News"
/>>
description: The callback
- name: search(string, NewsSearchOptionalParams)
uid: '@azure/cognitiveservices-newssearch.NewsOperations.search'
package: '@azure/cognitiveservices-newssearch'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function search(query: string, options?: NewsSearchOptionalParams):
Promise<NewsSearchResponse>
parameters:
- id: query
type: string
description: >-
The user's search query string. The query string cannot be empty.
The query string
may contain [Bing Advanced
Operators](http://msdn.microsoft.com/library/ff795620.aspx). For
example, to limit news to a specific domain, use the
[site:](http://msdn.microsoft.com/library/ff795613.aspx) operator.
Use this parameter only with
the News Search API. Do not specify this parameter when calling the
Trending Topics API or News
Category API.
- id: options
type: >-
<xref
uid="@azure/cognitiveservices-newssearch.NewsSearchModels.NewsSearchOptionalParams"
/>
description: The optional parameters
return:
description: Promise<Models.NewsSearchResponse>
type: >-
Promise<<xref
uid="@azure/cognitiveservices-newssearch.NewsSearchModels.NewsSearchResponse"
/>>
- name: search(string, NewsSearchOptionalParams, ServiceCallback<News>)
uid: '@azure/cognitiveservices-newssearch.NewsOperations.search_2'
package: '@azure/cognitiveservices-newssearch'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function search(query: string, options: NewsSearchOptionalParams,
callback: ServiceCallback<News>)
parameters:
- id: query
type: string
description: >-
The user's search query string. The query string cannot be empty.
The query string
may contain [Bing Advanced
Operators](http://msdn.microsoft.com/library/ff795620.aspx). For
example, to limit news to a specific domain, use the
[site:](http://msdn.microsoft.com/library/ff795613.aspx) operator.
Use this parameter only with
the News Search API. Do not specify this parameter when calling the
Trending Topics API or News
Category API.
- id: options
type: >-
<xref
uid="@azure/cognitiveservices-newssearch.NewsSearchModels.NewsSearchOptionalParams"
/>
description: The optional parameters
- id: callback
type: >-
<xref uid="@azure/ms-rest-js.ServiceCallback" /><<xref
uid="@azure/cognitiveservices-newssearch.NewsSearchModels.News"
/>>
description: The callback
- name: search(string, ServiceCallback<News>)
uid: '@azure/cognitiveservices-newssearch.NewsOperations.search_1'
package: '@azure/cognitiveservices-newssearch'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'function search(query: string, callback: ServiceCallback<News>)'
parameters:
- id: query
type: string
description: >-
The user's search query string. The query string cannot be empty.
The query string
may contain [Bing Advanced
Operators](http://msdn.microsoft.com/library/ff795620.aspx). For
example, to limit news to a specific domain, use the
[site:](http://msdn.microsoft.com/library/ff795613.aspx) operator.
Use this parameter only with
the News Search API. Do not specify this parameter when calling the
Trending Topics API or News
Category API.
- id: callback
type: >-
<xref uid="@azure/ms-rest-js.ServiceCallback" /><<xref
uid="@azure/cognitiveservices-newssearch.NewsSearchModels.News"
/>>
description: The callback
- name: trending(NewsTrendingOptionalParams)
uid: '@azure/cognitiveservices-newssearch.NewsOperations.trending'
package: '@azure/cognitiveservices-newssearch'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function trending(options?: NewsTrendingOptionalParams):
Promise<NewsTrendingResponse>
parameters:
- id: options
type: >-
<xref
uid="@azure/cognitiveservices-newssearch.NewsSearchModels.NewsTrendingOptionalParams"
/>
description: The optional parameters
return:
description: Promise<Models.NewsTrendingResponse>
type: >-
Promise<<xref
uid="@azure/cognitiveservices-newssearch.NewsSearchModels.NewsTrendingResponse"
/>>
- name: trending(NewsTrendingOptionalParams, ServiceCallback<TrendingTopics>)
uid: '@azure/cognitiveservices-newssearch.NewsOperations.trending_2'
package: '@azure/cognitiveservices-newssearch'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function trending(options: NewsTrendingOptionalParams, callback:
ServiceCallback<TrendingTopics>)
parameters:
- id: options
type: >-
<xref
uid="@azure/cognitiveservices-newssearch.NewsSearchModels.NewsTrendingOptionalParams"
/>
description: The optional parameters
- id: callback
type: >-
<xref uid="@azure/ms-rest-js.ServiceCallback" /><<xref
uid="@azure/cognitiveservices-newssearch.NewsSearchModels.TrendingTopics"
/>>
description: The callback
- name: trending(ServiceCallback<TrendingTopics>)
uid: '@azure/cognitiveservices-newssearch.NewsOperations.trending_1'
package: '@azure/cognitiveservices-newssearch'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'function trending(callback: ServiceCallback<TrendingTopics>)'
parameters:
- id: callback
type: >-
<xref uid="@azure/ms-rest-js.ServiceCallback" /><<xref
uid="@azure/cognitiveservices-newssearch.NewsSearchModels.TrendingTopics"
/>>
description: The callback