@dasch-swiss/dsp-js
Version:
JavaScript library that handles API requests to Knora
101 lines (100 loc) • 4.59 kB
TypeScript
import { IFulltextSearchParams } from "../../../interfaces/models/v2/i-fulltext-search-params";
import { ILabelSearchParams } from "../../../interfaces/models/v2/i-label-search-params";
import { KnoraApiConfig } from "../../../knora-api-config";
import { Endpoint } from "../../endpoint";
import { V2Endpoint } from "../v2-endpoint";
/**
* Handles requests to the search route of the Knora API.
*
* @category Endpoint V2
*/
export declare class SearchEndpointV2 extends Endpoint {
protected readonly knoraApiConfig: KnoraApiConfig;
protected readonly path: string;
private readonly v2Endpoint;
constructor(knoraApiConfig: KnoraApiConfig, path: string, v2Endpoint: V2Endpoint);
/**
* URL encodes fulltext search params.
*
* @param offset offset to be used for paging, zero-based.
* @param params parameters for fulltext search.
*/
private static encodeFulltextParams;
/**
* URL encodes search by label params.
*
* @param offset offset to be used for paging, zero-based.
* @param params parameters for search by label.
*/
private static encodeLabelParams;
/**
* Performs a fulltext search.
*
* @param searchTerm the term to search for.
* @param offset offset to be used for paging, zero-based.
* @param params parameters for fulltext search, if any.
*/
doFulltextSearch(searchTerm: string, offset?: number, params?: IFulltextSearchParams): import("rxjs").Observable<import("../../..").ReadResourceSequence>;
/**
* Performs a fulltext search count query.
*
* @param searchTerm the term to search for.
* @param offset offset to be used for paging, zero-based.
* @param params parameters for fulltext search, if any.
*/
doFulltextSearchCountQuery(searchTerm: string, offset?: number, params?: IFulltextSearchParams): import("rxjs").Observable<import("../../..").CountQueryResponse>;
/**
* Performs a Gravsearch query.
*
* @param gravsearchQuery the given Gravsearch query.
*/
doExtendedSearch(gravsearchQuery: string): import("rxjs").Observable<import("../../..").ReadResourceSequence>;
/**
* Performs a Gravsearch count query.
*
* @param gravsearchQuery the given Gravsearch query.
*/
doExtendedSearchCountQuery(gravsearchQuery: string): import("rxjs").Observable<import("../../..").CountQueryResponse>;
/**
* Performs a Gravsearch in order to get incoming links of queried resource
*
* @param resourceIri resource that is queried for incoming links
* @param offset the offset to be used for paging
*/
doSearchIncomingLinks(resourceIri: string, offset?: number): import("rxjs").Observable<import("../../..").ReadResourceSequence>;
/**
* Performs a Gravsearch in order to get StillImageRepresentations of queried resource
*
* @param resourceIri resource that is queried for incoming links
* @param offset the offset to be used for paging
*/
doSearchStillImageRepresentations(resourceIri: string, offset?: number): import("rxjs").Observable<import("../../..").ReadResourceSequence>;
/**
* Performs a Gravsearch in order to get StillImageRepresentations count of queried resource
*
* @param resourceIri resource that is queried for incoming links
*/
doSearchStillImageRepresentationsCount(resourceIri: string): import("rxjs").Observable<import("../../..").CountQueryResponse>;
/**
* Performs a Gravsearch to get incoming regions of queried resource
*
* @param resourceIri resource that is queried for incoming links
* @param offset the offset to be used for paging
*/
doSearchIncomingRegions(resourceIri: string, offset?: number): import("rxjs").Observable<import("../../..").ReadResourceSequence>;
/**
* Performs a search by label.
*
* @param searchTerm the label to search for.
* @param offset offset to be used for paging, zero-based.
* @param params parameters for fulltext search, if any.
*/
doSearchByLabel(searchTerm: string, offset?: number, params?: ILabelSearchParams): import("rxjs").Observable<import("../../..").ReadResourceSequence>;
/**
* Performs a query to get the count of results when performing a search by label.
*
* @param searchTerm the label to search for.
* @param params parameters for fulltext search, if any.
*/
doSearchByLabelCountQuery(searchTerm: string, params?: ILabelSearchParams): import("rxjs").Observable<import("../../..").CountQueryResponse>;
}