Close the response stream. This notifies the requester that the current search provider is done sending results.
import type { SearchListenerResponse } from './my-shape-definition';
function closeStream(request:SearchListenerRequest, response:SearchListenerResponse) {
response.close();
}
closeStream();
Open the response stream, notifying the search requester that there are new or updated search results that have yet to be pushed by the current provider.
Respond to the search request with new or updated search results.
response.respond([
{ name: 'result-1' },
{ name: 'result-2' },
{ name: 'result-3' },
]);
new or updated search results to respond with.
Remove a search result from the list of responded search results.
response.revoke({ name: 'result-1' }, { name: 'result-2' });
the keys of the search results to revoke.
Generated using TypeDoc
Representation of a search response from a specific invocation of a SearchProvider's
onUserInput
listener function. Can optionally be used to push search results to the requester.