Class Trigger

Aktywator

Wyzwalacz skryptu.

Metody

MetodaZwracany typKrótki opis
getEventType()EventTypeZwraca typ zdarzenia, w wyniku którego uruchamia się reguła.
getHandlerFunction()StringZwraca funkcję, która zostanie wywołana po uruchomieniu aktywatora.
getTriggerSource()TriggerSourceZwraca źródło zdarzeń, które spowodują uruchomienie reguły.
getTriggerSourceId()StringZwraca identyfikator źródła.
getUniqueId()StringZwraca unikalny identyfikator, który pozwala odróżnić od siebie aktywatory.

Szczegółowa dokumentacja

getEventType()

Zwraca typ zdarzenia, w wyniku którego uruchamia się reguła.

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

Powrót

EventType – typ zdarzenia, którego dotyczy ta reguła.

Autoryzacja

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 aktywatora.

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

Powrót

String – nazwa metody,

Autoryzacja

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 spowodują uruchomienie reguły.

Na przykład wyzwalacz onEdit w arkuszu kalkulacyjnym zwróciłby SPREADSHEETS, czyli regułę opartą na czasie. zwróci wartość 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");
  }
}

Powrót

TriggerSource – wydawca, którego dotyczy reguła

Autoryzacja

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 źródła.

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

Powrót

String – identyfikator elementu wydawcy, którego dotyczy reguła.

Autoryzacja

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 pozwala odróżnić od siebie aktywatory.

Powrót

String – unikalny identyfikator aktywatora;

Autoryzacja

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

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