WebSearchClient class

  • Reference
Package:
@azure/cognitiveservices-websearch
Extends
WebSearchClientContext

Constructors

WebSearchClient(ServiceClientCredentials, WebSearchClientOptions)

Initializes a new instance of the WebSearchClient class.

Properties

web

Inherited Properties

credentials
endpoint

Inherited Methods

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Send an HTTP request that is populated using the provided OperationSpec.
sendRequest(RequestPrepareOptions | WebResourceLike)

Send the provided httpRequest.

Constructor Details

WebSearchClient(ServiceClientCredentials, WebSearchClientOptions)

Initializes a new instance of the WebSearchClient class.

new WebSearchClient(credentials: ServiceClientCredentials, options?: WebSearchClientOptions)

Parameters

credentials
ServiceClientCredentials

Subscription credentials which uniquely identify client subscription.

options
WebSearchClientOptions

The parameter options

Property Details

web 

web: Web

Property Value

Web

Inherited Property Details

credentials 

credentials: ServiceClientCredentials

Property Value

ServiceClientCredentials

Inherited From WebSearchClientContext.credentials

endpoint 

endpoint?: string

Property Value

string

Inherited From WebSearchClientContext.endpoint

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 WebSearchClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Send the provided httpRequest.

function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>

Parameters

options

RequestPrepareOptions | WebResourceLike

Returns

Promise<HttpOperationResponse>

Inherited From WebSearchClientContext.sendRequest