UserContext

UserContext 类。

UserContext 类提供的方法用于：

• 控制用户上下台行为。

• 更新用户信息和属性。

getLocalUserInfo

获取本地用户信息。

Kotlin

abstract fun getLocalUserInfo(): AgoraEduContextUserInfo

返回值

调用成功，则返回 AgoraEduContextUserInfo。

getCoHostList

获取所有上台用户的信息。

Kotlin

abstract fun getCoHostList(): List<AgoraEduContextUserInfo>

返回值

调用成功，则返回 AgoraEduContextUserInfo 数组。

getUserList

获取指定角色的用户信息。

Kotlin

abstract fun getUserList(role: AgoraEduContextUserRole): List<AgoraEduContextUserInfo>

参数

参数名	描述
role	用户角色，详见 AgoraEduContextUserRole。

返回值

调用成功，则返回 AgoraEduContextUserInfo 数组。

getAllUserList

获取房间内所有用户的信息。

Kotlin

abstract fun getAllUserList(): List<AgoraEduContextUserInfo>

返回值

调用成功，则返回 AgoraEduContextUserInfo 数组。

updateUserProperties

新增或更新自定义用户属性。

Kotlin

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

详见如何设置自定义用户属性。

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

参数

参数名	描述
userUuid	用户 ID。
properties	用户属性。
cause	更新原因，可为空。
callback	通过 EduContextCallback 异步获取调用结果。

deleteUserProperties

删除自定义用户属性。

Kotlin

abstract fun deleteUserProperties(userUuid: String,
                                  keys: MutableList<String>,
                                  cause: MutableMap<String, Any>?,
                                  callback: EduContextCallback<Unit>? = null)

参数

参数名	描述
userUuid	用户 ID。
keys	你想要删除的属性的 key path，如 "key1.subkey1"。
cause	删除原因，可为空。
callback	通过 EduContextCallback 异步获取调用结果。

getUserProperties

获取指定用户的自定义属性。

Kotlin

abstract fun getUserProperties(userUuid: String): MutableMap<String, Any>

参数

参数名	描述
userUuid	用户 ID。

返回值

调用成功，则返回用户自定义属性。

getUserRewardCount

获取指定用户拥有的奖励数量。

Kotlin

abstract fun getUserRewardCount(userUuid: String): Int

参数

参数名	描述
userUuid	用户 ID。

返回值

调用成功，则返回奖励数量。

getHandsWaveEnable

确认是否能举手。

Kotlin

abstract fun getHandsWaveEnable(): Boolean

确认当前房间内学生是否能举手申请上讲台。

返回值

请求成功，则返回确认结果。

handsWave

举手申请上讲台发言。

Kotlin

abstract fun handsWave(duration: Int,
                       callback: EduContextCallback<Unit>? = null)

参数

参数名	描述
duration	申请上讲台的时长，单位为秒。
payload	自定义信息，可为空。
callback	通过 EduContextCallback 异步获取调用结果。

handsDown

取消举手。

Kotlin

abstract fun handsDown(callback: EduContextCallback<Unit>? = null)

参数

参数名	描述
callback	通过 EduContextCallback 异步获取调用结果。