Class ClasschartsClient

The base client

Hierarchy

ClasschartsClient
- ClasschartsParentClient
- ClasschartsStudentClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ClasschartsClient(API_BASE: string, axiosConfig?: AxiosRequestConfig<any>): ClasschartsClient

- Defined in baseClient.ts:35
Parameters
- API_BASE: string
  
  Base API URL, this is different depending if its called as a parent or student
- Optional axiosConfig: AxiosRequestConfig<any>
Returns ClasschartsClient

Properties

Protected API_BASE

API_BASE: string = ""

Protected authCookies

authCookies: undefined | string[]

Protected axios

axios: AxiosInstance

Protected sessionId

sessionId: string = ""

Protected studentId

studentId: number = 0

Protected studentName

studentName: string = ""

Methods

getActivity

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

- Defined in baseClient.ts:79
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>

- Defined in baseClient.ts:189
Gets a list of the students badges

Returns Promise<BadgesResponse>
Array of badges

getBehaviour

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

- Defined in baseClient.ts:125
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 baseClient.ts:213
Gets the logged in student's detentions

Returns Promise<DetentionsResponse>
Array of detentions

getFullActivity

getFullActivity(options: GetFullActivityOptions): Promise<ActivityResponse>

- Defined in baseClient.ts:96
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>

- Defined in baseClient.ts:174
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 baseClient.ts:66
Gets general information about the logged in student

Returns Promise<Student>
Student object

listAnnouncements

listAnnouncements(): Promise<AnnouncementsResponse>

- Defined in baseClient.ts:201
Lists the logged in student's announcements

Returns Promise<AnnouncementsResponse>
Array of announcements

listAttendance

listAttendance(options?: GetAttendanceOptions): Promise<AttendanceResponse>

- Defined in baseClient.ts:226
Gets the logged in student's attendance

Parameters
- Optional options: GetAttendanceOptions
  
  GetAttendanceOptions
Returns Promise<AttendanceResponse>
Array of dates of attendance

listHomeworks

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

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

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

makeAuthedRequest

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

- Defined in baseClient.ts:39
Parameters
- path: string
- options: Omit<AxiosRequestConfig<any>, "path">
Returns Promise<any>

Generated using TypeDoc