Class RecurrenceRule

RecurrenceRule

Representa una regla de recurrencia para una serie de eventos.

Ten en cuenta que esta clase también se comporta como el EventRecurrence al que pertenece, lo que te permite encadenar la creación de reglas de la siguiente manera: 

const recurrence = CalendarApp.newRecurrence().addDailyRule().times(3).interval(2).addWeeklyExclusion().times(2);
 Los modificadores como times(times) y interval(interval) se aplican a la regla agregada más recientemente.

Métodos

MétodoTipo de datos que se devuelveDescripción breve
addDailyExclusion()RecurrenceRuleAgrega una regla que excluye las ocurrencias de forma diaria.
addDailyRule()RecurrenceRuleAgrega una regla que hace que el evento se repita a diario.
addDate(date)EventRecurrenceAgrega una regla que hace que el evento se repita en una fecha específica.
addDateExclusion(date)EventRecurrenceAgrega una regla que excluye una ocurrencia para una fecha específica.
addMonthlyExclusion()RecurrenceRuleAgrega una regla que excluye las ocurrencias de forma mensual.
addMonthlyRule()RecurrenceRuleAgrega una regla que hace que el evento se repita mensualmente.
addWeeklyExclusion()RecurrenceRuleAgrega una regla que excluye las ocurrencias de forma semanal.
addWeeklyRule()RecurrenceRuleAgrega una regla que hace que el evento se repita semanalmente.
addYearlyExclusion()RecurrenceRuleAgrega una regla que excluye las ocurrencias de forma anual.
addYearlyRule()RecurrenceRuleAgrega una regla que hace que el evento se repita anualmente.
interval(interval)RecurrenceRuleConfigura la regla para que solo se aplique en este intervalo de la unidad de tiempo de la regla.
onlyInMonth(month)RecurrenceRuleConfigura la regla para que solo se aplique a un mes específico.
onlyInMonths(months)RecurrenceRuleConfigura la regla para que solo se aplique a meses específicos.
onlyOnMonthDay(day)RecurrenceRuleConfigura la regla para que solo se aplique a un día específico del mes.
onlyOnMonthDays(days)RecurrenceRuleConfigura la regla para que solo se aplique a días específicos del mes.
onlyOnWeek(week)RecurrenceRuleConfigura la regla para que solo se aplique a una semana específica del año.
onlyOnWeekday(day)RecurrenceRuleConfigura la regla para que solo se aplique a un día específico de la semana.
onlyOnWeekdays(days)RecurrenceRuleConfigura la regla para que solo se aplique a días específicos de la semana.
onlyOnWeeks(weeks)RecurrenceRuleConfigura la regla para que solo se aplique a semanas específicas del año.
onlyOnYearDay(day)RecurrenceRuleConfigura la regla para que solo se aplique a un día específico del año.
onlyOnYearDays(days)RecurrenceRuleConfigura la regla para que solo se aplique a días específicos del año.
setTimeZone(timeZone)EventRecurrenceEstablece la zona horaria para esta recurrencia.
times(times)RecurrenceRuleConfigura la regla para que finalice después de una cantidad determinada de repeticiones.
until(endDate)RecurrenceRuleConfigura la regla para que finalice en una fecha determinada (inclusive).
weekStartsOn(day)RecurrenceRuleConfigura qué día comienza la semana a los efectos de aplicar la regla.

Documentación detallada

addDailyExclusion()

Agrega una regla que excluye las ocurrencias de forma diaria. 

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

Volver

RecurrenceRule: Es el nuevo RecurrenceRule.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

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

addDailyRule()

Agrega una regla que hace que el evento se repita a diario. 

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

Volver

RecurrenceRule: Es el nuevo RecurrenceRule.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

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

addDate(date)

Agrega una regla que hace que el evento se repita en una fecha específica.

Parámetros

NombreTipoDescripción
dateDate

Volver

EventRecurrence: Este EventRecurrence para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

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

addDateExclusion(date)

Agrega una regla que excluye una ocurrencia para una fecha específica.

Parámetros

NombreTipoDescripción
dateDate

Volver

EventRecurrence: Este EventRecurrence para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

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

addMonthlyExclusion()

Agrega una regla que excluye las ocurrencias de forma mensual.

De forma predeterminada, la exclusión se aplica el mismo día del mes que el primer evento de la serie, pero esto se puede modificar llamando a onlyOnMonthDay(day) o onlyOnMonthDays(days).

Volver

RecurrenceRule: Es el nuevo RecurrenceRule.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

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

addMonthlyRule()

Agrega una regla que hace que el evento se repita mensualmente.

De forma predeterminada, el evento se repite el mismo día del mes que el primer evento de la serie, pero esto se puede modificar llamando a onlyOnMonthDay(day) o onlyOnMonthDays(days). 

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

Volver

RecurrenceRule: Es el nuevo RecurrenceRule.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

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

addWeeklyExclusion()

Agrega una regla que excluye las ocurrencias de forma semanal.

De forma predeterminada, la exclusión se aplica el mismo día de la semana que el primer evento de la serie, pero esto se puede modificar llamando a onlyOnWeekday(day) o 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);

Volver

RecurrenceRule: Es el nuevo RecurrenceRule.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

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

addWeeklyRule()

Agrega una regla que hace que el evento se repita semanalmente.

De forma predeterminada, el evento se repite el mismo día de la semana que el primer evento de la serie, pero esto se puede modificar llamando a onlyOnWeekday(day) o onlyOnWeekdays(days). 

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

Volver

RecurrenceRule: Es el nuevo RecurrenceRule.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

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

addYearlyExclusion()

Agrega una regla que excluye las ocurrencias de forma anual.

De forma predeterminada, la exclusión se aplica el mismo día del año que el primer evento de la serie, pero esto se puede modificar llamando a onlyOnYearDay(day) o onlyOnYearDays(days).

Volver

RecurrenceRule: Es el nuevo RecurrenceRule.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

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

addYearlyRule()

Agrega una regla que hace que el evento se repita anualmente.

De forma predeterminada, el evento se repite el mismo día del año que el primer evento de la serie, pero esto se puede modificar llamando a onlyOnYearDay(day) o onlyOnYearDays(days).

Volver

RecurrenceRule: Es el nuevo RecurrenceRule.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

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

interval(interval)

Configura la regla para que solo se aplique en este intervalo de la unidad de tiempo de la regla. 

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

Parámetros

NombreTipoDescripción
intervalIntegerEl intervalo en la unidad de tiempo de la regla

Volver

RecurrenceRule: Este RecurrenceRule para encadenar

onlyInMonth(month)

Configura la regla para que solo se aplique a un mes específico. 

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

Parámetros

NombreTipoDescripción
monthMonthel mes

Volver

RecurrenceRule: Este RecurrenceRule para encadenar

onlyInMonths(months)

Configura la regla para que solo se aplique 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

NombreTipoDescripción
monthsMonth[]los meses

Volver

RecurrenceRule: Este RecurrenceRule para encadenar

onlyOnMonthDay(day)

Configura la regla para que solo se aplique a un día específico del mes. 

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

Parámetros

NombreTipoDescripción
dayIntegerEl día del mes

Volver

RecurrenceRule: Este RecurrenceRule para encadenar

onlyOnMonthDays(days)

Configura la regla para que solo se aplique a días específicos del mes. 

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

NombreTipoDescripción
daysInteger[]Los días del mes

Volver

RecurrenceRule: Este RecurrenceRule para encadenar

onlyOnWeek(week)

Configura la regla para que solo se aplique a una semana específica del año. 

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

Parámetros

NombreTipoDescripción
weekIntegerla semana

Volver

RecurrenceRule: Este RecurrenceRule para encadenar

onlyOnWeekday(day)

Configura la regla para que solo se aplique a un día específico de la semana. 

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

Parámetros

NombreTipoDescripción
dayWeekdayEl día de la semana

Volver

RecurrenceRule: Este RecurrenceRule para encadenar

onlyOnWeekdays(days)

Configura la regla para que solo se aplique a días específicos de la 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

NombreTipoDescripción
daysWeekday[]los días de la semana

Volver

RecurrenceRule: Este RecurrenceRule para encadenar

onlyOnWeeks(weeks)

Configura la regla para que solo se aplique a semanas específicas del año. 

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

Parámetros

NombreTipoDescripción
weeksInteger[]las semanas

Volver

RecurrenceRule: Este RecurrenceRule para encadenar

onlyOnYearDay(day)

Configura la regla para que solo se aplique a un día específico del año. 

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

Parámetros

NombreTipoDescripción
dayIntegerEl día del año

Volver

RecurrenceRule: Este RecurrenceRule para encadenar

onlyOnYearDays(days)

Configura la regla para que solo se aplique a días específicos del año. 

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

Parámetros

NombreTipoDescripción
daysInteger[]los días del año

Volver

RecurrenceRule: Este RecurrenceRule para encadenar

setTimeZone(timeZone)

Establece la zona horaria para esta recurrencia. Esto afecta la fecha y la hora en que se repiten los eventos, y si el evento cambia con el horario de verano. El valor predeterminado es la zona horaria del calendario.

Parámetros

NombreTipoDescripción
timeZoneStringLa zona horaria, especificada en formato "largo" (p.ej., "America/New_York", como se indica en Joda.org)

Volver

EventRecurrence: Este EventRecurrence para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

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

times(times)

Configura la regla para que finalice después de una cantidad determinada de repeticiones. 

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

Parámetros

NombreTipoDescripción
timesIntegerLa cantidad de veces que se repetirá

Volver

RecurrenceRule: Este RecurrenceRule para encadenar

until(endDate)

Configura la regla para que finalice en una fecha determinada (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

NombreTipoDescripción
endDateDate

Volver

RecurrenceRule: Este RecurrenceRule para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:

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

weekStartsOn(day)

Configura qué día comienza la semana a los efectos de aplicar la regla. 

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

Parámetros

NombreTipoDescripción
dayWeekdayEl día en que comienza la semana

Volver

RecurrenceRule: Este RecurrenceRule para encadenar