Interface CaseField

The CaseField controller is responsible for setting the value and retrieving suggestions for a field from the case creation form and optionally trigger Case Assist API requests.

For example implementations, see the following Coveo Quantic Case Assist components:

interface CaseField {
    state: CaseFieldState;
    subscribe(listener: () => void): Unsubscribe;
    update(
        value: string,
        updatesToFetch?: UpdateCaseFieldFetchOptions,
        autoSelection?: boolean,
    ): void;
}

Hierarchy (View Summary)

Controller
- CaseField

Index

Methods

subscribe update

Properties

state

Methods

subscribe(listener: () => void): Unsubscribe
Adds a callback that's invoked on state change.
Parameters
- listener: () => void
  A callback that's invoked on state change.
Returns Unsubscribe
A function to remove the listener.
Inherited from Controller.subscribe
- Defined in packages/headless/src/controllers/controller/headless-controller.ts:11

update

update(
    value: string,
    updatesToFetch?: UpdateCaseFieldFetchOptions,
    autoSelection?: boolean,
): void
Sets the value of the specified field.
Parameters
- value: string
  The field value to set.
- OptionalupdatesToFetch: UpdateCaseFieldFetchOptions
  A set of flags dictating whether to fetch case assist data after updating the field value.
- OptionalautoSelection: boolean
  A flag indicating whether the update was triggered by an automatic selection.
Returns void
- Defined in packages/headless/src/controllers/case-field/headless-case-field.ts:93

Properties

state

state: CaseFieldState

A scoped and simplified part of the headless state that is relevant to the CaseField controller.

Interface CaseField

Hierarchy (View Summary)

Index

Methods

Properties

Methods

subscribe

Parameters

Returns Unsubscribe

update

Parameters

Returns void

Properties

state

Settings

On This Page