Merge pull request #979 from haoxiuwen/doc-v2

Add Web/Applet 4.10.0 Release Note
easemob · Oct 11, 2024 · c62caed · c62caed
2 parents c5154b0 + ea1905d
commit c62caed
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 2 deletions.
diff --git a/docs/document/applet/releasenote.md b/docs/document/applet/releasenote.md
@@ -2,6 +2,20 @@
 
 <Toc />
 
+## 版本 V4.10.0 2024-10-11（开发版）
+
+### 新增特性
+
+- 聊天室公告修改事件中增加公告内容：`updateAnnouncement` 事件中增加 `announcement` 字段，表示更新的公告。
+- 新增两个错误码：
+  - `WEBIM_USER_ALREADY_LOGIN` 208：用户已登录。单设备登录时，若调用 open 方法用户已经登录，会触发该错误。
+  - `MESSAGE_SEND_TIMEOUT` 512：发送消息超时
+- 新增 `onShow` 方法，小程序或 uniapp 在 `onShow` 生命周期中执行该方法，可优化重连速度。
+
+### 优化
+
+调整了登录方法的 `open().then` 与连接成功事件 `onConnected` 的触发时机。优化后，调用登录方法 `open` 后，先触发连接成功与否的事件 `onConnected` 或 `onDisconnected`，然后再触发登录 `open().then` 或者 `open().catch`，以确保连接完全建立后再进行后续处理。之前版本为调用登录方法，先触发登录回调，然后触发连接事件，导致需要等待连接成功事件 `onConnected` 触发后才能发送消息。同时，优化后，鉴权失败等登录错误会在 `open.catch` 中抛出。
+
 ## 版本 V4.9.2 2024-09-20（开发版）
 
 ### 新增特性

diff --git a/docs/document/ios/message_send_receive.md b/docs/document/ios/message_send_receive.md
@@ -20,10 +20,9 @@
 
 ## 技术原理
 
-环信即时通讯 IM iOS SDK 提供 `ChatManager` 类和 `EMChatMessage` 类，支持发送、接收消息，发送、接收消息已读回执，并管理用户设备上存储的消息会话数据，其中包含如下主要方法：
+环信即时通讯 IM iOS SDK 提供 `ChatManager` 类和 `EMChatMessage` 类，支持发送和接收消息，其中包含如下主要方法：
 
 - `sendMessage` 发送消息给某个用户，群组或者聊天室；
-- `recallMessage` 撤回自己发出的消息；
 - `addMessageListener` 添加消息接收的回调通知；
 - `ackConversationRead` 发送会话已读通知；
 - `ackMessageRead` 发送指定消息已读的通知；

diff --git a/docs/document/web/error.md b/docs/document/web/error.md
@@ -37,6 +37,7 @@ error.type === statusCode.WEBIM_CONNCTION_USER_NOT_ASSIGN_ERROR 其中 `error`
 | 205    | MESSAGE_PARAMETER_ERROR                     | 消息参数错误。如撤回消息时未传消息 ID 或者发送消息时未传消息接收方的用户 ID。|
 | 206    | WEBIM_CONNCTION_USER_LOGIN_ANOTHER_DEVICE      | 用户在其他设备登录：如果没有开启多设备登录，则在其他设备登录会将当前登录的设备踢下线，用户会收到此错误。 |
 | 207    | WEBIM_CONNCTION_USER_REMOVED                   | 用户已经被注销：如果登录用户的 ID 被管理员从管理后台删除则会收到此错误。 |
+| 208    | WEBIM_USER_ALREADY_LOGIN                   | 用户已登录。单设备登录时，若调用 open 方法用户已经登录，会提示该错误。 |
 | 216    | WEBIM_CONNCTION_USER_KICKED_BY_CHANGE_PASSWORD | 用户密码更新：当前登录的用户密码被修改后，当前登录会断开并提示该错误。 |
 | 217    | WEBIM_CONNCTION_USER_KICKED_BY_OTHER_DEVICE    | 用户被踢下线：开启多设备登录后，如果用户在其他设备上调用 API 或者通过管理后台踢出当前设备登录的 ID，SDK 会提示该错误。 |
 | 219    | USER_MUTED_BY_ADMIN                            | 用户被全局禁言：在管理后台禁言了此用户后，该用户发送消息时会提示该错误。                     |
@@ -53,6 +54,7 @@ error.type === statusCode.WEBIM_CONNCTION_USER_NOT_ASSIGN_ERROR 其中 `error`
 | 509    | MESSAGE_CURRENT_LIMITING                       | 单个用户 ID 发送消息超出频率限制。默认情况下，SDK 对单个用户 ID 发送群消息未做频率限制。如果你联系了环信商务设置了该限制，一旦在在单聊、群聊或聊天室中单个用户的消息发送频率超过设定的上限，则会提示该错误。 |
 | 510    | MESSAGE_WEBSOCKET_DISCONNECTED                 | 消息发送失败，例如网络断开、重连失败等情况下导致发送失败。  |
 | 511    | MESSAGE_SIZE_LIMIT                 | 消息体大小超过限制。关于各端消息体大小的限制，详见[消息管理概述中的描述](message_overview.html#消息类型)。|
+| 512    | MESSAGE_SEND_TIMEOUT                 | 发送消息超时。例如，发消息时连接断开，会提示该错误。|
 | 601    | GROUP_ALREADY_JOINED                           | 已在群组内：当前用户已在该群组中。                           |
 | 602    | GROUP_NOT_JOINED                               | 不在群组内：用户发送群消息或进行群操作时未加入该群组。                   |
 | 603    | PERMISSION_DENIED                              | 用户无权限：例如，如果用户被添加到黑名单后，发送消息时会提示该错误。其他报错情况包括用户修改其他用户发出的消息、修改其他用户设置的群成员属性以及普通群成员试图解散子区（仅子区所在群组的群主和群管理员有权解散子区）。 |

diff --git a/docs/document/web/releasenote.md b/docs/document/web/releasenote.md
@@ -2,6 +2,19 @@
 
 <Toc />
 
+## 版本 V4.10.0 2024-10-11（开发版）
+
+### 新增特性
+
+- 聊天室公告修改事件中增加公告内容：`updateAnnouncement` 事件中增加 `announcement` 字段，表示更新的公告。
+- 新增两个错误码：
+  - `WEBIM_USER_ALREADY_LOGIN` 208：用户已登录。单设备登录时，若调用 open 方法用户已经登录，会提示该错误。
+  - `MESSAGE_SEND_TIMEOUT` 512：发送消息超时。例如，发消息时连接断开，会提示该错误。
+
+### 优化
+
+调整了登录方法的 `open().then` 与连接成功事件 `onConnected` 的触发时机。优化后，调用登录方法 `open` 后，先触发连接成功与否的事件 `onConnected` 或 `onDisconnected`，然后再触发登录 `open().then` 或者 `open().catch`，以确保连接完全建立后再进行后续处理。之前版本为调用登录方法，先触发登录回调，然后触发连接事件，导致需要等待连接成功事件 `onConnected` 触发后才能发送消息。同时，优化后，鉴权失败等登录错误会在 `open.catch` 中抛出。
+
 ## 版本 V4.9.2 2024-09-20（开发版）
 
 ### 新增特性