PortalQueryResultSetForGroups Class

  • PortalQueryResultSetForGroups
  • class Esri::ArcGISRuntime::PortalQueryResultSetForGroups

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

    Header: #include <PortalQueryResultSetForGroups.h>
    Since: Esri::ArcGISRuntime 100.0
    Inherits: Esri::ArcGISRuntime::Object

    Public Functions

    virtual ~PortalQueryResultSetForGroups() override
    Esri::ArcGISRuntime::PortalGroupListModel *groupResults() const
    Esri::ArcGISRuntime::PortalQueryParametersForGroups nextQueryParameters() const
    Esri::ArcGISRuntime::PortalQueryParametersForGroups 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 PortalQueryResultSetForGroups is limited by the results limit field of the PortalQueryParametersForGroups used to make the query. By default, only the first ten result values are returned. The PortalQueryResultSetForGroups allows clients to retrieve results in batches. Use nextQueryParameters to get a PortalQueryParametersForGroups object to fetch the next batch of results.

    See also Portal, PortalQueryParametersForGroups, and PortalGroup.

    Member Function Documentation

    [override virtual] PortalQueryResultSetForGroups::~PortalQueryResultSetForGroups()


    Esri::ArcGISRuntime::PortalGroupListModel *PortalQueryResultSetForGroups::groupResults() const

    Returns a list of PortalGroup objects which satisfy the query.

    See also PortalGroup.

    Esri::ArcGISRuntime::PortalQueryParametersForGroups PortalQueryResultSetForGroups::nextQueryParameters() const

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

    If the full set of groups 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::findGroups on the portal. If this property is empty, no further groups are available.

    See also Portal and PortalQueryParametersForGroups.

    Esri::ArcGISRuntime::PortalQueryParametersForGroups PortalQueryResultSetForGroups::queryParameters() const

    Returns the parameters used to select the groupResults

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

    See also PortalQueryParametersForGroups.

    int PortalQueryResultSetForGroups::totalResults() const

    Returns the count of groups selected by the query.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.