edu.ksu.canvas.interfaces.CalendarReader Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of canvas-api Show documentation

A native Java library to talk to the Canvas REST API

The newest version!

package edu.ksu.canvas.interfaces;

import edu.ksu.canvas.model.CalendarEvent;
import edu.ksu.canvas.requestOptions.ListCalendarEventsOptions;

import java.io.IOException;
import java.util.List;
import java.util.Optional;

/**
 * Methods to query and read calendar events from Canvas.
 *
 * @see Canvas calendar event documentation
 *
 */
public interface CalendarReader extends CanvasReader {

    /**
     * Retrieve calendar events for the current user.
     *
     * @param options Options class to capture optional parameters to this API call
     * @return A list of events matching the query parameters
     * @throws IOException When there is an error communicating with Canvas
     */
    List listCurrentUserCalendarEvents(ListCalendarEventsOptions options) throws IOException;

    /**
     * Retrieve calendar events for a specified user.
     *
     * To read another user's events you must be an administrator or observer.
     * @param userId Canvas ID or sis_user_id:xxx of the user to query
     * @param options Additional options to modify the calendar query
     * @return A list of events matching the query parameters
     * @throws IOException When there is an error communicating with Canvas
     */
    List listCalendarEvents(String userId, ListCalendarEventsOptions options) throws  IOException;

    /**
     * Retrieve a specific calendar event from Canvas.
     * @param id Canvas ID of the calendar event
     * @return The requested calendar event object
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional getCalendarEvent(Long id) throws IOException;

}