User

User

Represents a user on SMHW.


Constructor

new User(client, response)

Instantiate a User object.

Parameters:
Name Type Description
client Client

The client that is instantiating the object.

response Object

The data for the object.

Members

(private) _client :Client

The client that instantiated this object.

Type:
  • Client

anonymous :Boolean

Whether or not the user is anonymous.

Type:
  • Boolean

avatar :String

The Avatar URL of the user.

Type:
  • String

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

bio :String

The bio of the user.

Type:
  • String

created_at :Number

The timestamp when the user was created.

Type:
  • Number

disabled :Boolean

Whether or not the user is disabled.

Type:
  • Boolean

facebook :String

The facebook account of the user.

Type:
  • String

forename :String

The forename of the user.

Type:
  • String

id :Number

The ID of the user.

Type:
  • Number

left_at :Number

The timestamp of when the user left.

Type:
  • Number

linked_in :String

The LinkedIn account of the user.

Type:
  • String

mobile_beta_user :Boolean

Whether or not the user is a mobile beta user.

Type:
  • Boolean

pintrest :String

The Pintrest account of the user.

Type:
  • String

push_notifications_enabled :Boolean

Whether or not the user has push notifications enabled.

Type:
  • Boolean

school_id :Number

The ID of the school that the user belongs to.

Type:
  • Number

sims_id :String

The ID of the user on SIMS.

Type:
  • String

student_friday_summary :Boolean

Type:
  • Boolean

student_marked_homework :Boolean

Type:
  • Boolean

student_overdue_summary :Boolean

Type:
  • Boolean

surname :String

The surname of the user.

Type:
  • String

teacher_stats :Boolean

Type:
  • Boolean

teacher_summary :Boolean

Type:
  • Boolean

title :String

The title of the user.

Type:
  • String

twitter :String

The twitter account of the user.

Type:
  • String

updated_at :Number

The timestamp of when the user was updated.

Type:
  • Number

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