edu.ksu.canvas.interfaces

Interface QuizReader

All Superinterfaces:

CanvasReader<Quiz,QuizReader>

All Known Implementing Classes:

QuizImpl

public interface QuizReader
extends CanvasReader<Quiz,QuizReader>

Method Summary

Modifier and Type	Method and Description
List<Quiz>	getQuizzesInCourse(String courseId) Retrieve a list of quizzes from Canvas by its course Canvas ID number
Optional<Quiz>	getSingleQuiz(String courseId, String quizId) Retrieve a specific quiz from Canvas by its course and quiz Canvas ID numbers

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

readAsCanvasUser, readAsSisUser, withCallback

Method Detail

getSingleQuiz

Optional<Quiz> getSingleQuiz(String courseId,
                             String quizId)
                      throws IOException

Retrieve a specific quiz from Canvas by its course and quiz Canvas ID numbers

Parameters:

courseId - The Canvas ID of the course

quizId - The Canvas ID of the quiz

Returns:

The assignment returned by Canvas or an empty Optional

Throws:

IOException - When there is an error communicating with Canvas

getQuizzesInCourse

List<Quiz> getQuizzesInCourse(String courseId)
                       throws IOException

Retrieve a list of quizzes from Canvas by its course Canvas ID number

Parameters:

courseId - The Canvas ID of the course

Returns:

List of quizzes in the course with the course ID

Throws:

IOException - When there is an error communicating with Canvas