diff --git a/docs/docs/sdk/applet/message_send_receive.md b/docs/docs/sdk/applet/message_send_receive.md index 85d74317..c50f762a 100644 --- a/docs/docs/sdk/applet/message_send_receive.md +++ b/docs/docs/sdk/applet/message_send_receive.md @@ -75,9 +75,7 @@ chatClient.addEventHandler("handlerId", { 接收方可以自行下载语音、图片、图片缩略图、视频和文件。 -// TODO：替换链接 - -对于消息附件，你也可以将附件上传到自己的服务器，而不是声网服务器，然后发送消息。这种情况下，需要在 SDK 初始化时将 [`Connection` 类中的 `useOwnUploadFun` 参数](https://doc.easemob.com/jsdoc/classes/Connection.Connection-1.html)设置为 `true`。例如，对于图片消息，上传附件后，调用 `sendPrivateUrlImg` 方法传入图片的 URL 发送图片消息。 +对于消息附件，你也可以将附件上传到自己的服务器，而不是声网服务器，然后发送消息。这种情况下，需要在 SDK 初始化时将 [`Connection` 类中的 `useOwnUploadFun` 参数](https://im.shengwang.cn/sdkdocs/chat1.x/web/classes/Connection.Connection-1.html#useOwnUploadFun)设置为 `true`。例如，对于图片消息，上传附件后，调用 `sendPrivateUrlImg` 方法传入图片的 URL 发送图片消息。 ```javascript function sendUrlImg() { @@ -552,23 +550,23 @@ chatClient.addEventHandler("handlerId", { 创建合并消息时，需要设置以下参数： -| 属性 | 类型 | 描述 | -| :------- | :-------------- | :--------------------------- | -| `chatType` | ChatType | 会话类型。 | -| `type` | 'combine' | 消息类型。 | -| `to` | String | 消息接收方。该字段的设置取决于会话类型：
- 单聊：对方用户 ID；
- 群聊：群组 ID；
- 子区会话：子区 ID；
- 聊天室聊天：聊天室 ID。 | -| `title` | String | 合并消息的标题。 | -| `summary` | String | 合并消息的概要。 | +| 属性 | 类型 | 描述 | +| :--------------------- | :---------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `chatType` | ChatType | 会话类型。 | +| `type` | 'combine' | 消息类型。 | +| `to` | String | 消息接收方。该字段的设置取决于会话类型：
- 单聊：对方用户 ID；
- 群聊：群组 ID；
- 子区会话：子区 ID；
- 聊天室聊天：聊天室 ID。 | +| `title` | String | 合并消息的标题。 | +| `summary` | String | 合并消息的概要。 | | `compatibleText` | String | 合并消息的兼容文本。
兼容文本起向下兼容不支持消息合并转发的版本的作用。当支持合并消息的 SDK 向不支持合并消息的低版本 SDK 发送消息时，低版本的 SDK 会将该属性解析为文本消息的消息内容。 | -| `messageList` | MessagesType[] | 合并消息的消息列表。该列表最多包含 300 个消息。 | -| `onFileUploadComplete` | (data: { url: string; secret: string;}) => void | 合并消息文件上传完成的回调。 | -| `onFileUploadError` | (error: any) => void | 合并消息文件上传失败的回调。 | +| `messageList` | MessagesType[] | 合并消息的消息列表。该列表最多包含 300 个消息。 | +| `onFileUploadComplete` | (data: { url: string; secret: string;}) => void | 合并消息文件上传完成的回调。 | +| `onFileUploadError` | (error: any) => void | 合并消息文件上传失败的回调。 | :::tip 1. 合并转发支持嵌套，最多支持 10 层嵌套，每层最多 300 条消息。 2. 只有成功发送或接收的消息才能合并转发。 -::: + ::: 示例代码如下： @@ -632,7 +630,7 @@ chatClient 1. 定向消息不写入服务端会话列表，不计入服务端会话的未读消息数。 2. 群组定向消息的漫游功能默认关闭，使用前需联系商务开通。 3. 聊天室定向消息的漫游功能默认关闭，使用前需联系商务开通聊天室消息漫游和定向消息漫游功能。 -::: + ::: 发送定向消息的流程与发送普通消息相似，唯一区别是需要设置定向消息的接收方。 diff --git a/docs/docs/sdk/applet/uniappnativeapp.md b/docs/docs/sdk/applet/uniappnativeapp.md index f9aeed24..887c2568 100644 --- a/docs/docs/sdk/applet/uniappnativeapp.md +++ b/docs/docs/sdk/applet/uniappnativeapp.md @@ -33,10 +33,10 @@ 可以通过以下两种方式获取 SDK： -// TODO：替换链接 +- 通过 CDN[下载 SDK](https://download.shengwang.cn/sdk/release/shengwang-chat-web-1.3.2.zip)。 +- 通过 npm 下载 'shengwang-chat'。 -- 通过官网 [下载 SDK](https://www.easemob.com/download/im)。 -- [Uni-app Demo 源码中获取](https://github.com/easemob/webim-uniapp-demo)。 +sdk 文件为 miniProgram 文件夹下的 Shengwang-chat.js #### 引入 SDK diff --git a/docs/docs/sdk/web/conversation_mark.md b/docs/docs/sdk/web/conversation_mark.md index 9145e4c6..9136af77 100644 --- a/docs/docs/sdk/web/conversation_mark.md +++ b/docs/docs/sdk/web/conversation_mark.md @@ -6,8 +6,7 @@ **如果要使用会话标记功能，你需要确保产品套餐包支持[从服务端获取会话列表的功能](conversation_list.html#从服务器分页获取会话列表)。** -//TODO -你需要自行维护会话标记与具体业务含义之间的映射，例如 [`MarkType.mark_0`](https://doc.easemob.com/jsdoc/enums/Types.ContactType.MarkType.html)表示待处理会话。 +你需要自行维护会话标记与具体业务含义之间的映射，例如 [`MarkType.mark_0`](https://im.shengwang.cn/sdkdocs/chat1.x/web/enums/Types.ContactType.MarkType.html)表示待处理会话。 ```javascript const MarkMap = new Map(); diff --git a/docs/docs/sdk/web/integration.md b/docs/docs/sdk/web/integration.md index ebe37725..ce538f04 100644 --- a/docs/docs/sdk/web/integration.md +++ b/docs/docs/sdk/web/integration.md @@ -23,9 +23,7 @@ npm install shengwang-chat SDK 提供了灵活的模块化设计，允许开发者根据需求引入功能模块，并将其注册到 miniCore 中使用。 -// TODO：替换链接 - -miniCore 是一个基座，支持登录登出和发送消息等[基础功能](https://doc.easemob.com/jsdoc/classes/Connection.Connection-1.html)，而且包含消息对象。因此，若只使用收发消息功能，则只需引入 miniCore。若使用其他功能，miniCore 支持使用插件的方式引入其他功能模块。按需引入模块的方式实现了不同模块的灵活组合，从而避免不必要的代码加载，减小了应用程序的体积。 +miniCore 是一个基座，支持登录登出和发送消息等[基础功能](https://im.shengwang.cn/sdkdocs/chat1.x/web/classes/Connection.Connection-1.html)，而且包含消息对象。因此，若只使用收发消息功能，则只需引入 miniCore。若使用其他功能，miniCore 支持使用插件的方式引入其他功能模块。按需引入模块的方式实现了不同模块的灵活组合，从而避免不必要的代码加载，减小了应用程序的体积。 :::tip @@ -162,9 +160,7 @@ import ChatSDK, { ShengwangChat } from "shengwang-chat"; ### 从官网获取并导入 SDK -// TODO：替换链接 - -1. 下载 [ShengwangChat Chat SDK for Web](https://www.easemob.com/download/im)。将 Web SDK 中的 `Shengwang-chat.js` 文件保存到你的项目下。 +1. 下载 [ShengwangChat Chat SDK for Web](https://download.shengwang.cn/sdk/release/shengwang-chat-web-1.3.2.zip)。将 Web SDK 中的 `Shengwang-chat.js` 文件保存到你的项目下。 2. 在 `index.html` 文件中，对 `index.js` 文件进行引用。 diff --git a/docs/docs/sdk/web/message_receipt.md b/docs/docs/sdk/web/message_receipt.md index 7daaf568..030b9558 100644 --- a/docs/docs/sdk/web/message_receipt.md +++ b/docs/docs/sdk/web/message_receipt.md @@ -17,9 +17,8 @@ 实现消息送达回执和已读回执的逻辑如下： - 单聊消息送达回执： - // TODO: 替换链接 - 1. SDK 初始化时，用户将 [`ConnectionParameters` 类型中的 `delivery` 参数](https://doc.easemob.com/jsdoc/interfaces/Connection.ConnectionParameters.html#delivery)设置为 `true`。 + 1. SDK 初始化时，用户将 [`ConnectionParameters` 类型中的 `delivery` 参数](https://im.shengwang.cn/sdkdocs/chat1.x/web/classes/Connection.Connection-1.html#delivery)设置为 `true`。 2. 接收方收到消息后，SDK 会自动向发送方发送送达回执。 diff --git a/docs/docs/sdk/web/message_send_receive.md b/docs/docs/sdk/web/message_send_receive.md index b79c9f7d..5015f079 100644 --- a/docs/docs/sdk/web/message_send_receive.md +++ b/docs/docs/sdk/web/message_send_receive.md @@ -75,9 +75,7 @@ chatClient.addEventHandler("handlerId", { 接收方可以自行下载语音、图片、图片缩略图、视频和文件。 -// TODO：替换链接 - -对于消息附件，你也可以将附件上传到自己的服务器，而不是声网服务器，然后发送消息。这种情况下，需要在 SDK 初始化时将 [`Connection` 类中的 `useOwnUploadFun` 参数](https://doc.easemob.com/jsdoc/classes/Connection.Connection-1.html)设置为 `true`。例如，对于图片消息，上传附件后，调用 `sendPrivateUrlImg` 方法传入图片的 URL 发送图片消息。 +对于消息附件，你也可以将附件上传到自己的服务器，而不是声网服务器，然后发送消息。这种情况下，需要在 SDK 初始化时将 [`Connection` 类中的 `useOwnUploadFun` 参数](https://im.shengwang.cn/sdkdocs/chat1.x/web/classes/Connection.Connection-1.html#useOwnUploadFun)设置为 `true`。例如，对于图片消息，上传附件后，调用 `sendPrivateUrlImg` 方法传入图片的 URL 发送图片消息。 ```javascript function sendUrlImg() { @@ -554,8 +552,8 @@ chatClient.addEventHandler("handlerId", { 创建合并消息时，需要设置以下参数： -| 属性 | 类型 | 描述 | -| :---------- | :--------------------------- | :-------------------------------- | +| 属性 | 类型 | 描述 | +| :--------------------- | :---------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `chatType` | ChatType | 会话类型。 | | `type` | 'combine' | 消息类型。 | | `to` | String | 消息接收方。该字段的设置取决于会话类型：
- 单聊：对方用户 ID；
- 群聊：群组 ID；
- 子区会话：子区 ID；
- 聊天室聊天：聊天室 ID。 | diff --git a/docs/docs/uikit/chatuikit/web/chatuikit_quickstart.md b/docs/docs/uikit/chatuikit/web/chatuikit_quickstart.md index 8619427e..9a30e797 100644 --- a/docs/docs/uikit/chatuikit/web/chatuikit_quickstart.md +++ b/docs/docs/uikit/chatuikit/web/chatuikit_quickstart.md @@ -80,11 +80,11 @@ yarn add shengwnag-chat-uikit 4. 在**即时通讯 IM** 页面，进入**运营管理**标签页。 -5. 在**用户** 页签下，点击**创建IM用户**。 +5. 在**用户** 页签下，点击**创建 IM 用户**。 6. 在弹出的对话框中，配置用户相关参数，点击**确定**。 -创建用户后，在用户列表点击对应的用户的**操作**一栏中的**更多**，选择**查看Token**。 +创建用户后，在用户列表点击对应的用户的**操作**一栏中的**更多**，选择**查看 Token**。 在弹出的对话框中，可以查看用户 Token，也可以点击**重新生成**，生成用户 token。 @@ -125,11 +125,11 @@ const ChatApp = () => { }, [client]); return ( -
-
+
+
-
+
diff --git a/docs/docs/uikit/chatuikit/web/chatuikit_storybook.md b/docs/docs/uikit/chatuikit/web/chatuikit_storybook.md index e1df1df5..16ac2479 100644 --- a/docs/docs/uikit/chatuikit/web/chatuikit_storybook.md +++ b/docs/docs/uikit/chatuikit/web/chatuikit_storybook.md @@ -4,5 +4,4 @@ `shengwang-chat-uikit` 提供三类组件：容器组件、module 组件和纯 UI 组件。组件中包含各种属性供你配置。 -//TODO -若要查看组件配置详情，请点击[这里](https://storybook.shengwang.com/)。 +若要查看组件配置详情，请点击[这里](https://im.shengwang.cn/sdkdocs/chat1.x/uikit/)。