getSingle static method

Future<PcoCheckInsEvent?> getSingle(
  1. String id,
  2. {PcoCheckInsEventQuery? query,
  3. bool includeAllRelated = false,
  4. bool includeAttendanceTypes = false,
  5. bool includeEventPeriods = false}
)

Will get a single PcoCheckInsEvent object using a path like this: /check-ins/v2/events/[id]

Available Query Filters:

  • archived
  • for_headcounts
  • not_archived

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.

Implementation

static Future<PcoCheckInsEvent?> getSingle(
  String id, {
  PcoCheckInsEventQuery? query,
  bool includeAllRelated = false,
  bool includeAttendanceTypes = false,
  bool includeEventPeriods = false,
}) async {
  query ??= PcoCheckInsEventQuery();
  if (includeAllRelated) query.include.addAll(PcoCheckInsEvent.canInclude);
  if (includeAttendanceTypes) query.include.add('attendance_types');
  if (includeEventPeriods) query.include.add('event_periods');
  var url = '/check-ins/v2/events/$id';
  var retval = await PcoCollection.fromApiCall<PcoCheckInsEvent>(url,
      query: query, apiVersion: kApiVersion);
  return retval.items.isEmpty ? null : retval.items.first;
}