QuerySetActions

Coveo Relevance Cloud Developer Headless Product Documentation

The query set action creators.

See Dispatch Actions.

Loader Function

loadQuerySetActions

Loads the querySet reducer and returns possible action creators.

Parameters

  • engine: SearchEngine

    The headless engine.

Returns QuerySetActionCreators: The query set action creators.

QuerySetActionCreators

registerQuerySetQuery

Registers a query in the query set.

Parameters

Returns PayloadAction<RegisterQuerySetQueryActionCreatorPayload>: A dispatchable action.

updateQuerySetQuery

Updates a query in the query set.

Parameters

Returns PayloadAction<UpdateQuerySetQueryActionCreatorPayload>: A dispatchable action.

RegisterQuerySetQueryActionCreatorPayload

Properties

  • id: string

    The unique identifier of the target query.

  • query: string

    The initial basic query expression.

UpdateQuerySetQueryActionCreatorPayload

Properties

  • id: string

    The unique identifier of the target query.

  • query: string

    The new basic query expression.