RoomContext

joinRoom

加入房间。

Kotlin

abstract fun joinRoom(callback: EduContextCallback<Unit>?)

参数

callback

通过 EduContextCallback 异步获取调用结果。

leaveRoom

离开房间。

Kotlin

abstract fun leaveRoom(callback: EduContextCallback<Unit>?)

参数

callback

通过 EduContextCallback 异步获取调用结果。

getRoomInfo

获取房间信息。

Kotlin

abstract fun getRoomInfo(): EduContextRoomInfo

返回值

调用成功，则返回 EduContextRoomInfo。

getRoomProperties

获取自定义房间属性。

Kotlin

abstract fun getRoomProperties(): Map<String, Any>?

返回值

调用成功，则返回 Map<String, Any>。

updateRoomProperties

新增或更新自定义房间属性。

Kotlin

abstract fun updateRoomProperties(properties: MutableMap<String, Any>,
                                  cause: MutableMap<String, Any>?,
                                  callback: EduContextCallback<Unit>? = null)

详情

详见如何设置自定义房间属性。

属性成功更新后，会触发 onRoomPropertiesUpdated 回调。

参数

properties

房间属性。

cause

更新原因。可为空。

callback

通过 EduContextCallback 异步获取调用结果。

deleteRoomProperties

删除自定义房间属性。

Kotlin

abstract fun deleteRoomProperties(keyPaths: MutableList<String>,
                                  cause: MutableMap<String, Any>?,
                                  callback: EduContextCallback<Unit>? = null)

参数

keyPaths

你想要删除的属性的 key path，如 key1.subkey1。

cause

删除原因。可为空。

callback

通过 EduContextCallback 异步获取调用结果。

getClassInfo

获取课堂信息。

Kotlin

abstract fun getClassInfo(): AgoraEduContextClassInfo

返回值

调用成功，则返回 AgoraEduContextClassInfo。