Merge pull request #1070 from haoxiuwen/doc-v2

Modify IM Docs
easemob · Dec 4, 2024 · e9e2ee0 · e9e2ee0
2 parents 7b15560 + 85fee25
commit e9e2ee0
Show file tree

Hide file tree

Showing 14 changed files with 51 additions and 38 deletions.
diff --git a/docs/document/android/conversation_list.md b/docs/document/android/conversation_list.md
@@ -28,6 +28,8 @@
 
 你可以调用 `asyncFetchConversationsFromServer` 方法从服务端分页获取会话列表，包含单聊和群组聊天会话，不包含聊天室会话。SDK 按照会话活跃时间（会话的最新一条消息的时间戳）的倒序返回会话列表，每个会话对象中包含会话 ID、会话类型、是否为置顶状态、置顶时间（对于未置顶的会话，值为 `0`）、会话标记以及最新一条消息。从服务端拉取会话列表后会更新本地会话列表。
 
+服务器默认存储 100 条会话。超过该限制后，新会话会覆盖旧会话。若会话中的历史消息均过期，会话变成空会话。默认拉取会话列表时不包含这些空会话，若要包含，需在 SDK 初始化时将 `EMOptions#isLoadEmptyConversations` 设置为 `true`。这种情况下，空会话都会占用会话拉取名额，不管拉取时是否需要。如果拉取会话时不需要空会话且不希望其占用会话列表名额，需要联系商务开通。
+
 :::tip
 1. **若使用该功能，需在环信控制台开通，并将 SDK 升级至 4.0.3。而且，只有开通该功能，你才能使用置顶会话和会话标记功能。** 
 2. 建议你在首次下载、卸载后重装应用等本地数据库无数据情况下拉取服务端会话列表。其他情况下，调用 `asyncFilterConversationsFromDB`、`getAllConversationsBySort` 或 `getAllConversations` 方法获取本地所有会话即可。

diff --git a/docs/document/android/room_attributes.md b/docs/document/android/room_attributes.md
@@ -12,8 +12,8 @@
 
 - 获取和更新聊天室基本属性；
 - 获取聊天室自定义属性；
-- 设置和强制设置聊天室自定义属性；
-- 删除和强制删除聊天室自定义属性。
+- 设置和更新/强制设置和更新聊天室自定义属性；
+- 删除/强制删除聊天室自定义属性。
 
 ## 前提条件
 
@@ -139,9 +139,9 @@ EMClient.getInstance().chatroomManager().asyncFetchChatRoomAllAttributesFromServ
 });
 ```
 
-#### 设置单个聊天室属性
+#### 设置/更新单个聊天室属性
 
-聊天室成员可以调用 `asyncSetChatroomAttribute` 方法设置单个聊天室自定义属性。该方法只可添加新自定义属性字段和更新自己设置的现有属性。设置后，其他聊天室成员收到 `onAttributesUpdate` 回调。
+聊天室成员可以调用 `asyncSetChatroomAttribute` 方法设置或更新单个聊天室自定义属性。该方法只可添加新自定义属性字段和更新自己设置的现有属性。设置后，其他聊天室成员收到 `onAttributesUpdate` 回调。
 
 示例代码如下：
 
@@ -174,9 +174,9 @@ EMClient.getInstance().chatroomManager().asyncSetChatroomAttribute(
 });
 ```
 
-#### 强制设置单个聊天室属性
+#### 强制设置/更新单个聊天室属性
 
-如果除了设置自己的单个自定义属性还需覆盖其他聊天室成员设置的该属性，需调用 `asyncSetChatroomAttributeForced` 方法。设置后，其他聊天室成员收到 `onAttributesUpdate` 回调。
+如果除了设置或更新自己的单个自定义属性还需覆盖其他聊天室成员设置的该属性，需调用 `asyncSetChatroomAttributeForced` 方法。设置后，其他聊天室成员收到 `onAttributesUpdate` 回调。
 
 示例代码如下：
 
@@ -209,9 +209,9 @@ EMClient.getInstance().chatroomManager().asyncSetChatroomAttributeForced(
 });
 ```
 
-#### 设置多个聊天室自定义属性
+#### 设置/更新多个聊天室自定义属性
 
-聊天室成员可以调用 `asyncSetChatroomAttributes` 方法设置多个聊天室自定义属性。该方法只能添加新属性字段以及更新当前用户已添加的属性字段。设置后，其他聊天室成员收到 `onAttributesUpdate` 回调。
+聊天室成员可以调用 `asyncSetChatroomAttributes` 方法设置或更新多个聊天室自定义属性。该方法只能添加新属性字段以及更新当前用户已添加的属性字段。设置后，其他聊天室成员收到 `onAttributesUpdate` 回调。
 
 示例代码如下：
 
@@ -241,7 +241,7 @@ EMClient.getInstance().chatroomManager().asyncSetChatroomAttributes(
 });
 ```
 
-#### 强制设置多个聊天室属性
+#### 强制设置/更新多个聊天室属性
 
 如果除了设置自己的多个自定义属性还需覆盖其他聊天室成员设置的这些属性，需调用 `asyncSetChatroomAttributesForced` 方法。设置后，其他聊天室成员收到 `onAttributesUpdate` 回调。
 

diff --git a/docs/document/flutter/conversation_list.md b/docs/document/flutter/conversation_list.md
@@ -26,6 +26,8 @@
 
 你可以调用 `fetchConversationsByOptions` 方法从服务端分页获取会话列表，包含单聊和群组聊天会话，不包含聊天室会话。SDK 按照会话活跃时间（会话的最新一条消息的时间戳）的倒序返回会话列表，每个会话对象中包含会话 ID、会话类型、是否为置顶状态、置顶时间（对于未置顶的会话，值为 `0`）以及最新一条消息。从服务端拉取会话列表后会更新本地会话列表。
 
+服务器默认存储 100 条会话。超过该限制后，新会话会覆盖旧会话。若会话中的历史消息均过期，会话变成空会话。默认拉取会话列表时不包含这些空会话，若要包含，需在 SDK 初始化时将 `EMOptions#enableEmptyConversation` 设置为 `true`。这种情况下，空会话都会占用会话拉取名额，不管拉取时是否需要。如果拉取会话时不需要空会话且不希望其占用会话列表名额，需要联系商务开通。
+
 :::tip
 1. **若使用该功能，需在环信控制台开通该功能，并将 SDK 升级至 V4.5.0 或以上版本。只有开通该功能，你才能使用置顶会话功能。** 
 2. 建议在 app 安装时或本地没有会话时调用该方法，否则调用 `loadAllConversations` 获取本地会话即可。

diff --git a/docs/document/flutter/room_attributes.md b/docs/document/flutter/room_attributes.md
@@ -12,8 +12,8 @@
 
 - 获取和更新聊天室基本属性；
 - 获取聊天室自定义属性；
-- 设置聊天室自定义属性；
-- 删除聊天室自定义属性。 
+- 设置/更新和强制设置/更新聊天室自定义属性；
+- 删除/强制删除聊天室自定义属性。 
 
 ## 前提条件
 
@@ -118,9 +118,9 @@ try {
 } on EMError catch (e) {}
 ```
 
-#### 设置聊天室自定义属性
+#### 设置/更新聊天室自定义属性
 
-所有聊天室成员均可调用 `addAttributes` 方法设置一个或多个聊天室自定义属性。利用该方法可设置新属性，也可以修改自己或其他成员设置的现有属性。设置后，其他聊天室成员收到 `EMChatRoomEventHandler#onAttributesUpdated` 回调。
+所有聊天室成员均可调用 `addAttributes` 方法设置或更新一个或多个聊天室自定义属性。利用该方法可设置新属性，也可以修改自己或其他成员设置的现有属性。设置后，其他聊天室成员收到 `EMChatRoomEventHandler#onAttributesUpdated` 回调。
 
 示例代码如下：
 

diff --git a/docs/document/harmonyos/room_attributes.md b/docs/document/harmonyos/room_attributes.md
@@ -12,7 +12,8 @@
 
 - 获取和更新聊天室基本属性；
 - 获取聊天室自定义属性；
-- 设置、获取和删除聊天室自定义属性。
+- 设置和更新/强制设置和更新聊天室自定义属性。
+- 删除/强制删除聊天室自定义属性。
 
 ## 前提条件
 
@@ -98,9 +99,9 @@ ChatClient.getInstance().chatroomManager()?.fetchChatroomAttributes(chatroomId).
 })
 ```
 
-#### 设置聊天室自定义属性
+#### 设置/更新聊天室自定义属性
 
-聊天室成员可以调用 `setChatroomAttributes` 方法设置单个聊天室自定义属性。该方法只可添加新自定义属性字段和更新自己设置的现有属性。设置后，其他聊天室成员收到 `onAttributesUpdate` 回调。
+聊天室成员可以调用 `setChatroomAttributes` 方法设置或更新单个聊天室自定义属性。该方法只可添加新自定义属性字段和更新自己设置的现有属性。设置后，其他聊天室成员收到 `onAttributesUpdate` 回调。
 
 示例代码如下：
 

diff --git a/docs/document/ios/conversation_list.md b/docs/document/ios/conversation_list.md
@@ -28,6 +28,8 @@
 
 你可以调用 `IEMChatManager#getConversationsFromServerWithCursor:pageSize:completion` 方法从服务端分页获取会话列表，包含单聊和群组聊天会话，不包含聊天室会话。SDK 按照会话活跃时间（会话的最新一条消息的时间戳）的倒序返回会话列表，每个会话对象中包含会话 ID、会话类型、是否为置顶状态、置顶时间（对于未置顶的会话，值为 `0`）以及最新一条消息。从服务端拉取会话列表后会更新本地会话列表。
 
+服务器默认存储 100 条会话。超过该限制后，新会话会覆盖旧会话。若会话中的历史消息均过期，会话变成空会话。默认拉取会话列表时不包含这些空会话，若要包含，需在 SDK 初始化时将 `EMOptions#loadEmptyConversations` 设置为 `YES`。这种情况下，空会话都会占用会话拉取名额，不管拉取时是否需要。如果拉取会话时不需要空会话且不希望其占用会话列表名额，需要联系商务开通。
+
 :::tip
 1. **若使用该功能，需在环信控制台开通该功能，并将 SDK 升级至 4.0.3。只有开通该功能，你才能使用置顶会话和会话标记功能。** 
 2. 建议你在首次下载、卸载后重装应用等本地数据库无数据情况下拉取服务端会话列表。其他情况下，调用 `filterConversationsFromDB`、`getAllConversations:` 或 `getAllConversations` 方法获取本地所有会话即可。

diff --git a/docs/document/ios/room_attributes.md b/docs/document/ios/room_attributes.md
@@ -12,8 +12,8 @@
 
 - 获取和更新聊天室基本属性；
 - 获取聊天室自定义属性；
-- 设置和强制设置聊天室自定义属性；
-- 删除和强制删除聊天室自定义属性。
+- 设置和更新/强制设置和更新聊天室自定义属性；
+- 删除/强制删除聊天室自定义属性。
 
 ## 前提条件
 
@@ -108,7 +108,7 @@ EMError *error = nil;
             }];
 ```
 
-#### 设置单个聊天室属性
+#### 设置/设置单个聊天室属性
 
 聊天室成员可以调用 `setChatroomAttributes` 方法设置和更新单个聊天室自定义属性。该方法只可添加新自定义属性字段和更新自己设置的现有属性。设置后，其他聊天室成员收到 `EMChatRoomManagerDelegate` 中的 `chatroomAttributesDidUpdated` 回调。
 
@@ -121,7 +121,7 @@ EMError *error = nil;
                 }];
 ```
 
-#### 强制设置单个聊天室属性
+#### 强制设置/更新单个聊天室属性
 
 如果除了设置自己的单个自定义属性还需覆盖其他聊天室成员设置的该属性，需调用 `setChatroomAttributesForced` 方法。设置成功后，其他聊天室成员收到 `EMChatRoomManagerDelegate` 中的 `chatroomAttributesDidUpdated` 回调。
 
@@ -134,7 +134,7 @@ EMError *error = nil;
                 }];
 ```
 
-#### 设置多个聊天室自定义属性
+#### 设置/更新多个聊天室自定义属性
 
 聊天室成员可以调用 `setChatroomAttributes` 方法设置多个聊天室自定义属性。该方法只能添加新属性字段以及更新当前用户已添加的属性字段。设置成功后，其他聊天室成员收到 `EMChatRoomManagerDelegate` 中的 `chatroomAttributesDidUpdated` 回调。
 
@@ -147,7 +147,7 @@ EMError *error = nil;
                 }];
 ```
 
-#### 强制设置多个聊天室属性
+#### 强制设置/更新多个聊天室属性
 
 如果除了设置自己的多个自定义属性还需覆盖其他聊天室成员设置的这些属性，需调用 `setChatroomAttributesForced` 方法。设置成功后，其他聊天室成员收到 `EMChatRoomManagerDelegate` 中的 `chatroomAttributesDidUpdated` 回调。
 

diff --git a/docs/document/react-native/conversation_list.md b/docs/document/react-native/conversation_list.md
@@ -26,6 +26,8 @@
 
 你可以调用 `fetchConversationsFromServerWithCursor` 方法从服务端分页获取会话列表，包含单聊和群组聊天会话，不包含聊天室会话。SDK 按照会话活跃时间（会话的最新一条消息的时间戳）的倒序返回会话列表，每个会话对象中包含会话 ID、会话类型、是否为置顶状态、置顶时间（对于未置顶的会话，值为 `0`）、会话标记以及最新一条消息。从服务端拉取会话列表后会更新本地会话列表。
 
+服务器默认存储 100 条会话。超过该限制后，新会话会覆盖旧会话。若会话中的历史消息均过期，会话变成空会话。默认拉取会话列表时不包含这些空会话，若要包含，需在 SDK 初始化时将 `ChatOptions#enableEmptyConversation` 设置为 `true`。这种情况下，空会话都会占用会话拉取名额，不管拉取时是否需要。如果拉取会话时不需要空会话且不希望其占用会话列表名额，需要联系商务开通。
+
 :::tip
 1. **若使用该功能，需在环信控制台开通，并将 SDK 升级至 1.2.0 或以上版本。而且，只有开通该功能，你才能使用置顶会话功能。**
 2. 建议你在首次下载、卸载后重装应用等本地数据库无数据情况下拉取服务端会话列表。其他情况下，调用 `getAllConversations` 方法获取本地所有会话即可。

diff --git a/docs/document/react-native/room_attributes.md b/docs/document/react-native/room_attributes.md
@@ -12,8 +12,8 @@
 
 - 获取和更新聊天室基本属性；
 - 获取聊天室自定义属性；
-- 设置聊天室自定义属性；
-- 删除聊天室自定义属性。
+- 设置和更新/强制设置和更新聊天室自定义属性；
+- 删除/强制删除聊天室自定义属性。
 
 ## 前提条件
 
@@ -116,9 +116,9 @@ ChatClient.getInstance()
   });
 ```
 
-#### 设置聊天室自定义属性
+#### 设置/更新聊天室自定义属性
 
-所有聊天室成员均可调用 `addAttributes` 方法设置一个或多个聊天室自定义属性。利用该方法可设置新属性，也可以修改自己或其他成员设置的现有属性。设置后，其他聊天室成员收到  `onAttributesUpdated` 回调。
+所有聊天室成员均可调用 `addAttributes` 方法设置或更新一个或多个聊天室自定义属性。利用该方法可设置新属性，也可以修改自己或其他成员设置的现有属性。设置后，其他聊天室成员收到  `onAttributesUpdated` 回调。
 
 ```typescript
 // 通过指定聊天室 ID、属性 key、属性值、deleteWhenLeft 和 overwrite 设置自定义属性。

diff --git a/docs/document/unity/conversation_list.md b/docs/document/unity/conversation_list.md
@@ -29,6 +29,8 @@
 - 若 `pinOnly` 为 `false`，获取包括置顶和未置顶会话的列表。SDK 按照会话活跃时间（会话的最新一条消息的时间戳）的倒序返回会话列表，每个会话对象中包含会话 ID、会话类型、是否为置顶状态、置顶时间（对于未置顶的会话，值为 `0`）以及最新一条消息。从服务端拉取会话列表后会更新本地会话列表。
 - 若为 `true` 仅获取置顶会话列表，最多可拉取 50 个置顶会话。SDK 按照会话置顶时间的倒序返回。
 
+服务器默认存储 100 条会话。超过该限制后，新会话会覆盖旧会话。若会话中的历史消息均过期，会话变成空会话。默认拉取会话列表时不包含这些空会话，若要包含，需在 SDK 初始化时将 `Options#EnableEmptyConversation` 设置为 `true`。这种情况下，空会话都会占用会话拉取名额，不管拉取时是否需要。如果拉取会话时不需要空会话且不希望其占用会话列表名额，需要联系商务开通。
+
 :::tip
 1. 若使用该方法，需将 SDK 升级至 V1.2.0 或以上版本。
 2. 建议你在首次下载、卸载后重装应用等本地数据库无数据情况下拉取服务端会话列表。其他情况下，调用 `LoadAllConversations` 方法获取本地所有会话即可。

diff --git a/docs/document/unity/room_attributes.md b/docs/document/unity/room_attributes.md
@@ -12,8 +12,8 @@
 
 - 获取和更新聊天室基本属性；
 - 获取聊天室自定义属性；
-- 设置聊天室自定义属性；
-- 删除聊天室自定义属性。
+- 设置和更新/强制设置和更新聊天室自定义属性；
+- 删除/强制删除聊天室自定义属性。
 
 ## 前提条件
 
@@ -114,9 +114,9 @@ SDKClient.Instance.RoomManager.FetchAttributes(roomId, keys, new ValueCallBack<D
 ));
 ```
 
-#### 设置聊天室自定义属性
+#### 设置/更新聊天室自定义属性
 
-所有聊天室成员均可调用 `AddAttributes` 方法设置一个或多个聊天室自定义属性。利用该方法可设置新属性，也可以修改自己或其他成员设置的现有属性。设置后，其他聊天室成员收到 `OnChatroomAttributesChanged` 回调。
+所有聊天室成员均可调用 `AddAttributes` 方法设置或更新一个或多个聊天室自定义属性。利用该方法可设置新属性，也可以修改自己或其他成员设置的现有属性。设置后，其他聊天室成员收到 `OnChatroomAttributesChanged` 回调。
 
 示例代码如下：
 

diff --git a/docs/document/web/room_attributes.md b/docs/document/web/room_attributes.md
@@ -12,8 +12,8 @@
 
 - 获取和更新聊天室基本属性；
 - 获取聊天室自定义属性；
-- 设置聊天室自定义属性；
-- 删除聊天室自定义属性。
+- 设置和更新/强制设置和更新聊天室自定义属性；
+- 删除/强制删除聊天室自定义属性。
 
 ## 前提条件
 
@@ -90,7 +90,7 @@ let option = {
 conn.getChatRoomAttributes(option).then((res) => console.log(res));
 ```
 
-#### 设置单个聊天室自定义属性
+#### 设置/更新单个聊天室自定义属性
 
 聊天室成员均可通过调用 `setChatRoomAttribute` 设置和更新单个自定义属性。设置后，其他聊天室成员收到 `onChatroomEvent` 回调，事件为 `updateChatRoomAttributes`。
 
@@ -105,7 +105,7 @@ let option = {
 conn.setChatRoomAttribute(option).then((res) => console.log(res));
 ```
 
-#### 设置多个聊天室自定义属性
+#### 设置/更新多个聊天室自定义属性
 
 聊天室成员均可以调用 `setChatRoomAttributes` 批量设置自定义属性。设置后，其他聊天室成员收到 `onChatroomEvent` 回调，事件为 `updateChatRoomAttributes`。
 

diff --git a/docs/document/windows/conversation_list.md b/docs/document/windows/conversation_list.md
@@ -29,6 +29,8 @@
 - 若 `pinOnly` 为 `false`，获取包括置顶和未置顶会话的列表。SDK 按照会话活跃时间（会话的最新一条消息的时间戳）的倒序返回会话列表，每个会话对象中包含会话 ID、会话类型、是否为置顶状态、置顶时间（对于未置顶的会话，值为 `0`）以及最新一条消息。从服务端拉取会话列表后会更新本地会话列表。
 - 若为 `true` 仅获取置顶会话列表，最多可拉取 50 个置顶会话。SDK 按照会话置顶时间的倒序返回。
 
+服务器默认存储 100 条会话。超过该限制后，新会话会覆盖旧会话。若会话中的历史消息均过期，会话变成空会话。默认拉取会话列表时不包含这些空会话，若要包含，需在 SDK 初始化时将 `Options#EnableEmptyConversation` 设置为 `true`。这种情况下，空会话都会占用会话拉取名额，不管拉取时是否需要。如果拉取会话时不需要空会话且不希望其占用会话列表名额，需要联系商务开通。
+
 :::tip
 1. 若使用该方法，需将 SDK 升级至 1.2.0 或以上版本。
 2. 建议你在首次下载、卸载后重装应用等本地数据库无数据情况下拉取服务端会话列表。其他情况下，调用 `LoadAllConversations` 方法获取本地所有会话即可。

diff --git a/docs/document/windows/room_attributes.md b/docs/document/windows/room_attributes.md
@@ -12,8 +12,8 @@
 
 - 获取和更新聊天室基本属性；
 - 获取聊天室自定义属性；
-- 设置聊天室自定义属性；
-- 删除聊天室自定义属性。
+- 设置和更新/强制设置和更新聊天室自定义属性；
+- 删除/强制删除聊天室自定义属性。
 
 ## 前提条件
 
@@ -114,9 +114,9 @@ SDKClient.Instance.RoomManager.FetchAttributes(roomId, keys, new ValueCallBack<D
 ));
 ```
 
-#### 设置聊天室自定义属性
+#### 设置/更新聊天室自定义属性
 
-所有聊天室成员均可调用 `AddAttributes` 方法设置一个或多个聊天室自定义属性。利用该方法可设置新属性，也可以修改自己或其他成员设置的现有属性。设置后，其他聊天室成员收到 `OnChatroomAttributesChanged` 回调。
+所有聊天室成员均可调用 `AddAttributes` 方法设置或更新一个或多个聊天室自定义属性。利用该方法可设置新属性，也可以修改自己或其他成员设置的现有属性。设置后，其他聊天室成员收到 `OnChatroomAttributesChanged` 回调。
 
 示例代码如下：