Google Apps Script

Class CalendarEvent

Represents a single calendar event.

Methods

MethodReturn typeBrief description
addEmailReminder(minutesBefore)CalendarEventAdds a new email reminder to the event.
addGuest(email)CalendarEventAdds a guest to the event.
addPopupReminder(minutesBefore)CalendarEventAdds a new popup reminder to the event.
addSmsReminder(minutesBefore)CalendarEventAdds a new SMS reminder to the event.
anyoneCanAddSelf()BooleanDetermines whether anyone can invite themselves.
deleteEvent()voidDeletes the event.
deleteTag(key)CalendarEventDeletes a key/value tag from the event.
getAllDayEndDate()DateGets the date on which this all-day calendar event ends.
getAllDayStartDate()DateGets the date on which this all-day calendar event begins.
getAllTagKeys()String[]Gets all keys for tags that have been set on the event.
getCreators()String[]Gets the creators of the event.
getDateCreated()DateGets the date the event was created.
getDescription()StringGets the description of the event.
getEmailReminders()Integer[]Gets the minute values for all email reminders for the event.
getEndTime()DateGets the date and time at which this calendar event ends.
getEventSeries()CalendarEventSeriesGets the series of recurring events that this event belongs to.
getGuestByEmail(email)EventGuestGets 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()StringGets the ID of the event.
getLastUpdated()DateGets the date the event was last updated.
getLocation()StringGets the location of the event.
getMyStatus()GuestStatusGets the event status (attending, etc.) of the effective user.
getOriginalCalendarId()StringGet 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()DateGets the date and time at which this calendar event begins.
getTag(key)StringGets a tag value of the event.
getTitle()StringGets the title of the event.
getVisibility()VisibilityGets the visibility of the event.
guestsCanInviteOthers()BooleanDetermines whether guests can invite other guests.
guestsCanModify()BooleanDetermines whether guests can modify the event.
guestsCanSeeGuests()BooleanDetermines whether guests can see other guests.
isAllDayEvent()BooleanDetermines whether this is an all-day event.
isOwnedByMe()BooleanDetermines whether the event is owned by the effective user.
isRecurringEvent()BooleanDetermines whether the event is part of an event series.
removeAllReminders()CalendarEventRemoves all reminders from the event.
removeGuest(email)CalendarEventRemoves a guest from the event.
resetRemindersToDefault()CalendarEventResets the reminders using the calendar's default settings.
setAllDayDate(date)CalendarEventSets the date of the event.
setAnyoneCanAddSelf(anyoneCanAddSelf)CalendarEventSets whether non-guests can add themselves to the event.
setDescription(description)CalendarEventSets the description of the event.
setGuestsCanInviteOthers(guestsCanInviteOthers)CalendarEventSets whether guests can invite other guests.
setGuestsCanModify(guestsCanModify)CalendarEventSets whether guests can modify the event.
setGuestsCanSeeGuests(guestsCanSeeGuests)CalendarEventSets whether guests can see other guests.
setLocation(location)CalendarEventSets the location of the event.
setMyStatus(status)CalendarEventSets the event status (attending, etc.) of the effective user.
setTag(key, value)CalendarEventSets a key/value tag on the event, for storing custom metadata.
setTime(startTime, endTime)CalendarEventSets the dates and times for the start and end of the event.
setTitle(title)CalendarEventSets the title of the event.
setVisibility(visibility)CalendarEventSets 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

NameTypeDescription
minutesBeforeIntegerthe number of minutes before the event

Return

CalendarEvent — this CalendarEvent for chaining


addGuest(email)

Adds a guest to the event.

Parameters

NameTypeDescription
emailStringthe email address of the guest

Return

CalendarEvent — this CalendarEvent for chaining


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

NameTypeDescription
minutesBeforeIntegerthe number of minutes before the event

Return

CalendarEvent — this CalendarEvent for chaining


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

NameTypeDescription
minutesBeforeIntegerthe number of minutes before the event

Return

CalendarEvent — this CalendarEvent for chaining


anyoneCanAddSelf()

Determines whether anyone can invite themselves.

Return

Booleantrue if non-guests can add themselves to the event; false if not


deleteEvent()

Deletes the event.


deleteTag(key)

Deletes a key/value tag from the event.

Parameters

NameTypeDescription
keyStringthe tag key

Return

CalendarEvent — this CalendarEvent for chaining


getAllDayEndDate()

Gets the date on which this all-day calendar event ends. (If this is not an all-day event, then this method will throw an exception.) The returned Date will represent 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


getAllDayStartDate()

Gets the date on which this all-day calendar event begins. (If this is not an all-day event, then this method will throw an exception.) The returned Date will represent 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


getAllTagKeys()

Gets all keys for tags that have been set on the event.

Return

String[] — an array of string keys


getCreators()

Gets the creators of the event.

Return

String[] — the email addresses of the event's creators


getDateCreated()

Gets the date the event was created.

Return

Date — the date of creation


getDescription()

Gets the description of the event.

Return

String — the description


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 will trigger


getEndTime()

Gets the date and time at which this calendar event ends. For non–all-day events, this will be 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 will be 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 will 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


getEventSeries()

Gets the series of recurring events that this event belongs to. A CalendarEventSeries object will be 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


getGuestByEmail(email)

Gets a guest by email address.

Parameters

NameTypeDescription
emailStringthe address of the guest

Return

EventGuest — the guest, or null if the email address does not correspond to a guest


getGuestList()

Gets the guests for the event, not including the event owner.

Return

EventGuest[] — an array of the guests


getGuestList(includeOwner)

Gets the guests for the event, potentially including the event owners.

Parameters

NameTypeDescription
includeOwnerBooleanwhether to include the owners as a guest

Return

EventGuest[] — an array of the guests


getId()

Gets the ID of the event.

Return

String — the ID of the event


getLastUpdated()

Gets the date the event was last updated.

Return

Date — the last updated date


getLocation()

Gets the location of the event.

Return

String — the event location


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


getOriginalCalendarId()

Get the ID of the calendar where this event was originally created.

Return

String — the ID of the original calendar


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 will trigger


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 will trigger


getStartTime()

Gets the date and time at which this calendar event begins. For non–all-day events, this will be 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 will be 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 will 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


getTag(key)

Gets a tag value of the event.

Parameters

NameTypeDescription
keyStringthe key

Return

String — the tag value


getTitle()

Gets the title of the event.

Return

String — the title


getVisibility()

Gets the visibility of the event.

Return

Visibility — the visibility value


guestsCanInviteOthers()

Determines whether guests can invite other guests.

Return

Booleantrue if guests can invite others; false if not


guestsCanModify()

Determines whether guests can modify the event.

Return

Booleantrue if guests can modify the event; false if not


guestsCanSeeGuests()

Determines whether guests can see other guests.

Return

Booleantrue if guests can see other guests; false if not


isAllDayEvent()

Determines whether this is an all-day event.

Return

Booleantrue if the event is all-day; false if not


isOwnedByMe()

Determines whether the event is owned by the effective user.

Return

Booleantrue if the event is owned by the effective user; false if not


isRecurringEvent()

Determines whether the event is part of an event series.

Return

Booleantrue if the event is part of an event series; false if not


removeAllReminders()

Removes all reminders from the event.

Return

CalendarEvent — this CalendarEvent for chaining


removeGuest(email)

Removes a guest from the event.

Parameters

NameTypeDescription
emailStringthe email address of the guest

Return

CalendarEvent — this CalendarEvent for chaining


resetRemindersToDefault()

Resets the reminders using the calendar's default settings.

Return

CalendarEvent — this CalendarEvent for chaining


setAllDayDate(date)

Sets the date of the event. Applying this method will change a regular event into an all-day event.

Parameters

NameTypeDescription
dateDatethe date for the event (the time is ignored)

Return

CalendarEvent — this CalendarEvent for chaining


setAnyoneCanAddSelf(anyoneCanAddSelf)

Sets whether non-guests can add themselves to the event.

Parameters

NameTypeDescription
anyoneCanAddSelfBooleanwhether anyone can invite themselves

Return

CalendarEvent — this CalendarEvent for chaining


setDescription(description)

Sets the description of the event.

Parameters

NameTypeDescription
descriptionStringthe new description

Return

CalendarEvent — this CalendarEvent for chaining


setGuestsCanInviteOthers(guestsCanInviteOthers)

Sets whether guests can invite other guests.

Parameters

NameTypeDescription
guestsCanInviteOthersBooleanwhether guests can invite others

Return

CalendarEvent — this CalendarEvent for chaining


setGuestsCanModify(guestsCanModify)

Sets whether guests can modify the event.

Parameters

NameTypeDescription
guestsCanModifyBooleanwhether guests can modify the event

Return

CalendarEvent — this CalendarEvent for chaining


setGuestsCanSeeGuests(guestsCanSeeGuests)

Sets whether guests can see other guests.

Parameters

NameTypeDescription
guestsCanSeeGuestsBooleanwhether guests can see others

Return

CalendarEvent — this CalendarEvent for chaining


setLocation(location)

Sets the location of the event.

Parameters

NameTypeDescription
locationStringthe new location

Return

CalendarEvent — this CalendarEvent for chaining


setMyStatus(status)

Sets the event status (attending, etc.) of the effective user.

Parameters

NameTypeDescription
statusGuestStatusthe new status

Return

CalendarEvent — this CalendarEvent for chaining


setTag(key, value)

Sets a key/value tag on the event, for storing custom metadata.

Parameters

NameTypeDescription
keyStringthe tag key
valueStringthe tag value

Return

CalendarEvent — this CalendarEvent for chaining


setTime(startTime, endTime)

Sets the dates and times for the start and end of the event. Applying this method will change an all-day event into a regular event.

Parameters

NameTypeDescription
startTimeDatethe new start of the event
endTimeDatethe new end of the event

Return

CalendarEvent — this CalendarEvent for chaining


setTitle(title)

Sets the title of the event.

Parameters

NameTypeDescription
titleStringthe new title

Return

CalendarEvent — this CalendarEvent for chaining


setVisibility(visibility)

Sets the visibility of the event.

Parameters

NameTypeDescription
visibilityVisibility

Return

CalendarEvent — this CalendarEvent for chaining

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.