getAllFromCheckInAndEventPeriodAndLocationEventPeriod static method

Future<PcoCollection<PcoCheckInsCheckIn>> getAllFromCheckInAndEventPeriodAndLocationEventPeriod(
  1. String checkInId,
  2. String eventPeriodId,
  3. String locationEventPeriodId, {
  4. String? id,
  5. PcoCheckInsCheckInQuery? query,
  6. bool includeAllRelated = false,
  7. bool includeCheckInTimes = false,
  8. bool includeCheckedInAt = false,
  9. bool includeCheckedInBy = false,
  10. bool includeCheckedOutBy = false,
  11. bool includeEvent = false,
  12. bool includeEventPeriod = false,
  13. bool includeEventTimes = false,
  14. bool includeLocations = false,
  15. bool includeOptions = false,
  16. bool includePerson = false,
})

Will get a PcoCollection containing ALL PcoCheckInsCheckIn objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/event_period/$eventPeriodId/location_event_periods/$locationEventPeriodId/check_ins

Available Query Filters:

  • attendee
  • checked_out
  • first_time
  • guest
  • not_checked_out
  • not_one_time_guest
  • one_time_guest
  • regular
  • volunteer

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<PcoCheckInsCheckIn>>
    getAllFromCheckInAndEventPeriodAndLocationEventPeriod(
  String checkInId,
  String eventPeriodId,
  String locationEventPeriodId, {
  String? id,
  PcoCheckInsCheckInQuery? query,
  bool includeAllRelated = false,
  bool includeCheckInTimes = false,
  bool includeCheckedInAt = false,
  bool includeCheckedInBy = false,
  bool includeCheckedOutBy = false,
  bool includeEvent = false,
  bool includeEventPeriod = false,
  bool includeEventTimes = false,
  bool includeLocations = false,
  bool includeOptions = false,
  bool includePerson = false,
}) async {
  query ??= PcoCheckInsCheckInQuery();
  query.getAll = true;
  if (includeAllRelated) query.include.addAll(PcoCheckInsCheckIn.canInclude);
  if (includeCheckInTimes) query.include.add('check_in_times');
  if (includeCheckedInAt) query.include.add('checked_in_at');
  if (includeCheckedInBy) query.include.add('checked_in_by');
  if (includeCheckedOutBy) query.include.add('checked_out_by');
  if (includeEvent) query.include.add('event');
  if (includeEventPeriod) query.include.add('event_period');
  if (includeEventTimes) query.include.add('event_times');
  if (includeLocations) query.include.add('locations');
  if (includeOptions) query.include.add('options');
  if (includePerson) query.include.add('person');
  var url =
      '/check-ins/v2/check_ins/$checkInId/event_period/$eventPeriodId/location_event_periods/$locationEventPeriodId/check_ins';
  if (id != null) url += '/$id';
  return PcoCollection.fromApiCall<PcoCheckInsCheckIn>(url,
      query: query, apiVersion: kApiVersion);
}