Interface QuerySuggestActionCreators

The query suggest action creators.

interface QuerySuggestActionCreators {
    clearQuerySuggest(
        payload: ClearQuerySuggestActionCreatorPayload,
    ): { payload: ClearQuerySuggestActionCreatorPayload; type: string };
    fetchQuerySuggestions(
        payload: FetchQuerySuggestionsActionCreatorPayload,
    ): AsyncThunkAction<
        FetchQuerySuggestionsThunkReturn,
        FetchQuerySuggestionsActionCreatorPayload,
        AsyncThunkSearchOptions<StateNeededByQuerySuggest>,
    >;
    registerQuerySuggest(
        payload: RegisterQuerySuggestActionCreatorPayload,
    ): { payload: RegisterQuerySuggestActionCreatorPayload; type: string };
    selectQuerySuggestion(
        payload: SelectQuerySuggestionActionCreatorPayload,
    ): { payload: SelectQuerySuggestionActionCreatorPayload; type: string };
}

Index

Methods

clearQuerySuggest fetchQuerySuggestions registerQuerySuggest selectQuerySuggestion

Methods

clearQuerySuggest

clearQuerySuggest(
payload: ClearQuerySuggestActionCreatorPayload,
): { payload: ClearQuerySuggestActionCreatorPayload; type: string }
Clears the current partial basic query expression and the list of query suggestions in a specific query suggest entity.
Parameters
- payload: ClearQuerySuggestActionCreatorPayload
  The action creator payload.
Returns { payload: ClearQuerySuggestActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/query-suggest/query-suggest-actions-loader.d.ts:19

fetchQuerySuggestions

fetchQuerySuggestions(
    payload: FetchQuerySuggestionsActionCreatorPayload,
): AsyncThunkAction<
    FetchQuerySuggestionsThunkReturn,
    FetchQuerySuggestionsActionCreatorPayload,
    AsyncThunkSearchOptions<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,
    AsyncThunkSearchOptions<StateNeededByQuerySuggest>,
>
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/query-suggest/query-suggest-actions-loader.d.ts:26

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/dist/definitions/features/query-suggest/query-suggest-actions-loader.d.ts:33

selectQuerySuggestion

selectQuerySuggestion(
payload: SelectQuerySuggestionActionCreatorPayload,
): { payload: SelectQuerySuggestionActionCreatorPayload; type: string }
Selects a suggestion provided through a specific query suggest entity.
Parameters
- payload: SelectQuerySuggestionActionCreatorPayload
  The action creator payload.
Returns { payload: SelectQuerySuggestionActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/dist/definitions/features/query-suggest/query-suggest-actions-loader.d.ts:40

Interface QuerySuggestActionCreators

Index

Methods

Methods

clearQuerySuggest

Parameters

Returns { payload: ClearQuerySuggestActionCreatorPayload; type: string }

fetchQuerySuggestions

Parameters

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

registerQuerySuggest

Parameters

Returns { payload: RegisterQuerySuggestActionCreatorPayload; type: string }

selectQuerySuggestion

Parameters

Returns { payload: SelectQuerySuggestionActionCreatorPayload; type: string }

Settings

On This Page

Interface QuerySuggestActionCreators

Index

Methods

Methods

clearQuerySuggest

Parameters

Returns { payload: ClearQuerySuggestActionCreatorPayload; type: string }

fetchQuerySuggestions

Parameters

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

registerQuerySuggest

Parameters

Returns { payload: RegisterQuerySuggestActionCreatorPayload; type: string }

selectQuerySuggestion

Parameters

Returns { payload: SelectQuerySuggestionActionCreatorPayload; type: string }

Settings

On This Page

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