Class RecurrenceRule

RecurrenceRule

代表活動系列的重複規則。

請注意,這個類別的行為也會像其所屬的 EventRecurrence。 可讓您連結規則建立作業,如下所示:

recurrence.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.
var 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.
var recurrence = CalendarApp.newRecurrence().addDailyRule().times(10);

回攻員

RecurrenceRule:新的 RecurrenceRule

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

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

addDate(date)

新增會在特定日期重複進行活動的規則。

參數

名稱類型說明
dateDate

回攻員

EventRecurrence:這個用於鏈結的 EventRecurrence

授權

使用這個方法的指令碼需要授權下列一或多個範圍相關 REST API 中的適當範圍:

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

addDateExclusion(date)

新增規則,排除特定日期的發生次數。

參數

名稱類型說明
dateDate

回攻員

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.
var 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.
var 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.
var 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.
var recurrence = CalendarApp.newRecurrence().addWeeklyRule().interval(4);

參數

名稱類型說明
intervalInteger規則時區的間隔

回攻員

RecurrenceRule:這項用於鏈結的 RecurrenceRule


onlyInMonth(month)

設定規則,只套用到特定月份。

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

參數

名稱類型說明
monthMonth當月

回攻員

RecurrenceRule:這項用於鏈結的 RecurrenceRule


onlyInMonths(months)

將規則設為僅套用到特定月份。

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

參數

名稱類型說明
monthsMonth[]月份

回攻員

RecurrenceRule:這項用於鏈結的 RecurrenceRule


onlyOnMonthDay(day)

設定規則,只套用到當月的特定日期。

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

參數

名稱類型說明
dayInteger

回攻員

RecurrenceRule:這項用於鏈結的 RecurrenceRule


onlyOnMonthDays(days)

將規則設為只套用到當月的特定日子。

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

參數

名稱類型說明
daysInteger[]

回攻員

RecurrenceRule:這項用於鏈結的 RecurrenceRule


onlyOnWeek(week)

設定規則,只套用到一年中的特定週次。

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

參數

名稱類型說明
weekInteger當週

回攻員

RecurrenceRule:這項用於鏈結的 RecurrenceRule


onlyOnWeekday(day)

設定規則,只套用到一週的某一天。

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

參數

名稱類型說明
dayWeekday星期幾

回攻員

RecurrenceRule:這項用於鏈結的 RecurrenceRule


onlyOnWeekdays(days)

將規則設為只在一週中的特定日子套用。

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

參數

名稱類型說明
daysWeekday[]星期幾

回攻員

RecurrenceRule:這項用於鏈結的 RecurrenceRule


onlyOnWeeks(weeks)

設定規則,只套用到一年中的特定週次。

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

參數

名稱類型說明
weeksInteger[]

回攻員

RecurrenceRule:這項用於鏈結的 RecurrenceRule


onlyOnYearDay(day)

設定規則,只套用到一年中的特定日期。

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

參數

名稱類型說明
dayInteger每年

回攻員

RecurrenceRule:這項用於鏈結的 RecurrenceRule


onlyOnYearDays(days)

設定規則,只套用到一年中的特定日子。

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

參數

名稱類型說明
daysInteger[]每年

回攻員

RecurrenceRule:這項用於鏈結的 RecurrenceRule


setTimeZone(timeZone)

設定這個重複週期的時區。這會影響活動週期性的日期和時間 以及活動是否隨日光節約時間開始變動。預設值為日曆的時區。

參數

名稱類型說明
timeZoneString時區,指定格式為「long」格式 (例如列於「America/New_York」 由 Joda.org 製作)

回攻員

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.
var recurrence = CalendarApp.newRecurrence().addDailyRule().times(10);

參數

名稱類型說明
timesInteger週期性次數

回攻員

RecurrenceRule:這項用於鏈結的 RecurrenceRule


until(endDate)

設定規則的結束日期 (含當日)。

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

參數

名稱類型說明
endDateDate

回攻員

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.
var recurrence = CalendarApp.newRecurrence()
    .addWeeklyRule().weekStartsOn(CalendarApp.Weekday.MONDAY);

參數

名稱類型說明
dayWeekday一週的起始日

回攻員

RecurrenceRule:這項用於鏈結的 RecurrenceRule