Class RecurrenceRule

قانون تکرار

نشان دهنده یک قانون تکرار برای یک سری رویداد است.

توجه داشته باشید که این کلاس مانند EventRecurrence که به آن تعلق دارد نیز رفتار می‌کند و به شما امکان می‌دهد ایجاد قوانین را به صورت زنجیره‌ای به هم متصل کنید:

const recurrence = CalendarApp.newRecurrence().addDailyRule().times(3).interval(2).addWeeklyExclusion().times(2);
اصلاح‌کننده‌هایی مانند times(times) و interval(interval) روی جدیدترین قانون اضافه شده اعمال می‌شوند.

روش‌ها

روش نوع بازگشتی شرح مختصر
add Daily Exclusion() Recurrence Rule قانونی اضافه می‌کند که وقایع روزانه را مستثنی می‌کند.
add Daily Rule() Recurrence Rule قانونی اضافه می‌کند که باعث می‌شود رویداد به صورت روزانه تکرار شود.
add Date(date) Event Recurrence قاعده‌ای اضافه می‌کند که باعث می‌شود رویداد در یک تاریخ خاص تکرار شود.
add Date Exclusion(date) Event Recurrence قانونی اضافه می‌کند که وقوع یک رویداد را برای یک تاریخ خاص مستثنی می‌کند.
add Monthly Exclusion() Recurrence Rule قانونی اضافه می‌کند که رخدادهای ماهانه را مستثنی می‌کند.
add Monthly Rule() Recurrence Rule قانونی اضافه می‌کند که باعث می‌شود این رویداد به صورت ماهانه تکرار شود.
add Weekly Exclusion() Recurrence Rule قانونی اضافه می‌کند که وقایع هفتگی را مستثنی می‌کند.
add Weekly Rule() Recurrence Rule قانونی اضافه می‌کند که باعث می‌شود رویداد به صورت هفتگی تکرار شود.
add Yearly Exclusion() Recurrence Rule قانونی اضافه می‌کند که رخدادهای سالانه را مستثنی می‌کند.
add Yearly Rule() Recurrence Rule قانونی اضافه می‌کند که باعث می‌شود این رویداد سالانه تکرار شود.
interval(interval) Recurrence Rule این قانون را طوری پیکربندی می‌کند که فقط در این بازه از واحد زمانی قانون اعمال شود.
only In Month(month) Recurrence Rule این قانون را طوری تنظیم می‌کند که فقط برای یک ماه خاص اعمال شود.
only In Months(months) Recurrence Rule این قانون را طوری تنظیم می‌کند که فقط برای ماه‌های خاصی اعمال شود.
only On Month Day(day) Recurrence Rule این قانون را طوری تنظیم می‌کند که فقط در یک روز خاص از ماه اعمال شود.
only On Month Days(days) Recurrence Rule این قانون را طوری پیکربندی می‌کند که فقط در روزهای خاصی از ماه اعمال شود.
only On Week(week) Recurrence Rule این قانون را طوری پیکربندی می‌کند که فقط برای یک هفته خاص از سال اعمال شود.
only On Weekday(day) Recurrence Rule این قانون را طوری تنظیم می‌کند که فقط در یک روز خاص از هفته اعمال شود.
only On Weekdays(days) Recurrence Rule این قانون را طوری پیکربندی می‌کند که فقط در روزهای خاصی از هفته اعمال شود.
only On Weeks(weeks) Recurrence Rule این قانون را طوری پیکربندی می‌کند که فقط برای هفته‌های خاصی از سال اعمال شود.
only On Year Day(day) Recurrence Rule این قانون را طوری تنظیم می‌کند که فقط برای یک روز خاص از سال اعمال شود.
only On Year Days(days) Recurrence Rule این قانون را طوری پیکربندی می‌کند که فقط در روزهای خاصی از سال اعمال شود.
set Time Zone(timeZone) Event Recurrence منطقه زمانی را برای این تکرار تنظیم می‌کند.
times(times) Recurrence Rule این قانون را طوری تنظیم می‌کند که پس از تعداد مشخصی از تکرار، پایان یابد.
until(endDate) Recurrence Rule این قانون را طوری تنظیم می‌کند که در یک تاریخ مشخص (شامل) پایان یابد.
week Starts On(day) Recurrence Rule برای اعمال قانون، شروع هفته را از کدام روز تنظیم می‌کند.

مستندات دقیق

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)

منطقه زمانی را برای این تکرار تنظیم می‌کند. این بر تاریخ و زمانی که رویدادها تکرار می‌شوند و اینکه آیا رویداد با ساعت تابستانی تغییر می‌کند یا خیر، تأثیر می‌گذارد. پیش‌فرض روی منطقه زمانی تقویم است.

پارامترها

نام نوع توضیحات
time Zone String منطقه زمانی، که با فرمت "طولانی" مشخص شده است (مثلاً '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.
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'));

پارامترها

نام نوع توضیحات
end Date 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 برای زنجیره‌سازی