gcal.patcheventprops
Home > @runlightyear/gcal > PatchEventProps
PatchEventProps interface
Signature:interface PatchEventProps
Required Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| calendarId | "primary" | string | 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. | |
| event | EventResourcePatchInput | The new event data | |
| eventId | string | Event identifier. |
Optional Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| conferenceDataVersion? | number | Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. Acceptable values are 0 to 1, inclusive. | |
| maxAttendees? | number | 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. | |
| sendUpdates? | "all" | "externalOnly" | "none" | Guests who should receive notifications about the event update (for example, title changes, etc.). Acceptable values are: "all": Notifications are sent to all guests. "externalOnly": Notifications are sent to non-Google Calendar guests only. "none": No notifications are sent. For calendar migration tasks, consider using the Events.import method instead. | |
| supportsAttachments? | boolean | Whether API client performing operation supports event attachments. Optional. The default is False. |