list method

Future<Events> list(
  1. String calendarId, {
  2. bool? alwaysIncludeEmail,
  3. List<String>? eventTypes,
  4. String? iCalUID,
  5. int? maxAttendees,
  6. int? maxResults,
  7. String? orderBy,
  8. String? pageToken,
  9. List<String>? privateExtendedProperty,
  10. String? q,
  11. List<String>? sharedExtendedProperty,
  12. bool? showDeleted,
  13. bool? showHiddenInvitations,
  14. bool? singleEvents,
  15. String? syncToken,
  16. DateTime? timeMax,
  17. DateTime? timeMin,
  18. String? timeZone,
  19. DateTime? updatedMin,
  20. String? $fields,
})

Returns events on the specified calendar.

Request parameters:

calendarId - Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

alwaysIncludeEmail - Deprecated and ignored.

eventTypes - Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.

iCalUID - Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID.

maxAttendees - The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

maxResults - Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.

orderBy - The order of the events returned in the result. Optional. The default is an unspecified, stable order. Possible string values are:

  • "startTime" : Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)
  • "updated" : Order by last modification time (ascending).

pageToken - Token specifying which result page to return. Optional.

privateExtendedProperty - Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.

q - Free text search terms to find events that match these terms in the following fields:

  • summary
  • description
  • location
  • attendee's displayName
  • attendee's email
  • organizer's displayName
  • organizer's email
  • workingLocationProperties.officeLocation.buildingId
  • workingLocationProperties.officeLocation.deskId
  • workingLocationProperties.officeLocation.label
  • workingLocationProperties.customLocation.label These search terms also match predefined keywords against all display title translations of working location, out-of-office, and focus-time events. For example, searching for "Office" or "Bureau" returns working location events of type officeLocation, whereas searching for "Out of office" or "Abwesend" returns out-of-office events. Optional.

sharedExtendedProperty - Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.

showDeleted - Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.

showHiddenInvitations - Whether to include hidden invitations in the result. Optional. The default is False.

singleEvents - Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.

syncToken - Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state.

These are:

  • iCalUID
  • orderBy
  • privateExtendedProperty
  • q
  • sharedExtendedProperty
  • timeMin
  • timeMax
  • updatedMin All other query parameters should be the same as for the initial synchronization to avoid undefined behavior. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

timeMax - Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.

timeMin - Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.

timeZone - Time zone used in the response. Optional. The default is the time zone of the calendar.

updatedMin - Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.

$fields - Selector specifying which fields to include in a partial response.

Completes with a Events.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<Events> list(
  core.String calendarId, {
  core.bool? alwaysIncludeEmail,
  core.List<core.String>? eventTypes,
  core.String? iCalUID,
  core.int? maxAttendees,
  core.int? maxResults,
  core.String? orderBy,
  core.String? pageToken,
  core.List<core.String>? privateExtendedProperty,
  core.String? q,
  core.List<core.String>? sharedExtendedProperty,
  core.bool? showDeleted,
  core.bool? showHiddenInvitations,
  core.bool? singleEvents,
  core.String? syncToken,
  core.DateTime? timeMax,
  core.DateTime? timeMin,
  core.String? timeZone,
  core.DateTime? updatedMin,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (alwaysIncludeEmail != null)
      'alwaysIncludeEmail': ['${alwaysIncludeEmail}'],
    if (eventTypes != null) 'eventTypes': eventTypes,
    if (iCalUID != null) 'iCalUID': [iCalUID],
    if (maxAttendees != null) 'maxAttendees': ['${maxAttendees}'],
    if (maxResults != null) 'maxResults': ['${maxResults}'],
    if (orderBy != null) 'orderBy': [orderBy],
    if (pageToken != null) 'pageToken': [pageToken],
    if (privateExtendedProperty != null)
      'privateExtendedProperty': privateExtendedProperty,
    if (q != null) 'q': [q],
    if (sharedExtendedProperty != null)
      'sharedExtendedProperty': sharedExtendedProperty,
    if (showDeleted != null) 'showDeleted': ['${showDeleted}'],
    if (showHiddenInvitations != null)
      'showHiddenInvitations': ['${showHiddenInvitations}'],
    if (singleEvents != null) 'singleEvents': ['${singleEvents}'],
    if (syncToken != null) 'syncToken': [syncToken],
    if (timeMax != null) 'timeMax': [timeMax.toUtc().toIso8601String()],
    if (timeMin != null) 'timeMin': [timeMin.toUtc().toIso8601String()],
    if (timeZone != null) 'timeZone': [timeZone],
    if (updatedMin != null)
      'updatedMin': [updatedMin.toUtc().toIso8601String()],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'calendars/' + commons.escapeVariable('$calendarId') + '/events';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return Events.fromJson(response_ as core.Map<core.String, core.dynamic>);
}