Interface CaseFieldActionCreators

The case field action creators.

See Dispatch actions.

interface CaseFieldActionCreators {
    fetchCaseClassifications(): AsyncThunkAction<
        FetchClassificationsThunkReturn,
        void,
        AsyncThunkCaseAssistOptions<StateNeededByFetchClassifications>,
    >;
    registerCaseField(
        payload: SetCaseFieldActionCreatorPayload,
    ): { payload: SetCaseFieldActionCreatorPayload; type: string };
    updateCaseField(
        payload: SetCaseFieldActionCreatorPayload,
    ): { payload: SetCaseFieldActionCreatorPayload; type: string };
}

Index

Methods

fetchCaseClassifications registerCaseField updateCaseField

Methods

fetchCaseClassifications

fetchCaseClassifications(): AsyncThunkAction<
    FetchClassificationsThunkReturn,
    void,
    AsyncThunkCaseAssistOptions<StateNeededByFetchClassifications>,
>
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.
- Defined in packages/headless/src/features/case-field/case-field-actions-loader.ts:50

registerCaseField

registerCaseField(
payload: SetCaseFieldActionCreatorPayload,
): { payload: SetCaseFieldActionCreatorPayload; type: string }
Registers a case field with the specified field and value.
Parameters
- payload: SetCaseFieldActionCreatorPayload
  The action creator payload.
Returns { payload: SetCaseFieldActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/case-field/case-field-actions-loader.ts:29

updateCaseField

updateCaseField(
payload: SetCaseFieldActionCreatorPayload,
): { payload: SetCaseFieldActionCreatorPayload; type: string }
Updates the specified case field with the provided value.
Parameters
- payload: SetCaseFieldActionCreatorPayload
  The action creator payload.
Returns { payload: SetCaseFieldActionCreatorPayload; type: string }
A dispatchable action.
- Defined in packages/headless/src/features/case-field/case-field-actions-loader.ts:39