• Public
  • Public/Protected
  • All

Interface CLIProvider

A CLI provider responds to search requests from Workspace components. Upon receiving a search request, a CLI provider can return search results that can be rendered and interacted with by a user by the requesting Workspace component.




Optional commandCode

commandCode?: string

A keycode that can be used to interact with this Search Provider.

Optional description

description?: string

A short description of the Search Provider.

Optional hidden

hidden?: boolean

A flag to indicate this provider will not be displayed as a command.


icon: string

An icon that a UI can display for the Search Provider.


id: string

A unique ID used to identify the search provider.

Optional identity

identity?: Identity

The OpenFin identity that registered this search provider.

Optional inputPlaceholder

inputPlaceholder?: string

The placeholder string to be displayed in a UI when targeting this specific Search Provider.

Optional listTitle

listTitle?: string

A title to display above the result list in a UI when targeting this specific Search Provider.

Optional logoUrl

logoUrl?: string

Logo to show render when targeting this specific Search Provider.

Optional scoreOrder

scoreOrder?: ScoreOrder

The order to sort the score in. The default is ascending.



title: string

A UI friendly title for the search provider.


Optional onResultDispatch

  • Callback that is invoked when ever a search result returned by this provider is interacted with from a Workspace component. (clicked, pressed enter, hotkey pressed, etc.)

    When this search provider returns search results via its onUserInput listener, the receiver of the results can select and dispatch a single result back to the provider.

    It is then up to the search provider to perform the custom requested action.


    Returns Promise<void>


  • Function that is called when a search request is triggered due to user input.

    When a search is requested on the subscribed search topic, this listener will be called and have the opportunity to return search results.


    Returns Promise<CLISearchResponse>

    an object that contains the search results to render in the requesting Workspace component.

Generated using TypeDoc