Interface DocumentSuggestionList

The DocumentSuggestion controller is responsible for getting document suggestions using case information present in the state.

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

interface DocumentSuggestionList {
    state: DocumentSuggestionListState;
    fetch(): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- DocumentSuggestionList

Index

Methods

fetch subscribe

Properties

Methods

fetch

fetch(): void
Fetches document suggestions using case information present in the state.

Returns void
- Defined in packages/headless/src/controllers/document-suggestion-list/headless-document-suggestion-list.ts:37

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

Properties

state

state: DocumentSuggestionListState

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