SearchStatus (Insight Engine)

This is for:

Developer

The SearchStatus controller lets you access search status information.

Example: search-status.fn.tsx

Methods

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

The state of the SearchStatus controller.

Properties

  • firstSearchExecuted: boolean

    Determines if a first search has been executed.

  • hasError: boolean

    true if there is an error for the last executed query and false otherwise.

  • hasResults: boolean

    Determines if there are results available for the last executed query.

  • isLoading: boolean

    Determines if a search is in progress.

Initialize

buildSearchStatus

Creates an insight SearchStatus controller instance.

Parameters

  • engine: InsightEngine

    The insight engine.

Returns SearchStatus

Unsubscribe

Call signatures

  • (): void;