SpellCheckClient class
- Extends
Constructors
| Spell |
Initializes a new instance of the SpellCheckClient class. |
Inherited Properties
| credentials | |
| endpoint |
Methods
Inherited Methods
| send |
Send an HTTP request that is populated using the provided OperationSpec. |
| send |
Send the provided httpRequest. |
Constructor Details
SpellCheckClient(ServiceClientCredentials, SpellCheckClientOptions)
Initializes a new instance of the SpellCheckClient class.
new SpellCheckClient(credentials: ServiceClientCredentials, options?: SpellCheckClientOptions)Parameters
- credentials
- ServiceClientCredentials
Subscription credentials which uniquely identify client subscription.
- options
- SpellCheckClientOptions
The parameter options
Inherited Property Details
credentials
credentials: ServiceClientCredentialsProperty Value
Inherited From SpellCheckClientContext.credentials
endpoint
Method Details
spellChecker(string, ServiceCallback<SpellCheck>)
function spellChecker(text: string, callback: ServiceCallback<SpellCheck>)Parameters
- text
-
string
The text string to check for spelling and grammar errors. The combined length of the text string, preContextText string, and postContextText string may not exceed 10,000 characters. You may specify this parameter in the query string of a GET request or in the body of a POST request. Because of the query string length limit, you'll typically use a POST request unless you're checking only short strings.
- callback
The callback
spellChecker(string, SpellCheckClientSpellCheckerOptionalParams)
function spellChecker(text: string, options?: SpellCheckClientSpellCheckerOptionalParams): Promise<SpellCheckerResponse>Parameters
- text
-
string
The text string to check for spelling and grammar errors. The combined length of the text string, preContextText string, and postContextText string may not exceed 10,000 characters. You may specify this parameter in the query string of a GET request or in the body of a POST request. Because of the query string length limit, you'll typically use a POST request unless you're checking only short strings.
The optional parameters
Returns
Promise<SpellCheckerResponse>
Promise<Models.SpellCheckerResponse>
spellChecker(string, SpellCheckClientSpellCheckerOptionalParams, ServiceCallback<SpellCheck>)
function spellChecker(text: string, options: SpellCheckClientSpellCheckerOptionalParams, callback: ServiceCallback<SpellCheck>)Parameters
- text
-
string
The text string to check for spelling and grammar errors. The combined length of the text string, preContextText string, and postContextText string may not exceed 10,000 characters. You may specify this parameter in the query string of a GET request or in the body of a POST request. Because of the query string length limit, you'll typically use a POST request unless you're checking only short strings.
The optional parameters
- callback
The callback
Inherited Method Details
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)
Send an HTTP request that is populated using the provided OperationSpec.
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>Parameters
- operationArguments
- OperationArguments
The arguments that the HTTP request's templated values will be populated from.
- operationSpec
- OperationSpec
The OperationSpec to use to populate the httpRequest.
- callback
-
ServiceCallback<any>
The callback to call when the response is received.
Returns
Promise<RestResponse>
Inherited From SpellCheckClientContext.sendOperationRequest
sendRequest(RequestPrepareOptions | WebResourceLike)
Send the provided httpRequest.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>Parameters
- options
Returns
Promise<HttpOperationResponse>
Inherited From SpellCheckClientContext.sendRequest