Class Trigger

Déclencheur

un déclencheur de script ;

Méthodes

MéthodeType renvoyéBrève description
getEventType()EventTypeRenvoie le type d'événement sur lequel le déclencheur s'active.
getHandlerFunction()StringRenvoie la fonction appelée lorsque le déclencheur est activé.
getTriggerSource()TriggerSourceRenvoie la source des événements qui provoquent l'activation du déclencheur.
getTriggerSourceId()StringRenvoie l'ID spécifique à la source.
getUniqueId()StringRenvoie un identifiant unique qui peut être utilisé pour distinguer les déclencheurs les uns des autres.

Documentation détaillée

getEventType()

Renvoie le type d'événement sur lequel le déclencheur s'active.

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

Renvois

EventType : type d'événement pour lequel il s'agit d'un déclencheur.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getHandlerFunction()

Renvoie la fonction appelée lorsque le déclencheur est activé.

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

Renvois

String : nom de la méthode.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getTriggerSource()

Renvoie la source des événements qui provoquent l'activation du déclencheur.

Par exemple, un déclencheur onEdit de feuille de calcul renvoie SPREADSHEETS, ou un déclencheur basé sur l'heure renvoie 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`);
  }
}

Renvois

TriggerSource : éditeur pour lequel le déclencheur est activé.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getTriggerSourceId()

Renvoie l'ID spécifique à la source.

Par exemple, si la source du déclencheur est une feuille de calcul, il s'agit de l'ID de la feuille de calcul. Pour les événements d'horloge, cette méthode renvoie null.

Renvois

String : ID de l'entité de l'éditeur pour laquelle il s'agit d'un déclencheur.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getUniqueId()

Renvoie un identifiant unique qui peut être utilisé pour distinguer les déclencheurs les uns des autres.

Renvois

String : identifiant unique du déclencheur.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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