Skip to content

Commit 1fa53aa

Browse files
authored
Merge pull request #1375 from Yleiting/privatization-v3
补充其他端文档
2 parents 42a5a28 + fef8ae3 commit 1fa53aa

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+192
-243
lines changed

docs/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1224,18 +1224,18 @@ projects:
12241224
- icon: /sdk/rest.svg
12251225
text: REST
12261226
link: /document/server-side/push.html
1227-
- text: 即时推送
1228-
desc: 即时推送服务的应用场景包括系统消息通知、活动促销营销、运营促活推送、社交互动通知、以及内容订阅推送等,覆盖谷歌、华为、小米、魅族、OPPO、VIVO 等主流手机厂商通道。
1229-
sdks:
1230-
- icon: /sdk/android.svg
1231-
text: Android
1232-
link: /push/push_integration_note_android.html
1233-
- icon: /sdk/iOS.svg
1234-
text: iOS
1235-
link: /push/push_integration_note_ios.html
1236-
- icon: /sdk/rest.svg
1237-
text: REST
1238-
link: /push/push_by_tag.html
1227+
# - text: 即时推送
1228+
# desc: 即时推送服务的应用场景包括系统消息通知、活动促销营销、运营促活推送、社交互动通知、以及内容订阅推送等,覆盖谷歌、华为、小米、魅族、OPPO、VIVO 等主流手机厂商通道。
1229+
# sdks:
1230+
# - icon: /sdk/android.svg
1231+
# text: Android
1232+
# link: /push/push_integration_note_android.html
1233+
# - icon: /sdk/iOS.svg
1234+
# text: iOS
1235+
# link: /push/push_integration_note_ios.html
1236+
# - icon: /sdk/rest.svg
1237+
# text: REST
1238+
# link: /push/push_by_tag.html
12391239
- title: UIKit 功能
12401240
features:
12411241
- title: 单群聊 UIKit

docs/document/applet/alipay.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414

1515
小程序在发布前,需要配置合法域名。
1616

17-
登录 [支付宝开放平台](https://open.alipay.com/platform/home.htm), 配置以下服务器域名
17+
登录 [支付宝开放平台](https://open.alipay.com/platform/home.htm), 配置 **私有化服务器域名**
1818

19-
:::tip
19+
<!-- :::tip
2020
request 合法域名:
2121
2222
1. https://a1.easemob.com
@@ -52,15 +52,15 @@ wss://im-api-alipay.easemob.com/websocket
5252
5353
### 说明
5454
55-
支付宝小程序:支付宝小程序在一段时间内只能保留一个 WebSocket 连接,如果当前已存在 WebSocket 连接,那么会自动关闭该连接,并重新创建一个新的 WebSocket 连接。
55+
支付宝小程序:支付宝小程序在一段时间内只能保留一个 WebSocket 连接,如果当前已存在 WebSocket 连接,那么会自动关闭该连接,并重新创建一个新的 WebSocket 连接。 -->
5656

5757
### 集成 SDK
5858

5959
#### 下载 SDK
6060

6161
可以通过以下两种方式获取 SDK:
6262

63-
- 通过官网 [下载 SDK](https://www.easemob.com/download/im)
63+
- 通过官网 [下载 SDK](https://github.com/easemob/webim-weixin-xcx)
6464
- 从环信的 [github 仓库](https://github.com/easemob/webim-weixin-xcx/tree/master/src/sdk) 中获取 SDK 中的文件。
6565

6666
#### 引入 SDK

docs/document/applet/baidu.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414

1515
小程序在发布前,需要配置合法域名。
1616

17-
登录 [百度智能小程序官网](https://smartprogram.baidu.com/)在开发设置页面配置以下服务器域名
17+
登录 [百度智能小程序官网](https://smartprogram.baidu.com/)在开发设置页面配置 **私有化服务器域名**
1818

19-
:::tip
19+
<!-- :::tip
2020
request 合法域名:
2121
2222
1. https://a1.easemob.com
@@ -56,15 +56,15 @@ wss://im-api-wechat.easemob.com(3.0 IM SDK)
5656
5757
### 说明
5858
59-
百度小程序注册主体不能为个人,必须为企业、媒体、政府等。
59+
百度小程序注册主体不能为个人,必须为企业、媒体、政府等。 -->
6060

6161
### 集成 SDK
6262

6363
#### 下载 SDK
6464

6565
可以通过以下两种方式获取 SDK:
6666

67-
- 通过官网 [下载 SDK](https://www.easemob.com/download/im)
67+
- 通过官网 [下载 SDK](https://github.com/easemob/webim-weixin-xcx)
6868
- 从环信的 [github 仓库](https://github.com/easemob/webim-weixin-xcx/tree/master/src/sdk) 中获取 SDK 中的文件
6969

7070
#### 引入 SDK

docs/document/applet/bytedance.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414

1515
小程序在发布前,需要配置合法域名。
1616

17-
登录抖音小程序 [开发者平台](https://microapp.bytedance.com/),选择当前小程序(如果没有需要创建一个小程序),进入 **开发管理 > 开发设置** 页面配置以下服务器地址
17+
登录抖音小程序 [开发者平台](https://microapp.bytedance.com/),选择当前小程序(如果没有需要创建一个小程序),进入 **开发管理 > 开发设置** 页面配置 **私有化服务器域名**
1818

19-
:::tip
19+
<!-- :::tip
2020
request 合法域名:
2121
2222
1. https://a1.easemob.com
@@ -53,15 +53,15 @@ wss://im-api-wechat.easemob.com(3.0 IM SDK)
5353
5454
应用所在数据中心可以在环信用户管理后台 > **即时通讯** > **服务概览**中查看:
5555
56-
![img](/images/applet/service_overview.png)
56+
![img](/images/applet/service_overview.png) -->
5757

5858
### 集成 SDK
5959

6060
#### 下载 SDK
6161

6262
可以通过以下两种方式获取 SDK:
6363

64-
- 通过官网 [下载 SDK](https://www.easemob.com/download/im)
64+
- 通过官网 [下载 SDK](https://github.com/easemob/webim-weixin-xcx)
6565
- 从环信的 [github 仓库](https://github.com/easemob/webim-weixin-xcx/tree/master/src/sdk) 中获取 SDK 中的文件
6666

6767
#### 引入 SDK

docs/document/applet/login.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
用户注册支持以下方式:
88

9-
- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。
9+
- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](/product/enable_and_configure_IM.html#创建应用)**应用概览** > **应用详情****应用设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。
1010

1111
示例代码如下:
1212

@@ -17,16 +17,14 @@ conn.registerUser({
1717
});
1818
```
1919

20-
- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)**即时通讯** > **服务概览****设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。
20+
- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](/product/enable_and_configure_IM.html#创建应用)**应用概览** > **应用详情****应用设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。
2121

22-
除此以外,可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)
22+
除此以外,可以在[环信即时通讯云控制台](/product/enable_and_configure_IM.html#用户管理)创建IM用户
2323

2424
## 登录方式
2525

2626
1. **用户 ID + token** 是更加安全的登录方式。
2727

28-
测试环境下,你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后,环信服务器会自动为这些用户分配用户 Token,详见[测试环境下创建用户的介绍](/product/enable_and_configure_IM.html#测试环境)
29-
3028
在生产环境中,为了安全考虑,你需要在你的应用服务器集成[获取 App Token API](/document/server-side/easemob_app_token.html)[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑,使你的用户从你的应用服务器获取 Token。SDK 会在 Token 过期时或者其有效期达到 80%(4.15.0 之前为 50%)时分别回调 `onTokenExpired``onTokenWillExpire` 通知用户更新 Token。你可以采取各种机制更新 Token,例如,每次登录时更新 token。
3129

3230
```javascript

docs/document/applet/message_send.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
环信即时通讯 IM 的小程序 SDK 可以实现文本、图片、音频、视频和文件等类型的消息的发送和接收。
66

7-
- 对于单聊,环信即时通信 IM 默认支持陌生人之间发送消息,即无需添加好友即可聊天。若仅允许好友之间发送单聊消息,你需要 [开启好友关系检查](/product/enable_and_configure_IM.html#好友关系检查)
7+
- 对于单聊,环信即时通信 IM 默认支持陌生人之间发送消息,即无需添加好友即可聊天。若仅允许好友之间发送单聊消息,你需要 [环信即时通讯云控制台](/product/enable_and_configure_IM.html#创建应用)**应用概览** > **应用详情****应用设置**区域,开启好友关系检查
88
- 对于群组和聊天室,用户每次只能向所属的单个群组和聊天室发送消息。
99
- 关于消息发送控制,详见 [单聊](/product/message_single_chat.html#单聊消息发送控制)[群组聊天](/product/message_group.html#群组消息发送控制)[聊天室](/product/message_chatroom.html#聊天室消息发送控制) 的 相关文档。
1010

@@ -131,7 +131,7 @@ function sendPrivateAudio(tempFilePath, duration) {
131131

132132
### 发送图片消息
133133

134-
创建和发送图片消息。SDK 会将图片上传至环信服务器,服务器自动生成图片缩略图。
134+
创建和发送图片消息。SDK 会将图片上传至环信服务器,如果私有部署提供oss环境,服务器自动生成图片缩略图。
135135

136136
```javascript
137137
function sendImage() {
@@ -242,7 +242,7 @@ sendGIFMsg(){
242242

243243
1. 发送视频消息之前,在 app 级别实现视频捕获以及捕获文件的上传。
244244

245-
2. 创建和发送视频消息。SDK 会将视频文件上传至消息服务器。服务端自动生成视频消息的缩略图。
245+
2. 创建和发送视频消息。SDK 会将视频文件上传至消息服务器。如果私有部署提供oss环境,服务端自动生成视频消息的缩略图。
246246

247247
```javascript
248248
function sendPrivateVideo(){
@@ -577,12 +577,3 @@ function sendTextMessage() {
577577
}
578578
```
579579

580-
### 发送消息前的内容审核
581-
582-
- 内容审核关注消息 body
583-
584-
[内容审核服务会关注消息 body 中指定字段的内容,不同类型的消息审核不同的字段](/product/moderation/moderation_mechanism.html),若创建消息时在这些字段中传入了很多业务信息,可能会影响审核效果。因此,创建消息时需要注意内容审核的字段不涉及业务信息,建议业务信息放在扩展字段中。
585-
586-
- 设置发送方收到内容审核替换后的内容
587-
588-
若初始化时打开了 `EMOptions#useReplacedMessageContents` 开关,发送文本消息时如果被内容审核(Moderation)进行了内容替换,发送方会收到替换后的内容。若该开关为关闭状态,则发送方不会收到替换后的内容。

docs/document/applet/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ SDK 目前支持微信、QQ、百度小程序、抖音、uni-app 编译的原生
2222
:::tip
2323

2424
- 小程序 Demo 只包含部分 IM 功能,详细参考 **功能说明**
25-
- 各小程序 Demo 源码可在官网 [下载页](https://www.easemob.com/download/im) 获取
26-
- Uni-app Demo Git 源码地址:[https://github.com/easemob/webim-uniapp-demo](https://github.com/easemob/webim-uniapp-demo)
25+
- 各小程序 SDK 可在官网 [下载](https://github.com/easemob/webim-weixin-xcx) 获取
26+
- Uni-app Demo Git 源码地址:[下载](https://github.com/easemob/webim-uniapp-demo)
2727
:::
2828

2929
## 功能说明

docs/document/applet/push/push_overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
**多设备离线推送策略**
1818

19-
多设备登录时,可在[环信即时通讯控制台](https://console.easemob.com/user/login)**证书管理**页面配置推送策略,该策略配置对所有推送通道生效:
19+
多设备登录时,可在 **环信即时通讯控制台** **证书管理**页面配置推送策略,该策略配置对所有推送通道生效:
2020

2121
- 所有设备离线时,才发送推送消息;
2222
- 任一设备离线时,都发送推送消息。
@@ -39,6 +39,6 @@
3939
- 设置推送模板。
4040
- 设置推送扩展功能:包括强制推送和发送静默消息。
4141

42-
其中,**推送高级功能包括设置推送通知方式、免打扰模式和自定义推送模板**。使用前,你需要在 [环信即时通讯控制台](https://console.easemob.com/user/login)**即时通讯 > 功能配置 > 功能配置总览**页面激活。如需关闭推送高级功能必须联系商务,因为该操作会删除所有相关配置。
42+
其中,**推送高级功能包括设置推送通知方式、免打扰模式和自定义推送模板**。使用前,你需要在 **环信即时通讯控制台** **即时通讯 > 功能配置 > 功能配置总览**页面激活。如需关闭推送高级功能必须联系商务,因为该操作会删除所有相关配置。
4343

4444
![image](/images/web/push_web_enable_push.png)

docs/document/applet/push/uniapp_push.md

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

99
1. 已开启环信即时通讯服务,详见 [开启和配置即时通讯服务](/product/enable_and_configure_IM.html)
1010
2. 了解环信即时通讯 IM 的使用限制,详见 [使用限制](/product/limitation.html)
11-
3. 你已在 [环信即时通讯控制台](https://console.easemob.com/user/login)**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。高级功能激活后,你可以设置推送通知方式、免打扰模式和自定义推送模板。**如需关闭推送高级功能必须联系商务,因为该操作会删除所有相关配置。**
11+
3. 你已在 **环信即时通讯控制台** **即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。高级功能激活后,你可以设置推送通知方式、免打扰模式和自定义推送模板。**如需关闭推送高级功能必须联系商务,因为该操作会删除所有相关配置。**
1212
4. 各推送使用的条件:
1313
- 小米推送:在小米设备上可用;
1414
- 华为推送:在华为设备上可用;
@@ -27,7 +27,7 @@
2727

2828
1. 在第三方推送服务后台注册应用,获取应用信息,开启推送服务。
2929

30-
2.[环信即时通讯云控制台](https://console.easemob.com/user/login)配置获取到的应用信息,上传推送证书,实现第三方推送服务与环信即时通讯 IM 的通信。
30+
2. **环信即时通讯云控制台** 配置获取到的应用信息,上传推送证书,实现第三方推送服务与环信即时通讯 IM 的通信。
3131

3232
:::tip
3333
更多详情,参见 [Android 离线推送](/document/android/push/push_fcm.html)[APNs 离线推送](/document/ios/push/push_apns.html)
@@ -169,7 +169,7 @@ onLaunch(() => {
169169

170170
2. 即时通讯 IM 是否支持多设备离线推送?
171171

172-
你可在[环信即时通讯控制台](https://console.easemob.com/user/login)**证书管理**页面配置多设备推送策略。该策略配置对所有推送通道生效:
172+
你可在 **环信即时通讯控制台** **证书管理**页面配置多设备推送策略。该策略配置对所有推送通道生效:
173173

174174
- 所有设备离线时,才发送推送消息;
175175
- 任一设备离线时,都发送推送消息。

docs/document/applet/qq.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818

1919
小程序在发布前,需要配置合法域名。
2020

21-
登录 QQ 小程序 [开发者平台](https://q.qq.com/),进入 “开发 > 开发设置” 页面配置以下服务器地址
21+
登录 QQ 小程序 [开发者平台](https://q.qq.com/),进入 “开发 > 开发设置” 页面配置 **私有化服务器域名**
2222

23-
:::tip
23+
<!-- :::tip
2424
request 合法域名:
2525
2626
1. https://a1.easemob.com
@@ -60,15 +60,15 @@ wss://im-api-wechat.easemob.com(3.0 IM SDK)
6060
6161
### 说明
6262
63-
QQ、微信小程序: 1.7.0 及以上版本,最多可以同时存在 5 个 WebSocket 连接,需开发者控制好连接数量,超出此限制 SDK 将不能连接上服务器。
63+
QQ、微信小程序: 1.7.0 及以上版本,最多可以同时存在 5 个 WebSocket 连接,需开发者控制好连接数量,超出此限制 SDK 将不能连接上服务器。 -->
6464

6565
### 集成 SDK
6666

6767
#### 下载 SDK
6868

6969
可以通过以下两种方式获取 SDK:
7070

71-
- 通过官网 [下载 SDK](https://www.easemob.com/download/im)
71+
- 通过官网 [下载 SDK](https://github.com/easemob/webim-weixin-xcx)
7272
- 从环信的 [github 仓库](https://github.com/easemob/webim-weixin-xcx/tree/master/src/sdk) 中获取 SDK 中的文件
7373

7474
#### 引入 SDK

0 commit comments

Comments
 (0)