Student

Student

Represents a student on SMHW.


Constructor

new Student(client, response)

Instantiate a Student object.

Parameters:
Name Type Description
client Client

The client that is instantiating the object.

response Object

The data for the object.

Extends

Members

(private) _client :Client

The client that instantiated this object.

Type:
  • Client
Overrides:

anonymous :Boolean

Whether or not the user is anonymous.

Type:
  • Boolean
Overrides:

avatar :String

The Avatar URL of the user.

Type:
  • String
Overrides:

avatar_large_thumb :String

The large avatar URL of the user.

Type:
  • String

avatar_small_thumb :String

The small avatar URL of the user.

Type:
  • String

backend_type :String

The type of user that the user is on the back-end.

Type:
  • String
Overrides:

bio :String

The bio of the user.

Type:
  • String
Overrides:

categories :Array.<String>

An array of categories that the student falls into.

Type:
  • Array.<String>

class_group_ids :Array.<Number>

An array of class group ids that the student is in.

Type:
  • Array.<Number>

created_at :Number

The timestamp when the user was created.

Type:
  • Number
Overrides:

disabled :Boolean

Whether or not the user is disabled.

Type:
  • Boolean
Overrides:

facebook :String

The facebook account of the user.

Type:
  • String
Overrides:

forename :String

The forename of the user.

Type:
  • String
Overrides:

gender :String

The gender of the user.

Type:
  • String

id :Number

The ID of the user.

Type:
  • Number
Overrides:

invite_code :String

The invite code that the student used.

Type:
  • String

invite_code_expires_on :Number

The timestamp of when then invite code expires.

Type:
  • Number

left_at :Number

The timestamp of when the user left.

Type:
  • Number
Overrides:

linked_in :String

The LinkedIn account of the user.

Type:
  • String
Overrides:

mobile_beta_user :Boolean

Whether or not the user is a mobile beta user.

Type:
  • Boolean

parent_ids :Array.<Number>

An array of IDs to the student's parents.

Type:
  • Array.<Number>

pintrest :String

The Pintrest account of the user.

Type:
  • String
Overrides:

push_notifications_enabled :Boolean

Whether or not the user has push notifications enabled.

Type:
  • Boolean

registration_group_id :Number

The ID of the registration group that the student belongs to.

Type:
  • Number

school_id :Number

The ID of the school that the user belongs to.

Type:
  • Number
Overrides:

sims_id :String

The ID of the user on SIMS.

Type:
  • String
Overrides:

student_badge_ids :Array.<Number>

An array of badge IDs that the student has.

Type:
  • Array.<Number>

student_category_ids :Array.<Number>

An array of category IDs that the student falls into.

Type:
  • Array.<Number>

student_friday_summary :Boolean

Type:
  • Boolean

student_marked_homework :Boolean

Type:
  • Boolean

student_overdue_summary :Boolean

Type:
  • Boolean

student_praise_summary_id :Number

The ID of the student's praise summary.

Type:
  • Number

surname :String

The surname of the user.

Type:
  • String
Overrides:

teacher_stats :Boolean

Type:
  • Boolean
Overrides:

teacher_summary :Boolean

Type:
  • Boolean

title :String

The title of the user.

Type:
  • String
Overrides:

twitter :String

The twitter account of the user.

Type:
  • String
Overrides:

updated_at :Number

The timestamp of when the user was updated.

Type:
  • Number
Overrides:

user_identity_id :Number

The ID of the user's private information.

Type:
  • Number

user_private_info_id :Number

The ID of the user's private information.

Type:
  • Number

year :String

The year that the student belongs to.

Type:
  • String

Methods

getClassGroups(idsopt) → {Promise.<Array.<ClassGroup>>}

Get class groups that the student is in.

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

An array of class group IDs to retrieve.

Returns:
Type
Promise.<Array.<ClassGroup>>