The client returned from subscribing as a secondary node to a search topic, which is managed by a primary node. Can be used to interact with a search topic.
Deregister a search provider by its name.
the name of the search provider to deregister
Disconnect from the search topic. NOTE: All search providers registered by this search client will be deregistered.
Dispatch a search result back to the search provider. It is then the search providers duty to perform what ever action was chosen.
the name of the search provider to send the search result back to.
the search result to send back to the search provider.
the action for the search provider to perform with the search result.
Obtain information about all search providers listening in on the topic.
Register a search provider.
the search provider to register.
Execute a search on the search topic.
The generator returned by this function can be called multiple times, returning the current list of search provider responses. As more search providers respond to the search request the returned list of responses will grow in length.
When all the search providers have responded to the search request, the generator will return the final
set of search response under the
value attribute and set the 'done' attribute set to true.
If no targets are included in request, will search against all search providers.
the request object that contains parameters to base the search on.
Generated using TypeDoc