Skip to content

Commit

Permalink
Merge pull request #1101 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history
Modify IM Docs
  • Loading branch information
haoxiuwen authored Dec 20, 2024
2 parents c167a90 + e4a3b20 commit e546ebe
Show file tree
Hide file tree
Showing 18 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/document/electron/message.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

- 发送消息

- 接受消息
- 接收消息

同时对于发送不超过2分钟的消息,允许主动撤回。

Expand Down
2 changes: 1 addition & 1 deletion docs/document/flutter/conversation_receipt.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
1. 开启已读回执功能,即 SDK 初始化时设置 `EMOptions#requireAck``true`

```dart
// 设置是否需要接受方已读确认,默认为 true
// 设置是否需要接收方已读确认,默认为 true
final options = EMOptions(
appKey: appKey,
requireAck: true,
Expand Down
2 changes: 1 addition & 1 deletion docs/document/flutter/message_send_receive.md
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,7 @@ void _sendBeginTyping() async {
```

以下示例代码展示如何接受和解析输入状态的透传消息
以下示例代码展示如何接收和解析输入状态的透传消息

```dart
final int typingTime = 10;
Expand Down
4 changes: 2 additions & 2 deletions docs/document/harmonyos/message_receipt.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ ChatClient.getInstance().chatManager()?.removeMessageListener(msgListener);

1. App 开启已读回执功能,即 SDK 初始化时将 `ChatOptions.setRequireReadAck` 设置为 `true`
```TypeScript
// 设置是否需要接受方已读确认,默认为true
// 设置是否需要接收方已读确认,默认为true
options.setRequireReadAck(true);
```

Expand Down Expand Up @@ -155,7 +155,7 @@ ChatClient.getInstance().chatManager()?.addMessageListener(msgListener);
该功能开启后,接收方阅读消息后,SDK 底层会自动进行消息已读回执。

```TypeScript
// 设置是否需要接受方已读确认,默认为 `true`。
// 设置是否需要接收方已读确认,默认为 `true`。
options.setRequireReadAck(true);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/document/react-native/conversation_receipt.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
1. 开启已读回执功能,即 SDK 初始化时设置 `ChatOptions#requireAck``true`

```TypeScript
// 设置是否需要接受方已读确认,默认为 true
// 设置是否需要接收方已读确认,默认为 true
options.requireAck = true;
```

Expand Down
2 changes: 1 addition & 1 deletion docs/document/react-native/message_receipt.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ ChatClient.getInstance().chatManager.addMessageListener({
1. App 开启已读回执功能,即 SDK 初始化时将 `ChatOptions#requireAck` 设置为 `true`

```TypeScript
// 设置是否需要接受方已读确认,默认为true
// 设置是否需要接收方已读确认,默认为true
options.requireAck = true;
```

Expand Down
2 changes: 1 addition & 1 deletion docs/document/server-side/callback_offline_push.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
| `invalid message` | 无效的消息(协议内容一般不会有这个错误)。 |
| `expire message` | 过期的消息,推送延迟超过一天的消息,不再推送。 |
| `user ignore push` | 主动免打扰。 |
| `ignore push device id` | 忽略用户设备推送(扩展限制接收或不接受推送设备)。 |
| `ignore push device id` | 忽略用户设备推送(扩展限制接收或不接收推送设备)。 |
| `invalid VOIP notification` | 无效的 APNs VoIP 类型推送。 |
| `get push token fail` | 获取推送 token 失败。 |
| `push yet but fail ` | 已经推送,但是返回失败。 |
Expand Down
2 changes: 1 addition & 1 deletion docs/document/server-side/chatroom_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ POST https://{host}/{org_name}/{app_name}/chatrooms
| :------------ | :----- | :------- | :------------------------------------------------------------------------------ |
| `name` | String || 聊天室名称,最大长度为 128 个字符。 |
| `description` | String || 聊天室描述,最大长度为 512 个字符。 |
| `maxusers` | Int || 聊天室最大成员数(包括聊天室所有者)。取值范围为 [1,10,000],默认值为 `1000`。如需调整请联系商务。 |
| `maxusers` | Int || 聊天室最大成员数(包括聊天室所有者)。取值范围为 [1, 10,000],默认值为 `1000`。如需调整请联系商务。 |
| `owner` | String || 聊天室所有者。 |
| `members` | Array || 聊天室普通成员和管理员的用户 ID 数组,不包含聊天室所有者的用户 ID。该数组可包含的元素数量不超过 `maxusers` 的值。若传该参数,确保至少设置一个数组元素。<Container type="tip" title="提示"> 创建聊天室时拉入的这些用户若从未登录过,会一直存在于聊天室中。</Container> |
| `custom` | String || 聊天室扩展信息,例如,可以给聊天室添加业务相关的标记,不能超过 8 KB。 |
Expand Down
2 changes: 1 addition & 1 deletion docs/document/unity/conversation_receipt.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
1. 开启已读回执功能,即 SDK 初始化时设置 `Options#RequireAck``true`

```C#
// 设置是否需要接受方已读确认,默认为 true
// 设置是否需要接收方已读确认,默认为 true
options.RequireAck = true;
```

Expand Down
4 changes: 2 additions & 2 deletions docs/document/unity/message_receipt.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ SDKClient.Instance.ChatManager.RemoveChatManagerDelegate(myDelegate);

1. App 开启已读回执功能,即 SDK 初始化时将 `Options#RequireAck` 设置为 `true`
```C#
// 设置是否需要接受方已读确认,默认为true
// 设置是否需要接收方已读确认,默认为true
options.RequireAck = true;
```

Expand Down Expand Up @@ -207,7 +207,7 @@ SDKClient.Instance.ChatManager.RemoveChatManagerDelegate(myDelegate);

该功能开启后,接收方阅读消息后,SDK 底层会自动进行消息已读回执。
```C#
// 设置是否需要接受方已读确认,默认为 `true`。
// 设置是否需要接收方已读确认,默认为 `true`。
options.RequireAck = true;
```

Expand Down
2 changes: 1 addition & 1 deletion docs/document/web/error.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ error.type === statusCode.WEBIM_CONNCTION_USER_NOT_ASSIGN_ERROR 其中 `error`
| 1100 | PRESENCE_PARAM_EXCEED | 发布自定义在线状态时,参数长度超出限制。 |
| 1101 | REACTION_ALREADY_ADDED | Reaction 重复添加。 |
| 1102 | REACTION_CREATING | 创建 Reaction 时,其他人正在创建。 |
| 1103 | REACTION_OPERATION_IS_ILLEGAL | 用户对该 Reaction 没有操作权限:没有添加过该 Reaction 的用户进行删除操作,或者单聊消息非发送者和非接受者进行添加 Reaction 操作。 |
| 1103 | REACTION_OPERATION_IS_ILLEGAL | 用户对该 Reaction 没有操作权限:没有添加过该 Reaction 的用户进行删除操作,或者单聊消息非发送者和非接收者进行添加 Reaction 操作。 |
| 1200 | TRANSLATION_NOT_VALID | 传入的语言 code 不合法。 |
| 1201 | TRANSLATION_TEXT_TOO_LONG | 翻译的文本过长。 |
| 1204 | TRANSLATION_FAILED | 获取翻译服务失败。 |
Expand Down
2 changes: 1 addition & 1 deletion docs/document/web/releasenote.md
Original file line number Diff line number Diff line change
Expand Up @@ -978,6 +978,6 @@
- 修复 bug。demo 联系人过多时的样式问题。
- 修复 bug。conn = new Easemob.im.Connection();变量名不为 conn 或者 conn 不是全局变量时接收不到消息。
- 修复 bug。群组离线消息当作陌生人消息处理。
- 修复 bug。IE 浏览器接受文本消息以换行符开始时会遮挡联系人名称
- 修复 bug。IE 浏览器接收文本消息以换行符开始时会遮挡联系人名称
- 修复 bug。在线用户被邀请加入群组不能实时显示,必须重新登录。
- 丰富相关文档内容。
2 changes: 1 addition & 1 deletion docs/document/windows/conversation_receipt.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
1. 开启已读回执功能,即 SDK 初始化时设置 `Options#RequireAck``true`

```C#
// 设置是否需要接受方已读确认,默认为 true
// 设置是否需要接收方已读确认,默认为 true
options.RequireAck = true;
```

Expand Down
2 changes: 1 addition & 1 deletion docs/document/windows/error.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ SDKClient.Instance.Login(username, passwd,
| 1299 | THIRD_DEFAULT_FAILED | 除第三方内容审核服务的其他服务的消息审核结果为“拒绝”。 |
| 1300 | REACTION_REACH_LIMIT | 该消息的 Reaction 数量已达到限制。 |
| 1301 | REACTION_HAS_BEEN_OPERATED | Reaction 重复添加。 |
| 1302 | REACTION_OPERATION_IS_ILLEGAL | 没有操作权限:用户对该 Reaction 没有操作权限。例如,没有添加过该 Reaction 的用户进行删除操作,或者单聊消息非发送者和非接受者进行添加 Reaction 操作。 |
| 1302 | REACTION_OPERATION_IS_ILLEGAL | 没有操作权限:用户对该 Reaction 没有操作权限。例如,没有添加过该 Reaction 的用户进行删除操作,或者单聊消息非发送者和非接收者进行添加 Reaction 操作。 |
| 1400 | THREAD_NOT_EXIST | 未找到该子区,该子区不存在。 |
| 1401 | THREAD_ALREADY_EXIST | 该消息 ID 下子区已存在,重复添加子区。 |
| 1402 | THREAD_CREATE_MESSAGE_ILLEGAL | 创建子区的消息无效:创建子区时父消息被撤回了,或者无法使用。 |
Expand Down
4 changes: 2 additions & 2 deletions docs/document/windows/message_receipt.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ SDKClient.Instance.ChatManager.RemoveChatManagerDelegate(myDelegate);

1. App 开启已读回执功能,即 SDK 初始化时将 `Options#RequireAck` 设置为 `true`
```C#
// 设置是否需要接受方已读确认,默认为true
// 设置是否需要接收方已读确认,默认为true
options.RequireAck = true;
```

Expand Down Expand Up @@ -207,7 +207,7 @@ SDKClient.Instance.ChatManager.RemoveChatManagerDelegate(myDelegate);

该功能开启后,接收方阅读消息后,SDK 底层会自动进行消息已读回执。
```C#
// 设置是否需要接受方已读确认,默认为 `true`。
// 设置是否需要接收方已读确认,默认为 `true`。
options.RequireAck = true;
```

Expand Down
2 changes: 1 addition & 1 deletion docs/product/faq_quality_issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
可能是以下原因:

- 用户 A 消息发送失败;
- 接受消息的用户 ID 错误;
- 接收消息的用户 ID 错误;
- 用户 B 把 A 设为黑名单了;
- 用户 B 在其他设备上登录时接收了消息;
- 用户 B 离线消息数量超过 500 条等。
Expand Down
2 changes: 1 addition & 1 deletion docs/product/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ CallKit 提供应用内聊天中音视频通话的页面和 UI 组件,帮助

### 离线

离线是指用户成功登出环信即时通讯 IM 系统或与即时通讯 IM 系统断开连接后的状态。用户登出即时通讯 IM 系统之后,无法发送和接受消息,在下次登录后可以接收到离线消息。
离线是指用户成功登出环信即时通讯 IM 系统或与即时通讯 IM 系统断开连接后的状态。用户登出即时通讯 IM 系统之后,无法发送和接收消息,在下次登录后可以接收到离线消息。

## 封禁用户

Expand Down
2 changes: 1 addition & 1 deletion docs/push/push_createnotification.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
#### 推送目标:

- 全量用户
- 指定用户:接受人以英文逗号分开,最多 1000 个接收人
- 指定用户:接收人以英文逗号分开,最多 1000 个接收人
- 指定标签用户:支持最多选择3个标签,支持交集运算

![img](/images/instantpush/push_user_certain.png)
Expand Down

0 comments on commit e546ebe

Please sign in to comment.