The result class returned from a suggest operation of a LocatorTask. More...
| Header: | #include <SuggestResult.h> |
| Since: | Esri::ArcGISRuntime 100.0 |
Public Functions
| SuggestResult() | |
| SuggestResult(const Esri::ArcGISRuntime::SuggestResult &other) | |
| SuggestResult(Esri::ArcGISRuntime::SuggestResult &&other) | |
| ~SuggestResult() | |
| bool | isCollection() const |
| bool | isEmpty() const |
| QString | label() const |
| Esri::ArcGISRuntime::SuggestResult & | operator=(const Esri::ArcGISRuntime::SuggestResult &other) |
| Esri::ArcGISRuntime::SuggestResult & | operator=(Esri::ArcGISRuntime::SuggestResult &&other) |
Detailed Description
Suggestions are used to create an auto-complete experience, where as a user types an address, potential matches are returned and displayed to the user. The potential matches that are returned are the SuggestResults. Suggestions can be made for street addresses, points of interest by name, points of interest by type (such as "restaurant"), administrative place names (such as "Seattle"), or postal codes.
Obtain this result from the SuggestListModel::suggestResults. The SuggestListModel is obtained through LocatorTask::suggestions.
Relevant samples:
- Find a place: Find places of interest near a location or within a specific area.
Member Function Documentation
SuggestResult::SuggestResult ()
Default constructor.
SuggestResult::SuggestResult (const Esri::ArcGISRuntime::SuggestResult &other)
Copy constructor from other SuggestResult.
SuggestResult::SuggestResult (Esri::ArcGISRuntime::SuggestResult &&other)
Move constructor from other SuggestResult.
SuggestResult::~SuggestResult ()
Destructor.
bool SuggestResult::isCollection () const
Gets a flag that indicates candidate is related to a category or group.
Returns true if the candidate is related to a category or group and false otherwise. Candidate can be related with a category or group for example 'coffee', or some business name for example 'Starbucks'.
bool SuggestResult::isEmpty () const
Returns whether this SuggestResult is empty.
QString SuggestResult::label() const
Returns the label of the SuggestResult.
Use this label to populate a view, indicating potential matches.
Esri::ArcGISRuntime::SuggestResult &SuggestResult::operator=(const Esri::ArcGISRuntime::SuggestResult &other)
Assignment operator from other SuggestResult.
Esri::ArcGISRuntime::SuggestResult &SuggestResult::operator=(Esri::ArcGISRuntime::SuggestResult &&other)
Move operator from other SuggestResult.