CaseFieldActions (Deprecated)

This is for:

Developer
Warning

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

The case field action creators.

See Dispatch Actions.

Loader Function

loadCaseFieldActions

Loads the case fields reducer and returns possible action creators.

Parameters

  • engine: CaseAssistEngine

    The headless engine.

Returns CaseFieldActionCreators: The case field action creators.

CaseFieldActionCreators

fetchCaseClassifications

Retrieves the case classifications from the platform. A single call retrieves classifications for all fields specified in the Case Assist configuration. Case classifications are retrieved based on the case information entered so far.

Returns AsyncThunkAction<FetchClassificationsThunkReturn, void, AsyncThunkCaseAssistOptions<StateNeededByFetchClassifications>>: A dispatchable action.

registerCaseField

Registers a case field with the specified field and value.

Parameters

Returns PayloadAction<SetCaseFieldActionCreatorPayload>: A dispatchable action.

updateCaseField

Updates the specified case field with the provided value.

Parameters

Returns PayloadAction<SetCaseFieldActionCreatorPayload>: A dispatchable action.

SetCaseFieldActionCreatorPayload

Properties

  • fieldName: string

    The name of the field whose value is being updated (for example, product, category, model)

  • fieldValue: string

    The value to set in the state.