Represents a single calendar event.
Methods
| Method | Return type | Brief description |
|---|---|---|
addEmailReminder(minutesBefore) | CalendarEvent | Adds a new email reminder to the event. |
addGuest(email) | CalendarEvent | Adds a guest to the event. |
addPopupReminder(minutesBefore) | CalendarEvent | Adds a new popup reminder to the event. |
addSmsReminder(minutesBefore) | CalendarEvent | Adds a new SMS reminder to the event. |
anyoneCanAddSelf() | Boolean | Determines whether anyone can invite themselves. |
deleteEvent() | void | Deletes the event. |
deleteTag(key) | CalendarEvent | Deletes a key/value tag from the event. |
getAllDayEndDate() | Date | Gets the date on which this all-day calendar event ends. |
getAllDayStartDate() | Date | Gets the date on which this all-day calendar event begins. |
getAllTagKeys() | String[] | Gets all keys for tags that have been set on the event. |
getColor() | String | Returns the color of the calendar event. |
getCreators() | String[] | Gets the creators of the event. |
getDateCreated() | Date | Gets the date the event was created. |
getDescription() | String | Gets the description of the event. |
getEmailReminders() | Integer[] | Gets the minute values for all email reminders for the event. |
getEndTime() | Date | Gets the date and time at which this calendar event ends. |
getEventSeries() | CalendarEventSeries | Gets the series of recurring events that this event belongs to. |
getGuestByEmail(email) | EventGuest | Gets a guest by email address. |
getGuestList() | EventGuest[] | Gets the guests for the event, not including the event owner. |
getGuestList(includeOwner) | EventGuest[] | Gets the guests for the event, potentially including the event owners. |
getId() | String | Gets the unique iCalUID of the event. |
getLastUpdated() | Date | Gets the date the event was last updated. |
getLocation() | String | Gets the location of the event. |
getMyStatus() | GuestStatus | Gets the event status (attending, etc.) of the effective user. |
getOriginalCalendarId() | String | Get the ID of the calendar where this event was originally created. |
getPopupReminders() | Integer[] | Gets the minute values for all popup reminders for the event. |
getSmsReminders() | Integer[] | Gets the minute values for all SMS reminders for the event. |
getStartTime() | Date | Gets the date and time at which this calendar event begins. |
getTag(key) | String | Gets a tag value of the event. |
getTitle() | String | Gets the title of the event. |
getVisibility() | Visibility | Gets the visibility of the event. |
guestsCanInviteOthers() | Boolean | Determines whether guests can invite other guests. |
guestsCanModify() | Boolean | Determines whether guests can modify the event. |
guestsCanSeeGuests() | Boolean | Determines whether guests can see other guests. |
isAllDayEvent() | Boolean | Determines whether this is an all-day event. |
isOwnedByMe() | Boolean | Determines whether the event is owned by the effective user. |
isRecurringEvent() | Boolean | Determines whether the event is part of an event series. |
removeAllReminders() | CalendarEvent | Removes all reminders from the event. |
removeGuest(email) | CalendarEvent | Removes a guest from the event. |
resetRemindersToDefault() | CalendarEvent | Resets the reminders using the calendar's default settings. |
setAllDayDate(date) | CalendarEvent | Sets the date of the event. |
setAllDayDates(startDate, endDate) | CalendarEvent | Sets the dates of the event. |
setAnyoneCanAddSelf(anyoneCanAddSelf) | CalendarEvent | Sets whether non-guests can add themselves to the event. |
setColor(color) | CalendarEvent | Sets the color of the calendar event. |
setDescription(description) | CalendarEvent | Sets the description of the event. |
setGuestsCanInviteOthers(guestsCanInviteOthers) | CalendarEvent | Sets whether guests can invite other guests. |
setGuestsCanModify(guestsCanModify) | CalendarEvent | Sets whether guests can modify the event. |
setGuestsCanSeeGuests(guestsCanSeeGuests) | CalendarEvent | Sets whether guests can see other guests. |
setLocation(location) | CalendarEvent | Sets the location of the event. |
setMyStatus(status) | CalendarEvent | Sets the event status (attending, etc.) of the effective user. |
setTag(key, value) | CalendarEvent | Sets a key/value tag on the event, for storing custom metadata. |
setTime(startTime, endTime) | CalendarEvent | Sets the dates and times for the start and end of the event. |
setTitle(title) | CalendarEvent | Sets the title of the event. |
setVisibility(visibility) | CalendarEvent | Sets the visibility of the event. |
Detailed documentation
addEmailReminder(minutesBefore)
Adds a new email reminder to the event. The reminder must be at least 5 minutes, and at most 4 weeks (40320 minutes), before the event.
Parameters
| Name | Type | Description |
|---|---|---|
minutesBefore | Integer | the number of minutes before the event |
Return
CalendarEvent — this CalendarEvent for chaining
Throws
Error — if there are more than 5 reminders on the event or the time is not
within the legal range
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
addGuest(email)
Adds a guest to the event.
Parameters
| Name | Type | Description |
|---|---|---|
email | String | the email address of the guest |
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
addPopupReminder(minutesBefore)
Adds a new popup reminder to the event. The reminder must be at least 5 minutes, and at most 4 weeks (40320 minutes), before the event.
Parameters
| Name | Type | Description |
|---|---|---|
minutesBefore | Integer | the number of minutes before the event |
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
addSmsReminder(minutesBefore)
Adds a new SMS reminder to the event. The reminder must be at least 5 minutes, and at most 4 weeks (40320 minutes), before the event.
Parameters
| Name | Type | Description |
|---|---|---|
minutesBefore | Integer | the number of minutes before the event |
Return
CalendarEvent — this CalendarEvent for chaining
Throws
Error — if there are more than 5 reminders on the event or the time is not
within the legal range
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
anyoneCanAddSelf()
Determines whether anyone can invite themselves.
Return
Boolean — true if non-guests can add themselves to the event; false if not
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
deleteEvent()
Deletes the event.
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
deleteTag(key)
Deletes a key/value tag from the event.
Parameters
| Name | Type | Description |
|---|---|---|
key | String | the tag key |
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
getAllDayEndDate()
Gets the date on which this all-day calendar event ends. (If this is not an all-day event, then
this method throws an exception.) The returned Date represents midnight at the
beginning of the day after the event ends in the script's time zone. To use the
calendar's time zone instead, call getEndTime().
Return
Date — this all-day calendar event's end date
Throws
Error — if this event is not an all-day event
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getAllDayStartDate()
Gets the date on which this all-day calendar event begins. (If this is not an all-day event,
then this method throws an exception.) The returned Date represents midnight at the
beginning of the day on which the event starts in the script's time zone. To use the
calendar's time zone instead, call getStartTime().
Return
Date — this all-day calendar event's start date
Throws
Error — if this event is not an all-day event
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getAllTagKeys()
Gets all keys for tags that have been set on the event.
Return
String[] — an array of string keys
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getColor()
Returns the color of the calendar event.
Return
String — the string representation of the event color, as an index (1-11) of values from CalendarApp.EventColors
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getCreators()
Gets the creators of the event.
Return
String[] — the email addresses of the event's creators
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getDateCreated()
Gets the date the event was created.
Return
Date — the date of creation
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getDescription()
Gets the description of the event.
Return
String — the description
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getEmailReminders()
Gets the minute values for all email reminders for the event.
Return
Integer[] — an array in which each value corresponds to the number of minutes before the event that
a reminder triggers
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getEndTime()
Gets the date and time at which this calendar event ends. For non–all-day events, this is the instant in time at which the event was defined to end. For all-day events, which only store an end date (not a date and time), this is midnight at the beginning of the day after the event ends in the calendar's time zone. This allows meaningful comparison of end times for all types of events; however, it does not necessarily preserve the original day-of-year unmodified.
For all-day events, getAllDayEndDate() should almost
always be called in preference to this method.
Return
Date — this calendar event's end time
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getEventSeries()
Gets the series of recurring events that this event belongs to. A CalendarEventSeries
object is returned even if this event doesn't belong to a series, so that you can add new
recurrence settings.
Return
CalendarEventSeries — the event series this event belongs to, or a new event series if it does not yet belong
to a series
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getGuestByEmail(email)
Gets a guest by email address.
Parameters
| Name | Type | Description |
|---|---|---|
email | String | the address of the guest |
Return
EventGuest — the guest, or null if the email address does not correspond to a guest
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
getGuestList()
Gets the guests for the event, not including the event owner.
Return
EventGuest[] — an array of the guests
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getGuestList(includeOwner)
Gets the guests for the event, potentially including the event owners.
Parameters
| Name | Type | Description |
|---|---|---|
includeOwner | Boolean | whether to include the owners as a guest |
Return
EventGuest[] — an array of the guests
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getId()
Gets the unique iCalUID of the event. Note that the iCalUID and the event id used by the Calendar v3 API and Calendar advanced service are not identical and
cannot be used interchangebly. 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.
Return
String — the iCalUID of the event
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getLastUpdated()
Gets the date the event was last updated.
Return
Date — the last updated date
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getLocation()
Gets the location of the event.
Return
String — the event location
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getMyStatus()
Gets the event status (attending, etc.) of the effective user. Always returns GuestStatus.OWNER if the effective user is the owner of the event.
Return
GuestStatus — the status
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getOriginalCalendarId()
Get the ID of the calendar where this event was originally created.
Return
String — the ID of the original calendar
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getPopupReminders()
Gets the minute values for all popup reminders for the event.
Return
Integer[] — an array in which each value corresponds to the number of minutes before the event that
a reminder triggers
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getSmsReminders()
Gets the minute values for all SMS reminders for the event.
Return
Integer[] — an array in which each value corresponds to the number of minutes before the event that
a reminder triggers
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getStartTime()
Gets the date and time at which this calendar event begins. For non–all-day events, this is the instant in time at which the event was defined to start. For all-day events, which only store a start date (not a date and time), this is midnight at the beginning of the day on which the event starts in the calendar's time zone. This allows meaningful comparison of start times for all types of events; however, it is not necessarily preserve the original day-of-year unmodified.
For all-day events, getAllDayStartDate() should
almost always be called in preference to this method.
Return
Date — this calendar event's start time
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getTag(key)
Gets a tag value of the event.
Parameters
| Name | Type | Description |
|---|---|---|
key | String | the key |
Return
String — the tag value
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getTitle()
Gets the title of the event.
Return
String — the title
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
getVisibility()
Gets the visibility of the event.
Return
Visibility — the visibility value
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
guestsCanInviteOthers()
Determines whether guests can invite other guests.
Return
Boolean — true if guests can invite others; false if not
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
guestsCanModify()
Determines whether guests can modify the event.
Return
Boolean — true if guests can modify the event; false if not
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
guestsCanSeeGuests()
Determines whether guests can see other guests.
Return
Boolean — true if guests can see other guests; false if not
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
isAllDayEvent()
Determines whether this is an all-day event.
Return
Boolean — true if the event is all-day; false if not
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
isOwnedByMe()
Determines whether the event is owned by the effective user.
Return
Boolean — true if the event is owned by the effective user; false if not
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
isRecurringEvent()
Determines whether the event is part of an event series.
Return
Boolean — true if the event is part of an event series; false if not
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
removeAllReminders()
Removes all reminders from the event.
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
removeGuest(email)
Removes a guest from the event.
Parameters
| Name | Type | Description |
|---|---|---|
email | String | the email address of the guest |
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
resetRemindersToDefault()
Resets the reminders using the calendar's default settings.
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
setAllDayDate(date)
Sets the date of the event. Applying this method changes a regular event into an all-day event.
Parameters
| Name | Type | Description |
|---|---|---|
date | Date | the date for the event (the time is ignored) |
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
setAllDayDates(startDate, endDate)
Sets the dates of the event. Applying this method changes a regular event into an all-day event.
Parameters
| Name | Type | Description |
|---|---|---|
startDate | Date | the date when the event starts (the time is ignored) |
endDate | Date | the date when the event ends (the time is ignored) |
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
setAnyoneCanAddSelf(anyoneCanAddSelf)
Sets whether non-guests can add themselves to the event.
Parameters
| Name | Type | Description |
|---|---|---|
anyoneCanAddSelf | Boolean | whether anyone can invite themselves |
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
setColor(color)
Sets the color of the calendar event.
Parameters
| Name | Type | Description |
|---|---|---|
color | String | an integer color index as a string, or a value from CalendarApp.EventColors |
Return
CalendarEvent — this calendar event, for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
setDescription(description)
Sets the description of the event.
Parameters
| Name | Type | Description |
|---|---|---|
description | String | the new description |
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
setGuestsCanInviteOthers(guestsCanInviteOthers)
Sets whether guests can invite other guests.
Parameters
| Name | Type | Description |
|---|---|---|
guestsCanInviteOthers | Boolean | whether guests can invite others |
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
setGuestsCanModify(guestsCanModify)
Sets whether guests can modify the event.
Parameters
| Name | Type | Description |
|---|---|---|
guestsCanModify | Boolean | whether guests can modify the event |
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
setGuestsCanSeeGuests(guestsCanSeeGuests)
Sets whether guests can see other guests.
Parameters
| Name | Type | Description |
|---|---|---|
guestsCanSeeGuests | Boolean | whether guests can see others |
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
setLocation(location)
Sets the location of the event.
Parameters
| Name | Type | Description |
|---|---|---|
location | String | the new location |
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
setMyStatus(status)
Sets the event status (attending, etc.) of the effective user.
Parameters
| Name | Type | Description |
|---|---|---|
status | GuestStatus | the new status |
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.googleapis.com/auth/calendar.readonly -
https://www.google.com/calendar/feeds
setTag(key, value)
Sets a key/value tag on the event, for storing custom metadata.
Parameters
| Name | Type | Description |
|---|---|---|
key | String | the tag key |
value | String | the tag value |
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
setTime(startTime, endTime)
Sets the dates and times for the start and end of the event. Applying this method changes an all-day event into a regular event.
Parameters
| Name | Type | Description |
|---|---|---|
startTime | Date | the new start of the event |
endTime | Date | the new end of the event |
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
setTitle(title)
Sets the title of the event.
Parameters
| Name | Type | Description |
|---|---|---|
title | String | the new title |
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds
setVisibility(visibility)
Sets the visibility of the event.
Parameters
| Name | Type | Description |
|---|---|---|
visibility | Visibility |
Return
CalendarEvent — this CalendarEvent for chaining
Authorization
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
-
https://www.googleapis.com/auth/calendar -
https://www.google.com/calendar/feeds