getAll static method

Future<PcoCollection<PcoPeopleForm>> getAll({
  1. String? id,
  2. PcoPeopleFormQuery? query,
  3. bool includeCampus = false,
})

Will get a PcoCollection containing ALL PcoPeopleForm objects (expecting many) using a path like this: /people/v2/forms

Available Query Filters:

  • archived
  • closed
  • not_archived
  • open
  • recently_viewed
  • with_recoverable

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<PcoPeopleForm>> getAll({
  String? id,
  PcoPeopleFormQuery? query,
  bool includeCampus = false,
}) async {
  query ??= PcoPeopleFormQuery();
  query.getAll = true;

  if (includeCampus) query.include.add('campus');
  var url = '/people/v2/forms';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoPeopleForm>(url,
      query: query, apiVersion: kApiVersion);
}