getAllFromTag static method

Future<PcoCollection<PcoGroupsGroup>> getAllFromTag(
  1. String tagId,
  2. {String? id,
  3. PcoGroupsGroupQuery? query,
  4. bool includeAllRelated = false,
  5. bool includeGroupType = false,
  6. bool includeLocation = false}
)

Will get a PcoCollection containing ALL PcoGroupsGroup objects (expecting many) using a path like this: /groups/v2/tags/$tagId/groups

Additional options may be specified by using the query argument, but some query options are also available as boolean flags in this function call too.

This function forces the query.getAll to be true.

Implementation

static Future<PcoCollection<PcoGroupsGroup>> getAllFromTag(
  String tagId, {
  String? id,
  PcoGroupsGroupQuery? query,
  bool includeAllRelated = false,
  bool includeGroupType = false,
  bool includeLocation = false,
}) async {
  query ??= PcoGroupsGroupQuery();
  query.getAll = true;
  if (includeAllRelated) query.include.addAll(PcoGroupsGroup.canInclude);
  if (includeGroupType) query.include.add('group_type');
  if (includeLocation) query.include.add('location');
  var url = '/groups/v2/tags/$tagId/groups';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoGroupsGroup>(url,
      query: query, apiVersion: kApiVersion);
}