Class Trigger

Trigger

Un attivatore di script.

Metodi

MetodoTipo restituitoBreve descrizione
getEventType()EventTypeRestituisce il tipo di evento su cui si attiva l'attivatore.
getHandlerFunction()StringRestituisce la funzione che verrà richiamata all'attivazione dell'attivatore.
getTriggerSource()TriggerSourceRestituisce l'origine degli eventi che causeranno l'attivazione dell'attivatore.
getTriggerSourceId()StringRestituisce l'ID specifico dell'origine.
getUniqueId()StringRestituisce un identificatore univoco che può essere utilizzato per distinguere gli attivatori l'uno dall'altro.

Documentazione dettagliata

getEventType()

Restituisce il tipo di evento su cui si attiva l'attivatore.

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

Ritorni

EventType: il tipo di evento per cui questo attivatore è

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getHandlerFunction()

Restituisce la funzione che verrà richiamata all'attivazione dell'attivatore.

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

Ritorni

String: il nome del metodo

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getTriggerSource()

Restituisce l'origine degli eventi che causeranno l'attivazione dell'attivatore.

Ad esempio, un trigger onEdit per fogli di lavoro restituirà SPREADSHEETS oppure un trigger basato sul tempo restituirà 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");
  }
}

Ritorni

TriggerSource: il publisher per il quale è un attivatore

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getTriggerSourceId()

Restituisce l'ID specifico dell'origine.

Ad esempio, se l'origine dell'attivatore è un foglio di lavoro, questo è l'ID del foglio di lavoro. Per gli eventi orologio, restituisce null.

Ritorni

String: l'ID dell'entità nel publisher per la quale si tratta di un attivatore

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getUniqueId()

Restituisce un identificatore univoco che può essere utilizzato per distinguere gli attivatori l'uno dall'altro.

Ritorni

String: l'identificatore univoco dell'attivatore

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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