AgoraEduSubRoomContext

AgoraEduSubRoomContext 类。

AgoraEduSubRoomContext 类提供的方法用于子房间控制。

joinSubRoom

加入子房间。

Objective-C

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

参数

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

返回值

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

leaveSubRoom

离开子房间。

Objective-C

void leaveSubRoom()

getSubRoomInfo

获取子房间信息。

Objective-C

AgoraEduContextSubRoomInfo getSubRoomInfo()

返回值

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

getSubRoomProperties

获取子房间自定义属性。

Objective-C

Map<String, Any> getSubRoomProperties()

返回值

子房间自定义属性 Map<String, Any>。可为空。

updateSubRoomProperties

更新子房间自定义属性。

Objective-C

void updateSubRoomProperties(Map<String, Any> properties,
                             Map<String, Any> cause,
                             Callback<Void> success,
                             Callback<AgoraEduContextError> failure)

参数

参数名	描述
properties	房间属性。
cause	更新原因。可为空。
success	调用成功。
fail	调用失败，则返回 AgoraEduContextError。

deleteSubRoomProperties

删除子房间自定义属性。

Objective-C

void deleteSubRoomProperties(Array<String> keyPaths,
                             Map<String, Any> cause,
                             Callback<Void> success,
                             Callback<AgoraEduContextError> failure)

参数

参数名	描述
keyPaths	你想要删除的属性的 key path，如 key1.subkey1。
cause	删除原因。可为空。
success	调用成功。
fail	调用失败，则返回 AgoraEduContextError。