Google Apps Script

Class CalendarEventSeries

Represents a series of events (a recurring event).

Methods

MethodReturn typeBrief description
addEmailReminder(minutesBefore)CalendarEventSeriesAdds a new email reminder to the event.
addGuest(email)CalendarEventSeriesAdds a guest to the event.
addPopupReminder(minutesBefore)CalendarEventSeriesAdds a new popup reminder to the event.
addSmsReminder(minutesBefore)CalendarEventSeriesAdds a new SMS reminder to the event.
anyoneCanAddSelf()BooleanDetermines whether anyone can invite themselves.
deleteEventSeries()voidDeletes the event series.
deleteTag(key)CalendarEventSeriesDeletes a key/value tag from the event.
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.
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.
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.
isOwnedByMe()BooleanDetermines whether the event is owned by the effective user.
removeAllReminders()CalendarEventSeriesRemoves all reminders from the event.
removeGuest(email)CalendarEventSeriesRemoves a guest from the event.
resetRemindersToDefault()CalendarEventSeriesResets the reminders using the calendar's default settings.
setAnyoneCanAddSelf(anyoneCanAddSelf)CalendarEventSeriesSets whether non-guests can add themselves to the event.
setDescription(description)CalendarEventSeriesSets the description of the event.
setGuestsCanInviteOthers(guestsCanInviteOthers)CalendarEventSeriesSets whether guests can invite other guests.
setGuestsCanModify(guestsCanModify)CalendarEventSeriesSets whether guests can modify the event.
setGuestsCanSeeGuests(guestsCanSeeGuests)CalendarEventSeriesSets whether guests can see other guests.
setLocation(location)CalendarEventSeriesSets the location of the event.
setMyStatus(status)CalendarEventSeriesSets the event status (attending, etc.) of the effective user.
setRecurrence(recurrence, startDate)CalendarEventSeriesSets the recurrence rules for an all-day event series.
setRecurrence(recurrence, startTime, endTime)CalendarEventSeriesSets the recurrence rules for this event series.
setTag(key, value)CalendarEventSeriesSets a key/value tag on the event, for storing custom metadata.
setTitle(title)CalendarEventSeriesSets the title of the event.
setVisibility(visibility)CalendarEventSeriesSets 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

CalendarEventSeries — this CalendarEventSeries for chaining


addGuest(email)

Adds a guest to the event.

Parameters

NameTypeDescription
emailStringthe email address of the guest

Return

CalendarEventSeries — this CalendarEventSeries 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

CalendarEventSeries — this CalendarEventSeries 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

CalendarEventSeries — this CalendarEventSeries for chaining


anyoneCanAddSelf()

Determines whether anyone can invite themselves.

Return

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


deleteEventSeries()

Deletes the event series.


deleteTag(key)

Deletes a key/value tag from the event.

Parameters

NameTypeDescription
keyStringthe tag key

Return

CalendarEventSeries — this CalendarEventSeries for chaining


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


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.

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


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


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


removeAllReminders()

Removes all reminders from the event.

Return

CalendarEventSeries — this CalendarEventSeries for chaining


removeGuest(email)

Removes a guest from the event.

Parameters

NameTypeDescription
emailStringthe email address of the guest

Return

CalendarEventSeries — this CalendarEventSeries for chaining


resetRemindersToDefault()

Resets the reminders using the calendar's default settings.

Return

CalendarEventSeries — this CalendarEventSeries for chaining


setAnyoneCanAddSelf(anyoneCanAddSelf)

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

Parameters

NameTypeDescription
anyoneCanAddSelfBooleanwhether anyone can invite themselves

Return

CalendarEventSeries — this CalendarEventSeries for chaining


setDescription(description)

Sets the description of the event.

Parameters

NameTypeDescription
descriptionStringthe new description

Return

CalendarEventSeries — this CalendarEventSeries for chaining


setGuestsCanInviteOthers(guestsCanInviteOthers)

Sets whether guests can invite other guests.

Parameters

NameTypeDescription
guestsCanInviteOthersBooleanwhether guests can invite others

Return

CalendarEventSeries — this CalendarEventSeries for chaining


setGuestsCanModify(guestsCanModify)

Sets whether guests can modify the event.

Parameters

NameTypeDescription
guestsCanModifyBooleanwhether guests can modify the event

Return

CalendarEventSeries — this CalendarEventSeries for chaining


setGuestsCanSeeGuests(guestsCanSeeGuests)

Sets whether guests can see other guests.

Parameters

NameTypeDescription
guestsCanSeeGuestsBooleanwhether guests can see others

Return

CalendarEventSeries — this CalendarEventSeries for chaining


setLocation(location)

Sets the location of the event.

Parameters

NameTypeDescription
locationStringthe new location

Return

CalendarEventSeries — this CalendarEventSeries for chaining


setMyStatus(status)

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

Parameters

NameTypeDescription
statusGuestStatusthe new status

Return

CalendarEventSeries — this CalendarEventSeries for chaining


setRecurrence(recurrence, startDate)

Sets the recurrence rules for an all-day event series. Applying this method will change a regular event series into an all-day event series.

 
// Sets the events in a series to take place every Wednesday in 2013.
 var eventSeries = CalendarApp.getDefaultCalendar().getEventSeriesById('123456789@google.com');
 var startDate = new Date('January 2, 2013 03:00:00 PM EST');
 var recurrence = CalendarApp.newRecurrence().addWeeklyRule()
     .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
     .until(new Date('January 1, 2014'));
 eventSeries.setRecurrence(recurrence, startDate);
 

Parameters

NameTypeDescription
recurrenceEventRecurrencethe recurrence rules to use
startDateDatethe date of the first event in the series (only the day is used; the time is ignored)

Return

CalendarEventSeries — this CalendarEventSeries for chaining


setRecurrence(recurrence, startTime, endTime)

Sets the recurrence rules for this event series. Applying this method will change an all-day event series into a regular event series.

 
// Sets the events in a series to take place from 3pm to 4pm every Tuesday and Thursday in
 // 2013.
 var eventSeries = CalendarApp.getDefaultCalendar().getEventSeriesById('123456789@google.com');
 var startTime = new Date('January 1, 2013 03:00:00 PM EST');
 var endTime = new Date('January 1, 2013 04:00:00 PM EST');
 var recurrence = CalendarApp.newRecurrence().addWeeklyRule()
      .onlyOnWeekdays([CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY])
      .until(new Date('January 1, 2014'));
 eventSeries.setRecurrence(recurrence, startTime, endTime);
 

Parameters

NameTypeDescription
recurrenceEventRecurrencethe recurrence rules to use
startTimeDatethe date and time when the first event in the series starts
endTimeDatethe date and time when the first event in the series ends

Return

CalendarEventSeries — this CalendarEventSeries 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

CalendarEventSeries — this CalendarEventSeries for chaining


setTitle(title)

Sets the title of the event.

Parameters

NameTypeDescription
titleStringthe new title

Return

CalendarEventSeries — this CalendarEventSeries for chaining


setVisibility(visibility)

Sets the visibility of the event.

Parameters

NameTypeDescription
visibilityVisibility

Return

CalendarEventSeries — this CalendarEventSeries 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.