gcal.deleteeventprops
Home > @runlightyear/gcal > DeleteEventProps
DeleteEventProps interface
Signature:interface DeleteEventProps
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. | |
| eventId | string | Event identifier. |
Optional Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| sendNotifications? | boolean | Deprecated. Please use sendUpdates instead. Whether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false. | |
| sendUpdates? | "all" | "externalOnly" | "none" | Guests who should receive notifications about the deletion of the event. 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. |