Assignment

Assignment

Represents a basic assignment on SMHW.

Constructor

new Assignment(client, response)

Instantiate an Assignment object.

Parameters:
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.

Type:
  • Client
Source:

attachment_ids :Array.<Number>

An array of IDs for attachments attached to the assignment.

Type:
  • Array.<Number>
Source:

class_group_id :Number

The ID of the class group that the assignment was set for.

Type:
  • Number
Source:

class_group_name :String

The name of the class group that the assignment was set for.

Type:
  • String
Source:

class_year :String

The class year that the assignment was set for.

Type:
  • String
Source:

community_resource_item_id :Number

The ID of the assignment community resource.

Type:
  • Number
Source:

created_at :Number

The timestamp of when the assignment was created.

Type:
  • Number
Source:

description :String

The description of the assignment.

Type:
  • String
Source:

due_on :Number

The timestamp of when the assignment is due.

Type:
  • Number
Source:

duration :String

The duration of the assignment.

Type:
  • String
Source:

duration_units :String

The duration units of the assignment.

Type:
  • String
Source:

has_unread_comments :Boolean

Whether or not the assignment has unread comments.

Type:
  • Boolean
Source:

id :Number

The ID of the assignment.

Type:
  • Number
Source:

issued_on :Number

The timestamp of when the assignment was issued.

Type:
  • Number
Source:

published_at :Number

The timestamp of when the assignment was published.

Type:
  • Number
Source:

purpose :String

The purpose of the assignment.

Type:
  • String
Source:

school_id :Number

The ID of the school that the assignment is set for.

Type:
  • Number
Source:

school_logo_url :String

The logo URL of of the school that the assignment is set for.

Type:
  • String
Source:

school_name :String

The name of the school that the assignment is set for.

Type:
  • String
Source:

subject :String

The subject of the assignment.

Type:
  • String
Source:

submission_ids :Array.<Number>

An array of IDs for submissions

Type:
  • Array.<Number>
Source:

submission_method_id :Number

The ID of the submission method to use.

Type:
  • Number
Source:

submission_status :String

The status of the submission for the client user.

Type:
  • String
Source:

teacher_id :Number

The ID of the teacher who set the assignment.

Type:
  • Number
Source:

teacher_name :String

The name of the teacher who set the assignment.

Type:
  • String
Source:

title :String

The title of the assignment.

Type:
  • String
Source:

type :String

The assignment type.

Type:
  • String
Source:

updated_at :Number

The timestamp of when the assignment was last updated.

Type:
  • Number
Source:

An array of links to web resources for the assigment.

Type:
Source:

Methods

getAttachments(idsopt) → {Promise.<Array.<Attachment>>}

Get attachments attached to the assignment.

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

The IDs of the attachments to retrieve.
Source:
Returns:
Type
Promise.<Array.<Attachment>>

getTeacher() → {Promise.<Employee>}

Get the teacher who set the assignment.

Source:
Returns:
Type
Promise.<Employee>