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以「長」格式指定的時區 (例如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.
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