AgoraEduUserContext

AgoraEduUserContext 类。

AgoraEduUserContext 类提供的方法用于：

• 控制用户上下台行为。

• 更新用户信息和属性。

getLocalUserInfo

获取本地用户信息。

C++

AgoraEduContextUserInfo getLocalUserInfo()

返回值

调用成功，则返回 AgoraEduContextUserInfo。

getCoHostList

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

C++

Array<AgoraEduContextUserInfo> getCoHostList()

返回值

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

getUserList

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

C++

Array<AgoraEduContextUserInfo> getUserList(AgoraEduContextUserRole role)

参数

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

返回值

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

getAllUserList

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

C++

Array<AgoraEduContextUserInfo> getAllUserList()

返回值

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

updateUserProperties

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

C++

void updateUserProperties(String userUuid,
                          Map<String, Any> properties,
                          Map<String, Any> cause,
                          Callback<Void> success,
                          Callback<AgoraEduContextError> fail)

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

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

参数

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

deleteUserProperties

删除自定义用户属性。

C++

void deleteUserProperties(String userUuid,
                          Array<String> keyPaths,
                          Map<String, Any> cause,
                          Callback<Void> success,
                          Callback<AgoraEduContextError> fail)

参数

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

getUserProperties

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

C++

Map<String, Any> getUserProperties(String userUuid)

参数

参数名	描述
userUuid	用户 ID。

返回值

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

getUserRewardCount

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

C++

Int getUserRewardCount(String userUuid)

参数

参数名	描述
userUuid	用户 ID。

返回值

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

getHandsWaveEnable

确认是否能举手。

C++

Bool getHandsWaveEnable()

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

返回值

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

handsWave

举手申请上讲台发言。

C++

void handsWave(Int duration,
               Callback<Void> success,
               Callback<AgoraEduContextError> fail)

参数

参数名	描述
duration	申请上讲台的时长，单位为秒。
payload	自定义信息，可为空。
success	调用成功。
fail	调用失败，则返回 AgoraEduContextError。

handsDown

取消举手。

C++

void handsDown(Callback<Void> success,
               Callback<AgoraEduContextError> fail)

参数

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