A script trigger.
Methods
| Method | Return type | Brief description |
|---|---|---|
forSpreadsheet(sheet) | SpreadsheetTriggerBuilder | Returns a builder for building spreadsheet triggers. |
forSpreadsheet(key) | SpreadsheetTriggerBuilder | Creates a SpreadsheetTriggerBuilder tied to the spreadsheet with the passed in id to make a spreadsheet event trigger. |
timeBased() | ClockTriggerBuilder | Returns a builder for building clock triggers. |
Detailed documentation
forSpreadsheet(sheet)
Returns a builder for building spreadsheet triggers. Note: You must have access to the spreadsheet to create spreadsheet events.
ScriptApp.newTrigger("myOnEditFunction")
.forSpreadsheet(SpreadsheetApp.getActiveSpreadsheet())
.onEdit()
.create();
Parameters
| Name | Type | Description |
|---|---|---|
sheet | Spreadsheet | the spreadsheet |
Return
SpreadsheetTriggerBuilder — a SpreadsheetTriggerBuilder for chaining
forSpreadsheet(key)
Creates a SpreadsheetTriggerBuilder tied to the spreadsheet with the passed in id to make a spreadsheet event trigger. Note: You must have access to the spreadsheet to create spreadsheet events.
ScriptApp.newTrigger("myOnEditFunction")
.forSpreadsheet("--myspreadsheetid--")
.onEdit()
.create();
Parameters
| Name | Type | Description |
|---|---|---|
key | String | the spreadsheet key |
Return
SpreadsheetTriggerBuilder — a SpreadsheetTriggerBuilder for chaining
timeBased()
Returns a builder for building clock triggers.
ScriptApp.newTrigger("myTimeTrigger")
.timeBased()
.atDate(2011, 10, 3)
.create();
Return
ClockTriggerBuilder — a ClockTriggerBuilder for chaining