Class Trigger

Déclencheur

Déclencheur de script.

Méthodes

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

Documentation détaillée

getEventType()

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

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 associée à 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 est 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 associée à un ou plusieurs des champs d'application suivants:

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

getTriggerSource()

Renvoie la source des événements qui activeront le déclencheur.

Par exemple, un déclencheur "onEdit" d'une feuille de calcul renverrait SPREADsheetsS, ou un déclencheur basé sur l'heure renverrait 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 ce déclencheur est utilisé.

Autorisation

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

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

getUniqueId()

Renvoie un identifiant unique permettant 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 associée à un ou plusieurs des champs d'application suivants:

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