Um acionador de script.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getEventType() | EventType | Retorna o tipo de evento em que o acionador é disparado. |
getHandlerFunction() | String | Retorna a função que será chamada quando o acionador for disparado. |
getTriggerSource() | TriggerSource | Retorna a origem dos eventos que farão com que o acionador seja disparado. |
getTriggerSourceId() | String | Retorna o ID específico da fonte. |
getUniqueId() | String | Retorna um identificador exclusivo que pode ser usado para distinguir acionadores entre si. |
Documentação detalhada
getEventType()
Retorna o tipo de evento em que o acionador é disparado.
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 } }
Retorno
EventType
: o tipo de evento para o qual esse é um acionador
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/script.scriptapp
getHandlerFunction()
Retorna a função que será chamada quando o acionador for disparado.
// Create a trigger for the script. ScriptApp.newTrigger('myFunction').forSpreadsheet('id of my spreadsheet').onEdit().create(); Logger.log(ScriptApp.getProjectTriggers()[0].getHandlerFunction()); // logs "myFunction"
Retorno
String
: o nome do método
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/script.scriptapp
getTriggerSource()
Retorna a origem dos eventos que farão com que o acionador seja disparado.
Por exemplo, um acionador onEdit de planilha retornaria SPREADsheetsS, ou um acionador baseado em horário retornaria 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"); } }
Retorno
TriggerSource
: o editor para o qual esse é um acionador
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/script.scriptapp
getTriggerSourceId()
Retorna o ID específico da fonte.
Por exemplo, se a origem do acionador for uma planilha, esse será o ID da planilha. Para eventos do relógio, retorna um valor nulo.
Retorno
String
: o ID da entidade no editor que aciona o acionador
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/script.scriptapp
getUniqueId()
Retorna um identificador exclusivo que pode ser usado para distinguir acionadores entre si.
Retorno
String
: o identificador exclusivo do acionador
Autorização
Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/script.scriptapp