Class SearcherService

Index

Constructors

Methods

getSearcher getSearcherBySearcherNameQuery

Constructors

constructor

new SearcherService(): SearcherService
Returns SearcherService

Methods

`Static`getSearcher

getSearcher<ThrowOnError extends boolean = true>(
    options?: Options<GetSearcherData, ThrowOnError, unknown>,
): RequestResult<
    GetSearcherResponses,
    GetSearcherErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of searchers.

Gets a collection of configured searchers in the Umbraco installation.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetSearcherData, ThrowOnError, unknown>
Returns RequestResult<GetSearcherResponses, GetSearcherErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:5617

`Static`getSearcherBySearcherNameQuery

getSearcherBySearcherNameQuery<ThrowOnError extends boolean = true>(
    options: Options<GetSearcherBySearcherNameQueryData, ThrowOnError>,
): RequestResult<
    GetSearcherBySearcherNameQueryResponses,
    GetSearcherBySearcherNameQueryErrors,
    ThrowOnError,
    "fields",
>
Queries a searcher.

Queries a named searcher with the provided search term and returns a paginated collection of search results.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetSearcherBySearcherNameQueryData, ThrowOnError>
Returns RequestResult<
    GetSearcherBySearcherNameQueryResponses,
    GetSearcherBySearcherNameQueryErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5630