管理用户属性

大约 4 分钟

管理用户属性

用户属性指实时消息互动用户的信息，如用户昵称、头像、邮箱、电话、性别、签名、生日等。

例如，在招聘场景下，利用用户属性功能可以存储性别、邮箱、用户类型（面试者）、职位类型（web 研发）等。查看用户信息时，可以直接查询服务器存储的用户属性信息。

本文介绍如何通过管理用户属性设置、更新、存储并获取实时消息用户的相关信息。

提示

为保证用户信息安全，SDK 仅支持用户设置或更新自己的用户属性。

技术原理

环信即时通讯 IM HarmonyOS SDK 提供一个 UserInfoManager 类，支持获取、设置及修改用户属性信息，其中包含如下方法：

  • updateUserInfo 设置和修改当前用户自己的属性信息；
  • fetchUserInfoById 获取指定用户的属性信息。

前提条件

设置用户属性前，请确保满足以下条件：

实现方法

本节介绍如何在项目中设置及获取用户属性。

实现过程中注意单个用户的所有属性最大不超过 2 KB，单个 app 所有用户属性数据最大不超过 10 GB。

设置当前用户的属性

参考如下示例代码，在你的项目中当前用户设置自己的所有属性或者仅设置某一项属性。

// 设置所有用户属性。
let userInfo: UserInfo = {
  nickname: "easemob",
  avatarUrl: "https://www.easemob.com",
  birth: "2000/10/10",
  signature: "Hello world",
  phone: "16666666666",
  email: "666@qq.com",
  gender: Gender.MALE
}

ChatClient.getInstance().userInfoManager()?.updateUserInfo(userInfo).then(result => {
  // success logic
}).catch((e: ChatError) => {
  // failure logic
});


// 以修改用户头像为例，演示如何修改指定用户属性。
let userInfo: UserInfo = {
  avatarUrl: "https://xxx/downloads/IMDemo/avatar/Image1.png"
}
ChatClient.getInstance().userInfoManager()?.updateUserInfo(userInfo).then(result => {
  // success logic
}).catch((e: ChatError) => {
  // failure logic
});

关于用户属性，客户端针对用户的昵称、头像 URL、联系方式、邮箱、性别、签名、生日和扩展字段默认使用以下键名。调用 RESTful 的接口设置或删除用户属性，若要确保在客户端能够获取设置，请求中必须传以下键名与客户端保持一致，键值可根据实际使用场景确定。

字段类型描述
nicknameString用户昵称。长度在 64 字符内。
avatarurlString用户头像 URL 地址。长度在 256 字符内。
phoneString用户联系方式。长度在 32 字符内。
mailString用户邮箱。长度在 64 字符内。
genderInt用户性别：
- 1：男；
- 2：女；
- （默认）0：未知；
- 设置为其他值无效。
signString用户签名。长度在 256 字符内。
birthString用户生日。长度在 64 字符内。
extString扩展字段。

获取用户属性

用户可以从服务端获取指定一个或多个用户的全部用户属性。

示例代码如下：

// 获取一个或多个用户的所有属性，一次调用用户 ID 数量不超过 100。
let userIds = new Array<string>();
userIds.push(this.userId);
ChatClient.getInstance().userInfoManager()?.fetchUserInfoById(userIds).then(result => {
  // success logic
}).catch((e: ChatError) => {
  // failure logic
});

获取指定用户的指定用户属性

用户可以从服务端获取指定用户的指定用户属性信息。

let userIds = new Array<string>();
userIds.push(this.userId);
let userTypes = new Array<UserInfoType>();
userTypes.push(UserInfoType.NICKNAME);
userTypes.push(UserInfoType.AVATAR_URL);
ChatClient.getInstance().userInfoManager()?.fetchUserInfoById(userIds, userTypes).then(result => {
  // success logic
}).catch((e: ChatError) => {
  // failure logic
});

更多功能

用户头像管理

如果你的应用场景中涉及用户头像管理，还可以参考如下步骤进行操作：

  1. 开通第三方文件存储服务。详情可以参考文件储存服务商的文档。
  2. 将头像文件上传至上述第三方文件存储，并获取存储 URL 地址。
  3. 将该 URL 地址传入用户属性的头像字段（avatarUrl）。
  4. 调用 fetchUserInfoById 获取头像 URL，并在本地 UI 中渲染头像。

常见问题

Q：我设置了用户昵称（nickname），但调用客户端或 RESTful API 获取用户属性时，未返回用户昵称，原因是什么？

A：你可以调用客户端 或RESTful API 设置用户昵称，例如，调用 updateUserInfo，然后通过客户端或RESTful API 获取用户属性，例如 SDK 为 fetchUserInfoById。

设置用户昵称时，请注意以下：

  1. 调用 RESTful 接口设置用户昵称时，若要确保在客户端能够获取设置，请求中必须传 nickname 键名。

Q: 调用设置或获取用户属性的接口时，上报错误码 4 的原因是什么？

A：设置和获取用户属性的接口，包括设置当前用户的属性、获取单个或多个用户的用户属性和获取指定用户的指定用户属性，超过调用频率限制时，会上报错误码 4 EXCEED_SERVICE_LIMIT。

环信 IM 文档 Version: 1.0.0 ©️环信