Merge pull request #1002 from haoxiuwen/doc-v2

Modify Web IM Doc
easemob · Oct 23, 2024 · 6c36eb9 · 6c36eb9
2 parents bfd9c9a + 55c519b
commit 6c36eb9
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/docs/document/server-side/push_extension.md b/docs/document/server-side/push_extension.md
@@ -16,7 +16,7 @@
 | `em_apns_ext`            | Object       | APNs 配置。 |
 | `em_android_push_ext`    | Object       | Android 配置。 |
 | `em_harmony_push_ext`    | Object       | 鸿蒙推送扩展配置。 |
-| `em_push_ext`            | Object       | 新的推送配置，用于集中管理，后续通用的配置会添加到该字段。 |
+| `em_push_ext`            | Object       | 通用的配置。 |
 
 `em_push_filter` 结构如下：
 

diff --git a/docs/document/web/error.md b/docs/document/web/error.md
@@ -16,7 +16,7 @@ error.type === statusCode.WEBIM_CONNCTION_USER_NOT_ASSIGN_ERROR 其中 `error`
 | -3     | REQUEST_PARAMETER_ERROR               | 参数错误。                                     |
 | -4     | REQUEST_ABORT               | 取消请求。                                     |
 | 1      | WEBIM_CONNCTION_OPEN_ERROR                    | 登录失败：获取 token 接口请求失败或 Token 无效。                          |
-| 2      | WEBIM_CONNCTION_AUTH_ERROR                     | 鉴权失败：调用 API 时校验 App Key 失败，App Key 不合法。     |
+| 2      | WEBIM_CONNCTION_AUTH_ERROR                     | 登录鉴权失败。     |
 | 12     | WEBIM_CONNCTION_GETROSTER_ERROR                | 获取 Chat token 失败：通过 Agora token 置换 Chat token 失败。 |
 | 16     | WEBIM_CONNCTION_DISCONNECTED                   | WebSocket 断开连接：由于断网等原因 WebSocket 已经断开。      |
 | 17     | WEBIM_CONNCTION_AJAX_ERROR                     | 服务请求的通用错误：请求服务器未成功时的默认错误。 |

diff --git a/docs/document/web/message_send_receive.md b/docs/document/web/message_send_receive.md
@@ -664,6 +664,7 @@ function sendCustomMsg() {
     // 会话类型：单聊、群聊和聊天室分别为 `singleChat`、`groupChat` 和 `chatRoom`。
     chatType: "singleChat",
     customEvent,
+    // key 和 value 只支持字符串类型，否则客户端无法解析。
     customExts,
     // 消息扩展字段，不能设置为空，即设置为 "ext:null" 这种形式会出错。
     ext: {},