gcal.updateeventprops
Home > @runlightyear/gcal > UpdateEventProps
UpdateEventProps interface
Signature:interface UpdateEventProps
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 | EventResourceInput | 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" | Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false. 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. Warning: Using the value none can have significant adverse effects, including events not syncing to external calendars or events being lost altogether for some users. 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. |