Représente une règle de récurrence pour une série d'événements.
Notez que cette classe se comporte également comme le EventRecurrence
auquel elle appartient, ce qui vous permet d'enchaîner la création de règles comme suit:
recurrence.addDailyRule().times(3).interval(2).addWeeklyExclusion().times(2);Les modificateurs tels que
times(times)
et interval(interval)
sont appliqués à la dernière règle ajoutée.Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addDailyExclusion() | RecurrenceRule | Ajoute une règle qui exclut les occurrences quotidiennement. |
addDailyRule() | RecurrenceRule | Ajoute une règle qui déclenche la répétition quotidienne de l'événement. |
addDate(date) | EventRecurrence | Ajoute une règle qui déclenche la répétition de l'événement à 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 déclenche la répétition mensuelle de l'événement. |
addWeeklyExclusion() | RecurrenceRule | Ajoute une règle qui exclut les occurrences sur une base hebdomadaire. |
addWeeklyRule() | RecurrenceRule | Ajoute une règle qui déclenche la répétition hebdomadaire de l'événement. |
addYearlyExclusion() | RecurrenceRule | Ajoute une règle qui exclut les occurrences sur une base annuelle. |
addYearlyRule() | RecurrenceRule | Ajoute une règle qui déclenche la répétition de l'événement une fois par an. |
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'à des jours spécifiques 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'à des jours spécifiques de la semaine. |
onlyOnWeeks(weeks) | RecurrenceRule | Configure la règle pour qu'elle ne s'applique qu'à des semaines spécifiques 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'à des jours spécifiques 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 premier jour de la semaine en vue d'appliquer la règle. |
Documentation détaillée
addDailyExclusion()
Ajoute une règle qui exclut les occurrences quotidiennement.
// Creates a rule that recurs every week after the first 30 days. var recurrence = CalendarApp.newRecurrence().addWeeklyRule().addDailyExclusion().times(30);
Renvois
RecurrenceRule
: nouvelle règle RecurrenceRule
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application 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 déclenche la répétition quotidienne de l'événement.
// Creates a rule that recurs every day for ten days. var recurrence = CalendarApp.newRecurrence().addDailyRule().times(10);
Renvois
RecurrenceRule
: nouvelle règle RecurrenceRule
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application 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 déclenche la répétition de l'événement à 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 associée à un ou plusieurs des champs d'application suivants ou des champs d'application 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 associée à un ou plusieurs des champs d'application suivants ou des champs d'application 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 modifier cela en appelant onlyOnMonthDay(day)
ou onlyOnMonthDays(days)
.
Renvois
RecurrenceRule
: nouvelle règle RecurrenceRule
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application 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 déclenche la répétition mensuelle de l'événement.
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 vous pouvez modifier cela en appelant onlyOnMonthDay(day)
ou onlyOnMonthDays(days)
.
// Creates a rule that recurs every month for three months. var recurrence = CalendarApp.newRecurrence().addMonthlyRule().times(4);
Renvois
RecurrenceRule
: nouvelle règle RecurrenceRule
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application 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 modifier cela en appelant 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);
Renvois
RecurrenceRule
: nouvelle règle RecurrenceRule
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application 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 déclenche la répétition hebdomadaire de l'événement.
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. var recurrence = CalendarApp.newRecurrence().addWeeklyRule().times(10);
Renvois
RecurrenceRule
: nouvelle règle RecurrenceRule
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application 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 modifier cela en appelant onlyOnYearDay(day)
ou onlyOnYearDays(days)
.
Renvois
RecurrenceRule
: nouvelle règle RecurrenceRule
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application 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 déclenche la répétition de l'événement une fois par an.
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
: nouvelle règle RecurrenceRule
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application 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. var 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 règle 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. var recurrence = CalendarApp.newRecurrence() .addWeeklyRule().onlyInMonth(CalendarApp.Month.FEBRUARY);
Paramètres
Nom | Type | Description |
---|---|---|
month | Month | le mois |
Renvois
RecurrenceRule
: cette règle 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. var recurrence = CalendarApp.newRecurrence() .addWeeklyRule().onlyInMonths([CalendarApp.Month.FEBRUARY, CalendarApp.Month.MARCH]);
Paramètres
Nom | Type | Description |
---|---|---|
months | Month[] | les mois |
Renvois
RecurrenceRule
: cette règle 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. var recurrence = CalendarApp.newRecurrence().addMonthlyRule().onlyOnMonthDay(5);
Paramètres
Nom | Type | Description |
---|---|---|
day | Integer | le jour du mois |
Renvois
RecurrenceRule
: cette règle RecurrenceRule pour le chaînage
onlyOnMonthDays(days)
Configure la règle pour qu'elle ne s'applique qu'à des jours spécifiques du mois.
// Creates a rule that recurs every month on the first and fifteenth day of the month. var recurrence = CalendarApp.newRecurrence().addMonthlyRule().onlyOnMonthDays([1, 15]);
Paramètres
Nom | Type | Description |
---|---|---|
days | Integer[] | les jours du mois |
Renvois
RecurrenceRule
: cette règle 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. var recurrence = CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeek(5);
Paramètres
Nom | Type | Description |
---|---|---|
week | Integer | la semaine |
Renvois
RecurrenceRule
: cette règle 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. var recurrence = CalendarApp.newRecurrence() .addWeeklyRule().onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY);
Paramètres
Nom | Type | Description |
---|---|---|
day | Weekday | le jour de la semaine |
Renvois
RecurrenceRule
: cette règle RecurrenceRule pour le chaînage
onlyOnWeekdays(days)
Configure la règle pour qu'elle ne s'applique qu'à des jours spécifiques de la semaine.
// Creates a rule that recurs every week on Tuesdays and Thursdays. var 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 règle RecurrenceRule pour le chaînage
onlyOnWeeks(weeks)
Configure la règle pour qu'elle ne s'applique qu'à des semaines spécifiques de l'année.
// Creates a rule that recurs on the fifth and tenth weeks of every year. var recurrence = CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeeks([5, 10]);
Paramètres
Nom | Type | Description |
---|---|---|
weeks | Integer[] | les semaines |
Renvois
RecurrenceRule
: cette règle 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). var recurrence = CalendarApp.newRecurrence().addYearlyRule().onlyOnYearDay(46);
Paramètres
Nom | Type | Description |
---|---|---|
day | Integer | le jour de l'année |
Renvois
RecurrenceRule
: cette règle RecurrenceRule pour le chaînage
onlyOnYearDays(days)
Configure la règle pour qu'elle ne s'applique qu'à des jours spécifiques de l'année.
// Creates a rule that recurs every year on January 20 and February 15. var recurrence = CalendarApp.newRecurrence().addYearlyRule().onlyOnYearDay([20, 46]);
Paramètres
Nom | Type | Description |
---|---|---|
days | Integer[] | jours de l'année |
Renvois
RecurrenceRule
: cette règle RecurrenceRule pour le chaînage
setTimeZone(timeZone)
Définit le fuseau horaire de cette récurrence. Cela affecte la date et l'heure de la répétition des événements, et le passage à l'heure d'été. Par défaut, le fuseau horaire de l'agenda est utilisé.
Paramètres
Nom | Type | Description |
---|---|---|
timeZone | String | Le fuseau horaire, spécifié au format "long" (par exemple, "America/New_York", tel que listé par Joda.org) |
Renvois
EventRecurrence
: cette EventRecurrence pour le chaînage
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application 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. var recurrence = CalendarApp.newRecurrence().addDailyRule().times(10);
Paramètres
Nom | Type | Description |
---|---|---|
times | Integer | le nombre de répétitions |
Renvois
RecurrenceRule
: cette règle 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. var recurrence = CalendarApp.newRecurrence() .addDailyRule().until(new Date('December 31, 2013'));
Paramètres
Nom | Type | Description |
---|---|---|
endDate | Date |
Renvois
RecurrenceRule
: cette règle RecurrenceRule pour le chaînage
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://www.googleapis.com/auth/calendar
-
https://www.google.com/calendar/feeds
weekStartsOn(day)
Configure le premier jour de la semaine en vue d'appliquer la règle.
// Creates a weekly rule where weeks start on Monday. var recurrence = CalendarApp.newRecurrence() .addWeeklyRule().weekStartsOn(CalendarApp.Weekday.MONDAY);
Paramètres
Nom | Type | Description |
---|---|---|
day | Weekday | premier jour de la semaine |
Renvois
RecurrenceRule
: cette règle RecurrenceRule pour le chaînage