getFromTag static method
Will get a PcoCollection
of PcoCalendarEventInstance objects (expecting many)
using a path like this: /calendar/v2/tags/$tagId/event_instances
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<PcoCalendarEventInstance>> getFromTag(
String tagId, {
String? id,
PcoCalendarEventInstanceQuery? query,
bool getAll = false,
bool includeAllRelated = false,
bool includeEvent = false,
bool includeEventTimes = false,
bool includeResourceBookings = false,
bool includeTags = false,
}) async {
query ??= PcoCalendarEventInstanceQuery();
if (getAll) query.getAll = true;
if (includeAllRelated)
query.include.addAll(PcoCalendarEventInstance.canInclude);
if (includeEvent) query.include.add('event');
if (includeEventTimes) query.include.add('event_times');
if (includeResourceBookings) query.include.add('resource_bookings');
if (includeTags) query.include.add('tags');
var url = '/calendar/v2/tags/$tagId/event_instances';
if (id != null) url += '/$id';
return PcoCollection.fromApiCall<PcoCalendarEventInstance>(url,
query: query, apiVersion: kApiVersion);
}