Class Trigger

Курок

Триггер сценария.

Методы

Метод Тип возврата Краткое описание
getEventType() EventType Возвращает тип события, при котором срабатывает триггер.
getHandlerFunction() String Возвращает функцию, которая будет вызываться при срабатывании триггера.
getTriggerSource() TriggerSource Возвращает источник событий, которые вызовут срабатывание триггера.
getTriggerSourceId() String Возвращает идентификатор, определенный для источника.
getUniqueId() String Возвращает уникальный идентификатор, который можно использовать для отличия триггеров друг от друга.

Подробная документация

getEventType()

Возвращает тип события, при котором срабатывает триггер.

var triggers = ScriptApp.getProjectTriggers();
for (var i = 0; i < triggers.length; i++) {
  if (triggers[i].getEventType() == ScriptApp.EventType.CLOCK) {
    // Some code here - other options are:
    // ScriptApp.EventType.ON_EDIT
    // ScriptApp.EventType.ON_FORM_SUBMIT
    // ScriptApp.EventType.ON_OPEN
  }
}

Возвращаться

EventType — тип события, для которого это является триггером.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/script.scriptapp

getHandlerFunction()

Возвращает функцию, которая будет вызываться при срабатывании триггера.

// Create a trigger for the script.
ScriptApp.newTrigger('myFunction').forSpreadsheet('id of my spreadsheet').onEdit().create();
Logger.log(ScriptApp.getProjectTriggers()[0].getHandlerFunction()); // logs "myFunction"

Возвращаться

String — имя метода

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/script.scriptapp

getTriggerSource()

Возвращает источник событий, которые вызовут срабатывание триггера.

Например, триггер электронной таблицы onEdit вернет SPREADSHEETS, а триггер, основанный на времени, вернет CLOCK.

var triggers = ScriptApp.getProjectTriggers();
for (var i = 0; i < triggers.length; i++) {
  if (triggers[i].getTriggerSource() == ScriptApp.TriggerSource.CLOCK) {
    Logger.log(triggers[i].getUniqueId() + " source is clock");
  } else if (triggers[i].getTriggerSource() == ScriptApp.TriggerSource.SPREADSHEETS) {
    Logger.log(triggers[i].getUniqueId() + " source is spreadsheets");
  }
}

Возвращаться

TriggerSource — издатель, для которого это триггер.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/script.scriptapp

getTriggerSourceId()

Возвращает идентификатор, определенный для источника.

Например, если источником триггера является электронная таблица, это будет идентификатор электронной таблицы. Для событий часов это возвращает ноль.

Возвращаться

String — идентификатор сущности в издателе, для которого это триггер.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/script.scriptapp

getUniqueId()

Возвращает уникальный идентификатор, который можно использовать для отличия триггеров друг от друга.

Возвращаться

String — уникальный идентификатор триггера

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/script.scriptapp