Class ClasschartsClient

The base client

Hierarchy

ClasschartsClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ClasschartsClient(studentCode: string, dateOfBirth?: string): ClasschartsClient

- Defined in client.ts:32
Parameters
- studentCode: string
  
  Classcharts student code
- Optional dateOfBirth: string
  
  Student's date of birth
Returns ClasschartsClient

Properties

Private authCookies

authCookies: undefined | string[]

dateOfBirth

dateOfBirth: string = ""

Private sessionId

sessionId: string = ""

studentCode

studentCode: string = ""

studentId

studentId: number = 0

studentName

studentName: string = ""

Methods

getActivity

getActivity(options?: GetActivityOptions): Promise<ActivityResponse>

- Defined in client.ts:113
Get's the logged in student's general activity

Parameters
- Optional options: GetActivityOptions
  
  GetActivityOptions
Returns Promise<ActivityResponse>
Activity data

getBadges

getBadges(): Promise<BadgesResponse>

- Defined in client.ts:190
Gets a list of the students badges

Returns Promise<BadgesResponse>
Array of badges

getBehaviour

getBehaviour(options?: GetBehaviourOptions): Promise<BehaviourResponse>

- Defined in client.ts:129
Gets the logged in students behaviour points

Parameters
- Optional options: GetBehaviourOptions
  
  GetBehaviourOptions
Returns Promise<BehaviourResponse>
Array of behaviour points

getLessons

getLessons(options?: GetLessonsOptions): Promise<LessonsResponse>

- Defined in client.ts:175
Gets the logged in student's lessons for a day

Parameters
- Optional options: GetLessonsOptions
  
  GetLessonsOptions
Returns Promise<LessonsResponse>
Array of lessons

getStudentInfo

getStudentInfo(): Promise<Student>

- Defined in client.ts:101
Gets general information about the logged in student

Returns Promise<Student>
Student object

listHomeworks

listHomeworks(options?: GetHomeworkOptions): Promise<HomeworksResponse>

- Defined in client.ts:148
Gets a list of the logged in student's homeworks

Parameters
- Optional options: GetHomeworkOptions
  
  GetHomeworkOptions
Returns Promise<HomeworksResponse>
Array of homeworks

login

login(): Promise<void>

- Defined in client.ts:63
Initialises the client and authenticates with classcharts

Returns Promise<void>

makeAuthedRequest

makeAuthedRequest(path: string, options: Omit<RequestOptions, "origin" | "path">): Promise<any>

- Defined in client.ts:36
Parameters
- path: string
- options: Omit<RequestOptions, "origin" | "path">
Returns Promise<any>

Generated using TypeDoc