Extended Fin object with fin.Search namespace.
const searchTopic = fin.Search.create({ topic: "my search topic" });
An object that represents a unique OpenFin identity.
A listener called when a search result generated by this provider is dispatched.
searchTopic.dispatch("My Provider Name", searchResult, "My Action");
The order to sort scored search results in.
Search API object that is injected in the window.
A function that listens for search requests on a search topic. Returns a set of search results based on arguments provided.
The search request coming in
EXPERIMENTAL - streaming response
A generator that returns search responses from all providers that have currently responded.
More documentation on Javascript Generators can be found here.
A search result returned by a SearchProvider's onSearch listener function.
Called when a remote OpenFin identity, such as a view, attempts to connect to the search topic.
Returning false will reject said request.
const allowedHosts = ["www.company.com"];
searchTopic.onSubscription(identity => {
const info = await fin.View.wrapSync(identity).getInfo();
const url = new URL(info.url);
return allowedHosts.includes(url.host);
});
Create a topic. If the OpenFin identity creating the topic is running in a platform, the search topic will be sandboxed to the platform. In order to subscribe to a sandboxed search topic, the UUID of the platform must be specified explicitly or the subscribing OpenFin identity must be running in the platform.
Subscribe to an existing search topic.
Generated using TypeDoc
Each action is defined by its title and a hotkey