Type alias HomeSearchListenerResponse

Representation of a search response from a specific invocation of a HomeProvider's onUserInput listener function. Can optionally be used to push search results to the Home UI.

Example

function onUserInput(req: HomeSearchListenerRequest, res: HomeSearchListenerResponse) {
   searchListenerResponse.open();

   const myLongRunningQuery = makeMyLongRunningQuery(searchListenerRequest.query);
   myLongRunningQuery.onNewResults(myNewResults => {
      searchListenerResponse.respond(myNewResults);
   });

   searchListenerRequest.onClose(() => {
      myLongRunningQuery.close();
   });

   // return any search results that are immediately available
   return quickQuery.getResults();
}
Copy