Class ClockTriggerBuilder

سازنده‌ی ماشه ساعت

سازنده‌ای برای محرک‌های ساعت.

روش‌ها

روش نوع بازگشتی شرح مختصر
after(durationMilliseconds) Clock Trigger Builder حداقل مدت زمان (بر حسب میلی ثانیه) پس از زمان فعلی که تریگر اجرا می‌شود را مشخص می‌کند.
at(date) Clock Trigger Builder زمان اجرای trigger را مشخص می‌کند.
at Date(year, month, day) Clock Trigger Builder مشخص می‌کند که تریگر در تاریخ داده شده، به طور پیش‌فرض نزدیک نیمه‌شب (+/- ۱۵ دقیقه) فعال شود.
at Hour(hour) Clock Trigger Builder ساعتی را که تریگر در آن اجرا می‌شود، مشخص می‌کند.
create() Trigger محرک را ایجاد می‌کند.
every Days(n) Clock Trigger Builder مشخص می‌کند که تریگر هر n روز اجرا شود.
every Hours(n) Clock Trigger Builder مشخص می‌کند که تریگر هر n ساعت اجرا شود.
every Minutes(n) Clock Trigger Builder مشخص می‌کند که تریگر هر n دقیقه اجرا شود.
every Weeks(n) Clock Trigger Builder مشخص می‌کند که تریگر هر n هفته اجرا شود.
in Timezone(timezone) Clock Trigger Builder منطقه زمانی را برای تاریخ/زمان مشخص شده هنگام اجرای تریگر مشخص می‌کند.
near Minute(minute) Clock Trigger Builder دقیقه‌ای را که تریگر در آن اجرا می‌شود (به‌علاوه یا منهای ۱۵ دقیقه) مشخص می‌کند.
on Month Day(day) Clock Trigger Builder تاریخ را در ماهی که تریگر اجرا می‌شود، مشخص می‌کند.
on Week Day(day) Clock Trigger Builder روزی از هفته را که تریگر اجرا می‌شود، مشخص می‌کند.

مستندات دقیق

after(durationMilliseconds)

حداقل مدت زمان (برحسب میلی‌ثانیه) پس از زمان فعلی اجرای تریگر را مشخص می‌کند. مدت زمان واقعی ممکن است متفاوت باشد، اما کمتر از حداقل مشخص شده شما نخواهد بود.

// Creates a trigger that runs 10 minutes later
ScriptApp.newTrigger('myFunction').timeBased().after(10 * 60 * 1000).create();

پارامترها

نام نوع توضیحات
duration Milliseconds Integer حداقل مدت زمان (برحسب میلی‌ثانیه) پس از زمان فعلی که تریگر باید اجرا شود.

بازگشت

ClockTriggerBuilder — سازنده، برای زنجیره‌سازی.

at(date)

زمان اجرای trigger را مشخص می‌کند.

// Creates a trigger for December 1, 2012
const triggerDay = new Date(2012, 11, 1);
ScriptApp.newTrigger('myFunction').timeBased().at(triggerDay).create();

پارامترها

نام نوع توضیحات
date Date یک شیء تاریخ که نشان می‌دهد تریگر چه زمانی باید اجرا شود.

بازگشت

ClockTriggerBuilder — سازنده، برای زنجیره‌سازی.

atDate(year, month, day)

مشخص می‌کند که تریگر در تاریخ داده شده، به طور پیش‌فرض نزدیک نیمه‌شب (+/- ۱۵ دقیقه) فعال شود.

// Schedules for January 1st, 2013
ScriptApp.newTrigger('myFunction').timeBased().atDate(2013, 1, 1).create();

پارامترها

نام نوع توضیحات
year Integer سال تقویمی برای برنامه‌ریزی ماشه.
month Integer ماه تقویمی برای زمان‌بندی تریگر (باید عددی بین ۱ تا ۱۲ باشد، شامل همه).
day Integer روز تقویمی برای زمان‌بندی فعال‌سازی (باید عددی بین ۱ تا ۳۱ باشد، شامل).

بازگشت

ClockTriggerBuilder — سازنده، برای زنجیره‌سازی.

atHour(hour)

ساعتی را که تریگر در آن اجرا می‌شود، مشخص می‌کند.

// Runs between 5am-6am in the timezone of the script
ScriptApp.newTrigger('myFunction')
    .timeBased()
    .atHour(5)
    .everyDays(
        1)  // Frequency is required if you are using atHour() or nearMinute()
    .create();

پارامترها

نام نوع توضیحات
hour Integer ساعتی که باید شلیک کرد.

بازگشت

ClockTriggerBuilder — سازنده، برای زنجیره‌سازی.

create()

محرک را ایجاد می‌کند.

بازگشت

Trigger - تریگر برنامه‌ریزی‌شده و تازه ایجاد شده.

everyDays(n)

مشخص می‌کند که تریگر هر n روز اجرا شود.

ScriptApp.newTrigger('myFunction').timeBased().everyDays(3).create();

پارامترها

نام نوع توضیحات
n Integer تعداد روزهای بین اعدام‌ها.

بازگشت

ClockTriggerBuilder — سازنده، برای زنجیره‌سازی.

everyHours(n)

مشخص می‌کند که تریگر هر n ساعت اجرا شود.

ScriptApp.newTrigger('myFunction').timeBased().everyHours(12).create();

پارامترها

نام نوع توضیحات
n Integer تعداد ساعات بین اعدام‌ها.

بازگشت

ClockTriggerBuilder — سازنده، برای زنجیره‌سازی.

everyMinutes(n)

مشخص می‌کند که تریگر هر n دقیقه اجرا شود. n باید ۱، ۵، ۱۰، ۱۵ یا ۳۰ باشد.

ScriptApp.newTrigger('myFunction').timeBased().everyMinutes(10).create();

پارامترها

نام نوع توضیحات
n Integer تعداد دقایق بین اعدام‌ها.

بازگشت

ClockTriggerBuilder — سازنده، برای زنجیره‌سازی.

everyWeeks(n)

مشخص می‌کند که تریگر هر n هفته اجرا شود.

ScriptApp.newTrigger('myFunction')
    .timeBased()
    .everyWeeks(2)
    .onWeekDay(ScriptApp.WeekDay.FRIDAY)
    .create();

پارامترها

نام نوع توضیحات
n Integer تعداد هفته‌های بین اعدام‌ها.

بازگشت

ClockTriggerBuilder — سازنده، برای زنجیره‌سازی.

inTimezone(timezone)

منطقه زمانی را برای تاریخ/زمان مشخص شده هنگام اجرای تریگر مشخص می‌کند. به طور پیش‌فرض، منطقه زمانی، منطقه زمانی اسکریپت است.

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

// Schedule the trigger to execute at noon every day in the US/Pacific time zone
ScriptApp.newTrigger('myFunction')
    .timeBased()
    .atHour(12)
    .everyDays(1)
    .inTimezone('America/Los_Angeles')
    .create();

پارامترها

نام نوع توضیحات
timezone String منطقه زمانی که اطلاعات زمانی در رویداد با آن پردازش می‌شود.

بازگشت

ClockTriggerBuilder — این ClockTriggerBuilder برای زنجیره‌سازی است.

nearMinute(minute)

دقیقه‌ای را که تریگر در آن اجرا می‌شود (به‌علاوه یا منهای ۱۵ دقیقه) مشخص می‌کند. اگر nearMinute() فراخوانی نشود، از یک مقدار تصادفی دقیقه استفاده می‌شود. 

// Runs at approximately 5:30am in the timezone of the script
ScriptApp.newTrigger('myFunction')
    .timeBased()
    .atHour(5)
    .nearMinute(30)
    .everyDays(
        1)  // Frequency is required if you are using atHour() or nearMinute()
    .create();

پارامترها

نام نوع توضیحات
minute Integer دقیقه‌ای که باید شلیک شود.

بازگشت

ClockTriggerBuilder — سازنده، برای زنجیره‌سازی.

onMonthDay(day)

تاریخ را در ماهی که تریگر اجرا می‌شود، مشخص می‌کند. 

// Schedules for the first of every month
ScriptApp.newTrigger('myFunction').timeBased().onMonthDay(1).create();

پارامترها

نام نوع توضیحات
day Integer روزی از ماه که باید تریگر برای آن برنامه‌ریزی شود.

بازگشت

ClockTriggerBuilder — سازنده، برای زنجیره‌سازی.

onWeekDay(day)

روزی از هفته را که تریگر اجرا می‌شود، مشخص می‌کند. 

ScriptApp.newTrigger('myFunction')
    .timeBased()
    .onWeekDay(ScriptApp.WeekDay.FRIDAY)
    .create();

پارامترها

نام نوع توضیحات
day Weekday روز هفته برای آتش زدن.

بازگشت

ClockTriggerBuilder — سازنده، برای زنجیره‌سازی.