Skip to content

Commit 12b8e73

Browse files
haoxiuwenhaoxiuwen
authored
Merge pull request #1352 from haoxiuwen/doc-v2
Modify Docs
2 parents 6bbd1a6 + 17a3116 commit 12b8e73

File tree

7 files changed

+12
-12
lines changed

7 files changed

+12
-12
lines changed

‎docs/document/android/message_search.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
## 实现方法
2525

26-
### 根据关键字搜索会话消息
26+
### 根据关键字搜索会话中的用户发送的消息
2727

2828
你可以调用 `searchMsgFromDB(string keywords, long timeStamp, int maxCount, string from, EMSearchDirection direction)` 方法根据关键字搜索本地数据库中单个会话中指定用户发送的消息，示例代码如下：
2929

‎docs/document/flutter/message_search.md‎

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

99
环信即时通讯 IM Flutter SDK 支持搜索用户设备上存储的消息数据，其中包含如下主要方法：
1010

11-
- `EMChatManager.searchMsgFromDB`：根据关键字搜索会话消息。
11+
- `EMChatManager.searchMsgFromDB`：根据关键字搜索会话中的用户发送的消息。
1212
- `EMChatManager#loadMessagesWithKeyword`：根据搜索范围搜索所有会话中的消息。
1313
- `EMConversation#loadMessagesWithKeyword`：根据搜索范围搜索当前会话中的消息。
1414
- `EMChatManager#searchMsgsByOptions`：根据单个或多个消息类型，搜索本地数据库中所有会话的消息。
@@ -23,7 +23,7 @@
2323

2424
## 实现方法
2525

26-
### 根据关键字搜索会话消息
26+
### 根据关键字搜索会话中的用户发送的消息
2727

2828
你可以调用 `loadMessagesWithKeyword` 方法根据关键字搜索本地数据库中单个会话中指定用户发送的消息，示例代码如下：
2929

‎docs/document/harmonyos/message_search.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ const conversation = ChatClient.getInstance().chatManager()?.getConversation(con
4040
const messages = conversation?.loadMoreMessagesFromDB(startMsgId, pageSize, direction);
4141
```
4242

43-
### 根据关键字搜索会话消息
43+
### 根据关键字搜索会话中的用户发送的消息
4444

4545
你可以调用 `ChatManager#searchMessagesFromDB(keywords: string, timestamp: number, maxCount: number, from?: string, direction?: SearchDirection)` 方法根据关键字搜索本地数据库中指定用户发送的消息，示例代码如下：
4646

‎docs/document/server-side/account_system.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ POST https://{host}/{org_name}/{app_name}/users
8484

8585
| 参数 | 类型 | 是否必需 | 描述 |
8686
| :--------- | :----- | :------- | :-------------------------------------------- |
87-
| `username` | String | 是 | 用户 ID，长度不可超过 64 个字节。不可设置为空。支持以下字符集：<br/>- 26 个小写英文字母 a-z；<br/>- 10 个数字 0-9；<br/>- “\_”, “-”, “.”。 <br/><Container type="notice" title="注意"><br/>- 请勿使用大写英文字母 A-Z。若你使用了大写字母和小写字母，响应中返回的用户 ID 只包含小写字母。<br/>- 请确保同一个 app 下，用户 ID 唯一；<br/>- 用户 ID 为公开信息，请勿使用 UUID、邮箱地址、手机号等敏感信息。</Container> |
87+
| `username` | String | 是 | 用户 ID，长度不可超过 64 个字节。不可设置为空。支持以下字符集：<br/>- 26 个小写英文字母 a-z；<br/>- 10 个数字 0-9；<br/>- “\_”, “-”, “.”。 <br/><Container type="notice" title="注意"><br/>- 请勿使用大写英文字母 A-Z。若你同时使用了大写字母和小写字母，响应中返回的用户 ID 只包含小写字母。<br/>- 请确保同一个 app 下，用户 ID 唯一；<br/>- 用户 ID 为公开信息，请勿使用 UUID、邮箱地址、手机号等敏感信息。</Container> |
8888
| `password` | String | 是 | 用户的登录密码，长度不可超过 64 个字符。 |
8989
| `nickname` | String | 否 | 离线推送时在接收方的客户端推送通知栏中显示的发送方的昵称。你可以自定义该昵称，长度不能超过 100 个字符。<br/>支持以下字符集：<br/> - 26 个小写英文字母 a-z；<br/> - 26 个大写英文字母 A-Z；<br/> - 10 个数字 0-9；<br/> - 中文；<br/> - 特殊字符。<Container type="tip" title="提示">1. 若不设置昵称，推送时会显示发送方的用户 ID，而非昵称。<br/>2. 该昵称可与用户属性中的昵称设置不同，不过我们建议这两种昵称的设置保持一致。因此，修改其中一个昵称时，也需调用相应方法对另一个进行更新，确保设置一致。更新用户属性中的昵称的方法，详见 [设置用户属性](userprofile.html#设置用户属性)。</Container> |
9090

@@ -185,7 +185,7 @@ POST https://{host}/{org_name}/{app_name}/users
185185

186186
| 参数 | 类型 | 是否必需 | 描述 |
187187
| :--------- | :----- | :------- | :------------------------ |
188-
| `username` | String | 是 | 用户 ID，长度不可超过 64 字节。不可设置为空。支持以下字符集：<br/>- 26 个小写英文字母 a-z；<br/>- 10 个数字 0-9；<br/>- “\_”, “-”, “.”。 <br/><Container type="notice" title="注意"><br/>- 请勿使用大写英文字母 A-Z；<br/>- 请确保同一个 app 下，用户 ID 唯一；<br/>- 用户 ID 为公开信息，请勿使用 UUID、邮箱地址、手机号等敏感信息。</Container> |
188+
| `username` | String | 是 | 用户 ID，长度不可超过 64 字节。不可设置为空。支持以下字符集：<br/>- 26 个小写英文字母 a-z；<br/>- 10 个数字 0-9；<br/>- “\_”, “-”, “.”。 <br/><Container type="notice" title="注意"><br/>- 请勿使用大写英文字母 A-Z。若你同时使用了大写字母和小写字母，响应中返回的用户 ID 只包含小写字母。<br/>- 请确保同一个 app 下，用户 ID 唯一；<br/>- 用户 ID 为公开信息，请勿使用 UUID、邮箱地址、手机号等敏感信息。</Container> |
189189
| `password` | String | 是 | 用户的登录密码，长度不可超过 64 个字符。 |
190190

191191
#### HTTP 响应
@@ -290,7 +290,7 @@ POST https://{host}/{org_name}/{app_name}/users
290290

291291
| 参数 | 类型 | 是否必需 | 描述 |
292292
| :--------- | :----- | :------- | :----------------------------- |
293-
| `username` | String | 是 | 用户 ID，长度不可超过 64 个字节。不可设置为空。支持以下字符集：<br/>- 26 个小写英文字母 a-z；<br/>- 10 个数字 0-9；<br/>- “\_”, “-”, “.”。 <br/><Container type="notice" title="注意"><br/>- 请勿使用大写英文字母 A-Z；<br/>- 请确保同一个 app 下，用户 ID 唯一；<br/>- 用户 ID 为公开信息，请勿使用 UUID、邮箱地址、手机号等敏感信息。</Container> |
293+
| `username` | String | 是 | 用户 ID，长度不可超过 64 个字节。不可设置为空。支持以下字符集：<br/>- 26 个小写英文字母 a-z；<br/>- 10 个数字 0-9；<br/>- “\_”, “-”, “.”。 <br/><Container type="notice" title="注意"><br/>- 请勿使用大写英文字母 A-Z。若你同时使用了大写字母和小写字母，响应中返回的用户 ID 只包含小写字母。<br/>- 请确保同一个 app 下，用户 ID 唯一；<br/>- 用户 ID 为公开信息，请勿使用 UUID、邮箱地址、手机号等敏感信息。</Container> |
294294
| `password` | String | 是 | 用户的登录密码，长度不可超过 64 个字符。 |
295295

296296
#### HTTP 响应

‎docs/document/unity/message_search.md‎

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

99
环信即时通讯 IM SDK 通过 `ChatManager` 和 `Conversation` 类支持搜索用户设备上存储的消息数据，其中包含如下主要方法：
1010

11-
- `ChatManager#LoadMessagesWithKeyword` 根据关键字搜索会话消息。
11+
- `ChatManager#LoadMessagesWithKeyword` 根据关键字搜索会话中的用户发送的消息。
1212
- `ChatManager#SearchMsgFromDB(string, long, in, string, MessageSearchDirection, MessageSearchScope, ValueCallBack<List<Message>>)`：根据搜索范围搜索所有会话中的消息。
1313
- `Conversation#LoadMessagesWithScope(string, MessageSearchScope, long, int, string, MessageSearchDirection, ValueCallBack<List<Message>>)`：根据搜索范围搜索当前会话中的消息。
1414
- `Conversation#LoadMessagesWithMsgTypeList` ：根据单个或多个消息类型，搜索本地数据库中当前会话的消息。
@@ -22,7 +22,7 @@
2222

2323
## 实现方法
2424

25-
### 根据关键字搜索会话消息
25+
### 根据关键字搜索会话中的用户发送的消息
2626

2727
你可以调用 `LoadMessagesWithKeyword` 方法根据关键字搜索本地数据库中单个会话中指定用户发送的消息，示例代码如下：
2828

‎docs/document/windows/message_search.md‎

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

99
环信即时通讯 IM SDK 通过 `ChatManager` 类支持搜索用户设备上存储的消息数据，其中包含如下主要方法：
1010

11-
- `ChatManager#LoadMessagesWithKeyword` 根据关键字搜索会话消息。
11+
- `ChatManager#LoadMessagesWithKeyword` 根据关键字搜索会话中的用户发送的消息。
1212
- `ChatManager#SearchMsgFromDB(string, long, in, string, MessageSearchDirection, MessageSearchScope, ValueCallBack<List<Message>>)`：根据搜索范围搜索所有会话中的消息。
1313
- `Conversation#LoadMessagesWithScope(string, MessageSearchScope, long, int, string, MessageSearchDirection, ValueCallBack<List<Message>>)`：根据搜索范围搜索当前会话中的消息。
1414
- `Conversation#LoadMessagesWithMsgTypeList` ：根据单个或多个消息类型，搜索本地数据库中所有会话的消息。
@@ -22,7 +22,7 @@
2222

2323
## 实现方法
2424

25-
### 根据关键字搜索会话消息
25+
### 根据关键字搜索会话中的用户发送的消息
2626

2727
你可以调用 `LoadMessagesWithKeyword` 方法根据关键字搜索本地数据库中单个会话中指定用户发送的消息，示例代码如下：
2828

‎docs/product/product_user_registration_login.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
| 参数 | 类型 | 是否必需 | 描述 |
2424
| :--------- | :----- | :------- | :-------------------------------------------- |
25-
| `username` | String | 是 | 用户 ID，长度不可超过 64 个字节。不可设置为空。支持以下字符集：<br/>- 26 个小写英文字母 a-z；<br/>- 10 个数字 0-9；<br/>- “_”, “-”, “.”。 <br/><Container type="notice" title="注意"><br/>- 请勿使用大写英文字母 A-Z；<br/>- 用户 ID 为公开信息，请勿使用 UUID、邮箱地址、手机号等敏感信息。</Container> |
25+
| `username` | String | 是 | 用户 ID，长度不可超过 64 个字节。不可设置为空。支持以下字符集：<br/>- 26 个小写英文字母 a-z；<br/>- 10 个数字 0-9；<br/>- “_”, “-”, “.”。 <br/><Container type="notice" title="注意"><br/>- 请勿使用大写英文字母 A-Z。若你同时使用了大写字母和小写字母，响应中返回的用户 ID 只包含小写字母。<br/>- 用户 ID 为公开信息，请勿使用 UUID、邮箱地址、手机号等敏感信息。</Container> |
2626
| `token` | String | 是 | token 可以通过调用 REST API 获取，即传入用户 ID （或用户 ID + 密码）和 token 有效期参数获取，详见 [环信用户 token 的获取](/document/server-side/easemob_user_token.html)。<br/><Container type="notice" title="注意"><br/>- 你可以在调用 REST API 获取 token 时，传入 `ttl` 参数，设置 token 的有效期。此外，你也可以通过[环信即时通讯云控制台](https://console.easemob.com/user/login/)的**用户认证**页面设置 token 的有效期。该参数值以最新设置为准。<br/>- 环信服务器完全信赖用户 token，为避免业务受影响，你需要确保 token 的安全。</Container> |
2727
| `password` | String | 是 | 用户的登录密码，长度不可超过 64 个字符。|
2828

0 commit comments

Comments
 (0)