edu.ksu.canvas.requestOptions

Class CompleteQuizSubmissionOptions

java.lang.Object

edu.ksu.canvas.requestOptions.BaseOptions

edu.ksu.canvas.requestOptions.CompleteQuizSubmissionOptions

public class CompleteQuizSubmissionOptions
extends BaseOptions

Field Summary

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

optionsMap

Constructor Summary

Constructors

Constructor and Description
CompleteQuizSubmissionOptions(String courseId, Integer quizId, Integer submissionId, Integer attempt, String validationToken) Constructs the API options for completing a quiz submission with the required arguments.

Method Summary

Modifier and Type	Method and Description
CompleteQuizSubmissionOptions	accessCode(String accessCode) Add the quiz access code (if required)
String	getCourseId()
Integer	getQuizId()
Integer	getSubmissionId()

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

CompleteQuizSubmissionOptions

public CompleteQuizSubmissionOptions(String courseId,
                                     Integer quizId,
                                     Integer submissionId,
                                     Integer attempt,
                                     String validationToken)

Constructs the API options for completing a quiz submission with the required arguments.

Parameters:

courseId - Course ID that the quiz is in

quizId - Quiz ID that this submission is associated with

submissionId - The ID of the submission object that is being completed.

attempt - The attempt number of the quiz submission being completed. Must be the latest attempt index.

validationToken - The unique validation token received from Canvas when starting the quiz submission.

Method Detail

getCourseId

public String getCourseId()

getQuizId

public Integer getQuizId()

getSubmissionId

public Integer getSubmissionId()

accessCode

public CompleteQuizSubmissionOptions accessCode(String accessCode)

Add the quiz access code (if required)

Parameters:

accessCode - Access code set by the instructor

Returns:

This object to allow adding more options