Class ClasschartsClientStudent

The base client

Hierarchy

ClasschartsClientStudent

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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

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:121
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:203
Gets a list of the students badges

Returns Promise<BadgesResponse>
Array of badges

getBehaviour

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

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

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

getDetentions

getDetentions(): Promise<DetentionsResponse>

- Defined in client.ts:215
Gets the logged in student's detentions

Returns Promise<DetentionsResponse>
Array of detentions

getLessons

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

- Defined in client.ts:188
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:109
Gets general information about the logged in student

Returns Promise<Student>
Student object

init

init(): Promise<void>

- Defined in client.ts:101
deprecated
Use .login() instead

Returns Promise<void>

listHomeworks

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

- Defined in client.ts:156
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:64
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:37
Parameters
- path: string
- options: Omit<RequestOptions, "origin" | "path">
Returns Promise<any>

Generated using TypeDoc