Merge pull request #1108 from haoxiuwen/doc-v2

Modify IM Docs

Author: haoxiuwen

docs/.vuepress/sidebar/document.ts

@@ -115,7 +115,7 @@ const documentSidebar = [
         children: [
           { text: '用户关系', link: 'user_relationship.html' },
           { text: '用户属性', link: 'userprofile.html' },
-          { text: '在线状态订阅', link: 'message_retrieve.html' },
+          { text: '在线状态订阅', link: 'presence.html' },
         ]
       },
       {

docs/product/limitation.md

@@ -1,37 +1,10 @@
-# 限制条件
+# 产品相关限制
 
 <Toc />
 
 本文简要介绍环信即时通讯 IM 的使用限制条件，包括调用频率、字符串大小和编码格式等。
 
-## 用户注册
-
-- 用户 ID：长度不能超过 64 字节，支持以下字符集：
-  - 26 个小写英文字母 a-z；
-  - 26 个大写英文字母 A-Z；
-  - 10 个数字 0-9；
-  - “_”, “-”, “.”。
-
-:::tip
-- 该参数不区分大小写，因此 Aa 和 aa 为相同用户名。
-- 请确保同一个 app 下，用户 ID 唯一。
-- 用户 ID 是会公开的信息，请勿使用 UUID、邮箱地址、手机号等敏感信息。
-:::
-
-- 密码：用户的登录密码，长度不可超过 64 个字符。
-
-## 用户属性
-
-- 默认单个用户的属性总长不得超过 2 KB。
-- 默认单个 app 下所有用户的属性总长度不得超过 10 GB。
-
-## 用户关系
-
-- 单个 App Key 下的每个用户的好友数量上限与套餐包版本相关，详见[套餐包功能详情](/product/pricing.html#套餐包功能详情)。
-- 好友备注的长度不能超过 100 个字符。
-- 每个用户的黑名单最多可存 500 个用户。
-
-## 消息
+## 消息相关
 
 ### 消息大小
 
@@ -56,6 +29,10 @@
 ### 消息存储
 
 - **历史消息**：在服务器上的存储时间与你订阅的套餐包有关，详见[产品价格](/product/pricing.html#套餐包功能详情)。
+- **聊天记录文件**：可从服务端获取用户的聊天记录文件。
+  - 单次请求获取从指定起始时间开始一小时内的发送的聊天记录文件。
+  - 你最多可以获取最近 3 天的聊天记录。若要提升该限制，你需要联系环信商务。
+  - 查询历史消息记录时存在一定延时，无法实时获取。
 - **消息附件/文件**：默认情况下，消息附件，例如图片、音频、视频和其他文件可存储 7 天。若要提升其中一个上限，请联系商务。消息附件的大小及存储时间限制与群组共享文件的相同。如果消息附件的其中一个限制进行了上调，群组共享文件的对应限制也会随之自动调整，反之亦然。
 - **离线消息**：对于单聊和群聊，离线消息默认保存 7 天。对于每个终端用户，所有的单聊会话可存储 500 条离线消息，所有的群聊会话可存储 200 条离线消息。若超过存储天数和条数的上限，最新的离线消息会挤掉最早的。如需提升上限，可联系商务。
 - **各类事件通知**：事件通知的存储时间与消息的存储一致。
@@ -115,11 +92,22 @@
 
 该功能只支持单聊和群组聊天，不支持聊天室。
 
+### 消息表情回复
+
+- 一个消息表情即为一个 Reaction，若不同用户重复添加同一消息表情，Reaction 数量计为 1。
+- 对于同一条 Reaction，一个用户只能添加一次，重复添加会报错误 1301。
+- 每条消息默认可添加 20 个 Reaction，若需提升该上限，需联系环信商务。
+- 创建 Reaction 时，设置的表情 ID 长度不能超过 128 个字符，对支持的字符集类型没有限制，但服务端与客户端的设置必须保持一致。若使用特殊字符，获取和删除 Reaction 时需对特殊字符进行 URL 编码。
+
 ### 获取消息流量统计
 
 - SDK 只支持统计该功能开启后最近 30 天内发送和接收的消息。
 - 仅 Android and iOS 端 SDK 支持该功能。
 
+### 消息举报
+
+举报消息的原因不能超过 512 字节。
+
 ## 会话
 
 ### 会话列表
@@ -163,6 +151,11 @@
 - 群组共享文件在服务器的存储时间与消息附件相同，即默认为 7 天。如果需要提升限制，请联系商务。
   如果消息附件在服务器上的存储时间进行了上调，群组共享文件的存储时间也会随之自动调整，反之亦然。
 
+### 子区
+
+- 单个 app 下的子区总数默认为 10 万，如需调整请联系商务。
+- 子区名称，不能超过 64 个字符。
+
 ## 聊天室
 
 不同套餐版本支持的聊天室总数，详见[套餐包功能详情](pricing.html#套餐包功能详情)。
@@ -192,25 +185,42 @@
 
 每个聊天室属性 value 不能超过 4096 个字符。
 
-## 子区
+## 用户相关
 
-- 单个 app 下的子区总数默认为 10 万，如需调整请联系商务。
-- 子区名称，不能超过 64 个字符。
+### 用户注册
+
+- 用户 ID：长度不能超过 64 字节，支持以下字符集：
+  - 26 个小写英文字母 a-z；
+  - 26 个大写英文字母 A-Z；
+  - 10 个数字 0-9；
+  - “_”, “-”, “.”。
 
-## 在线状态订阅
+:::tip
+- 该参数不区分大小写，因此 Aa 和 aa 为相同用户名。
+- 请确保同一个 app 下，用户 ID 唯一。
+- 用户 ID 是会公开的信息，请勿使用 UUID、邮箱地址、手机号等敏感信息。
+:::
+
+- 密码：用户的登录密码，长度不可超过 64 个字符。
+
+### 用户属性
+
+- 默认单个用户的属性总长不得超过 2 KB。
+- 默认单个 app 下所有用户的属性总长度不得超过 10 GB。
+
+### 用户关系
+
+- 单个 App Key 下的每个用户的好友数量上限与套餐包版本相关，详见[套餐包功能详情](/product/pricing.html#套餐包功能详情)。
+- 好友备注的长度不能超过 100 个字符。
+- 每个用户的黑名单最多可存 500 个用户。
+
+### 在线状态订阅
 
 - 订阅时长最长为 30 天，过期需重新订阅。如果未过期的情况下重复订阅，新设置的有效期会覆盖之前的有效期。
 - 每次调用接口最多只能订阅 100 个账号，若数量较大需多次调用。
 - 每个用户 ID 订阅的用户数不超过 3000。如果超过 3000，后续订阅也会成功，但默认会将订阅剩余时长较短的替代。
 - 每个用户最多可被 3000 个用户订阅。
 
-## 消息表情回复
-
-- 一个消息表情即为一个 Reaction，若不同用户重复添加同一消息表情，Reaction 数量计为 1。
-- 对于同一条 Reaction，一个用户只能添加一次，重复添加会报错误 1301。
-- 每条消息默认可添加 20 个 Reaction，若需提升该上限，需联系环信商务。
-- 创建 Reaction 时，设置的表情 ID 长度不能超过 128 个字符，对支持的字符集类型没有限制，但服务端与客户端的设置必须保持一致。若使用特殊字符，获取和删除 Reaction 时需对特殊字符进行 URL 编码。
-
 ## 离线推送
 
 ### 推送昵称
@@ -222,15 +232,6 @@
 - 中文；
 - 特殊字符。
 
-### 免打扰时间
-
-免打扰时间参数的说明如下表所示：
-
-| 免打扰时间参数       | 类型 |描述           | 应用范围           |
-| :------------------- | :--------------------------- | :--------------------------- | :------------------- |
-| 免打扰时间段 | Int |每天定时触发离线推送免打扰的时间段，采用 24 小时制，精确到分钟，格式为 H:M-H:M，例如 8:30-10:0，开始时间和结束时间中的小时数和分钟数的取值范围分别为 [0,23] 和 [0,59]。免打扰时间段的设置说明如下：<br/> - 开始时间和结束时间设置后，免打扰模式每天定时触发。例如，若该时间段设置为 `8:0`-`10:0`，免打扰模式在每天的 8:00-10:00 内生效。若你在 11:00 设置开始时间为 `8:0`，结束时间为 `12:0`，则免打扰模式在当天的 11:00-12:00 生效，以后每天均在 8:00-12:00 生效。<br/> - 若开始时间和结束时间相同，免打扰模式则全天生效。不过，若设置为  `0:0`-`0:0`，则关闭免打扰模式。<br/> - 若结束时间早于开始时间，则免打扰模式在每天的开始时间到次日的结束时间内生效。例如，开始时间为 `10:0`，结束时间为 `8:0`，则免打扰模式的在当天的 10:00 到次日的 8:00 生效。<br/> - 目前仅支持在每天的一个指定时间段内开启免打扰模式，不支持多个免打扰时间段，新的设置会覆盖之前的设置。<br/> - 若不设置该参数，传空字符串。<br/> - 若该参数和 `SILENT_MODE_DURATION` 均设置，免打扰模式当日在这两个时间段均生效，例如，上午 8:00 将 `SILENT_MODE_INTERVAL` 设置为 8:0-10:0，`SILENT_MODE_DURATION` 设置为 240 分钟（4 个小时），则 app 在当天 8:00-12:00 和以后每天 8:00-10:00 处于免打扰模式。 | 仅针对 app 生效，对单聊或群聊不生效。 |
-| 免打扰时长 | Int |免打扰时长，单位为分钟。免打扰时长的取值范围为 [0,10080]，`0` 表示该参数无效，`10080` 表示免打扰模式持续 7 天。<br/> 与免打扰时间段的设置每天生效不同，该参数为一次有效。设置后立即生效，例如，上午 8:00 将 app 层级的 `SILENT_MODE_DURATION` 设置为 240 分钟（4 个小时），则 app 在当天 8:00-12:00 处于免打扰模式。<br/> - 若该参数和 `SILENT_MODE_INTERVAL` 均设置，免打扰模式当日在这两个时间段均生效，例如，上午 8:00 将 app 级的 `SILENT_MODE_INTERVAL` 设置为 8:00-10:00，免打扰时长设置为 240 分钟（4 个小时），则 app 在当前 8:00-12:00 和以后每天 8:00-10:00 处于免打扰模式。    | App 或单聊/群聊会话。|
-
 ### 推送模板名称
 
 - 添加默认的推送模板时，模板名称应设置为 `default`。
@@ -245,10 +246,6 @@
 
 - 自定义设置登录设备的平台时，设备平台的取值范围为 [1,100]，设备数量的取值范围为 [0,4]。
 
-## 消息举报
-
-举报消息的原因不能超过 512 字节。
-
 ## 调用频率限制
 
 关于 RESTf API 的调用频率限制，详见 [Rest API 调用频率限制](limitationapi.html)。