- Description:
A javascript module to retrieve calendar events from the server.
- Source:
- Copyright:
- 2018 Ryan Wyllie
- 2018 Ryan Wyllie
- License:
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
A javascript module to retrieve calendar events from the server.
Methods
(inner) queryByCourse(args) → {promise}
- Description:
Retrieve a list of calendar events for the logged in user for the given course.
Valid args are: int courseid Only get events for this course int starttime Only get events after this time int endtime Only get events before this time int limit Limit the number of results returned int aftereventid Offset the result set from the given id
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
args |
object | The request arguments |
Returns:
Resolved with an array of the calendar events
- Type
- promise
(inner) queryByCourses(args) → {promise}
- Description:
Retrieve a list of calendar events for the given courses for the logged in user.
Valid args are: array courseids Get events for these courses int starttime Only get events after this time int endtime Only get events before this time int limit Limit the number of results returned
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
args |
object | The request arguments |
Returns:
Resolved with an array of the calendar events
- Type
- promise
(inner) queryByTime(args) → {promise}
- Description:
Retrieve a list of calendar events for the logged in user after the given time.
Valid args are: int starttime Only get events after this time int endtime Only get events before this time int limit Limit the number of results returned int aftereventid Offset the result set from the given id
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
args |
object | The request arguments |
Returns:
Resolved with an array of the calendar events
- Type
- promise