User Context

useUserListContext enables developers to implement the user list module in the flexible classroom.

rosterUserList

rosterUserList: any[],

The students displayed in the user list of the classroom.

userList

userList: array,

The list of all users in the classroom.

acceptedUserList

acceptedUserList: array,

The list of users whose application for speaking up has been approved by the teacher.

localUserInfo

localUserInfo: EduUser,

Since v1.1.5.

The information of the local client.

teacherInfo

teacherInfo?: EduUser,

Since v1.1.5.

The information of the teacher in the current classroom.

toggleWhiteboardPermission

toggleWhiteboardPermission: (userUuid:string, whiteboardGranted: boolean) => Promise<any>,

Since v1.1.5.

Grants the permission of drawing on the whiteboard to a specified user.

toggleCamera

toggleCamera: (userUuid:string, enabled: boolean) => Promise<any>,

Since v1.1.5.

Turns on or off the camera of a specified user.

toggleMic

toggleMic: (userUuid:string, enabled: boolean) => Promise<any>,

Since v1.1.5.

Turns on or off the microphone of a specified user.

controlTools

controlTools: ControlTool[],

Since v1.1.5.

Available user management tools.

isHost

isHost: boolean

Since v1.1.5.

Whether the local user is the host.

kick

kick: (userUuid:string) => Promise<any>,

Since v1.1.5.

Kicks a specified user out of the classroom.