SearchEndpointV2 | @dasch-swiss/dsp-js API Documentation

Handles requests to the search route of the Knora API.

Hierarchy

Endpoint
- SearchEndpointV2

Index

Constructors

constructor

Properties

Accessors

jsonWebToken

Methods

Constructors

constructor

new SearchEndpointV2(knoraApiConfig: KnoraApiConfig, path: string, v2Endpoint: V2Endpoint): SearchEndpointV2

Overrides Endpoint.constructor
- Defined in src/api/v2/search/search-endpoint-v2.ts:22
Parameters
- knoraApiConfig: KnoraApiConfig
- path: string
- v2Endpoint: V2Endpoint
Returns SearchEndpointV2

Properties

jsonConvert

jsonConvert: JsonConvert = new JsonConvert(OperationMode.ENABLE,ValueCheckingMode.DISALLOW_NULL,false,PropertyMatchingRule.CASE_STRICT)

JsonConvert instance

Protected knoraApiConfig

knoraApiConfig: KnoraApiConfig

Protected path

path: string

Accessors

jsonWebToken

get jsonWebToken(): string
set jsonWebToken(value: string): void

Inherited from Endpoint.jsonWebToken
- Defined in src/api/endpoint.ts:41
The session token

Returns string
Inherited from Endpoint.jsonWebToken
- Defined in src/api/endpoint.ts:48
The session token

Parameters
- value: string
Returns void

Methods

doExtendedSearch

doExtendedSearch(gravsearchQuery: string): Observable<ReadResourceSequence | ApiResponseError>

- Defined in src/api/v2/search/search-endpoint-v2.ts:140
Performs a Gravsearch query.

Parameters
- gravsearchQuery: string
  
  the given Gravsearch query.
Returns Observable<ReadResourceSequence | ApiResponseError>

doExtendedSearchCountQuery

doExtendedSearchCountQuery(gravsearchQuery: string): Observable<CountQueryResponse | ApiResponseError>

- Defined in src/api/v2/search/search-endpoint-v2.ts:166
Performs a Gravsearch count query.

Parameters
- gravsearchQuery: string
  
  the given Gravsearch query.
Returns Observable<CountQueryResponse | ApiResponseError>

doFulltextSearch

doFulltextSearch(searchTerm: string, offset?: number, params?: IFulltextSearchParams): Observable<ReadResourceSequence | ApiResponseError>

- Defined in src/api/v2/search/search-endpoint-v2.ts:90
Performs a fulltext search.

Parameters
- searchTerm: string
  
  the term to search for.
- Default value offset: number = 0
  
  offset to be used for paging, zero-based.
- Optional params: IFulltextSearchParams
  
  parameters for fulltext search, if any.
Returns Observable<ReadResourceSequence | ApiResponseError>

doFulltextSearchCountQuery

doFulltextSearchCountQuery(searchTerm: string, offset?: number, params?: IFulltextSearchParams): Observable<CountQueryResponse | ApiResponseError>

- Defined in src/api/v2/search/search-endpoint-v2.ts:116
Performs a fulltext search count query.

Parameters
- searchTerm: string
  
  the term to search for.
- Default value offset: number = 0
  
  offset to be used for paging, zero-based.
- Optional params: IFulltextSearchParams
  
  parameters for fulltext search, if any.
Returns Observable<CountQueryResponse | ApiResponseError>

doSearchByLabel

doSearchByLabel(searchTerm: string, offset?: number, params?: ILabelSearchParams): Observable<ReadResourceSequence | ApiResponseError>

- Defined in src/api/v2/search/search-endpoint-v2.ts:192
Performs a search by label.

Parameters
- searchTerm: string
  
  the label to search for.
- Default value offset: number = 0
  
  offset to be used for paging, zero-based.
- Optional params: ILabelSearchParams
  
  parameters for fulltext search, if any.
Returns Observable<ReadResourceSequence | ApiResponseError>

Protected handleError

handleError(error: AjaxError | DataError): Observable<ApiResponseError>

Inherited from Endpoint.handleError
- Defined in src/api/endpoint.ts:150
Handles parsing errors.

Parameters
- error: AjaxError | DataError
  
  the error class provided by us
Returns Observable<ApiResponseError>

Protected httpDelete

httpDelete(path?: undefined | string): Observable<AjaxResponse>

Inherited from Endpoint.httpDelete
- Defined in src/api/endpoint.ts:138
Performs a general PUT request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
Returns Observable<AjaxResponse>

Protected httpGet

httpGet(path?: undefined | string): Observable<AjaxResponse>

Inherited from Endpoint.httpGet
- Defined in src/api/endpoint.ts:80
Performs a general GET request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
Returns Observable<AjaxResponse>

Protected httpPatch

httpPatch(path?: undefined | string, body?: any, contentType?: "json"): Observable<AjaxResponse>

Inherited from Endpoint.httpPatch
- Defined in src/api/endpoint.ts:125
Performs a general PATCH request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
- Optional body: any
  
  the body of the request
- Default value contentType: "json" = "json"
  
  content content type of body, if any.
Returns Observable<AjaxResponse>

Protected httpPost

httpPost(path?: undefined | string, body?: any, contentType?: "json" | "sparql"): Observable<AjaxResponse>

Inherited from Endpoint.httpPost
- Defined in src/api/endpoint.ts:95
Performs a general POST request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
- Optional body: any
  
  the body of the request, if any.
- Default value contentType: "json" | "sparql" = "json"
  
  content content type of body, if any.
Returns Observable<AjaxResponse>

Protected httpPut

httpPut(path?: undefined | string, body?: any, contentType?: "json"): Observable<AjaxResponse>

Inherited from Endpoint.httpPut
- Defined in src/api/endpoint.ts:110
Performs a general PUT request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
- Optional body: any
  
  the body of the request
- Default value contentType: "json" = "json"
  
  content content type of body, if any.
Returns Observable<AjaxResponse>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

knoraApiConfig: KnoraApiConfig

path: string

v2Endpoint: V2Endpoint

Returns SearchEndpointV2

Properties

jsonConvert

Protected knoraApiConfig

Protected path

Accessors

jsonWebToken

Returns string

Parameters

value: string

Returns void

Methods

doExtendedSearch

Parameters

gravsearchQuery: string

Returns Observable<ReadResourceSequence | ApiResponseError>

doExtendedSearchCountQuery

Parameters

gravsearchQuery: string

Returns Observable<CountQueryResponse | ApiResponseError>

doFulltextSearch

Parameters

searchTerm: string

Default value offset: number = 0

Optional params: IFulltextSearchParams

Returns Observable<ReadResourceSequence | ApiResponseError>

doFulltextSearchCountQuery

Parameters

searchTerm: string

Default value offset: number = 0

Optional params: IFulltextSearchParams

Returns Observable<CountQueryResponse | ApiResponseError>

doSearchByLabel

Parameters

searchTerm: string

Default value offset: number = 0

Optional params: ILabelSearchParams

Returns Observable<ReadResourceSequence | ApiResponseError>

Protected handleError

Parameters

error: AjaxError | DataError

Returns Observable<ApiResponseError>

Protected httpDelete

Parameters

Optional path: undefined | string

Returns Observable<AjaxResponse>

Protected httpGet

Parameters

Optional path: undefined | string

Returns Observable<AjaxResponse>

Protected httpPatch

Parameters

Optional path: undefined | string

Optional body: any

Default value contentType: "json" = "json"

Returns Observable<AjaxResponse>

Protected httpPost

Parameters

Optional path: undefined | string

Optional body: any

Default value contentType: "json" | "sparql" = "json"

Returns Observable<AjaxResponse>

Protected httpPut

Parameters

Optional path: undefined | string

Optional body: any

Default value contentType: "json" = "json"

Returns Observable<AjaxResponse>