Skip To Content ArcGIS for Developers Sign In Dashboard

SuggestResult Class

(Esri::ArcGISRuntime::SuggestResult)

The result class returned from a suggest operation of a LocatorTask. More...

Header: #include <SuggestResult>
Since: Esri::ArcGISRuntime 100.0

Public Functions

SuggestResult()
SuggestResult(const SuggestResult &other)
SuggestResult(SuggestResult &&other)
~SuggestResult()
bool isCollection() const
bool isEmpty() const
QString label() const
SuggestResult &operator=(const SuggestResult &other)
SuggestResult &operator=(SuggestResult &&other)

Detailed Description

The result class returned from a suggest operation of a LocatorTask.

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.

Member Function Documentation

SuggestResult::SuggestResult()

Default constructor.

SuggestResult::SuggestResult(const SuggestResult &other)

Copy constructor from other SuggestResult.

SuggestResult::SuggestResult(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.

SuggestResult &SuggestResult::operator=(const SuggestResult &other)

Assignment operator from other SuggestResult.

SuggestResult &SuggestResult::operator=(SuggestResult &&other)

Move operator from other SuggestResult.


Feedback on this topic?