Class IndexerService

Index

Constructors

Methods

getIndexer getIndexerByIndexName postIndexerByIndexNameRebuild

Constructors

constructor

new IndexerService(): IndexerService
Returns IndexerService

Methods

`Static`getIndexer

getIndexer<ThrowOnError extends boolean = true>(
    options?: Options<GetIndexerData, ThrowOnError>,
): RequestResult<
    GetIndexerResponses,
    GetIndexerErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of indexers.

Gets a collection of configured search indexers in the Umbraco installation.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetIndexerData, ThrowOnError>
Returns RequestResult<GetIndexerResponses, GetIndexerErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:2857

`Static`getIndexerByIndexName

getIndexerByIndexName<ThrowOnError extends boolean = true>(
    options: Options<GetIndexerByIndexNameData, ThrowOnError>,
): RequestResult<
    GetIndexerByIndexNameResponses,
    GetIndexerByIndexNameErrors,
    ThrowOnError,
    "fields",
>
Gets indexer details.

Gets detailed information about the indexer identified by the provided name.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetIndexerByIndexNameData, ThrowOnError>
Returns RequestResult<
    GetIndexerByIndexNameResponses,
    GetIndexerByIndexNameErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2875

`Static`postIndexerByIndexNameRebuild

postIndexerByIndexNameRebuild<ThrowOnError extends boolean = true>(
    options: Options<PostIndexerByIndexNameRebuildData, ThrowOnError>,
): RequestResult<
    PostIndexerByIndexNameRebuildResponses,
    PostIndexerByIndexNameRebuildErrors,
    ThrowOnError,
    "fields",
>
Rebuilds an indexer.

Rebuilds the search index for the indexer identified by the provided name.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostIndexerByIndexNameRebuildData, ThrowOnError>
Returns RequestResult<
    PostIndexerByIndexNameRebuildResponses,
    PostIndexerByIndexNameRebuildErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2893