Constructor
new Student(client, response)
Instantiate a Student object.
Name | Type | Description |
---|---|---|
client |
Client | The client that is instantiating the object. |
response |
Object | The data for the object. |
- Source:
Extends
Members
(private) _client :Client
The client that instantiated this object.
- Client
- Overrides:
- Source:
anonymous :Boolean
Whether or not the user is anonymous.
- Boolean
- Overrides:
- Source:
avatar :String
The Avatar URL of the user.
- String
- Overrides:
- Source:
avatar_large_thumb :String
The large avatar URL of the user.
- String
- Overrides:
- Source:
avatar_small_thumb :String
The small avatar URL of the user.
- String
- Overrides:
- Source:
backend_type :String
The type of user that the user is on the back-end.
- String
- Overrides:
- Source:
bio :String
The bio of the user.
- String
- Overrides:
- Source:
categories :Array.<String>
An array of categories that the student falls into.
- Array.<String>
- Source:
class_group_ids :Array.<Number>
An array of class group ids that the student is in.
- Array.<Number>
- Source:
created_at :Number
The timestamp when the user was created.
- Number
- Overrides:
- Source:
disabled :Boolean
Whether or not the user is disabled.
- Boolean
- Overrides:
- Source:
facebook :String
The facebook account of the user.
- String
- Overrides:
- Source:
forename :String
The forename of the user.
- String
- Overrides:
- Source:
gender :String
The gender of the user.
- String
- Source:
id :Number
The ID of the user.
- Number
- Overrides:
- Source:
invite_code :String
The invite code that the student used.
- String
- Source:
invite_code_expires_on :Number
The timestamp of when then invite code expires.
- Number
- Source:
left_at :Number
The timestamp of when the user left.
- Number
- Overrides:
- Source:
linked_in :String
The LinkedIn account of the user.
- String
- Overrides:
- Source:
mobile_beta_user :Boolean
Whether or not the user is a mobile beta user.
- Boolean
- Overrides:
- Source:
parent_ids :Array.<Number>
An array of IDs to the student's parents.
- Array.<Number>
- Source:
pintrest :String
The Pintrest account of the user.
- String
- Overrides:
- Source:
push_notifications_enabled :Boolean
Whether or not the user has push notifications enabled.
- Boolean
- Overrides:
- Source:
registration_group_id :Number
The ID of the registration group that the student belongs to.
- Number
- Source:
school_id :Number
The ID of the school that the user belongs to.
- Number
- Overrides:
- Source:
sims_id :String
The ID of the user on SIMS.
- String
- Overrides:
- Source:
student_badge_ids :Array.<Number>
An array of badge IDs that the student has.
- Array.<Number>
- Source:
student_category_ids :Array.<Number>
An array of category IDs that the student falls into.
- Array.<Number>
- Source:
student_friday_summary :Boolean
- Boolean
- Overrides:
- Source:
student_marked_homework :Boolean
- Boolean
- Overrides:
- Source:
student_overdue_summary :Boolean
- Boolean
- Overrides:
- Source:
student_praise_summary_id :Number
The ID of the student's praise summary.
- Number
- Source:
surname :String
The surname of the user.
- String
- Overrides:
- Source:
teacher_stats :Boolean
- Boolean
- Overrides:
- Source:
teacher_summary :Boolean
- Boolean
- Overrides:
- Source:
title :String
The title of the user.
- String
- Overrides:
- Source:
twitter :String
The twitter account of the user.
- String
- Overrides:
- Source:
updated_at :Number
The timestamp of when the user was updated.
- Number
- Overrides:
- Source:
user_identity_id :Number
The ID of the user's private information.
- Number
- Overrides:
- Source:
user_private_info_id :Number
The ID of the user's private information.
- Number
- Overrides:
- Source:
year :String
The year that the student belongs to.
- String
- Source:
Methods
getClassGroups(idsopt) → {Promise.<Array.<ClassGroup>>}
Get class groups that the student is in.
Name | Type | Attributes | Description |
---|---|---|---|
ids |
Array.<Number> |
<optional> |
An array of class group IDs to retrieve. |
- Source:
- Type
- Promise.<Array.<ClassGroup>>