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:
recurrence.addDailyRule().times(3).interval(2).addWeeklyExclusion().times(2);Los modificadores como
times(times)
y interval(interval)
se aplican a la regla que se agregó más recientemente.Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
addDailyExclusion() | RecurrenceRule | Agrega una regla que excluye los casos diariamente. |
addDailyRule() | RecurrenceRule | Agrega una regla que provoca que el evento se repita todos los días. |
addDate(date) | EventRecurrence | Agrega una regla que provoca que el evento se repita en una fecha específica. |
addDateExclusion(date) | EventRecurrence | Agrega una regla que excluye un caso en una fecha específica. |
addMonthlyExclusion() | RecurrenceRule | Agrega una regla que excluye los casos de forma mensual. |
addMonthlyRule() | RecurrenceRule | Agrega una regla que provoca que el evento se repita de forma mensual. |
addWeeklyExclusion() | RecurrenceRule | Agrega una regla que excluye los casos todas las semanas. |
addWeeklyRule() | RecurrenceRule | Agrega una regla que haga que el evento se repita semanalmente. |
addYearlyExclusion() | RecurrenceRule | Agrega una regla que excluye los casos de forma anual. |
addYearlyRule() | RecurrenceRule | Agrega una regla que provoca que el evento se repita de forma anual. |
interval(interval) | RecurrenceRule | Configura la regla para que se aplique solo en este intervalo de la unidad de tiempo de la regla. |
onlyInMonth(month) | RecurrenceRule | Configura la regla para que se aplique solo a un mes específico. |
onlyInMonths(months) | RecurrenceRule | Configura la regla para que se aplique solo a meses específicos. |
onlyOnMonthDay(day) | RecurrenceRule | Configura la regla para que se aplique solo a un día específico del mes. |
onlyOnMonthDays(days) | RecurrenceRule | Configura la regla para que se aplique solo a días específicos del mes. |
onlyOnWeek(week) | RecurrenceRule | Configura la regla para que se aplique solo a una semana específica del año. |
onlyOnWeekday(day) | RecurrenceRule | Configura la regla para que se aplique solo a un día específico de la semana. |
onlyOnWeekdays(days) | RecurrenceRule | Configura la regla para que se aplique solo a días específicos de la semana. |
onlyOnWeeks(weeks) | RecurrenceRule | Configura la regla para que se aplique solo a semanas específicas del año. |
onlyOnYearDay(day) | RecurrenceRule | Configura la regla para que se aplique solo a un día específico del año. |
onlyOnYearDays(days) | RecurrenceRule | Configura la regla para que se aplique solo a días específicos del año. |
setTimeZone(timeZone) | EventRecurrence | Establece la zona horaria para esta recurrencia. |
times(times) | RecurrenceRule | Configura la regla para que finalice después de una cantidad determinada de repeticiones. |
until(endDate) | RecurrenceRule | Configura la regla para que finalice en una fecha determinada (inclusive). |
weekStartsOn(day) | RecurrenceRule | Configura en qué día comienza una semana con el fin de aplicar la regla. |
Documentación detallada
addDailyExclusion()
Agrega una regla que excluye los casos diariamente.
// Creates a rule that recurs every week after the first 30 days. var recurrence = CalendarApp.newRecurrence().addWeeklyRule().addDailyExclusion().times(30);
Devolvedor
RecurrenceRule
: Es la nueva 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 los permisos adecuados de la API de REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
addDailyRule()
Agrega una regla que provoca que el evento se repita todos los días.
// Creates a rule that recurs every day for ten days. var recurrence = CalendarApp.newRecurrence().addDailyRule().times(10);
Devolvedor
RecurrenceRule
: Es la nueva 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 los permisos 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 provoca que el evento se repita en una fecha específica.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
date | Date |
Devolvedor
EventRecurrence
: Este es 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 los permisos 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 un caso en una fecha específica.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
date | Date |
Devolvedor
EventRecurrence
: Este es 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 los permisos 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 los casos 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 si se llama a onlyOnMonthDay(day)
o a onlyOnMonthDays(days)
.
Devolvedor
RecurrenceRule
: Es la nueva 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 los permisos adecuados de la API de REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
addMonthlyRule()
Agrega una regla que provoca que el evento se repita de forma mensual.
De forma predeterminada, el evento se repite el mismo día del mes que el primer evento de la serie, pero se puede modificar si llamas a onlyOnMonthDay(day)
o onlyOnMonthDays(days)
.
// Creates a rule that recurs every month for three months. var recurrence = CalendarApp.newRecurrence().addMonthlyRule().times(4);
Devolvedor
RecurrenceRule
: Es la nueva 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 los permisos 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 los casos todas las semanas.
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 si se llama a onlyOnWeekday(day)
o 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);
Devolvedor
RecurrenceRule
: Es la nueva 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 los permisos adecuados de la API de REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
addWeeklyRule()
Agrega una regla que haga 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 se puede modificar si llamas a onlyOnWeekday(day)
o onlyOnWeekdays(days)
.
// Creates a rule that recurs every week for ten weeks. var recurrence = CalendarApp.newRecurrence().addWeeklyRule().times(10);
Devolvedor
RecurrenceRule
: Es la nueva 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 los permisos 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 los casos 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 si se llama a onlyOnYearDay(day)
o a onlyOnYearDays(days)
.
Devolvedor
RecurrenceRule
: Es la nueva 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 los permisos adecuados de la API de REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
addYearlyRule()
Agrega una regla que provoca que el evento se repita de forma anual.
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 si llamas a onlyOnYearDay(day)
o onlyOnYearDays(days)
.
Devolvedor
RecurrenceRule
: Es la nueva 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 los permisos 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 se aplique solo en este intervalo de la unidad de tiempo de la regla.
// Creates a rule that recurs every fourth week. var recurrence = CalendarApp.newRecurrence().addWeeklyRule().interval(4);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
interval | Integer | el intervalo en la unidad de tiempo de la regla |
Devolvedor
RecurrenceRule
: Esta RecurrenceRule para encadenar
onlyInMonth(month)
Configura la regla para que se aplique solo a un mes específico.
// Creates a rule that recurs every week in February. var recurrence = CalendarApp.newRecurrence() .addWeeklyRule().onlyInMonth(CalendarApp.Month.FEBRUARY);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
month | Month | del mes |
Devolvedor
RecurrenceRule
: Esta RecurrenceRule para encadenar
onlyInMonths(months)
Configura la regla para que se aplique solo 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
Nombre | Tipo | Descripción |
---|---|---|
months | Month[] | los meses |
Devolvedor
RecurrenceRule
: Esta RecurrenceRule para encadenar
onlyOnMonthDay(day)
Configura la regla para que se aplique solo a un día específico del mes.
// Creates a rule that recurs every month on the fifth day of the month. var recurrence = CalendarApp.newRecurrence().addMonthlyRule().onlyOnMonthDay(5);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
day | Integer | el día del mes |
Devolvedor
RecurrenceRule
: Esta RecurrenceRule para encadenar
onlyOnMonthDays(days)
Configura la regla para que se aplique solo a días específicos del mes.
// 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
Nombre | Tipo | Descripción |
---|---|---|
days | Integer[] | los días del mes |
Devolvedor
RecurrenceRule
: Esta RecurrenceRule para encadenar
onlyOnWeek(week)
Configura la regla para que se aplique solo a una semana específica del año.
// Creates a rule that recurs on the fifth week of every year. var recurrence = CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeek(5);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
week | Integer | la semana |
Devolvedor
RecurrenceRule
: Esta RecurrenceRule para encadenar
onlyOnWeekday(day)
Configura la regla para que se aplique solo a un día específico de la semana.
// Creates a rule that recurs every week on Wednesdays. var recurrence = CalendarApp.newRecurrence() .addWeeklyRule().onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
day | Weekday | el día de la semana |
Devolvedor
RecurrenceRule
: Esta RecurrenceRule para encadenar
onlyOnWeekdays(days)
Configura la regla para que se aplique solo a días específicos de la 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
Nombre | Tipo | Descripción |
---|---|---|
days | Weekday[] | los días de la semana |
Devolvedor
RecurrenceRule
: Esta RecurrenceRule para encadenar
onlyOnWeeks(weeks)
Configura la regla para que se aplique solo a semanas específicas del año.
// Creates a rule that recurs on the fifth and tenth weeks of every year. var recurrence = CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeeks([5, 10]);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
weeks | Integer[] | las semanas |
Devolvedor
RecurrenceRule
: Esta RecurrenceRule para encadenar
onlyOnYearDay(day)
Configura la regla para que se aplique solo a un día específico del año.
// Creates a rule that recurs every year on February 15 (the 46th day). var recurrence = CalendarApp.newRecurrence().addYearlyRule().onlyOnYearDay(46);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
day | Integer | el día del año |
Devolvedor
RecurrenceRule
: Esta RecurrenceRule para encadenar
onlyOnYearDays(days)
Configura la regla para que se aplique solo a días específicos del año.
// Creates a rule that recurs every year on January 20 and February 15. var recurrence = CalendarApp.newRecurrence().addYearlyRule().onlyOnYearDay([20, 46]);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
days | Integer[] | los días del año |
Devolvedor
RecurrenceRule
: Esta 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. La configuración predeterminada es la zona horaria del calendario.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
timeZone | String | la zona horaria, especificada en formato "largo" (p.ej., 'America/New_York', en la lista de Joda.org) |
Devolvedor
EventRecurrence
: Este es 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 los permisos 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. var recurrence = CalendarApp.newRecurrence().addDailyRule().times(10);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
times | Integer | la cantidad de veces que deben repetirse |
Devolvedor
RecurrenceRule
: Esta 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. var recurrence = CalendarApp.newRecurrence() .addDailyRule().until(new Date('December 31, 2013'));
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
endDate | Date |
Devolvedor
RecurrenceRule
: Esta 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 los permisos adecuados de la API de REST relacionada:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
weekStartsOn(day)
Configura en qué día comienza una semana con el fin de aplicar la regla.
// Creates a weekly rule where weeks start on Monday. var recurrence = CalendarApp.newRecurrence() .addWeeklyRule().weekStartsOn(CalendarApp.Weekday.MONDAY);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
day | Weekday | el día en que comienza la semana |
Devolvedor
RecurrenceRule
: Esta RecurrenceRule para encadenar