Outil de création d'horloge.
Méthodes
| Méthode | Type renvoyé | Brève description |
|---|---|---|
after(durationMilliseconds) | ClockTriggerBuilder | Indique la durée minimale (en millisecondes) après l'heure actuelle d'exécution du déclencheur. |
at(date) | ClockTriggerBuilder | Indique le moment où le déclencheur s'exécute. |
atDate(year, month, day) | ClockTriggerBuilder | Indique que le déclencheur s'exécute à 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 | Indique d'exécuter le déclencheur tous les n jours. |
everyHours(n) | ClockTriggerBuilder | Indique d'exécuter le déclencheur toutes les n heures. |
everyMinutes(n) | ClockTriggerBuilder | Spécifie d'exécuter le déclencheur toutes les n minutes. |
everyWeeks(n) | ClockTriggerBuilder | Indique d'exécuter le déclencheur toutes les n semaines. |
inTimezone(timezone) | ClockTriggerBuilder | Indique le fuseau horaire des dates et heures spécifiées lors de l'exécution du déclencheur. |
nearMinute(minute) | ClockTriggerBuilder | Indique la minute à laquelle le déclencheur s'exécute (plus ou moins 15 minutes). |
onMonthDay(day) | ClockTriggerBuilder | Indique la date du mois au cours duquel le déclencheur s'exécute. |
onWeekDay(day) | ClockTriggerBuilder | Indique le jour de la semaine pendant lequel le déclencheur est exécuté. |
Documentation détaillée
after(durationMilliseconds)
Indique la durée minimale (en millisecondes) après l'heure actuelle d'exécution du déclencheur. La durée réelle peut varier, mais elle ne doit pas être 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 d'exécution du déclencheur. |
Aller-retour
ClockTriggerBuilder : compilateur, pour le chaînage
at(date)
Indique le moment où le déclencheur s'exécute.
// Creates a trigger for December 1, 2012
var 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. |
Aller-retour
ClockTriggerBuilder : compilateur, pour le chaînage
atDate(year, month, day)
Indique que le déclencheur s'exécute à 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 calendaire pour planifier le déclencheur |
month | Integer | Mois calendaire pour planifier le déclencheur (doit être un nombre compris entre 1 et 12 inclus). |
day | Integer | Jour calendaire où programmer le déclencheur (doit être un nombre compris entre 1 et 31 inclus). |
Aller-retour
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 de déclenchement. |
Aller-retour
ClockTriggerBuilder : compilateur, pour le chaînage
create()
everyDays(n)
Indique d'exécuter le 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. |
Aller-retour
ClockTriggerBuilder : compilateur, pour le chaînage
everyHours(n)
Indique d'exécuter le 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. |
Aller-retour
ClockTriggerBuilder : compilateur, pour le chaînage
everyMinutes(n)
Spécifie d'exécuter le déclencheur toutes les n minutes. n doit être 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. |
Aller-retour
ClockTriggerBuilder : compilateur, pour le chaînage
everyWeeks(n)
Indique d'exécuter le déclencheur toutes les n semaines.
ScriptApp.newTrigger("myFunction")
.timeBased()
.everyWeeks(2)
.create();
Paramètres
| Nom | Type | Description |
|---|---|---|
n | Integer | Nombre de semaines entre les exécutions. |
Aller-retour
ClockTriggerBuilder : compilateur, pour le chaînage
inTimezone(timezone)
Indique le fuseau horaire des dates et heures spécifiées lors de l'exécution du déclencheur. 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 répertoriées par Joda.org. Si le fuseau horaire n'est pas valide, le script génère une erreur.
// 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. |
Aller-retour
ClockTriggerBuilder : cet élément (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 feu doit être déclenché. |
Aller-retour
ClockTriggerBuilder : compilateur, pour le chaînage
onMonthDay(day)
Indique la date du mois au cours duquel 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 au cours duquel le déclencheur doit être planifié. |
Aller-retour
ClockTriggerBuilder : compilateur, pour le chaînage
onWeekDay(day)
Indique le jour de la semaine pendant lequel le déclencheur est exécuté.
ScriptApp.newTrigger("myFunction")
.timeBased()
.onWeekDay(ScriptApp.WeekDay.FRIDAY)
.create();
Paramètres
| Nom | Type | Description |
|---|---|---|
day | Weekday | Jour de la semaine pour le feu. |
Aller-retour
ClockTriggerBuilder : compilateur, pour le chaînage