Class RecurrenceRule

Regra de recorrência

Representa uma regra de recorrência para uma série de eventos.

Essa classe também se comporta como a EventRecurrence a que pertence, permitindo que você encadeie a criação de regras, como esta: 

const recurrence = CalendarApp.newRecurrence().addDailyRule().times(3).interval(2).addWeeklyExclusion().times(2);
 Modificadores como times(times) e interval(interval) são aplicados à regra adicionada mais recentemente.

Métodos

MétodoTipo de retornoBreve descrição
addDailyExclusion()RecurrenceRuleAdiciona uma regra que exclui ocorrências diariamente.
addDailyRule()RecurrenceRuleAdiciona uma regra que faz com que o evento ocorra diariamente.
addDate(date)EventRecurrenceAdiciona uma regra que faz com que o evento se repita em uma data específica.
addDateExclusion(date)EventRecurrenceAdiciona uma regra que exclui uma ocorrência em uma data específica.
addMonthlyExclusion()RecurrenceRuleAdiciona uma regra que exclui ocorrências mensalmente.
addMonthlyRule()RecurrenceRuleAdiciona uma regra que faz com que o evento seja recorrente mensalmente.
addWeeklyExclusion()RecurrenceRuleAdiciona uma regra que exclui ocorrências semanalmente.
addWeeklyRule()RecurrenceRuleAdiciona uma regra que faz com que o evento se repita semanalmente.
addYearlyExclusion()RecurrenceRuleAdiciona uma regra que exclui ocorrências anualmente.
addYearlyRule()RecurrenceRuleAdiciona uma regra que faz com que o evento ocorra anualmente.
interval(interval)RecurrenceRuleConfigura a regra para ser aplicada apenas nesse intervalo da unidade de tempo da regra.
onlyInMonth(month)RecurrenceRuleConfigura a regra para aplicar apenas a um mês específico.
onlyInMonths(months)RecurrenceRuleConfigura a regra para aplicar apenas a meses específicos.
onlyOnMonthDay(day)RecurrenceRuleConfigura a regra para que ela seja aplicada apenas a um dia específico do mês.
onlyOnMonthDays(days)RecurrenceRuleConfigura a regra para que ela seja aplicada apenas a dias específicos do mês.
onlyOnWeek(week)RecurrenceRuleConfigura a regra para que ela seja aplicada apenas a uma semana específica do ano.
onlyOnWeekday(day)RecurrenceRuleConfigura a regra para que ela seja aplicada apenas a um dia específico da semana.
onlyOnWeekdays(days)RecurrenceRuleConfigura a regra para que ela seja aplicada apenas em dias específicos da semana.
onlyOnWeeks(weeks)RecurrenceRuleConfigura a regra para que ela seja aplicada apenas a semanas específicas do ano.
onlyOnYearDay(day)RecurrenceRuleConfigura a regra para que ela seja aplicada apenas a um dia específico do ano.
onlyOnYearDays(days)RecurrenceRuleConfigura a regra para que ela seja aplicada apenas em dias específicos do ano.
setTimeZone(timeZone)EventRecurrenceDefine o fuso horário para essa recorrência.
times(times)RecurrenceRuleConfigura a regra para terminar após um determinado número de ocorrências.
until(endDate)RecurrenceRuleConfigura a regra para terminar em uma determinada data (inclusive).
weekStartsOn(day)RecurrenceRuleConfigura o dia da semana em que a regra começa a ser aplicada.

Documentação detalhada

addDailyExclusion()

Adiciona uma regra que exclui ocorrências diariamente. 

// Creates a rule that recurs every week after the first 30 days.
const recurrence =
    CalendarApp.newRecurrence().addWeeklyRule().addDailyExclusion().times(30);

Retornar

RecurrenceRule: a nova RecurrenceRule

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

addDailyRule()

Adiciona uma regra que faz com que o evento ocorra diariamente. 

// Creates a rule that recurs every day for ten days.
const recurrence = CalendarApp.newRecurrence().addDailyRule().times(10);

Retornar

RecurrenceRule: a nova RecurrenceRule

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

addDate(date)

Adiciona uma regra que faz com que o evento se repita em uma data específica.

Parâmetros

NomeTipoDescrição
dateDate

Retornar

EventRecurrence: essa EventRecurrence para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

addDateExclusion(date)

Adiciona uma regra que exclui uma ocorrência em uma data específica.

Parâmetros

NomeTipoDescrição
dateDate

Retornar

EventRecurrence: essa EventRecurrence para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

addMonthlyExclusion()

Adiciona uma regra que exclui ocorrências mensalmente.

Por padrão, a exclusão é aplicada no mesmo dia do mês do primeiro evento da série, mas isso pode ser alterado chamando onlyOnMonthDay(day) ou onlyOnMonthDays(days).

Retornar

RecurrenceRule: a nova RecurrenceRule

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

addMonthlyRule()

Adiciona uma regra que faz com que o evento seja recorrente mensalmente.

Por padrão, o evento é repetido no mesmo dia do mês do primeiro evento da série, mas isso pode ser alterado chamando onlyOnMonthDay(day) ou onlyOnMonthDays(days). 

// Creates a rule that recurs every month for three months.
const recurrence = CalendarApp.newRecurrence().addMonthlyRule().times(4);

Retornar

RecurrenceRule: a nova RecurrenceRule

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

addWeeklyExclusion()

Adiciona uma regra que exclui ocorrências semanalmente.

Por padrão, a exclusão é aplicada no mesmo dia da semana do primeiro evento da série, mas isso pode ser alterado chamando onlyOnWeekday(day) ou onlyOnWeekdays(days). 

// Creates a rule that recurs every day except the first four Wednesdays.
const recurrence = CalendarApp.newRecurrence()
                       .addDailyRule()
                       .addWeeklyExclusion()
                       .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
                       .times(4);

Retornar

RecurrenceRule: a nova RecurrenceRule

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

addWeeklyRule()

Adiciona uma regra que faz com que o evento se repita semanalmente.

Por padrão, o evento é recorrente no mesmo dia da semana do primeiro evento da série, mas isso pode ser alterado chamando onlyOnWeekday(day) ou onlyOnWeekdays(days). 

// Creates a rule that recurs every week for ten weeks.
const recurrence = CalendarApp.newRecurrence().addWeeklyRule().times(10);

Retornar

RecurrenceRule: a nova RecurrenceRule

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

addYearlyExclusion()

Adiciona uma regra que exclui ocorrências anualmente.

Por padrão, a exclusão é aplicada no mesmo dia do ano do primeiro evento da série, mas isso pode ser alterado chamando onlyOnYearDay(day) ou onlyOnYearDays(days).

Retornar

RecurrenceRule: a nova RecurrenceRule

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

addYearlyRule()

Adiciona uma regra que faz com que o evento ocorra anualmente.

Por padrão, o evento é repetido no mesmo dia do ano do primeiro evento da série, mas isso pode ser alterado chamando onlyOnYearDay(day) ou onlyOnYearDays(days).

Retornar

RecurrenceRule: a nova RecurrenceRule

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

interval(interval)

Configura a regra para ser aplicada apenas nesse intervalo da unidade de tempo da regra. 

// Creates a rule that recurs every fourth week.
const recurrence = CalendarApp.newRecurrence().addWeeklyRule().interval(4);

Parâmetros

NomeTipoDescrição
intervalIntegero intervalo na unidade de tempo da regra

Retornar

RecurrenceRule: essa regra de recorrência para encadeamento

onlyInMonth(month)

Configura a regra para aplicar apenas a um mês específico. 

// Creates a rule that recurs every week in February.
const recurrence = CalendarApp.newRecurrence().addWeeklyRule().onlyInMonth(
    CalendarApp.Month.FEBRUARY);

Parâmetros

NomeTipoDescrição
monthMontho mês

Retornar

RecurrenceRule: essa regra de recorrência para encadeamento

onlyInMonths(months)

Configura a regra para aplicar apenas a meses específicos. 

// Creates a rule that recurs every week in February and March.
const recurrence = CalendarApp.newRecurrence().addWeeklyRule().onlyInMonths(
    [CalendarApp.Month.FEBRUARY, CalendarApp.Month.MARCH]);

Parâmetros

NomeTipoDescrição
monthsMonth[]os meses

Retornar

RecurrenceRule: essa regra de recorrência para encadeamento

onlyOnMonthDay(day)

Configura a regra para que ela seja aplicada apenas a um dia específico do mês. 

// Creates a rule that recurs every month on the fifth day of the month.
const recurrence =
    CalendarApp.newRecurrence().addMonthlyRule().onlyOnMonthDay(5);

Parâmetros

NomeTipoDescrição
dayIntegero dia do mês

Retornar

RecurrenceRule: essa regra de recorrência para encadeamento

onlyOnMonthDays(days)

Configura a regra para que ela seja aplicada apenas a dias específicos do mês. 

// Creates a rule that recurs every month on the first and fifteenth day of the
// month.
const recurrence =
    CalendarApp.newRecurrence().addMonthlyRule().onlyOnMonthDays([1, 15]);

Parâmetros

NomeTipoDescrição
daysInteger[]os dias do mês

Retornar

RecurrenceRule: essa regra de recorrência para encadeamento

onlyOnWeek(week)

Configura a regra para que ela seja aplicada apenas a uma semana específica do ano. 

// Creates a rule that recurs on the fifth week of every year.
const recurrence = CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeek(5);

Parâmetros

NomeTipoDescrição
weekIntegera semana

Retornar

RecurrenceRule: essa regra de recorrência para encadeamento

onlyOnWeekday(day)

Configura a regra para que ela seja aplicada apenas a um dia específico da semana. 

// Creates a rule that recurs every week on Wednesdays.
const recurrence = CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeekday(
    CalendarApp.Weekday.WEDNESDAY);

Parâmetros

NomeTipoDescrição
dayWeekdayo dia da semana

Retornar

RecurrenceRule: essa regra de recorrência para encadeamento

onlyOnWeekdays(days)

Configura a regra para que ela seja aplicada apenas em dias específicos da semana. 

// Creates a rule that recurs every week on Tuesdays and Thursdays.
const recurrence = CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeekdays(
    [CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]);

Parâmetros

NomeTipoDescrição
daysWeekday[]os dias da semana

Retornar

RecurrenceRule: essa regra de recorrência para encadeamento

onlyOnWeeks(weeks)

Configura a regra para que ela seja aplicada apenas a semanas específicas do ano. 

// Creates a rule that recurs on the fifth and tenth weeks of every year.
const recurrence =
    CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeeks([5, 10]);

Parâmetros

NomeTipoDescrição
weeksInteger[]as semanas

Retornar

RecurrenceRule: essa regra de recorrência para encadeamento

onlyOnYearDay(day)

Configura a regra para que ela seja aplicada apenas a um dia específico do ano. 

// Creates a rule that recurs every year on February 15 (the 46th day).
const recurrence =
    CalendarApp.newRecurrence().addYearlyRule().onlyOnYearDay(46);

Parâmetros

NomeTipoDescrição
dayIntegero dia do ano

Retornar

RecurrenceRule: essa regra de recorrência para encadeamento

onlyOnYearDays(days)

Configura a regra para que ela seja aplicada apenas em dias específicos do ano. 

// Creates a rule that recurs every year on January 20 and February 15.
const recurrence =
    CalendarApp.newRecurrence().addYearlyRule().onlyOnYearDay([20, 46]);

Parâmetros

NomeTipoDescrição
daysInteger[]os dias do ano

Retornar

RecurrenceRule: essa regra de recorrência para encadeamento

setTimeZone(timeZone)

Define o fuso horário para essa recorrência. Isso afeta a data e a hora em que os eventos são recorrentes e se o evento muda com o horário de verão. O padrão é o fuso horário da agenda.

Parâmetros

NomeTipoDescrição
timeZoneStringo fuso horário, especificado no formato "long" (por exemplo, 'America/New_York', conforme listado por Joda.org)

Retornar

EventRecurrence: essa EventRecurrence para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

times(times)

Configura a regra para terminar após um determinado número de ocorrências. 

// Creates a rule that recurs every day for ten days.
const recurrence = CalendarApp.newRecurrence().addDailyRule().times(10);

Parâmetros

NomeTipoDescrição
timesIntegero número de vezes que a repetição vai ocorrer

Retornar

RecurrenceRule: essa regra de recorrência para encadeamento

until(endDate)

Configura a regra para terminar em uma determinada data (inclusive). 

// Creates a rule that recurs every day through the end of 2013.
const recurrence = CalendarApp.newRecurrence().addDailyRule().until(
    new Date('December 31, 2013'));

Parâmetros

NomeTipoDescrição
endDateDate

Retornar

RecurrenceRule: essa regra de recorrência para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos adequados da API REST relacionada:

  • https://www.googleapis.com/auth/calendar
  • https://www.google.com/calendar/feeds

weekStartsOn(day)

Configura o dia da semana em que a regra começa a ser aplicada. 

// Creates a weekly rule where weeks start on Monday.
const recurrence = CalendarApp.newRecurrence().addWeeklyRule().weekStartsOn(
    CalendarApp.Weekday.MONDAY);

Parâmetros

NomeTipoDescrição
dayWeekdayo dia em que a semana começa

Retornar

RecurrenceRule: essa regra de recorrência para encadeamento