Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions docs/.vuepress/config.ts.69f76f9a.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -1415,7 +1415,7 @@ var PUSH_SIDEBAR = [
text: "\u5FEB\u901F\u5165\u95E8",
children: [
{ text: "\u521B\u5EFA\u4EA7\u54C1\u53CA\u5E94\u7528", link: "push_createproduct_app.html" },
{ text: "\u521B\u5EFA\u63A8\u9001", link: "push_createnotification.html" },
{ text: "\u521B\u5EFA\u63A8\u9001", link: "push_task_create.html" },
{ text: "\u63A8\u9001\u4EFB\u52A1", link: "push_task.html" },
{ text: "\u6807\u7B7E\u7BA1\u7406", link: "push_tag_mgmt.html" },
{ text: "\u8BC1\u4E66\u914D\u7F6E", link: "push_certificate_config.html" },
Expand Down Expand Up @@ -1602,7 +1602,7 @@ var zhSidebar = sidebar({
},
{ text: "\u89C4\u5219\u6D4B\u8BD5", link: "moderation/moderation_rule_test.html" },
{ text: "\u5386\u53F2\u8BB0\u5F55", link: "moderation/moderation_history.html" },
{ text: "\u5173\u952E\u8BCD\u5BA1\u6838", link: "moderation/keyword_review.html" },
{ text: "\u5173\u952E\u8BCD\u5BA1\u6838", link: "moderation/moderation_keyword" },
{
text: "\u6D88\u606F\u5BA1\u6838\u673A\u5236",
link: "moderation/moderation_mechanism.html"
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.vuepress/public/images/instantpush/push_bind_user.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/.vuepress/public/images/instantpush/push_domain_name.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 10 additions & 20 deletions docs/.vuepress/sidebar/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -146,11 +146,12 @@ export const zhSidebar = sidebar({
link: "moderation/moderation_rule_config.html",
},
{ text: "规则测试", link: "moderation/moderation_rule_test.html" },
{ text: "数据总览", link: "moderation/moderation_data_overview.html" },
{ text: "历史记录", link: "moderation/moderation_history.html" },
{ text: "关键词审核", link: "moderation/keyword_review.html" },
{
text: "消息审核机制",
link: "moderation/moderation_mechanism.html",
{ text: "消息举报", link: "moderation/moderation_message_report.html" },
{ text: "关键词审核", link: "moderation/moderation_keyword" },
{ text: "标签管理", link: "moderation/moderation_user_tag" },
{ text: "消息审核机制", link: "moderation/moderation_mechanism.html",
},
],
},
Expand All @@ -163,10 +164,10 @@ export const zhSidebar = sidebar({
link: "moderation/moderation_record_callback.html",
},
{
text: "消息人工审核",
text: "群组/聊天室审核",
link: "moderation/moderation_manual_review.html",
},
{ text: "用户管理", link: "moderation/moderation_usermgmt.html" },
{ text: "用户审核", link: "moderation/moderation_usermgmt.html" },
],
},
],
Expand Down Expand Up @@ -245,20 +246,7 @@ export const zhSidebar = sidebar({
text: "配置增值功能",
collapsible: true,
children: [
{
text: "内容审核",
collapsible: true,
children: [
{ text: "数据总览", link: "console/moderation_data_overview.html" },
{ text: "规则配置", link: "console/moderation_rule_config.html" },
{ text: "规则测试", link: "console/moderation_rule_test.html" },
{ text: "历史记录", link: "console/moderation_history.html" },
{ text: "关键词名单", link: "console/moderation_keyword.html" },
{ text: "审核记录导出", link: "console/moderation_history_export.html" },
{ text: "消息举报", link: "console/moderation_message_report.html" },
{ text: "标签管理", link: "console/moderation_user_tag.html" },
],
},
{ text: "内容审核", link: "console/value_added_config_moderation.html" },
{
text: "即时推送",
collapsible: true,
Expand All @@ -272,6 +260,8 @@ export const zhSidebar = sidebar({
{ text: "推送统计", link: "console/push_statistics.html" },
],
},
{ text: "即时推送", link: "console/value_added_config_push.html" },
{ text: "实时音视频", link: "console/value_added_config_rtc.html" },
],
},
],
Expand Down
2 changes: 1 addition & 1 deletion docs/.vuepress/sidebar/push.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export const PUSH_SIDEBAR = [
text: '快速入门',
children: [
{ text: '创建产品及应用', link: 'push_createproduct_app.html' },
{ text: '创建推送', link: 'push_createnotification.html' },
{ text: '创建推送', link: 'push_task_create.html' },
{ text: '推送任务', link: 'push_task.html' },
{ text: '标签管理', link: 'push_tag_mgmt.html' },
{ text: '证书配置', link: 'push_certificate_config.html' },
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -590,7 +590,7 @@ projects:
text: Windows
link: /document/windows/message_pin.html
- text: 消息审核(举报)
desc: 你的用户可以在客户端举报违规消息。当服务器收到举报消息后,会将举报消息存储到数据库,并在环信即时通讯云控制台展示。你可在环信即时通讯云控制台查看举报记录,并进行相应处理。
desc: 你的用户可以在客户端举报违规消息。当服务器收到举报消息后,会将举报消息存储到数据库,并在环信控制台展示。你可在环信控制台查看举报记录,并进行相应处理。
sdks:
- icon: /sdk/android.svg
text: Android
Expand Down Expand Up @@ -2024,7 +2024,7 @@ projects:
- text: 查看历史记录
link: /product/moderation/moderation_history.html
- text: 关键词审核
link: /product/moderation/keyword_review.html
link: /product/moderation/moderation_keyword.html
- text: 消息审核机制
link: /product/moderation/moderation_mechanism.html
- text: 审核记录回调
Expand Down
2 changes: 1 addition & 1 deletion docs/callkit/android/easecallkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ EaseCallKit 集成在环信开源 IM Demo 中,你可以通过以下两种方

集成该库之前,你需要满足以下条件:

- 分别创建 [环信应用](/product/enable_and_configure_IM.html) 及 [声网应用](https://doc.shengwang.cn/doc/rtc/android/get-started/enable-service#创建声网项目);
- 分别创建 [环信应用](/product/console/app_create.html) 及 [声网应用](https://doc.shengwang.cn/doc/rtc/android/get-started/enable-service#创建声网项目);
- 已完成环信 IM 的基本功能,包括登录、好友、群组以及会话等的集成;
- 上线之前开通声网 Token 验证时,用户需要实现自己的 [App Server](https://github.com/easemob/easemob-im-app-server/tree/master/agora-app-server),用于生成 Token。具体请参见 [创建 Token 服务及使用 App Server 生成 Token](https://doc.shengwang.cn/doc/rtc/android/basic-features/token-authentication)。

Expand Down
2 changes: 1 addition & 1 deletion docs/callkit/android/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ dependencyResolutionManagement {
}
```

2. 在 app(module) 目录的 `build.gradle.kts` 文件中添加以下依赖
2. 在 app(module) 目录的 `build.gradle.kts` 文件中添加以下依赖。关于 CallKit 的最新版本,详见 [Maven 仓库](https://central.sonatype.com/artifact/io.hyphenate/chat-call-kit/overview)。

```kotlin
dependencies {
Expand Down
2 changes: 1 addition & 1 deletion docs/callkit/android/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ dependencyResolutionManagement {
}
```

- 在 app(module) 目录的 `build.gradle.kts` 文件中添加以下依赖
- 在 app(module) 目录的 `build.gradle.kts` 文件中添加以下依赖。关于 CallKit 的最新版本,详见 [Maven 仓库](https://central.sonatype.com/artifact/io.hyphenate/chat-call-kit/overview)。

```kotlin
dependencies {
Expand Down
2 changes: 1 addition & 1 deletion docs/callkit/ios/easecallkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ pod install

在集成该库前,你需要满足以下条件:

- 分别创建 [环信应用](/product/enable_and_configure_IM.html) 及 [声网应用](https://doc.shengwang.cn/doc/rtc/ios/get-started/enable-service#创建声网项目);
- 分别创建 [环信应用](/product/console/app_create.html) 及 [声网应用](https://doc.shengwang.cn/doc/rtc/ios/get-started/enable-service#创建声网项目);
- 已完成环信 IM 的基本功能,包括登录、好友、群组以及会话等的集成;
- 上线之前开通声网 token 验证时,用户需要实现自己的 [App Server](https://github.com/easemob/easemob-im-app-server/tree/master/agora-app-server),用于生成 token。利用 App Server 生成 token 的过程参见 [声网 token](https://doc.shengwang.cn/doc/rtc/ios/basic-features/token-authentication)。

Expand Down
2 changes: 1 addition & 1 deletion docs/callkit/web/easecallkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

集成该库之前,你需要满足以下条件:

- 创建 [环信应用](/product/enable_and_configure_IM.html)及[声网应用](https://doc.shengwang.cn/doc/rtc/javascript/get-started/enable-service#创建声网项目);
- 创建 [环信应用](/product/console/app_create.html)及[声网应用](https://doc.shengwang.cn/doc/rtc/javascript/get-started/enable-service#创建声网项目);
- 实现环信 IM 的基本功能,包括登录、好友、群组以及会话等的集成;
- 上线前开通声网 Token 验证时,用户需要实现自己的 [App Server](https://github.com/easemob/easemob-im-app-server/tree/master/agora-app-server),用于生成 Token。详见[创建 Token 服务及使用 App Server 生成 Token](https://doc.shengwang.cn/doc/rtc/javascript/basic-features/token-authentication)。

Expand Down
2 changes: 1 addition & 1 deletion docs/document/android/conversation_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
:::tip
1. **若使用该功能,需 [在环信控制台开通](/product/console/basic_conversation_group_chatroom.html#服务端会话列表),并将 SDK 升级至 4.0.3。而且,只有开通该功能,你才能使用置顶会话和会话标记功能。**
2. 建议你在首次下载、卸载后重装应用等本地数据库无数据情况下拉取服务端会话列表。其他情况下,调用 `asyncFilterConversationsFromDB`、`getAllConversationsBySort` 或 `getAllConversations` 方法获取本地所有会话即可。
3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送,获取会话列表时,该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能,需在[环信即时通讯控制台开通](/product/enable_and_configure_IM.html#设置通过-restful-api-发送的消息写入会话列表)。
3. 通过 RESTful 接口发送的消息默认不创建或写入会话。若会话中的最新一条消息通过 RESTful 接口发送,获取会话列表时,该会话中的最新一条消息显示为通过非 RESTful 接口发送的最新消息。若要开通 RESTful 接口发送的消息写入会话列表的功能,需在[环信控制台开通](/product/console/basic_conversation_group_chatroom.html#rest-发消息写会话列表)。
:::

示例代码如下:
Expand Down
6 changes: 3 additions & 3 deletions docs/document/android/demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@

### 跑通步骤

1. [创建应用](/product/enable_and_configure_IM.html#创建应用)。
2. [获取应用的 App Key](/product/enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。
3. [创建用户](/product/enable_and_configure_IM.html#创建-im-用户)。
1. [创建应用](/product/console/app_create.html)。
2. [获取应用的 App Key](/product/console/app_manage.html#查看应用信息)。
3. [创建用户](/product/console/operation_user.html#创建用户)。
4. [下载即时通讯 IM Demo 项目源码](https://github.com/easemob/easemob-demo-android)。
5. 下载完毕,打开 Android Studio,点击 **File > Open**,打开已下载到本地的 Demo (`easemob-demo-android`) 工程根目录即可。
6. 将你的应用的 App Key 填入 Demo 工程根目录下的 `local.properties` 文件,格式为 `APPKEY = 你申请的appkey`。
Expand Down
2 changes: 1 addition & 1 deletion docs/document/android/initialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## 前提条件

有效的环信即时通讯 IM 开发者账号和 App key,详见[环信即时通讯云控制台的相关文档](/product/enable_and_configure_IM.html#创建应用)。
有效的环信即时通讯 IM 开发者账号和 App key,详见[环信控制台的相关文档](/product/console/app_create.html)。

## 初始化

Expand Down
10 changes: 5 additions & 5 deletions docs/document/android/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

1. 可通过以下两种方式调用接口创建用户:

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

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

示例代码如下所示:

Expand All @@ -19,13 +19,13 @@ EMClient.getInstance().createAccount(mAccount, mPassword);// 同步方法。

2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户:

可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户,详见 [创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。
可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户,详见 [创建用户相关介绍](/product/console/operation_user.html#创建用户)。

## 主动登录

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

测试环境下,你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后,环信服务器会自动为这些用户分配用户 Token,详见[测试环境下创建用户的介绍](/product/enable_and_configure_IM.html#测试环境)。
测试环境下,你在[环信控制台](https://console.easemob.com/user/login)创建用户后,环信服务器会自动为这些用户分配用户 Token,详见[查看用户 Token](/product/console/operation_user.html#查看用户-token)。

在生产环境中,为了安全考虑,你需要在你的应用服务器集成 [获取 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。

Expand Down Expand Up @@ -130,4 +130,4 @@ EMClient.getInstance().logout(true, new EMCallBack() {

### 登录被封禁账号的提示

在环信即时通讯控制台或调用 REST API 封禁用户账号后,若仍使用该账号登录,SDK会返回 "service is disabled"(305 错误), 可以根据用户这个返回值来进行相应的提示或者处理。
在环信控制台或调用 REST API 封禁用户账号后,若仍使用该账号登录,SDK会返回 "service is disabled"(305 错误), 可以根据用户这个返回值来进行相应的提示或者处理。
2 changes: 1 addition & 1 deletion docs/document/android/message_recall.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- 对于单聊会话,只支持发送方撤回发送成功的消息。若消息过期,撤回失败。
- 对于群组/聊天室会话,普通成员只能撤回自己发送的消息,若消息过期,撤回失败。群主/聊天室所有者和管理员可撤回其他用户发送的消息,即使消息过期也能撤回。
- **除了透传消息,其他各类型的消息都支持撤回**
- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)**功能配置** > **功能配置总览** > **基础功能** 页面设置消息撤回时长,该时长不超过 7 天。
- 默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在[环信控制台](https://console.easemob.com/user/login)**功能配置** > **功能配置总览** > **基础功能** 页面设置消息撤回时长,该时长不超过 7 天。
- 撤回消息时,服务端的消息(历史消息,离线消息或漫游消息)以及消息发送方和接收方的内存和数据库中的消息均会被移出。
- 对于附件类型消息,包括图片、音频和视频和文件消息,撤回消息后,消息附件也相应删除。

Expand Down
Loading