Merge pull request #549 from haoxiuwen/doc-v2

Modify Android/iOS Release Notes 4.3.0 & Web/Applet 4.4.0
easemob · Dec 25, 2023 · dc91d04 · dc91d04
2 parents 791c708 + cbcad14
commit dc91d04
Show file tree

Hide file tree

Showing 17 changed files with 45 additions and 59 deletions.
diff --git a/docs/document/android/conversation_mark.md b/docs/document/android/conversation_mark.md
@@ -4,7 +4,7 @@
 
 某些情况下，你可能需要对会话添加标记，例如会话标星或将会话标为已读或未读。即时通讯云 IM 支持对单聊和群聊会话添加标记，最大支持 20 个标记，所以一个会话最多可添加 20 个标记。
 
-如果要使用会话标记功能，你需要确保开通了[会话列表服务](conversation_list.html#从服务器分页获取会话列表)并将 SDK 版本升级至 4.3.0 或以上版本。
+**如果要使用会话标记功能，你需要确保开通了[会话列表服务](conversation_list.html#从服务器分页获取会话列表)并将 SDK 版本升级至 4.3.0 或以上版本。**
 
 你需要自行维护会话标记与具体业务含义（比如 `MARK_0` 为重要会话）之间的映射关系。例如：
 

diff --git a/docs/document/android/conversation_pin.md b/docs/document/android/conversation_pin.md
@@ -4,6 +4,8 @@
 
 会话置顶指将单聊或群聊会话固定在会话列表的顶部，方便用户查找。例如，将重点会话置顶，可快速定位会话。
 
+**若使用会话置顶功能，需将 SDK 升级至 4.0.3，并[开通服务端会话列表功能](conversation_list#从服务器分页获取会话列表)。**
+
 ## 前提条件
 
 开始前，请确保满足以下条件：
@@ -27,10 +29,6 @@
 
 你最多可以置顶 50 个会话。
 
-:::tip
-若使用该功能，需将 SDK 升级至 4.0.3。
-:::
-
 示例代码如下： 
 
 ```java
@@ -55,10 +53,6 @@ EMClient.getInstance().chatManager().asyncPinConversation(conversationId, isPinn
 
 你最多可以拉取 50 个置顶会话。
 
-:::tip
-若使用该功能，需将 SDK 升级至 4.0.3。
-:::
-
 示例代码如下： 
 
 ```java

diff --git a/docs/document/android/releasenote.md b/docs/document/android/releasenote.md
@@ -6,18 +6,18 @@
 
 ### 新增特性
 
-- [IM SDK] 附件消息支持分片上传。
-- [IM SDK] 支持[会话标记功能](conversation_mark.html)。
-  - `EMChatManager#asyncAddConversationMark`：[标记会话](conversation_mark.html#标记会话)。
-  - `EMChatManager#asyncRemoveConversationMark`：[取消标记会话](conversation_mark.html#取消标记会话)。
-  - `EMChatManager#asyncGetConversationsFromServerWithCursor`：[根据会话标记从服务器分页查询会话列表](conversation_mark.html#根据会话标记从服务器分页查询会话列表)。
-  - `EMConversation#marks`：[获取本地单个会话的所有标记](conversation_mark.html#获取本地单个会话的所有标记)。
-  - `onChatThreadEvent#CONVERSATION_MARK_UPDATE`：[多设备场景下的会话标记事件](multi_device.html#获取其他设备上的操作)。当前用户在一台登录设备上更新了会话标记，包括添加和移除会话标记，其他登录设备会收到该事件。
+[IM SDK] 支持[会话标记功能](conversation_mark.html)。
+- `EMChatManager#asyncAddConversationMark`：[标记会话](conversation_mark.html#标记会话)。
+- `EMChatManager#asyncRemoveConversationMark`：[取消标记会话](conversation_mark.html#取消标记会话)。
+- `EMChatManager#asyncGetConversationsFromServerWithCursor`：[根据会话标记从服务器分页查询会话列表](conversation_mark.html#根据会话标记从服务器分页查询会话列表)。
+- `EMConversation#marks`：[获取本地单个会话的所有标记](conversation_mark.html#获取本地单个会话的所有标记)。
+- `onChatThreadEvent#CONVERSATION_MARK_UPDATE`：[多设备场景下的会话标记事件](multi_device.html#获取其他设备上的操作)。当前用户在一台登录设备上更新了会话标记，包括添加和移除会话标记，其他登录设备会收到该事件。
 
 ### 优化
 
 - [IM SDK] 移除 FPA 功能，重新编译 boringssl、cipherdb、libevent 库，减小 SDK 体积。
 - [IM SDK] 单个日志文件大小由 2 MB 提升到 5 MB。
+- [IM SDK] 优化附件类型消息发送时中的附件上传，支持分片上传。
 
 ## 版本 V4.2.1 Dev 2023-11-17（开发版）
 

diff --git a/docs/document/applet/message_send_receive.md b/docs/document/applet/message_send_receive.md
@@ -202,7 +202,7 @@ WebIM.conn.addEventHandler('MESSAGES',{
 
 1. 创建和发送附件类型消息。SDK 将附件上传到环信服务器，获取消息的基本信息以及服务器上附件文件的路径。
 
-   对于图片消息来说，服务器会自动生成图片的缩略图；而对于视频消息来说，服务器不会自动生成视频缩略图。
+   对于图片消息来说，服务器会自动生成图片的缩略图；而对于视频消息来说，视频的首帧为缩略图。
 
 2. 接收附件消息。
 

diff --git a/docs/document/flutter/conversation_pin.md b/docs/document/flutter/conversation_pin.md
@@ -4,6 +4,8 @@
 
 会话置顶指将单聊或群聊会话固定在会话列表的顶部，方便用户查找。例如，将重点会话置顶，可快速定位会话。
 
+**若使用会话置顶功能，需将 SDK 升级至 4.0.3，并[开通服务端会话列表功能](conversation_list#从服务器分页获取会话列表)。**
+
 ## 前提条件
 
 开始前，请确保满足以下条件：
@@ -50,10 +52,6 @@ try {
 
 你最多可以拉取 50 个置顶会话。
 
-:::notice
-若使用该功能，需将 SDK 升级至 4.0.3。
-:::
-
 示例代码如下： 
 
 ```dart

diff --git a/docs/document/ios/conversation_mark.md b/docs/document/ios/conversation_mark.md
@@ -4,7 +4,7 @@
 
 某些情况下，你可能需要对会话添加标记，例如会话标星或将会话标为已读或未读。即时通讯云 IM 支持对单聊和群聊会话添加标记，最大支持 20 个标记，所以一个会话最多可添加 20 个标记。
 
-如果要使用会话标记功能，你需要确保开通了[会话列表服务](conversation_list.html#从服务器分页获取会话列表)并将 SDK 版本升级至 4.3.0 或以上版本。
+**如果要使用会话标记功能，你需要确保开通了[会话列表服务](conversation_list.html#从服务器分页获取会话列表)并将 SDK 版本升级至 4.3.0 或以上版本。**
 
 你需要自行维护会话标记与具体业务含义（比如 `EMMarkType0` 为重要会话）之间的映射关系。例如：
 

diff --git a/docs/document/ios/releasenote.md b/docs/document/ios/releasenote.md
@@ -6,18 +6,18 @@
 
 ### 新增特性
 
-- [IM SDK] 附件消息支持分片上传。
-- [IM SDK] 支持[会话标记功能](conversation_mark.html)。
-  - `EMChatManager#addConversationMark:completion`：[标记会话](conversation_mark.html#标记会话)。
-  - `EMChatManager#removeConversationMark:completion`：[取消标记会话](conversation_mark.html#取消标记会话)。
-  - `EMChatManager#getConversationsFromServerWithCursor:filter:completion`：[根据会话标记从服务器分页查询会话列表](conversation_mark.html#根据会话标记从服务器分页查询会话列表)。
-  - `EMConversation#marks`：[获取本地单个会话的所有标记](conversation_mark.html#获取本地单个会话的所有标记)。
-  - `multiDevicesConversationEvent#EMMultiDevicesEventConversationUpdateMark`：[多设备场景下的会话标记事件](multi_device.html#获取其他设备上的操作)。当前用户在一台登录设备上更新了会话标记，包括添加和移除会话标记，其他登录设备会收到该事件。
+[IM SDK] 支持[会话标记功能](conversation_mark.html)。
+- `EMChatManager#addConversationMark:completion`：[标记会话](conversation_mark.html#标记会话)。
+- `EMChatManager#removeConversationMark:completion`：[取消标记会话](conversation_mark.html#取消标记会话)。
+- `EMChatManager#getConversationsFromServerWithCursor:filter:completion`：[根据会话标记从服务器分页查询会话列表](conversation_mark.html#根据会话标记从服务器分页查询会话列表)。
+- `EMConversation#marks`：[获取本地单个会话的所有标记](conversation_mark.html#获取本地单个会话的所有标记)。
+- `multiDevicesConversationEvent#EMMultiDevicesEventConversationUpdateMark`：[多设备场景下的会话标记事件](multi_device.html#获取其他设备上的操作)。当前用户在一台登录设备上更新了会话标记，包括添加和移除会话标记，其他登录设备会收到该事件。
 
 ### 优化
 
 - [IM SDK] 移除 FPA 功能，减小 SDK 体积。
 - [IM SDK] 单个日志文件大小由 2 MB 提升到 5 MB。
+- [IM SDK] 优化附件类型消息发送时中的附件上传，支持分片上传。
 
 ## 版本 V4.2.0 Dev 2023-11-13（开发版）
 

diff --git a/docs/document/react-native/conversation_pin.md b/docs/document/react-native/conversation_pin.md
@@ -4,6 +4,8 @@
 
 会话置顶指将单聊或群聊会话固定在会话列表的顶部，方便用户查找。例如，将重点会话置顶，可快速定位会话。
 
+**若使用会话置顶功能，需将 SDK 升级至 1.2.0，并[开通服务端会话列表功能](conversation_list#从服务器分页获取会话列表)。**
+
 ## 前提条件
 
 开始前，请确保满足以下条件：
@@ -27,10 +29,6 @@
 
 你最多可以置顶 50 个会话。
 
-:::tip
-若使用该功能，需将 SDK 升级至 1.2.0。
-:::
-
 示例代码如下： 
 
 ```typescript
@@ -53,10 +51,6 @@ ChatClient.getInstance()
 
 你最多可以拉取 50 个置顶会话。
 
-:::notice
-若使用该功能，需将 SDK 升级至 1.2.0。
-:::
-
 示例代码如下： 
 
 ```typescript

diff --git a/docs/document/unity/conversation_overview.md b/docs/document/unity/conversation_overview.md
@@ -45,7 +45,12 @@
 
 ```csharp
 public class ChatManagerDelegate : IChatManagerDelegate {
-        // 收到会话已读回调
+        // 收到会话已读的事件。该事件在以下场景中触发：
+       // 1. 当消息接收方调用 `SendConversationReadAck 方法，SDK 会执行此回调，
+       // 会将本地数据库中该会话中消息的 `isAcked` 属性置为 `true`。
+       // 2. 多端多设备登录时，若一端发送会话已读回执（conversation ack），
+       // 服务器端会将会话的未读消息数置为 0，
+       // 同时其他端会回调此方法，并将本地数据库中该会话中消息的 `isRead` 属性置为 `true`。
         public void OnConversationRead(string from, string to)
         {
 

diff --git a/docs/document/unity/conversation_pin.md b/docs/document/unity/conversation_pin.md
@@ -4,6 +4,8 @@
 
 会话置顶指将单聊或群聊会话固定在会话列表的顶部，方便用户查找。例如，将重点会话置顶，可快速定位会话。
 
+**若使用会话置顶功能，需将 SDK 升级至 1.2.0，并[开通服务端会话列表功能](conversation_list#从服务器分页获取会话列表)。**
+
 ## 前提条件
 
 开始前，请确保满足以下条件：
@@ -27,10 +29,6 @@
 
 你最多可以置顶 50 个会话。
 
-:::tip
-若使用该功能，需将 SDK 升级至  1.2.0。
-:::
-
 示例代码如下： 
 
 ```csharp

diff --git a/docs/document/web/conversation_mark.md b/docs/document/web/conversation_mark.md
@@ -4,7 +4,7 @@
 
 某些情况下，你可能需要对会话添加标记，例如会话标星或将会话标为已读或未读。即时通讯云 IM 支持对单聊和群聊会话添加标记，最大支持 20 个标记，所以一个会话最多可添加 20 个标记。
 
-如果要使用会话标记功能，你需要确保开通了[会话列表服务](conversation_list.html#从服务器分页获取会话列表)并将 SDK 版本升级至 4.4.0 或以上版本。  
+**如果要使用会话标记功能，你需要确保开通了[会话列表服务](conversation_list.html#从服务器分页获取会话列表)并将 SDK 版本升级至 4.4.0 或以上版本。**  
 
 你需要自行维护会话标记与具体业务含义之间的映射，例如 [`MarkType.mark_0`](https://docs-im-beta.easemob.com/jsdoc/enums/Types.ContactType.MarkType.html)表示待处理会话。
 

diff --git a/docs/document/web/conversation_pin.md b/docs/document/web/conversation_pin.md
@@ -4,6 +4,8 @@
 
 会话置顶指将单聊或群聊会话固定在会话列表的顶部，方便用户查找。例如，将重点会话置顶，可快速定位会话。
 
+**若使用会话置顶功能，需将 SDK 升级至 4.1.7，并[开通服务端会话列表功能](conversation_list#从服务器分页获取会话列表)。**
+
 ## 前提条件
 
 开始前，请确保满足以下条件：
@@ -27,10 +29,6 @@
 
 你最多可以置顶 50 个会话。
 
-:::tip
-若使用该功能，需将 SDK 升级至 4.1.7 或以上版本。
-:::
-
 示例代码如下： 
 
 ```javascript
@@ -43,10 +41,6 @@ connection.pinConversation({conversationId:'conversationId', conversationType: '
 
 你最多可以拉取 50 个置顶会话。
 
-:::notice
-若使用该功能，需将 SDK 升级至 4.1.7 或以上版本。
-:::
-
 示例代码如下，返回数据类型参见[从服务器分页获取会话列表](conversation_list#从服务器分页获取会话列表)。
 
 ```javascript

diff --git a/docs/document/web/message_send_receive.md b/docs/document/web/message_send_receive.md
@@ -206,7 +206,7 @@ conn.addEventHandler('MESSAGES',{
 
 1. 创建和发送附件类型消息。SDK 将附件上传到环信服务器，获取消息的基本信息以及服务器上附件文件的路径。
 
-  对于图片消息来说，环信服务器会自动生成图片缩略图；而对于视频消息来说，服务器不会生成视频缩略图。
+  对于图片消息来说，环信服务器会自动生成图片缩略图；而对于视频消息来说，视频的首帧为缩略图。
 
 2. 接收附件消息。
 

diff --git a/docs/document/web/releasenote.md b/docs/document/web/releasenote.md
@@ -6,7 +6,6 @@
 
 ### 新增特性
 
-- [IM SDK] 附件消息支持分片上传。
 - [IM SDK] 新增[会话标记功能](conversation_mark.html)。
   - `addConversationMark`：[标记会话](conversation_mark.html#标记会话)。
   - `removeConversationMark`：[取消标记会话](conversation_mark.html#取消标记会话)。
@@ -19,6 +18,7 @@
 
 - [IM SDK] SDK 类型修正。
 - [IM SDK] vite 引入 MiniCore SDK 报错。
+- [IM SDK] 优化附件类型消息发送时的附件上传，支持分片上传。
 
 ## 版本 V4.3.1 Dev 2023-12-13（开发版）
 

diff --git a/docs/document/windows/conversation_overview.md b/docs/document/windows/conversation_overview.md
@@ -45,7 +45,12 @@
 
 ```csharp
 public class ChatManagerDelegate : IChatManagerDelegate {
-        // 收到会话已读回调
+        // 收到会话已读的事件。该事件在以下场景中触发：
+       // 1. 当消息接收方调用 `SendConversationReadAck` 方法，SDK 会执行此回调，
+       // 会将本地数据库中该会话中消息的 `isAcked` 属性置为 `true`。
+       // 2. 多端多设备登录时，若一端发送会话已读回执（conversation ack），
+       // 服务器端会将会话的未读消息数置为 0，
+       // 同时其他端会回调此方法，并将本地数据库中该会话中消息的 `isRead` 属性置为 `true`。
         public void OnConversationRead(string from, string to)
         {
 

diff --git a/docs/document/windows/conversation_pin.md b/docs/document/windows/conversation_pin.md
@@ -4,6 +4,8 @@
 
 会话置顶指将单聊或群聊会话固定在会话列表的顶部，方便用户查找。例如，将重点会话置顶，可快速定位会话。
 
+**若使用会话置顶功能，需将 SDK 升级至 1.2.0，并[开通服务端会话列表功能](conversation_list#从服务器分页获取会话列表)。**
+
 ## 前提条件
 
 开始前，请确保满足以下条件：
@@ -27,10 +29,6 @@
 
 你最多可以置顶 50 个会话。
 
-:::tip
-若使用该功能，需将 SDK 升级至  1.2.0。
-:::
-
 示例代码如下： 
 
 ```csharp

diff --git a/docs/product/product_dynamics.md b/docs/product/product_dynamics.md
@@ -4,7 +4,7 @@
 
 | 动态名称   | 动态描述 | 发布时间       | 相关文档          |
 | :----- | :------- | :---------------- | :---------------- |
-| SDK 4.3.0 开发版发布 | **新增特性**：<br/> - [会话标记功能](/document/android/conversation_mark.html)：支持标记会话，并按照标记获取会话。<br/> - 附件消息支持分片上传。 <br/> **优化**<br/> - 移动端移除 FPA 功能，减小 SDK 体积。<br/> - 移动端单个日志文件大小由 2 MB 提升到 5 MB。<br/> - Web 端增加 `onMessage` 回调。在收到文本、图片、视频、语音、地理位置和文件等消息时，批量将消息回调给应用。<br/> - Web 端视频类型消息增加视频首帧缩略图, 通过 videoMessage.thumb 访问。    |  2023-12-22     | <br/> - [Android 4.3.0 更新日志](/document/android/releasenote.html)<br/> - [iOS 4.3.0 更新日志](/document/ios/releasenote.html)<br/> - [Web 4.4.0 更新日志](/document/web/releasenote.html)<br/> - [小程序 4.4.0 更新日志](/document/applet/releasenote.html)。   |
+| SDK 4.3.0 开发版发布 | **新增特性**：<br/> - [会话标记功能](/document/android/conversation_mark.html)：支持标记会话，并按照标记获取会话。<br/> **优化**<br/> - 对于原生平台，优化附件类型消息发送时的附件上传，支持分片上传。 <br/> - 移动端移除 FPA 功能，减小 SDK 体积。<br/> - 移动端单个日志文件大小由 2 MB 提升到 5 MB。<br/> - Web 端增加 `onMessage` 回调。在收到文本、图片、视频、语音、地理位置和文件等消息时，批量将消息回调给应用。<br/> - Web 端视频类型消息增加视频首帧缩略图, 通过 videoMessage.thumb 访问。    |  2023-12-22     | <br/> - [Android 4.3.0 更新日志](/document/android/releasenote.html)<br/> - [iOS 4.3.0 更新日志](/document/ios/releasenote.html)<br/> - [Web 4.4.0 更新日志](/document/web/releasenote.html)<br/> - [小程序 4.4.0 更新日志](/document/applet/releasenote.html)。   |
 
 
 ## 2023-11