Class ClockTriggerBuilder

ClockTriggerBuilder

כלי ליצירת טריגרים לפי שעון.

Methods

שיטהסוג הערך המוחזרתיאור קצר
after(durationMilliseconds)ClockTriggerBuilderמשך הזמן המינימלי (באלפיות השנייה) לאחר השעה הנוכחית שבו הטריגר פועל.
at(date)ClockTriggerBuilderמתי הטריגר פועל.
atDate(year, month, day)ClockTriggerBuilderההגדרה הזו קובעת שהטריגר יופעל בתאריך שצוין, כברירת מחדל בסביבות חצות (+/- 15 דקות).
atHour(hour)ClockTriggerBuilderהשעה שבה הטריגר פועל.
create()Triggerיצירת הטריגר.
everyDays(n)ClockTriggerBuilderההגדרה קובעת להפעיל את הטריגר כל n ימים.
everyHours(n)ClockTriggerBuilderמציין שהטריגר יופעל כל n שעות.
everyMinutes(n)ClockTriggerBuilderהטריגר יופעל כל n דקות.
everyWeeks(n)ClockTriggerBuilderמציין להפעיל את הטריגר כל n שבועות.
inTimezone(timezone)ClockTriggerBuilderמציין את אזור הזמן של התאריכים או השעה שצוינו, כאשר הטריגר פועל.
nearMinute(minute)ClockTriggerBuilderהדקה שבה הטריגר פועל (פלוס/מינוס 15 דקות).
onMonthDay(day)ClockTriggerBuilderמציין את התאריך בחודש שבו הטריגר פועל.
onWeekDay(day)ClockTriggerBuilderמציין את היום בשבוע שבו הטריגר פועל.

מסמכים מפורטים

after(durationMilliseconds)

משך הזמן המינימלי (באלפיות השנייה) לאחר השעה הנוכחית שבו הטריגר פועל. משך הזמן בפועל עשוי להשתנות, אבל הוא לא יהיה קצר יותר מהמשך הזמן המינימלי שציינתם.

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

פרמטרים

שםסוגתיאור
durationMillisecondsIntegerמשך הזמן המינימלי (באלפיות השנייה) אחרי השעה הנוכחית שבו הטריגר אמור לפעול.

חזרה

ClockTriggerBuilder – ה-builder, לצורך קישור.


at(date)

מתי הטריגר פועל.

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

פרמטרים

שםסוגתיאור
dateDateאובייקט Date שמייצג את המועד שבו הטריגר אמור לפעול.

חזרה

ClockTriggerBuilder – ה-builder, לצורך קישור.


atDate(year, month, day)

ההגדרה הזו קובעת שהטריגר יופעל בתאריך שצוין, כברירת מחדל בסביבות חצות (+/- 15 דקות).

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

פרמטרים

שםסוגתיאור
yearIntegerהשנה הקלנדרית שבה רוצים לתזמן את הטריגר.
monthIntegerהחודש הקלנדרי שבו רוצים לתזמן את הטריגר (צריך להיות מספר בין 1 ל-12, כולל).
dayIntegerהיום בלוח השנה שבו רוצים לתזמן את הטריגר (צריך להיות מספר בין 1 ל-31, כולל).

חזרה

ClockTriggerBuilder – ה-builder, לצורך קישור.


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

פרמטרים

שםסוגתיאור
hourIntegerהשעה שבה צריך להפעיל את ההגדרה.

חזרה

ClockTriggerBuilder – ה-builder, לצורך קישור.


create()

יצירת הטריגר.

חזרה

Trigger – הטריגר המתוזמן החדש שנוצר.


everyDays(n)

ההגדרה קובעת להפעיל את הטריגר כל n ימים.

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

פרמטרים

שםסוגתיאור
nIntegerמספר הימים בין ההפעלות.

חזרה

ClockTriggerBuilder – ה-builder, לצורך קישור.


everyHours(n)

מציין שהטריגר יופעל כל n שעות.

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

פרמטרים

שםסוגתיאור
nIntegerמספר השעות בין ההפעלות.

חזרה

ClockTriggerBuilder – ה-builder, לצורך קישור.


everyMinutes(n)

הטריגר יופעל כל n דקות. הערך של n חייב להיות 1, 5, 10, 15 או 30.

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

פרמטרים

שםסוגתיאור
nIntegerמספר הדקות בין ההפעלות.

חזרה

ClockTriggerBuilder – ה-builder, לצורך קישור.


everyWeeks(n)

מציין שהמפעיל יופעל כל n שבועות.

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

פרמטרים

שםסוגתיאור
nIntegerמספר השבועות בין ההפעלות.

חזרה

ClockTriggerBuilder – ה-builder, לצורך קישור.


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

פרמטרים

שםסוגתיאור
timezoneStringאזור הזמן שבו יתבצע הטיפול בפרטי הזמן באירוע.

חזרה

ClockTriggerBuilder — השדה ClockTriggerBuilder, לצורך קישור.


nearMinute(minute)

הדקה שבה הטריגר פועל (פלוס/מינוס 15 דקות). אם לא קוראים לפונקציה 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();

פרמטרים

שםסוגתיאור
minuteIntegerהדקה שבה התג יופעל.

חזרה

ClockTriggerBuilder – ה-builder, לצורך קישור.


onMonthDay(day)

מציין את התאריך בחודש שבו הטריגר פועל.

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

פרמטרים

שםסוגתיאור
dayIntegerהיום בחודש שבו צריך לתזמן את הטריגר.

חזרה

ClockTriggerBuilder – ה-builder, לצורך קישור.


onWeekDay(day)

מציין את היום בשבוע שבו הטריגר פועל.

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

פרמטרים

שםסוגתיאור
dayWeekdayהיום בשבוע שבו הפונקציה מופעלת.

חזרה

ClockTriggerBuilder – ה-builder, לצורך קישור.