Ubuntu Phone documentation
unity.scopes.SearchMetadata
Metadata passed with search requests. More...
#include <unity/scopes/SearchMetadata.h>
Inheritance diagram for unity::scopes::SearchMetadata:
src="https://assets.ubuntu.com/v1/1b1b2ca3-classunity_1_1scopes_1_1_search_metadata__inherit__graph.png" border="0" alt="Inheritance graph"/>
Public Member Functions | |
| SearchMetadata (std::string const &locale, std::string const &form_factor) | |
| Create SearchMetadata with the given locale and form factor. More... | |
| SearchMetadata (int cardinality, std::string const &locale, std::string const &form_factor) | |
| Create SearchMetadata with the given cardinality, locale, and form factor. More... | |
| void | set_cardinality (int cardinality) |
| Set cardinality. More... | |
| int | cardinality () const |
| Get cardinality. More... | |
| void | set_location (Location const &location) |
| Set location. More... | |
| Location | location () const |
| Get location. More... | |
| bool | has_location () const |
| Does the SearchMetadata have a location. More... | |
| void | remove_location () |
| Remove location data entirely. More... | |
| void | set_aggregated_keywords (std::set< std::string > const &aggregated_keywords) |
| Set the list of scope keywords used to initiate this search request. More... | |
| std::set< std::string > | aggregated_keywords () const |
| Get the list of scope keywords used to initiate this search request. More... | |
| bool | is_aggregated () const |
| Check if this search request originated from an aggregator scope. More... | |
| void | set_hint (std::string const &key, Variant const &value) |
| Sets a hint. More... | |
| VariantMap | hints () const |
| Get all hints. More... | |
| bool | contains_hint (std::string const &key) const |
| Check if this SearchMetadata has a hint. More... | |
| Variant & | operator[] (std::string const &key) |
| Returns a reference to a hint. More... | |
| Variant const & | operator[] (std::string const &key) const |
| Returns a const reference to a hint. More... | |
| Copy and assignment | |
Copy and assignment operators (move and non-move versions) have the usual value semantics. | |
| SearchMetadata (SearchMetadata const &other) | |
| SearchMetadata (SearchMetadata &&) | |
| SearchMetadata & | operator= (SearchMetadata const &other) |
| SearchMetadata & | operator= (SearchMetadata &&) |
| std::string | locale () const |
| Get the locale string. More... | |
| std::string | form_factor () const |
| Get the form factor string. More... | |
| void | set_internet_connectivity (ConnectivityStatus connectivity_status) |
| Set internet connectivity status. More... | |
| ConnectivityStatus | internet_connectivity () const |
| Get internet connectivity status. More... | |
Additional Inherited Members | |
| enum | ConnectivityStatus { Unknown, Connected, Disconnected } |
| Indicates the internet connectivity status. More... | |
Detailed Description
Metadata passed with search requests.
Constructor & Destructor Documentation
| unity::scopes::SearchMetadata::SearchMetadata | ( | std::string const & | locale, |
| std::string const & | form_factor | ||
| ) |
Create SearchMetadata with the given locale and form factor.
- Parameters
-
locale locale string, eg. en_EN form_factor form factor name, e.g. phone, desktop, phone-version etc.
| unity::scopes::SearchMetadata::SearchMetadata | ( | int | cardinality, |
| std::string const & | locale, | ||
| std::string const & | form_factor | ||
| ) |
Create SearchMetadata with the given cardinality, locale, and form factor.
- Parameters
-
cardinality maximum number of search results locale locale string, eg. en_EN form_factor form factor name, e.g. phone, desktop, phone-version etc.
Member Function Documentation
| std::set< std::string > unity::scopes::SearchMetadata::aggregated_keywords | ( | ) | const |
Get the list of scope keywords used to initiate this search request.
- Returns
- The list of scope keywords used to initiate this search request.
| int unity::scopes::SearchMetadata::cardinality | ( | ) | const |
Get cardinality.
- Returns
- The maxmium number of search results, or 0 for no limit.
| bool unity::scopes::SearchMetadata::contains_hint | ( | std::string const & | key | ) | const |
Check if this SearchMetadata has a hint.
- Parameters
-
key The hint name.
- Returns
- True if the hint is set.
| bool unity::scopes::SearchMetadata::has_location | ( | ) | const |
Does the SearchMetadata have a location.
- Returns
- True if there is a location property.
| VariantMap unity::scopes::SearchMetadata::hints | ( | ) | const |
Get all hints.
- Returns
- Hints dictionary.
- Exceptions
-
unity::NotFoundException if no hints are available.
| bool unity::scopes::SearchMetadata::is_aggregated | ( | ) | const |
Check if this search request originated from an aggregator scope.
- Returns
- True if this search request originated from an aggregator scope.
| Location unity::scopes::SearchMetadata::location | ( | ) | const |
Get location.
- Returns
- Location data representing the current location, including attributes such as city and country.
- Exceptions
-
unity::NotFoundException if no location data is available.
| Variant & unity::scopes::SearchMetadata::operator[] | ( | std::string const & | key | ) |
Returns a reference to a hint.
This method can be used to read or set hints. Setting a value of an existing hint overwrites its previous value. Referencing a non-existing hint automatically creates it with a default value of Variant::Type::Null.
- Parameters
-
key The name of the hint.
- Returns
- A reference to the hint.
| Variant const & unity::scopes::SearchMetadata::operator[] | ( | std::string const & | key | ) | const |
Returns a const reference to a hint.
This method can be used for read-only access to hints. Referencing a non-existing hint throws unity::InvalidArgumentException.
- Parameters
-
key The name of the hint.
- Returns
- A const reference to the hint.
- Exceptions
-
unity::NotFoundException if no hint with the given name exists.
| void unity::scopes::SearchMetadata::remove_location | ( | ) |
Remove location data entirely.
This method does nothing if no location data is present.
| void unity::scopes::SearchMetadata::set_aggregated_keywords | ( | std::set< std::string > const & | aggregated_keywords | ) |
Set the list of scope keywords used to initiate this search request.
- Parameters
-
aggregated_keywords The list of scope keywords used to initiate this search request.
| void unity::scopes::SearchMetadata::set_cardinality | ( | int | cardinality | ) |
Set cardinality.
- Parameters
-
cardinality The maximum number of search results.
| void unity::scopes::SearchMetadata::set_hint | ( | std::string const & | key, |
| Variant const & | value | ||
| ) |
Sets a hint.
- Parameters
-
key The name of the hint. value Hint value
| void unity::scopes::SearchMetadata::set_location | ( | Location const & | location | ) |
Set location.
- Parameters
-
location Location data.