文档中心
灵动课堂
API 参考
EduApiService | agora classroom sdk
Edu Store API Reference for Web/Electron
Properties
Optional headers
headers?: Record<string, string | number>
Optional host
host?: string
Optional pathPrefix
pathPrefix?: string
Methods
acceptGroupInvite
- acceptGroupInvite(roomUuid: string, groupUuid: string, data?: { leaveGroupUuids: string[] }): Promise<any>
Parameters
roomUuid: string
groupUuid: string
Optional data: { leaveGroupUuids: string[] }
leaveGroupUuids: string[]
Returns Promise<any>
acceptHandsUp
- acceptHandsUp(params: { roomUuid: string; toUserUuid: string }): Promise<any>
Parameters
params: { roomUuid: string; toUserUuid: string }
roomUuid: string
toUserUuid: string
Returns Promise<any>
addCloudDriveFile
Parameters
resourceUuid: string
userUuid: string
Returns Promise<any>
addCloudDriveFileV3
- addCloudDriveFileV3(resourceUuid: string, userUuid: string, resourceInfo: CloudDriveResourceInfo): Promise<any>
Parameters
resourceUuid: string
userUuid: string
Returns Promise<any>
addGroup
- addGroup(roomUuid: string, data: { groups: GroupDetail[]; inProgress: boolean }): Promise<any>
Parameters
roomUuid: string
data: { groups: GroupDetail[]; inProgress: boolean }
Returns Promise<any>
allowHandsUp
- allowHandsUp(params: { defaultAcceptRole?: "" | "audience"; roomUuid: string; state: number }): Promise<any>
Parameters
params: { defaultAcceptRole?: "" | "audience"; roomUuid: string; state: number }
Optional defaultAcceptRole?: "" | "audience"
roomUuid: string
state: number
Returns Promise<any>
broadcastHxChatMessage
Parameters
roomUuid: string
msg: string
Optional toGroupUuids?: string[]
Returns Promise<any>
broadcastMessage
Parameters
roomUuid: string
msg: string
Optional toGroupUuids?: string[]
Returns Promise<any>
broadcastRtmChatMessage
Parameters
roomUuid: string
msg: string
Optional toGroupUuids?: string[]
Returns Promise<any>
cancelHandsUp
- cancelHandsUp(params: { roomUuid: string; toUserUuid?: string }): Promise<any>
Parameters
params: { roomUuid: string; toUserUuid?: string }
roomUuid: string
Optional toUserUuid?: string
Returns Promise<any>
checkIn
- checkIn(session: EduSessionInfo, handsUpLimit?: { maxAccept: number; maxWait: number; timeout: number; type: number }, stream?: { audioSourceState?: AgoraRteMediaSourceState; audioState?: AgoraRteMediaPublishState; videoSourceState?: AgoraRteMediaSourceState; videoState?: AgoraRteMediaPublishState }): Promise<any>
Parameters
Optional handsUpLimit: { maxAccept: number; maxWait: number; timeout: number; type: number }
maxAccept: number
maxWait: number
timeout: number
type: number
Optional stream: { audioSourceState?: AgoraRteMediaSourceState; audioState?: AgoraRteMediaPublishState; videoSourceState?: AgoraRteMediaSourceState; videoState?: AgoraRteMediaPublishState }
Optional audioSourceState?: AgoraRteMediaSourceState
Optional audioState?: AgoraRteMediaPublishState
Optional videoSourceState?: AgoraRteMediaSourceState
Optional videoState?: AgoraRteMediaPublishState
Returns Promise<any>
confirmInvited
- confirmInvited(params: { roomUuid: string }): Promise<any>
Parameters
params: { roomUuid: string }
Returns Promise<any>
copyScenes
- copyScenes(roomUuid: string, fromRoomUuid: string): Promise<any>
Parameters
roomUuid: string
fromRoomUuid: string
Returns Promise<any>
deleteBatchUserProperties
- deleteBatchUserProperties(param0: { data: { cause?: unknown; properties: string[]; userUuid: string }[]; roomUuid: string }): Promise<any>
Parameters
param0: { data: { cause?: unknown; properties: string[]; userUuid: string }[]; roomUuid: string }
data: { cause?: unknown; properties: string[]; userUuid: string }[]
roomUuid: string
Returns Promise<any>
deleteWidget
- deleteWidget(roomUuid: string, widgetUuid: string): Promise<{ data: any }>
Parameters
roomUuid: string
widgetUuid: string
Returns Promise<{ data: any }>
dismissHandsUp
- dismissHandsUp(params: { roomUuid: string; toUserUuid: string }): Promise<any>
Parameters
params: { roomUuid: string; toUserUuid: string }
roomUuid: string
toUserUuid: string
Returns Promise<any>
fetch
- fetch(params: AgoraFetchParams): Promise<any>
Parameters
Returns Promise<any>
fetchFileUploadSts
- fetchFileUploadSts(param0: Partial<{ contentType: string; conversion?: Partial<Partial<{ canvasVersion: boolean; outputFormat: string; preview: boolean; scale: number; type: string }>>; ext: string; resourceName: string; size: number; userUuid: string }>): Promise<any>
Parameters
param0: Partial<{ contentType: string; conversion?: Partial<Partial<{ canvasVersion: boolean; outputFormat: string; preview: boolean; scale: number; type: string }>>; ext: string; resourceName: string; size: number; userUuid: string }>
Returns Promise<any>
fetchPersonalResources
- fetchPersonalResources(userUuid: string, options: { converted?: number; limit?: number; nextId?: string; orderBy?: string; pageNo?: number; pageSize?: number; parentResourceUuid?: string; resourceName?: string; tags?: string[] }): Promise<any>
Parameters
userUuid: string
options: { converted?: number; limit?: number; nextId?: string; orderBy?: string; pageNo?: number; pageSize?: number; parentResourceUuid?: string; resourceName?: string; tags?: string[] }
Optional converted?: number
Optional limit?: number
Optional nextId?: string
Optional orderBy?: string
Optional pageNo?: number
Optional pageSize?: number
Optional parentResourceUuid?: string
Optional resourceName?: string
Optional tags?: string[]
Returns Promise<any>
fetchUserList
- fetchUserList(roomId: string, params: { count?: number; nextId: undefined | null | string | number; role: EduRoleTypeEnum; type?: "0" | "1"; userName?: string }): Promise<any>
Parameters
roomId: string
params: { count?: number; nextId: undefined | null | string | number; role: EduRoleTypeEnum; type?: "0" | "1"; userName?: string }
Optional count?: number
nextId: undefined | null | string | number
Optional type?: "0" | "1"
Optional userName?: string
Returns Promise<any>
getAgoraChatToken
- getAgoraChatToken(param0: { roomUuid: string; userUuid: string }): Promise<any>
Parameters
param0: { roomUuid: string; userUuid: string }
roomUuid: string
userUuid: string
Returns Promise<any>
getAnswerList
- getAnswerList(roomUuid: string, popupQuizId: string, query: { count: number; nextId: number }): Promise<{ data: any }>
Parameters
roomUuid: string
popupQuizId: string
query: { count: number; nextId: number }
count: number
nextId: number
Returns Promise<{ data: any }>
getConversationHistoryChatMessage
- getConversationHistoryChatMessage(params: { data: { nextId: string; sort: number; studentUuid: string }; roomUuid: string }): Promise<any>
Parameters
params: { data: { nextId: string; sort: number; studentUuid: string }; roomUuid: string }
data: { nextId: string; sort: number; studentUuid: string }
nextId: string
sort: number
studentUuid: string
roomUuid: string
Returns Promise<any>
getConversationList
- getConversationList(params: { data: { nextId: string }; roomUuid: string }): Promise<any>
Parameters
params: { data: { nextId: string }; roomUuid: string }
data: { nextId: string }
roomUuid: string
Returns Promise<any>
getHistoryChatMessage
- getHistoryChatMessage(params: { data: { nextId: string; sort: number }; roomUuid: string; userUuid: string }): Promise<any>
Parameters
params: { data: { nextId: string; sort: number }; roomUuid: string; userUuid: string }
data: { nextId: string; sort: number }
nextId: string
sort: number
roomUuid: string
userUuid: string
Returns Promise<any>
getRecordList
- getRecordList(param0: { nextId?: number; roomUuid: string }): Promise<any>
Parameters
param0: { nextId?: number; roomUuid: string }
Optional nextId?: number
roomUuid: string
Returns Promise<any>
getRoomEvents
- getRoomEvents(param0: { causeDataFilterKeys?: string; causeDataFilterValues?: string; cmd?: number; nextId?: number; roomUuid: string; userUuid?: string }): Promise<any>
Parameters
param0: { causeDataFilterKeys?: string; causeDataFilterValues?: string; cmd?: number; nextId?: number; roomUuid: string; userUuid?: string }
Optional causeDataFilterKeys?: string
Optional causeDataFilterValues?: string
Optional cmd?: number
Optional nextId?: number
roomUuid: string
Optional userUuid?: string
Returns Promise<any>
getWindowManagerAttributes
- getWindowManagerAttributes(roomUuid: string): Promise<any>
Parameters
Returns Promise<any>
kickOutOnceOrBan
- kickOutOnceOrBan(userUuid: string, isBan: boolean, roomUuid: string): Promise<any>
Parameters
userUuid: string
isBan: boolean
roomUuid: string
Returns Promise<any>
muteChat
- muteChat(params: { muteChat: number; roomUuid: string }): Promise<any>
Parameters
params: { muteChat: number; roomUuid: string }
muteChat: number
roomUuid: string
Returns Promise<any>
refuseHandsUp
- refuseHandsUp(params: { roomUuid: string; toUserUuid: string }): Promise<any>
Parameters
params: { roomUuid: string; toUserUuid: string }
roomUuid: string
toUserUuid: string
Returns Promise<any>
rejectGroupInvite
- rejectGroupInvite(roomUuid: string, groupUuid: string): Promise<any>
Parameters
roomUuid: string
groupUuid: string
Returns Promise<any>
remoteControlGetTokens
- remoteControlGetTokens(roomUuid: string, userUuid: string): Promise<any>
Parameters
roomUuid: string
userUuid: string
Returns Promise<any>
remoteControlStudentAcceptInvite
- remoteControlStudentAcceptInvite(roomUuid: string, userUuid: string): Promise<any>
Parameters
roomUuid: string
userUuid: string
Returns Promise<any>
remoteControlTeacherAuthorization
- remoteControlTeacherAuthorization(roomUuid: string, userUuid: string): Promise<any>
Parameters
roomUuid: string
userUuid: string
Returns Promise<any>
remoteControlTeacherInvite
- remoteControlTeacherInvite(roomUuid: string, data: { toUserUuid: string }): Promise<any>
Parameters
roomUuid: string
data: { toUserUuid: string }
Returns Promise<any>
remoteControlTeacherStopInvite
- remoteControlTeacherStopInvite(roomUuid: string, toUserUuid: string): Promise<any>
Parameters
roomUuid: string
toUserUuid: string
Returns Promise<any>
remoteControlTeacherUnauthorization
- remoteControlTeacherUnauthorization(roomUuid: string, userUuid: string): Promise<any>
Parameters
roomUuid: string
userUuid: string
Returns Promise<any>
removeGroup
- removeGroup(roomUuid: string, data: { removeGroupUuids: string[] }): Promise<any>
Parameters
roomUuid: string
data: { removeGroupUuids: string[] }
removeGroupUuids: string[]
Returns Promise<any>
removeMaterials
- removeMaterials(resourceUuids: string[], userUuid: string): Promise<any>
Parameters
resourceUuids: string[]
userUuid: string
Returns Promise<any>
removeWidgetExtraProperties
- removeWidgetExtraProperties(roomUuid: string, widgetUuid: string, properties: unknown): Promise<{ data: any }>
Parameters
roomUuid: string
widgetUuid: string
properties: unknown
Returns Promise<{ data: any }>
removeWidgetUserProperties
- removeWidgetUserProperties(roomUuid: string, widgetUuid: string, userUuid: string, properties: unknown): Promise<{ data: any }>
Parameters
roomUuid: string
widgetUuid: string
userUuid: string
properties: unknown
Returns Promise<{ data: any }>
reportMicCameraStateLeagcy
- reportMicCameraStateLeagcy(payload: { data: unknown; roomUuid: string; userUuid: string }): Promise<any>
Parameters
payload: { data: unknown; roomUuid: string; userUuid: string }
data: unknown
roomUuid: string
userUuid: string
Returns Promise<any>
revokeAllCoVideo
- revokeAllCoVideo(params: { roomUuid: string }): Promise<any>
Parameters
params: { roomUuid: string }
Returns Promise<any>
revokeCoVideo
- revokeCoVideo(params: { roomUuid: string; toUserUuid?: string }): Promise<any>
Parameters
params: { roomUuid: string; toUserUuid?: string }
roomUuid: string
Optional toUserUuid?: string
Returns Promise<any>
sendChat
- sendChat(params: { data: { message: string; type: number }; roomUuid: string; userUuid: string }): Promise<any>
Parameters
params: { data: { message: string; type: number }; roomUuid: string; userUuid: string }
data: { message: string; type: number }
message: string
type: number
roomUuid: string
userUuid: string
Returns Promise<any>
sendConversationChat
- sendConversationChat(params: { data: { message: string; type: number }; roomUuid: string; userUuid: string }): Promise<any>
Parameters
params: { data: { message: string; type: number }; roomUuid: string; userUuid: string }
data: { message: string; type: number }
message: string
type: number
roomUuid: string
userUuid: string
Returns Promise<any>
sendNotificationMessage
- sendNotificationMessage(roomUuid: string, data: { msg: string; rang: number; toGroupUuids: string[]; type: string }): Promise<any>
Parameters
roomUuid: string
data: { msg: string; rang: number; toGroupUuids: string[]; type: string }
msg: string
rang: number
toGroupUuids: string[]
type: string
Returns Promise<any>
sendRewards
- sendRewards(params: { rewards: { changeReward: number; userUuid: string }[]; roomUuid: string }, isBatch?: boolean): Promise<any>
Parameters
params: { rewards: { changeReward: number; userUuid: string }[]; roomUuid: string }
rewards: { changeReward: number; userUuid: string }[]
roomUuid: string
Optional isBatch: boolean
Returns Promise<any>
setWindowManagerAttributes
- setWindowManagerAttributes(roomUuid: string, data: unknown): Promise<any>
Parameters
roomUuid: string
data: unknown
Returns Promise<any>
startAnswer
- startAnswer(roomUuid: string, properties: unknown): Promise<{ data: any }>
Parameters
roomUuid: string
properties: unknown
Returns Promise<{ data: any }>
startCarousel
- startCarousel(payload: { count?: number; interval?: number; range?: number; roomUuid: string; type?: number }): Promise<any>
Parameters
payload: { count?: number; interval?: number; range?: number; roomUuid: string; type?: number }
Optional count?: number
Optional interval?: number
Optional range?: number
roomUuid: string
Optional type?: number
Returns Promise<any>
startHandsUp
- startHandsUp(params: { payload?: unknown; retry?: boolean; roomUuid: string; timout?: number; toUserUuid: string }): Promise<any>
Parameters
params: { payload?: unknown; retry?: boolean; roomUuid: string; timout?: number; toUserUuid: string }
Optional payload?: unknown
Optional retry?: boolean
roomUuid: string
Optional timout?: number
toUserUuid: string
Returns Promise<any>
startPolling
- startPolling(roomUuid: string, properties: unknown): Promise<{ data: any }>
Parameters
roomUuid: string
properties: unknown
Returns Promise<{ data: any }>
startShareScreen
- startShareScreen(roomId: string, userUuid: string, audioOptions?: Partial<AgoraStreamStates>): Promise<any>
Parameters
roomId: string
userUuid: string
Returns Promise<any>
startShareScreenStateless
- startShareScreenStateless(roomId: string, userUuid: string): Promise<any>
Parameters
roomId: string
userUuid: string
Returns Promise<any>
stopAnswer
- stopAnswer(roomUuid: string, popupQuizId: string): Promise<{ data: any }>
Parameters
roomUuid: string
popupQuizId: string
Returns Promise<{ data: any }>
stopCarousel
- stopCarousel(payload: { roomUuid: string }): Promise<any>
Parameters
payload: { roomUuid: string }
Returns Promise<any>
stopPolling
- stopPolling(roomUuid: string, pollId: string): Promise<{ data: any }>
Parameters
roomUuid: string
pollId: string
Returns Promise<{ data: any }>
stopShareScreen
- stopShareScreen(roomId: string, userUuid: string): Promise<any>
Parameters
roomId: string
userUuid: string
Returns Promise<any>
stopShareScreenStateless
- stopShareScreenStateless(roomId: string, userUuid: string): Promise<any>
Parameters
roomId: string
userUuid: string
Returns Promise<any>
submitAnswer
- submitAnswer(roomUuid: string, popupQuizId: string, userUuid: string, properties: unknown): Promise<{ data: any }>
Parameters
roomUuid: string
popupQuizId: string
userUuid: string
properties: unknown
Returns Promise<{ data: any }>
submitResult
- submitResult(roomUuid: string, pollId: string, userUuid: string, properties: unknown): Promise<{ data: any }>
Parameters
roomUuid: string
pollId: string
userUuid: string
properties: unknown
Returns Promise<{ data: any }>
updateBatchUserProperties
- updateBatchUserProperties(param0: { data: { cause?: unknown; properties: unknown; userUuid: string }[]; roomUuid: string }): Promise<any>
Parameters
param0: { data: { cause?: unknown; properties: unknown; userUuid: string }[]; roomUuid: string }
data: { cause?: unknown; properties: unknown; userUuid: string }[]
roomUuid: string
Returns Promise<any>
updateClassState
- updateClassState(params: { roomUuid: string; state: ClassState }): Promise<any>
Parameters
Returns Promise<any>
updateExpandedScopeAndStreams
- updateExpandedScopeAndStreams(roomUuid: string, state: 0 | 1, data: { userUuids: string[] }): Promise<any>
Parameters
roomUuid: string
state: 0 | 1
data: { userUuids: string[] }
Returns Promise<any>
updateFlexProperties
- updateFlexProperties(roomUuid: string, params: { cause?: unknown; increments?: unknown; properties?: unknown; throttleTime?: number }): Promise<any>
Parameters
roomUuid: string
params: { cause?: unknown; increments?: unknown; properties?: unknown; throttleTime?: number }
Optional cause?: unknown
Optional increments?: unknown
Optional properties?: unknown
Optional throttleTime?: number
Returns Promise<any>
updateGroupInfo
- updateGroupInfo(roomUuid: string, data: { groups: PatchGroup[] }): Promise<any>
Parameters
Returns Promise<any>
updateGroupState
- updateGroupState(roomUuid: string, data: { groups: GroupDetail[]; inProgress?: boolean; syncBoardScenes?: boolean }, state?: GroupState): Promise<any>
Parameters
roomUuid: string
data: { groups: GroupDetail[]; inProgress?: boolean; syncBoardScenes?: boolean }
Optional inProgress?: boolean
Optional syncBoardScenes?: boolean
Returns Promise<any>
updateGroupUsers
- updateGroupUsers(roomUuid: string, data: { groups: PatchGroup[]; inProgress: boolean }): Promise<any>
Parameters
roomUuid: string
data: { groups: PatchGroup[]; inProgress: boolean }
Returns Promise<any>
updateRecordingState
- updateRecordingState(params: { args?: unknown; backupCount?: number; roomUuid: string; state: number }): Promise<any>
Parameters
params: { args?: unknown; backupCount?: number; roomUuid: string; state: number }
Optional args?: unknown
Optional backupCount?: number
roomUuid: string
state: number
Returns Promise<any>
updateUserTags
- updateUserTags(param0: { data: unknown; key: string; roomUuid: string; userUuid: string }): Promise<any>
Parameters
param0: { data: unknown; key: string; roomUuid: string; userUuid: string }
data: unknown
key: string
roomUuid: string
userUuid: string
Returns Promise<any>
updateWidgetProperties
- updateWidgetProperties(roomUuid: string, widgetUuid: string, properties: unknown): Promise<{ data: any }>
Parameters
roomUuid: string
widgetUuid: string
properties: unknown
Returns Promise<{ data: any }>
updateWidgetUserProperties
- updateWidgetUserProperties(roomUuid: string, widgetUuid: string, userUuid: string, properties: unknown): Promise<{ data: any }>
Parameters
roomUuid: string
widgetUuid: string
userUuid: string
properties: unknown
Returns Promise<{ data: any }>
waveArm
- waveArm(params: { payload?: unknown; retry?: boolean; roomUuid: string; timout?: number; toUserUuid: string }): Promise<any>
Parameters
params: { payload?: unknown; retry?: boolean; roomUuid: string; timout?: number; toUserUuid: string }
Optional payload?: unknown
Optional retry?: boolean
roomUuid: string
Optional timout?: number
toUserUuid: string
Returns Promise<any>
接受分组邀请