Skip to content

Commit 85a40f6

Browse files
authored
Merge pull request #1291 from haoxiuwen/doc-v2
Optimize Product Docs
2 parents 30d0af9 + 8243f4b commit 85a40f6

File tree

79 files changed

+1984
-632
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+1984
-632
lines changed

docs/.vuepress/sidebar/index.ts

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,13 @@ export const zhSidebar = sidebar({
2828
children: [
2929
{ text: "产品概述", link: "introduction.html" },
3030
{ text: "应用场景", link: "application_scenario.html" },
31-
{ text: "功能介绍", link: "product_function.html" },
31+
{ text: "功能介绍",
32+
collapsible: true,
33+
children: [
34+
{ text: "功能列表", link: "product_function.html" },
35+
{ text: "功能详情", link: "conversation_function.html" },
36+
],
37+
},
3238
{ text: "账号系统",
3339
collapsible: true,
3440
children: [
@@ -43,15 +49,18 @@ export const zhSidebar = sidebar({
4349
{ text: "用户关系", link: "product_user_relationship.html" },
4450
],
4551
},
46-
{ text: "消息",
52+
{ text: "消息管理",
4753
collapsible: true,
4854
children: [
49-
{ text: "消息概述", link: "product_message_overview.html" },
55+
{ text: "单聊消息", link: "message_single_chat.html" },
56+
{ text: "群组消息", link: "message_group.html" },
57+
{ text: "聊天室消息", link: "message_chatroom.html" },
58+
{ text: "消息存储", link: "message_store.html" },
5059
{ text: "消息格式", link: "product_message_format.html" },
5160
],
5261
},
5362
{ text: "离线推送", link: "product_offline_push_overview.html" },
54-
{ text: "群组",
63+
{ text: "群组管理",
5564
collapsible: true,
5665
children: [
5766
{ text: "群组概述", link: "product_group_overview.html" },
@@ -75,10 +84,12 @@ export const zhSidebar = sidebar({
7584
},
7685
],
7786
},
78-
{ text: "计费说明",
87+
{ text: "购买指南",
7988
collapsible: true,
8089
children: [
81-
{ text: "计费说明", link: "pricing.html"},
90+
{ text: "计费策略", link: "pricing_policy.html"},
91+
{ text: "套餐包功能对比", link: "product_package_feature.html"},
92+
{ text: "购买指引", link: "pricing_method.html" },
8293
],
8394
},
8495
{

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ tagline: false
66
products:
77
- link: "/product/introduction.html"
88
text: 产品概述
9-
- link: "/product/pricing.html"
9+
- link: "/product/pricing_policy.html"
1010
text: 产品价格
1111
- link: "/product/product_dynamics.html"
1212
text: 产品动态

docs/document/android/group_manage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ String cursor = result.getCursor();
215215

216216
### 查询当前用户已加入的群组数量
217217

218-
自 4.2.1 版本开始,你可以调用 `EMGroupManager#asyncGetJoinedGroupsCountFromServer` 方法从服务器获取当前用户已加入的群组数量。单个用户可加入群组数量的上限取决于订阅的即时通讯的套餐包,详见[产品价格](/product/pricing.html#套餐包功能详情)
218+
自 4.2.1 版本开始,你可以调用 `EMGroupManager#asyncGetJoinedGroupsCountFromServer` 方法从服务器获取当前用户已加入的群组数量。单个用户可加入群组数量的上限取决于订阅的即时通讯的套餐包,详见 [计费策略](/product/pricing_policy.html#增值服务费用)
219219

220220
```java
221221
EMClient.getInstance().groupManager().asyncGetJoinedGroupsCountFromServer(new EMValueCallBack<Integer>() {

docs/document/android/message_receipt.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**单聊会话支持消息送达回执和消息已读回执**,发送方发送消息后可及时了解接收方是否及时收到并阅读了消息。
66

7-
**群聊会话只支持消息已读回执,不支持送达回执**。群成员在发送消息时,可以设置该消息是否需要已读回执。要使用该功能,你需要[在环信即时通讯云控制台上开通该功能](/product/enable_and_configure_IM.html#设置群消息已读回执),具体费用详见[产品价格](/product/pricing.html#增值服务费用)
7+
**群聊会话只支持消息已读回执,不支持送达回执**。群成员在发送消息时,可以设置该消息是否需要已读回执。要使用该功能,你需要 [在环信即时通讯云控制台上开通该功能](/product/enable_and_configure_IM.html#设置群消息已读回执),具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)
88

99
消息送达回执和已读回执的效果示例,如下图所示:
1010

@@ -38,7 +38,7 @@
3838

3939
- 完成 SDK 初始化,并连接到服务器,详见 [快速开始](quickstart.html)
4040
- 了解环信即时通讯 IM 的使用限制,详见 [使用限制](/product/limitation.html)
41-
- 要使用群消息已读回执功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通,具体费用详见[产品价格](/product/pricing.html#增值服务费用)
41+
- 要使用群消息已读回执功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通,具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)
4242

4343
## 实现方法
4444

@@ -76,7 +76,7 @@ EMClient.getInstance().chatManager().removeMessageListener(msgListener);
7676

7777
单聊既支持单条消息已读回执,也支持[会话已读回执](conversation_receipt.html)。我们建议你结合使用这两种回执,见实现步骤的描述。
7878

79-
单聊消息的已读回执有效期与消息在服务端的存储时间一致,即在服务器存储消息期间均可发送已读回执。消息在服务端的存储时间与你订阅的套餐包有关,详见[产品价格](/product/pricing.html#套餐包功能详情)
79+
单聊消息的已读回执有效期与消息在服务端的存储时间一致,即在服务器存储消息期间均可发送已读回执。消息在服务端的存储时间与你订阅的套餐包有关,详见 [IM 套餐包功能对比](/product/product_package_feature.html)
8080

8181
参考如下步骤在单聊中实现消息已读回执。
8282

@@ -170,7 +170,7 @@ EMClient.getInstance().chatManager().removeMessageListener(msgListener);
170170

171171
| 使用限制| 默认 | 描述 |
172172
| :--------- | :----- | :------- |
173-
| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **功能配置** > **功能配置总览**> **基础功能**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见[产品价格](/product/pricing.html#增值服务费用)|
173+
| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **功能配置** > **功能配置总览**> **基础功能**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)|
174174
| 使用权限 | 所有群成员 | 默认情况下,所有群成员发送消息时可要求已读回执。如果仅需群主和群管理员发消息时要求已读回执,可联系商务修改。 |
175175
| 已读回执有效期 | 3 天 | 群聊已读回执的有效期为 3 天,即群组中的消息发送时间超过 3 天,服务器不记录阅读该条消息的群组成员,也不会发送已读回执。 |
176176
| 群规模 | 200 人 | 该特性最大支持 200 人的群组。如果超过 200 人/群,群成员发送的消息不会返回已读回执。你可以联系商务提升群成员人数上限。 |

docs/document/android/message_retrieve.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
1. 若使用该 API,需将 SDK 版本升级至 V4.0.2 版本或以上。
5050
2. **默认可获取单聊和群组聊天的历史消息。若要获取聊天室的历史消息,需升级至 4.5.0 版本,并联系环信商务。**
5151
3. 对于单聊消息,自 4.11.0 版本开始,从服务器拉取历史消息时会读取服务端的消息已读和送达状态。该功能默认关闭,如果需要,请联系环信商务开通。
52-
4. 历史消息在服务器上的存储时间与产品的套餐包相关,详见[产品套餐包详情](/product/pricing.html#套餐包功能详情)
52+
4. 历史消息在服务器上的存储时间与产品的套餐包相关,详见 [IM 套餐包功能对比](/product/product_package_feature.html)
5353
:::
5454

5555
```java

docs/document/android/message_send_receive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
- 对于群组和聊天室,用户每次只能向所属的单个群组和聊天室发送消息。
88

9-
单聊、群组聊天和聊天室的消息发送控制,详见[消息发送控制](/product/product_message_overview.html#消息发送控制)文档
9+
关于消息发送控制,详见 [单聊](/product/message_single_chat.html#单聊消息发送控制)[群组聊天](/product/message_group.html#群组消息发送控制)[聊天室](/product/message_chatroom.html#聊天室消息发送控制) 的 相关文档
1010

1111
## 前提条件
1212

docs/document/applet/message_send_receive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
- 对于群组和聊天室,用户每次只能向所属的单个群组和聊天室发送消息。
1010

11-
单聊、群组聊天和聊天室的消息发送控制,详见[消息发送控制](/product/product_message_overview.html#消息发送控制)文档
11+
关于消息发送控制,详见 [单聊](/product/message_single_chat.html#单聊消息发送控制)[群组聊天](/product/message_group.html#群组消息发送控制)[聊天室](/product/message_chatroom.html#聊天室消息发送控制) 的 相关文档
1212

1313
## 前提条件
1414

docs/document/flutter/group_manage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ try {
229229

230230
### 查询当前用户已加入的群组数量
231231

232-
自 4.2.0 版本开始,你可以调用 `EMGroupManager#fetchJoinedGroupCount` 方法从服务器获取当前用户已加入的群组数量。单个用户可加入群组数量的上限取决于订阅的即时通讯的套餐包,详见[产品价格](/product/pricing.html#套餐包功能详情)
232+
自 4.2.0 版本开始,你可以调用 `EMGroupManager#fetchJoinedGroupCount` 方法从服务器获取当前用户已加入的群组数量。单个用户可加入群组数量的上限取决于订阅的即时通讯的套餐包,详见 [IM 套餐包功能对比](/product/product_package_feature.html)
233233

234234
```dart
235235
void fetchJoinedGroupCount() async {

docs/document/flutter/message_receipt.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**单聊会话支持消息送达回执和消息已读回执**,发送方发送消息后可及时了解接收方是否及时收到并阅读了消息。
66

7-
**群聊会话只支持消息已读回执,不支持送达回执**。群成员在发送消息时,可以设置该消息是否需要已读回执。要使用该功能,你需要[在环信即时通讯云控制台上开通该功能](/product/enable_and_configure_IM.html#设置群消息已读回执),具体费用详见[产品价格](/product/pricing.html#增值服务费用)
7+
**群聊会话只支持消息已读回执,不支持送达回执**。群成员在发送消息时,可以设置该消息是否需要已读回执。要使用该功能,你需要[在环信即时通讯云控制台上开通该功能](/product/enable_and_configure_IM.html#设置群消息已读回执),具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)
88

99
消息送达回执和已读回执的效果示例,如下图所示:
1010

@@ -38,7 +38,7 @@
3838

3939
- 完成 SDK 初始化,并连接到服务器,详见 [快速开始](quickstart.html)
4040
- 了解环信即时通讯 IM 的使用限制,详见 [使用限制](/product/limitation.html)
41-
- 要使用群消息已读回执功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通,具体费用详见[产品价格](/product/pricing.html#增值服务费用)
41+
- 要使用群消息已读回执功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通,具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)
4242

4343
## 实现方法
4444

@@ -71,7 +71,7 @@
7171

7272
单聊既支持单条消息已读回执,也支持[会话已读回执](conversation_receipt.html)。我们建议你结合使用这两种回执,见实现步骤的描述。
7373

74-
单聊消息的已读回执有效期与消息在服务端的存储时间一致,即在服务器存储消息期间均可发送已读回执。消息在服务端的存储时间与你订阅的套餐包有关,详见[产品价格](/product/pricing.html#套餐包功能详情)
74+
单聊消息的已读回执有效期与消息在服务端的存储时间一致,即在服务器存储消息期间均可发送已读回执。消息在服务端的存储时间与你订阅的套餐包有关,详见 [IM 套餐包功能对比](/product/product_package_feature.html)
7575

7676
参考如下步骤在单聊中实现消息已读回执。
7777

@@ -128,7 +128,7 @@ EMClient.getInstance.chatManager.addEventHandler(
128128

129129
| 使用限制| 默认 | 描述 |
130130
| :--------- | :----- | :------- |
131-
| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **功能配置** > **功能配置总览**> **基础功能**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见[产品价格](/product/pricing.html#增值服务费用)|
131+
| 功能开通 | 关闭 | 若要使用该功能,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **功能配置** > **功能配置总览**> **基础功能**页签下,搜索找到 **消息已读回执(群聊)** 开通功能。具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)|
132132
| 使用权限 | 所有群成员 | 默认情况下,所有群成员发送消息时可要求已读回执。如果仅需群主和群管理员发消息时要求已读回执,可联系商务修改。 |
133133
| 已读回执有效期 | 3 天 | 群聊已读回执的有效期为 3 天,即群组中的消息发送时间超过 3 天,服务器不记录阅读该条消息的群组成员,也不会发送已读回执。 |
134134
| 群规模 | 200 人 | 该特性最大支持 200 人的群组。如果超过 200 人/群,群成员发送的消息不会返回已读回执。你可以联系商务提升群成员人数上限。 |

docs/document/flutter/message_retrieve.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
:::tip
4444
1. 若使用该 API,需将 SDK 版本升级至 V4.0.2 版本或以上。
4545
2. **默认可获取单聊和群组聊天的历史消息。若要获取聊天室的历史消息,需升级至 4.5.0 版本,并联系环信商务。**
46-
3. 历史消息在服务器上的存储时间与产品的套餐包相关,详见[产品套餐包详情](/product/pricing.html#套餐包功能详情)
46+
3. 历史消息在服务器上的存储时间与产品的套餐包相关,详见 [IM 套餐包功能对比](/product/product_package_feature.html)
4747
:::
4848

4949
```dart

docs/document/flutter/message_send_receive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
- 对于群组和聊天室,用户每次只能向所属的单个群组和聊天室发送消息。
88

9-
单聊、群组聊天和聊天室的消息发送控制,详见[消息发送控制](/product/product_message_overview.html#消息发送控制)文档
9+
关于消息发送控制,详见 [单聊](/product/message_single_chat.html#单聊消息发送控制)[群组聊天](/product/message_group.html#群组消息发送控制)[聊天室](/product/message_chatroom.html#聊天室消息发送控制) 的 相关文档
1010

1111
## 前提条件
1212

docs/document/harmonyos/group_manage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ if (result) {
179179

180180
### 查询当前用户已加入的群组数量
181181

182-
你可以调用 `GroupManager#fetchJoinedGroupsCount` 方法从服务器获取当前用户已加入的群组数量。单个用户可加入群组数量的上限取决于订阅的即时通讯的套餐包,详见[产品价格](/product/pricing.html#套餐包功能详情)
182+
你可以调用 `GroupManager#fetchJoinedGroupsCount` 方法从服务器获取当前用户已加入的群组数量。单个用户可加入群组数量的上限取决于订阅的即时通讯的套餐包,详见 [IM 套餐包功能对比](/product/product_package_feature.html)
183183

184184
```typescript
185185
ChatClient.getInstance().groupManager()?.fetchJoinedGroupsCount().then(res => console.log(res.toString()));

docs/document/harmonyos/group_members.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
- 完成 SDK 初始化,详见 [快速开始](quickstart.html)
2323
- 了解环信即时通讯 IM 的使用限制,详见 [使用限制](/product/limitation.html)
2424
- 了解群成员角色,详见 [群组概述](group_overview.html#群组成员角色)
25-
- 了解群组和群成员的数量限制,详见 [套餐包详情](/product/pricing.html#套餐包功能详情)
25+
- 了解群组和群成员的数量限制,详见 [IM 套餐包功能对比](/product/product_package_feature.html)
2626

2727
## 实现方法
2828

0 commit comments

Comments
 (0)