Module index

The main entry of this SDK.

We generated this with the powerful TypeDoc!

Index

References

Functions

References

Auth

Renames and re-exports auth

RequestClient

Renames and re-exports request/client

Types

Renames and re-exports types

Utilities

Renames and re-exports utilities

Functions

Checkin

Checkin(courseUUID: string, auth: default): Promise<CheckinResponse>

- Defined in logic/student/checkin.ts:9
Check in the specified course.

Parameters
- courseUUID: string
- auth: default
Returns Promise<CheckinResponse>

CheckinList

CheckinList(courseId: number, auth: default): Promise<any[]>

- Defined in logic/teacher/checkin_list.ts:9
Get the students list as well as their checkin status.

Parameters
- courseId: number
- auth: default
Returns Promise<any[]>

CloseCourse

CloseCourse(courseId: number, auth: default): Promise<boolean>

- Defined in logic/course/close_course.ts:7
Close a course.

Parameters
- courseId: number
- auth: default
Returns Promise<boolean>

CreateCourse

CreateCourse(classroomId: string, request: { expire_time: string; late_time: string; start_timestamp: Date }, auth: default): Promise<CourseResponse>

- Defined in logic/course/create_course.ts:18
Create a course.
example
```
CreateCourse("12345", {
  start_timestamp: new Date(),
  late_time: "00:10:00",
  expire_time: "00:50:00",
});
```
Parameters
- classroomId: string
- request: { expire_time: string; late_time: string; start_timestamp: Date }
  - expire_time: string
  - late_time: string
  - start_timestamp: Date
- auth: default
Returns Promise<CourseResponse>

GetClassroomsList

GetClassroomsList(auth: default): Promise<any[]>

- Defined in logic/course/get_classrooms_list.ts:9
Get the available classrooms.

Parameters
- auth: default
Returns Promise<any[]>

GetClientId

GetClientId(): Promise<OrgInfoResponse>

- Defined in logic/auth/get_client_id.ts:9
Get the Google OAuth2 client ID for the Google login component from backend.

Returns Promise<OrgInfoResponse>

GetCourseByID

GetCourseByID(courseId: number, auth: default): Promise<CourseResponse>

- Defined in logic/course/get_course.ts:23
Get the info of the specified ID of course.

Parameters
- courseId: number
- auth: default
Returns Promise<CourseResponse>

GetCourseByUUID

GetCourseByUUID(courseUUID: string): Promise<CourseResponse>

- Defined in logic/course/get_course.ts:9
Get the info of the specified UUID of course.

Parameters
- courseUUID: string
Returns Promise<CourseResponse>

GetCoursesList

GetCoursesList(auth: default): Promise<any[]>

- Defined in logic/course/get_courses_list.ts:9
Get the available courses.

Parameters
- auth: default
Returns Promise<any[]>

GetShareLink

GetShareLink(courseId: number, auth: default): Promise<ShareResponse>

- Defined in logic/course/get_share_link.ts:9
Get the share link.

Parameters
- courseId: number
- auth: default
Returns Promise<ShareResponse>

ShareToClassroom

ShareToClassroom(courseId: number, auth: default): Promise<ShareResponse>

- Defined in logic/course/share_to_classroom.ts:11
Share this course to Google Classroom.

Parameters
- courseId: number
- auth: default
Returns Promise<ShareResponse>
the link sent

SyncCourseMembers

SyncCourseMembers(courseId: number, auth: default): Promise<boolean>

- Defined in logic/course/sync_course_members.ts:7
Sync the members list of the specified course.

Parameters
- courseId: number
- auth: default
Returns Promise<boolean>

Generated using TypeDoc