@sitecore/sc-contenthub-webclient-sdk
Version:
Sitecore Content Hub WebClient SDK.
29 lines (28 loc) • 1.57 kB
TypeScript
import { AllFacetValuesResponse } from "../models/search/all-facet-values-response";
import { AllFacetsRequest } from "../models/search/all-facets-request";
import { SearchRequest } from "../models/search/search-request";
import { SearchResponse } from "../models/search/search-response";
import { IExtendedContentHubClient } from "./extended-client";
import { CancelCallback } from "./internal-client";
export interface ISearchClient {
/**
* Send a {@link SearchRequest}.
* @param searchRequest - The search request
* @param cancelCallback - A {@link CancelCallback} that will be placed in an axios {@link CancelToken} if provided
* @returns The search response.
*/
searchAsync(searchRequest: SearchRequest, cancelCallback?: CancelCallback): Promise<SearchResponse>;
/**
* Send a {@link AllFacetsRequest}.
* @param allFacetsRequest - The all facets search request
* @param cancelCallback - A {@link CancelCallback} that will be placed in an axios {@link CancelToken} if provided
* @returns The search response.
*/
allFacetsAsync(allFacetsRequest: AllFacetsRequest, cancelCallback?: CancelCallback): Promise<AllFacetValuesResponse>;
}
export declare class SearchClient implements ISearchClient {
private readonly _client;
constructor(client: IExtendedContentHubClient);
searchAsync(searchRequest: SearchRequest, cancelCallback?: CancelCallback): Promise<SearchResponse>;
allFacetsAsync(allFacetsRequest: AllFacetsRequest, cancelCallback?: CancelCallback): Promise<AllFacetValuesResponse>;
}