Interface UmbSearchProvider<SearchResultItemType, SearchRequestArgsType>

interface UmbSearchProvider<SearchResultItemType, SearchRequestArgsType> {
destroy(): void;
search(args: SearchRequestArgsType): Promise<UmbRepositoryResponse<UmbPagedModel<SearchResultItemType>>>;
}

Type Parameters

SearchResultItemType extends UmbSearchResultItemModel = UmbSearchResultItemModel
SearchRequestArgsType extends UmbSearchRequestArgs = UmbSearchRequestArgs

Hierarchy (view full)

UmbApi
- UmbSearchProvider

Index

Methods

Methods

destroy

destroy(): void
Returns void
Inherited from UmbApi.destroy
- Defined in src/libs/extension-api/models/api.interface.ts:2

search

search(args): Promise<UmbRepositoryResponse<UmbPagedModel<SearchResultItemType>>>
Parameters
- args: SearchRequestArgsType
Returns Promise<UmbRepositoryResponse<UmbPagedModel<SearchResultItemType>>>
- Defined in src/packages/search/types.ts:21