Skip to content

Commit 2fe95aa

Browse files
haoxiuwenhaoxiuwen
authored
Merge pull request #61 from myZhangDong/web_update
update web docs
2 parents 1845d19 + 996bc6f commit 2fe95aa

26 files changed

+198
-344
lines changed

‎docs/docs/sdk/applet/alipay.md‎

Lines changed: 19 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -16,43 +16,28 @@
1616

1717
登录 [支付宝开放平台](https://open.alipay.com/platform/home.htm), 配置以下服务器域名。
1818

19-
// TODO 更换域名
20-
2119
:::tip
2220
request 合法域名：
2321

24-
1. https://a1.easemob.com
25-
2. https://a2.easemob.com
26-
3. https://a3.easemob.com
27-
4. https://a4.easemob.com
28-
5. https://a5.easemob.com
29-
6. https://rs.chat.agora.io
30-
7. https://rs.easemob.com
31-
:::
22+
1. https://c1.chat.rtnsvc.com
23+
2. https://c1.chat.realtimemesh.com
24+
3. https://rs.chat.rtnsvc.com
25+
4. https://rs.chat.realtimemesh.com
26+
:::
3227

3328
:::tip
3429
socket 合法域名：
35-
wss://im-api-alipay.easemob.com/websocket
30+
wss://im-api-alipay-c1.chat.rtnsvc.com/websocket
31+
wss://im-api-alipay-c1.chat.realtimemesh.com/websocket
3632
:::
3733

38-
// TODO：目前声网 IM 只有一个数据中心，下面的提示是否要删掉？
39-
40-
声网不同数据中心的 REST API 请求域名、WebSocket 访问域名：
41-
42-
// TODO：替换表格中的地址
43-
44-
| 数据中心 | REST API 请求地址 | WebSocket 访问域名 |
45-
| ----------- | ---------------------------------------- | -------------------------------------------------------------- |
46-
| 国内 1 区 | a1.easemob.com | im-api-alipay.easemob.com 或 im-api-alipay.easecdn.com |
47-
| 国内 2 区 | a31.easemob.com | im-api-alipay-31.easemob.com 或 im-api-alipay-31.easecdn.com |
48-
| 国内 VIP 区 | 请咨询商务经理 | 请咨询商务经理 |
49-
| 客服专用 | 请咨询商务经理 | 请咨询商务经理 |
50-
| 新加坡 1 区 | a1-sgp.easemob.com 或 a1-sgp.easecdn.com | im-api-alipay-sgp.easemob.com 或 im-api-alipay-sgp.easecdn.com |
51-
| 新加坡 2 区 | a61.easemob.com 或 a61.easecdn.com | im-api-alipay-61.easemob.com 或 im-api-alipay-61.easecdn.com |
52-
| 美东 1 区 | a41.easemob.com 或 a41.easecdn.com | im-api-alipay-41.easemob.com 或 im-api-alipay-41.easecdn.com |
53-
| 德国 2 区 | a71.easemob.com 或 a71.easecdn.com | im-api-alipay-71.easemob.com 或 im-api-alipay-71.easecdn.com |
34+
:::tip
35+
uploadFile, downloadFile 合法域名：
5436

55-
关于如何查看应用所在数据中心，详见[数据中心文档](data.center.html#查看数据中心)。
37+
1. https://c1.chat.rtnsvc.com
38+
2. https://c1.chat.realtimemesh.com
39+
3. https://c1-chatfile.chat.rtnsvc.com
40+
:::
5641

5742
### 说明
5843

@@ -64,25 +49,24 @@ wss://im-api-alipay.easemob.com/websocket
6449

6550
可以通过以下两种方式获取 SDK：
6651

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

69-
- 通过官网[下载 SDK](https://www.easemob.com/download/im)。
70-
- 从声网的[github 仓库](https://github.com/easemob/webim-weixin-xcx/tree/master/src/sdk) 中获取 SDK 中的文件。
55+
sdk 文件为 miniProgram 文件夹下的 Shengwang-chat.js
7156

7257
#### 引入 SDK
7358

7459
- 开始一个全新的项目。
75-
1. 将下载的 SDK（src/sdk/）导入到自己的项目中。 // TODO：括号中的描述对吗？
76-
2. 引入 SDK：`import ChatSDK from "../sdk/Shengwang-chat-miniProgram";`
77-
- 基于 Demo 二次开发。 // TODO：需要提 Demo 吗？
60+
1. 将下载的 SDK 导入到自己的项目中。
61+
2. 引入 SDK：`import ChatSDK from "./Shengwang-chat";`
7862

7963
将下载的代码导入开发者工具即可运行起来。
8064

8165
#### 调用示例
8266

8367
```javascript
8468
//使用示例
85-
import ChatSDK from "../sdk/Shengwang-chat-miniProgram";
69+
import ChatSDK from "./Shengwang-chat";
8670
```
8771

8872
#### 实例调用方式

‎docs/docs/sdk/applet/baidu.md‎

Lines changed: 18 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -16,46 +16,28 @@
1616

1717
登录 [百度智能小程序官网](https://smartprogram.baidu.com/)，在开发设置页面配置以下服务器域名。
1818

19-
// TODO 更换域名
20-
2119
:::tip
2220
request 合法域名：
2321

24-
1. https://a1.easemob.com
25-
2. https://a2.easemob.com
26-
3. https://a3.easemob.com
27-
4. https://a4.easemob.com
28-
5. https://a5.easemob.com
29-
6. https://rs.chat.agora.io
30-
7. https://rs.easemob.com
22+
1. https://c1.chat.rtnsvc.com
23+
2. https://c1.chat.realtimemesh.com
24+
3. https://rs.chat.rtnsvc.com
25+
4. https://rs.chat.realtimemesh.com
3126
:::
3227

3328
:::tip
3429
socket 合法域名：
35-
wss://im-api-wechat.easemob.com
30+
wss://im-api-wechat-c1.chat.rtnsvc.com
31+
wss://im-api-wechat-c1.chat.realtimemesh.com
3632
:::
3733

38-
// TODO：目前声网 IM 只有一个数据中心，下面的提示是否要删掉？
3934
:::tip
40-
为满足不同客户的业务需求，声网在多地部署了数据中心。不同数据中心的 REST API 请求域名、WebSocket 访问域名不同。请根据您所在数据中心进行配置。
41-
:::
42-
43-
声网不同数据中心的 REST API 请求域名、WebSocket 访问域名：
44-
45-
// TODO：替换表格中的地址
35+
uploadFile, downloadFile 合法域名：
4636

47-
| 数据中心 | REST API 请求地址 | WebSocket 访问域名 |
48-
| ----------- | ---------------------------------------- | -------------------------------------------------------------- |
49-
| 国内 1 区 | a1.easemob.com | im-api-wechat.easemob.com 或 im-api-wechat.easecdn.com |
50-
| 国内 2 区 | a31.easemob.com | im-api-wechat-31.easemob.com 或 im-api-wechat-31.easecdn.com |
51-
| 国内 VIP 区 | 请咨询商务经理 | 请咨询商务经理 |
52-
| 客服专用 | 请咨询商务经理 | 请咨询商务经理 |
53-
| 新加坡 1 区 | a1-sgp.easemob.com 或 a1-sgp.easecdn.com | im-api-wechat-sgp.easemob.com 或 im-api-wechat-sgp.easecdn.com |
54-
| 新加坡 2 区 | a61.easemob.com 或 a61.easecdn.com | im-api-wechat-61.easemob.com 或 im-api-wechat-61.easecdn.com |
55-
| 美东 1 区 | a41.easemob.com 或 a41.easecdn.com | im-api-wechat-41.easemob.com 或 im-api-wechat-41.easecdn.com |
56-
| 德国 2 区 | a71.easemob.com 或 a71.easecdn.com | im-api-wechat-71.easemob.com 或 im-api-wechat-71.easecdn.com |
57-
58-
关于如何查看应用所在数据中心，详见[数据中心文档](data.center.html#查看数据中心)。
37+
1. https://c1.chat.rtnsvc.com
38+
2. https://c1.chat.realtimemesh.com
39+
3. https://c1-chatfile.chat.rtnsvc.com
40+
:::
5941

6042
### 说明
6143

@@ -67,25 +49,24 @@ wss://im-api-wechat.easemob.com
6749

6850
可以通过以下两种方式获取 SDK：
6951

70-
- 通过官网 [下载 SDK](https://www.easemob.com/download/im)。
71-
- 从声网的 [github 仓库](https://github.com/easemob/webim-weixin-xcx/tree/master/src/sdk) 中获取 SDK 中的文件。
52+
- 通过 CDN[下载 SDK](https://download.shengwang.cn/sdk/release/shengwang-chat-web-1.3.2.zip)。
53+
- 通过 npm 下载 'shengwang-chat'。
7254

73-
#### 引入 SDK
55+
sdk 文件为 miniProgram 文件夹下的 Shengwang-chat.js
7456

75-
// TODO：替换链接
57+
#### 引入 SDK
7658

7759
- 开始一个全新的项目。
78-
1. 将下载的 SDK（src/sdk/）导入到自己的项目中。// TODO：括号中的描述对吗？
79-
2. 引入 SDK：`import ChatSDK from "../sdk/Shengwang-chat-miniProgram";`
80-
- 基于 Demo 二次开发。// TODO：需要提 Demo 吗？
60+
1. 将下载的 SDK 导入到自己的项目中。
61+
2. 引入 SDK：`import ChatSDK from "./Shengwang-chat";`
8162

8263
将下载的代码导入开发者工具即可运行起来。
8364

8465
#### 调用示例
8566

8667
```javascript
8768
//使用示例
88-
import ChatSDK from "../sdk/Shengwang-chat-miniProgram";
69+
import ChatSDK from "./Shengwang-chat";
8970
```
9071

9172
#### 实例调用方式

‎docs/docs/sdk/applet/bytedance.md‎

Lines changed: 18 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -19,63 +19,50 @@
1919
:::tip
2020
request 合法域名：
2121

22-
1. https://a1.easemob.com
23-
2. https://a2.easemob.com
24-
3. https://a3.easemob.com
25-
4. https://a4.easemob.com
26-
5. https://a5.easemob.com
27-
6. https://a1-chatfile.easemob.com
28-
7. https://rs.chat.agora.io
29-
8. https://rs.easemob.com
22+
1. https://c1.chat.rtnsvc.com
23+
2. https://c1.chat.realtimemesh.com
24+
3. https://rs.chat.rtnsvc.com
25+
4. https://rs.chat.realtimemesh.com
3026
:::
3127

3228
:::tip
3329
socket 合法域名：
34-
wss://im-api-wechat.easemob.com
30+
wss://im-api-wechat-c1.chat.rtnsvc.com
31+
wss://im-api-wechat-c1.chat.realtimemesh.com
3532
:::
3633

3734
:::tip
38-
为满足不同客户的业务需求，声网在多地部署了数据中心。不同数据中心的 REST API 请求域名、WebSocket 访问域名不同。请根据您所在数据中心进行配置。
39-
:::
40-
41-
声网不同数据中心的 REST API 请求域名、WebSocket 访问域名：
42-
43-
| 数据中心 | REST API 请求地址 | WebSocket 访问域名 |
44-
| ----------- | ---------------------------------------- | -------------------------------------------------------------- |
45-
| 国内 1 区 | a1.easemob.com | im-api-wechat.easemob.com 或 im-api-wechat.easecdn.com |
46-
| 国内 2 区 | a31.easemob.com | im-api-wechat-31.easemob.com 或 im-api-wechat-31.easecdn.com |
47-
| 国内 VIP 区 | 请咨询商务经理 | 请咨询商务经理 |
48-
| 客服专用 | 请咨询商务经理 | 请咨询商务经理 |
49-
| 新加坡 1 区 | a1-sgp.easemob.com 或 a1-sgp.easecdn.com | im-api-wechat-sgp.easemob.com 或 im-api-wechat-sgp.easecdn.com |
50-
| 新加坡 2 区 | a61.easemob.com 或 a61.easecdn.com | im-api-wechat-61.easemob.com 或 im-api-wechat-61.easecdn.com |
51-
| 美东 1 区 | a41.easemob.com 或 a41.easecdn.com | im-api-wechat-41.easemob.com 或 im-api-wechat-41.easecdn.com |
52-
| 德国 2 区 | a71.easemob.com 或 a71.easecdn.com | im-api-wechat-71.easemob.com 或 im-api-wechat-71.easecdn.com |
35+
uploadFile, downloadFile 合法域名：
5336

54-
关于如何查看应用所在数据中心，详见[数据中心文档](data.center.html#查看数据中心)。
37+
1. https://c1.chat.rtnsvc.com
38+
2. https://c1.chat.realtimemesh.com
39+
3. https://c1-chatfile.chat.rtnsvc.com
40+
:::
5541

5642
### 集成 SDK
5743

5844
#### 下载 SDK
5945

6046
可以通过以下两种方式获取 SDK：
6147

62-
- 通过官网 [下载 SDK](https://www.easemob.com/download/im)。
63-
- 从声网的 [github 仓库](https://github.com/easemob/webim-weixin-xcx/tree/master/src/sdk) 中获取 SDK 中的文件。
48+
- 通过 CDN[下载 SDK](https://download.shengwang.cn/sdk/release/shengwang-chat-web-1.3.2.zip)。
49+
- 通过 npm 下载 'shengwang-chat'。
50+
51+
sdk 文件为 miniProgram 文件夹下的 Shengwang-chat.js
6452

6553
#### 引入 SDK
6654

6755
- 开始一个全新的项目。
68-
1. 将下载的 SDK（src/sdk/）导入到自己的项目中。
69-
2. 引入 SDK：`import ChatSDK from "../sdk/Shengwang-chat-miniProgram";`
70-
- 基于 Demo 二次开发。
56+
1. 将下载的 SDK 导入到自己的项目中。
57+
2. 引入 SDK：`import ChatSDK from "./Shengwang-chat";`
7158

7259
将下载的代码导入开发者工具即可运行起来。
7360

7461
#### 调用示例
7562

7663
```javascript
7764
//使用示例
78-
import ChatSDK from "../sdk/Shengwang-chat-miniProgram";
65+
import ChatSDK from "./Shengwang-chat";
7966
```
8067

8168
#### 实例调用方式

‎docs/docs/sdk/applet/initialization.md‎

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,23 @@
1111
使用 SDK 前需要进行初始化，示例代码如下：
1212

1313
```javascript
14-
const conn = new EC.connection({
14+
const chatClient = new ChatSDK.connection({
1515
appId: "your appId",
1616
});
1717
```
1818

1919
初始化 SDK 参数说明：
2020

21-
| 参数 | 类型 | 是否必需 | 描述 |
22-
| :-------------------- | :----- | :------- | :------------------------ |
23-
| `appId` | String | 是 | 声网控制台为你的应用生成的唯一标识。 |
24-
| `isHttpDNS` | Bool | 否 | 是否开启 DNS，防止 DNS 劫持。<br/> -（默认）`true`：开启 DNS；<br/> - `false`：关闭 DNS。 |
25-
| `delivery` | Bool | 否 | 是否开启送达回执：<br/> - `true`：开启；<br/> -（默认）`false`：关闭。 |
26-
| `enableReportLogs` | Bool | 否 | 小程序平台是否允许上传日志：<br/> - `true`：开启；<br/> -（默认）`false`：关闭。 |
27-
| `https` | Bool | 否 | 是否支持通过 HTTPS 访问即时通讯 IM：<br/> - （默认）`true`：支持 HTTPS 和 HTTP；<br/> -`false`：浏览器根据使用的域名自行判断。 |
28-
| `heartBeatWait` | Int | 否 | 心跳间隔，单位为毫秒，默认为 30000。 |
29-
| `deviceId` | String | 否 | 设备 ID，为默认随机值。 |
30-
| `useOwnUploadFun` | Bool | 否 | 是否支持通过自己的路径将图片、文件上传到自己的服务器。<br/> -`true`：支持，需要指定路径；<br/> -（默认）`false`：关闭，通过消息服务器上传下载文件。 |
31-
| `autoReconnectNumMax` | Int | 否 | 最大重连次数。 |
32-
| `apiUrl` | String | 是 | 指定的 REST 服务器。在未开启 DNS 的情况下使用，一般适用于开发者要实现数据隔离、特别注重数据安全的场景。要获取该服务器地址，需在[声网控制台](https://console.shengwang.cn/overview)的 **全部产品 > 即时通讯 IM > 功能配置 > 础信息** 页面，查看 **访问域名**区域中的 **REST API** 设置。 |
33-
| `url` | String | 是 | 指定的消息服务器。在未开启 DNS 的情况下使用，一般适用于开发者要实现数据隔离、特别注重数据安全的场景。需在[声网控制台](https://console.shengwang.cn/overview)的 **全部产品 > 即时通讯 IM > 功能配置 > 础信息** 页面，查看 **访问域名**区域中的 **WebSocket 地址** 设置。 |
34-
35-
// TODO：上表中的 `url` 的的配置对吗？
21+
| 参数 | 类型 | 是否必需 | 描述 |
22+
| :-------------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
23+
| `appId` | String | 是 | 声网控制台为你的应用生成的唯一标识。 |
24+
| `isHttpDNS` | Bool | 否 | 是否开启 DNS，防止 DNS 劫持。<br/> -（默认）`true`：开启 DNS；<br/> - `false`：关闭 DNS。 |
25+
| `delivery` | Bool | 否 | 是否开启送达回执：<br/> - `true`：开启；<br/> -（默认）`false`：关闭。 |
26+
| `enableReportLogs` | Bool | 否 | 小程序平台是否允许上传日志：<br/> - `true`：开启；<br/> -（默认）`false`：关闭。 |
27+
| `https` | Bool | 否 | 是否支持通过 HTTPS 访问即时通讯 IM：<br/> - （默认）`true`：支持 HTTPS 和 HTTP；<br/> -`false`：浏览器根据使用的域名自行判断。 |
28+
| `heartBeatWait` | Int | 否 | 心跳间隔，单位为毫秒，默认为 30000。 |
29+
| `deviceId` | String | 否 | 设备 ID，为默认随机值。 |
30+
| `useOwnUploadFun` | Bool | 否 | 是否支持通过自己的路径将图片、文件上传到自己的服务器。<br/> -`true`：支持，需要指定路径；<br/> -（默认）`false`：关闭，通过消息服务器上传下载文件。 |
31+
| `autoReconnectNumMax` | Int | 否 | 最大重连次数。 |
32+
| `apiUrl` | String | 是 | 指定的 REST 服务器。在未开启 DNS 的情况下使用，一般适用于开发者要实现数据隔离、特别注重数据安全的场景。要获取该服务器地址，需在[声网控制台](https://console.shengwang.cn/overview)的 **全部产品 > 即时通讯 IM > 功能配置 > 础信息** 页面，查看 **访问域名**区域中的 **REST API** 设置。 |
33+
| `url` | String | 是 | 指定的消息服务器。在未开启 DNS 的情况下使用，一般适用于开发者要实现数据隔离、特别注重数据安全的场景。需在[声网控制台](https://console.shengwang.cn/overview)的 **全部产品 > 即时通讯 IM > 功能配置 > 础信息** 页面，查看 **访问域名**区域中的 **WebSocket 地址** 设置。 |

‎docs/docs/sdk/applet/push/uniapp_push.md‎

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

99
1. 已开启即时通讯服务，详见 [开启和配置即时通讯服务](enable_im.html)。
1010
2. 了解即时通讯 IM 的使用限制，详见 [使用限制](limitation.html)。
11-
3. 你已在 [声网控制台](https://console.shengwang.cn/overview)的**即时通讯 IM** > **功能配置** > **推送模板** 页签下开启高级功能。高级功能激活后，你可以设置推送通知方式、免打扰模式和自定义推送模板。**高级功能开启后，如需关闭必须联系商务，因为该操作会删除所有相关配置。**
11+
3. 你已在 [声网控制台](https://console.shengwang.cn/overview)的**即时通讯 IM** > **功能配置** > **推送模板** 页签下开启高级功能。高级功能激活后，你可以设置推送通知方式、免打扰模式和自定义推送模板。**高级功能开启后，如需关闭必须联系商务，因为该操作会删除所有相关配置。**
1212
4. 各推送使用的条件：
1313
- 小米推送：在小米设备上可用；
1414
- 华为推送：在华为设备上可用；
@@ -33,9 +33,7 @@
3333

3434
### 步骤二 配置 uni-app 应用支持推送插件
3535

36-
// TODO：替换链接
37-
38-
1. 新建 uni-app 工程，并引入[声网 uni-app 推送插件](https://downloadsdk.easemob.com/downloads/WEB_SDK/EMPushUniPlugin_V1.0.0.zip)。
36+
1. 新建 uni-app 工程，并引入[声网 uni-app 推送插件](https://download.shengwang.cn/sdk/release/EMPushUniPlugin_v1.0.0.zip)。
3937

4038
在你的 uni-app 应用根目录下新建 `nativeplugins` 文件夹，然后将下载的插件放置于 `nativeplugins` 文件夹下。如下图所示：
4139

0 commit comments

Comments
 (0)