Interface CaseInput

The CaseInput controller is responsible for setting and retrieving the value of a single 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 CaseInput {
    state: CaseInputState;
    subscribe(listener: () => void): Unsubscribe;
    update(value: string, updatesToFetch?: UpdateFetchOptions): void;
}

Hierarchy (View Summary)

Controller
- CaseInput

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?: UpdateFetchOptions): void
Sets the value of the specified field.
Parameters
- value: string
  The case input value to set.
- OptionalupdatesToFetch: UpdateFetchOptions
  A set of flags dictating whether to fetch case assist data after updating the input value.
Returns void
- Defined in packages/headless/src/controllers/case-input/headless-case-input.ts:69

Properties

state

state: CaseInputState

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

Interface CaseInput

Hierarchy (View Summary)

Index

Methods

Properties

Methods

subscribe

Parameters

Returns Unsubscribe

update

Parameters

Returns void

Properties

state

Settings

On This Page