Interface SearchActionCreators

The search action creators.

interface SearchActionCreators {
    executeSearch(
        analyticsSearchAction: LegacySearchAction,
    ): AsyncThunkAction<
        ExecuteSearchThunkReturn,
        LegacySearchAction,
        AsyncThunkOptions<
            StateNeededByExecuteSearch,
            ClientThunkExtraArguments<SearchAPIClient, GeneratedAnswerAPIClient>,
        >,
    >;
    fetchFacetValues(
        analyticsSearchAction: LegacySearchAction,
    ): AsyncThunkAction<
        ExecuteSearchThunkReturn,
        LegacySearchAction,
        AsyncThunkOptions<
            StateNeededByExecuteSearch,
            ClientThunkExtraArguments<SearchAPIClient, GeneratedAnswerAPIClient>,
        >,
    >;
    fetchInstantResults(
        options: FetchInstantResultsActionCreatorPayload,
    ): AsyncThunkAction<
        FetchInstantResultsThunkReturn,
        FetchInstantResultsActionCreatorPayload,
        AsyncThunkSearchOptions<
            ConfigurationSection & Partial<
                QuerySection & AdvancedSearchQueriesSection & PaginationSection & SortSection & FacetSection & NumericFacetSection & CategoryFacetSection & DateFacetSection & ContextSection & DidYouMeanSection & FieldsSection & PipelineSection & SearchHubSection & QuerySetSection & FacetOptionsSection & FacetOrderSection & DebugSection & SearchSection & FoldingSection & TriggerSection,
            > & InstantResultSection,
        >,
    >;
    fetchMoreResults(): AsyncThunkAction<
        ExecuteSearchThunkReturn,
        void,
        AsyncThunkOptions<
            StateNeededByExecuteSearch,
            ClientThunkExtraArguments<SearchAPIClient, GeneratedAnswerAPIClient>,
        >,
    >;
    fetchPage(
        analyticsSearchAction: LegacySearchAction,
    ): AsyncThunkAction<
        ExecuteSearchThunkReturn,
        LegacySearchAction,
        AsyncThunkOptions<
            StateNeededByExecuteSearch,
            ClientThunkExtraArguments<SearchAPIClient, GeneratedAnswerAPIClient>,
        >,
    >;
}

Methods

executeSearch fetchFacetValues fetchInstantResults fetchMoreResults fetchPage

Methods

executeSearch

  • executeSearch(
        analyticsSearchAction: LegacySearchAction,
    ): AsyncThunkAction<
        ExecuteSearchThunkReturn,
        LegacySearchAction,
        AsyncThunkOptions<
            StateNeededByExecuteSearch,
            ClientThunkExtraArguments<SearchAPIClient, GeneratedAnswerAPIClient>,
        >,
    >

    Creates an action that executes a search query.

    Parameters

    • analyticsSearchAction: LegacySearchAction

      The analytics action to log after a successful query. See loadSearchAnalyticsActions for possible values.

    Returns AsyncThunkAction<
        ExecuteSearchThunkReturn,
        LegacySearchAction,
        AsyncThunkOptions<
            StateNeededByExecuteSearch,
            ClientThunkExtraArguments<SearchAPIClient, GeneratedAnswerAPIClient>,
        >,
    >

    A dispatchable action.

    Example

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

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

fetchFacetValues

  • fetchFacetValues(
        analyticsSearchAction: LegacySearchAction,
    ): AsyncThunkAction<
        ExecuteSearchThunkReturn,
        LegacySearchAction,
        AsyncThunkOptions<
            StateNeededByExecuteSearch,
            ClientThunkExtraArguments<SearchAPIClient, GeneratedAnswerAPIClient>,
        >,
    >

    Creates an action that only fetches facet values without affecting the rest of the state.

    Parameters

    • analyticsSearchAction: LegacySearchAction

      The analytics action to log after a successful query. See loadSearchAnalyticsActions for possible values.

    Returns AsyncThunkAction<
        ExecuteSearchThunkReturn,
        LegacySearchAction,
        AsyncThunkOptions<
            StateNeededByExecuteSearch,
            ClientThunkExtraArguments<SearchAPIClient, GeneratedAnswerAPIClient>,
        >,
    >

    A dispatchable action.

fetchInstantResults

  • fetchInstantResults(
        options: FetchInstantResultsActionCreatorPayload,
    ): AsyncThunkAction<
        FetchInstantResultsThunkReturn,
        FetchInstantResultsActionCreatorPayload,
        AsyncThunkSearchOptions<
            ConfigurationSection & Partial<
                QuerySection & AdvancedSearchQueriesSection & PaginationSection & SortSection & FacetSection & NumericFacetSection & CategoryFacetSection & DateFacetSection & ContextSection & DidYouMeanSection & FieldsSection & PipelineSection & SearchHubSection & QuerySetSection & FacetOptionsSection & FacetOrderSection & DebugSection & SearchSection & FoldingSection & TriggerSection,
            > & InstantResultSection,
        >,
    >

    Creates an action that fetches instant results.

    Parameters

    Returns AsyncThunkAction<
        FetchInstantResultsThunkReturn,
        FetchInstantResultsActionCreatorPayload,
        AsyncThunkSearchOptions<
            ConfigurationSection & Partial<
                QuerySection & AdvancedSearchQueriesSection & PaginationSection & SortSection & FacetSection & NumericFacetSection & CategoryFacetSection & DateFacetSection & ContextSection & DidYouMeanSection & FieldsSection & PipelineSection & SearchHubSection & QuerySetSection & FacetOptionsSection & FacetOrderSection & DebugSection & SearchSection & FoldingSection & TriggerSection,
            > & InstantResultSection,
        >,
    >

    A dispatchable action.

fetchMoreResults

  • fetchMoreResults(): AsyncThunkAction<
        ExecuteSearchThunkReturn,
        void,
        AsyncThunkOptions<
            StateNeededByExecuteSearch,
            ClientThunkExtraArguments<SearchAPIClient, GeneratedAnswerAPIClient>,
        >,
    >

    Creates an action that fetches more results.

    Returns AsyncThunkAction<
        ExecuteSearchThunkReturn,
        void,
        AsyncThunkOptions<
            StateNeededByExecuteSearch,
            ClientThunkExtraArguments<SearchAPIClient, GeneratedAnswerAPIClient>,
        >,
    >

    A dispatchable action.

fetchPage

  • fetchPage(
        analyticsSearchAction: LegacySearchAction,
    ): AsyncThunkAction<
        ExecuteSearchThunkReturn,
        LegacySearchAction,
        AsyncThunkOptions<
            StateNeededByExecuteSearch,
            ClientThunkExtraArguments<SearchAPIClient, GeneratedAnswerAPIClient>,
        >,
    >

    Creates an action that executes a search query to fetch a new page of results.

    Parameters

    • analyticsSearchAction: LegacySearchAction

      The analytics action to log after a successful query. See loadSearchAnalyticsActions for possible values.

    Returns AsyncThunkAction<
        ExecuteSearchThunkReturn,
        LegacySearchAction,
        AsyncThunkOptions<
            StateNeededByExecuteSearch,
            ClientThunkExtraArguments<SearchAPIClient, GeneratedAnswerAPIClient>,
        >,
    >

    A dispatchable action.

    Example

    const {logPagerNext} = loadSearchAnalyticsActions(engine);
    const {fetchPage} = loadSearchActions(engine);

    engine.dispatch(fetchPage(logPagerNext()));

Settings

Member Visibility

On This Page

Methods