Constructor
new HomeworkSubmission(client, response)
Instantiate a HomeworkSubmission object.
Name | Type | Description |
---|---|---|
client |
Client | The client that is instantiating this object. |
response |
Object | The data for the object. |
- Source:
Extends
Members
(private) _client :Client
The client that instantiated this object.
- Client
- Overrides:
- Source:
assignment_type :String
The type of assignment that the submission is for.
- String
- Overrides:
- Source:
comment_ids :Array.<Number>
An array of IDs of comments posted to the submission.
- Array.<Number>
- Overrides:
- Source:
completed :Boolean
Whether or not the homework submission is marked as complete.
- Boolean
- Source:
created_at :Number
The timestamp of when the submission was created.
- Number
- Overrides:
- Source:
current_submission_version_id :Number
The ID of the current homework submission version.
- Number
- Source:
event_ids :Array.<Number>
An array of IDs to events refering to the submission.
- Array.<Number>
- Overrides:
- Source:
grade :String
The grade recieved for the event.
- String
- Overrides:
- Source:
grade_sent :Boolean
Whether or not a grade has been given for the homework submission.
- Boolean
- Source:
grading_comment :String
The comment made for the grade for the homework submission.
- String
- Source:
handed_in_on :Number
The timestamp of when the homework submission was handed in.
- Number
- Source:
has_unread_comments :Boolean
Whether or not the homework submission has unread comments.
- Boolean
- Source:
homework_id :Number
The ID of the homework that the homework submission is for.
- Number
- Source:
id :String
The ID of the submission.
- String
- Overrides:
- Source:
marked :Boolean
Whether or not the homework submission has been marked.
- Boolean
- Source:
overdue :Boolean
Whether or not the homework submission is overdue.
- Boolean
- Source:
status :String
The status of the submission.
- String
- Overrides:
- Source:
student_avatar :String
The avatar URL of the student.
- String
- Overrides:
- Source:
student_id :Number
The ID of the student.
- Number
- Overrides:
- Source:
student_name :String
The name of the student.
- String
- Overrides:
- Source:
submission_type :String
The type of submission.
- String
- Source:
updated_at :Number
The timestamp of when the submission was last updated.
- Number
- Overrides:
- Source:
version_ids :Array.<Number>
An array of IDs to each homework submission version.
- Array.<Number>
- Source:
Methods
getComments(idsopt) → {Promise.<Array.<HomeworkSubmissionComment>>}
Get an array comments made to the submission.
Name | Type | Attributes | Description |
---|---|---|---|
ids |
Array.<Number> |
<optional> |
An array of IDs of the submission comments to retrieve. |
- Source:
- Type
- Promise.<Array.<HomeworkSubmissionComment>>
getEvents(idsopt) → {Promise.<Array.<SubmissionEvent>>}
Get submission events that refer to this submission.
Name | Type | Attributes | Description |
---|---|---|---|
ids |
Array.<Number> |
<optional> |
An array of IDs of submission events to retrieve. |
- Overrides:
- Source:
- Type
- Promise.<Array.<SubmissionEvent>>
getHomework() → {Promise.<Homework>}
Get the homework that the homework submission is for.
- Source:
- Type
- Promise.<Homework>
getStudent() → {Promise.<Student>}
Get the student who submitted the flexible task submission.
- Overrides:
- Source:
- Type
- Promise.<Student>
getVersions(idsopt) → {Promise.<Array.<HomeworkSubmissionVersion>>}
Get homework submission versions for the homework submission.
Name | Type | Attributes | Description |
---|---|---|---|
ids |
Array.<Number> |
<optional> |
An array of IDs of homework versions to retrieve. |
- Source:
- Type
- Promise.<Array.<HomeworkSubmissionVersion>>
postComment(text) → {Promise.<HomeworkSubmissionComment>}
Post a comment on the submission from the client user.
Name | Type | Description |
---|---|---|
text |
String | The text of the comment. |
- Source:
- Type
- Promise.<HomeworkSubmissionComment>