Class RecurrenceRule

RecurenceRule

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

توجه داشته باشید که این کلاس نیز مانند 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)

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

پارامترها

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

بازگشت

EventRecurrence - این رویداد Recurrence برای زنجیره‌بندی

مجوز

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

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

addDateExclusion(date)

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

پارامترها

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

بازگشت

EventRecurrence - این رویداد Recurrence برای زنجیره‌بندی

مجوز

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

پارامترها

نام تایپ کنید توضیحات
interval Integer فاصله در واحد زمان قاعده

بازگشت

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

onlyInMonth(month)

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

// Creates a rule that recurs every week in February.
var 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.
var 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.
var 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.
var 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.
var recurrence = CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeek(5);

پارامترها

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

بازگشت

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

onlyOnWeekday(day)

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

// Creates a rule that recurs every week on Wednesdays.
var 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.
var 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.
var 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).
var 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.
var recurrence = CalendarApp.newRecurrence().addYearlyRule().onlyOnYearDay([20, 46]);

پارامترها

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

بازگشت

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

setTimeZone(timeZone)

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

پارامترها

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

بازگشت

EventRecurrence - این رویداد 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.
var recurrence = CalendarApp.newRecurrence().addDailyRule().times(10);

پارامترها

نام تایپ کنید توضیحات
times Integer تعداد دفعات تکرار

بازگشت

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'));

پارامترها

نام تایپ کنید توضیحات
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.
var recurrence = CalendarApp.newRecurrence()
    .addWeeklyRule().weekStartsOn(CalendarApp.Weekday.MONDAY);

پارامترها

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

بازگشت

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