edu.ksu.canvas.interfaces

Interface CourseSettingsReader

All Superinterfaces:

CanvasReader<CourseSettings,CourseSettingsReader>

All Known Implementing Classes:

CourseSettingsImpl

public interface CourseSettingsReader
extends CanvasReader<CourseSettings,CourseSettingsReader>

Method Summary

Modifier and Type	Method and Description
Optional<CourseSettings>	getCourseSettings(String courseId) Returns course settings from Canvas

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

getCourseSettings

Optional<CourseSettings> getCourseSettings(String courseId)
                                    throws IOException

Returns course settings from Canvas

See Get course settings in the Canvas docs for details.

Parameters:

courseId - The Canvas ID of the course or sis_course_id:SISID

Returns:

The course settings from Canvas

Throws:

IOException - When there is an error communicating with Canvas