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 };
}

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()}))

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.

fetchMoreResults

  • fetchMoreResults(): AsyncThunkAction<
        ExecuteSearchThunkReturn,
        void,
        AsyncThunkInsightOptions<StateNeededByExecuteSearch>,
    >

  • Creates an action that fetches more results.

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

    A dispatchable action.

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.

fetchQuerySuggestions

registerQuerySuggest

Settings

Member Visibility

On This Page

Methods