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.updateUserExtendedData(newUserExtendedData, new ZIMUserExtendedDataUpdatedCallback() {
        @Override
        public void onUserExtendedDataUpdated(String extendedData, ZIMError errorInfo) {
            if(errorInfo.code == ZIMErrorCode.SUCCESS) {
                // 修改成功
            }
        }
});
1
Copied!

修改用户名称

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

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

Example
// 修改用户名称
// userName 最大 256 字节的字符串,无特殊字符限制。
String newUserName = "new_name";
zim.updateUserName(newUserName, new ZIMUserNameUpdatedCallback() {
        @Override
        public void onUserNameUpdated(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.updateUserAvatarUrl(userAvatarUrl, new ZIMUserAvatarUrlUpdatedCallback() {
    @Override
    public void onUserAvatarUrlUpdated(String userAvatarUrl, ZIMError errorInfo) {
        if(errorInfo.code == ZIMErrorCode.SUCCESS) {
            // 设置成功
        }
    }
});
1
Copied!

查询用户信息

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

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

Example
// 查询用户信息

// 使用限制:单次调用接口,查询 UserID 不能超过 10 个;在 10 秒内,多次调用接口查询的 UserID 累计总数不能超过 10 个。
ArrayList<String> userIDList = new ArrayList<>();
userIDList.add("user_id_1");

ZIMUsersInfoQueryConfig config = new ZIMUsersInfoQueryConfig();
config.isQueryFromServer = false;

zim.queryUsersInfo(userIDList, config, new ZIMUsersInfoQueriedCallback() {
        @Override
        public void onUsersInfoQueried(ArrayList<ZIMUserFullInfo> userList, ArrayList<ZIMErrorUserInfo> errorUserList, ZIMError errorInfo) {
            if(errorInfo.code == ZIMErrorCode.SUCCESS) {
                 // 查询成功
            }
        }
});
1
Copied!

Previous

使用 Token 鉴权

Next

多端登录