RecommendationActions (Deprecated)

This is for:

Developer
Warning

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

The recommendation action creators.

See Dispatch Actions.

Loader Function

loadRecommendationActions

Loads the recommendation reducer and returns possible action creators.

Parameters

  • engine: RecommendationEngine

    The headless engine.

Returns RecommendationActionCreators: The recommendation action creators.

RecommendationActionCreators

getRecommendations

Refreshes the recommendations.

Returns AsyncThunkAction<GetRecommendationsThunkReturn, void, AsyncThunkSearchOptions<StateNeededByGetRecommendations>>: A dispatchable action.

setRecommendationId

Updates the recommendation identifier.

Parameters

Returns PayloadAction<SetRecommendationIdActionCreatorPayload>: A dispatchable action.

SetRecommendationIdActionCreatorPayload

Properties

  • id: string

    The recommendation identifier.