Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Recurring Events page to reflect latest changes in the api #782

Merged
merged 1 commit into from
Mar 29, 2024
Merged

Update Recurring Events page to reflect latest changes in the api #782

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions docs/functionalities/recurring-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,17 +164,22 @@ A document containing the properties that represents the recurrence rule followe
recurrenceRuleString: string
frequency: ["DAILY", "WEEKLY", "MONTHLY", "YEARLY"]
weekdays: ["MONDAY", ... , "SUNDAY"]
interval: number
count: number
// ...more rrule fields could be added
weekDayOccurenceInMonth: number
baseRecurringEventId: ObjectId
}
```

- **recurrenceRuleString**: an `rrule` string that would be used to generate an `rrule` object, from which we would generate the recurrence dates.
- **frequency**: Frequency of recurrence.
- **weekDays**: The days of the week at which the instances would be scheduled.
- **interval**: Interval of recurrence, i.e every day, every other day, every 5th day, etc.
- **count**: The number of instances following that recurrence rule.
- ...more recurrence specific properties could be added to this interface.
- **weekDayOccurenceInMonth**: The occurence of weekDay in month, i.e whether it's the first Monday, third Monday, or last Monday. It is to be used with Monthly frequency, and a weekDay, e.g.:
- for `frequency: MONTHLY` and `weekDays: ["MONDAY"]`:
- if `weekDayOccurenceInMonth:2`, it would mean that the recurring event occurs every **_Second Monday_** every month.
- if `weekDayOccurenceInMonth:-1`, it would mean every **_Last Monday_** every month.
- **baseRecurringEventId**: The `BaseRecurringEvent` for that recurring event.

### BaseRecurringEvent
Expand Down Expand Up @@ -228,7 +233,10 @@ Every instance of a recurring event would have these fields:

This is the approach we're following for the _**creation and management of recurring events**_.

_**The functionalities have been implemented with this issue**_: [Recurring Events](https://github.com/PalisadoesFoundation/talawa-api/issues/1583) <br />
_Go through the **issue** and the associated **PR**s for more details._
_**The functionalities are being implemented with these issues:**_
1) [Recurring Events Api](https://github.com/PalisadoesFoundation/talawa-api/issues/1583)
2) [Recurring Events Admin](https://github.com/PalisadoesFoundation/talawa-admin/issues/1643) <br />

Last updated on _**March 5, 2024**_
_Go through the **issues** and the associated **PR**s for more details._

Last updated on _**March 29, 2024**_
Loading