Skip to content

Commit 6f3fe1c

Browse files
authored
Merge pull request #1436 from haoxiuwen/doc-v2
Add Function Activation Description on Console for SDK and REST Docs
2 parents cdbb67f + 240960f commit 6f3fe1c

Some content is hidden

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

70 files changed

+180
-138
lines changed

docs/document/android/conversation_list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
对于每个终端用户,服务器默认存储 100 条会话。超过该限制后,新会话会覆盖旧会话。若会话中的历史消息均过期,会话变成空会话。从服务端拉取会话列表时默认不包含这些空会话,若要包含,需在 SDK 初始化时将 `EMOptions#isLoadEmptyConversations` 设置为 `true`。这种情况下,空会话都会占用会话拉取名额,不管拉取时是否需要。如果拉取会话时不需要空会话且不希望其占用会话列表名额,需要联系商务开通。
3232

3333
:::tip
34-
1. **若使用该功能,需在环信控制台开通,并将 SDK 升级至 4.0.3。而且,只有开通该功能,你才能使用置顶会话和会话标记功能。**
34+
1. **若使用该功能,[在环信控制台开通](/product/console/basic_conversation_group_chatroom.html#服务端会话列表),并将 SDK 升级至 4.0.3。而且,只有开通该功能,你才能使用置顶会话和会话标记功能。**
3535
2. 建议你在首次下载、卸载后重装应用等本地数据库无数据情况下拉取服务端会话列表。其他情况下,调用 `asyncFilterConversationsFromDB``getAllConversationsBySort``getAllConversations` 方法获取本地所有会话即可。
3636
3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送,获取会话列表时,该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能,需在[环信即时通讯控制台开通](/product/enable_and_configure_IM.html#设置通过-restful-api-发送的消息写入会话列表)
3737
:::

docs/document/android/message_receipt.md

Lines changed: 2 additions & 2 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_policy.html#增值服务费用)
7+
**群聊会话只支持消息已读回执,不支持送达回执**。群成员在发送消息时,可以设置该消息是否需要已读回执。要使用该功能,你需要 [在环信控制台上开通该功能](/product/console/basic_message.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_policy.html#增值服务费用)
41+
- 要使用群消息已读回执功能,需在 [环信控制台](https://console.easemob.com/user/login) 开通,具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)
4242

4343
## 实现方法
4444

docs/document/android/multi_device.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<Toc />
44

5-
即时通讯 IM 支持同一账号在多个设备上登录,使用该服务前,你需要在[环信即时通讯控制台](https://console.easemob.com/user/login)**即时通讯** > **功能配置** > **功能配置总览** > **基础功能** 页面上查找**多端多设备在线**,开启该功能
5+
即时通讯 IM 支持同一账号在多个设备上登录。使用该功能前,你需要在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#多端多设备)
66

77
多端多设备登录场景下,所有已登录的设备同步以下信息和操作:
88

@@ -11,7 +11,7 @@
1111
- 子区相关操作;
1212
- 会话相关操作。
1313

14-
多端登录时,即时通讯 IM 每端默认最多支持 4 个设备同时在线。如需增加支持的设备数量,可以联系环信即时通讯 IM 的商务经理。你可以在环信控制台的**基础功能**页签下点击**多端多设备在线**操作栏中的**设置**,在弹出的对话框中设置各端设备的数量:
14+
多端登录时,即时通讯 IM 每端默认最多支持 4 个设备同时在线。如需增加支持的设备数量,可以联系环信即时通讯 IM 的商务经理。你可以在环信控制台的 **基础功能** 页签下点击**多端多设备在线**操作栏中的**设置**,在弹出的对话框中设置各端设备的数量:
1515

1616
![img](/images/common/multidevice_device_count.png)
1717

@@ -53,9 +53,9 @@ Android SDK 初始化时会生成登录 ID 用于在多设备登录和消息推
5353

5454
## 前提条件
5555

56-
开始前,确保将 SDK 初始化,连接到服务器。详见[快速开始](quickstart.html)
57-
58-
设置登录设备的自定义名称和平台需在 SDK 初始化时中完成。
56+
- 开始前,确保将 SDK 初始化,连接到服务器。详见[快速开始](quickstart.html)
57+
- 已在 [环信控制台](https://console.easemob.com/user/login) 开通多端多设备功能。详见 [环信控制台文档](/product/console/basic_user.html#多端多设备)
58+
- 设置登录设备的自定义名称和平台需在 SDK 初始化时中完成。
5959

6060
## 实现方法
6161

docs/document/android/presence.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<Toc />
44

5-
用户在线状态(即 Presence)包含用户的在线、离线以及自定义状态。
5+
用户在线状态(即 Presence)包含用户的在线、离线以及自定义状态。使用该功能前,你需要在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#用户离在线状态实时同步)
66

77
本文介绍如何在即时通讯应用中发布、订阅和查询用户的在线状态。
88

@@ -36,9 +36,9 @@
3636

3737
使用在线状态功能前,请确保满足以下条件:
3838

39-
1. 完成 `3.9.1 或以上版本` SDK 初始化,详见 [快速开始](quickstart.html)
39+
1. 完成 3.9.1 或以上版本 SDK 初始化,详见 [快速开始](quickstart.html)
4040
2. 了解环信即时通讯 IM API 的 [使用限制](/product/limitation.html)
41-
3. 已在[环信控制台](https://console.easemob.com/user/login)开通在线状态订阅功能。
41+
3. 已在[环信控制台](https://console.easemob.com/user/login)开通在线状态订阅功能。详见 [环信控制台文档](/product/console/basic_user.html#用户离在线状态实时同步)
4242

4343
## 实现方法
4444

docs/document/android/thread.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22

33
<Toc />
44

5-
子区是群组成员的子集,是支持多人沟通的即时通讯系统。本文介绍如何使用环信即时通讯 IM Android SDK 在实时互动 app 中创建和管理子区,并实现子区相关功能
5+
子区是群组成员的子集,是支持多人沟通的即时通讯系统。使用子区功能前,你需要在 [环信控制台](https://console.easemob.com/user/login) 开通。详见 [环信控制台文档](/product/console/basic_conversation_group_chatroom.html#消息话题)
66

7-
使用子区功能前,你需要在[环信即时通讯控制台](https://console.easemob.com/user/login)开通。
8-
9-
如需查看消息相关内容,参见 [子区消息管理](thread_message.html)
7+
本文介绍如何使用环信即时通讯 IM Android SDK 在实时互动 app 中创建和管理子区,并实现子区相关功能。如需查看消息相关内容,参见 [子区消息管理](thread_message.html)
108

119
## 技术原理
1210

@@ -28,7 +26,7 @@
2826
- 完成 3.9.3 或以上版本 SDK 初始化,详见 [快速开始](quickstart.html)
2927
- 了解环信即时通讯 IM API 的 [使用限制](/product/limitation.html)
3028
- 了解子区和子区成员数量限制,详见 [使用限制](/product/limitation.html)
31-
- 已在[环信即时通讯控制台](https://console.easemob.com/user/login)开通子区功能。
29+
- 已在 [环信控制台](https://console.easemob.com/user/login) 开通子区功能。详见 [环信控制台文档](/product/console/basic_conversation_group_chatroom.html#消息话题)
3230

3331
## 实现方法
3432

docs/document/android/thread_message.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
<Toc />
44

5-
子区消息消息类型属于群聊消息类型,与普通群组消息的区别是需要添加 `isChatThreadMessage` 标记。本文介绍环信即时通讯 IM Android SDK 如何发送、接收以及撤回子区消息
5+
子区消息消息类型属于群聊消息类型,与普通群组消息的区别是需要添加 `isChatThreadMessage` 标记。使用子区消息功能前,你需要在 [环信控制台](https://console.easemob.com/user/login)开通。详见 [环信控制台文档](/product/console/basic_conversation_group_chatroom.html#消息话题)
66

7-
使用子区功能前,你需要在[环信即时通讯控制台](https://console.easemob.com/user/login)开通
7+
本文介绍环信即时通讯 IM Android SDK 如何发送、接收以及撤回子区消息
88

99
## 技术原理
1010

@@ -25,7 +25,7 @@
2525
- 已集成环信 IM 3.9.3 或以上版本的基本功能,账户登录成功。
2626
- 完成 SDK 初始化,详见 [快速开始](quickstart.html)
2727
- 了解环信即时通讯 IM 的使用限制,详见 [使用限制](/product/limitation.html)
28-
- 已在[环信即时通讯控制台](https://console.easemob.com/user/login)开通子区功能。
28+
- 已在[环信控制台](https://console.easemob.com/user/login)开通子区功能。详见 [环信控制台文档](/product/console/basic_conversation_group_chatroom.html#消息话题)
2929

3030
## 实现方法
3131

docs/document/android/user_relationship.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
SDK 提供用户关系管理功能,包括好友列表管理和黑名单管理:
66

77
- 好友列表管理:查询好友列表、请求添加好友、接受好友请求、拒绝好友请求、删除好友和设置好友备注等操作。
8-
- 黑名单管理:查询黑名单列表、添加用户至黑名单以及将用户移除黑名单等操作。
8+
- 黑名单管理:查询黑名单列表、添加用户至黑名单以及将用户移除黑名单等操作。使用该功能前,你需要在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#用户黑名单)
99

10-
此外,环信即时通讯 IM 默认支持陌生人之间发送单聊消息,即无需添加好友即可聊天。若仅允许好友之间发送单聊消息,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。该功能开启后,SDK 会在用户发起单聊时检查好友关系,若用户向陌生人发送单聊消息,SDK 会提示错误码 221。
10+
此外,环信即时通讯 IM 默认支持陌生人之间发送单聊消息,即无需添加好友即可聊天。若仅允许好友之间发送单聊消息,你需要在[环信控制台](https://console.easemob.com/user/login)[开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)。该功能开启后,SDK 会在用户发起单聊时检查好友关系,若用户向陌生人发送单聊消息,SDK 会提示错误码 221。
1111

1212
## 技术原理
1313

@@ -26,6 +26,7 @@ SDK 提供用户关系管理功能,包括好友列表管理和黑名单管理
2626

2727
- 完成 SDK 初始化,并连接到服务器,详见 [快速开始](quickstart.html)
2828
- 了解环信即时通讯 IM 的使用限制,详见 [使用限制](/product/limitation.html)
29+
- 已在 [环信控制台](https://console.easemob.com/user/login) 开通黑名单功能。详见 [环信控制台文档](/product/console/basic_user.html#用户黑名单)
2930

3031
## 实现方法
3132

docs/document/flutter/conversation_list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
对于每个终端用户,服务器默认存储 100 条会话。超过该限制后,新会话会覆盖旧会话。若会话中的历史消息均过期,会话变成空会话。从服务端拉取会话列表时默认不包含这些空会话,若要包含,需在 SDK 初始化时将 `EMOptions#enableEmptyConversation` 设置为 `true`。这种情况下,空会话都会占用会话拉取名额,不管拉取时是否需要。如果拉取会话时不需要空会话且不希望其占用会话列表名额,需要联系商务开通。
3030

3131
:::tip
32-
1. **若使用该功能,需在环信控制台开通该功能,并将 SDK 升级至 V4.5.0 或以上版本。只有开通该功能,你才能使用置顶会话功能。**
32+
1. **若使用该功能,[在环信控制台开通](/product/console/basic_conversation_group_chatroom.html#服务端会话列表) ,并将 SDK 升级至 V4.5.0 或以上版本。只有开通该功能,你才能使用置顶会话功能。**
3333
2. 建议在 app 安装时或本地没有会话时调用该方法,否则调用 `loadAllConversations` 获取本地会话即可。
3434
3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送,获取会话列表时,该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能,需在[环信即时通讯控制台开通](/product/enable_and_configure_IM.html#设置通过-restful-api-发送的消息写入会话列表)
3535
:::

docs/document/flutter/message_receipt.md

Lines changed: 2 additions & 2 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_policy.html#增值服务费用)
7+
**群聊会话只支持消息已读回执,不支持送达回执**。群成员在发送消息时,可以设置该消息是否需要已读回执。要使用该功能,你需要 [在环信控制台上开通该功能](/product/console/basic_message.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_policy.html#增值服务费用)
41+
- 要使用群消息已读回执功能,需在 [环信控制台](https://console.easemob.com/user/login) 开通,具体费用详见 [计费策略](/product/pricing_policy.html#增值服务费用)
4242

4343
## 实现方法
4444

docs/document/flutter/multi_device.md

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

33
<Toc />
44

5-
即时通讯 IM 支持同一账号在多个设备上登录,使用该服务前,你需要在[环信即时通讯控制台](https://console.easemob.com/user/login)**即时通讯** > **功能配置** > **功能配置总览** > **基础功能** 页面上查找**多端多设备在线**,开启该功能
5+
即时通讯 IM 支持同一账号在多个设备上登录。使用该功能前,你需要在 [环信控制台](https://console.easemob.com/user/login) 开通该服务。详见 [环信控制台文档](/product/console/basic_user.html#多端多设备)
66

77
多端多设备登录场景下,所有已登录的设备同步以下信息和操作:
88

@@ -51,9 +51,9 @@ Android SDK 初始化时会生成登录 ID 用于在多设备登录和消息推
5151

5252
## 前提条件
5353

54-
开始前,确保将 SDK 初始化,连接到服务器。详见[快速开始](quickstart.html)
55-
56-
设置登录设备的自定义名称和平台需在 SDK 初始化时中完成。
54+
- 开始前,确保将 SDK 初始化,连接到服务器。详见[快速开始](quickstart.html)
55+
- 已在 [环信控制台](https://console.easemob.com/user/login) 开通多端多设备功能。详见 [环信控制台文档](/product/console/basic_user.html#多端多设备)
56+
- 设置登录设备的自定义名称和平台需在 SDK 初始化时中完成。
5757

5858
## 实现方法
5959

0 commit comments

Comments
 (0)