Class Trigger

Trigger

Un attivatore di script.

Metodi

MetodoTipo restituitoBreve descrizione
getEventType()EventTypeRestituisce il tipo di evento per cui viene attivato l'attivatore.
getHandlerFunction()StringRestituisce la funzione che verrà chiamata quando viene attivato l'attivatore.
getTriggerSource()TriggerSourceRestituisce l'origine degli eventi che attiveranno l'attivatore.
getTriggerSourceId()StringRestituisce l'ID specifico dell'origine.
getUniqueId()StringRestituisce un identificatore univoco che può essere utilizzato per distinguere gli attivatori tra loro.

Documentazione dettagliata

getEventType()

Restituisce il tipo di evento per cui viene attivato l'attivatore.

const triggers = ScriptApp.getProjectTriggers();
for (let 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
  }
}

Invio

EventType: il tipo di evento per cui si tratta di un trigger

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à chiamata quando viene attivato l'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"

Invio

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 attiveranno l'attivatore.

Ad esempio, un attivatore onEdit di un foglio di lavoro restituirà SPREADSHEETS o un attivatore basato sul tempo restituirà CLOCK.

const triggers = ScriptApp.getProjectTriggers();
for (let 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`);
  }
}

Invio

TriggerSource: l'editore per cui 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

getTriggerSourceId()

Restituisce l'ID specifico dell'origine.

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

Invio

String: l'ID dell'entità nel publisher per cui 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 tra loro.

Invio

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