Interface SearchListenerResponse

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();
Copy

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.

import type { SearchListenerResponse } from './my-shape-definition';
function openStream(response:SearchListenerResponse) {
     response.open();
}

openStream();
Copy

Respond to the search request with new or updated search results.

response.respond([
     { name: 'result-1' },
     { name: 'result-2' },
     { name: 'result-3' },
]);

Copy

Remove a search result from the list of responded search results.

response.revoke({ name: 'result-1' }, { name: 'result-2' });
Copy

Respond to the search request with new or updated search results context.