Esta página foi traduzida pela API Cloud Translation.

Class ClockTriggerBuilder

Um builder para gatilhos de relógio.

Métodos

Método	Tipo de retorno	Breve descrição
`after(durationMilliseconds)`	`ClockTriggerBuilder`	Especifica a duração mínima (em milissegundos) após o tempo atual em que o acionador é executado.
`at(date)`	`ClockTriggerBuilder`	Especifica quando o gatilho é executado.
`atDate(year, month, day)`	`ClockTriggerBuilder`	Especifica que o acionador será disparado na data especificada, por padrão, perto da meia-noite (+/- 15 minutos).
`atHour(hour)`	`ClockTriggerBuilder`	Especifica a hora em que o gatilho é executado.
`create()`	`Trigger`	Cria o gatilho.
`everyDays(n)`	`ClockTriggerBuilder`	Especifica a execução do acionador a cada `n` dias.
`everyHours(n)`	`ClockTriggerBuilder`	Especifica a execução do acionador a cada `n` horas.
`everyMinutes(n)`	`ClockTriggerBuilder`	Especifica a execução do gatilho a cada `n` minutos.
`everyWeeks(n)`	`ClockTriggerBuilder`	Especifica a execução do acionador a cada `n` semanas.
`inTimezone(timezone)`	`ClockTriggerBuilder`	Especifica o fuso horário das datas/horas especificadas quando o acionador é executado.
`nearMinute(minute)`	`ClockTriggerBuilder`	Especifica o minuto em que o acionador é executado (mais ou menos 15 minutos).
`onMonthDay(day)`	`ClockTriggerBuilder`	Especifica a data no mês em que o acionador é executado.
`onWeekDay(day)`	`ClockTriggerBuilder`	Especifica 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á menor que o mínimo especificado.

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

Parâmetros

Nome	Tipo	Descrição
`durationMilliseconds`	`Integer`	Duração mínima (em milissegundos) após o tempo atual em que o acionador precisa ser executado.

Retorno

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

Nome	Tipo	Descrição
`date`	`Date`	Um objeto Date que representa quando o acionador deve ser executado.

Retorno

ClockTriggerBuilder: o builder, para encadeamento.

`atDate(year, month, day)`

Especifica que o acionador será disparado na data especificada, 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

Nome	Tipo	Descrição
`year`	`Integer`	O ano civil para programar o acionador.
`month`	`Integer`	O mês para programar o acionador (precisa ser um número entre 1 e 12, inclusive).
`day`	`Integer`	O dia do calendário para programar o acionador (precisa ser um número entre 1 e 31).

Retorno

ClockTriggerBuilder: o builder, para encadeamento.

`atHour(hour)`

Especifica a hora em que o gatilho é 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

Nome	Tipo	Descrição
`hour`	`Integer`	A hora em que disparar.

Retorno

ClockTriggerBuilder: o builder, para encadeamento.

`create()`

Cria o gatilho.

Retorno

Trigger: o acionador programado recém-criado.

`everyDays(n)`

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

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

Parâmetros

Nome	Tipo	Descrição
`n`	`Integer`	O número de dias entre as execuções.

Retorno

ClockTriggerBuilder: o builder, para encadeamento.

`everyHours(n)`

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

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

Parâmetros

Nome	Tipo	Descrição
`n`	`Integer`	O número de horas entre as execuções.

Retorno

ClockTriggerBuilder: o builder, para encadeamento.

`everyMinutes(n)`

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

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

Parâmetros

Nome	Tipo	Descrição
`n`	`Integer`	O número de minutos entre as execuções.

Retorno

ClockTriggerBuilder: o builder, para encadeamento.

`everyWeeks(n)`

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

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

Parâmetros

Nome	Tipo	Descrição
`n`	`Integer`	O número de semanas entre as execuções.

Retorno

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 fusos horários válidas listadas por Joda.org (link 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

Nome	Tipo	Descrição
`timezone`	`String`	O fuso horário com o qual as informações de horário serão tratadas no evento.

Retorno

ClockTriggerBuilder: este ClockTriggerBuilder, para encadeamento.

`nearMinute(minute)`

Especifica o minuto em que o acionador é 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

Nome	Tipo	Descrição
`minute`	`Integer`	O minuto em que disparar.

Retorno

ClockTriggerBuilder: o builder, para encadeamento.

`onMonthDay(day)`

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

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

Parâmetros

Nome	Tipo	Descrição
`day`	`Integer`	O dia do mês para o qual o acionador deve ser programado.

Retorno

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

Nome	Tipo	Descrição
`day`	`Weekday`	O dia da semana para disparar.

Retorno

ClockTriggerBuilder: o builder, para encadeamento.