Class ClockTriggerBuilder

ClockTriggerBuilder

‫Builder להפעלות חוזרות לפי שעון.

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אזור הזמן שבו יטופל המידע על הזמן באירוע.

חזרה

ClockTriggerBuilderClockTriggerBuilder הזה, לשרשור.


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, לשרשור.