Class ClockTriggerBuilder

ClockTriggerBuilder

Compilateur pour les déclencheurs d'horloge.

Méthodes

MéthodeType renvoyéBrève description
after(durationMilliseconds)ClockTriggerBuilderSpécifie la durée minimale (en millisecondes) après l'heure actuelle d'exécution du déclencheur.
at(date)ClockTriggerBuilderIndique le moment où le déclencheur s'exécute.
atDate(year, month, day)ClockTriggerBuilderIndique que le déclencheur s'exécute à la date donnée, par défaut vers minuit (+/- 15 minutes).
atHour(hour)ClockTriggerBuilderSpécifie l'heure à laquelle le déclencheur s'exécute.
create()TriggerCrée le déclencheur.
everyDays(n)ClockTriggerBuilderSpécifie l'exécution du déclencheur tous les n jours.
everyHours(n)ClockTriggerBuilderSpécifie l'exécution du déclencheur toutes les n heures.
everyMinutes(n)ClockTriggerBuilderSpécifie l'exécution du déclencheur toutes les n minutes.
everyWeeks(n)ClockTriggerBuilderSpécifie l'exécution du déclencheur toutes les n semaines.
inTimezone(timezone)ClockTriggerBuilderSpécifie le fuseau horaire des dates/heures spécifiées d'exécution du déclencheur.
nearMinute(minute)ClockTriggerBuilderSpécifie la minute à laquelle le déclencheur s'exécute (plus ou moins 15 minutes).
onMonthDay(day)ClockTriggerBuilderSpécifie la date du mois d'exécution du déclencheur.
onWeekDay(day)ClockTriggerBuilderSpécifie 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 d'exécution du déclencheur. La durée réelle peut varier, mais ne sera pas inférieure au minimum spécifié.

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

Paramètres

NomTypeDescription
durationMillisecondsIntegerDurée minimale (en millisecondes) après l'heure actuelle d'exécution du déclencheur.

Renvois

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

NomTypeDescription
dateDateObjet Date représentant le moment auquel le déclencheur doit s'exécuter.

Renvois

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

NomTypeDescription
yearIntegerAnnée civile dans laquelle planifier le déclencheur.
monthIntegerMois calendaire au cours duquel le déclencheur doit être planifié (il doit s'agir d'un nombre compris entre 1 et 12 inclus).
dayIntegerJour calendaire de programmation du déclencheur (il doit s'agir d'un nombre compris entre 1 et 31 inclus).

Renvois

ClockTriggerBuilder : compilateur, pour le chaînage.


atHour(hour)

Spécifie 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

NomTypeDescription
hourIntegerHeure à laquelle le tir doit être déclenché.

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

NomTypeDescription
nIntegerNombre 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

NomTypeDescription
nIntegerNombre 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

NomTypeDescription
nIntegerNombre de minutes entre les exécutions.

Renvois

ClockTriggerBuilder : compilateur, pour le chaînage.


everyWeeks(n)

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

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

Paramètres

NomTypeDescription
nIntegerNombre de semaines entre les exécutions.

Renvois

ClockTriggerBuilder : compilateur, pour le chaînage.


inTimezone(timezone)

Spécifie le fuseau horaire des dates/heures spécifiées d'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 listées sur Joda.org. Si la chaîne de 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

NomTypeDescription
timezoneStringFuseau horaire à utiliser pour traiter les informations temporelles de l'événement.

Renvois

ClockTriggerBuilder : ClockTriggerBuilder, pour le chaînage.


nearMinute(minute)

Spécifie la minute à laquelle le déclencheur s'exécute (plus ou moins 15 minutes). Si nearMinute() n'est pas appelé, une valeur de minutes 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

NomTypeDescription
minuteIntegerMinute à laquelle se déclenche le tir.

Renvois

ClockTriggerBuilder : compilateur, pour le chaînage.


onMonthDay(day)

Spécifie la date du mois d'exécution du déclencheur.

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

Paramètres

NomTypeDescription
dayIntegerJour du mois pour lequel le déclencheur doit être programmé.

Renvois

ClockTriggerBuilder : compilateur, pour le chaînage.


onWeekDay(day)

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

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

Paramètres

NomTypeDescription
dayWeekdayJour de la semaine du déclenchement.

Renvois

ClockTriggerBuilder : compilateur, pour le chaînage.