edu.ksu.canvas.interfaces.CourseSettingsReader 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.CourseSettings;

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

public interface CourseSettingsReader extends CanvasReader {

    /**
     * Returns course settings from Canvas
     * 
     * See Get course settings
     * in the Canvas docs for details.
     * @param courseId The Canvas ID of the course or sis_course_id:SISID
     * @return The course settings from Canvas
     * @throws IOException When there is an error communicating with Canvas
     */
    Optional getCourseSettings(String courseId) throws IOException;
}