DocumentSuggestionList (Deprecated)

This is for:

Developer
Warning

Headless v1 has been deprecated. We recommend using the latest version of the Coveo Headless library.

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

Methods

fetch

Fetches document suggestions using case information present in the state.

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 DocumentSuggestion controller.

Properties

  • documents: DocumentSuggestionResponse[]

    The retrieved document suggestions.

  • error: CaseAssistAPIErrorStatusResponse | null

    The Case Assist API error response.

  • loading: boolean

    Whether document suggestions are being retrieved.

Initialize

buildDocumentSuggestionList

Creates a Document Suggestion List controller instance.

Parameters

  • engine: CaseAssistEngine

    The headless engine.

Returns DocumentSuggestionList

DocumentSuggestionResponse

Properties

  • clickUri: string

  • excerpt: string

  • fields: Record<string, string | number | boolean | string[]>

  • hasHtmlVersion: boolean

  • title: string

  • uniqueId: string

Unsubscribe

Call signatures

  • (): void