Class 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 Объект 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 — Построитель для цепочки.