Constructor
new Homework(client, response)
Instantiate a Homework object.
Name | Type | Description |
---|---|---|
client |
Client | The client that is instantiating the object. |
response |
Object | The data for the object. |
- Source:
Members
(private) _client :Client
The client that instantiated this object.
- Client
- Source:
attachment_ids :Array.<Number>
An array of IDs for attachments attached to the homework.
- Array.<Number>
- Source:
bookstore_content_ids :Array.<Number>
- Array.<Number>
- Source:
class_group_id :Number
The ID of the class group that the homework was set for.
- Number
- Source:
class_group_name :String
The name of the class group that the homework was set for.
- String
- Source:
class_year :String
The class year that the homework was set for.
- String
- Source:
community_resource_item_id :Number
The ID of the homework community resource.
- Number
- Source:
created_at :Number
The timestamp of when the homework was created.
- Number
- Source:
description :String
The description of the homework.
- String
- Source:
due_on :Number
The timestamp of when the homework is due.
- Number
- Source:
duration :String
The duration of the homework.
- String
- Source:
duration_units :String
The duration units of the homework.
- String
- Source:
has_unread_comments :Boolean
Whether or not the homework has unread comments.
- Boolean
- Source:
id :Number
The ID of the homework.
- Number
- Source:
issued_on :Number
The timestamp of when the homework was issued.
- Number
- Source:
marking_scheme_id :Number
The ID of the marking scheme used for the homework.
- Number
- Source:
published_at :Number
The timestamp of when the homework was published.
- Number
- Source:
purpose :String
The purpose of the homework.
- String
- Source:
school_id :Number
The ID of the school that the homework is set for.
- Number
- Source:
school_logo_url :String
The logo URL of of the school that the homework is set for.
- String
- Source:
school_name :String
The name of the school that the homework is set for.
- String
- Source:
subject :String
The subject of the homework.
- String
- Source:
submission_ids :Array.<Number>
An array of IDs for submissions
- Array.<Number>
- Source:
submission_method_id :Number
The ID of the submission method to use.
- Number
- Source:
submission_status :String
The status of the submission for the client user.
- String
- Source:
submission_type :String
The name of the submission method to use.
- String
- Source:
teacher_id :Number
The ID of the teacher who set the homework.
- Number
- Source:
teacher_name :String
The name of the teacher who set the homework.
- String
- Source:
title :String
The title of the homework.
- String
- Source:
updated_at :Number
The timestamp of when the homework was last updated.
- Number
- Source:
web_links :Array.<String>
An array of links to web resources for the homework.
- Array.<String>
- Source:
Methods
getAttachments(idsopt) → {Promise.<Array.<Attachment>>}
Get attachments on the homework.
Name | Type | Attributes | Description |
---|---|---|---|
ids |
Array.<Number> |
<optional> |
The IDs of the attachments to retrieve. |
- Source:
- Type
- Promise.<Array.<Attachment>>
getSubmission() → {Promise.<HomeworkSubmission>}
Get the client user's submission to the homework.
- Source:
- Type
- Promise.<HomeworkSubmission>
getSubmissionComments(idsopt) → {Promise.<Array.<SubmissionComment>>}
Get comments made on homework submissions.
Name | Type | Attributes | Description |
---|---|---|---|
ids |
Array.<Number> |
<optional> |
The IDs of the homework comments to retrieve. |
- Source:
- Type
- Promise.<Array.<SubmissionComment>>
getSubmissions(idsopt) → {Promise.<Array.<HomeworkSubmissions>>}
Get submissions to the homework.
Name | Type | Attributes | Description |
---|---|---|---|
ids |
Array.<Number> |
<optional> |
The IDs of the homework submissions to retrieve. |
- Source:
- Type
- Promise.<Array.<HomeworkSubmissions>>
getTeacher() → {Promise.<Employee>}
Get the teacher who set the homework.
- Source:
- Type
- Promise.<Employee>