Merge pull request #1069 from haoxiuwen/doc-v2

Add Android/iOS/Web SDK 4.11.0 Release Notes
easemob · Dec 4, 2024 · 7b15560 · 7b15560
2 parents fe5eaad + b5528e0
commit 7b15560
Show file tree

Hide file tree

Showing 27 changed files with 168 additions and 46 deletions.
diff --git a/docs/document/android/message_retrieve.md b/docs/document/android/message_retrieve.md
@@ -45,9 +45,9 @@
 
 :::tip
 1. 若使用该 API，需将 SDK 版本升级至 V4.0.2 版本或以上。
-2. **默认可获取单聊和群组聊天的历史消息。若要获取聊天室的历史消息，需联系环信商务。**
-3. 历史消息和离线消息在服务器上的存储时间与你订阅的套餐包有关，详见[产品价格](/product/pricing.html#套餐包功能详情)。
-4. 各类事件通知发送时，若接收的用户离线，事件通知的存储时间与离线消息的存储时间一致，即也取决于你订阅的套餐包。
+2. **默认可获取单聊和群组聊天的历史消息。若要获取聊天室的历史消息，需升级至 4.5.0 版本，并联系环信商务。**
+3. 对于单聊消息，自 4.11.0 版本开始，从服务器拉取历史消息时会读取服务端的消息已读和送达状态。该功能默认关闭，如果需要，请联系环信商务开通。 
+4. 历史消息在服务器上的存储时间与产品的套餐包相关，详见[产品套餐包详情](/product/pricing.html#套餐包功能详情)。
 :::
 
 ```java

diff --git a/docs/document/android/releasenote.md b/docs/document/android/releasenote.md
@@ -2,6 +2,20 @@
 
 <Toc />
 
+## 版本 V4.11.0 Dev 2024-12-3（开发版）
+
+### 新增特性
+
+- [IM SDK] 新增[拉取服务器漫游消息](message_retrieve.html#从服务器获取指定会话的消息)时会读取服务端的消息已读和送达状态。该功能只适用于单聊消息，默认关闭，如果需要，请联系环信商务开通。 
+- [IM SDK] 聊天室成员禁言回调：
+  - 新增聊天室禁言回调 `EMChatRoomChangeListener#onMuteListAdded(java.lang.String, java.util.Map<java.lang.String,java.lang.Long>)`，在回调中使用 `Map<String,Long> muteInfo` 参数表示被禁言的用户 ID 和禁言到期时间戳。
+  - 废弃原来的回调 `EMChatRoomChangeListener#onMuteListAdded(java.lang.String, java.util.List<java.lang.String>, long)`。
+- [IM SDK] 新增 Native Crash 上报能力：当 SDK native 层代码发生 Crash 时，会在下次启动后上报 Crash 信息。
+
+### 修复
+
+- [IM SDK] 修复极端情况下因网络异常导致的 Crash。
+
 ## 版本 V4.10.3 Dev 2024-11-25（开发版）
 
 ### 修复

diff --git a/docs/document/android/room_manage.md b/docs/document/android/room_manage.md
@@ -165,7 +165,7 @@ public interface EMChatRoomChangeListener {
     void onRemovedFromChatRoom(final int reason, final String roomId, final String roomName, final String participant);
 
     // 有成员被加入禁言列表。被添加的成员收到该事件。
-    void onMuteListAdded(final String chatRoomId, final List<String> mutes, final long expireTime);
+    void onMuteListAdded(final String chatRoomId, Map<String,Long> muteInfo);
 
     // 有成员被移出禁言列表。被解除禁言的成员会收到该事件。
     void onMuteListRemoved(final String chatRoomId, final List<String> mutes);

diff --git a/docs/document/android/room_members.md b/docs/document/android/room_members.md
@@ -210,7 +210,7 @@ EMClient.getInstance().chatroomManager().removeFromChatRoomWhiteList(chatRoomId,
 
 #### 添加成员至聊天室禁言列表
 
-仅聊天室所有者和管理员可以调用 `EMChatRoomManager#muteChatRoomMembers` 方法将指定成员添加至聊天室禁言列表，操作者外其他成员收到 `EMChatRoomChangeListener#onMuteListAdded` 回调。
+仅聊天室所有者和管理员可以调用 `EMChatRoomManager#muteChatRoomMembers` 方法将指定成员添加至聊天室禁言列表。被禁言的成员和其他未操作的聊天室管理员或聊天室所有者收到 `EMChatRoomChangeListener#onMuteListAdded` 回调。
 
 :::notice
 聊天室所有者可禁言聊天室所有成员，聊天室管理员可禁言聊天室普通成员。
@@ -227,7 +227,7 @@ EMChatRoom chatRoom = EMClient.getInstance().chatroomManager().muteChatRoomMembe
 
 #### 将成员移出聊天室禁言列表
 
-仅聊天室所有者和管理员可以调用 `EMChatRoomManager#unMuteChatRoomMembers` 方法将成员移出聊天室禁言列表。被解除禁言后，其他成员收到 `EMChatRoomChangeListener#onMuteListRemoved` 回调。
+仅聊天室所有者和管理员可以调用 `EMChatRoomManager#unMuteChatRoomMembers` 方法将成员移出聊天室禁言列表。被解除禁言的成员和其他未操作的聊天室管理员或聊天室所有者收到 `EMChatRoomChangeListener#onMuteListRemoved` 回调。
 
 :::notice
 聊天室所有者可对聊天室所有成员解除禁言，聊天室管理员可对聊天室普通成员解除禁言。

diff --git a/docs/document/applet/releasenote.md b/docs/document/applet/releasenote.md
@@ -2,6 +2,23 @@
 
 <Toc />
 
+## 版本 V4.11.0 Dev 2024-12-3（开发版）
+
+### 新增特性
+
+- [IM SDK] 新增[拉取服务器漫游消息](message_retrieve.html#从服务器获取指定会话的消息)时会读取服务端的消息已读和送达状态。该功能只适用于单聊消息，默认关闭，如果需要，请联系环信商务开通。
+- [IM SDK] 聊天室禁言回调 `muteMember` 新增 `muteTimestamp` 参数，表示禁言过期时间。
+- [IM SDK] 群组/聊天室禁言事件 `muteMember` 新增 `userId` 字段，表示被禁言的成员。
+- [IM SDK] uniapp SDK 支持鸿蒙系统。
+
+### 优化
+
+[IM SDK] SDK 的 message 对象中新增 `parseDownloadResponse`、`download` 方法。目前，SDK 的 utils 对象和 message 对象中均包含 `parseDownloadResponse`、`download` 方法。
+
+### 修复
+
+[IM SDK] 修复消息置顶事件 `onMessagePinEvent` 中的 `conversationId` 参数值错误的问题。
+
 ## 版本 V4.10.0 2024-10-11（开发版）
 
 ### 新增特性

diff --git a/docs/document/applet/uniapp.md b/docs/document/applet/uniapp.md
@@ -5,7 +5,8 @@
 环信小程序 SDK 为各端小程序开发提供一套完整的技术解决方案，在各端小程序的开发环境下，集成 IM 相关的功能更加便捷、高效。让您的小程序快速获得安全稳定的 IM 能力，集成简单，使用方便，帮助您快速拓展业务，赢得先机。
 
 :::tip
-SDK 目前支持微信、支付宝、QQ、百度小程序、抖音（请使用低于 1.70.0 以下的版本基础库）、uni-app 编译的 原生 Android 以及 iOS。
+- uniapp SDK 目前支持微信、支付宝、QQ、百度小程序、抖音（请使用低于 1.70.0 以下的版本基础库）、uni-app 编译的 原生 Android 以及 iOS。
+- uniapp SDK 4.11.0 及以上版本支持鸿蒙系统。
 :::
 
 ## 体验小程序

diff --git a/docs/document/flutter/message_retrieve.md b/docs/document/flutter/message_retrieve.md
@@ -42,9 +42,8 @@
 
 :::tip
 1. 若使用该 API，需将 SDK 版本升级至 V4.0.2 版本或以上。
-2. **默认可获取单聊和群组聊天的历史消息。若要获取聊天室的历史消息，需联系环信商务。**
-3. 历史消息和离线消息在服务器上的存储时间与你订阅的套餐包有关，详见[产品价格](/product/pricing.html#套餐包功能详情)。
-4. 各类事件通知发送时，若接收的用户离线，事件通知的存储时间与离线消息的存储时间一致，即也取决于你订阅的套餐包。
+2. **默认可获取单聊和群组聊天的历史消息。若要获取聊天室的历史消息，需升级至 4.5.0 版本，并联系环信商务。**
+3. 历史消息在服务器上的存储时间与产品的套餐包相关，详见[产品套餐包详情](/product/pricing.html#套餐包功能详情)。
 :::
 
 ```dart

diff --git a/docs/document/harmonyos/message_retrieve.md b/docs/document/harmonyos/message_retrieve.md
@@ -40,8 +40,7 @@
 
 :::tip
 1. **默认可获取单聊和群组聊天的历史消息。若要获取聊天室的历史消息，需联系环信商务。**
-2. 历史消息和离线消息在服务器上的存储时间与你订阅的套餐包有关，详见[产品价格](/product/pricing.html#套餐包功能详情)。
-3. 各类事件通知发送时，若接收的用户离线，事件通知的存储时间与离线消息的存储时间一致，即也取决于你订阅的套餐包。
+2. 历史消息在服务器上的存储时间与产品的套餐包相关，详见[产品套餐包详情](/product/pricing.html#套餐包功能详情)。
 :::
 
 ```TypeScript

diff --git a/docs/document/ios/message_retrieve.md b/docs/document/ios/message_retrieve.md
@@ -47,9 +47,9 @@
 
 :::tip
 1. 若使用该 API，需将 SDK 版本升级至 V4.0.2 版本或以上。
-2. **默认可获取单聊和群组聊天的历史消息。若要获取聊天室的历史消息，需联系环信商务。**
-3. 历史消息和离线消息在服务器上的存储时间与你订阅的套餐包有关，详见[产品价格](/product/pricing.html#套餐包功能详情)。
-4. 各类事件通知发送时，若接收的用户离线，事件通知的存储时间与离线消息的存储时间一致，即也取决于你订阅的套餐包。
+2. **默认可获取单聊和群组聊天的历史消息。若要获取聊天室的历史消息，需升级至 4.5.0 版本，并联系环信商务。**
+3. 对于单聊消息，自 4.11.0 版本开始，从服务器拉取历史消息时会读取服务端的消息已读和送达状态。该功能默认关闭，如果需要，请联系环信商务开通。
+4. 历史消息在服务器上的存储时间与产品的套餐包相关，详见[产品套餐包详情](/product/pricing.html#套餐包功能详情)。
 :::
 
 ```swift

diff --git a/docs/document/ios/releasenote.md b/docs/document/ios/releasenote.md
@@ -2,6 +2,55 @@
 
 <Toc />
 
+## 版本 V4.11.0 Dev 2024-12-3（开发版）
+
+### 新增特性
+
+- [IM SDK] 新增[拉取服务器漫游消息](message_retrieve.html#从服务器获取指定会话的消息)时会读取服务端的消息已读和送达状态。该功能只适用于单聊消息，默认关闭，如果需要，请联系环信商务开通。 
+- [IM SDK] 聊天室成员禁言回调：
+  - 新增聊天室禁言回调 `EMChatroomManagerDelegate#chatroomMuteListDidUpdate:addedMutedMembers:`，在回调中使用 `(NSDictionary<NSString *,NSNumber*> *)aMutes` 参数表示禁言到期时间戳。
+  - 废弃原来的回调 `EMChatroomManagerDelegate#chatroomMuteListDidUpdate:addedMutedMembers:muteExpire:`。
+- [IM SDK] 新增 Crash 上报能力：当 SDK 发生 Crash 时，会在下次启动后上报 Crash 信息。
+
+### 修复
+
+- [IM SDK] 修复极端情况下因网络异常导致的 Crash。
+
+### 优化
+
+- [IM SDK] 将 4.0.0 版本之前标为废弃的 API 删除。
+
+### 注意
+
+由于 Crash 上报使用了 `aosl.xcframework` 库，如果同时集成了 `HyphenateChat 4.11.0` 和 `AgoraRtcEngine_iOS 4.3.0-4.4.1` 的版本，会有 AOSL 库冲突的问题，执行 `pod install` 时会出现如下报错：
+```
+[!] The 'Pods-EaseChatDemo' target has frameworks with conflicting names: aosl.xcframework.
+```
+
+要修复该问题，需要修改 `Podfile` 文件，添加如下脚本：
+
+```ruby
+pre_install do |installer|
+  # 定义 AgoraRtcEngine_iOS framework 的路径
+  rtc_pod_path = File.join(installer.sandbox.root, 'AgoraRtcEngine_iOS')
+
+  # aosl.xcframework 的完整路径
+  aosl_xcframework_path = File.join(rtc_pod_path, 'aosl.xcframework')
+
+  # 检查文件是否存在，如果存在则删除
+  if File.exist?(aosl_xcframework_path)
+    puts "Deleting aosl.xcframework from #{aosl_xcframework_path}"
+    FileUtils.rm_rf(aosl_xcframework_path)
+  else
+    puts "aosl.xcframework not found, skipping deletion."
+  end
+end
+```
+然后重新执行 `pod install`。
+
+详情请点击[这里](https://doc.shengwang.cn/faq/integration-issues/rtm2-rtc-integration-issue)。
+
+
 ## 版本 V4.10.2 Dev 2024-11-22（开发版）
 
 ### 修复

diff --git a/docs/document/ios/room_manage.md b/docs/document/ios/room_manage.md
@@ -167,9 +167,8 @@ SDK 中提供了聊天室事件的监听接口。你可以通过注册聊天室
 // 有成员被加入禁言列表。被禁言的成员会收到该事件。
 
 - (void)chatroomMuteListDidUpdate:(EMChatroom *)aChatroom
-      addedMutedMembers:(NSArray *)aMutes
-             muteExpire:(NSInteger)aMuteExpire {
-  }
+                addedMutedMembers:(NSDictionary<NSString *,NSNumber*> *)aMutes {
+}
 
 // 有成员被移除禁言列表。被解除禁言的成员会收到该事件。
 - (void)chatroomMuteListDidUpdate:(EMChatroom *)aChatroom

diff --git a/docs/document/ios/room_members.md b/docs/document/ios/room_members.md
@@ -194,7 +194,7 @@ EMError *error = nil;
 
 #### 添加成员至聊天室禁言列表
 
-仅聊天室所有者和管理员可以调用 `muteMembers` 方法将指定成员添加至聊天室禁言列表。被禁言后，操作者外其他成员收到 `chatroomMuteListDidUpdate:addedMutedMembers` 回调。
+仅聊天室所有者和管理员可以调用 `muteMembers` 方法将指定成员添加至聊天室禁言列表。被禁言的成员和其他未操作的聊天室管理员或聊天室所有者收到 `chatroomMuteListDidUpdate:addedMutedMembers` 回调。
 
 :::notice
 聊天室所有者可禁言聊天室所有成员，聊天室管理员可禁言聊天室普通成员。
@@ -211,7 +211,7 @@ EMError *error = nil;
 
 #### 将成员移出聊天室禁言列表
 
-仅聊天室所有者和管理员可以调用 `unmuteMembers` 方法将成员移出聊天室禁言列表。被解除禁言后，其他成员收到 `chatroomMuteListDidUpdate: removedMutedMembers` 回调。
+仅聊天室所有者和管理员可以调用 `unmuteMembers` 方法将成员移出聊天室禁言列表。被解除禁言的成员和其他未操作的聊天室管理员或聊天室所有者收到 `chatroomMuteListDidUpdate: removedMutedMembers` 回调。
 
 :::notice
 聊天室所有者可对聊天室所有成员解除禁言，聊天室管理员可对聊天室普通成员解除禁言。

diff --git a/docs/document/react-native/message_retrieve.md b/docs/document/react-native/message_retrieve.md
@@ -46,9 +46,8 @@
 :::tip
 
 1. 若使用该 API，需将 SDK 版本升级至 V1.1.2 版本或以上。
-2. **默认可获取单聊和群组聊天的历史消息。若要获取聊天室的历史消息，需联系环信商务。**
-3. 历史消息和离线消息在服务器上的存储时间与你订阅的套餐包有关，详见[产品价格](/product/pricing.html#套餐包功能详情)。
-4. 各类事件通知发送时，若接收的用户离线，事件通知的存储时间与离线消息的存储时间一致，即也取决于你订阅的套餐包。
+2. **默认可获取单聊和群组聊天的历史消息。若要获取聊天室的历史消息，需升级至 1.4.0 版本，需联系环信商务。**
+3. 历史消息在服务器上的存储时间与产品的套餐包相关，详见[产品套餐包详情](/product/pricing.html#套餐包功能详情)。
    :::
 
 ```tsx

diff --git a/docs/document/server-side/message_historical.md b/docs/document/server-side/message_historical.md
@@ -56,7 +56,7 @@ GET https://{host}/{org_name}/{app_name}/chatmessages/{time}
 
 | 参数   | 类型   | 是否必需 | 描述         |
 | :----- | :----- | :------- | :------------- |
-| `time` | String | 是       | 历史消息记录查询的起始时间。UTC 时间，使用 ISO8601 标准，格式为 yyyyMMddHH。例如 `time` 为 `2018112717`，则表示查询 2018 年 11 月 27 日 17 时至 2018 年 11 月 27 日 18 时期间的历史消息。若海外集群为 UTC 时区，需要根据自己所在的时区进行时间转换。 |
+| `time` | String | 是       | 历史消息记录查询的起始时间。<br/> - 国内集群：采用北京时间，格式为 yyyyMMddHH。例如 `time` 为 `2018112717`，则表示查询 2018 年 11 月 27 日 17 时至 2018 年 11 月 27 日 18 时期间的历史消息。<br/> - 海外集群：采用 UTC 时间，格式为 yyyyMMddHH，你需要根据自己所在的时区进行时间转换。 |
 
 其他参数及描述详见 [公共参数](#公共参数)。
 

diff --git a/docs/document/unity/message_retrieve.md b/docs/document/unity/message_retrieve.md
@@ -42,9 +42,8 @@
 
 :::tip
 1. 若使用该 API，需将 SDK 升级至 V1.2.0 或以上版本。
-2. **默认可获取单聊和群组聊天的历史消息。若要获取聊天室的历史消息，需联系环信商务。**
-3. 历史消息和离线消息在服务器上的存储时间与你订阅的套餐包有关，详见[产品价格](/product/pricing.html#套餐包功能详情)。
-4. 各类事件通知发送时，若接收的用户离线，事件通知的存储时间与离线消息的存储时间一致，即也取决于你订阅的套餐包。
+2. **默认可获取单聊和群组聊天的历史消息。若要获取聊天室的历史消息，需升级至 1.3.0 版本，并联系环信商务。**
+3. 历史消息在服务器上的存储时间与产品的套餐包相关，详见[产品套餐包详情](/product/pricing.html#套餐包功能详情)。
 :::
 
 ```csharp

diff --git a/docs/document/web/message_retrieve.md b/docs/document/web/message_retrieve.md
@@ -27,8 +27,8 @@
 :::tip
 1. 若使用该 API，需将 SDK 版本升级至 V4.1.6 版本或以上。
 2. **默认可获取单聊和群组聊天的历史消息。若要获取聊天室的历史消息，需联系环信商务。**
-3. 历史消息和离线消息在服务器上的存储时间与你订阅的套餐包有关，详见[产品价格](/product/pricing.html#套餐包功能详情)。
-4. 各类事件通知发送时，若接收的用户离线时，事件通知的存储时间与离线消息的存储时间一致，即也取决于你订阅的套餐包。
+3. 对于单聊消息，从服务器拉取历史消息时会读取服务端的消息已读和送达状态。该功能默认关闭，如果需要，需升级至 4.11.0 版本，并联系环信商务开通。
+4. 历史消息在服务器上的存储时间与产品的套餐包相关，详见[产品套餐包详情](/product/pricing.html#套餐包功能详情)。
 :::
 
 ```javascript

diff --git a/docs/document/web/releasenote.md b/docs/document/web/releasenote.md
@@ -2,6 +2,22 @@
 
 <Toc />
 
+## 版本 V4.11.0 Dev 2024-12-3（开发版）
+
+### 新增特性
+
+- [IM SDK] 新增[拉取服务器漫游消息](message_retrieve.html#从服务器获取指定会话的消息)时会读取服务端的消息已读和送达状态。该功能只适用于单聊消息，默认关闭，如果需要，请联系环信商务开通。
+- [IM SDK] 聊天室禁言回调 `muteMember` 新增 `muteTimestamp` 参数，表示禁言过期时间。
+- [IM SDK] 群组/聊天室禁言事件 `muteMember` 新增 `userId` 字段，表示被禁言的成员。
+
+### 优化
+
+[IM SDK] SDK 的 message 对象中新增 `parseDownloadResponse`、`download` 方法。目前，SDK 的 utils 对象和 message 对象中均包含 `parseDownloadResponse`、`download` 方法。
+
+### 修复
+
+[IM SDK] 修复消息置顶事件 `onMessagePinEvent` 中的 `conversationId` 参数值错误的问题。
+
 ## 版本 V4.10.0 2024-10-11（开发版）
 
 ### 新增特性

diff --git a/docs/document/web/room_members.md b/docs/document/web/room_members.md
@@ -211,7 +211,7 @@ conn.getChatRoomMuteList(option).then(res => console.log(res))
 
 #### 将成员添加至聊天室禁言列表
 
-仅聊天室所有者和管理员可调用 `muteChatRoomMember` 方法将指定成员添加至聊天室禁言列表。被禁言的聊天室成员会收到 `muteMember` 事件。
+仅聊天室所有者和管理员可调用 `muteChatRoomMember` 方法将指定成员添加至聊天室禁言列表。被禁言的成员和其他未操作的聊天室管理员或聊天室所有者收到 `muteMember` 事件。
 
 :::notice
 聊天室所有者可禁言聊天室所有成员，聊天室管理员可禁言聊天室普通成员。
@@ -233,7 +233,7 @@ conn.muteChatRoomMember(option).then(res => console.log(res))
 仅聊天室所有者和管理员可调用 `unmuteChatRoomMember` 方法将一组成员解除禁言。
 
 :::notice
-聊天室所有者可对聊天室所有成员解除禁言，聊天室管理员可对聊天室普通成员解除禁言。被解除禁言的聊天室成员会收到 `removeMute` 事件。
+聊天室所有者可对聊天室所有成员解除禁言，聊天室管理员可对聊天室普通成员解除禁言。被解除禁言的成员和其他未操作的聊天室管理员或聊天室所有者收到 `unmuteMember` 事件。
 :::
 
 示例代码如下：

diff --git a/docs/document/windows/message_retrieve.md b/docs/document/windows/message_retrieve.md
@@ -44,9 +44,8 @@
 
 :::tip
 1. 若使用该 API，需将 SDK 升级至 V1.2.0 或以上版本。
-2. **默认可获取单聊和群组聊天的历史消息。若要获取聊天室的历史消息，需联系环信商务。**
-3. 历史消息和离线消息在服务器上的存储时间与你订阅的套餐包有关，详见[产品价格](/product/pricing.html#套餐包功能详情)。
-4. 各类事件通知发送时，若接收的用户离线，事件通知的存储时间与离线消息的存储时间一致，即也取决于你订阅的套餐包。
+2. **默认可获取单聊和群组聊天的历史消息。若要获取聊天室的历史消息，需升级至 1.3.0 版本，并联系环信商务。**
+3. 历史消息在服务器上的存储时间与产品的套餐包相关，详见[产品套餐包详情](/product/pricing.html#套餐包功能详情)。
 :::
 
 ```csharp