Class RecurrenceRule

RecurrenceRule (link em inglês)

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

Observe que essa classe também se comporta como o EventRecurrence a que pertence, permitindo que você encadeie a criação de regras da seguinte maneira:

recurrence.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 se repita 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 se repita 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 se repita anualmente.
interval(interval)RecurrenceRuleConfigura a regra para ser aplicada somente neste intervalo da unidade de tempo da regra.
onlyInMonth(month)RecurrenceRuleConfigura a regra para ser aplicada somente a um mês específico.
onlyInMonths(months)RecurrenceRuleConfigura a regra para ser aplicada somente a meses específicos.
onlyOnMonthDay(day)RecurrenceRuleConfigura a regra para ser aplicada somente a um dia específico do mês.
onlyOnMonthDays(days)RecurrenceRuleConfigura a regra para ser aplicada somente a dias específicos do mês.
onlyOnWeek(week)RecurrenceRuleConfigura a regra para ser aplicada somente a uma semana específica do ano.
onlyOnWeekday(day)RecurrenceRuleConfigura a regra para ser aplicada somente a um dia específico da semana.
onlyOnWeekdays(days)RecurrenceRuleConfigura a regra para ser aplicada somente a dias específicos da semana.
onlyOnWeeks(weeks)RecurrenceRuleConfigura a regra para ser aplicada somente a semanas específicas do ano.
onlyOnYearDay(day)RecurrenceRuleConfigura a regra para ser aplicada somente a um dia específico do ano.
onlyOnYearDays(days)RecurrenceRuleConfigura a regra para ser aplicada somente a 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 começa a aplicar a regra.

Documentação detalhada

addDailyExclusion()

Adiciona uma regra que exclui ocorrências diariamente.

// Creates a rule that recurs every week after the first 30 days.
var 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 apropriados 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 se repita diariamente.

// Creates a rule that recurs every day for ten days.
var 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 apropriados 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: esta EventRecurrence para encadeamentos

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados 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: esta EventRecurrence para encadeamentos

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados 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 apropriados 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 se repita mensalmente.

Por padrão, o evento se repete 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.
var 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 apropriados 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, como o 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.
var 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 apropriados 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 se repete no mesmo dia da semana, como o 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.
var 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 apropriados 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 apropriados 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 se repita anualmente.

Por padrão, o evento se repete no mesmo dia do ano que o 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 apropriados da API REST relacionada:

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

interval(interval)

Configura a regra para ser aplicada somente neste intervalo da unidade de tempo da regra.

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

Parâmetros

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

Retornar

RecurrenceRule: esta RecurrenceRule para encadeamento


onlyInMonth(month)

Configura a regra para ser aplicada somente a um mês específico.

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

Parâmetros

NomeTipoDescrição
monthMontho mês

Retornar

RecurrenceRule: esta RecurrenceRule para encadeamento


onlyInMonths(months)

Configura a regra para ser aplicada somente a meses específicos.

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

Parâmetros

NomeTipoDescrição
monthsMonth[]os meses

Retornar

RecurrenceRule: esta RecurrenceRule para encadeamento


onlyOnMonthDay(day)

Configura a regra para ser aplicada somente a um dia específico do mês.

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

Parâmetros

NomeTipoDescrição
dayIntegero dia do mês

Retornar

RecurrenceRule: esta RecurrenceRule para encadeamento


onlyOnMonthDays(days)

Configura a regra para ser aplicada somente a dias específicos do mês.

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

Parâmetros

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

Retornar

RecurrenceRule: esta RecurrenceRule para encadeamento


onlyOnWeek(week)

Configura a regra para ser aplicada somente a uma semana específica do ano.

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

Parâmetros

NomeTipoDescrição
weekIntegera semana

Retornar

RecurrenceRule: esta RecurrenceRule para encadeamento


onlyOnWeekday(day)

Configura a regra para ser aplicada somente a um dia específico da semana.

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

Parâmetros

NomeTipoDescrição
dayWeekdayo dia da semana

Retornar

RecurrenceRule: esta RecurrenceRule para encadeamento


onlyOnWeekdays(days)

Configura a regra para ser aplicada somente a dias específicos da semana.

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

Parâmetros

NomeTipoDescrição
daysWeekday[]os dias da semana

Retornar

RecurrenceRule: esta RecurrenceRule para encadeamento


onlyOnWeeks(weeks)

Configura a regra para ser aplicada somente a semanas específicas do ano.

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

Parâmetros

NomeTipoDescrição
weeksInteger[]as semanas

Retornar

RecurrenceRule: esta RecurrenceRule para encadeamento


onlyOnYearDay(day)

Configura a regra para ser aplicada somente a um dia específico do ano.

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

Parâmetros

NomeTipoDescrição
dayIntegero dia do ano

Retornar

RecurrenceRule: esta RecurrenceRule para encadeamento


onlyOnYearDays(days)

Configura a regra para ser aplicada somente a dias específicos do ano.

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

Parâmetros

NomeTipoDescrição
daysInteger[]os dias do ano

Retornar

RecurrenceRule: esta RecurrenceRule para encadeamento


setTimeZone(timeZone)

Define o fuso horário para essa recorrência. Isso afeta a data e a hora em que os eventos se repetem 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, 'América/Nova_York' conforme listado por Joda.org (em inglês)

Retornar

EventRecurrence: esta EventRecurrence para encadeamentos

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados 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.
var recurrence = CalendarApp.newRecurrence().addDailyRule().times(10);

Parâmetros

NomeTipoDescrição
timesIntegero número de vezes recorrentes

Retornar

RecurrenceRule: esta RecurrenceRule 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.
var recurrence = CalendarApp.newRecurrence()
    .addDailyRule().until(new Date('December 31, 2013'));

Parâmetros

NomeTipoDescrição
endDateDate

Retornar

RecurrenceRule: esta RecurrenceRule para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos ou escopos apropriados 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 começa a aplicar a regra.

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

Parâmetros

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

Retornar

RecurrenceRule: esta RecurrenceRule para encadeamento