QuizSubmission

QuizSubmission

Represents a quiz submission on SMHW.


Constructor

new QuizSubmission(client, response)

Instantiate a QuizSubmission object.

Parameters:
Name Type Description
client Client

The client that is instantiating this object.

response Object

The data for the object.

Extends

Members

(private) _client :Client

The client that instantiated this object.

Type:
  • Client
Overrides:

assignment_type :String

The type of assignment that the submission is for.

Type:
  • String

comment_ids :Array.<Number>

An array of IDs of comments posted to the submission.

Type:
  • Array.<Number>

created_at :Number

The timestamp of when the submission was created.

Type:
  • Number

event_ids :Array.<Number>

An array of IDs to events refering to the submission.

Type:
  • Array.<Number>

grade :String

The grade recieved for the event.

Type:
  • String
Overrides:

id :String

The ID of the submission.

Type:
  • String
Overrides:

question_ids :Array.<Number>

An array of submission question IDs.

Type:
  • Array.<Number>

quiz_id :Number

The ID of the quiz that the quiz submission is for.

Type:
  • Number

status :String

The status of the submission.

Type:
  • String
Overrides:

student_avatar :String

The avatar URL of the student.

Type:
  • String

student_id :Number

The ID of the student.

Type:
  • Number

student_name :String

The name of the student.

Type:
  • String

submission_type :String

The type of submission.

Type:
  • String

updated_at :Number

The timestamp of when the submission was last updated.

Type:
  • Number

Methods

getComments(idsopt) → {Promise.<Array.<QuizSubmissionComment>>}

Get an array comments made to the submission.

Parameters:
Name Type Attributes Description
ids Array.<Number> <optional>

An array of IDs of the submission comments to retrieve.

Returns:
Type
Promise.<Array.<QuizSubmissionComment>>

getEvents(idsopt) → {Promise.<Array.<SubmissionEvent>>}

Get submission events that refer to this submission.

Parameters:
Name Type Attributes Description
ids Array.<Number> <optional>

An array of IDs of submission events to retrieve.

Returns:
Type
Promise.<Array.<SubmissionEvent>>

getQuestions(idsopt) → {Promise.<Array.<QuizSubmissionQuestion>>}

Get the questions for the quiz submission.

Parameters:
Name Type Attributes Description
ids Array.<Number> <optional>

An array of IDs of quiz submission questions to retrieve.

Returns:
Type
Promise.<Array.<QuizSubmissionQuestion>>

getQuiz() → {Promise.<Quiz>}

Get the quiz that the quiz submission is for.

Returns:
Type
Promise.<Quiz>

getStudent() → {Promise.<Student>}

Get the student who submitted the flexible task submission.

Returns:
Type
Promise.<Student>

postComment(text) → {Promise.<QuizSubmissionComment>}

Post a comment on the submission from the client user.

Parameters:
Name Type Description
text String

The text of the comment.

Returns:
Type
Promise.<QuizSubmissionComment>