edu.ksu.canvas.interfaces

Interface CalendarReader

All Superinterfaces:

CanvasReader<CalendarEvent,CalendarReader>

All Known Implementing Classes:

CalendarEventImpl

public interface CalendarReader
extends CanvasReader<CalendarEvent,CalendarReader>

Methods to query and read calendar events from Canvas.

See Also:

Canvas calendar event documentation

Method Summary

Modifier and Type	Method and Description
Optional<CalendarEvent>	getCalendarEvent(Integer id) Retrieve a specific calendar event from Canvas.
List<CalendarEvent>	listCalendarEvents(String userId, ListCalendarEventsOptions options) Retrieve calendar events for a specified user.
List<CalendarEvent>	listCurrentUserCalendarEvents(ListCalendarEventsOptions options) Retrieve calendar events for the current user.

Methods inherited from interface edu.ksu.canvas.interfaces.CanvasReader

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

listCurrentUserCalendarEvents

List<CalendarEvent> listCurrentUserCalendarEvents(ListCalendarEventsOptions options)
                                           throws IOException

Retrieve calendar events for the current user.

Parameters:

options - Options class to capture optional parameters to this API call

Returns:

A list of events matching the query parameters

Throws:

IOException - When there is an error communicating with Canvas

listCalendarEvents

List<CalendarEvent> listCalendarEvents(String userId,
                                       ListCalendarEventsOptions options)
                                throws IOException

Retrieve calendar events for a specified user. To read another user's events you must be an administrator or observer.

Parameters:

userId - Canvas ID or sis_user_id:xxx of the user to query

options - Additional options to modify the calendar query

Returns:

A list of events matching the query parameters

Throws:

IOException - When there is an error communicating with Canvas

getCalendarEvent

Optional<CalendarEvent> getCalendarEvent(Integer id)
                                  throws IOException

Retrieve a specific calendar event from Canvas.

Parameters:

id - Canvas ID of the calendar event

Returns:

The requested calendar event object

Throws:

IOException - When there is an error communicating with Canvas