====== 用户属性 ======
更新时间:2022-09-07
用户属性指实时消息互动用户的信息,如用户昵称、头像、邮箱、电话、性别、签名、生日等。
例如,在招聘场景下,利用用户属性功能可以存储性别、邮箱、用户类型(面试者)、职位类型(web 研发)等。查看用户信息时,可以直接查询服务器存储的用户属性信息。
本文介绍如何通过管理用户属性设置、更新、存储并获取实时消息用户的相关信息。
**注意** 为保证用户信息安全,SDK 仅支持用户设置或更新自己的用户属性。
===== 技术原理 =====
环信即时通讯 IM Flutter SDK 提供一个 ''%%EMUserInfoManager%%'' 类,支持获取、设置及修改用户属性信息,其中包含如下方法:
* ''%%updateOwnUserInfo%%'' 设置和修改自己的属性信息;
* ''%%fetchUserInfoById%%'' 获取指定用户的属性信息;
* ''%%fetchOwnInfo%%'' 获取自己的属性信息。
===== 前提条件 =====
设置用户属性前,请确保满足以下条件:
* 完成 SDK 初始化,详见 [[https://docs-im.easemob.com/ccim/flutter/quickstart|快速开始]]。
* 了解环信即时通讯 IM 的使用限制,详见 [[https://docs-im.easemob.com/ccim/limitation|使用限制]]。
===== 实现方法 =====
本节介绍如何在项目中设置及获取用户属性。
实现过程中注意单个用户的所有属性最大不超过 2 KB,单个 app 所有用户属性数据最大不超过 10 GB。
==== 设置当前用户的属性 ====
参考如下示例代码,在你的项目中指定用户设置自己的所有属性或者仅设置某一项属性。
try {
await EMClient.getInstance.userInfoManager.updateUserInfo(
nickname: "your nickname",
);
} on EMError catch (e) {}
用户属性包括如下字段:
^字段 ^类型 ^描述 ^
|''%%nickname%%'' |String|用户昵称。长度在 64 字符内。 |
|''%%avatarurl%%''|String|用户头像 URL 地址。长度在 256 字符内。 |
|''%%phone%%'' |String|用户联系方式。长度在 32 字符内。 |
|''%%mail%%'' |String|用户邮箱。长度在 64 字符内。 |
|''%%gender%%'' |Number|用户性别。
- ''%%1%%'':男;
- ''%%2%%'':女;
- (默认)''%%0%%'':未知;
- 设置为其他值无效。|
|''%%sign%%'' |String|用户签名。长度在 256 字符内。 |
|''%%birth%%'' |String|用户生日。长度在 64 字符内。 |
|''userId'' |String|用户 ID。 |
|''%%ext%%'' |String|扩展字段。 |
==== 获取用户属性 ====
你可以获取指定一个或多个用户的用户属性,一次调用用户 ID 数量不超过 100。
示例代码如下:
List list = ["tom", "json"];
try {
Map userInfos =
await EMClient.getInstance.userInfoManager.fetchUserInfoById(list);
} on EMError catch (e) {
}
==== 获取当前用户的属性 ====
try {
EMUserInfo? userInfo =
await EMClient.getInstance.userInfoManager.fetchOwnInfo();
} on EMError catch (e) {
}
===== 更多功能 =====
==== 用户头像管理 ====
如果你的应用场景中涉及用户头像管理,还可以参考如下步骤进行操作:
- 开通第三方文件存储服务。详见[[https://help.aliyun.com/product/27516.html|阿里云文件存储 NAS]] 或其他第三方文件存储帮助文档。
- 将头像文件上传至上述第三方文件存储,并获取存储 URL 地址。
- 将该 URL 地址传入用户属性的头像字段(avatarUrl)。
- 调用 ''%%fetchUserInfoById%%'' 获取头像字段,并在本地 UI 中渲染用户头像。