Denotes that this search request should return search results that represent content that a user has saved. (Workspaces, Pages)
Denotes that this search request should return search results that represent other Home search providers. If the user chooses to launch one of these apps, they should register a Home provider.
Denotes that this search request should return search results that represents content that is stored in the platform. This should exclude content that the user has saved. (Workspaces, Pages, Views, Apps)
Denotes that this Home search request was triggered via the user selecting a suggestion from this provider.
any user-selected filters will be populated here e.g [{ title: 'Currency Pairs', type: FilterOptionType.MultiSelect, options: [{ value: 'GBPUSD', isSelected: true}] }]
The ID of the search request. Can be used to tie related search requests together between providers.
The search query.
A list of search provider names to execute the search request against.
The ID of the topic the search request was dispatched on.
Registers a listener that is called when the search request is closed by the search requester.
Can be used to cleanup pending queries:
async function onUserInput(request) {
const myQuery = makeQuery(request.query);
request.onClose(() => {
myQuery.cancel();
});
const results = await myQuery.getResults();
return { results };
}
the listener to call when the request is closed.
Remove a registered listener.
function myListener(request, listener) {
// Do something
}
request.removeListener(myListener);
the listener to remove.
Generated using TypeDoc
Representation of a search request from a specific invocation of a HomeProvider's
onUserInputlistener function.