Merge pull request #483 from haoxiuwen/doc-v2

Modify IM Docs
easemob · Nov 1, 2023 · 6d37bbd · 6d37bbd
2 parents c424184 + aa2d02a
commit 6d37bbd
Show file tree

Hide file tree

Showing 9 changed files with 88 additions and 15 deletions.
diff --git a/docs/document/android/message_modify.md b/docs/document/android/message_modify.md
@@ -1,9 +1,17 @@
 # 修改消息
 
-对于单聊或群聊会话中已经发送成功的文本消息，SDK 支持对这些消息进行修改，修改成功后会同步给会话中的接收方。
+对于单聊或群组聊天会话中已经发送成功的文本消息，SDK 支持对这些消息的内容进行修改。消息内容修改流程如下：
+
+1. 用户调用 SDK 的 API 修改一条消息。
+2. 服务端存储的该条消息，修改成功后回调给 SDK。
+3. SDK 修改客户端上的该条消息。成功后，SDK 将修改后的消息回调给用户。
+
+修改消息没有时间限制，即只要这条消息仍在服务端存储就可以修改。消息修改后，消息生命周期（在服务端的保存时间）会重新计算，例如，消息可在服务器上保存 180 天，用户在消息发送后的第 30 天（服务器上的保存时间剩余 150 天）修改了消息，修改成功后该消息还可以在服务器上保存 180 天。
+
+对于修改后的消息，消息体中除了内容变化，还新增了修改者的用户 ID、修改时间和修改次数属性。除消息体外，该消息的其他信息（例如，消息发送方、接收方和扩展属性）均不会发生变化。
 
 - 对于单聊会话，只有消息发送方才能对消息进行修改。
-- 对于群聊会话，群主和群管理员除了可以修改自己发送的消息，还可以修改普通群成员发送的消息，而普通群成员只能修改自己发送的消息。
+- 对于群聊会话，普通群成员只能修改自己发送的消息。群主和群管理员除了可以修改自己发送的消息，还可以修改普通群成员发送的消息。这种情况下，消息的发送方不变，消息体中的修改者的用户 ID 属性为群主或群管理员的用户 ID。
 
 :::notice
 1. 若使用该功能，需将 SDK 升级至 4.1.0 或以上版本。

diff --git a/docs/document/android/message_send_receive.md b/docs/document/android/message_send_receive.md
@@ -581,7 +581,7 @@ EMClient.getInstance().chatManager().sendMessage(customMessage);
 
 1. 利用原始消息列表创建一条合并消息。
 2. 发送合并消息。
-3. 对端收到合并消息后进行解析，获取原始消息列表。
+3. 对端收到合并消息后进行解析，获取原始消息列表。合并消息转发后在接收端显示该消息的标题和预览图。
 
 #### 创建和发送合并消息
 
@@ -600,6 +600,7 @@ EMClient.getInstance().chatManager().sendMessage(customMessage);
 :::notice
 1. 合并转发支持嵌套，最多支持 10 层嵌套，每层最多 300 条消息。
 2. 不论 `EMOptions#setAutoTransferMessageAttachments` 设置为 `false` 或 `true`，SDK 都会将合并消息附件上传到环信服务器。
+3. 合并消息不支持搜索。
 :::
 
 示例代码如下：

diff --git a/docs/document/flutter/message_modify.md b/docs/document/flutter/message_modify.md
@@ -1,9 +1,17 @@
 # 修改消息
 
-对于单聊或群聊会话中已经发送成功的消息，SDK 支持对这些消息进行修改，修改成功后会同步给会话中的接收方。
+对于单聊或群组聊天会话中已经发送成功的文本消息，SDK 支持对这些消息的内容进行修改。消息内容修改流程如下：
+
+1. 用户调用 SDK 的 API 修改一条消息。
+2. 服务端存储的该条消息，修改成功后回调给 SDK。
+3. SDK 修改客户端上的该条消息。成功后，SDK 将修改后的消息回调给用户。
+
+修改消息没有时间限制，即只要这条消息仍在服务端存储就可以修改。消息修改后，消息生命周期（在服务端的保存时间）会重新计算，例如，消息可在服务器上保存 180 天，用户在消息发送后的第 30 天（服务器上的保存时间剩余 150 天）修改了消息，修改成功后该消息还可以在服务器上保存 180 天。
+
+对于修改后的消息，消息体中除了内容变化，还新增了修改者的用户 ID、修改时间和修改次数属性。除消息体外，该消息的其他信息（例如，消息发送方、接收方和扩展属性）均不会发生变化。
 
 - 对于单聊会话，只有消息发送方才能对消息进行修改。
-- 对于群聊会话，群主和群管理员除了可以修改自己发送的消息，还可以修改普通群成员发送的消息，而普通群成员只能修改自己发送的消息。
+- 对于群聊会话，普通群成员只能修改自己发送的消息。群主和群管理员除了可以修改自己发送的消息，还可以修改普通群成员发送的消息。这种情况下，消息的发送方不变，消息体中的修改者的用户 ID 属性为群主或群管理员的用户 ID。
 
 :::notice
 1. 若使用该功能，需将 SDK 升级至 4.1.0 或以上版本。

diff --git a/docs/document/flutter/releasenote.md b/docs/document/flutter/releasenote.md
@@ -2,6 +2,22 @@
 
 <Toc />
 
+## 版本 4.1.0 2023-11-1
+
+#### 新增
+
+- 支持安卓 14;
+- 新增 `EMOptions#enableHonorPush` 方法用于开启荣耀推送。
+
+#### 修复
+
+- 修复调用 `EMChatManager#getThreadConversation` 报错；
+- 修复 `EMMessage#chatThread` 方法报错;
+- 修复 `EMChatRoomEventHandler#onSpecificationChanged` 回调不执行；
+- 修复 `EMChatThreadManager#fetchChatThreadMembers` 崩溃；
+- 修复特殊场景下，安卓平台退出后再登录会丢失聊天室监听事件问题；
+- 修复修改消息后，离线用户上线后拉取历史消息，消息体中缺乏 `from` 属性的问题。
+
 ## 版本 4.1.0 2023-8-16
 
 ### 新增特性

diff --git a/docs/document/ios/message_modify.md b/docs/document/ios/message_modify.md
@@ -1,9 +1,17 @@
 # 修改消息
 
-对于单聊或群聊会话中已经发送成功的文本消息，SDK 支持对这些消息进行修改，修改成功后会同步给会话中的接收方。
+对于单聊或群组聊天会话中已经发送成功的文本消息，SDK 支持对这些消息的内容进行修改。消息内容修改流程如下：
+
+1. 用户调用 SDK 的 API 修改一条消息。
+2. 服务端存储的该条消息，修改成功后回调给 SDK。
+3. SDK 修改客户端上的该条消息。成功后，SDK 将修改后的消息回调给用户。
+
+修改消息没有时间限制，即只要这条消息仍在服务端存储就可以修改。消息修改后，消息生命周期（在服务端的保存时间）会重新计算，例如，消息可在服务器上保存 180 天，用户在消息发送后的第 30 天（服务器上的保存时间剩余 150 天）修改了消息，修改成功后该消息还可以在服务器上保存 180 天。
+
+对于修改后的消息，消息体中除了内容变化，还新增了修改者的用户 ID、修改时间和修改次数属性。除消息体外，该消息的其他信息（例如，消息发送方、接收方和扩展属性）均不会发生变化。
 
 - 对于单聊会话，只有消息发送方才能对消息进行修改。
-- 对于群聊会话，群主和群管理员除了可以修改自己发送的消息，还可以修改普通群成员发送的消息，而普通群成员只能修改自己发送的消息。
+- 对于群聊会话，普通群成员只能修改自己发送的消息。群主和群管理员除了可以修改自己发送的消息，还可以修改普通群成员发送的消息。这种情况下，消息的发送方不变，消息体中的修改者的用户 ID 属性为群主或群管理员的用户 ID。
 
 :::notice
 1. 若使用该功能，需将 SDK 升级至 4.1.0 或以上版本。

diff --git a/docs/document/react-native/message_modify.md b/docs/document/react-native/message_modify.md
@@ -1,9 +1,17 @@
 # 修改消息
 
-对于单聊或群聊会话中已经发送成功的文本消息，SDK 支持对这些消息进行修改，修改成功后会同步给会话中的接收方。
+对于单聊或群组聊天会话中已经发送成功的文本消息，SDK 支持对这些消息的内容进行修改。消息内容修改流程如下：
+
+1. 用户调用 SDK 的 API 修改一条消息。
+2. 服务端存储的该条消息，修改成功后回调给 SDK。
+3. SDK 修改客户端上的该条消息。成功后，SDK 将修改后的消息回调给用户。
+
+修改消息没有时间限制，即只要这条消息仍在服务端存储就可以修改。消息修改后，消息生命周期（在服务端的保存时间）会重新计算，例如，消息可在服务器上保存 180 天，用户在消息发送后的第 30 天（服务器上的保存时间剩余 150 天）修改了消息，修改成功后该消息还可以在服务器上保存 180 天。
+
+对于修改后的消息，消息体中除了内容变化，还新增了修改者的用户 ID、修改时间和修改次数属性。除消息体外，该消息的其他信息（例如，消息发送方、接收方和扩展属性）均不会发生变化。
 
 - 对于单聊会话，只有消息发送方才能对消息进行修改。
-- 对于群聊会话，群主和群管理员除了可以修改自己发送的消息，还可以修改普通群成员发送的消息，而普通群成员只能修改自己发送的消息。
+- 对于群聊会话，普通群成员只能修改自己发送的消息。群主和群管理员除了可以修改自己发送的消息，还可以修改普通群成员发送的消息。这种情况下，消息的发送方不变，消息体中的修改者的用户 ID 属性为群主或群管理员的用户 ID。
 
 :::notice
 1. 若使用该功能，需将 SDK 升级至 1.2.0 或以上版本。

diff --git a/docs/document/unity/message_modify.md b/docs/document/unity/message_modify.md
@@ -1,9 +1,17 @@
 # 修改消息
 
-对于单聊或群聊会话中已经发送成功的消息，SDK 支持对这些消息进行修改，修改成功后会同步给会话中的接收方。
+对于单聊或群组聊天会话中已经发送成功的文本消息，SDK 支持对这些消息的内容进行修改。消息内容修改流程如下：
+
+1. 用户调用 SDK 的 API 修改一条消息。
+2. 服务端存储的该条消息，修改成功后回调给 SDK。
+3. SDK 修改客户端上的该条消息。成功后，SDK 将修改后的消息回调给用户。
+
+修改消息没有时间限制，即只要这条消息仍在服务端存储就可以修改。消息修改后，消息生命周期（在服务端的保存时间）会重新计算，例如，消息可在服务器上保存 180 天，用户在消息发送后的第 30 天（服务器上的保存时间剩余 150 天）修改了消息，修改成功后该消息还可以在服务器上保存 180 天。
+
+对于修改后的消息，消息体中除了内容变化，还新增了修改者的用户 ID、修改时间和修改次数属性。除消息体外，该消息的其他信息（例如，消息发送方、接收方和扩展属性）均不会发生变化。
 
 - 对于单聊会话，只有消息发送方才能对消息进行修改。
-- 对于群聊会话，群主和群管理员除了可以修改自己发送的消息，还可以修改普通群成员发送的消息，而普通群成员只能修改自己发送的消息。
+- 对于群聊会话，普通群成员只能修改自己发送的消息。群主和群管理员除了可以修改自己发送的消息，还可以修改普通群成员发送的消息。这种情况下，消息的发送方不变，消息体中的修改者的用户 ID 属性为群主或群管理员的用户 ID。
 
 :::notice
 1. 若使用该功能，需将 SDK 升级至 1.2.0 或以上版本。

diff --git a/docs/document/web/message_modify.md b/docs/document/web/message_modify.md
@@ -1,9 +1,17 @@
 # 修改消息
 
-对于单聊或群聊会话中已经发送成功的文本消息，SDK 支持对这些消息进行修改，修改成功后会同步给会话中的接收方。
+对于单聊或群组聊天会话中已经发送成功的文本消息，SDK 支持对这些消息的内容进行修改。消息内容修改流程如下：
+
+1. 用户调用 SDK 的 API 修改一条消息。
+2. 服务端存储的该条消息，修改成功后回调给 SDK。
+3. SDK 修改客户端上的该条消息。成功后，SDK 将修改后的消息回调给用户。
+
+修改消息没有时间限制，即只要这条消息仍在服务端存储就可以修改。消息修改后，消息生命周期（在服务端的保存时间）会重新计算，例如，消息可在服务器上保存 180 天，用户在消息发送后的第 30 天（服务器上的保存时间剩余 150 天）修改了消息，修改成功后该消息还可以在服务器上保存 180 天。
+
+对于修改后的消息，消息体中除了内容变化，还新增了修改者的用户 ID、修改时间和修改次数属性。除消息体外，该消息的其他信息（例如，消息发送方、接收方和扩展属性）均不会发生变化。
 
 - 对于单聊会话，只有消息发送方才能对消息进行修改。
-- 对于群聊会话，群主和群管理员除了可以修改自己发送的消息，还可以修改普通群成员发送的消息，而普通群成员只能修改自己发送的消息。
+- 对于群聊会话，普通群成员只能修改自己发送的消息。群主和群管理员除了可以修改自己发送的消息，还可以修改普通群成员发送的消息。这种情况下，消息的发送方不变，消息体中的修改者的用户 ID 属性为群主或群管理员的用户 ID。
 
 :::notice
 1. 若使用该功能，需将 SDK 升级至 4.2.0 或以上版本。

diff --git a/docs/document/windows/message_modify.md b/docs/document/windows/message_modify.md
@@ -1,9 +1,17 @@
 # 修改消息
 
-对于单聊或群聊会话中已经发送成功的消息，SDK 支持对这些消息进行修改，修改成功后会同步给会话中的接收方。
+对于单聊或群组聊天会话中已经发送成功的文本消息，SDK 支持对这些消息的内容进行修改。消息内容修改流程如下：
+
+1. 用户调用 SDK 的 API 修改一条消息。
+2. 服务端存储的该条消息，修改成功后回调给 SDK。
+3. SDK 修改客户端上的该条消息。成功后，SDK 将修改后的消息回调给用户。
+
+修改消息没有时间限制，即只要这条消息仍在服务端存储就可以修改。消息修改后，消息生命周期（在服务端的保存时间）会重新计算，例如，消息可在服务器上保存 180 天，用户在消息发送后的第 30 天（服务器上的保存时间剩余 150 天）修改了消息，修改成功后该消息还可以在服务器上保存 180 天。
+
+对于修改后的消息，消息体中除了内容变化，还新增了修改者的用户 ID、修改时间和修改次数属性。除消息体外，该消息的其他信息（例如，消息发送方、接收方和扩展属性）均不会发生变化。
 
 - 对于单聊会话，只有消息发送方才能对消息进行修改。
-- 对于群聊会话，群主和群管理员除了可以修改自己发送的消息，还可以修改普通群成员发送的消息，而普通群成员只能修改自己发送的消息。
+- 对于群聊会话，普通群成员只能修改自己发送的消息。群主和群管理员除了可以修改自己发送的消息，还可以修改普通群成员发送的消息。这种情况下，消息的发送方不变，消息体中的修改者的用户 ID 属性为群主或群管理员的用户 ID。
 
 :::notice
 1. 若使用该功能，需将 SDK 升级至 1.2.0 或以上版本。