Skip To Content ArcGIS for Developers Sign In Dashboard

PortalQueryResultSetForItems Class

class Esri::ArcGISRuntime::PortalQueryResultSetForItems

This class represents results of an items query performed on a portal. More...

Header: #include <PortalQueryResultSetForItems>
Since: Esri::ArcGISRuntime 100.0
Inherits: Esri::ArcGISRuntime::Object

This class was introduced in Esri::ArcGISRuntime 100.0.

Public Functions

PortalQueryResultSetForItems(QObject *parent = nullptr)
virtual ~PortalQueryResultSetForItems() override
Esri::ArcGISRuntime::PortalItemListModel *itemResults() const
Esri::ArcGISRuntime::PortalQueryParametersForItems nextQueryParameters() const
Esri::ArcGISRuntime::PortalQueryParametersForItems queryParameters() const
int totalResults() const

Detailed Description

A "pageable" search performed on a portal may yield a large number of results. The number of results in a PortalQueryResultSetForItems is limited by the results limit field of the PortalQueryParametersForItems used to make the query. By default, only the first ten result values are returned. The PortalQueryResultSetForItems allows clients to retrieve results in batches. Use nextQueryParameters to get a PortalQueryParametersForItems object to fetch the next batch of results.

See also Portal, PortalQueryParametersForItems, and PortalItem.

Member Function Documentation

PortalQueryResultSetForItems::PortalQueryResultSetForItems(QObject *parent = nullptr)

Default constructor with an optional parent.

[override virtual] PortalQueryResultSetForItems::~PortalQueryResultSetForItems()

Destructor.

Esri::ArcGISRuntime::PortalItemListModel *PortalQueryResultSetForItems::itemResults() const

Returns a list of PortalItem objects which satisfy the query.

See also PortalItem.

Esri::ArcGISRuntime::PortalQueryParametersForItems PortalQueryResultSetForItems::nextQueryParameters() const

Returns the parameters used to select the next set of results.

If the full set of items identified by the original query is too large, this property will contain the query which should be used to make a further call to Portal::findItems on the portal. If this property is empty, no further items are available.

See also Portal and PortalQueryParametersForItems.

Esri::ArcGISRuntime::PortalQueryParametersForItems PortalQueryResultSetForItems::queryParameters() const

Returns the parameters used to select the itemResults

The parameters are based on the original PortalQueryResultSetForItems used to call Portal::findItems on the portal. However, if the total set of results is too large, the parameters will be refined to select only a subset of the records - i.e. those contained in the results.

See also PortalQueryParametersForItems.

int PortalQueryResultSetForItems::totalResults() const

Returns the count of items selected by the query.


Feedback on this topic?