Merge pull request #1374 from haoxiuwen/doc-v2

Modify Flutter Message Receiving Doc & User Attributes Docs

Author: haoxiuwen

docs/document/android/error.md

@@ -14,7 +14,7 @@ Android 中错误码的类为 [EMError](https://sdkdocs.easemob.com/apidoc/andro
 | 1      |          GENERAL_ERROR          | SDK 或请求相关的默认错误，未区分具体错误类型：例如，SDK 内部未正确初始化，或者请求服务器时未识别出具体原因的错误。 | 需要结合日志和调用的 API 进行分析。 |
 | 2      |          NETWORK_ERROR          | 网络错误：无网络服务时会回调此错误，表示 SDK 与服务器的连接已断开。 | 群组/聊天室操作时，如果无网络，可能返回该错误，可以在网络恢复后，重复操作。 |
 | 3      |          DATABASE_ERROR         | 数据库操作失败：打开本地数据库失败。 | 需要根据调用的 API 结合日志分析，如果使用 `EMConversation#updateMessage` 方法更新一条本地不存在的消息，可能返回该错误；在数据库未打开时，调用其他本地数据库操作，也可能返回该错误。| 
-| 4      |      EXCEED_SERVICE_LIMIT       | 超过服务限制：超过当前服务版本的数量限制，例如，创建的用户 ID 数量超过购买服务的限制时提示该错误；设置和获取用户属性的接口，包括[设置当前用户的属性](userprofile.html#设置当前用户的属性)、[获取单个或多个用户的用户属性](userprofile.html#获取用户属性)和[获取指定用户的指定用户属性](userprofile.html#获取指定用户的指定用户属性)，超过调用频率限制时，会上报该错误。 | 检查调用的 API，若传入 `limit` 参数，可将该参数控制在限制内，如果是限流导致，可以在延后一段时间重新调用。 |
+| 4      |      EXCEED_SERVICE_LIMIT       | 超过服务限制：超过当前服务版本的数量限制，例如，创建的用户 ID 数量超过购买服务的限制时提示该错误；设置和获取用户属性的接口，包括 [设置当前用户的属性](userprofile.html#设置当前用户的所有属性)、[获取用户的所有属性](userprofile.html#获取用户的所有属性) 和 [获取用户的指定属性](userprofile.html#获取用户的指定属性)，超过调用频率限制时，会上报该错误。 | 检查调用的 API，若传入 `limit` 参数，可将该参数控制在限制内，如果是限流导致，可以在延后一段时间重新调用。 |
 | 8      |       APP_ACTIVE_NUMBER_REACH_LIMITATION    | 应用程序的日活跃用户数量（DAU）或月活跃用户数量（MAU）达到上限。  | 需在[环信控制台](https://console.easemob.com/user/login)对 IM 服务进行升级。 |
 | 100    |         INVALID_APP_KEY         | App Key 不合法：用户的 App Key 格式不正确。可在[环信控制台](https://console.easemob.com/user/login)的 **应用详情** 页面查看 App Key。  | 使用正确的 App Key 进行初始化。 |
 | 101    |        INVALID_USER_NAME        | 用户 ID 不正确：一般情况下，用户 ID 为空时提示该错误，例如，邀请好友时 username 参数为空字符。 | 检查报错的 API 中传入的用户 ID 参数是否为空。|

docs/document/android/releasenote.md

@@ -227,7 +227,7 @@
 
 ### 优化
 
-- [IM SDK] 设置和获取用户属性的接口，包括[设置当前用户的属性](userprofile.html#设置当前用户的属性)、[获取单个或多个用户的用户属性](userprofile.html#获取用户属性)和[获取指定用户的指定用户属性](userprofile.html#获取指定用户的指定用户属性)，超过调用频率限制时，会上报错误码 4 `EXCEED_SERVICE_LIMIT`。
+- [IM SDK] 设置和获取用户属性的接口，包括 [设置当前用户的所有属性](userprofile.html#设置当前用户的所有属性)、[设置当前用户的单个属性](userprofile.html#设置当前用户的单个属性)、[获取用户的用户属性](userprofile.html#获取用户的所有属性)和[获取用户的指定用户属性](userprofile.html#获取用户的指定属性)，超过调用频率限制时，会上报错误码 4 `EXCEED_SERVICE_LIMIT`。
 
 ### 修复
 

docs/document/android/userprofile.md

@@ -18,10 +18,10 @@
 
 环信即时通讯 IM Android SDK 提供一个 [EMUserInfoManager](https://sdkdocs.easemob.com/apidoc/android/chat3.0/classcom_1_1hyphenate_1_1chat_1_1_e_m_user_info_manager.html) 类，支持获取、设置及修改用户属性信息，其中包含如下方法：
 
-- `updateOwnInfo` 设置和修改当前用户自己的属性信息；
-- `updateOwnInfoByAttribute` 设置和修改用户信息中的某个属性；
-- `fetchUserInfoByUserId` 获取指定用户的所有用户属性信息；
-- `fetchUserInfoByAttribute` 获取指定环信用户 ID 和指定用户的用户属性。
+- `updateOwnInfo` 设置和修改当前用户自己的所有属性；
+- `updateOwnInfoByAttribute` 设置和修改用户的某个属性；
+- `fetchUserInfoByUserId` 获取单个或多个用户的所有用户属性；
+- `fetchUserInfoByAttribute` 获取单个用户的单个或多个用户属性。
 
 ## 前提条件
 
@@ -34,14 +34,13 @@
 
 本节介绍如何在项目中设置及获取用户属性。
 
-实现过程中注意单个用户的所有属性最大不超过 2 KB，单个 app 所有用户属性数据最大不超过 10 GB。
+单个用户的所有属性最大不超过 2 KB，单个 app 所有用户属性数据最大不超过 10 GB。
 
-### 设置当前用户的属性
+### 设置当前用户的所有属性
 
-参考如下示例代码，在你的项目中当前用户设置自己的所有属性或者仅设置某一项属性。
+当前用户设置自己的所有属性：
 
 ```java
-// 设置所有用户属性。
 EMUserInfo userInfo = new EMUserInfo();
 userInfo.setUserId(EMClient.getInstance().getCurrentUser());
 userInfo.setNickname("easemob");
@@ -60,20 +59,9 @@ EMClient.getInstance().userInfoManager().updateOwnInfo(userInfo, new EMValueCall
     public void onError(int error, String errorMsg) {
     }
 });
-// 以修改用户头像为例，演示如何修改指定用户属性。
-String url = "https://download-sdk.oss-cn-beijing.aliyuncs.com/downloads/IMDemo/avatar/Image1.png";
-EMClient.getInstance().userInfoManager().updateOwnInfoByAttribute(EMUserInfoType.AVATAR_URL, url, new EMValueCallBack<String>() {
-    @Override
-    public void onSuccess(String value) {
-    }
-
-    @Override
-    public void onError(int error, String errorMsg) {
-    }
-});
 ```
 
-关于用户属性，客户端针对用户的昵称、头像 URL、联系方式、邮箱、性别、签名、生日和扩展字段默认使用以下键名。[调用 RESTful 的接口设置](/document/server-side/userprofile.html#设置用户属性)或[删除用户属性](/document/server-side/userprofile.html#删除用户属性)，若要确保在客户端能够获取设置，请求中必须传以下键名与客户端保持一致，键值可根据实际使用场景确定。
+关于用户属性，客户端针对用户的昵称、头像 URL、联系方式、邮箱、性别、签名、生日和扩展字段默认使用以下键名。[调用 RESTful 的接口设置](/document/server-side/userprofile.html#设置用户属性)或 [删除用户属性](/document/server-side/userprofile.html#删除用户属性)，若要确保在客户端能够获取设置，请求中必须传以下键名与客户端保持一致，键值可根据实际使用场景确定。
 
 | 字段        | 类型   | 描述                                                                                              |
 | :---------- | :----- | :------------------------------------------------------------------------------------------------ |
@@ -86,23 +74,38 @@ EMClient.getInstance().userInfoManager().updateOwnInfoByAttribute(EMUserInfoType
 | `birth`     | String | 用户生日。长度在 64 字符内。                                                                      |
 | `ext`       | String | 扩展字段。                                                                                        |
 
-### 获取用户属性
+### 设置当前用户的单个属性
+
+例如，修改当前用户的头像：
+
+```java
+String url = "https://download-sdk.oss-cn-beijing.aliyuncs.com/downloads/IMDemo/avatar/Image1.png";
+EMClient.getInstance().userInfoManager().updateOwnInfoByAttribute(EMUserInfoType.AVATAR_URL, url, new EMValueCallBack<String>() {
+    @Override
+    public void onSuccess(String value) {
+    }
+
+    @Override
+    public void onError(int error, String errorMsg) {
+    }
+});
+```
 
-用户可以获取指定一个或多个用户的全部用户属性。
+### 获取用户的所有属性
 
-示例代码如下：
+用户可以获取指定一个或多个用户的所有用户属性。
 
 ```java
-// 获取一个或多个用户的所有属性，一次调用用户 ID 数量不超过 100。
+// 每次传入的用户 ID 数量不超过 100 个。
 String[] userId = new String[1];
 //username 指用户 ID。
 userId[0] = username;
 EMClient.getInstance().userInfoManager().fetchUserInfoByUserId(userId, new EMValueCallBack<Map<String, EMUserInfo>>() {});
 ```
 
-### 获取指定用户的指定用户属性
+### 获取用户的指定属性
 
-用户可以获取指定用户的指定用户属性信息。
+用户可以获取单个用户的单个或多个用户属性。
 
 ```java
 String[] userId = new String[1];
@@ -154,13 +157,13 @@ EMClient.getInstance().chatManager().sendMessage(message);
 
 Q：我设置了用户昵称（`nickname`），但调用客户端或 RESTful API 获取用户属性时，未返回用户昵称，原因是什么？
 
-A：你可以调用[客户端](#设置当前用户的属性) 或[RESTful API](/document/server-side/userprofile.html#设置用户属性) 设置用户昵称，例如 Android 为 `updateOwnInfo`，然后通过[客户端](#获取用户属性)或[RESTful API](/document/server-side/userprofile.html#获取用户属性) 获取用户属性，例如 Android 为 `fetchUserInfoByAttribute`。
+A：你可以调用 [客户端](#设置当前用户的所有属性) 或 [RESTful API](/document/server-side/userprofile.html#设置用户属性) 设置用户昵称，例如 Android 为 `updateOwnInfo`，然后通过 [客户端](#获取用户的指定属性) 或 [RESTful API](/document/server-side/userprofile.html#获取用户属性) 获取用户属性，例如 Android 为 `fetchUserInfoByAttribute`。
 
 设置用户昵称时，请注意以下两点：
 
 1. 调用 RESTful 接口设置用户昵称时，若要确保在客户端能够获取设置，请求中必须传 `nickname` 键名。
 
-2. 调用 RESTful API [获取用户详情](/document/server-side/account_system.html#获取用户详情)和[删除用户账户](/document/server-side/account_system.html#删除用户账号)中返回的响应中的 `nickname` 参数表示为推送昵称，即离线推送时在接收方的客户端推送通知栏中显示的发送方的昵称，与用户属性中的用户昵称不同。不过，我们建议这两种昵称的设置保持一致。因此，修改其中一个昵称时，也需调用相应方法对另一个进行更新，确保设置一致。例如，对于 Android，更推送昵称的方法为 [updatePushNickname](/document/android/push/push_display.html#设置推送通知的显示属性)，对于 RESTful API，详见 [离线推送通知的显示属性配置](/document/server-side/push.html#设置离线推送时显示的昵称)。
+2. 调用 RESTful API [获取用户详情](/document/server-side/account_system.html#获取用户详情)和 [删除用户账户](/document/server-side/account_system.html#删除用户账号) 中返回的响应中的 `nickname` 参数表示为推送昵称，即离线推送时在接收方的客户端推送通知栏中显示的发送方的昵称，与用户属性中的用户昵称不同。不过，我们建议这两种昵称的设置保持一致。因此，修改其中一个昵称时，也需调用相应方法对另一个进行更新，确保设置一致。例如，对于 Android，更推送昵称的方法为 [updatePushNickname](/document/android/push/push_display.html#设置推送通知的显示属性)，对于 RESTful API，详见 [离线推送通知的显示属性配置](/document/server-side/push.html#设置离线推送时显示的昵称)。
 
 Q: 调用设置或获取用户属性的接口时，上报错误码 4 的原因是什么？
 

docs/document/flutter/message_receive.md

@@ -53,6 +53,7 @@ class _ChatMessagesPageState extends State<ChatMessagesPage> {
 
 1. 接收附件消息。SDK 自动下载语音消息，默认自动下载图片和视频的缩略图。若下载原图、视频和文件，需调用 `downloadAttachment` 方法。
 2. 获取附件的服务器地址和本地路径。
+3. 自 4.15.0 版本开始，即时通讯 IM 支持消息附件下载鉴权功能。该功能默认关闭，如要开通需联系环信商务。该功能开通后，用户必须调用 SDK 的 `downloadAttachment` 方法下载消息附件。
 
 ### 接收语音消息
 

docs/document/harmonyos/userprofile.md

@@ -16,8 +16,8 @@
 
 环信即时通讯 IM HarmonyOS SDK 提供一个 `UserInfoManager` 类，支持获取、设置及修改用户属性信息，其中包含如下方法：
 
-- `updateUserInfo` 设置和修改当前用户自己的属性信息；
-- `fetchUserInfoById` 获取指定用户的属性信息。
+- `updateUserInfo` 设置当前用户的所有属性或单个属性
+- `fetchUserInfoById` 获取指定一个或多个用户的全部用户属性；获取单个用户的单个或多个用户属性。
 
 ## 前提条件
 
@@ -32,12 +32,11 @@
 
 实现过程中注意单个用户的所有属性最大不超过 2 KB，单个 app 所有用户属性数据最大不超过 10 GB。
 
-### 设置当前用户的属性
+### 设置当前用户的所有属性
 
-参考如下示例代码，在你的项目中当前用户设置自己的所有属性或者仅设置某一项属性。
+当前用户设置自己的所有属性：
 
 ```typescript
-// 设置所有用户属性。
 let userInfo: UserInfo = {
   nickname: "easemob",
   avatarUrl: "https://www.easemob.com",
@@ -53,17 +52,6 @@ ChatClient.getInstance().userInfoManager()?.updateUserInfo(userInfo).then(result
 }).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 的接口设置](/document/server-side/userprofile.html#设置用户属性)或[删除用户属性](/document/server-side/userprofile.html#删除用户属性)，若要确保在客户端能够获取设置，请求中必须传以下键名与客户端保持一致，键值可根据实际使用场景确定。
@@ -79,7 +67,24 @@ ChatClient.getInstance().userInfoManager()?.updateUserInfo(userInfo).then(result
 | `birth`     | String | 用户生日。长度在 64 字符内。     |
 | `ext`       | String | 扩展字段。   |
 
-### 获取用户属性
+### 设置当前用户的单个属性
+
+例如，修改当前用户的头像：
+
+```typescript
+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
+});
+```
+
+
+
+### 获取用户的所有属性
 
 用户可以从服务端获取指定一个或多个用户的全部用户属性。
 
@@ -96,9 +101,9 @@ ChatClient.getInstance().userInfoManager()?.fetchUserInfoById(userIds).then(resu
 });
 ```
 
-### 获取指定用户的指定用户属性
+###  获取用户的指定属性
 
-用户可以从服务端获取指定用户的指定用户属性信息。
+用户可以获取单个用户的单个或多个用户属性。
 
 ```typescript
 let userIds = new Array<string>();
@@ -128,7 +133,7 @@ ChatClient.getInstance().userInfoManager()?.fetchUserInfoById(userIds, userTypes
 
 Q：我设置了用户昵称（`nickname`），但调用客户端或 RESTful API 获取用户属性时，未返回用户昵称，原因是什么？
 
-A：你可以调用[客户端](#设置当前用户的属性) 或[RESTful API](/document/server-side/userprofile.html#设置用户属性) 设置用户昵称，例如，调用 `updateUserInfo`，然后通过[客户端](#获取用户属性)或[RESTful API](/document/server-side/userprofile.html#获取用户属性) 获取用户属性，例如 SDK 为 `fetchUserInfoById`。
+A：你可以调用 [客户端](#设置当前用户的所有属性) 或 [RESTful API](/document/server-side/userprofile.html#设置用户属性) 设置用户昵称，例如，调用 `updateUserInfo`，然后通过 [客户端](#获取用户的所有属性) 或 [RESTful API](/document/server-side/userprofile.html#获取用户属性) 获取用户属性，例如 SDK 为 `fetchUserInfoById`。
 
 设置用户昵称时，请注意以下：
 

docs/document/ios/error.md

@@ -16,7 +16,7 @@ iOS 的错误码只有当操作出错的时候才会有返回值，否则返回
 | 1      |           EMErrorGeneral            | SDK 或请求相关的默认错误，未区分具体错误类型：例如，SDK 内部未正确初始化，或者请求服务器时未识别出具体原因的错误。| 需要结合日志和调用的 API 进行分析。 |
 | 2      |      EMErrorNetworkUnavailable      | 网络错误：无网络服务时会回调此错误，表示 SDK 与服务器的连接已断开。 | 群组/聊天室操作时，如果无网络，可能返回该错误，可以在网络恢复后，重复操作。 |
 | 3      |   EMErrorDatabaseOperationFailed    | 数据库操作失败：打开本地数据库失败。    | 需要根据调用的 API 结合日志分析，如果使用 `EMConversation#updateMessage` 方法更新一条本地不存在的消息，可能返回该错误；在数据库未打开时，调用其他本地数据库操作，也可能返回该错误。 |
-| 4      |      EMErrorExceedServiceLimit      | 超过服务限制：超过当前服务版本的数量限制，例如，创建的用户 ID 数量超过购买服务的限制时提示该错误；设置和获取用户属性的接口，包括[设置当前用户的属性](userprofile.html#设置当前用户的属性)、[获取单个或多个用户的用户属性](userprofile.html#获取用户属性)和[获取指定用户的指定用户属性](userprofile.html#获取指定用户的指定用户属性)，超过调用频率限制时，会上报该错误。| 检查调用的 API，若传入 `limit` 参数，可将该参数控制在上限内，若是限流导致，可以在延后一段时间重新调用。 |
+| 4      |      EMErrorExceedServiceLimit      | 超过服务限制：超过当前服务版本的数量限制，例如，创建的用户 ID 数量超过购买服务的限制时提示该错误；设置和获取用户属性的接口，包括[设置当前用户的属性](userprofile.html#设置当前用户的所有属性)、[获取单个或多个用户的用户属性](userprofile.html#获取用户的所有属性)和[获取指定用户的指定用户属性](userprofile.html#获取用户的指定属性)，超过调用频率限制时，会上报该错误。| 检查调用的 API，若传入 `limit` 参数，可将该参数控制在上限内，若是限流导致，可以在延后一段时间重新调用。 |
 | 8      |      EMAppActiveNumbersReachLimitation       | 应用程序的日活跃用户数量（DAU）或月活跃用户数量（MAU）达到上限。  | 需在[环信控制台](https://console.easemob.com/user/login)对 IM 服务进行升级。 |
 | 100    |        EMErrorInvalidAppkey         | App Key 不合法：用户的 App Key 格式不正确。可在[环信控制台](https://console.easemob.com/user/login)的 **应用详情** 页面查看 App Key。   | 使用正确的 App Key 进行初始化。 |
 | 101    |       EMErrorInvalidUsername        | 用户 ID 不正确：一般情况下，用户 ID 为空时提示该错误，例如，邀请好友时 username 参数为空字符。 | 检查报错API 中传入的用户 ID 参数是否为空。 |