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

Class ClockTriggerBuilder

Compilateur pour les déclencheurs horaires.

Méthodes

Méthode	Type renvoyé	Brève description
`after(durationMilliseconds)`	`ClockTriggerBuilder`	Spécifie la durée minimale (en millisecondes) après l'heure actuelle pendant laquelle le déclencheur s'exécute.
`at(date)`	`ClockTriggerBuilder`	Indique quand le déclencheur s'exécute.
`atDate(year, month, day)`	`ClockTriggerBuilder`	Indique que le déclencheur se déclenche à la date donnée, par défaut vers minuit (+/- 15 minutes).
`atHour(hour)`	`ClockTriggerBuilder`	Indique l'heure à laquelle le déclencheur s'exécute.
`create()`	`Trigger`	Crée le déclencheur.
`everyDays(n)`	`ClockTriggerBuilder`	Spécifie l'exécution du déclencheur tous les `n` jours.
`everyHours(n)`	`ClockTriggerBuilder`	Spécifie l'exécution du déclencheur toutes les `n` heures.
`everyMinutes(n)`	`ClockTriggerBuilder`	Spécifie l'exécution du déclencheur toutes les `n` minutes.
`everyWeeks(n)`	`ClockTriggerBuilder`	Indique que le déclencheur doit s'exécuter toutes les `n` semaines.
`inTimezone(timezone)`	`ClockTriggerBuilder`	Spécifie le fuseau horaire pour les dates/heures spécifiées lorsque le déclencheur s'exécute.
`nearMinute(minute)`	`ClockTriggerBuilder`	Indique la minute à laquelle le déclencheur s'exécute (plus ou moins 15 minutes).
`onMonthDay(day)`	`ClockTriggerBuilder`	Spécifie la date du mois à laquelle le déclencheur s'exécute.
`onWeekDay(day)`	`ClockTriggerBuilder`	Indique le jour de la semaine où le déclencheur s'exécute.

Documentation détaillée

`after(durationMilliseconds)`

Spécifie la durée minimale (en millisecondes) après l'heure actuelle pendant laquelle le déclencheur s'exécute. La durée réelle peut varier, mais elle ne sera pas inférieure à la durée minimale spécifiée.

// Creates a trigger that runs 10 minutes later
ScriptApp.newTrigger('myFunction').timeBased().after(10 * 60 * 1000).create();

Paramètres

Nom	Type	Description
`durationMilliseconds`	`Integer`	Durée minimale (en millisecondes) après l'heure actuelle à laquelle le déclencheur doit s'exécuter.

Renvois

ClockTriggerBuilder : compilateur, pour le chaînage.

`at(date)`

Indique quand le déclencheur s'exécute.

// Creates a trigger for December 1, 2012
const triggerDay = new Date(2012, 11, 1);
ScriptApp.newTrigger('myFunction').timeBased().at(triggerDay).create();

Paramètres

Nom	Type	Description
`date`	`Date`	Objet Date représentant le moment où le déclencheur doit s'exécuter.

Renvois

ClockTriggerBuilder : compilateur, pour le chaînage.

`atDate(year, month, day)`

Indique que le déclencheur se déclenche à la date donnée, par défaut vers minuit (+/- 15 minutes).

// Schedules for January 1st, 2013
ScriptApp.newTrigger('myFunction').timeBased().atDate(2013, 1, 1).create();

Paramètres

Nom	Type	Description
`year`	`Integer`	Année civile pour planifier le déclencheur.
`month`	`Integer`	Mois du calendrier pour planifier le déclencheur (doit être un nombre compris entre 1 et 12 inclus).
`day`	`Integer`	Jour du calendrier pour planifier le déclencheur (doit être un nombre compris entre 1 et 31, inclus).

Renvois

ClockTriggerBuilder : compilateur, pour le chaînage.

`atHour(hour)`

Indique l'heure à laquelle le déclencheur s'exécute.

// Runs between 5am-6am in the timezone of the script
ScriptApp.newTrigger('myFunction')
    .timeBased()
    .atHour(5)
    .everyDays(
        1)  // Frequency is required if you are using atHour() or nearMinute()
    .create();

Paramètres

Nom	Type	Description
`hour`	`Integer`	Heure à laquelle l'événement doit se déclencher.

Renvois

ClockTriggerBuilder : compilateur, pour le chaînage.

`create()`

Crée le déclencheur.

Renvois

Trigger : déclencheur planifié nouvellement créé.

`everyDays(n)`

Spécifie l'exécution du déclencheur tous les n jours.

ScriptApp.newTrigger('myFunction').timeBased().everyDays(3).create();

Paramètres

Nom	Type	Description
`n`	`Integer`	Nombre de jours entre les exécutions.

Renvois

ClockTriggerBuilder : compilateur, pour le chaînage.

`everyHours(n)`

Spécifie l'exécution du déclencheur toutes les n heures.

ScriptApp.newTrigger('myFunction').timeBased().everyHours(12).create();

Paramètres

Nom	Type	Description
`n`	`Integer`	Nombre d'heures entre les exécutions.

Renvois

ClockTriggerBuilder : compilateur, pour le chaînage.

`everyMinutes(n)`

Spécifie l'exécution du déclencheur toutes les n minutes. n doit être défini sur 1, 5, 10, 15 ou 30.

ScriptApp.newTrigger('myFunction').timeBased().everyMinutes(10).create();

Paramètres

Nom	Type	Description
`n`	`Integer`	Nombre de minutes entre les exécutions.

Renvois

ClockTriggerBuilder : compilateur, pour le chaînage.

`everyWeeks(n)`

Indique que le déclencheur doit s'exécuter toutes les n semaines.

ScriptApp.newTrigger('myFunction')
    .timeBased()
    .everyWeeks(2)
    .onWeekDay(ScriptApp.WeekDay.FRIDAY)
    .create();

Paramètres

Nom	Type	Description
`n`	`Integer`	Nombre de semaines entre les exécutions.

Renvois

ClockTriggerBuilder : compilateur, pour le chaînage.

`inTimezone(timezone)`

Spécifie le fuseau horaire pour les dates/heures spécifiées lorsque le déclencheur s'exécute. Par défaut, le fuseau horaire est celui du script.

La liste des chaînes de fuseau horaire valides correspond aux chaînes de fuseau horaire valides listées par Joda.org. Une chaîne de fuseau horaire non valide génère une erreur dans le script.

// Schedule the trigger to execute at noon every day in the US/Pacific time zone
ScriptApp.newTrigger('myFunction')
    .timeBased()
    .atHour(12)
    .everyDays(1)
    .inTimezone('America/Los_Angeles')
    .create();

Paramètres

Nom	Type	Description
`timezone`	`String`	Fuseau horaire à utiliser pour traiter les informations temporelles de l'événement.

Renvois

ClockTriggerBuilder : ClockTriggerBuilder pour le chaînage.

`nearMinute(minute)`

Indique la minute à laquelle le déclencheur s'exécute (plus ou moins 15 minutes). Si nearMinute() n'est pas appelé, une valeur de minute aléatoire est utilisée.

// Runs at approximately 5:30am in the timezone of the script
ScriptApp.newTrigger('myFunction')
    .timeBased()
    .atHour(5)
    .nearMinute(30)
    .everyDays(
        1)  // Frequency is required if you are using atHour() or nearMinute()
    .create();

Paramètres

Nom	Type	Description
`minute`	`Integer`	Minute à laquelle le déclenchement doit se produire.

Renvois

ClockTriggerBuilder : compilateur, pour le chaînage.

`onMonthDay(day)`

Spécifie la date du mois à laquelle le déclencheur s'exécute.

// Schedules for the first of every month
ScriptApp.newTrigger('myFunction').timeBased().onMonthDay(1).create();

Paramètres

Nom	Type	Description
`day`	`Integer`	Jour du mois auquel le déclencheur doit être planifié.

Renvois

ClockTriggerBuilder : compilateur, pour le chaînage.

`onWeekDay(day)`

Indique le jour de la semaine où le déclencheur s'exécute.

ScriptApp.newTrigger('myFunction')
    .timeBased()
    .onWeekDay(ScriptApp.WeekDay.FRIDAY)
    .create();

Paramètres

Nom	Type	Description
`day`	`Weekday`	Jour de la semaine à exécuter.

Renvois

ClockTriggerBuilder : compilateur, pour le chaînage.