此页面由 Cloud Translation API 翻译。

Class RecurrenceRule

表示系列活动的重复发生规则。

请注意，此类的行为也与其所属的 EventRecurrence 类似，因此您可以将规则创建串联起来，如下所示：

const recurrence = CalendarApp.newRecurrence().addDailyRule().times(3).interval(2).addWeeklyExclusion().times(2);

times(times) 和 interval(interval) 等修饰符会应用于最近添加的规则。

方法

方法	返回类型	简介
`addDailyExclusion()`	`RecurrenceRule`	添加一个用于排除每日发生的事件的规则。
`addDailyRule()`	`RecurrenceRule`	添加一个规则，使活动每天重复。
`addDate(date)`	`EventRecurrence`	添加一个规则，使活动在特定日期重复。
`addDateExclusion(date)`	`EventRecurrence`	添加一个用于排除特定日期的出现情况的规则。
`addMonthlyExclusion()`	`RecurrenceRule`	添加一个用于排除按月发生的事件的规则。
`addMonthlyRule()`	`RecurrenceRule`	添加一个规则，使事件每月重复一次。
`addWeeklyExclusion()`	`RecurrenceRule`	添加一个用于排除每周发生的事件的规则。
`addWeeklyRule()`	`RecurrenceRule`	添加一个规则，使活动每周重复。
`addYearlyExclusion()`	`RecurrenceRule`	添加一个用于排除每年发生的事件的规则。
`addYearlyRule()`	`RecurrenceRule`	添加一个规则，使活动每年重复。
`interval(interval)`	`RecurrenceRule`	将规则配置为仅在规则的时间单位的此时间间隔内应用。
`onlyInMonth(month)`	`RecurrenceRule`	将规则配置为仅适用于特定月份。
`onlyInMonths(months)`	`RecurrenceRule`	将规则配置为仅应用于特定月份。
`onlyOnMonthDay(day)`	`RecurrenceRule`	将规则配置为仅应用于每月的特定日期。
`onlyOnMonthDays(days)`	`RecurrenceRule`	将规则配置为仅应用于当月的特定日期。
`onlyOnWeek(week)`	`RecurrenceRule`	将规则配置为仅适用于一年中的特定一周。
`onlyOnWeekday(day)`	`RecurrenceRule`	将规则配置为仅应用于一周中的特定一天。
`onlyOnWeekdays(days)`	`RecurrenceRule`	将规则配置为仅应用于一周中的特定几天。
`onlyOnWeeks(weeks)`	`RecurrenceRule`	将规则配置为仅适用于一年中的特定周。
`onlyOnYearDay(day)`	`RecurrenceRule`	将规则配置为仅适用于一年中的特定日期。
`onlyOnYearDays(days)`	`RecurrenceRule`	将规则配置为仅适用于一年中的特定日期。
`setTimeZone(timeZone)`	`EventRecurrence`	设置此重复设置的时区。
`times(times)`	`RecurrenceRule`	将规则配置为在发生给定次数后结束。
`until(endDate)`	`RecurrenceRule`	将规则配置为在指定日期（包括该日期）结束。
`weekStartsOn(day)`	`RecurrenceRule`	配置一周的开始日期，以便应用规则。

详细文档

`addDailyExclusion()`

添加一个用于排除每天发生的事件的规则。

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

RecurrenceRule - 新的 RecurrenceRule

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds

`addDailyRule()`

添加一个规则，使活动每天重复。

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

RecurrenceRule - 新的 RecurrenceRule

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds

`addDate(date)`

添加一个规则，使活动在特定日期重复。

参数

名称	类型	说明
`date`	`Date`

EventRecurrence - 用于链式调用的 EventRecurrence

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds

`addDateExclusion(date)`

添加一个用于排除特定日期的出现情况的规则。

参数

名称	类型	说明
`date`	`Date`

EventRecurrence - 用于链式调用的 EventRecurrence

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds

`addMonthlyExclusion()`

添加一个用于排除每月发生的事件的规则。

默认情况下，排除项会在系列活动的第一项活动所在月的同一天应用，但您可以通过调用 onlyOnMonthDay(day) 或 onlyOnMonthDays(days) 来更改这一设置。

RecurrenceRule - 新的 RecurrenceRule

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds

`addMonthlyRule()`

添加一个规则，使事件每月重复。

默认情况下，事件会在系列中第一个事件所在的月份同一天重复，但您可以通过调用 onlyOnMonthDay(day) 或 onlyOnMonthDays(days) 来更改此设置。

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

RecurrenceRule - 新的 RecurrenceRule

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds

`addWeeklyExclusion()`

添加一项规则，用于排除每周发生的事件。

默认情况下，排除项会在系列中第一项活动所在的一周同一天应用，但您可以通过调用 onlyOnWeekday(day) 或 onlyOnWeekdays(days) 来更改这一设置。

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

RecurrenceRule - 新的 RecurrenceRule

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds

`addWeeklyRule()`

添加一个规则，使活动每周重复一次。

默认情况下，活动会在系列中第一个活动的同一周几重复，但您可以通过调用 onlyOnWeekday(day) 或 onlyOnWeekdays(days) 来更改这一设置。

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

RecurrenceRule - 新的 RecurrenceRule

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds

`addYearlyExclusion()`

添加一个用于排除每年发生的事件的规则。

默认情况下，排除项会在系列活动中的第一个活动所在年份的同一天应用，但您可以通过调用 onlyOnYearDay(day) 或 onlyOnYearDays(days) 来更改此设置。

RecurrenceRule - 新的 RecurrenceRule

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds

`addYearlyRule()`

添加一个规则，使活动每年重复。

默认情况下，事件会在系列中第一项事件所在的年份的同一天重复，但您可以通过调用 onlyOnYearDay(day) 或 onlyOnYearDays(days) 来更改此设置。

RecurrenceRule - 新的 RecurrenceRule

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds

`interval(interval)`

将规则配置为仅在规则的时间单位的此时间间隔内应用。

// Creates a rule that recurs every fourth week.
const recurrence = CalendarApp.newRecurrence().addWeeklyRule().interval(4);

参数

名称	类型	说明
`interval`	`Integer`	规则的时间单位中的间隔

RecurrenceRule - 用于链式调用的此 RecurrenceRule

`onlyInMonth(month)`

将规则配置为仅适用于特定月份。

// Creates a rule that recurs every week in February.
const recurrence = CalendarApp.newRecurrence().addWeeklyRule().onlyInMonth(
    CalendarApp.Month.FEBRUARY);

参数

名称	类型	说明
`month`	`Month`	月份

RecurrenceRule - 用于链式调用的此 RecurrenceRule

`onlyInMonths(months)`

将规则配置为仅应用于特定月份。

// Creates a rule that recurs every week in February and March.
const recurrence = CalendarApp.newRecurrence().addWeeklyRule().onlyInMonths(
    [CalendarApp.Month.FEBRUARY, CalendarApp.Month.MARCH]);

参数

名称	类型	说明
`months`	`Month[]`	月份

RecurrenceRule - 用于链式调用的此 RecurrenceRule

`onlyOnMonthDay(day)`

将规则配置为仅应用于每月的特定日期。

// Creates a rule that recurs every month on the fifth day of the month.
const recurrence =
    CalendarApp.newRecurrence().addMonthlyRule().onlyOnMonthDay(5);

参数

名称	类型	说明
`day`	`Integer`	日期

RecurrenceRule - 用于链式调用的此 RecurrenceRule

`onlyOnMonthDays(days)`

将规则配置为仅应用于当月的特定日期。

// Creates a rule that recurs every month on the first and fifteenth day of the
// month.
const recurrence =
    CalendarApp.newRecurrence().addMonthlyRule().onlyOnMonthDays([1, 15]);

参数

名称	类型	说明
`days`	`Integer[]`	日期

RecurrenceRule - 用于链式调用的此 RecurrenceRule

`onlyOnWeek(week)`

将规则配置为仅适用于一年中的特定一周。

// Creates a rule that recurs on the fifth week of every year.
const recurrence = CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeek(5);

参数

名称	类型	说明
`week`	`Integer`	周

RecurrenceRule - 用于链式调用的此 RecurrenceRule

`onlyOnWeekday(day)`

将规则配置为仅应用于一周中的特定一天。

// Creates a rule that recurs every week on Wednesdays.
const recurrence = CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeekday(
    CalendarApp.Weekday.WEDNESDAY);

参数

名称	类型	说明
`day`	`Weekday`	星期几

RecurrenceRule - 用于链式调用的此 RecurrenceRule

`onlyOnWeekdays(days)`

将规则配置为仅应用于一周中的特定几天。

// Creates a rule that recurs every week on Tuesdays and Thursdays.
const recurrence = CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeekdays(
    [CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]);

参数

名称	类型	说明
`days`	`Weekday[]`	星期

RecurrenceRule - 用于链式调用的此 RecurrenceRule

`onlyOnWeeks(weeks)`

将规则配置为仅适用于一年中的特定周。

// Creates a rule that recurs on the fifth and tenth weeks of every year.
const recurrence =
    CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeeks([5, 10]);

参数

名称	类型	说明
`weeks`	`Integer[]`	周

RecurrenceRule - 用于链式调用的此 RecurrenceRule

`onlyOnYearDay(day)`

将规则配置为仅适用于一年中的特定日期。

// Creates a rule that recurs every year on February 15 (the 46th day).
const recurrence =
    CalendarApp.newRecurrence().addYearlyRule().onlyOnYearDay(46);

参数

名称	类型	说明
`day`	`Integer`	年月日

RecurrenceRule - 用于链式调用的此 RecurrenceRule

`onlyOnYearDays(days)`

将规则配置为仅适用于一年中的特定日期。

// Creates a rule that recurs every year on January 20 and February 15.
const recurrence =
    CalendarApp.newRecurrence().addYearlyRule().onlyOnYearDay([20, 46]);

参数

名称	类型	说明
`days`	`Integer[]`	一年中的天数

RecurrenceRule - 用于链式调用的此 RecurrenceRule

`setTimeZone(timeZone)`

设置此重复设置的时区。这会影响活动的重复日期和时间，以及活动是否会随夏令时而变化。默认为日历的时区。

参数

名称	类型	说明
`timeZone`	`String`	时区，采用“long”格式指定（例如Joda.org 中列出的“America/New_York”）

EventRecurrence - 用于链式调用的 EventRecurrence

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds

`times(times)`

将规则配置为在发生给定次数后结束。

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

参数

名称	类型	说明
`times`	`Integer`	重复的次数

RecurrenceRule - 用于链式调用的此 RecurrenceRule

`until(endDate)`

将规则配置为在指定日期（包括该日期）结束。

// Creates a rule that recurs every day through the end of 2013.
const recurrence = CalendarApp.newRecurrence().addDailyRule().until(
    new Date('December 31, 2013'));

参数

名称	类型	说明
`endDate`	`Date`

RecurrenceRule - 用于链式调用的此 RecurrenceRule

授权

使用此方法的脚本需要具有以下一个或多个作用域或相关 REST API 中的适当作用域的授权：

https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds

`weekStartsOn(day)`

配置一周的开始日期，以便应用规则。

// Creates a weekly rule where weeks start on Monday.
const recurrence = CalendarApp.newRecurrence().addWeeklyRule().weekStartsOn(
    CalendarApp.Weekday.MONDAY);

参数

名称	类型	说明
`day`	`Weekday`	一周的起始日

RecurrenceRule - 用于链式调用的此 RecurrenceRule

Class RecurrenceRule

方法

详细文档

addDailyExclusion()

返回

授权

addDailyRule()

返回

授权

addDate(date)

参数

返回

授权

addDateExclusion(date)

参数

返回

授权

addMonthlyExclusion()

返回

授权

addMonthlyRule()

返回

授权

addWeeklyExclusion()

返回

授权

addWeeklyRule()

返回

授权

addYearlyExclusion()

返回

授权

addYearlyRule()

返回

授权

interval(interval)

参数

返回

onlyInMonth(month)

参数

返回

onlyInMonths(months)

参数

返回

onlyOnMonthDay(day)

参数

返回

onlyOnMonthDays(days)

参数

返回

onlyOnWeek(week)

参数

返回

onlyOnWeekday(day)

参数

返回

onlyOnWeekdays(days)

参数

返回

onlyOnWeeks(weeks)

参数

返回

onlyOnYearDay(day)

参数

返回

onlyOnYearDays(days)

参数

返回

setTimeZone(timeZone)

参数

返回

授权

times(times)

参数

返回

until(endDate)

参数

返回

授权

weekStartsOn(day)

`addDailyExclusion()`

`addDailyRule()`

`addDate(date)`

`addDateExclusion(date)`

`addMonthlyExclusion()`

`addMonthlyRule()`

`addWeeklyExclusion()`

`addWeeklyRule()`

`addYearlyExclusion()`

`addYearlyRule()`

`interval(interval)`

`onlyInMonth(month)`

`onlyInMonths(months)`

`onlyOnMonthDay(day)`

`onlyOnMonthDays(days)`

`onlyOnWeek(week)`

`onlyOnWeekday(day)`

`onlyOnWeekdays(days)`

`onlyOnWeeks(weeks)`

`onlyOnYearDay(day)`

`onlyOnYearDays(days)`

`setTimeZone(timeZone)`

`times(times)`

`until(endDate)`

`weekStartsOn(day)`