Class Trigger

Aktywator

Wyzwalacz skryptu.

Metody

MetodaZwracany typKrótki opis
getEventType()EventTypeZwraca typ zdarzenia, które jest uruchamiane przez regułę.
getHandlerFunction()StringZwraca funkcję, która zostanie wywołana po uruchomieniu reguły.
getTriggerSource()TriggerSourceZwraca źródło zdarzeń, które będą uruchamiać regułę.
getTriggerSourceId()StringZwraca identyfikator właściwy dla danego źródła.
getUniqueId()StringZwraca unikalny identyfikator, którego można użyć do odróżniania od siebie reguł.

Szczegółowa dokumentacja

getEventType()

Zwraca typ zdarzenia, które jest uruchamiane 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
  }
}

Zwróć

EventType – typ zdarzenia, które ma wyzwalać regułę;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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"

Zwróć

String – nazwa metody;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

getTriggerSource()

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

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

Zwróć

TriggerSource – wydawca, dla którego występuje reguła;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

getTriggerSourceId()

Zwraca identyfikator właściwy dla danego źródła.

Jeśli np. źródłem wyzwalacza jest arkusz kalkulacyjny, jest to identyfikator arkusza kalkulacyjnego. W przypadku zdarzeń zegara ta wartość zwraca wartość null.

Zwróć

String – identyfikator podmiotu na wydawcy, który wywołał regułę;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

getUniqueId()

Zwraca unikalny identyfikator, którego można użyć do odróżniania od siebie reguł.

Zwróć

String – unikalny identyfikator aktywatora,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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