Class ClockTriggerBuilder

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
ClockTriggerBuilder

Um builder para gatilhos de relógio.

Métodos

MétodoTipo de retornoBreve descrição
after(durationMilliseconds)ClockTriggerBuilderEspecifica a duração mínima (em milissegundos) após o tempo atual em que o acionador é executado.
at(date)ClockTriggerBuilderEspecifica quando o gatilho é executado.
atDate(year, month, day)ClockTriggerBuilderEspecifica que o acionador é disparado em uma determinada data, por padrão, perto da meia-noite (+/- 15 minutos).
atHour(hour)ClockTriggerBuilderEspecifica o horário em que o acionador é executado.
create()TriggerCria o gatilho.
everyDays(n)ClockTriggerBuilderEspecifica a execução do gatilho a cada n dias.
everyHours(n)ClockTriggerBuilderEspecifica a execução do gatilho a cada n horas.
everyMinutes(n)ClockTriggerBuilderEspecifica a execução do gatilho a cada n minutos.
everyWeeks(n)ClockTriggerBuilderEspecifica a execução do gatilho a cada n semanas.
inTimezone(timezone)ClockTriggerBuilderEspecifica o fuso horário das datas/horas especificadas quando o acionador é executado.
nearMinute(minute)ClockTriggerBuilderEspecifica o minuto em que o gatilho é executado (mais ou menos 15 minutos).
onMonthDay(day)ClockTriggerBuilderEspecifica a data do mês em que o acionador é executado.
onWeekDay(day)ClockTriggerBuilderEspecifica o dia da semana em que o acionador é executado.

Documentação detalhada

after(durationMilliseconds)

Especifica a duração mínima (em milissegundos) após o tempo atual em que o acionador é executado. A duração real pode variar, mas não será inferior ao mínimo especificado.

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

Parâmetros

NomeTipoDescrição
durationMillisecondsIntegerA duração mínima (em milissegundos) após o momento atual em que o gatilho precisa ser executado.

Retornar

ClockTriggerBuilder: o builder, para encadeamento.


at(date)

Especifica quando o gatilho é executado.

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

Parâmetros

NomeTipoDescrição
dateDateUm objeto Date que representa quando o gatilho será executado.

Retornar

ClockTriggerBuilder: o builder, para encadeamento.


atDate(year, month, day)

Especifica que o acionador é disparado em uma determinada data, por padrão, perto da meia-noite (+/- 15 minutos).

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

Parâmetros

NomeTipoDescrição
yearIntegerO ano do calendário para o qual o acionador será programado.
monthIntegerO mês do calendário para programar o gatilho (deve ser um número entre 1 e 12, incluindo esses dois valores).
dayIntegerO dia do calendário para programar o gatilho (deve ser um número entre 1 e 31, incluindo esses dois valores).

Retornar

ClockTriggerBuilder: o builder, para encadeamento.


atHour(hour)

Especifica o horário em que o acionador é executado.

// 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

NomeTipoDescrição
hourIntegerA hora em que disparar.

Retornar

ClockTriggerBuilder: o builder, para encadeamento.


create()

Cria o gatilho.

Retornar

Trigger: o gatilho programado recém-criado.


everyDays(n)

Especifica a execução do gatilho a cada n dias.

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

Parâmetros

NomeTipoDescrição
nIntegerO número de dias entre execuções.

Retornar

ClockTriggerBuilder: o builder, para encadeamento.


everyHours(n)

Especifica a execução do gatilho a cada n horas.

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

Parâmetros

NomeTipoDescrição
nIntegerO número de horas entre execuções.

Retornar

ClockTriggerBuilder: o builder, para encadeamento.


everyMinutes(n)

Especifica a execução do gatilho a cada n minutos. O n precisa ser 1, 5, 10, 15 ou 30.

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

Parâmetros

NomeTipoDescrição
nIntegerO número de minutos entre as execuções.

Retornar

ClockTriggerBuilder: o builder, para encadeamento.


everyWeeks(n)

Especifica a execução do gatilho a cada n semanas.

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

Parâmetros

NomeTipoDescrição
nIntegerO número de semanas entre execuções.

Retornar

ClockTriggerBuilder: o builder, para encadeamento.


inTimezone(timezone)

Especifica o fuso horário das datas/horas especificadas quando o acionador é executado. Por padrão, o fuso horário é o do script.

A lista de strings de fusos horários válidas corresponde às strings de fuso horário válidas listadas por Joda.org (em inglês). Uma string de fuso horário inválida faz com que o script gere um erro.

// 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

NomeTipoDescrição
timezoneStringÉ o fuso horário com que as informações de horário serão tratadas no evento.

Retornar

ClockTriggerBuilder: este ClockTriggerBuilder para encadeamento.


nearMinute(minute)

Especifica o minuto em que o gatilho é executado (mais ou menos 15 minutos). Se nearMinute() não for chamado, um valor de minuto aleatório será usado.

// 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

NomeTipoDescrição
minuteIntegerO minuto para disparar.

Retornar

ClockTriggerBuilder: o builder, para encadeamento.


onMonthDay(day)

Especifica a data do mês em que o acionador é executado.

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

Parâmetros

NomeTipoDescrição
dayIntegerO dia do mês em que o acionador será programado.

Retornar

ClockTriggerBuilder: o builder, para encadeamento.


onWeekDay(day)

Especifica o dia da semana em que o acionador é executado.

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

Parâmetros

NomeTipoDescrição
dayWeekdayO dia da semana a ser disparado.

Retornar

ClockTriggerBuilder: o builder, para encadeamento.