Class ClasschartsStudentClient

The base client

Hierarchy

ClasschartsClient
- ClasschartsStudentClient

Index

Constructors

constructor

new ClasschartsStudentClient(studentCode: string, dateOfBirth?: string, axiosConfig?: AxiosRequestConfig<any>): ClasschartsStudentClient
Parameters
- studentCode: string
  
  Classcharts student code
- Optional dateOfBirth: string
  
  Student's date of birth
- Optional axiosConfig: AxiosRequestConfig<any>
Returns ClasschartsStudentClient
Overrides ClasschartsClient.constructor
- Defined in studentClient.ts:17

Properties

`Protected` API_BASE

API_BASE: string = ""

authCookies

authCookies: undefined | string[]

`Protected` axios

axios: AxiosInstance

dateOfBirth

dateOfBirth: string = ""

sessionId

sessionId: string = ""

studentCode

studentCode: string = ""

`Protected` studentId

studentId: number = 0

`Protected` studentName

studentName: string = ""

Methods

getActivity

getActivity(options?: GetActivityOptions): Promise<ActivityResponse>
This function is only used for pagination, you likely want client.getFullActivity

Returns
Activity data
Parameters
- Optional options: GetActivityOptions
  
  GetActivityOptions
Returns Promise<ActivityResponse>
Inherited from ClasschartsClient.getActivity
- Defined in baseClient.ts:85

getBadges

getBadges(): Promise<BadgesResponse>
Gets a list of the students badges

Returns
Array of badges

Returns Promise<BadgesResponse>
Inherited from ClasschartsClient.getBadges
- Defined in baseClient.ts:195

getBehaviour

getBehaviour(options?: GetBehaviourOptions): Promise<BehaviourResponse>
Gets the logged in students behaviour points

Returns
Array of behaviour points
Parameters
- Optional options: GetBehaviourOptions
  
  GetBehaviourOptions
Returns Promise<BehaviourResponse>
Inherited from ClasschartsClient.getBehaviour
- Defined in baseClient.ts:131

getDetentions

getDetentions(): Promise<DetentionsResponse>
Gets the logged in student's detentions

Returns
Array of detentions

Returns Promise<DetentionsResponse>
Inherited from ClasschartsClient.getDetentions
- Defined in baseClient.ts:219

getFullActivity

getFullActivity(options: GetFullActivityOptions): Promise<ActivityResponse>
Helper function for getActivity, returns all the data from the selected dates

Returns
Activity Data
Parameters
- options: GetFullActivityOptions
  
  GetFullActivityOptions
Returns Promise<ActivityResponse>
Inherited from ClasschartsClient.getFullActivity
- Defined in baseClient.ts:102

getLessons

getLessons(options?: GetLessonsOptions): Promise<LessonsResponse>
Gets the logged in student's lessons for a day

Returns
Array of lessons
Parameters
- Optional options: GetLessonsOptions
  
  GetLessonsOptions
Returns Promise<LessonsResponse>
Inherited from ClasschartsClient.getLessons
- Defined in baseClient.ts:180

getStudentInfo

getStudentInfo(): Promise<Student>
Gets general information about the logged in student

Returns
Student object

Returns Promise<Student>
Inherited from ClasschartsClient.getStudentInfo
- Defined in baseClient.ts:72

listAnnouncements

listAnnouncements(): Promise<AnnouncementsResponse>
Lists the logged in student's announcements

Returns
Array of announcements

Returns Promise<AnnouncementsResponse>
Inherited from ClasschartsClient.listAnnouncements
- Defined in baseClient.ts:207

listAttendance

listAttendance(options?: GetAttendanceOptions): Promise<AttendanceResponse>
Gets the logged in student's attendance

Returns
Array of dates of attendance
Parameters
- Optional options: GetAttendanceOptions
  
  GetAttendanceOptions
Returns Promise<AttendanceResponse>
Inherited from ClasschartsClient.listAttendance
- Defined in baseClient.ts:232

listHomeworks

listHomeworks(options?: GetHomeworkOptions): Promise<HomeworksResponse>
Gets a list of the logged in student's homeworks

Returns
Array of homeworks
Parameters
- Optional options: GetHomeworkOptions
  
  GetHomeworkOptions
Returns Promise<HomeworksResponse>
Inherited from ClasschartsClient.listHomeworks
- Defined in baseClient.ts:149

login

login(): Promise<void>
Initialises the client and authenticates with classcharts

Returns Promise<void>
- Defined in studentClient.ts:30

makeAuthedRequest

makeAuthedRequest(path: string, options: Omit<AxiosRequestConfig<any>, "path">): Promise<any>
Parameters
- path: string
- options: Omit<AxiosRequestConfig<any>, "path">
Returns Promise<any>
Inherited from ClasschartsClient.makeAuthedRequest
- Defined in baseClient.ts:46

Generated using TypeDoc