StandaloneSearchBoxSetActions (Deprecated)

This is for:

Developer

In this article

Loader Function
StandaloneSearchBoxSetActionCreators
Related types

Headless v1 has been deprecated. We recommend using the latest version of the Coveo Headless library.

The standalone search box set action creators.

See Dispatch Actions.

Loader Function

`loadStandaloneSearchBoxSetActions`

Loads the standaloneSearchBoxSet reducer and returns possible action creators.

Parameters

engine: SearchEngine

The headless engine.

Returns StandaloneSearchBoxSetActionCreators: The standalone search box set action creators.

StandaloneSearchBoxSetActionCreators

`fetchRedirectUrl`

Preprocesses the query for the current headless state, and retrieves a redirection URL if a redirect trigger was fired in the query pipeline.

Parameters

payload: FetchRedirectUrlActionCreatorPayload

The action creator payload.

Returns AsyncThunkAction<string, FetchRedirectUrlActionCreatorPayload, AsyncThunkSearchOptions<StateNeededForRedirect>>: A dispatchable action.

`registerStandaloneSearchBox`

Registers a standalone search box.

Parameters

payload: RegisterStandaloneSearchBoxActionCreatorPayload

The action creator payload.

Returns PayloadAction<RegisterStandaloneSearchBoxActionCreatorPayload>: A dispatchable action.

`resetStandaloneSearchBox`

Resets the standalone search box state. To be dispatched on single page applications after the redirection has been triggered.

Parameters

payload: ResetStandaloneSearchBoxActionCreatorPayload

The action creator payload.

Returns PayloadAction<ResetStandaloneSearchBoxActionCreatorPayload>: A dispatchable action.

`updateAnalyticsToOmniboxFromLink`

Updates the standalone search box analytics data to reflect a search submitted by selecting a query suggestion.

Parameters

payload: UpdateAnalyticsToOmniboxFromLinkActionCreatorPayload

The action creator payload.

Returns PayloadAction<UpdateAnalyticsToOmniboxFromLinkActionCreatorPayload>: A dispatchable action.

`updateAnalyticsToSearchFromLink`

Updates the standalone search box analytics data to reflect a search submitted using the search box.

Parameters

payload: UpdateAnalyticsToSearchFromLinkActionCreatorPayload

The action creator payload.

Returns PayloadAction<UpdateAnalyticsToSearchFromLinkActionCreatorPayload>: A dispatchable action.

`FetchRedirectUrlActionCreatorPayload`

Properties

id: string

The standalone search box id.

`RegisterStandaloneSearchBoxActionCreatorPayload`

Properties

id: string

The standalone search box id.
redirectionUrl: string

The default URL to which to redirect the user.

`ResetStandaloneSearchBoxActionCreatorPayload`

Properties

id: string

The standalone search box id.

`UpdateAnalyticsToOmniboxFromLinkActionCreatorPayload`

Properties

id: string

The standalone search box id.
metadata: OmniboxSuggestionMetadata

The metadata of the suggestion selected from the standalone search box.

`UpdateAnalyticsToSearchFromLinkActionCreatorPayload`

Properties

id: string

The standalone search box id.

Was this article useful?

Very useful

Not really