Class ClockTriggerBuilder

ClockTriggerBuilder

Конструктор для запуска тактовых сигналов.

Методы

Метод Тип возвращаемого значения Краткое описание
after(durationMilliseconds) Clock Trigger Builder Указывает минимальную продолжительность (в миллисекундах) после текущего момента времени, в течение которой срабатывает триггер.
at(date) Clock Trigger Builder Указывает, когда срабатывает триггер.
at Date(year, month, day) Clock Trigger Builder Указывает, что триггер срабатывает в указанную дату, по умолчанию около полуночи (+/- 15 минут).
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 Указывает минуту, в которую срабатывает триггер (плюс-минус 15 минут).
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)

Указывает, когда срабатывает триггер.

// Creates a trigger for December 1, 2012
const 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 — конструктор для создания цепочек триггеров.