edu.ksu.canvas.interfaces

Interface CalendarWriter

All Superinterfaces:

CanvasWriter<CalendarEvent,CalendarWriter>

All Known Implementing Classes:

CalendarEventImpl

public interface CalendarWriter
extends CanvasWriter<CalendarEvent,CalendarWriter>

Methods to manipulate calendar events in Canvas.

See Also:

Canvas calendar event documentation

Method Summary

Modifier and Type	Method and Description
Optional<CalendarEvent>	createCalendarEvent(CalendarEvent calendarEvent) Create a new calendar event in Canvas.
Optional<CalendarEvent>	deleteCalendarEvent(DeleteCalendarEventOptions options) Delete a calendar event from Canvas.
Optional<CalendarEvent>	editCalendarEvent(CalendarEvent calendarEvent) Modify a calendar event in Canvas.

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

writeAsCanvasUser, writeAsSisUser

Method Detail

deleteCalendarEvent

Optional<CalendarEvent> deleteCalendarEvent(DeleteCalendarEventOptions options)
                                     throws IOException

Delete a calendar event from Canvas.

Parameters:

options - Options class containing required and optional parameters for the delete action

Returns:

The deleted calendar event

Throws:

IOException - When there is an error communicating with Canvas

createCalendarEvent

Optional<CalendarEvent> createCalendarEvent(CalendarEvent calendarEvent)
                                     throws IOException

Create a new calendar event in Canvas.

Parameters:

calendarEvent - Calendar event object to persist to Canvas. Context code is required.

Returns:

The newly created calendar event

Throws:

IOException - When there is an error communicating with Canvas

editCalendarEvent

Optional<CalendarEvent> editCalendarEvent(CalendarEvent calendarEvent)
                                   throws IOException

Modify a calendar event in Canvas.

Parameters:

calendarEvent - An existing calendar event to modify

Returns:

The updated calendar event

Throws:

IOException - When there is an error communicating with Canvas