Class ClockTriggerBuilder

ClockTriggerBuilder

כלי לבניית טריגרים של שעון.

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
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();

פרמטרים

שם	תיאור	התיאור
durationMilliseconds	Integer	משך הזמן המינימלי (באלפיות שנייה) לאחר הזמן הנוכחי שבו הטריגר אמור לרוץ.

החזרות

ClockTriggerBuilder – הכלי ליצירת שרשורים.

---

at(date)

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

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

פרמטרים

שם	תיאור	התיאור
date	Date	אובייקט 'תאריך' שמייצג את הזמן שבו הטריגר צריך לפעול.

החזרות

ClockTriggerBuilder – הכלי ליצירת שרשורים.

---

atDate(year, month, day)

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

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

פרמטרים

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

החזרות

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 חייב להיות בין 1, 5, 10, 15 או 30.

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)

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

פרמטרים

שם	תיאור	התיאור
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 – הכלי ליצירת שרשורים.