A keycode that can be used to interact with this Search Provider.
A short description of the Search Provider.
A flag to indicate this provider will not be displayed as a command.
An icon that a UI can display for the Search Provider.
A unique ID used to identify the search provider.
The OpenFin identity that registered this search provider.
The placeholder string to be displayed in a UI when targeting this specific Search Provider.
A title to display above the result list in a UI when targeting this specific Search Provider.
Logo to show render when targeting this specific Search Provider.
The order to sort the score in. The default is ascending
.
A UI friendly title for the search provider.
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.)
import { getAvailableCommands } from './my-commands';
const onResultDispatch = async(result: CLIDispatchedSearchResult): Promise<void> => {
try {
//Grab the command corresponding to the result
const availableCommands = await getAvailableCommands();
const commandToExecute = availableCommands.find((command) => command.key === result.key);
if (commantToExecute != undefined) {
await commandToExecute.action();
}
} catch (err) {
//Handle the error
log.error('Error trying to action show command %s', err, result.key);
}
}
the search result with the action that was selected by the user.
Function that is called when a search request is triggered due to user input.
import { getAllData, getResultsByQuery } from './get-all-data';
const onUserInput = async({ query }): Promise<CLISearchResponse> => {
if (!query) {
return getAllData();
}
// Provide an implmentation to fetch query-filtered search results
return getResultsByQuery(query);
}
an object that contains the search results to render in the requesting Workspace component.
Generated using TypeDoc
A CLI provider responds to search requests from Home UI. Exposes search features that are specifically supported by Home.