THIS IS ARCHIVED DOCUMENTATION

StandaloneSearchBoxSetActions (Deprecated)

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

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

registerStandaloneSearchBox

Registers a standalone search box.

Parameters

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

Returns PayloadAction<ResetStandaloneSearchBoxActionCreatorPayload>: A dispatchable action.

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

Parameters

Returns PayloadAction<UpdateAnalyticsToOmniboxFromLinkActionCreatorPayload>: A dispatchable action.

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

Parameters

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.