Skip to content
This repository was archived by the owner on Jul 24, 2025. It is now read-only.

Assignment

Edward Smale edited this page Apr 7, 2020 · 3 revisions

Assignment

Represents a base assignment. (Homework, Quiz, Spelling Test, etc.)

Properties

.client (Client) The client that initiated the object.

.id (Number) The ID of the assignment.

.teacher_id (Number) The ID of the teacher that set the assignment.

.teacher_name (String) The name of the teacher that set the assignment.

.title (String) The title of the assignment.

.subject (String) The subject of the assignment.

.due_timestamp (Number) The timestamp when the assignment is due.

.issued_timestamp (Number) The timestamp when the assignment was issued.

.created_timestamp (Number) The timestamp when the assignment was created.

.updated_timestamp (Number) The timestamp when the assignment was last updated.

.published_timestamp (Number) The timestamp when the assignment was published.

.class_group_id (Number) The ID of the class group.

.class_group_name (String) The name of the class group.

.purpose (String) The purpose of the assignment.

.year (String) The class year of the assignment.

.submission_status (String) The status of the Client user's submission.

.submission_ids (Array<Number>) An array of all submission IDs for the assignment.

.has_unread_comments (Boolean) Whether or not the assignment has unread comments or not.

.school_id (Number) The ID of the school.

.school_name (String) The name of the school

.school_logo_url (String) The URL of the school's logo.

.description (String) The description of the school.

.submission_method_id (Number) the ID of the submission method used.

.web_links (Array<String>) An array of URLs to third party websites.

.community_resource_item_id (Number) The ID of the community resource item.

.attachment_ids (Array<Number>) An array of IDs to attachments.

Methods

.getAttachments([...ids])

  • [...ids] (Number) A list of all attachment IDs to retrieve. Leave out to retrieve all.

Get a list of attachments attached to the submission. Returns Promise<Array<Attachment>>

.getClassGroup()

Get the class group object for the assignment. Returns Promise<ClassGroup>

Clone this wiki locally