Skip to content

Commit c332a32

Browse files
authored
Merge pull request MicrosoftDocs#319 from MicrosoftDocs/master
5/15 Publish
2 parents b4cf45c + d36e9be commit c332a32

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+2349
-112
lines changed

docs-ref-autogen/azure-cognitiveservices-newssearch/NewsOperations.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -2028,7 +2028,7 @@ items:
20282028
20292029
[category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category)
20302030
2031-
parameter, Bing ignores this paramter.
2031+
parameter, Bing ignores this parameter.
20322032
optional: true
20332033
- id: options.headlineCount
20342034
type:
@@ -2116,7 +2116,7 @@ items:
21162116
21172117
[category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category)
21182118
2119-
parameter, Bing ignores this paramter.
2119+
parameter, Bing ignores this parameter.
21202120
optional: true
21212121
- id: options.originalImage
21222122
type:
@@ -2791,7 +2791,7 @@ items:
27912791
27922792
[category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category)
27932793
2794-
parameter, Bing ignores this paramter.
2794+
parameter, Bing ignores this parameter.
27952795
optional: true
27962796
- id: options.headlineCount
27972797
type:
@@ -2879,7 +2879,7 @@ items:
28792879
28802880
[category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category)
28812881
2882-
parameter, Bing ignores this paramter.
2882+
parameter, Bing ignores this parameter.
28832883
optional: true
28842884
- id: options.originalImage
28852885
type:

docs-ref-autogen/azure-cognitiveservices-spellcheck/SpellCheckAPIClient.yml

+48-49
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ items:
6767
id: >-
6868
azure-cognitiveservices-spellcheck.SpellCheckAPIClient#spellCheckerWithHttpOperationResponse
6969
parent: azure-cognitiveservices-spellcheck.SpellCheckAPIClient
70-
name: spellCheckerWithHttpOperationResponse(options)
70+
name: 'spellCheckerWithHttpOperationResponse(text, options)'
7171
summary: >-
7272
The Bing Spell Check API lets you perform contextual grammar and
7373
@@ -81,7 +81,8 @@ items:
8181
8282
based on a massive corpus of web searches and documents.
8383
fullName: >-
84-
azure-cognitiveservices-spellcheck.SpellCheckAPIClient.spellCheckerWithHttpOperationResponse(options)
84+
azure-cognitiveservices-spellcheck.SpellCheckAPIClient.spellCheckerWithHttpOperationResponse(text,
85+
options)
8586
tags:
8687
- originalTitle: resolve
8788
title: resolve
@@ -94,6 +95,25 @@ items:
9495
type: Function
9596
syntax:
9697
parameters:
98+
- id: text
99+
type:
100+
- string
101+
description: >-
102+
The text string to check for spelling and grammar
103+
104+
errors. The combined length of the text string, preContextText
105+
string, and
106+
107+
postContextText string may not exceed 10,000 characters. You may
108+
specify
109+
110+
this parameter in the query string of a GET request or in the body
111+
of a POST
112+
113+
request. Because of the query string length limit, you'll typically
114+
use a
115+
116+
POST request unless you're checking only short strings.
97117
- id: options
98118
type:
99119
- object
@@ -594,7 +614,7 @@ items:
594614
the grammar errors that Proof catches (for example, capitalization
595615
and
596616
597-
repeated words). Possible values include: 'Proof', 'Spell'
617+
repeated words). Possible values include: 'proof', 'spell'
598618
optional: true
599619
- id: options.preContextText
600620
type:
@@ -652,26 +672,6 @@ items:
652672
653673
request.
654674
optional: true
655-
- id: options.text
656-
type:
657-
- string
658-
description: >-
659-
The text string to check for spelling and
660-
661-
grammar errors. The combined length of the text string,
662-
preContextText
663-
664-
string, and postContextText string may not exceed 10,000 characters.
665-
You may
666-
667-
specify this parameter in the query string of a GET request or in
668-
the body
669-
670-
of a POST request. Because of the query string length limit, you'll
671-
672-
typically use a POST request unless you're checking only short
673-
strings.
674-
optional: true
675675
- id: options.customHeaders
676676
type:
677677
- object
@@ -683,13 +683,13 @@ items:
683683
type:
684684
- Promise
685685
description: A promise is returned
686-
content: function spellCheckerWithHttpOperationResponse(options)
686+
content: 'function spellCheckerWithHttpOperationResponse(text, options)'
687687
langs:
688688
- js
689689
- uid: 'azure-cognitiveservices-spellcheck.SpellCheckAPIClient#spellChecker'
690690
id: 'azure-cognitiveservices-spellcheck.SpellCheckAPIClient#spellChecker'
691691
parent: azure-cognitiveservices-spellcheck.SpellCheckAPIClient
692-
name: 'spellChecker(options, optionalCallback)'
692+
name: 'spellChecker(text, options, optionalCallback)'
693693
summary: >-
694694
The Bing Spell Check API lets you perform contextual grammar and
695695
@@ -703,8 +703,8 @@ items:
703703
704704
based on a massive corpus of web searches and documents.
705705
fullName: >-
706-
azure-cognitiveservices-spellcheck.SpellCheckAPIClient.spellChecker(options,
707-
optionalCallback)
706+
azure-cognitiveservices-spellcheck.SpellCheckAPIClient.spellChecker(text,
707+
options, optionalCallback)
708708
tags:
709709
- originalTitle: resolve
710710
title: resolve
@@ -741,6 +741,25 @@ items:
741741
type: Function
742742
syntax:
743743
parameters:
744+
- id: text
745+
type:
746+
- string
747+
description: >-
748+
The text string to check for spelling and grammar
749+
750+
errors. The combined length of the text string, preContextText
751+
string, and
752+
753+
postContextText string may not exceed 10,000 characters. You may
754+
specify
755+
756+
this parameter in the query string of a GET request or in the body
757+
of a POST
758+
759+
request. Because of the query string length limit, you'll typically
760+
use a
761+
762+
POST request unless you're checking only short strings.
744763
- id: options
745764
type:
746765
- object
@@ -1241,7 +1260,7 @@ items:
12411260
the grammar errors that Proof catches (for example, capitalization
12421261
and
12431262
1244-
repeated words). Possible values include: 'Proof', 'Spell'
1263+
repeated words). Possible values include: 'proof', 'spell'
12451264
optional: true
12461265
- id: options.preContextText
12471266
type:
@@ -1299,26 +1318,6 @@ items:
12991318
13001319
request.
13011320
optional: true
1302-
- id: options.text
1303-
type:
1304-
- string
1305-
description: >-
1306-
The text string to check for spelling and
1307-
1308-
grammar errors. The combined length of the text string,
1309-
preContextText
1310-
1311-
string, and postContextText string may not exceed 10,000 characters.
1312-
You may
1313-
1314-
specify this parameter in the query string of a GET request or in
1315-
the body
1316-
1317-
of a POST request. Because of the query string length limit, you'll
1318-
1319-
typically use a POST request unless you're checking only short
1320-
strings.
1321-
optional: true
13221321
- id: options.customHeaders
13231322
type:
13241323
- object
@@ -1340,6 +1339,6 @@ items:
13401339
then it returns the callback else returns a Promise.
13411340
13421341
{Promise} A promise is returned
1343-
content: 'function spellChecker(options, optionalCallback)'
1342+
content: 'function spellChecker(text, options, optionalCallback)'
13441343
langs:
13451344
- js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
### YamlMime:UniversalReference
2+
items:
3+
- uid: azure-event-hubs.AadTokenProvider
4+
id: azure-event-hubs.AadTokenProvider
5+
name: AadTokenProvider
6+
summary: Defines the AAD (Azure ActiveDirectory) TokenProvider.
7+
fullName: azure-event-hubs.AadTokenProvider
8+
type: Class
9+
children:
10+
- 'azure-event-hubs.AadTokenProvider.#ctor'
11+
- 'azure-event-hubs.AadTokenProvider#tokenRenewalMarginInSeconds'
12+
- 'azure-event-hubs.AadTokenProvider#tokenValidTimeInSeconds'
13+
- 'azure-event-hubs.AadTokenProvider#getToken'
14+
langs:
15+
- js
16+
- id: 'azure-event-hubs.AadTokenProvider.#ctor'
17+
uid: 'azure-event-hubs.AadTokenProvider.#ctor'
18+
parent: azure-event-hubs.AadTokenProvider
19+
name: AadTokenProvider()
20+
fullName: azure-event-hubs.AadTokenProvider.AadTokenProvider()
21+
summary: Defines the AAD (Azure ActiveDirectory) TokenProvider.
22+
type: Constructor
23+
syntax:
24+
content: new AadTokenProvider()
25+
langs:
26+
- js
27+
- uid: 'azure-event-hubs.AadTokenProvider#tokenRenewalMarginInSeconds'
28+
id: 'azure-event-hubs.AadTokenProvider#tokenRenewalMarginInSeconds'
29+
parent: azure-event-hubs.AadTokenProvider
30+
name: tokenRenewalMarginInSeconds
31+
summary: ''
32+
fullName: azure-event-hubs.AadTokenProvider.tokenRenewalMarginInSeconds
33+
type: Member
34+
syntax:
35+
content: tokenRenewalMarginInSeconds
36+
langs:
37+
- js
38+
- uid: 'azure-event-hubs.AadTokenProvider#tokenValidTimeInSeconds'
39+
id: 'azure-event-hubs.AadTokenProvider#tokenValidTimeInSeconds'
40+
parent: azure-event-hubs.AadTokenProvider
41+
name: tokenValidTimeInSeconds
42+
summary: ''
43+
fullName: azure-event-hubs.AadTokenProvider.tokenValidTimeInSeconds
44+
type: Member
45+
syntax:
46+
content: tokenValidTimeInSeconds
47+
langs:
48+
- js
49+
- uid: 'azure-event-hubs.AadTokenProvider#getToken'
50+
id: 'azure-event-hubs.AadTokenProvider#getToken'
51+
parent: azure-event-hubs.AadTokenProvider
52+
name: getToken(audience)
53+
summary: Gets the jwt token for the specified audience
54+
fullName: azure-event-hubs.AadTokenProvider.getToken(audience)
55+
type: Function
56+
syntax:
57+
parameters:
58+
- id: audience
59+
type:
60+
- string
61+
description: >-
62+
The audience for which the token is desired. If not
63+
64+
provided then the Endpoint from the connection string will be
65+
applied.
66+
optional: true
67+
content: function getToken(audience)
68+
langs:
69+
- js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
### YamlMime:UniversalReference
2+
items:
3+
- uid: azure-event-hubs.BatchingReceiver
4+
id: azure-event-hubs.BatchingReceiver
5+
name: BatchingReceiver
6+
summary: >-
7+
Describes the batching receiver where the user can receive a specified
8+
number of messages for a predefined time.
9+
fullName: azure-event-hubs.BatchingReceiver
10+
type: Class
11+
children:
12+
- 'azure-event-hubs.BatchingReceiver.#ctor'
13+
- 'azure-event-hubs.BatchingReceiver#receive'
14+
- azure-event-hubs.BatchingReceiver.create
15+
langs:
16+
- js
17+
- id: 'azure-event-hubs.BatchingReceiver.#ctor'
18+
uid: 'azure-event-hubs.BatchingReceiver.#ctor'
19+
parent: azure-event-hubs.BatchingReceiver
20+
name: BatchingReceiver()
21+
fullName: azure-event-hubs.BatchingReceiver.BatchingReceiver()
22+
summary: >-
23+
Describes the batching receiver where the user can receive a specified
24+
number of messages for a predefined time.
25+
type: Constructor
26+
syntax:
27+
content: new BatchingReceiver()
28+
langs:
29+
- js
30+
- uid: 'azure-event-hubs.BatchingReceiver#receive'
31+
id: 'azure-event-hubs.BatchingReceiver#receive'
32+
parent: azure-event-hubs.BatchingReceiver
33+
name: 'receive(maxMessageCount, maxWaitTimeInSeconds)'
34+
summary: >-
35+
Receive a batch of EventData objects from an EventHub partition for a
36+
given count and a given max wait time in seconds, whichever
37+
38+
happens first. This method can be used directly after creating the
39+
receiver object and **MUST NOT** be used along with the `start()` method.
40+
fullName: >-
41+
azure-event-hubs.BatchingReceiver.receive(maxMessageCount,
42+
maxWaitTimeInSeconds)
43+
type: Function
44+
syntax:
45+
parameters:
46+
- id: maxMessageCount
47+
type:
48+
- number
49+
description: The maximum message count. Must be a value greater than 0.
50+
- id: maxWaitTimeInSeconds
51+
type:
52+
- number
53+
description: >-
54+
The maximum wait time in seconds for which the Receiver should wait
55+
56+
to receiver the said amount of messages. If not provided, it
57+
defaults to 60 seconds.
58+
optional: true
59+
return:
60+
type:
61+
- azure-event-hubs.Promise.<Array.<EventData>>
62+
description: A promise that resolves with an array of EventData objects.
63+
content: 'function receive(maxMessageCount, maxWaitTimeInSeconds)'
64+
langs:
65+
- js
66+
- uid: azure-event-hubs.BatchingReceiver.create
67+
id: azure-event-hubs.BatchingReceiver.create
68+
parent: azure-event-hubs.BatchingReceiver
69+
name: 'create(context, partitionId, options)'
70+
summary: Creates a batching receiver.
71+
fullName: 'azure-event-hubs.BatchingReceiver.create(context, partitionId, options)'
72+
type: Function
73+
syntax:
74+
parameters:
75+
- id: context
76+
type:
77+
- azure-event-hubs.ConnectionContext
78+
description: The connection context.
79+
- id: partitionId
80+
type:
81+
- string
82+
- number
83+
description: The partitionId to receive events from.
84+
- id: options
85+
type:
86+
- azure-event-hubs.ReceiveOptions
87+
description: Receive options.
88+
optional: true
89+
content: 'function create(context, partitionId, options)'
90+
langs:
91+
- js

0 commit comments

Comments
 (0)