Class RecurrenceRule

قانون عود

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

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

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 DateExclusion(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 به منظور اعمال قانون، روزهای شروع هفته را پیکربندی می کند.

مستندات دقیق

add Daily Exclusion()

قاعده‌ای اضافه می‌کند که رخدادهای روزانه را حذف می‌کند. 

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

بازگشت

Recurrence Rule - RecurrenceRule جدید

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:

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

add Daily Rule()

قانونی اضافه می کند که باعث می شود رویداد به صورت روزانه تکرار شود. 

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

بازگشت

Recurrence Rule - RecurrenceRule جدید

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:

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

add Date(date)

قانونی اضافه می کند که باعث می شود رویداد در تاریخ خاصی تکرار شود.

پارامترها

نام تایپ کنید توضیحات
date Date

بازگشت

Event Recurrence - این رویداد تکراری برای زنجیر کردن

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:

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

add DateExclusion(date)

قاعده‌ای اضافه می‌کند که یک رویداد را برای یک تاریخ خاص استثنا می‌کند.

پارامترها

نام تایپ کنید توضیحات
date Date

بازگشت

Event Recurrence - این رویداد تکراری برای زنجیر کردن

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:

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

add Monthly Exclusion()

قاعده‌ای اضافه می‌کند که رویدادها را به‌صورت ماهانه مستثنی می‌کند.

به‌طور پیش‌فرض، استثنا در همان روز از ماه به عنوان اولین رویداد مجموعه اعمال می‌شود، اما می‌توان آن را با تماس only On Month Day(day) یا only On Month Days(days) تغییر داد.

بازگشت

Recurrence Rule - RecurrenceRule جدید

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:

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

add Monthly Rule()

قانونی اضافه می کند که باعث می شود رویداد به صورت ماهانه تکرار شود.

به‌طور پیش‌فرض، رویداد در همان روز از ماه تکرار می‌شود که اولین رویداد مجموعه است، اما این رویداد را می‌توان با تماس only On Month Day(day) یا only On Month Days(days) تغییر داد. 

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

بازگشت

Recurrence Rule - RecurrenceRule جدید

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:

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

add Weekly Exclusion()

قاعده‌ای اضافه می‌کند که رویدادها را به صورت هفتگی حذف می‌کند.

به‌طور پیش‌فرض، استثنا در همان روز هفته با اولین رویداد مجموعه اعمال می‌شود، اما می‌توان با تماس only On Weekday(day) یا only On Weekdays(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);

بازگشت

Recurrence Rule - RecurrenceRule جدید

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:

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

add Weekly Rule()

قانونی اضافه می کند که باعث می شود رویداد به صورت هفتگی تکرار شود.

به‌طور پیش‌فرض، رویداد در همان روز هفته تکرار می‌شود که اولین رویداد مجموعه است، اما این رویداد را می‌توان با تماس only On Weekday(day) یا only On Weekdays(days) تغییر داد. 

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

بازگشت

Recurrence Rule - RecurrenceRule جدید

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:

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

add Yearly Exclusion()

قاعده‌ای اضافه می‌کند که رویدادها را به‌صورت سالانه مستثنی می‌کند.

به‌طور پیش‌فرض، استثنا در همان روز سال به عنوان اولین رویداد در مجموعه اعمال می‌شود، اما می‌توان آن را با تماس only On Year Day(day) یا only On Year Days(days) تغییر داد.

بازگشت

Recurrence Rule - RecurrenceRule جدید

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:

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

add Yearly Rule()

قانونی اضافه می کند که باعث می شود رویداد به صورت سالانه تکرار شود.

به‌طور پیش‌فرض، رویداد در همان روز سال تکرار می‌شود که اولین رویداد مجموعه است، اما این رویداد را می‌توان با تماس only On Year Day(day) یا only On Year Days(days) تغییر داد.

بازگشت

Recurrence Rule - 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 فاصله در واحد زمان قاعده

بازگشت

Recurrence Rule - این RecurrenceRule برای زنجیر کردن

only In Month(month)

این قانون را طوری پیکربندی می کند که فقط برای یک ماه خاص اعمال شود. 

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

پارامترها

نام تایپ کنید توضیحات
month Month ماه

بازگشت

Recurrence Rule - این RecurrenceRule برای زنجیر کردن

only In Months(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[] ماه ها

بازگشت

Recurrence Rule - این RecurrenceRule برای زنجیر کردن

only On Month Day(day)

این قانون را طوری پیکربندی می‌کند که فقط در یک روز خاص از ماه اعمال شود. 

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

پارامترها

نام تایپ کنید توضیحات
day Integer روز ماه

بازگشت

Recurrence Rule - این RecurrenceRule برای زنجیر کردن

only On Month Days(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[] روزهای ماه

بازگشت

Recurrence Rule - این RecurrenceRule برای زنجیر کردن

only On Week(week)

این قانون را طوری پیکربندی می‌کند که فقط برای هفته خاصی از سال اعمال شود. 

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

پارامترها

نام تایپ کنید توضیحات
week Integer هفته

بازگشت

Recurrence Rule - این RecurrenceRule برای زنجیر کردن

only On Weekday(day)

این قانون را طوری پیکربندی می‌کند که فقط برای یک روز خاص از هفته اعمال شود. 

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

پارامترها

نام تایپ کنید توضیحات
day Weekday روز هفته

بازگشت

Recurrence Rule - این RecurrenceRule برای زنجیر کردن

only On Weekdays(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[] روزهای هفته

بازگشت

Recurrence Rule - این RecurrenceRule برای زنجیر کردن

only On Weeks(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[] هفته ها

بازگشت

Recurrence Rule - این RecurrenceRule برای زنجیر کردن

only On Year Day(day)

این قانون را طوری پیکربندی می‌کند که فقط برای یک روز خاص از سال اعمال شود. 

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

پارامترها

نام تایپ کنید توضیحات
day Integer روز سال

بازگشت

Recurrence Rule - این RecurrenceRule برای زنجیر کردن

only On Year Days(days)

این قانون را طوری پیکربندی می‌کند که فقط برای روزهای خاصی از سال اعمال شود. 

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

پارامترها

نام تایپ کنید توضیحات
days Integer[] روزهای سال

بازگشت

Recurrence Rule - این RecurrenceRule برای زنجیر کردن

set Time Zone(timeZone)

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

پارامترها

نام تایپ کنید توضیحات
time Zone String منطقه زمانی، مشخص شده در قالب "طولانی" (به عنوان مثال، "America/New_York"، همانطور که توسط Joda.org فهرست شده است)

بازگشت

Event Recurrence - این رویداد تکراری برای زنجیر کردن

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از 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 تعداد دفعات تکرار

بازگشت

Recurrence Rule - این 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

بازگشت

Recurrence Rule - این RecurrenceRule برای زنجیر کردن

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر یا محدوده های مناسب از REST API مربوطه دارند:

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

week Starts On(day)

به منظور اعمال قانون، روزهای شروع هفته را پیکربندی می کند. 

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

پارامترها

نام تایپ کنید توضیحات
day Weekday روزی که هفته شروع می شود

بازگشت

Recurrence Rule - این RecurrenceRule برای زنجیر کردن