google_api_calendar v0.5.0 API Reference
Modules
API calls for all endpoints tagged Acl
.
API calls for all endpoints tagged CalendarList
.
API calls for all endpoints tagged Calendars
.
API calls for all endpoints tagged Channels
.
API calls for all endpoints tagged Colors
.
API calls for all endpoints tagged Events
.
API calls for all endpoints tagged Freebusy
.
API calls for all endpoints tagged Settings
.
Handle Tesla connections for GoogleApi.Calendar.V3.
Attributes
- etag (String.t): ETag of the collection. Defaults to
nil
. - items (list(GoogleApi.Calendar.V3.Model.AclRule.t)): List of rules on the access control list. Defaults to
nil
. - kind (String.t): Type of the collection ("calendar#acl"). Defaults to
calendar#acl
. - nextPageToken (String.t): Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. Defaults to
nil
. - nextSyncToken (String.t): Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. Defaults to
nil
.
Attributes
- etag (String.t): ETag of the resource. Defaults to
nil
. - id (String.t): Identifier of the ACL rule. Defaults to
nil
. - kind (String.t): Type of the resource ("calendar#aclRule"). Defaults to
calendar#aclRule
. - role (String.t): The role assigned to the scope. Possible values are:
- "none" - Provides no access.
- "freeBusyReader" - Provides read access to free/busy information.
- "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs. Defaults to
nil
. - scope (GoogleApi.Calendar.V3.Model.AclRuleScope.t): The scope of the rule. Defaults to
nil
.
The scope of the rule.
Attributes
- conferenceProperties (GoogleApi.Calendar.V3.Model.ConferenceProperties.t): Conferencing properties for this calendar, for example what types of conferences are allowed. Defaults to
nil
. - description (String.t): Description of the calendar. Optional. Defaults to
nil
. - etag (String.t): ETag of the resource. Defaults to
nil
. - id (String.t): Identifier of the calendar. To retrieve IDs call the calendarList.list() method. Defaults to
nil
. - kind (String.t): Type of the resource ("calendar#calendar"). Defaults to
calendar#calendar
. - location (String.t): Geographic location of the calendar as free-form text. Optional. Defaults to
nil
. - summary (String.t): Title of the calendar. Defaults to
nil
. - timeZone (String.t): The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. Defaults to
nil
.
Attributes
- etag (String.t): ETag of the collection. Defaults to
nil
. - items (list(GoogleApi.Calendar.V3.Model.CalendarListEntry.t)): Calendars that are present on the user's calendar list. Defaults to
nil
. - kind (String.t): Type of the collection ("calendar#calendarList"). Defaults to
calendar#calendarList
. - nextPageToken (String.t): Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. Defaults to
nil
. - nextSyncToken (String.t): Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. Defaults to
nil
.
Attributes
- accessRole (String.t): The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
- "freeBusyReader" - Provides read access to free/busy information.
- "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs. Defaults to
nil
. - backgroundColor (String.t): The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional. Defaults to
nil
. - colorId (String.t): The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional. Defaults to
nil
. - conferenceProperties (GoogleApi.Calendar.V3.Model.ConferenceProperties.t): Conferencing properties for this calendar, for example what types of conferences are allowed. Defaults to
nil
. - defaultReminders (list(GoogleApi.Calendar.V3.Model.EventReminder.t)): The default reminders that the authenticated user has for this calendar. Defaults to
nil
. - deleted (boolean()): Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False. Defaults to
false
. - description (String.t): Description of the calendar. Optional. Read-only. Defaults to
nil
. - etag (String.t): ETag of the resource. Defaults to
nil
. - foregroundColor (String.t): The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional. Defaults to
nil
. - hidden (boolean()): Whether the calendar has been hidden from the list. Optional. The default is False. Defaults to
false
. - id (String.t): Identifier of the calendar. Defaults to
nil
. - kind (String.t): Type of the resource ("calendar#calendarListEntry"). Defaults to
calendar#calendarListEntry
. - location (String.t): Geographic location of the calendar as free-form text. Optional. Read-only. Defaults to
nil
. - notificationSettings (GoogleApi.Calendar.V3.Model.CalendarListEntryNotificationSettings.t): The notifications that the authenticated user is receiving for this calendar. Defaults to
nil
. - primary (boolean()): Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False. Defaults to
false
. - selected (boolean()): Whether the calendar content shows up in the calendar UI. Optional. The default is False. Defaults to
false
. - summary (String.t): Title of the calendar. Read-only. Defaults to
nil
. - summaryOverride (String.t): The summary that the authenticated user has set for this calendar. Optional. Defaults to
nil
. - timeZone (String.t): The time zone of the calendar. Optional. Read-only. Defaults to
nil
.
The notifications that the authenticated user is receiving for this calendar.
Attributes
- method (String.t): The method used to deliver the notification. Possible values are:
- "email" - Notifications are sent via email.
- "sms" - Deprecated. Once this feature is shutdown, the API will no longer return notifications using this method. Any newly added SMS notifications will be ignored. See Google Calendar SMS notifications to be removed for more information.
Notifications are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS notifications are only available for G Suite customers.
Required when adding a notification. Defaults tonil
. - type (String.t): The type of notification. Possible values are:
- "eventCreation" - Notification sent when a new event is put on the calendar.
- "eventChange" - Notification sent when an event is changed.
- "eventCancellation" - Notification sent when an event is cancelled.
- "eventResponse" - Notification sent when an attendee responds to the event invitation.
- "agenda" - An agenda with the events of the day (sent out in the morning).
Required when adding a notification. Defaults tonil
.
Attributes
- address (String.t): The address where notifications are delivered for this channel. Defaults to
nil
. - expiration (String.t): Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional. Defaults to
nil
. - id (String.t): A UUID or similar unique string that identifies this channel. Defaults to
nil
. - kind (String.t): Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel". Defaults to
api#channel
. - params (map()): Additional parameters controlling delivery channel behavior. Optional. Defaults to
nil
. - payload (boolean()): A Boolean value to indicate whether payload is wanted. Optional. Defaults to
nil
. - resourceId (String.t): An opaque ID that identifies the resource being watched on this channel. Stable across different API versions. Defaults to
nil
. - resourceUri (String.t): A version-specific identifier for the watched resource. Defaults to
nil
. - token (String.t): An arbitrary string delivered to the target address with each notification delivered over this channel. Optional. Defaults to
nil
. - type (String.t): The type of delivery mechanism used for this channel. Defaults to
nil
.
Attributes
- calendar (%{optional(String.t) => GoogleApi.Calendar.V3.Model.ColorDefinition.t}): A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its color field. Read-only. Defaults to
nil
. - event (%{optional(String.t) => GoogleApi.Calendar.V3.Model.ColorDefinition.t}): A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its color field. Read-only. Defaults to
nil
. - kind (String.t): Type of the resource ("calendar#colors"). Defaults to
calendar#colors
. - updated (DateTime.t): Last modification time of the color palette (as a RFC3339 timestamp). Read-only. Defaults to
nil
.
Attributes
- conferenceId (String.t): The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. Values for solution types:
- "eventHangout": unset.
- "eventNamedHangout": the name of the Hangout.
- "hangoutsMeet": the 10-letter meeting code, for example "aaa-bbbb-ccc". Optional. Defaults to
nil
. - conferenceSolution (GoogleApi.Calendar.V3.Model.ConferenceSolution.t): The conference solution, such as Hangouts or Hangouts Meet.
Unset for a conference with a failed create request.
Either conferenceSolution and at least one entryPoint, or createRequest is required. Defaults to
nil
. - createRequest (GoogleApi.Calendar.V3.Model.CreateConferenceRequest.t): A request to generate a new conference and attach it to the event. The data is generated asynchronously. To see whether the data is present check the status field.
Either conferenceSolution and at least one entryPoint, or createRequest is required. Defaults to
nil
. - entryPoints (list(GoogleApi.Calendar.V3.Model.EntryPoint.t)): Information about individual conference entry points, such as URLs or phone numbers.
All of them must belong to the same conference.
Either conferenceSolution and at least one entryPoint, or createRequest is required. Defaults to
nil
. - notes (String.t): Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional. Defaults to
nil
. - parameters (GoogleApi.Calendar.V3.Model.ConferenceParameters.t): Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming. Defaults to
nil
. - signature (String.t): The signature of the conference data.
Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.
Unset for a conference with a failed create request.
Optional for a conference with a pending create request. Defaults to
nil
.
Attributes
- statusCode (String.t): The current status of the conference create request. Read-only. The possible values are:
- "pending": the conference create request is still being processed.
- "success": the conference create request succeeded, the entry points are populated.
- "failure": the conference create request failed, there are no entry points. Defaults to
nil
.
Attributes
- iconUri (String.t): The user-visible icon for this solution. Defaults to
nil
. - key (GoogleApi.Calendar.V3.Model.ConferenceSolutionKey.t): The key which can uniquely identify the conference solution for this event. Defaults to
nil
. - name (String.t): The user-visible name of this solution. Not localized. Defaults to
nil
.
Attributes
- type (String.t): The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. The possible values are:
- "eventHangout" for Hangouts for consumers (http://hangouts.google.com)
- "eventNamedHangout" for classic Hangouts for G Suite users (http://hangouts.google.com)
- "hangoutsMeet" for Hangouts Meet (http://meet.google.com) Defaults to
nil
.
Attributes
- conferenceSolutionKey (GoogleApi.Calendar.V3.Model.ConferenceSolutionKey.t): The conference solution, such as Hangouts or Hangouts Meet. Defaults to
nil
. - requestId (String.t): The client-generated unique ID for this request.
Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. Defaults to
nil
. - status (GoogleApi.Calendar.V3.Model.ConferenceRequestStatus.t): The status of the conference create request. Defaults to
nil
.
Attributes
- accessCode (String.t): The access code to access the conference. The maximum length is 128 characters.
When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
Optional. Defaults to
nil
. - entryPointFeatures (list(String.t)): Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point. Defaults to
nil
. - entryPointType (String.t): The type of the conference entry point. Possible values are:
- "video" - joining a conference over HTTP. A conference can have zero or one video entry point.
- "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points.
- "sip" - joining a conference over SIP. A conference can have zero or one sip entry point.
- "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference. Defaults to
nil
. - label (String.t): The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. Examples:
- for video: meet.google.com/aaa-bbbb-ccc
- for phone: +1 123 268 2601
- for sip: 12345678@altostrat.com
- for more: should not be filled
Optional. Defaults tonil
. - meetingCode (String.t): The meeting code to access the conference. The maximum length is 128 characters.
When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
Optional. Defaults to
nil
. - passcode (String.t): The passcode to access the conference. The maximum length is 128 characters.
When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Defaults to
nil
. - password (String.t): The password to access the conference. The maximum length is 128 characters.
When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
Optional. Defaults to
nil
. - pin (String.t): The PIN to access the conference. The maximum length is 128 characters.
When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed.
Optional. Defaults to
nil
. - regionCode (String.t): The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden.
Calendar backend will populate this field only for EntryPointType.PHONE. Defaults to
nil
. - uri (String.t): The URI of the entry point. The maximum length is 1300 characters. Format:
- for video, http: or https: schema is required.
- for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234).
- for sip, sip: schema is required, e.g., sip:12345678@myprovider.com.
- for more, http: or https: schema is required. Defaults to
nil
.
Attributes
- domain (String.t): Domain, or broad category, of the error. Defaults to
nil
. - reason (String.t): Specific reason for the error. Some of the possible values are:
- "groupTooBig" - The group of users requested is too large for a single query.
- "tooManyCalendarsRequested" - The number of calendars requested is too large for a single query.
- "notFound" - The requested resource was not found.
- "internalError" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list. Defaults to
nil
.
Attributes
- iCalUID (String.t): Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method.
Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs. Defaults to
nil
. - source (GoogleApi.Calendar.V3.Model.EventSource.t): Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. Defaults to
nil
. - htmlLink (String.t): An absolute link to this event in the Google Calendar Web UI. Read-only. Defaults to
nil
. - created (DateTime.t): Creation time of the event (as a RFC3339 timestamp). Read-only. Defaults to
nil
. - locked (boolean()): Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only. Defaults to
false
. - originalStartTime (GoogleApi.Calendar.V3.Model.EventDateTime.t): For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable. Defaults to
nil
. - updated (DateTime.t): Last modification time of the event (as a RFC3339 timestamp). Read-only. Defaults to
nil
. - end (GoogleApi.Calendar.V3.Model.EventDateTime.t): The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. Defaults to
nil
. - id (String.t): Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:
- characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
- the length of the ID must be between 5 and 1024 characters
- the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122.
If you do not specify an ID, it will be automatically generated by the server.
Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs. Defaults to
nil
. - endTimeUnspecified (boolean()): Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. Defaults to
false
. - recurringEventId (String.t): For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. Defaults to
nil
. - transparency (String.t): Whether the event blocks time on the calendar. Optional. Possible values are:
- "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
- "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. Defaults to
opaque
. - recurrence (list(String.t)): List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events. Defaults to
nil
. - sequence (integer()): Sequence number as per iCalendar. Defaults to
nil
. - extendedProperties (GoogleApi.Calendar.V3.Model.EventExtendedProperties.t): Extended properties of the event. Defaults to
nil
. - guestsCanInviteOthers (boolean()): Whether attendees other than the organizer can invite others to the event. Optional. The default is True. Defaults to
true
. - colorId (String.t): The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. Defaults to
nil
. - gadget (GoogleApi.Calendar.V3.Model.EventGadget.t): A gadget that extends this event. Defaults to
nil
. - visibility (String.t): Visibility of the event. Optional. Possible values are:
- "default" - Uses the default visibility for events on the calendar. This is the default value.
- "public" - The event is public and event details are visible to all readers of the calendar.
- "private" - The event is private and only event attendees may view event details.
- "confidential" - The event is private. This value is provided for compatibility reasons. Defaults to
default
. - status (String.t): Status of the event. Optional. Possible values are:
- "confirmed" - The event is confirmed. This is the default status.
- "tentative" - The event is tentatively confirmed.
- "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. A cancelled status represents two different states depending on the event type:
- Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty.
- All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely.
Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details.
If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated. Defaults to
nil
. - location (String.t): Geographic location of the event as free-form text. Optional. Defaults to
nil
. - organizer (GoogleApi.Calendar.V3.Model.EventOrganizer.t): The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event. Defaults to
nil
. - anyoneCanAddSelf (boolean()): Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. Defaults to
false
. - creator (GoogleApi.Calendar.V3.Model.EventCreator.t): The creator of the event. Read-only. Defaults to
nil
. - start (GoogleApi.Calendar.V3.Model.EventDateTime.t): The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. Defaults to
nil
. - attendees (list(GoogleApi.Calendar.V3.Model.EventAttendee.t)): The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Defaults to
nil
. - guestsCanModify (boolean()): Whether attendees other than the organizer can modify the event. Optional. The default is False. Defaults to
false
. - kind (String.t): Type of the resource ("calendar#event"). Defaults to
calendar#event
. - description (String.t): Description of the event. Optional. Defaults to
nil
. - attachments (list(GoogleApi.Calendar.V3.Model.EventAttachment.t)): File attachments for the event. Currently only Google Drive attachments are supported.
In order to modify attachments the supportsAttachments request parameter should be set to true.
There can be at most 25 attachments per event, Defaults to
nil
. - hangoutLink (String.t): An absolute link to the Google+ hangout associated with this event. Read-only. Defaults to
nil
. - conferenceData (GoogleApi.Calendar.V3.Model.ConferenceData.t): The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. Defaults to
nil
. - privateCopy (boolean()): Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. Defaults to
false
. - summary (String.t): Title of the event. Defaults to
nil
. - guestsCanSeeOtherGuests (boolean()): Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. Defaults to
true
. - reminders (GoogleApi.Calendar.V3.Model.EventReminders.t): Information about the event's reminders for the authenticated user. Defaults to
nil
. - attendeesOmitted (boolean()): Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False. Defaults to
false
. - etag (String.t): ETag of the resource. Defaults to
nil
.
Attributes
- fileId (String.t): ID of the attached file. Read-only.
For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API. Defaults to
nil
. - fileUrl (String.t): URL link to the attachment.
For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API.
Required when adding an attachment. Defaults to
nil
. - iconLink (String.t): URL link to the attachment's icon. Read-only. Defaults to
nil
. - mimeType (String.t): Internet media type (MIME type) of the attachment. Defaults to
nil
. - title (String.t): Attachment title. Defaults to
nil
.
Attributes
- additionalGuests (integer()): Number of additional guests. Optional. The default is 0. Defaults to
0
. - comment (String.t): The attendee's response comment. Optional. Defaults to
nil
. - displayName (String.t): The attendee's name, if available. Optional. Defaults to
nil
. - email (String.t): The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322.
Required when adding an attendee. Defaults to
nil
. - id (String.t): The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API Defaults to
nil
. - optional (boolean()): Whether this is an optional attendee. Optional. The default is False. Defaults to
false
. - organizer (boolean()): Whether the attendee is the organizer of the event. Read-only. The default is False. Defaults to
nil
. - resource (boolean()): Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False. Defaults to
false
. - responseStatus (String.t): The attendee's response status. Possible values are:
- "needsAction" - The attendee has not responded to the invitation.
- "declined" - The attendee has declined the invitation.
- "tentative" - The attendee has tentatively accepted the invitation.
- "accepted" - The attendee has accepted the invitation. Defaults to
nil
. - self (boolean()): Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False. Defaults to
false
.
The creator of the event. Read-only.
Attributes
- date (Date.t): The date, in the format "yyyy-mm-dd", if this is an all-day event. Defaults to
nil
. - dateTime (DateTime.t): The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone. Defaults to
nil
. - timeZone (String.t): The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end. Defaults to
nil
.
Extended properties of the event.
A gadget that extends this event.
The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.
Attributes
- method (String.t): The method used by this reminder. Possible values are:
- "email" - Reminders are sent via email.
- "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information. Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored.
- "popup" - Reminders are sent via a UI popup.
Required when adding a reminder. Defaults tonil
. - minutes (integer()): Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).
Required when adding a reminder. Defaults to
nil
.
Information about the event's reminders for the authenticated user.
Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.
Attributes
- accessRole (String.t): The user's access role for this calendar. Read-only. Possible values are:
- "none" - The user has no access.
- "freeBusyReader" - The user has read access to free/busy information.
- "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- "owner" - The user has ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs. Defaults to
nil
. - defaultReminders (list(GoogleApi.Calendar.V3.Model.EventReminder.t)): The default reminders on the calendar for the authenticated user. These reminders apply to all events on this calendar that do not explicitly override them (i.e. do not have reminders.useDefault set to True). Defaults to
nil
. - description (String.t): Description of the calendar. Read-only. Defaults to
nil
. - etag (String.t): ETag of the collection. Defaults to
nil
. - items (list(GoogleApi.Calendar.V3.Model.Event.t)): List of events on the calendar. Defaults to
nil
. - kind (String.t): Type of the collection ("calendar#events"). Defaults to
calendar#events
. - nextPageToken (String.t): Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. Defaults to
nil
. - nextSyncToken (String.t): Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. Defaults to
nil
. - summary (String.t): Title of the calendar. Read-only. Defaults to
nil
. - timeZone (String.t): The time zone of the calendar. Read-only. Defaults to
nil
. - updated (DateTime.t): Last modification time of the calendar (as a RFC3339 timestamp). Read-only. Defaults to
nil
.
Attributes
- calendarExpansionMax (integer()): Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50. Defaults to
nil
. - groupExpansionMax (integer()): Maximal number of calendar identifiers to be provided for a single group. Optional. An error is returned for a group with more members than this value. Maximum value is 100. Defaults to
nil
. - items (list(GoogleApi.Calendar.V3.Model.FreeBusyRequestItem.t)): List of calendars and/or groups to query. Defaults to
nil
. - timeMax (DateTime.t): The end of the interval for the query formatted as per RFC3339. Defaults to
nil
. - timeMin (DateTime.t): The start of the interval for the query formatted as per RFC3339. Defaults to
nil
. - timeZone (String.t): Time zone used in the response. Optional. The default is UTC. Defaults to
UTC
.
Attributes
- calendars (%{optional(String.t) => GoogleApi.Calendar.V3.Model.FreeBusyCalendar.t}): List of free/busy information for calendars. Defaults to
nil
. - groups (%{optional(String.t) => GoogleApi.Calendar.V3.Model.FreeBusyGroup.t}): Expansion of groups. Defaults to
nil
. - kind (String.t): Type of the resource ("calendar#freeBusy"). Defaults to
calendar#freeBusy
. - timeMax (DateTime.t): The end of the interval. Defaults to
nil
. - timeMin (DateTime.t): The start of the interval. Defaults to
nil
.
Attributes
- etag (String.t): ETag of the resource. Defaults to
nil
. - id (String.t): The id of the user setting. Defaults to
nil
. - kind (String.t): Type of the resource ("calendar#setting"). Defaults to
calendar#setting
. - value (String.t): Value of the user setting. The format of the value depends on the ID of the setting. It must always be a UTF-8 string of length up to 1024 characters. Defaults to
nil
.
Attributes
- etag (String.t): Etag of the collection. Defaults to
nil
. - items (list(GoogleApi.Calendar.V3.Model.Setting.t)): List of user settings. Defaults to
nil
. - kind (String.t): Type of the collection ("calendar#settings"). Defaults to
calendar#settings
. - nextPageToken (String.t): Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided. Defaults to
nil
. - nextSyncToken (String.t): Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided. Defaults to
nil
.