Class EventRecurrence

  • EventRecurrence allows you to define how an event series repeats over time, such as daily, weekly, monthly, or yearly.

  • You can set specific rules for recurrence, including exclusions for certain dates or days.

  • EventRecurrence provides methods to control the frequency, duration, and time zone of the recurrence pattern.

  • Recurrence rules can be customized further by specifying conditions like "only on weekdays" or "only on month days".

  • Using EventRecurrence, you can automate the creation of recurring events in Google Calendar, simplifying scheduling tasks.
EventRecurrence

Represents the recurrence settings for an event series.

Methods

MethodReturn typeBrief description
addDailyExclusion() RecurrenceRule Adds a rule that excludes occurrences on a daily basis.
addDailyRule() RecurrenceRule Adds a rule that causes the event to recur on a daily basis.
addDate(date) EventRecurrence Adds a rule that causes the event to recur on a specific date.
addDateExclusion(date) EventRecurrence Adds a rule that excludes an occurrence for a specific date.
addMonthlyExclusion() RecurrenceRule Adds a rule that excludes occurrences on a monthly basis.
addMonthlyRule() RecurrenceRule Adds a rule that causes the event to recur on a monthly basis.
addWeeklyExclusion() RecurrenceRule Adds a rule that excludes occurrences on a weekly basis.
addWeeklyRule() RecurrenceRule Adds a rule that causes the event to recur on a weekly basis.
addYearlyExclusion() RecurrenceRule Adds a rule that excludes occurrences on a yearly basis.
addYearlyRule() RecurrenceRule Adds a rule that causes the event to recur on a yearly basis.
setTimeZone(timeZone) EventRecurrence Sets the time zone for this recurrence.

Detailed documentation

addDailyExclusion()

Adds a rule that excludes occurrences on a daily basis. 

// Creates a rule that recurs every week after the first 30 days.
constrecurrence=
CalendarApp.newRecurrence().addWeeklyRule().addDailyExclusion().times(30);

Return

RecurrenceRule — the new RecurrenceRule

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

addDailyRule()

Adds a rule that causes the event to recur on a daily basis. 

// Creates a rule that recurs every day for ten days.
constrecurrence=CalendarApp.newRecurrence().addDailyRule().times(10);

Return

RecurrenceRule — the new RecurrenceRule

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

addDate(date)

Adds a rule that causes the event to recur on a specific date.

Parameters

NameTypeDescription
dateDate

Return

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

addDateExclusion(date)

Adds a rule that excludes an occurrence for a specific date.

Parameters

NameTypeDescription
dateDate

Return

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

addMonthlyExclusion()

Adds a rule that excludes occurrences on a monthly basis.

By default the exclusion is applied on the same day of the month as the first event in the series, but this can be altered by calling RecurrenceRule.onlyOnMonthDay(day) or RecurrenceRule.onlyOnMonthDays(days) .

Return

RecurrenceRule — the new RecurrenceRule

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

addMonthlyRule()

Adds a rule that causes the event to recur on a monthly basis.

By default the event recurs on the same day of the month as the first event in the series, but this can be altered by calling RecurrenceRule.onlyOnMonthDay(day) or RecurrenceRule.onlyOnMonthDays(days) . 

// Creates a rule that recurs every month for three months.
constrecurrence=CalendarApp.newRecurrence().addMonthlyRule().times(4);

Return

RecurrenceRule — the new RecurrenceRule

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

addWeeklyExclusion()

Adds a rule that excludes occurrences on a weekly basis.

By default the exclusion is applied on the same day of the week as the first event in the series, but this can be altered by calling RecurrenceRule.onlyOnWeekday(day) or RecurrenceRule.onlyOnWeekdays(days) . 

// Creates a rule that recurs every day except the first four Wednesdays.
constrecurrence=CalendarApp.newRecurrence()
.addDailyRule()
.addWeeklyExclusion()
.onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
.times(4);

Return

RecurrenceRule — the new RecurrenceRule

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

addWeeklyRule()

Adds a rule that causes the event to recur on a weekly basis.

By default the event recurs on the same day of the week as the first event in the series, but this can be altered by calling RecurrenceRule.onlyOnWeekday(day) or RecurrenceRule.onlyOnWeekdays(days) . 

// Creates a rule that recurs every week for ten weeks.
constrecurrence=CalendarApp.newRecurrence().addWeeklyRule().times(10);

Return

RecurrenceRule — the new RecurrenceRule

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

addYearlyExclusion()

Adds a rule that excludes occurrences on a yearly basis.

By default the exclusion is applied on the same day of the year as the first event in the series, but this can be altered by calling RecurrenceRule.onlyOnYearDay(day) or RecurrenceRule.onlyOnYearDays(days) .

Return

RecurrenceRule — the new RecurrenceRule

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

addYearlyRule()

Adds a rule that causes the event to recur on a yearly basis.

By default the event recurs on the same day of the year as the first event in the series, but this can be altered by calling RecurrenceRule.onlyOnYearDay(day) or RecurrenceRule.onlyOnYearDays(days) .

Return

RecurrenceRule — the new RecurrenceRule

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

setTimeZone(timeZone)

Sets the time zone for this recurrence. This affects the date and time that events recur on, and whether the event shifts with daylight savings time. Defaults to the calendar's time zone.

Parameters

NameTypeDescription
timeZoneStringthe time zone, specified in "long" format (e.g., 'America/New_York', as listed by Joda.org)

Return

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

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024年12月03日 UTC.