Constructor
new Task(client, response)
Instantiate a Task 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:
class_group_name :String
The name of the class group that the task is set for.
- String
- Source:
class_task_description :String
The description of the task.
- String
- Source:
class_task_id :Number
The ID of the task.
- Number
- Source:
class_task_title :String
The title of the task.
- String
- Source:
class_task_type :String
The type of task.
- String
- Source:
completed :Boolean
Whether or not the task has been completed.
- Boolean
- Source:
description :String
The description of the task.
- String
- Source:
due_on :Number
The timestamp of when the task is due.
- Number
- Source:
has_assignments :Boolean
Whether or not the task has assignments.
- Boolean
- Source:
id :Number
The ID of the task.
- Number
- Source:
issued_on :Number
The timestamp of when the task was issued.
- Number
- Source:
subject :String
The subject that the task was set for.
- String
- Source:
submission_status :String
The submission status of the task for client.
- String
- Source:
submission_status :string
The submission type of the task.
- string
- Source:
teacher_name :String
The name of the teacher who set the task.
- String
- Source:
user_id :String
The ID of the user who the task is for.
- String
- Source:
Methods
getAssignment() → {Promise.<(Homework|FlexibleTask)>}
Get the task assignment.
- Source:
- Type
- Promise.<(Homework|FlexibleTask)>
setCompleted(completed) → {Promise.<Task>}
Mark the task as completed or incomplete.
Name | Type | Description |
---|---|---|
completed |
Boolean | Whether or not the task should be marked completed or incomplete. |
- Source:
- Type
- Promise.<Task>
setViewed() → {Promise.<Boolean>}
Fire an event to set the homework as viewed.
- Source:
- Type
- Promise.<Boolean>
toggleCompleted() → {Promise.<Task>}
Toggle the task as completed or incomplete.
- Source:
- Type
- Promise.<Task>