unity.scopes.Scope
Allows queries, preview requests, and activation requests to be sent to a scope.
More...
#include <unity/scopes/Scope.h>
Inheritance diagram for unity::scopes::Scope:
![]()
src="https://assets.ubuntu.com/v1/70caa136-classunity_1_1scopes_1_1_scope__inherit__graph.png" border="0" alt="Inheritance graph"/>
|
| 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 ChildScopeList | child_scopes ()=0 |
| | Returns a list of child scopes aggregated by this scope. More...
|
| |
| virtual bool | set_child_scopes (ChildScopeList const &child_scopes)=0 |
| | Sets the list of child scopes aggregated by this scope. More...
|
| |
| virtual QueryCtrlProxy | search (std::string const &query_string, std::string const &department_id, FilterState const &filter_state, Variant const &user_data, SearchMetadata const &metadata, SearchListenerBase::SPtr const &reply)=0 |
| | Initiates a search query (overloaded method). More...
|
| |
| virtual QueryCtrlProxy | activate_result_action (Result const &result, ActionMetadata const &metadata, std::string const &action_id, ActivationListenerBase::SPtr const &reply)=0 |
| | Initiates activation of a result (in-card) action. 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 | target_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 | The result that was activated. |
| metadata | Additional data to pass to the scope. |
| reply | The callback object to receive replies |
- Returns
- A proxy that permits cancellation of this request.
| virtual QueryCtrlProxy unity::scopes::Scope::activate_result_action |
( |
Result const & |
result, |
|
|
ActionMetadata const & |
metadata, |
|
|
std::string const & |
action_id, |
|
|
ActivationListenerBase::SPtr const & |
reply |
|
) |
| |
|
pure virtual |
Initiates activation of a result (in-card) action.
- Parameters
-
| result | The result that was was activated. |
| metadata | Additional data to pass to the scope. |
| action_id | The identifier of the action. |
| reply | The callback object to receive replies |
- Returns
- A proxy that permits cancellation of this request.
Returns a list of child scopes aggregated by this scope.
- Returns
- The list of child scopes aggregated by this scope.
| 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 | The result that was previewed. |
| metadata | Additional data to pass to the scope. |
| widget_id | The identifier of the 'actions' widget of the activated action. |
| action_id | The 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 | The result to be previewed. |
| metadata | Additional data to pass to the 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 | The search string. |
| metadata | Additional data to pass to the 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 | The search string. |
| filter_state | The state of filters. |
| metadata | Additional data to pass to the 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 | The search string. |
| department_id | The identifier of a department to search. |
| filter_state | The state of filters. |
| metadata | Additional data to pass to the 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, |
|
|
Variant const & |
user_data, |
|
|
SearchMetadata const & |
metadata, |
|
|
SearchListenerBase::SPtr const & |
reply |
|
) |
| |
|
pure virtual |
Initiates a search query (overloaded method).
This method has same synopsis as previous search method, but it takes additional user_data argument.
- Parameters
-
| query_string | The search string. |
| department_id | The identifier of a department to search. |
| filter_state | The state of filters. |
| user_data | Arbitrary data. |
| metadata | Additional data to pass to the scope. |
| reply | The callback object to receive replies |
- Returns
- A proxy that permits cancellation of this request.
| virtual bool unity::scopes::Scope::set_child_scopes |
( |
ChildScopeList const & |
child_scopes | ) |
|
|
pure virtual |
Sets the list of child scopes aggregated by this scope.
- Note
- The only time this call will return false is if the scope cannot write to its config directory. This should not happen in real-world usage, but if it does, check the log for more detail.
- Parameters
-
| child_scopes | The list of child scopes aggregated by this scope. |
- Returns
- True if the list was successfully set.
Ubuntu Phone documentation