Client

Client

Represents a SMHW client.

Constructor

• options (Object) The options for the client.
  • keep_heartbeat (Boolean)

Properties

.access (Access) Authorisation information for the client to make authorised requests.

.student (Student) The student user that the client represents.

.user (User) The user that the client represents.

Methods

.stopHeartbeat()

Stop the client pulsing heartbeat, if available. Returns nothing.

.login(<school_id>, <username>, <password>)

• .school_id (Number) The ID of the school to log onto.
• .username (String) The username of the user to log onto.
• .password (String) The password of the user to log onto. (not permanently stored)

Get an authorisation token to make authorised requests, get private user data and get school information. Returns Promise<true>