AgoraEduGroupContext

AgoraEduGroupContext 类。

AgoraEduGroupContext 类提供的方法用于管理所有的子房间。可通过该类实现分组讨论功能。

getGroupInfo

获取分组信息。

Objective-C

AgoraEduContextGroupInfo getGroupInfo()

返回值

返回分组信息对象 AgoraEduContextGroupInfo。

addSubRoomList

创建子房间，

Objective-C

void addSubRoomList(Array<AgoraEduContextSubRoomCreateConfig> configList,
                    Callback<Void> success,
                    Callback<AgoraEduContextError> failure)

参数

参数名	描述
configs	创建子房间配置数组，详见 AgoraEduContextSubRoomCreateConfig。
success	调用成功。
fail	调用失败，则返回 AgoraEduContextError。

removeSubRoomList

移除子房间。

Objective-C

void removeSubRoomList(Array<String> subRoomList,
                       Callback<Void> success,
                       Callback<AgoraEduContextError> failure)

参数

参数名	描述
subRoomList	子房间 ID 列表。
success	调用成功。
fail	调用失败，则返回 AgoraEduContextError。

removeAllSubRoomList

移除所有子房间。

Objective-C

void removeAllSubRoomList(Callback<Void> success,
                          Callback<AgoraEduContextError> failure)

参数

参数名	描述
success	调用成功。
fail	调用失败，则返回 AgoraEduContextError。

getSubRoomList

获取子房间列表。

Objective-C

Array<AgoraEduContextSubRoomInfo> getSubRoomList()

返回值

调用成功，则返回子房间信息 AgoraEduContextSubRoomInfo 列表。

createSubRoomObject

创建子房间对象。

Objective-C

AgoraEduContextSubRoom createSubRoomObject(String subRoomUuid)

创建子房间对象后，可由外界管理该对象的生命周期。

参数

参数名	描述
subRoomUuid	子房间 ID。

返回值

返回 AgoraEduSubRoomContext 子房间对象。如果本地用户未在 subRoomUuid 所对应的子房间的用户列表中，则返回空对象。

getUserListFromSubRoom

获取指定子房间内的用户列表。

Objective-C

Array<String> getUserListFromSubRoom(String subRoomUuid)

参数

参数名	描述
subRoomUuid	子房间 ID。

返回值

用户 ID 列表。

inviteUserListToSubRoom

邀请用户加入子房间。

Objective-C

void inviteUserListToSubRoom(Array<String> userList,
                             String subRoomUuid,
                             Callback<Void> success,
                             Callback<AgoraEduContextError> failure)

参数

参数名	描述
userList	用户 ID 列表。
subRoomUuid	子房间 ID。
success	调用成功。
fail	调用失败，则返回 AgoraEduContextError。

userListAcceptInvitationToSubRoom

用户接受邀请进入自房间。

Objective-C

void userListAcceptInvitationToSubRoom(Array<String> userList,
                                       String subRoomUuid,
                                       Callback<Void> success,
                                       Callback<AgoraEduContextError> failure)

参数

参数名	描述
userList	用户 ID 列表。
subRoomUuid	子房间 ID。
success	调用成功。
fail	调用失败，则返回 AgoraEduContextError。

userListRejectInvitationToSubRoom

用户拒绝加入子房间的邀请。

Objective-C

void userListRejectInvitationToSubRoom(Array<String> userList,
                                       String subRoomUuid,
                                       Callback<Void> success,
                                       Callback<AgoraEduContextError> failure)

参数

参数名	描述
userList	用户 ID 列表。
subRoomUuid	子房间 ID。
success	调用成功。
fail	调用失败，则返回 AgoraEduContextError。

addUserListToSubRoom

将用户移入子房间。

Objective-C

void adddUserListToSubRoom(Array<String> userList,
                           String subRoomUuid,
                           Callback<Void> success,
                           Callback<AgoraEduContextError> failure)

该方法跳过邀请步骤，直接将用户移入子房间。

参数

参数名	描述
userList	用户 ID 列表。
subRoomUuid	子房间 ID。
success	调用成功。
fail	调用失败，则返回 AgoraEduContextError。

removeUserListFromSubRoom

将用户移出子房间。

Objective-C

void removeUserListFromSubRoom(Array<String> userList,
                               String subRoomUuid,
                               Callback<Void> success,
                               Callback<AgoraEduContextError> failure)

参数

参数名	描述
userList	用户 ID 列表。
subRoomUuid	子房间 ID。
success	调用成功。
fail	调用失败，则返回 AgoraEduContextError。

moveUserListToSubRoom

将用户从某子房间移动至另一子房间。

Objective-C

void moveUserListToSubRoom(Array<String> userList,
                           String fromSubRoomUuid,
                           String toSubRoomUuid,
                           Callback<Void> success,
                           Callback<AgoraEduContextError> failure)

参数

参数名	描述
userList	用户 ID 列表。
fromSubRoomUuid	源子房间 ID。
toSubRoomUuid	目标子房间 ID。
success	调用成功。
fail	调用失败，则返回 AgoraEduContextError。