CaseInput

This is for:

Developer
Note

This component was introduced in version 1.48.1.

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.

Methods

update

Sets the value of the specified field.

Parameters

  • value: string

    The case input value to set.

  • updatesToFetch: UpdateFetchOptions

    A set of flags dictating whether to fetch case assist data after updating the input value.

subscribe

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.

Attributes

state

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

Properties

  • value: string

    The value of the case input.

Initialize

buildCaseInput

Creates a Case Input controller instance.

Parameters

  • engine: CaseAssistEngine

    The headless engine.

  • props: CaseInputProps

    The configurable CaseInput controller properties.

Returns CaseInput

CaseInputProps

The configurable CaseInput controller properties.

Properties

CaseInputOptions

Properties

  • field: string

Unsubscribe

Call signatures

  • (): void;

UpdateFetchOptions

Properties

  • caseClassifications?: boolean

  • documentSuggestions?: boolean