getSingle static method

Future<PcoCalendarEventInstance?> getSingle(
  1. String id, {
  2. PcoCalendarEventInstanceQuery? query,
  3. bool includeAllRelated = false,
  4. bool includeEvent = false,
  5. bool includeEventTimes = false,
  6. bool includeResourceBookings = false,
  7. bool includeTags = false,
})

Will get a single PcoCalendarEventInstance object using a path like this: /calendar/v2/event_instances/[id]

Available Query Filters:

  • all
  • approved
  • approved_pending
  • approved_pending_rejected
  • approved_rejected
  • approver
  • approver_subscriber
  • future
  • lost
  • owner
  • owner_approver
  • owner_approver_subscriber
  • owner_subscriber
  • pending
  • pending_rejected
  • rejected
  • shared
  • subscriber
  • unresolved

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<PcoCalendarEventInstance?> getSingle(
  String id, {
  PcoCalendarEventInstanceQuery? query,
  bool includeAllRelated = false,
  bool includeEvent = false,
  bool includeEventTimes = false,
  bool includeResourceBookings = false,
  bool includeTags = false,
}) async {
  query ??= PcoCalendarEventInstanceQuery();
  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/event_instances/$id';
  var retval = await PcoCollection.fromApiCall<PcoCalendarEventInstance>(url,
      query: query, apiVersion: kApiVersion);
  return retval.items.isEmpty ? null : retval.items.first;
}