getSingleFromOption static method
Future<PcoCheckInsCheckIn?>
getSingleFromOption(
- String optionId,
- 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,
Will get a single PcoCheckInsCheckIn
object
using a path like this: /check-ins/v2/options/$optionId/check_ins/[id]
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<PcoCheckInsCheckIn?> getSingleFromOption(
String optionId,
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();
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/options/$optionId/check_ins/$id';
var retval = await PcoCollection.fromApiCall<PcoCheckInsCheckIn>(url,
query: query, apiVersion: kApiVersion);
return retval.items.isEmpty ? null : retval.items.first;
}