Interface InsightSearchActionCreators

See Dispatch actions.

interface InsightSearchActionCreators {
    executeSearch(
        analyticsSearchAction: InsightAction,
    ): AsyncThunkAction<
        ExecuteSearchThunkReturn,
        InsightAction,
        AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
    >;
    fetchFacetValues(
        analyticsSearchAction: InsightAction,
    ): AsyncThunkAction<
        ExecuteSearchThunkReturn,
        InsightAction,
        AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
    >;
    fetchMoreResults(): AsyncThunkAction<
        ExecuteSearchThunkReturn,
        void,
        AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
    >;
    fetchPage(
        analyticsSearchAction: InsightAction,
    ): AsyncThunkAction<
        ExecuteSearchThunkReturn,
        InsightAction,
        AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
    >;
    fetchQuerySuggestions(
        payload: FetchQuerySuggestionsActionCreatorPayload,
    ): AsyncThunkAction<
        FetchQuerySuggestionsThunkReturn,
        FetchQuerySuggestionsActionCreatorPayload,
        AsyncThunkInsightOptions<StateNeededByQuerySuggest>,
    >;
    registerQuerySuggest(
        payload: RegisterQuerySuggestActionCreatorPayload,
    ): { payload: RegisterQuerySuggestActionCreatorPayload; type: string };
}

Index

Methods

executeSearch fetchFacetValues fetchMoreResults fetchPage fetchQuerySuggestions registerQuerySuggest

Methods

executeSearch

executeSearch(
    analyticsSearchAction: InsightAction,
): AsyncThunkAction<
    ExecuteSearchThunkReturn,
    InsightAction,
    AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
>
Creates an action that executes a search query.
Parameters
- analyticsSearchAction: InsightAction
  The analytics action to log after a successful query. See loadSearchAnalyticsActions for possible values.
Returns AsyncThunkAction<
    ExecuteSearchThunkReturn,
    InsightAction,
    AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
>
A dispatchable action.
Example
```
const {logInterfaceLoad} = loadSearchAnalyticsActions(engine);
const {executeSearch} = loadInsightSearchActions(engine);
```
engine.dispatch(executeSearch({legacy: interfaceLoad()}))
- Defined in packages/headless/src/features/insight-search/insight-search-actions-loader.ts:45

fetchFacetValues

fetchFacetValues(
    analyticsSearchAction: InsightAction,
): AsyncThunkAction<
    ExecuteSearchThunkReturn,
    InsightAction,
    AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
>
Creates an action that only fetches facet values without affecting the rest of the state.
Parameters
- analyticsSearchAction: InsightAction
  The analytics action to log after a successful query. See loadSearchAnalyticsActions for possible values.
Returns AsyncThunkAction<
    ExecuteSearchThunkReturn,
    InsightAction,
    AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
>
A dispatchable action.
- Defined in packages/headless/src/features/insight-search/insight-search-actions-loader.ts:84

fetchMoreResults

fetchMoreResults(): AsyncThunkAction<
    ExecuteSearchThunkReturn,
    void,
    AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
>
Creates an action that fetches more results.

Returns AsyncThunkAction<
    ExecuteSearchThunkReturn,
    void,
    AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
>
A dispatchable action.
- Defined in packages/headless/src/features/insight-search/insight-search-actions-loader.ts:58

fetchPage

fetchPage(
    analyticsSearchAction: InsightAction,
): AsyncThunkAction<
    ExecuteSearchThunkReturn,
    InsightAction,
    AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
>
Creates an action that executes a search query to fetch a new page of results.
Parameters
- analyticsSearchAction: InsightAction
  The analytics action to log after a successful query. See loadSearchAnalyticsActions for possible values.
Returns AsyncThunkAction<
    ExecuteSearchThunkReturn,
    InsightAction,
    AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
>
A dispatchable action.
- Defined in packages/headless/src/features/insight-search/insight-search-actions-loader.ts:70

fetchQuerySuggestions

fetchQuerySuggestions(
    payload: FetchQuerySuggestionsActionCreatorPayload,
): AsyncThunkAction<
    FetchQuerySuggestionsThunkReturn,
    FetchQuerySuggestionsActionCreatorPayload,
    AsyncThunkInsightOptions<StateNeededByQuerySuggest>,
>
Fetches a list of query suggestions for a specific query suggest entity according to the current headless state.
Parameters
- payload: FetchQuerySuggestionsActionCreatorPayload
  The action creator payload.
Returns AsyncThunkAction<
    FetchQuerySuggestionsThunkReturn,
    FetchQuerySuggestionsActionCreatorPayload,
    AsyncThunkInsightOptions<StateNeededByQuerySuggest>,
>
A dispatchable action.
- Defined in packages/headless/src/features/insight-search/insight-search-actions-loader.ts:98

registerQuerySuggest

registerQuerySuggest(
payload: RegisterQuerySuggestActionCreatorPayload,
): { payload: RegisterQuerySuggestActionCreatorPayload; type: string }
Registers a new query suggest entity to the headless state to enable the Coveo ML query suggestions feature.
Parameters
- payload: RegisterQuerySuggestActionCreatorPayload
  The action creator payload.
Returns { payload: RegisterQuerySuggestActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/insight-search/insight-search-actions-loader.ts:112

Interface InsightSearchActionCreators

Index

Methods

Methods

executeSearch

Parameters

Returns AsyncThunkAction<
    ExecuteSearchThunkReturn,
    InsightAction,
    AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
>

Example

fetchFacetValues

Parameters

Returns AsyncThunkAction<
    ExecuteSearchThunkReturn,
    InsightAction,
    AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
>

fetchMoreResults

Returns AsyncThunkAction<
    ExecuteSearchThunkReturn,
    void,
    AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
>

fetchPage

Parameters

Returns AsyncThunkAction<
    ExecuteSearchThunkReturn,
    InsightAction,
    AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
>

fetchQuerySuggestions

Parameters

Returns AsyncThunkAction<
    FetchQuerySuggestionsThunkReturn,
    FetchQuerySuggestionsActionCreatorPayload,
    AsyncThunkInsightOptions<StateNeededByQuerySuggest>,
>

registerQuerySuggest

Parameters

Returns { payload: RegisterQuerySuggestActionCreatorPayload; type: string }

Settings

On This Page

Interface InsightSearchActionCreators

Index

Methods

Methods

executeSearch

Parameters

Returns AsyncThunkAction< ExecuteSearchThunkReturn, InsightAction, AsyncThunkInsightOptions<StateNeededByExecuteSearch>,>

Example

fetchFacetValues

Parameters

Returns AsyncThunkAction< ExecuteSearchThunkReturn, InsightAction, AsyncThunkInsightOptions<StateNeededByExecuteSearch>,>

fetchMoreResults

Returns AsyncThunkAction< ExecuteSearchThunkReturn, void, AsyncThunkInsightOptions<StateNeededByExecuteSearch>,>

fetchPage

Parameters

Returns AsyncThunkAction< ExecuteSearchThunkReturn, InsightAction, AsyncThunkInsightOptions<StateNeededByExecuteSearch>,>

fetchQuerySuggestions

Parameters

Returns AsyncThunkAction< FetchQuerySuggestionsThunkReturn, FetchQuerySuggestionsActionCreatorPayload, AsyncThunkInsightOptions<StateNeededByQuerySuggest>,>

registerQuerySuggest

Parameters

Returns { payload: RegisterQuerySuggestActionCreatorPayload; type: string }

Settings

On This Page

Returns AsyncThunkAction<
ExecuteSearchThunkReturn,
InsightAction,
AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
>

Returns AsyncThunkAction<
ExecuteSearchThunkReturn,
InsightAction,
AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
>

Returns AsyncThunkAction<
ExecuteSearchThunkReturn,
void,
AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
>

Returns AsyncThunkAction<
ExecuteSearchThunkReturn,
InsightAction,
AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
>

Returns AsyncThunkAction<
FetchQuerySuggestionsThunkReturn,
FetchQuerySuggestionsActionCreatorPayload,
AsyncThunkInsightOptions<StateNeededByQuerySuggest>,
>