Class Trigger

Aktywator

Wyzwalacz skryptu.

Metody

MetodaZwracany typKrótki opis
getEventType()EventTypeZwraca typ zdarzenia, które jest wywołane przez regułę.
getHandlerFunction()StringZwraca funkcję, która zostanie wywołana po uruchomieniu reguły.
getTriggerSource()TriggerSourceZwraca źródło zdarzeń, które będą powodować uruchomienie reguły.
getTriggerSourceId()StringZwraca identyfikator specyficzny dla źródła.
getUniqueId()StringZwraca unikalny identyfikator, który umożliwia odróżnianie od siebie aktywatorów.

Szczegółowa dokumentacja

getEventType()

Zwraca typ zdarzenia, które jest wywołane przez regułę.

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
  }
}

Powroty

EventType – typ zdarzenia, w przypadku którego uruchamia się ta reguła;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getHandlerFunction()

Zwraca funkcję, która zostanie wywołana po uruchomieniu reguły.

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

Powroty

String – nazwa metody,

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getTriggerSource()

Zwraca źródło zdarzeń, które będą powodować uruchomienie reguły.

Na przykład reguła w arkuszu kalkulacyjnym onEdit zwróciłaby SPREADSHEETS, a reguła oparta na czasie – 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");
  }
}

Powroty

TriggerSource – wydawca, w przypadku którego reguła jest uruchamiana;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getTriggerSourceId()

Zwraca identyfikator specyficzny dla źródła.

Jeśli źródłem reguły jest np. arkusz kalkulacyjny, będzie to identyfikator tego arkusza. W przypadku zdarzeń zegara zwraca wartość null.

Powroty

String – identyfikator jednostki wydawcy, w przypadku której reguła jest uruchamiana.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getUniqueId()

Zwraca unikalny identyfikator, który umożliwia odróżnianie od siebie aktywatorów.

Powroty

String – unikalny identyfikator aktywatora,

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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