Interface InsightSearchActionCreators

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

  • 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.

    const {logInterfaceLoad} = loadSearchAnalyticsActions(engine);
    const {executeSearch} = loadInsightSearchActions(engine);

    engine.dispatch(executeSearch({legacy: interfaceLoad()}))

  • 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.

  • 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.