Cette page a été traduite par l'API Cloud Translation.

Class TriggerBuilder

Un compilateur générique pour les déclencheurs de script.

Méthodes

Méthode	Type renvoyé	Brève description
`forDocument(document)`	`DocumentTriggerBuilder`	Crée et renvoie un `DocumentTriggerBuilder` associé au document donné.
`forDocument(key)`	`DocumentTriggerBuilder`	Crée et renvoie un `DocumentTriggerBuilder` associé au document avec l'ID donné.
`forForm(form)`	`FormTriggerBuilder`	Crée et renvoie un `FormTriggerBuilder` associé au formulaire donné.
`forForm(key)`	`FormTriggerBuilder`	Crée et renvoie un `FormTriggerBuilder` associé au formulaire avec l'ID donné.
`forSpreadsheet(sheet)`	`SpreadsheetTriggerBuilder`	Crée et renvoie un `SpreadsheetTriggerBuilder` associé à la feuille de calcul donnée.
`forSpreadsheet(key)`	`SpreadsheetTriggerBuilder`	Crée et renvoie un `SpreadsheetTriggerBuilder` associé à la feuille de calcul avec l'ID donné.
`forUserCalendar(emailId)`	`CalendarTriggerBuilder`	Renvoie un générateur permettant de créer des déclencheurs d'agenda.
`timeBased()`	`ClockTriggerBuilder`	Crée et renvoie un `ClockTriggerBuilder` pour créer des déclencheurs basés sur le temps.

Documentation détaillée

`forDocument(document)`

Crée et renvoie un DocumentTriggerBuilder associé au document donné.

ScriptApp.newTrigger('myFunction')
    .forDocument(DocumentApp.getActiveDocument())
    .onOpen()
    .create();

Paramètres

Nom	Type	Description
`document`	`Document`	le document

Renvois

DocumentTriggerBuilder : nouveau DocumentTriggerBuilder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`forDocument(key)`

Crée et renvoie un DocumentTriggerBuilder associé au document avec l'ID donné.

ScriptApp.newTrigger('myFunction')
    .forDocument('1234567890abcdefghijklmnopqrstuvwxyz')
    .onOpen()
    .create();

Paramètres

Nom	Type	Description
`key`	`String`	l'ID du document ;

Renvois

DocumentTriggerBuilder : nouveau DocumentTriggerBuilder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`forForm(form)`

Crée et renvoie un FormTriggerBuilder associé au formulaire donné.

ScriptApp.newTrigger('myFunction')
    .forForm(FormApp.getActiveForm())
    .onFormSubmit()
    .create();

Paramètres

Nom	Type	Description
`form`	`Form`	le formulaire

Renvois

FormTriggerBuilder : nouveau FormTriggerBuilder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`forForm(key)`

Crée et renvoie un FormTriggerBuilder associé au formulaire avec l'ID donné.

ScriptApp.newTrigger('myFunction')
    .forForm('1234567890abcdefghijklmnopqrstuvwxyz')
    .onFormSubmit()
    .create();

Paramètres

Nom	Type	Description
`key`	`String`	ID du formulaire

Renvois

FormTriggerBuilder : nouveau FormTriggerBuilder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/forms.currentonly
https://www.googleapis.com/auth/forms

`forSpreadsheet(sheet)`

Crée et renvoie un SpreadsheetTriggerBuilder associé à la feuille de calcul donnée.

ScriptApp.newTrigger('myFunction')
    .forSpreadsheet(SpreadsheetApp.getActive())
    .onEdit()
    .create();

Paramètres

Nom	Type	Description
`sheet`	`Spreadsheet`	la feuille de calcul

Renvois

SpreadsheetTriggerBuilder : nouveau SpreadsheetTriggerBuilder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`forSpreadsheet(key)`

Crée et renvoie un SpreadsheetTriggerBuilder associé à la feuille de calcul avec l'ID donné.

ScriptApp.newTrigger('myFunction')
    .forSpreadsheet('1234567890abcdefghijklmnopqrstuvwxyz')
    .onEdit()
    .create();

Paramètres

Nom	Type	Description
`key`	`String`	l'ID de la feuille de calcul ;

Renvois

SpreadsheetTriggerBuilder : nouveau SpreadsheetTriggerBuilder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/spreadsheets.currentonly
https://www.googleapis.com/auth/spreadsheets

`forUserCalendar(emailId)`

Renvoie un générateur permettant de créer des déclencheurs d'agenda.

Paramètres

Nom	Type	Description
`emailId`	`String`	ID de messagerie de l'agenda utilisateur que le déclencheur surveille.

Renvois

CalendarTriggerBuilder : nouveau CalendarTriggerBuilder.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/calendar.events.readonly
https://www.google.com/calendar/feeds

`timeBased()`

Crée et renvoie un ClockTriggerBuilder pour créer des déclencheurs basés sur le temps.

ScriptApp.newTrigger('myFunction').timeBased().atDate(2013, 10, 31).create();

Renvois

ClockTriggerBuilder : nouveau ClockTriggerBuilder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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