Class ClasschartsStudentClient

The base client

Hierarchy

ClasschartsClient
- ClasschartsStudentClient

Index

Constructors

constructor

new ClasschartsStudentClient(studentCode: string, dateOfBirth?: string, axiosConfig?: AxiosRequestConfig<any>): ClasschartsStudentClient

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

Properties

Protected API_BASE

API_BASE: string = ""

Protected authCookies

authCookies: undefined | string[]

Protected axios

axios: AxiosInstance

dateOfBirth

dateOfBirth: string = ""

Protected sessionId

sessionId: string = ""

studentCode

studentCode: string = ""

Protected studentId

studentId: number = 0

Protected studentName

studentName: string = ""

Methods

getActivity

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

Inherited from ClasschartsClient.getActivity
- Defined in baseClient.ts:77
This function is only used for pagination, you likely want client.getFullActivity

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

getBadges

getBadges(): Promise<BadgesResponse>

Inherited from ClasschartsClient.getBadges
- Defined in baseClient.ts:187
Gets a list of the students badges

Returns Promise<BadgesResponse>
Array of badges

getBehaviour

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

Inherited from ClasschartsClient.getBehaviour
- Defined in baseClient.ts:123
Gets the logged in students behaviour points

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

getDetentions

getDetentions(): Promise<DetentionsResponse>

Inherited from ClasschartsClient.getDetentions
- Defined in baseClient.ts:211
Gets the logged in student's detentions

Returns Promise<DetentionsResponse>
Array of detentions

getFullActivity

getFullActivity(options: GetFullActivityOptions): Promise<ActivityResponse>

Inherited from ClasschartsClient.getFullActivity
- Defined in baseClient.ts:94
Helper function for getActivity, returns all the data from the selected dates

Parameters
- options: GetFullActivityOptions
  
  GetFullActivityOptions
Returns Promise<ActivityResponse>
Activity Data

getLessons

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

Inherited from ClasschartsClient.getLessons
- Defined in baseClient.ts:172
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>

Inherited from ClasschartsClient.getStudentInfo
- Defined in baseClient.ts:64
Gets general information about the logged in student

Returns Promise<Student>
Student object

listAnnouncements

listAnnouncements(): Promise<AnnouncementsResponse>

Inherited from ClasschartsClient.listAnnouncements
- Defined in baseClient.ts:199
Lists the logged in student's announcements

Returns Promise<AnnouncementsResponse>
Array of announcements

listHomeworks

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

Inherited from ClasschartsClient.listHomeworks
- Defined in baseClient.ts:141
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 studentClient.ts:31
Initialises the client and authenticates with classcharts

Returns Promise<void>

makeAuthedRequest

makeAuthedRequest(path: string, options: Omit<AxiosRequestConfig<any>, "path">): Promise<any>

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

Generated using TypeDoc