Allows the results of a search query to be sent to the query source.
More...
#include <unity/scopes/SearchReply.h>
|
virtual void | register_departments (Department::SCPtr const &parent)=0 |
| Register departments for the current search reply and provide the current department. More...
|
|
virtual Category::SCPtr | register_category (std::string const &id, std::string const &title, std::string const &icon, CategoryRenderer const &renderer_template=CategoryRenderer())=0 |
| Register new category and send it to the source of the query. More...
|
|
virtual void | register_category (Category::SCPtr category)=0 |
| Register an existing category instance and send it to the source of the query. More...
|
|
virtual Category::SCPtr | lookup_category (std::string const &id)=0 |
| Returns a previously registered category. More...
|
|
virtual bool | push (CategorisedResult const &result)=0 |
| Sends a single result to the source of a query. More...
|
|
virtual bool | push (experimental::Annotation const &annotation)=0 |
| Push an annotation. More...
|
|
virtual bool | push (Filters const &filters, FilterState const &filter_state)=0 |
| Sends all filters and their state to the source of a query. More...
|
|
virtual | ~SearchReply () |
| Destroys a Reply. More...
|
|
virtual Category::SCPtr | register_category (std::string const &id, std::string const &title, std::string const &icon, CannedQuery const &query, CategoryRenderer const &renderer_template=CategoryRenderer())=0 |
| Register new category and send it to the source of the query. More...
|
|
virtual void | finished ()=0 |
| Informs the source of a query that the query results are complete. More...
|
|
virtual void | error (std::exception_ptr ex)=0 |
| Informs the source of a query that the query was terminated due to an error. More...
|
|
virtual void | info (OperationInfo const &op_info)=0 |
| Informs the source of a query that additional information regarding the reply is available. More...
|
|
virtual | ~Reply () |
| Destroys a Reply. 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 the results of a search query to be sent to the query source.
virtual unity::scopes::SearchReply::~SearchReply |
( |
| ) |
|
|
virtual |
virtual Category::SCPtr unity::scopes::SearchReply::lookup_category |
( |
std::string const & |
id | ) |
|
|
pure virtual |
Returns a previously registered category.
- Returns
- The category instance or
nullptr
if the category does not exist.
Sends a single result to the source of a query.
Any calls to push() after finished() was called are ignored.
- Returns
- The return value is true if the result was accepted, false otherwise. A false return value can be due to finished() having been called earlier, or the client that sent the query having cancelled that query. The return value is false also if the query has a cardinality limit and is reached or exceeded. (The return value is false for the last valid push and subsequent pushes.)
virtual bool unity::scopes::SearchReply::push |
( |
experimental::Annotation const & |
annotation | ) |
|
|
pure virtual |
Push an annotation.
The annotation will be rendered at a next available spot below the category of last pushed result. To render an annotation in the top annotation area, push it before pushing search results.
- Note
- The Unity shell can ignore some or all annotations, depending on available screen real estate.
virtual bool unity::scopes::SearchReply::push |
( |
Filters const & |
filters, |
|
|
FilterState const & |
filter_state |
|
) |
| |
|
pure virtual |
Sends all filters and their state to the source of a query.
- Returns
- True if the filters were accepted, false otherwise.
virtual Category::SCPtr unity::scopes::SearchReply::register_category |
( |
std::string const & |
id, |
|
|
std::string const & |
title, |
|
|
std::string const & |
icon, |
|
|
CategoryRenderer const & |
renderer_template = CategoryRenderer() |
|
) |
| |
|
pure virtual |
Register new category and send it to the source of the query.
- Parameters
-
id | The identifier of the category |
title | The title of the category |
icon | The icon of the category |
renderer_template | The renderer template to be used for results in this category |
- Returns
- The category instance
- Exceptions
-
unity::scopes::InvalidArgumentException | if category with that id has already been registered. |
virtual void unity::scopes::SearchReply::register_category |
( |
Category::SCPtr |
category | ) |
|
|
pure virtual |
Register an existing category instance and send it to the source of the query.
The purpose of this call is to register a category obtained via SearchListenerBase::push(Category::SCPtr const&) when aggregating results and categories from other scope(s).
- Exceptions
-
unity::InvalidArgumentException | if category is already registered. |
virtual Category::SCPtr unity::scopes::SearchReply::register_category |
( |
std::string const & |
id, |
|
|
std::string const & |
title, |
|
|
std::string const & |
icon, |
|
|
CannedQuery const & |
query, |
|
|
CategoryRenderer const & |
renderer_template = CategoryRenderer() |
|
) |
| |
|
pure virtual |
Register new category and send it to the source of the query.
- Parameters
-
id | The identifier of the category |
title | The title of the category |
icon | The icon of the category |
query | Query to perform when expanding this category |
renderer_template | The renderer template to be used for results in this category |
- Returns
- The category instance
- Exceptions
-
unity::scopes::InvalidArgumentException | if category with that id has already been registered. |
virtual void unity::scopes::SearchReply::register_departments |
( |
Department::SCPtr const & |
parent | ) |
|
|
pure virtual |
Register departments for the current search reply and provide the current department.
Departments are optional. If scope supports departments, it is expected to register departments on every search as follows:
For example, assuming the user is visiting a "History" department in "Books", and "History" has sub-departments such as "World War Two" and "Ancient", the code that registers departments for current search in "History" may look like this:
history->set_subdepartments(history_depts);
books->set_subdepartments({history});
reply->register_departments(books);
Current department should be the department returned by unity::scopes::CannedQuery::department_id(). Empty department id denotes the root deparment.
- Parameters
-
parent | The parent department of current department, or current one if visiting root department. |
- Exceptions
-
unity::LogicException | if departments are invalid (nullptr passed, current department not present in the parent's tree, duplicated department ids present in the tree). |
The documentation for this class was generated from the following file: