Skip to content

Commit

Permalink
modify
Browse files Browse the repository at this point in the history
  • Loading branch information
haoxiuwen committed Dec 20, 2024
1 parent 7c7ab90 commit f244706
Show file tree
Hide file tree
Showing 118 changed files with 194 additions and 194 deletions.
4 changes: 2 additions & 2 deletions docs/document/android/easecallkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

**利用 `EaseCallKit` 通话过程中,使用环信 ID 加入频道,方便音视频视图中显示用户名。如果用户不使用 `EaseCallKit` 而直接调用声网 API,也可以直接使用数字 UID 加入频道。**

:::notice
:::tip
本 UI 库只和移动端 3.8.0 及以上版本 Demo 互通。3.8.1 的 UI 库使用声网数字 uid 加入频道,而 3.8.0 使用字符串加入频道,3.8.1 版本不与 3.8.0 互通,Demo 中 EaseCallKit 使用的 token 和 UID 均由你自己生成。若你需要使用声网对应的音视频服务,需单独在声网申请。
:::

Expand Down Expand Up @@ -59,7 +59,7 @@ EaseCallKit 集成在环信开源 IM Demo 中,你可以通过进入 [环信 De
implementation 'io.hyphenate:ease-call-kit:3.8.9'
```

:::notice
:::tip
`EaseCallKit` 必须依赖环信 IM SDK (即 hyphenate-chat) ,因而在使用 `EaseCallKit` 时必须同时添加环信 IM SDK 依赖。
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/document/android/group_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ EMClient.getInstance().groupManager().createGroup(groupName, desc, allMembers, r

仅群主可以调用 `destroyGroup` 方法解散群组。群组解散时,其他群组成员收到 `EMGroupChangeListener#onGroupDestroyed` 回调并被踢出群组。

:::notice
:::tip
该操作是危险操作,解散群组后,将删除本地数据库及内存中的群相关信息及群会话。
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/document/android/group_members.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ EMClient.getInstance().groupManager().asyncRemoveUsersFromGroup("GroupId", userL

你可调用 `EMGroupManager#asyncFetchGroupMembersAttributes` 方法根据指定的属性 key 获取多个群成员的自定义属性。

:::notice
:::tip
每次最多可获取 10 个群成员的自定义属性。
:::

Expand Down
4 changes: 2 additions & 2 deletions docs/document/android/multi_device.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ EMClient.getInstance().chatManager().sendMessage(message);

你可以调用 `kickDevice``kickDeviceWithToken` 方法通过传入用户 ID 和登录密码或用户 token 将指定账号从单个登录设备踢下线。调用这两种方法前,你需要首先通过 `EMClient#getLoggedInDevicesFromServer``EMDeviceInfo#getResource` 方法获取设备 ID。

:::notice
:::tip
不登录也可以使用该接口。
:::

Expand All @@ -204,7 +204,7 @@ EMClient.getInstance().kickDevice(username, password, deviceInfos.get(selectedIn

你可以调用 `kickAllDevices``kickAllDevicesWithToken` 方法通过传入用户 ID 和登录密码或用户 token 将指定账号从所有登录设备踢下线。

:::notice
:::tip
不登录也可以使用该接口。
:::

Expand Down
6 changes: 3 additions & 3 deletions docs/document/android/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ options.setAppKey("Your appkey");
EMClient.getInstance().init(context, options);
```

:::notice
:::tip
需要在主进程中进行初始化。
:::

Expand Down Expand Up @@ -69,7 +69,7 @@ EMClient.getInstance().init(context, options);
EMClient.getInstance().createAccount(mAccount, mPassword);// 同步方法。
```

:::notice
:::tip
该注册模式为在客户端注册,旨在方便测试,并不推荐在正式环境中使用。
:::

Expand Down Expand Up @@ -109,7 +109,7 @@ EMClient.getInstance().login(mAccount, mPassword, new EMCallBack() {

**用户 ID + token** 是更加安全的登录方式。token 可以通过调用 REST API 获取。详见 [环信用户 token 的获取](/document/server-side/easemob_user_token.html)

:::notice
:::tip
使用 token 登录时需要处理 token 过期的问题,比如在每次登录时更新 token 等机制。
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/document/android/privatecloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ emOptions.enableDNSConfig(false);//默认是 true,在私有云下,需要关

EMClient.getInstance().init(context,emOptions);//最后初始化 SDK
```
:::notice
:::tip
如果需要配置 HTTPS 只需在 REST 地址前加一个前缀。
:::

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

:::notice
:::tip
如果使用 3.8.0 之前的版本,gradle 依赖需要按照下面格式添加:
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/document/android/reaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

环信即时通讯 IM 提供消息表情回复(下文统称 “Reaction”)功能。用户可以在单聊和群聊中对消息添加、删除表情。表情可以直观地表达情绪,利用 Reaction 可以提升用户的使用体验。同时在群组中,利用 Reaction 可以发起投票,根据不同表情的追加数量来确认投票。

:::notice
:::tip

目前 Reaction 仅适用于单聊和群组。聊天室暂不支持 Reaction 功能。
:::
Expand Down
4 changes: 2 additions & 2 deletions docs/document/android/room_members.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ EMClient.getInstance().chatroomManager().removeFromChatRoomWhiteList(chatRoomId,

仅聊天室所有者和管理员可以调用 `EMChatRoomManager#muteChatRoomMembers` 方法将指定成员添加至聊天室禁言列表。被禁言的成员和其他未操作的聊天室管理员或聊天室所有者收到 `EMChatRoomChangeListener#onMuteListAdded` 回调。

:::notice
:::tip
聊天室所有者可禁言聊天室所有成员,聊天室管理员可禁言聊天室普通成员。
:::

Expand All @@ -229,7 +229,7 @@ EMChatRoom chatRoom = EMClient.getInstance().chatroomManager().muteChatRoomMembe

仅聊天室所有者和管理员可以调用 `EMChatRoomManager#unMuteChatRoomMembers` 方法将成员移出聊天室禁言列表。被解除禁言的成员和其他未操作的聊天室管理员或聊天室所有者收到 `EMChatRoomChangeListener#onMuteListRemoved` 回调。

:::notice
:::tip
聊天室所有者可对聊天室所有成员解除禁言,聊天室管理员可对聊天室普通成员解除禁言。
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/document/android/thread.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ EMClient.getInstance().chatThreadManager().createChatThread(parentId, messageId,

单设备登录时,子区所属群组的所有成员均会收到 `EMChatThreadChangeListener#onChatThreadDestroyed` 回调;多设备登录时,其他设备会同时收到 `EMMultiDeviceListener#onThreadEvent` 回调,回调事件为 `THREAD_DESTROY`

:::notice
:::tip
解散子区或解散子区所在的群组后,将删除本地数据库及内存中关于该子区的全部数据,需谨慎操作。
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/document/android/userprofile.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

本文介绍如何通过管理用户属性设置、更新、存储并获取实时消息用户的相关信息。

:::notice
:::tip
为保证用户信息安全,SDK 仅支持用户设置或更新自己的用户属性。
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/document/applet/baidu.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ socket 合法域名:
wss://im-api-wechat.easemob.com(3.0 IM SDK)
:::

:::notice
:::tip
为满足不同客户的业务需求,环信在多地部署了数据中心。不同数据中心的 REST API 请求域名、WebSocket 访问域名不同。请根据您所在数据中心进行配置。
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/document/applet/bytedance.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ socket 合法域名:
wss://im-api-wechat.easemob.com(3.0 IM SDK)
:::

:::notice
:::tip
为满足不同客户的业务需求,环信在多地部署了数据中心。不同数据中心的 REST API 请求域名、WebSocket 访问域名不同。请根据您所在数据中心进行配置。
:::

Expand Down
8 changes: 4 additions & 4 deletions docs/document/applet/message_send_receive.md
Original file line number Diff line number Diff line change
Expand Up @@ -556,7 +556,7 @@ function sendCMDMessage() {
- 收到消息后,如果用户 B 与用户 A 的聊天页面处于打开状态,则显示用户 A 的输入指示器。
- 如果用户 B 在几秒后未收到用户 A 的输入,则自动取消输入指示器。

:::notice
:::tip
用户 A 可根据需要设置透传消息发送间隔。
:::

Expand Down Expand Up @@ -671,7 +671,7 @@ function sendCustomMsg() {
2. 发送合并消息。
3. 对端收到合并消息后进行解析,获取原始消息列表。

:::notice
:::tip

该功能在 uniapp 中暂不支持运行到原生手机端。

Expand All @@ -694,7 +694,7 @@ function sendCustomMsg() {
| `onFileUploadComplete` | (data: { url: string; secret: string;}) => void | 合并消息文件上传完成的回调。 |
| `onFileUploadError` | (error: any) => void | 合并消息文件上传失败的回调。 |

:::notice
:::tip
1. 合并转发支持嵌套,最多支持 10 层嵌套,每层最多 300 条消息。
2. 只有成功发送或接收的消息才能合并转发。
:::
Expand Down Expand Up @@ -755,7 +755,7 @@ connection

该功能适用于文本消息、图片消息和音视频消息等全类型消息,最多可向群组或聊天室的 20 个成员发送定向消息。

:::notice
:::tip
1. 仅 SDK 4.2.0 及以上版本支持。
2. 定向消息不写入服务端会话列表,不计入服务端会话的未读消息数。
3. 群组定向消息的漫游功能默认关闭,使用前需联系商务开通。
Expand Down
4 changes: 2 additions & 2 deletions docs/document/applet/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

环信小程序 SDK 为各端小程序开发提供一套完整的技术解决方案,在各端小程序的开发环境下,集成 IM 相关的功能更加便捷、高效。让您的小程序快速获得安全稳定的 IM 能力,集成简单,使用方便,帮助您快速拓展业务,赢得先机。

:::notice
:::tip
SDK 目前支持微信、QQ、百度小程序、抖音、uni-app 编译的原生 Android 以及 iOS。
:::

Expand All @@ -19,7 +19,7 @@ SDK 目前支持微信、QQ、百度小程序、抖音、uni-app 编译的原生
- 安卓: [https://www.pgyer.com/h4XF](https://www.pgyer.com/h4XF)
- iOS: [https://www.pgyer.com/9ISC](https://www.pgyer.com/9ISC)

:::notice
:::tip

- 小程序 Demo 只包含部分 IM 功能,详细参考 **功能说明**
- 各小程序 Demo 源码可在官网 [下载页](https://www.easemob.com/download/im) 获取
Expand Down
2 changes: 1 addition & 1 deletion docs/document/applet/qq.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ socket 合法域名:
wss://im-api-wechat.easemob.com(3.0 IM SDK)
:::

:::notice
:::tip
为满足不同客户的业务需求,环信在多地部署了数据中心。不同数据中心的 REST API 请求域名、WebSocket 访问域名不同。请根据您所在数据中心进行配置。
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/document/applet/serverconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

7. 登陆环信后台获取 socket 域名,进入即时通讯-服务概览页,即可看到如图的域名展示。

:::notice
:::tip
抖音小程序、QQ 小程序、百度小程序、uniapp 全平台等同微信小程序的域名一致,使用微信小程序栏的域名即可。
:::

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

![img](/images/applet/applet-demo.png)

:::notice
:::tip

- 小程序 Demo 只包含部分 IM 功能,详细参考 **功能说明**
- Uni-app Demo Git 源码地址 [https://github.com/easemob/webim-uniapp-demo](https://github.com/easemob/webim-uniapp-demo)
Expand Down
4 changes: 2 additions & 2 deletions docs/document/applet/uniappnativeapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
- 安卓: [https://www.pgyer.com/h4XF](https://www.pgyer.com/h4XF)
- iOS: [https://www.pgyer.com/9ISC](https://www.pgyer.com/9ISC)

:::notice
:::tip

- Demo 只包含部分 IM 功能,详细参考 **功能说明**
- Uni-app Demo Git 源码地址 [https://github.com/easemob/webim-uniapp-demo](https://github.com/easemob/webim-uniapp-demo):::
Expand All @@ -29,7 +29,7 @@

1. 下载 HBuilderx 编辑器 https://www.dcloud.io/hbuilderx.html

:::notice
:::tip
项目中 HBuilderx 目前使用的最新版本,如果此前下载过 HBuilderx,为保证开发环境统一请更新到最新版本
:::

Expand Down
4 changes: 2 additions & 2 deletions docs/document/applet/uniappuikit.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ HBuilderx ⇒ 工具 ⇒ 插件安装 ⇒ 安装新插件 ⇒ 前往插件市场

### 集成说明

:::notice
:::tip
小程序模版必须依赖环信 IM SDK,因而在使用小程序模版时必须同时添加环信 IM SDK 依赖。
:::

Expand Down Expand Up @@ -111,7 +111,7 @@ import longPressModal from "@/components/longPressModal/index";
- `hidePop` – Function,显隐框操作事件
- `popStyle` – string,样式

:::notice
:::tip
使用长按组件时候需要先获取当前窗口,再根据当前点击的位置来显示组件框:
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/document/applet/wechat.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ downloadFile 合法域名:
8. https://a1-chatfile.easemob.com
:::

:::notice
:::tip
为满足不同客户的业务需求,环信在多地部署了数据中心。不同数据中心的 REST API 请求域名、WebSocket 访问域名不同。请根据您所在数据中心进行配置。
:::

Expand Down
4 changes: 2 additions & 2 deletions docs/document/flutter/group_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ try {

仅群主可以调用 `DestroyGroup` 方法解散群组。群组解散时,其他群组成员收到 `EMGroupEventHandler#onGroupDestroyed` 事件并被踢出群组。

:::notice
:::tip
解散群组后,将删除本地数据库及内存中的群相关信息及群会话,谨慎操作。
:::

Expand All @@ -99,7 +99,7 @@ try {
- 群主或群管理员同意入群申请,申请人收到 `EMGroupEventHandler#onRequestToJoinAcceptedFromGroup` 事件,其他群成员收到`EMGroupEventHandler#onMemberJoinedFromGroup` 事件;
- 群主或群管理员拒绝入群申请,申请人收到 `EMGroupEventHandler#onRequestToJoinDeclinedFromGroup` 事件。

:::notice
:::tip
用户只能申请加入公开群组,私有群组不支持用户申请入群。
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/document/flutter/group_members.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ try {

你可调用 `EMGroupManager#fetchMembersAttributes` 方法根据指定的属性 key 获取多个群成员的自定义属性。

:::notice
:::tip
每次最多可获取 10 个群成员的自定义属性。
:::

Expand Down
4 changes: 2 additions & 2 deletions docs/document/flutter/multi_device.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ EMClient.getInstance.removeConnectionEventHandler("identifier");

你可以调用 `kickDevice` 方法通过传入用户 ID 和登录密码或用户 token 将指定账号从单个登录设备踢下线。被踢设备会收到 `onUserKickedByOtherDevice` 回调。调用该方法前,你需要首先通过 `EMClient#fetchLoggedInDevices` 方法获取设备 ID。

:::notice
:::tip
不登录也可以使用该接口。
:::

Expand Down Expand Up @@ -206,7 +206,7 @@ try {

你可以调用 `kickAllDevices` 方法通过传入用户 ID 和登录密码或用户 token 将指定账号从所有登录设备踢下线。

:::notice
:::tip
不登录也可以使用该接口。
:::

Expand Down
4 changes: 2 additions & 2 deletions docs/document/flutter/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ try {
} on EMError catch (e) {}
```

:::notice
:::tip
该注册模式为在客户端注册,旨在方便测试,并不推荐在正式环境中使用。
:::

Expand Down Expand Up @@ -82,7 +82,7 @@ try {

**用户 ID + token** 是更加安全的登录方式。token 可以通过调用 REST API 获取。 详见 [环信用户 token 的获取](/document/server-side/easemob_user_token.html)

:::notice
:::tip
使用 token 登录时需要处理 token 过期的问题,比如在每次登录时更新 token 等机制。
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/document/flutter/reaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

环信即时通讯 IM 提供消息表情回复(下文统称 “Reaction”)功能。用户可以在单聊和群聊中对消息添加、删除表情。表情可以直观地表达情绪,利用 Reaction 可以提升用户的使用体验。同时在群组中,利用 Reaction 可以发起投票,根据不同表情的追加数量来确认投票。

:::notice
:::tip
目前 Reaction 仅适用于单聊和群组。聊天室暂不支持 Reaction 功能。
:::

Expand Down
4 changes: 2 additions & 2 deletions docs/document/flutter/room_members.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ try {

仅聊天室所有者和管理员可以调用 `EMChatRoomManager#muteChatRoomMembers` 方法将指定成员添加至聊天室禁言列表。被禁言后,该成员和其他未操作的聊天室管理员或聊天室所有者收到 `EMChatRoomEventHandler#onMuteListAddedFromChatRoom` 事件。

:::notice
:::tip
聊天室所有者可禁言聊天室所有成员,聊天室管理员可禁言聊天室普通成员。
:::

Expand All @@ -232,7 +232,7 @@ try {

仅聊天室所有者和管理员可以调用 `EMChatRoomManager#unMuteChatRoomMembers` 方法将成员移出聊天室禁言列表。被解除禁言后,该成员和其他未操作的聊天室管理员或聊天室所有者收到 `EMChatRoomEventHandler#onMuteListRemovedFromChatRoom` 事件。

:::notice
:::tip
聊天室所有者可对聊天室所有成员解除禁言,聊天室管理员可对聊天室普通成员解除禁言。
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/document/flutter/thread.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ try {

单设备登录时,子区所属群组的所有成员均会收到 `EMChatThreadEventHandler#onChatThreadDestroy` 事件;多设备登录时,其他设备会同时收到 `EMMultiDeviceEventHandler#onChatThreadEvent` 事件,回调事件为 `EMMultiDevicesEvent#CHAT_THREAD_DESTROY`

:::notice
:::tip
解散子区或解散子区所在的群组后,将删除本地数据库及内存中关于该子区的全部数据,需谨慎操作。
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/document/flutter/userprofile.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

本文介绍如何通过管理用户属性设置、更新、存储并获取实时消息用户的相关信息。

:::notice
:::tip
为保证用户信息安全,SDK 仅支持用户设置或更新自己的用户属性。
:::

Expand Down
Loading

0 comments on commit f244706

Please sign in to comment.