THIS IS ARCHIVED DOCUMENTATION

SearchConfigurationActions (Deprecated)

The search configuration action creators.

Loader Function

loadSearchConfigurationActions

Loads the necessary reducers and returns possible action creators.

Parameters

  • engine: SearchEngine

    The headless engine.

Returns SearchConfigurationActionCreators: The search configuration action creators.

SearchConfigurationActionCreators

updateSearchConfiguration

Updates the search configuration.

Parameters

Returns PayloadAction<UpdateSearchConfigurationActionCreatorPayload>: A dispatchable action.

UpdateSearchConfigurationActionCreatorPayload

Properties

  • apiBaseUrl?: string

    The Search API base URL to use (for example, https://platform.cloud.coveo.com/rest/search/v2).

  • locale?: string

    The locale of the current user. Must comply with IETF’s BCP 47 definition: https://www.rfc-editor.org/rfc/bcp/bcp47.txt.

  • pipeline?: string

    The name of the query pipeline to use for the query (for example, External Search).

  • searchHub?: string

    The first level of origin of the request, typically the identifier of the graphical search interface from which the request originates (for example, ExternalSearch).

Associated Engines

The SearchConfiguration actions are available in the following engine: