CustomSearchClient class

Package:

@azure/cognitiveservices-customsearch

Extends

CustomSearchClientContext

Constructors

CustomSearchClient(ServiceClientCredentials, CustomSearchClientOptions)

Initializes a new instance of the CustomSearchClient class.

Properties

customInstance

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

CustomSearchClient(ServiceClientCredentials, CustomSearchClientOptions)

Initializes a new instance of the CustomSearchClient class.

new CustomSearchClient(credentials: ServiceClientCredentials, options?: CustomSearchClientOptions)

Parameters

credentials

ServiceClientCredentials

Subscription credentials which uniquely identify client subscription.

options

CustomSearchClientOptions

The parameter options

Property Details

customInstance

customInstance: CustomInstance

Property Value

CustomInstance

Inherited Property Details

credentials

credentials: ServiceClientCredentials

Property Value

ServiceClientCredentials

Inherited From CustomSearchClientContext.credentials

endpoint

endpoint?: string

Property Value

string

Inherited From CustomSearchClientContext.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 CustomSearchClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Send the provided httpRequest.

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

Parameters

options

RequestPrepareOptions | WebResourceLike

Returns

Promise<HttpOperationResponse>

Inherited From CustomSearchClientContext.sendRequest