findGroups method

Future<PortalQueryResultSet<PortalGroup>> findGroups({
  1. required PortalQueryParameters parameters,
})

Finds portal groups that match the given query parameters.

This method obtains a PortalQueryResultSet object containing a collection of PortalGroup objects. Use PortalQueryResultSet.results to obtain the collection of PortalGroup objects that match the query parameters. The PortalGroup objects are fully populated and have a load status of LoadStatus.loaded. Use the PortalQueryParameters to restrict the items returned by this method. If you provide a simple keyword string for the search, such as "federal", this method searches the default set of high performance index fields, such as id, title, description, snippet, tags, and owner.

For more advanced searches, you can preface your simple keyword strings with ArcGIS Portal Directory REST named fields followed by a colon (:). These advanced searches can take advantage of Boolean operators (AND, NOT, OR, -) and a range of special characters. For a more information, see the Search reference document in the ArcGIS Portal Directory REST API. Here are some examples of advanced search strings:

  • To find one specific portal group by it's Id: "id:1db70a32f5f84ea9a88f5f460f22557b"
  • To find all private portal groups with the word 'federal' in the Title field: "title:federal AND access:private"
  • To find all portal groups with the word 'federal' in the Title field and the word 'restricted' in the Description field: "title:federal AND description:restricted"
  • To find all portal groups with the word 'state' in the Title field and not have the word 'restricted' in the Description field: "title:state NOT description:restricted"

Returns: a Future of PortalQueryResultSet containing the PortalGroups that were found.

Implementation

Future<PortalQueryResultSet<PortalGroup>> findGroups({
  required PortalQueryParameters parameters,
}) =>
    _portalHelper.findGroups(parameters: parameters);