Class Trigger

Déclencheur

Déclencheur de script.

Méthodes

MéthodeType renvoyéBrève description
getEventType()EventTypeRenvoie le type d'événement sur lequel le déclencheur est exécuté.
getHandlerFunction()StringRenvoie la fonction qui sera appelée lorsque le déclencheur sera exécuté.
getTriggerSource()TriggerSourceRenvoie la source des événements qui entraînent l'activation du déclencheur.
getTriggerSourceId()StringRenvoie l'ID spécifique à la source.
getUniqueId()StringAffiche un identifiant unique qui permet de distinguer les déclencheurs les uns des autres.

Documentation détaillée

getEventType()

Renvoie le type d'événement sur lequel le déclencheur est exécuté.

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

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 correspondant à un ou plusieurs des champs d'application suivants:

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

getHandlerFunction()

Renvoie la fonction qui sera appelée lorsque le déclencheur sera exécuté.

// 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 correspondant à un ou plusieurs des champs d'application suivants:

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

getTriggerSource()

Renvoie la source des événements qui entraînent l'activation du déclencheur.

Par exemple, un déclencheur "onEdit" d'une feuille de calcul renverrait "SPREADSHEETS" ou un déclencheur temporel. renverra 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");
  }
}

Renvois

TriggerSource : éditeur pour lequel il s'agit d'un déclencheur

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application 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 feuille de calcul. Pour les événements d'horloge, la valeur renvoyée est "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 correspondant à un ou plusieurs des champs d'application suivants:

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

getUniqueId()

Affiche un identifiant unique qui permet de 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 correspondant à un ou plusieurs des champs d'application suivants:

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