logo
当前页

用户管理


功能简介

ZIM SDK 提供了用户管理功能,支持用户上传自己的个人信息,更新自己的用户名称、头像,以及查询自己的个人信息等。

实现流程

用户扩展字段管理

ZIM SDK 提供了用户信息的扩展字段,用于描述用户的其他相关属性。开发者可以使用扩展字段,通过 UpdateUserExtendedData 接口,自定义用户的扩展字段。扩展字段可由开发者自行定义其使用方式,SDK 只会将该字段透传,不会做其它处理。

修改扩展字段属性后,用户可以通过 ZIMUserExtendedDataUpdatedCallback 收到修改结果。

Example
string newUserExtendedData = "{\"user_avatar\":\"https://url\",\"user_name\":\"new_name\",\"user_sex\":\"male\",\"user_birth\":\"1970-01-01\",\"user_phone\":\"12345678901\"}";

ZIM.GetInstance().UpdateUserExtendedData(newUserExtendedData, 
(string extendedData, ZIMError errorInfo) => {
    if(errorInfo.code == ZIMErrorCode.Success) {
        // 操作成功
    }
});
1
Copied!

修改用户名称

用户名称 userName,是指用来描述用户昵称的字符串,开发者可以通过 ZIMUserInfo 对象进行配置。ZIM SDK 支持用户在登录后,通过 UpdateUserName 接口修改自己的用户名称。

修改用户名称后,用户可以通过 ZIMUserNameUpdatedCallback 收到修改结果。

Example
// 修改用户名
// userName 是一个最大长度为256字节的字符串,没有特殊字符限制。
string newUserName = "新用户名";
ZIM.GetInstance().UpdateUserName(newUserName, (string userName, ZIMError errorInfo) => {
    if(errorInfo.code == ZIMErrorCode.Success) {
        // 操作成功
    }
});
1
Copied!

设置用户头像

ZIM SDK 支持用户在登录后,通过 UpdateUserAvatarUrl 接口设置或修改自己的用户头像。

设置用户头像后,用户可以通过 ZIMUserAvatarUrlUpdatedCallback 收到设置结果。

注意

当一名用户修改头像后,其他用户需调用 QueryUsersInfo 接口,并将 ZIMUsersInfoQueryConfigisQueryFromServer 参数赋值为 true 重新 查询用户信息,才会获取最新头像。

Example
// URL最大为500字节,没有特殊字符限制
string userAvatarUrl = "xxx";
ZIM.GetInstance().UpdateUserAvatarUrl(userAvatarUrl, (string userAvatarUrl, ZIMError errorInfo) => {
    if(errorInfo.code == ZIMErrorCode.Success) {
        // 操作成功
    }
});
1
Copied!

查询用户信息

用户可以通过 QueryUsersInfo 接口,查询指定用户的全量信息,包括用户名称、用户扩展字段。用户头像 URL、用户扩展字段信息,仅在该接口中可以获取到。

查询信息后,用户可以通过 ZIMUsersInfoQueriedCallback 收到查询结果。

Example
// 限制:单个 API 调用中的 UserID 查询数量不能超过 10;在 10 秒内,所有 UserID 查询的累计总数不能超过 10。
List<string> userIDList = new List<string>();
userIDList.Add("user_id_1");
ZIMUsersInfoQueryConfig config = new ZIMUsersInfoQueryConfig();
ZIM.GetInstance().QueryUsersInfo(userIDList, config, (ZIMUserFullInfo[] userList, ZIMErrorUserInfo[] errorUserList, ZIMError errorInfo) => {
    if (errorInfo.code == ZIMErrorCode.Success)
    {
        // 操作成功
    }
});
1
Copied!

Previous

使用 Token 鉴权

Next

房间管理