Skip to content
This repository was archived by the owner on Jul 24, 2025. It is now read-only.

Client

Jump to bottom
Edward Smale edited this page May 3, 2020 · 8 revisions

Client

Represents a SMHW client.

Constructor

  • options (Object) The options for the client.

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 into.
  • username (String) The username of the user to log into.
  • password (String) The password of the user to log into. (not permanently stored)

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

.getTodo()

Get a list of tasks todo. Returns Promise<Array<Task>>

.getHomework(<id>)

  • id (Number) ID of the homework to retrieve.

Get a homework by ID. Returns Promise<Homework>

.getQuiz(<id>)

  • id (Number) ID of the quiz to retrieve.

Get a quiz by ID. Returns Promise<Quiz>

.getFlexibleTask(<id>)

  • id (Number) ID of the flexible task to retrieve.

Get a flexible task by ID. Returns Promise<FlexibleTask>

.getSpellingTest(<id>)

  • id (Number) ID of the spelling test to retrieve.

Get a spelling test by ID. Returns Promise<SpellingTest>

.getHomeworkSubmission(<id>)

  • id (Number) ID of the homework submission to retrieve.

Get a homework submission by ID. Returns Promise<HomeworkSubmission>

.getQuizSubmission(<id>)

  • id (Number) ID of the quiz submission to retrieve.

Get a quiz submission by ID. Returns Promise<QuizSubmission>

.getFlexibleTaskSubmission(<id>)

  • id (Number) ID of the flexible task submission to retrieve.

Get a flexible task submission by ID. Returns Promise<FlexibleTaskSubmission>

.getSpellingTestSubmission(<id>)

  • id (Number) ID of the spelling test submission to retrieve.

Get a spelling test submission by ID. Returns Promise<SpellingTestSubmission>

.getTeacher(<id>)

  • id (Number) ID of the teacher to retrieve.

Get a teacher by ID. Returns Promise<Teacher>

.getSubmissionMethods()

Get a list of submission methods. Returns Promise<Array<SubmissionMethod>>

.searchSchools(<term>[, options])

  • term (String) The term to search.
  • options (Object) The options to include for the search.

Search schools on SMHW. Returns Promise<Array<Schoolincomplete>>

Clone this wiki locally