edu.ksu.canvas.requestOptions

Class StartQuizSubmissionOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.StartQuizSubmissionOptions

public class StartQuizSubmissionOptions
extends BaseOptions

Field Summary

Fields inherited from class edu.ksu.canvas.requestOptions.BaseOptions

optionsMap

Constructor Summary

Constructors

Constructor and Description
StartQuizSubmissionOptions(String courseId, Integer quizId) Create API options wrapper for the "create quiz submission" API call with required parameters

Method Summary

Modifier and Type	Method and Description
StartQuizSubmissionOptions	accessCode(String accessCode) Add an access code (if required)
String	getCourseId()
Integer	getQuizId()
StartQuizSubmissionOptions	preview(Boolean preview) Only valid for teachers.

Methods inherited from class edu.ksu.canvas.requestOptions.BaseOptions

addEnumList, addNumberList, addSingleItem, addStringList, getOptionsMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StartQuizSubmissionOptions

public StartQuizSubmissionOptions(String courseId,
                                  Integer quizId)

Create API options wrapper for the "create quiz submission" API call with required parameters

Parameters:

courseId - Course ID of the course the quiz is in

quizId - Quiz ID of the quiz that is being taken

Method Detail

getCourseId

public String getCourseId()

getQuizId

public Integer getQuizId()

accessCode

public StartQuizSubmissionOptions accessCode(String accessCode)

Add an access code (if required)

Parameters:

accessCode - The access code set by the instructor

Returns:

This object to allow adding more options

preview

public StartQuizSubmissionOptions preview(Boolean preview)

Only valid for teachers. Set whether this should be a preview submission and not count towards the user's course record.

Parameters:

preview - Whether this should be a preview

Returns:

This object to allow adding more options