Class ClockTriggerBuilder

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.
ClockTriggerBuilder.

Un compilador para activadores de reloj

Métodos

MétodoTipo de datos que se muestraDescripción breve
after(durationMilliseconds)ClockTriggerBuilderEspecifica la duración mínima (en milisegundos) después de la hora actual en la que se ejecuta el activador.
at(date)ClockTriggerBuilderEspecifica cuándo se ejecuta el activador.
atDate(year, month, day)ClockTriggerBuilderEspecifica que el activador se activa en una fecha determinada, de forma predeterminada, cerca de la medianoche (+/- 15 minutos).
atHour(hour)ClockTriggerBuilderEspecifica la hora en la que se ejecuta el activador.
create()TriggerCrea el activador.
everyDays(n)ClockTriggerBuilderEspecifica que se ejecute el activador cada n días.
everyHours(n)ClockTriggerBuilderEspecifica que se ejecute el activador cada n horas.
everyMinutes(n)ClockTriggerBuilderEspecifica que se ejecute el activador cada n minutos.
everyWeeks(n)ClockTriggerBuilderEspecifica que se ejecute el activador cada n semanas.
inTimezone(timezone)ClockTriggerBuilderEspecifica la zona horaria para las fechas y horas especificadas cuando se ejecuta el activador.
nearMinute(minute)ClockTriggerBuilderEspecifica el minuto en el que se ejecuta el activador (más o menos 15 minutos).
onMonthDay(day)ClockTriggerBuilderEspecifica la fecha del mes en que se ejecuta el activador.
onWeekDay(day)ClockTriggerBuilderEspecifica el día de la semana en que se ejecuta el activador.

Documentación detallada

after(durationMilliseconds)

Especifica la duración mínima (en milisegundos) después de la hora actual en la que se ejecuta el activador. La duración real puede variar, pero no será inferior al mínimo especificado.

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

Parámetros

NombreTipoDescripción
durationMillisecondsIntegerLa duración mínima (en milisegundos) posterior a la hora actual en la que debe ejecutarse el activador.

Volver

ClockTriggerBuilder: el compilador para la cadena.


at(date)

Especifica cuándo se ejecuta el activador.

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

Parámetros

NombreTipoDescripción
dateDateUn objeto de fecha que representa cuándo se debe ejecutar el activador.

Volver

ClockTriggerBuilder: el compilador para la cadena.


atDate(year, month, day)

Especifica que el activador se activa en una fecha determinada, de forma predeterminada, cerca de la medianoche (+/- 15 minutos).

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

Parámetros

NombreTipoDescripción
yearIntegerEl año calendario para programar el activador.
monthIntegerEl mes calendario para programar el activador (debe ser un número entre 1 y 12, ambos incluidos).
dayIntegerEl día calendario para programar el activador (debe ser un número entre 1 y 31 inclusive).

Volver

ClockTriggerBuilder: el compilador para la cadena.


atHour(hour)

Especifica la hora en la que se ejecuta el activador.

// 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();

Parámetros

NombreTipoDescripción
hourIntegerLa hora a la que se activa.

Volver

ClockTriggerBuilder: el compilador para la cadena.


create()

Crea el activador.

Volver

Trigger: El activador programado recién creado.


everyDays(n)

Especifica que se ejecute el activador cada n días.

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

Parámetros

NombreTipoDescripción
nIntegerLa cantidad de días entre ejecuciones.

Volver

ClockTriggerBuilder: el compilador para la cadena.


everyHours(n)

Especifica que se ejecute el activador cada n horas.

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

Parámetros

NombreTipoDescripción
nIntegerLa cantidad de horas entre ejecuciones.

Volver

ClockTriggerBuilder: el compilador para la cadena.


everyMinutes(n)

Especifica que se ejecute el activador cada n minutos. n debe ser 1, 5, 10, 15 o 30.

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

Parámetros

NombreTipoDescripción
nIntegerLa cantidad de minutos entre ejecuciones.

Volver

ClockTriggerBuilder: el compilador para la cadena.


everyWeeks(n)

Especifica que se ejecute el activador cada n semanas.

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

Parámetros

NombreTipoDescripción
nIntegerLa cantidad de semanas entre ejecuciones.

Volver

ClockTriggerBuilder: el compilador para la cadena.


inTimezone(timezone)

Especifica la zona horaria para las fechas y horas especificadas cuando se ejecuta el activador. De forma predeterminada, la zona horaria es la de la secuencia de comandos.

La lista de strings de zona horaria válidas corresponde a las strings de zona horaria válidas que muestra Joda.org. Una string de zona horaria no válida hace que la secuencia de comandos arroje un error.

// 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();

Parámetros

NombreTipoDescripción
timezoneStringLa zona horaria con la que se tratará la información de tiempo en el evento.

Volver

ClockTriggerBuilder: Este ClockTriggerBuilder, para encadenar.


nearMinute(minute)

Especifica el minuto en el que se ejecuta el activador (más o menos 15 minutos). Si no se llama a nearMinute(), se usa un valor de minuto aleatorio.

// 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();

Parámetros

NombreTipoDescripción
minuteIntegerEl minuto en el que se activa.

Volver

ClockTriggerBuilder: el compilador para la cadena.


onMonthDay(day)

Especifica la fecha del mes en que se ejecuta el activador.

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

Parámetros

NombreTipoDescripción
dayIntegerEl día del mes en el que se debe programar el activador.

Volver

ClockTriggerBuilder: el compilador para la cadena.


onWeekDay(day)

Especifica el día de la semana en que se ejecuta el activador.

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

Parámetros

NombreTipoDescripción
dayWeekdayEl día de la semana para activar.

Volver

ClockTriggerBuilder: el compilador para la cadena.