文档中心
灵动课堂
API 参考
GroupStore | agora classroom sdk
Edu Store API Reference for Web/Electron
Properties
Protected Readonly classroomStore
Protected Readonly logger
logger: Logger
Static Readonly CMD_PROCESS_PREFIX
CMD_PROCESS_PREFIX: "groups-" = "groups-"
Static Readonly MAX_GROUP_COUNT
MAX_GROUP_COUNT: 20 = 20
Static Readonly MAX_PER_GROUP_PERSON
MAX_PER_GROUP_PERSON: 15 = 15
Static Readonly MIN_GROUP_COUNT
MIN_GROUP_COUNT: 2 = 2
Accessors
currentSubRoom
- get currentSubRoom(): undefined | string
Returns undefined | string
groupUuidByUserUuid
- get groupUuidByUserUuid(): Map<string, string>
Returns Map<string, string>
Methods
acceptGroupInvite
- acceptGroupInvite(groupUuid: string): Promise<void>
Parameters
Returns Promise<void>
addGroups
- addGroups(groupDetails: (GroupDetail & { groupUuid?: string })[], inProgress?: boolean): Promise<void>
Parameters
groupDetails: (GroupDetail & { groupUuid?: string })[]
Optional inProgress: boolean
Returns Promise<void>
broadcastMessage
- broadcastMessage(messageText: string): void
joinSubRoom
- joinSubRoom(groupUuid: string): void
moveIntoSubRoom
- moveIntoSubRoom(fromGroupUuid: string, toGroupUuid: string): void
Parameters
fromGroupUuid: string
toGroupUuid: string
Returns void
moveUsersToGroup
- moveUsersToGroup(fromGroupUuid: string, toGroupUuid: string, users: string[]): Promise<void>
Parameters
fromGroupUuid: string
toGroupUuid: string
users: string[]
Returns Promise<void>
rejectGroupInvite
- rejectGroupInvite(groupUuid: string): Promise<void>
Parameters
Returns Promise<void>
removeGroupUsers
- removeGroupUsers(fromGroupUuid: string, users: string[]): Promise<void>
Parameters
fromGroupUuid: string
users: string[]
Returns Promise<void>
removeGroups
- removeGroups(groups: string[]): Promise<void>
Parameters
Returns Promise<void>
startGroup
- startGroup(groupDetails: GroupDetail[], syncBoardScenes?: boolean): Promise<void>
Parameters
Optional syncBoardScenes: boolean
Returns Promise<void>
stopGroup
- stopGroup(): Promise<void>
updateGroupInfo
- updateGroupInfo(groups: PatchGroup[]): Promise<void>
Parameters
Returns Promise<void>
updateGroupUsers
- updateGroupUsers(patches: PatchGroup[], sendInvitation?: boolean): Promise<void>
Parameters
Optional sendInvitation: boolean
Returns Promise<void>
GroupStore
类提供分组讨论功能相关的能力。 负责功能: 1.获取子房间 2.获取子房间对象 3.加入子房间 4.离开子房间 5.主房间属性 6.新增房间 7.删除房间 8.删除所有子房间 9.添加用户到房间 10.邀请用户到房间 11.用户接收邀请进入房间 12.用户移动至指定房间