getAllFromStation static method

Future<PcoCollection<PcoCheckInsCheckInGroup>> getAllFromStation(
  1. String stationId, {
  2. String? id,
  3. PcoCheckInsCheckInGroupQuery? query,
  4. bool includeAllRelated = false,
  5. bool includeCheckIns = false,
  6. bool includeEventPeriod = false,
  7. bool includePrintStation = false,
})

Will get a PcoCollection containing ALL PcoCheckInsCheckInGroup objects (expecting many) using a path like this: /check-ins/v2/stations/$stationId/check_in_groups

Available Query Filters:

  • canceled
  • printed
  • ready
  • skipped

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<PcoCheckInsCheckInGroup>> getAllFromStation(
  String stationId, {
  String? id,
  PcoCheckInsCheckInGroupQuery? query,
  bool includeAllRelated = false,
  bool includeCheckIns = false,
  bool includeEventPeriod = false,
  bool includePrintStation = false,
}) async {
  query ??= PcoCheckInsCheckInGroupQuery();
  query.getAll = true;
  if (includeAllRelated)
    query.include.addAll(PcoCheckInsCheckInGroup.canInclude);
  if (includeCheckIns) query.include.add('check_ins');
  if (includeEventPeriod) query.include.add('event_period');
  if (includePrintStation) query.include.add('print_station');
  var url = '/check-ins/v2/stations/$stationId/check_in_groups';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoCheckInsCheckInGroup>(url,
      query: query, apiVersion: kApiVersion);
}