Skip to content

Commit aff60ff

Browse files
haoxiuwenhaoxiuwen
authored
Merge pull request #68 from myZhangDong/web_1.22
web update links
2 parents b5c24e5 + 8afcf47 commit aff60ff

File tree

8 files changed

+29
-40
lines changed

8 files changed

+29
-40
lines changed

‎docs/docs/sdk/applet/message_send_receive.md‎

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,7 @@ chatClient.addEventHandler("handlerId", {
7575

7676
接收方可以自行下载语音、图片、图片缩略图、视频和文件。
7777

78-
// TODO：替换链接
79-
80-
对于消息附件，你也可以将附件上传到自己的服务器，而不是声网服务器，然后发送消息。这种情况下，需要在 SDK 初始化时将 [`Connection` 类中的 `useOwnUploadFun` 参数](https://doc.easemob.com/jsdoc/classes/Connection.Connection-1.html)设置为 `true`。例如，对于图片消息，上传附件后，调用 `sendPrivateUrlImg` 方法传入图片的 URL 发送图片消息。
78+
对于消息附件，你也可以将附件上传到自己的服务器，而不是声网服务器，然后发送消息。这种情况下，需要在 SDK 初始化时将 [`Connection` 类中的 `useOwnUploadFun` 参数](https://im.shengwang.cn/sdkdocs/chat1.x/web/classes/Connection.Connection-1.html#useOwnUploadFun)设置为 `true`。例如，对于图片消息，上传附件后，调用 `sendPrivateUrlImg` 方法传入图片的 URL 发送图片消息。
8179

8280
```javascript
8381
function sendUrlImg() {
@@ -552,23 +550,23 @@ chatClient.addEventHandler("handlerId", {
552550

553551
创建合并消息时，需要设置以下参数：
554552

555-
| 属性 | 类型 | 描述 |
556-
| :------- | :-------------- | :--------------------------- |
557-
| `chatType` | ChatType | 会话类型。 |
558-
| `type` | 'combine' | 消息类型。 |
559-
| `to` | String | 消息接收方。该字段的设置取决于会话类型：<br/> - 单聊：对方用户 ID；<br/> - 群聊：群组 ID；<br/> - 子区会话：子区 ID；<br/> - 聊天室聊天：聊天室 ID。 |
560-
| `title` | String | 合并消息的标题。 |
561-
| `summary` | String | 合并消息的概要。 |
553+
| 属性 | 类型 | 描述 |
554+
| :--------------------- | :---------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
555+
| `chatType` | ChatType | 会话类型。 |
556+
| `type` | 'combine' | 消息类型。 |
557+
| `to` | String | 消息接收方。该字段的设置取决于会话类型：<br/> - 单聊：对方用户 ID；<br/> - 群聊：群组 ID；<br/> - 子区会话：子区 ID；<br/> - 聊天室聊天：聊天室 ID。 |
558+
| `title` | String | 合并消息的标题。 |
559+
| `summary` | String | 合并消息的概要。 |
562560
| `compatibleText` | String | 合并消息的兼容文本。<br/>兼容文本起向下兼容不支持消息合并转发的版本的作用。当支持合并消息的 SDK 向不支持合并消息的低版本 SDK 发送消息时，低版本的 SDK 会将该属性解析为文本消息的消息内容。 |
563-
| `messageList` | MessagesType[] | 合并消息的消息列表。该列表最多包含 300 个消息。 |
564-
| `onFileUploadComplete` | (data: { url: string; secret: string;}) => void | 合并消息文件上传完成的回调。 |
565-
| `onFileUploadError` | (error: any) => void | 合并消息文件上传失败的回调。 |
561+
| `messageList` | MessagesType[] | 合并消息的消息列表。该列表最多包含 300 个消息。 |
562+
| `onFileUploadComplete` | (data: { url: string; secret: string;}) => void | 合并消息文件上传完成的回调。 |
563+
| `onFileUploadError` | (error: any) => void | 合并消息文件上传失败的回调。 |
566564

567565
:::tip
568566

569567
1. 合并转发支持嵌套，最多支持 10 层嵌套，每层最多 300 条消息。
570568
2. 只有成功发送或接收的消息才能合并转发。
571-
:::
569+
:::
572570

573571
示例代码如下：
574572

@@ -632,7 +630,7 @@ chatClient
632630
1. 定向消息不写入服务端会话列表，不计入服务端会话的未读消息数。
633631
2. 群组定向消息的漫游功能默认关闭，使用前需联系商务开通。
634632
3. 聊天室定向消息的漫游功能默认关闭，使用前需联系商务开通聊天室消息漫游和定向消息漫游功能。
635-
:::
633+
:::
636634

637635
发送定向消息的流程与发送普通消息相似，唯一区别是需要设置定向消息的接收方。
638636

‎docs/docs/sdk/applet/uniappnativeapp.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@
3333

3434
可以通过以下两种方式获取 SDK：
3535

36-
// TODO：替换链接
36+
- 通过 CDN[下载 SDK](https://download.shengwang.cn/sdk/release/shengwang-chat-web-1.3.2.zip)。
37+
- 通过 npm 下载 'shengwang-chat'。
3738

38-
- 通过官网 [下载 SDK](https://www.easemob.com/download/im)。
39-
- [Uni-app Demo 源码中获取](https://github.com/easemob/webim-uniapp-demo)。
39+
sdk 文件为 miniProgram 文件夹下的 Shengwang-chat.js
4040

4141
#### 引入 SDK
4242

‎docs/docs/sdk/web/conversation_mark.md‎

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

77
**如果要使用会话标记功能，你需要确保产品套餐包支持[从服务端获取会话列表的功能](conversation_list.html#从服务器分页获取会话列表)。**
88

9-
//TODO
10-
你需要自行维护会话标记与具体业务含义之间的映射，例如 [`MarkType.mark_0`](https://doc.easemob.com/jsdoc/enums/Types.ContactType.MarkType.html)表示待处理会话。
9+
你需要自行维护会话标记与具体业务含义之间的映射，例如 [`MarkType.mark_0`](https://im.shengwang.cn/sdkdocs/chat1.x/web/enums/Types.ContactType.MarkType.html)表示待处理会话。
1110

1211
```javascript
1312
const MarkMap = new Map();

‎docs/docs/sdk/web/integration.md‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,7 @@ npm install shengwang-chat
2323

2424
SDK 提供了灵活的模块化设计，允许开发者根据需求引入功能模块，并将其注册到 miniCore 中使用。
2525

26-
// TODO：替换链接
27-
28-
miniCore 是一个基座，支持登录登出和发送消息等[基础功能](https://doc.easemob.com/jsdoc/classes/Connection.Connection-1.html)，而且包含消息对象。因此，若只使用收发消息功能，则只需引入 miniCore。若使用其他功能，miniCore 支持使用插件的方式引入其他功能模块。按需引入模块的方式实现了不同模块的灵活组合，从而避免不必要的代码加载，减小了应用程序的体积。
26+
miniCore 是一个基座，支持登录登出和发送消息等[基础功能](https://im.shengwang.cn/sdkdocs/chat1.x/web/classes/Connection.Connection-1.html)，而且包含消息对象。因此，若只使用收发消息功能，则只需引入 miniCore。若使用其他功能，miniCore 支持使用插件的方式引入其他功能模块。按需引入模块的方式实现了不同模块的灵活组合，从而避免不必要的代码加载，减小了应用程序的体积。
2927

3028
:::tip
3129

@@ -162,9 +160,7 @@ import ChatSDK, { ShengwangChat } from "shengwang-chat";
162160

163161
### 从官网获取并导入 SDK
164162

165-
// TODO：替换链接
166-
167-
1. 下载 [ShengwangChat Chat SDK for Web](https://www.easemob.com/download/im)。将 Web SDK 中的 `Shengwang-chat.js` 文件保存到你的项目下。
163+
1. 下载 [ShengwangChat Chat SDK for Web](https://download.shengwang.cn/sdk/release/shengwang-chat-web-1.3.2.zip)。将 Web SDK 中的 `Shengwang-chat.js` 文件保存到你的项目下。
168164

169165
2. 在 `index.html` 文件中，对 `index.js` 文件进行引用。
170166

‎docs/docs/sdk/web/message_receipt.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,8 @@
1717
实现消息送达回执和已读回执的逻辑如下：
1818

1919
- 单聊消息送达回执：
20-
// TODO: 替换链接
2120

22-
1. SDK 初始化时，用户将 [`ConnectionParameters` 类型中的 `delivery` 参数](https://doc.easemob.com/jsdoc/interfaces/Connection.ConnectionParameters.html#delivery)设置为 `true`。
21+
1. SDK 初始化时，用户将 [`ConnectionParameters` 类型中的 `delivery` 参数](https://im.shengwang.cn/sdkdocs/chat1.x/web/classes/Connection.Connection-1.html#delivery)设置为 `true`。
2322

2423
2. 接收方收到消息后，SDK 会自动向发送方发送送达回执。
2524

‎docs/docs/sdk/web/message_send_receive.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,7 @@ chatClient.addEventHandler("handlerId", {
7575

7676
接收方可以自行下载语音、图片、图片缩略图、视频和文件。
7777

78-
// TODO：替换链接
79-
80-
对于消息附件，你也可以将附件上传到自己的服务器，而不是声网服务器，然后发送消息。这种情况下，需要在 SDK 初始化时将 [`Connection` 类中的 `useOwnUploadFun` 参数](https://doc.easemob.com/jsdoc/classes/Connection.Connection-1.html)设置为 `true`。例如，对于图片消息，上传附件后，调用 `sendPrivateUrlImg` 方法传入图片的 URL 发送图片消息。
78+
对于消息附件，你也可以将附件上传到自己的服务器，而不是声网服务器，然后发送消息。这种情况下，需要在 SDK 初始化时将 [`Connection` 类中的 `useOwnUploadFun` 参数](https://im.shengwang.cn/sdkdocs/chat1.x/web/classes/Connection.Connection-1.html#useOwnUploadFun)设置为 `true`。例如，对于图片消息，上传附件后，调用 `sendPrivateUrlImg` 方法传入图片的 URL 发送图片消息。
8179

8280
```javascript
8381
function sendUrlImg() {
@@ -554,8 +552,8 @@ chatClient.addEventHandler("handlerId", {
554552

555553
创建合并消息时，需要设置以下参数：
556554

557-
| 属性 | 类型 | 描述 |
558-
| :---------- | :--------------------------- | :-------------------------------- |
555+
| 属性 | 类型 | 描述 |
556+
| :--------------------- | :---------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
559557
| `chatType` | ChatType | 会话类型。 |
560558
| `type` | 'combine' | 消息类型。 |
561559
| `to` | String | 消息接收方。该字段的设置取决于会话类型：<br/> - 单聊：对方用户 ID；<br/> - 群聊：群组 ID；<br/> - 子区会话：子区 ID；<br/> - 聊天室聊天：聊天室 ID。 |

‎docs/docs/uikit/chatuikit/web/chatuikit_quickstart.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,11 @@ yarn add shengwnag-chat-uikit
8080

8181
4. 在**即时通讯 IM** 页面，进入**运营管理**标签页。
8282

83-
5. 在**用户** 页签下，点击**创建IM用户**。
83+
5. 在**用户** 页签下，点击**创建 IM 用户**。
8484

8585
6. 在弹出的对话框中，配置用户相关参数，点击**确定**。
8686

87-
创建用户后，在用户列表点击对应的用户的**操作**一栏中的**更多**，选择**查看Token**。
87+
创建用户后，在用户列表点击对应的用户的**操作**一栏中的**更多**，选择**查看 Token**。
8888

8989
在弹出的对话框中，可以查看用户 Token，也可以点击**重新生成**，生成用户 token。
9090

@@ -125,11 +125,11 @@ const ChatApp = () => {
125125
}, [client]);
126126

127127
return (
128-
<div>
129-
<div>
128+
<div style={{ display: "flex", height: "100vh" }}>
129+
<div style={{ width: "350px" }}>
130130
<ConversationList />
131131
</div>
132-
<div>
132+
<div style={{ flex: "1" }}>
133133
<Chat />
134134
</div>
135135
</div>

‎docs/docs/uikit/chatuikit/web/chatuikit_storybook.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,4 @@
44

55
`shengwang-chat-uikit` 提供三类组件：容器组件、module 组件和纯 UI 组件。组件中包含各种属性供你配置。
66

7-
//TODO
8-
若要查看组件配置详情，请点击[这里](https://storybook.shengwang.com/)。
7+
若要查看组件配置详情，请点击[这里](https://im.shengwang.cn/sdkdocs/chat1.x/uikit/)。

0 commit comments

Comments
 (0)