Class RecurrenceRule

RecurrenceRule

Représente une règle de récurrence pour une série d'événements.

Notez que cette classe se comporte également comme la classe EventRecurrence à laquelle elle appartient, ce qui vous permet d'enchaîner la création de règles comme suit :

const recurrence = CalendarApp.newRecurrence().addDailyRule().times(3).interval(2).addWeeklyExclusion().times(2);

Les modificateurs tels que times(times) et interval(interval) sont appliqués à la règle la plus récemment ajoutée.

Méthodes

Méthode	Type renvoyé	Brève description
addDailyExclusion()	RecurrenceRule	Ajoute une règle qui exclut les occurrences au quotidien.
addDailyRule()	RecurrenceRule	Ajoute une règle qui fait que l'événement se répète quotidiennement.
addDate(date)	EventRecurrence	Ajoute une règle qui fait que l'événement se répète à une date spécifique.
addDateExclusion(date)	EventRecurrence	Ajoute une règle qui exclut une occurrence pour une date spécifique.
addMonthlyExclusion()	RecurrenceRule	Ajoute une règle qui exclut les occurrences sur une base mensuelle.
addMonthlyRule()	RecurrenceRule	Ajoute une règle qui fait que l'événement se répète tous les mois.
addWeeklyExclusion()	RecurrenceRule	Ajoute une règle qui exclut les occurrences sur une base hebdomadaire.
addWeeklyRule()	RecurrenceRule	Ajoute une règle qui fait que l'événement se répète chaque semaine.
addYearlyExclusion()	RecurrenceRule	Ajoute une règle qui exclut les occurrences sur une base annuelle.
addYearlyRule()	RecurrenceRule	Ajoute une règle qui fait que l'événement se répète chaque année.
interval(interval)	RecurrenceRule	Configure la règle pour qu'elle ne s'applique qu'à cet intervalle de l'unité de temps de la règle.
onlyInMonth(month)	RecurrenceRule	Configure la règle pour qu'elle ne s'applique qu'à un mois spécifique.
onlyInMonths(months)	RecurrenceRule	Configure la règle pour qu'elle ne s'applique qu'à des mois spécifiques.
onlyOnMonthDay(day)	RecurrenceRule	Configure la règle pour qu'elle ne s'applique qu'à un jour spécifique du mois.
onlyOnMonthDays(days)	RecurrenceRule	Configure la règle pour qu'elle ne s'applique qu'à certains jours du mois.
onlyOnWeek(week)	RecurrenceRule	Configure la règle pour qu'elle ne s'applique qu'à une semaine spécifique de l'année.
onlyOnWeekday(day)	RecurrenceRule	Configure la règle pour qu'elle ne s'applique qu'à un jour spécifique de la semaine.
onlyOnWeekdays(days)	RecurrenceRule	Configure la règle pour qu'elle ne s'applique qu'à certains jours de la semaine.
onlyOnWeeks(weeks)	RecurrenceRule	Configure la règle pour qu'elle ne s'applique qu'à certaines semaines de l'année.
onlyOnYearDay(day)	RecurrenceRule	Configure la règle pour qu'elle ne s'applique qu'à un jour spécifique de l'année.
onlyOnYearDays(days)	RecurrenceRule	Configure la règle pour qu'elle ne s'applique qu'à certains jours de l'année.
setTimeZone(timeZone)	EventRecurrence	Définit le fuseau horaire de cette récurrence.
times(times)	RecurrenceRule	Configure la règle pour qu'elle se termine après un nombre donné d'occurrences.
until(endDate)	RecurrenceRule	Configure la règle pour qu'elle se termine à une date donnée (incluse).
weekStartsOn(day)	RecurrenceRule	Configure le jour de début de la semaine pour l'application de la règle.

Documentation détaillée

addDailyExclusion()

Ajoute une règle qui exclut les occurrences au quotidien.

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

Renvois

RecurrenceRule : la nouvelle RecurrenceRule

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

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

---

addDailyRule()

Ajoute une règle qui fait que l'événement se répète quotidiennement.

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

Renvois

RecurrenceRule : la nouvelle RecurrenceRule

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

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

---

addDate(date)

Ajoute une règle qui fait que l'événement se répète à une date spécifique.

Paramètres

Nom	Type	Description
date	Date

Renvois

EventRecurrence : cette EventRecurrence pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

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

---

addDateExclusion(date)

Ajoute une règle qui exclut une occurrence pour une date spécifique.

Paramètres

Nom	Type	Description
date	Date

Renvois

EventRecurrence : cette EventRecurrence pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

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

---

addMonthlyExclusion()

Ajoute une règle qui exclut les occurrences sur une base mensuelle.

Par défaut, l'exclusion est appliquée le même jour du mois que le premier événement de la série, mais vous pouvez la modifier en appelant onlyOnMonthDay(day) ou onlyOnMonthDays(days).

Renvois

RecurrenceRule : la nouvelle RecurrenceRule

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

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

---

addMonthlyRule()

Ajoute une règle qui fait que l'événement se répète tous les mois.

Par défaut, l'événement se répète le même jour du mois que le premier événement de la série, mais cela peut être modifié en appelant onlyOnMonthDay(day) ou onlyOnMonthDays(days).

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

Renvois

RecurrenceRule : la nouvelle RecurrenceRule

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

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

---

addWeeklyExclusion()

Ajoute une règle qui exclut les occurrences sur une base hebdomadaire.

Par défaut, l'exclusion est appliquée le même jour de la semaine que le premier événement de la série, mais vous pouvez la modifier en appelant 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);

Renvois

RecurrenceRule : la nouvelle RecurrenceRule

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

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

---

addWeeklyRule()

Ajoute une règle qui fait que l'événement se répète chaque semaine.

Par défaut, l'événement se répète le même jour de la semaine que le premier événement de la série, mais vous pouvez modifier cela en appelant onlyOnWeekday(day) ou onlyOnWeekdays(days).

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

Renvois

RecurrenceRule : la nouvelle RecurrenceRule

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

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

---

addYearlyExclusion()

Ajoute une règle qui exclut les occurrences sur une base annuelle.

Par défaut, l'exclusion est appliquée le même jour de l'année que le premier événement de la série, mais vous pouvez la modifier en appelant onlyOnYearDay(day) ou onlyOnYearDays(days).

Renvois

RecurrenceRule : la nouvelle RecurrenceRule

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

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

---

addYearlyRule()

Ajoute une règle qui fait que l'événement se répète chaque année.

Par défaut, l'événement se répète le même jour de l'année que le premier événement de la série, mais vous pouvez modifier cela en appelant onlyOnYearDay(day) ou onlyOnYearDays(days).

Renvois

RecurrenceRule : la nouvelle RecurrenceRule

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

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

---

interval(interval)

Configure la règle pour qu'elle ne s'applique qu'à cet intervalle de l'unité de temps de la règle.

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

Paramètres

Nom	Type	Description
interval	Integer	l'intervalle dans l'unité de temps de la règle.

Renvois

RecurrenceRule : cette RecurrenceRule pour le chaînage

---

onlyInMonth(month)

Configure la règle pour qu'elle ne s'applique qu'à un mois spécifique.

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

Paramètres

Nom	Type	Description
month	Month	le mois

Renvois

RecurrenceRule : cette RecurrenceRule pour le chaînage

---

onlyInMonths(months)

Configure la règle pour qu'elle ne s'applique qu'à des mois spécifiques.

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

Paramètres

Nom	Type	Description
months	Month[]	les mois

Renvois

RecurrenceRule : cette RecurrenceRule pour le chaînage

---

onlyOnMonthDay(day)

Configure la règle pour qu'elle ne s'applique qu'à un jour spécifique du mois.

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

Paramètres

Nom	Type	Description
day	Integer	le jour du mois ;

Renvois

RecurrenceRule : cette RecurrenceRule pour le chaînage

---

onlyOnMonthDays(days)

Configure la règle pour qu'elle ne s'applique qu'à certains jours du mois.

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

Paramètres

Nom	Type	Description
days	Integer[]	les jours du mois ;

Renvois

RecurrenceRule : cette RecurrenceRule pour le chaînage

---

onlyOnWeek(week)

Configure la règle pour qu'elle ne s'applique qu'à une semaine spécifique de l'année.

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

Paramètres

Nom	Type	Description
week	Integer	la semaine

Renvois

RecurrenceRule : cette RecurrenceRule pour le chaînage

---

onlyOnWeekday(day)

Configure la règle pour qu'elle ne s'applique qu'à un jour spécifique de la semaine.

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

Paramètres

Nom	Type	Description
day	Weekday	le jour de la semaine ;

Renvois

RecurrenceRule : cette RecurrenceRule pour le chaînage

---

onlyOnWeekdays(days)

Configure la règle pour qu'elle ne s'applique qu'à certains jours de la semaine.

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

Paramètres

Nom	Type	Description
days	Weekday[]	les jours de la semaine ;

Renvois

RecurrenceRule : cette RecurrenceRule pour le chaînage

---

onlyOnWeeks(weeks)

Configure la règle pour qu'elle ne s'applique qu'à certaines semaines de l'année.

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

Paramètres

Nom	Type	Description
weeks	Integer[]	les semaines

Renvois

RecurrenceRule : cette RecurrenceRule pour le chaînage

---

onlyOnYearDay(day)

Configure la règle pour qu'elle ne s'applique qu'à un jour spécifique de l'année.

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

Paramètres

Nom	Type	Description
day	Integer	le jour de l'année

Renvois

RecurrenceRule : cette RecurrenceRule pour le chaînage

---

onlyOnYearDays(days)

Configure la règle pour qu'elle ne s'applique qu'à certains jours de l'année.

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

Paramètres

Nom	Type	Description
days	Integer[]	les jours de l'année ;

Renvois

RecurrenceRule : cette RecurrenceRule pour le chaînage

---

setTimeZone(timeZone)

Définit le fuseau horaire de cette récurrence. Cela affecte la date et l'heure de récurrence des événements, ainsi que le décalage de l'événement avec l'heure d'été. La valeur par défaut est le fuseau horaire de l'agenda.

Paramètres

Nom	Type	Description
timeZone	String	le fuseau horaire, spécifié au format "long" (par exemple, "America/New_York", tel qu'indiqué sur Joda.org)

Renvois

EventRecurrence : cette EventRecurrence pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

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

---

times(times)

Configure la règle pour qu'elle se termine après un nombre donné d'occurrences.

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

Paramètres

Nom	Type	Description
times	Integer	le nombre de récurrences ;

Renvois

RecurrenceRule : cette RecurrenceRule pour le chaînage

---

until(endDate)

Configure la règle pour qu'elle se termine à une date donnée (incluse).

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

Paramètres

Nom	Type	Description
endDate	Date

Renvois

RecurrenceRule : cette RecurrenceRule pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

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

---

weekStartsOn(day)

Configure le jour de début de la semaine pour l'application de la règle.

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

Paramètres

Nom	Type	Description
day	Weekday	le jour où commence la semaine ;

Renvois

RecurrenceRule : cette RecurrenceRule pour le chaînage