getFromEventTimeAndLocationEventTime static method
Future<PcoCollection<PcoCheckInsCheckIn> >
getFromEventTimeAndLocationEventTime(
- String eventTimeId,
- String locationEventTimeId, {
- String? id,
- PcoCheckInsCheckInQuery? query,
- bool getAll = false,
- 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,
Will get a PcoCollection
of PcoCheckInsCheckIn objects (expecting many)
using a path like this: /check-ins/v2/event_times/$eventTimeId/location_event_times/$locationEventTimeId/check_ins
Available Query Filters:
attendee
checked_out
first_time
guest
not_checked_out
not_one_time_guest
one_time_guest
regular
volunteer
Getting a PcoCollection
is useful even when retrieving a single object
because it contains error data and helper functions.
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<PcoCollection<PcoCheckInsCheckIn>>
getFromEventTimeAndLocationEventTime(
String eventTimeId,
String locationEventTimeId, {
String? id,
PcoCheckInsCheckInQuery? query,
bool getAll = false,
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();
if (getAll) 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/event_times/$eventTimeId/location_event_times/$locationEventTimeId/check_ins';
if (id != null) url += '/$id';
return PcoCollection.fromApiCall<PcoCheckInsCheckIn>(url,
query: query, apiVersion: kApiVersion);
}