Allows queries, preview requests, and activation requests to be sent to a scope.
More...
#include <unity/scopes/Scope.h>
|
virtual QueryCtrlProxy | search (std::string const &query_string, SearchMetadata const &metadata, SearchListenerBase::SPtr const &reply)=0 |
| Initiates a search query. More...
|
|
virtual QueryCtrlProxy | search (std::string const &query_string, FilterState const &filter_state, SearchMetadata const &metadata, SearchListenerBase::SPtr const &reply)=0 |
| Initiates a search query (overloaded method). More...
|
|
virtual QueryCtrlProxy | search (std::string const &query_string, std::string const &department_id, FilterState const &filter_state, SearchMetadata const &metadata, SearchListenerBase::SPtr const &reply)=0 |
| Initiates a search query (overloaded method). More...
|
|
virtual QueryCtrlProxy | activate (Result const &result, ActionMetadata const &metadata, ActivationListenerBase::SPtr const &reply)=0 |
| Initiates activation of a search result. More...
|
|
virtual QueryCtrlProxy | perform_action (Result const &result, ActionMetadata const &metadata, std::string const &widget_id, std::string const &action_id, ActivationListenerBase::SPtr const &reply)=0 |
| Initiates activation of a preview action. More...
|
|
virtual QueryCtrlProxy | preview (Result const &result, ActionMetadata const &metadata, PreviewListenerBase::SPtr const &reply)=0 |
| Initiates preview request. More...
|
|
virtual | ~Scope () |
| Destroys a Scope. More...
|
|
virtual std::string | endpoint ()=0 |
| Returns the endpoint this proxy connects to. More...
|
|
virtual std::string | identity ()=0 |
| Returns the identity of the target object of this proxy. More...
|
|
virtual std::string | category ()=0 |
| Returns the category of the target object of this proxy. More...
|
|
virtual int64_t | timeout ()=0 |
| Returns the timeout in milliseconds if this proxy is a twoway proxy. More...
|
|
virtual std::string | to_string ()=0 |
| converts a proxy into its string representation. More...
|
|
Allows queries, preview requests, and activation requests to be sent to a scope.
virtual unity::scopes::Scope::~Scope |
( |
| ) |
|
|
virtual |
Destroys a Scope.
Destroying a Scope has no effect on any query that might still be in progress.
Initiates activation of a search result.
- Parameters
-
result | activated result |
metadata | additional data to pass to scope |
reply | The callback object to receive replies |
- Returns
- A proxy that permits cancellation of this request
virtual QueryCtrlProxy unity::scopes::Scope::perform_action |
( |
Result const & |
result, |
|
|
ActionMetadata const & |
metadata, |
|
|
std::string const & |
widget_id, |
|
|
std::string const & |
action_id, |
|
|
ActivationListenerBase::SPtr const & |
reply |
|
) |
| |
|
pure virtual |
Initiates activation of a preview action.
- Parameters
-
result | Result that was previewed. |
metadata | additional data to pass to scope |
widget_id | identifier of 'actions' widget of activated action |
action_id | identifier of an action to activate |
reply | The callback object to receive replies |
- Returns
- A proxy that permits cancellation of this request
Initiates preview request.
- Parameters
-
result | Result to be previewed |
metadata | additional data to pass to scope |
reply | The callback object to receive replies |
- Returns
- A proxy that permits cancellation of this request
virtual QueryCtrlProxy unity::scopes::Scope::search |
( |
std::string const & |
query_string, |
|
|
SearchMetadata const & |
metadata, |
|
|
SearchListenerBase::SPtr const & |
reply |
|
) |
| |
|
pure virtual |
Initiates a search query.
The search() method expects a SearchListenerBase, which it uses to return the results for the query. search() may block for some time, for example, if the target scope is not running and needs to be started first. Results for the query may begin to arrive only after search() completes (but may also arrive while search() is still running).
- Parameters
-
query_string | search string |
metadata | additional data to pass to scope |
reply | The callback object to receive replies |
- Returns
- A proxy that permits cancellation of this request
virtual QueryCtrlProxy unity::scopes::Scope::search |
( |
std::string const & |
query_string, |
|
|
FilterState const & |
filter_state, |
|
|
SearchMetadata const & |
metadata, |
|
|
SearchListenerBase::SPtr const & |
reply |
|
) |
| |
|
pure virtual |
Initiates a search query (overloaded method).
This method has same synopsis as previous method, but it takes additional unity::scopes::FilterState argument.
- Parameters
-
query_string | search string |
filter_state | state of filters |
metadata | additional data to pass to scope |
reply | The callback object to receive replies |
- Returns
- A proxy that permits cancellation of this request
virtual QueryCtrlProxy unity::scopes::Scope::search |
( |
std::string const & |
query_string, |
|
|
std::string const & |
department_id, |
|
|
FilterState const & |
filter_state, |
|
|
SearchMetadata const & |
metadata, |
|
|
SearchListenerBase::SPtr const & |
reply |
|
) |
| |
|
pure virtual |
Initiates a search query (overloaded method).
This method has same synopsis as previous method, but it takes additional department identifier argument.
- Parameters
-
query_string | search string |
department_id | identifier of a department to search |
filter_state | state of filters |
metadata | additional data to pass to scope |
reply | The callback object to receive replies |
- Returns
- query handler
The documentation for this class was generated from the following file: