Search

The Search API offers two distinct functionalities: you can use it to create both search providers and search clients. Search providers are apps that respond to search queries, whereas search clients are apps that initiate searches. For instance, a search provider may return a list of instruments as a response to a search query, and may also support one or more actions - like showing a chart for the selected instrument. Actions may be executed when the user clicks on a result in the UI of a search client app. You may present multiple actions as options to the user via the search client UI, so that they may choose how to handle the search result depending on their current needs. The Search API also enables you to define search types, set debounce time for search queries, set limits for search results and more.

io.Connect Desktop has a built-in search provider that returns search results for apps, Workspaces, Layouts, and actions.

Configuration

To disable the default search provider, or to modify the search types for which the default search provider will return results, use the "searchProvider" top-level key in the system.json system configuration file of io.Connect Desktop:

The following example demonstrates how to configure io.Connect Desktop to provide search results only for Workspaces and Layouts:

{
    "searchProvider": {
        "enabled": true,
        "types": ["workspace", "layout"]
    }
}

The "searchProvider" object has the following properties: