Skip to content

Commit a1f19ab

Browse files
author
haoxiuwen
committed
Modify Message Deletion Docs and Message Receipt Docs
1 parent b093089 commit a1f19ab

17 files changed

+46
-45
lines changed

‎docs/docs/sdk/android/limitation.md‎

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

8686
### 置顶消息
8787

88-
- 单个会话默认可置顶 20 条消息。你可以联系声网商务提升该上限，最大可调整至 100。
88+
单个会话默认可置顶 20 条消息。你可以联系声网商务提升该上限，最大可调整至 100。
8989

9090
### 消息仅投递在线用户
9191

‎docs/docs/sdk/android/message_delete.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010

1111
- `ChatManager#asyncDeleteAllMsgsAndConversations`：清空当前用户的聊天记录，包括单聊、群聊和聊天室的消息和会话，同时可以选择是否单向清除服务端的聊天记录。
1212
- `Conversation#removeMessagesFromServer`：按消息时间或消息 ID 单向删除服务端的历史消息。
13-
- `ChatManager#clearAllMessages`：删除本地指定会话的所有消息。
14-
- `ChatManager#removeMessages(startTime, endTime)`：删除指定时间段的本地消息。
15-
- `ChatManager#removeMessage(targetMessageId)`：删除本地单个会话的指定消息。
13+
- `Conversation#clearAllMessages`：删除本地指定会话的所有消息。
14+
- `Conversation#removeMessages(startTime, endTime)`：删除指定会话一段时间内的本地消息。
15+
- `Conversation#removeMessage(targetMessageId)`：删除本地会话的指定消息。
1616

1717
## 前提条件
1818

@@ -87,7 +87,7 @@ if(conversation != null) {
8787
}
8888
```
8989

90-
### 删除单个本地会话指定时间段的消息
90+
### 删除本地会话指定时间段的消息
9191

9292
你可以删除本地指定会话在一段时间内的本地消息，示例代码如下：
9393

@@ -98,9 +98,9 @@ if(conversation != null) {
9898
}
9999
```
100100

101-
### 删除本地单个会话的指定消息
101+
### 删除本地会话的指定消息
102102

103-
你可以删除本地单个会话的指定消息，示例代码如下：
103+
你可以删除本地会话的指定消息，示例代码如下：
104104

105105
```java
106106
Conversation conversation = ChatClient.getInstance().chatManager().getConversation(conversationId);

‎docs/docs/sdk/android/message_import_insert.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,11 @@
66

77
## 技术原理
88

9-
即时通讯 IM Android SDK 支持提供 `ChatManager` 类支持在本地导入和插入消息，其中包含如下主要方法：
9+
即时通讯 IM Android SDK 支持提供 `ChatManager` 类和 `Conversation` 类支持在本地导入和插入消息，其中包含如下主要方法：
1010

1111
- `ChatManager#importMessages`：批量导入消息到数据库；
12-
- `ChatManager#insertMessage`：在本地指定会话中插入一条消息。
12+
- `Conversation#insertMessage`：在本地指定会话中插入一条消息。
13+
- `ChatManager#saveMessage`：直接插入消息。若会话不存在，SDK 会自动创建会话。
1314

1415
## 前提条件
1516

@@ -48,7 +49,7 @@ ChatClient.getInstance().chatManager().importMessages(msgs);
4849
// 将消息插入到指定会话中。
4950
Conversation conversation = ChatClient.getInstance().chatManager().getConversation(username);
5051
conversation.insertMessage(message);
51-
// 直接插入消息。
52+
// 直接插入消息。若会话不存在，SDK 会自动创建会话。
5253
ChatClient.getInstance().chatManager().saveMessage(message);
5354
```
5455

‎docs/docs/sdk/android/message_receipt.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ options.setRequireAck(true);
194194
与单聊消息的 app 层级设置已读回执功能不同，群聊消息是在发送消息时设置指定消息是否需要已读回执。
195195

196196
```java
197-
ChatMessage message = ChatMessage.createTxtSendMessage(content, to);
197+
ChatMessage message = ChatMessage.createTextSendMessage(content, to);
198198
message.setIsNeedGroupAck(true);
199199
```
200200

@@ -275,14 +275,14 @@ public void asyncFetchGroupReadAcks(
275275

276276
| 字段 | 描述 |
277277
| :--------- | :----- |
278-
| `ChatMessage#isUnread` | 用户是否已读了该消息。如果是自己发送的消息，该字段的值固定为 `true`。|
278+
| `ChatMessage#isUnread` | 用户是否已读了该消息。如果是自己发送的消息，该字段的值固定为 `false`，表示该消息已读。|
279279
| `ChatMessage#isAcked` | 是否（消息接收方）已发送或（消息发送方）已收到消息已读回执。如果是自己发送的消息，记录的是对方是否已读。如果是对方的消息，则记录的是自己是否发送过已读回执。 |
280280

281281
对于群聊消息，本地数据库通过以下字段存储消息已读状态：
282282

283283
| 字段 | 描述 |
284284
| :--------- | :----- |
285-
| `ChatMessage#isUnread` | 用户是否已读了该消息。如果是自己发送的消息，该字段的值固定为 `true`。|
285+
| `ChatMessage#isUnread` | 用户是否已读了该消息。如果是自己发送的消息，该字段的值固定为 `false`，表示该消息已读。|
286286
| `ChatMessage#groupAckCount` | 已阅读消息的群成员数量。 |
287287

288288
### 已读回执与未读消息数

‎docs/docs/sdk/android/message_send_receive.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,7 @@ ChatClient.getInstance().chatManager().sendMessage(message);
504504
当 SDK 提供的消息类型不满足需求时，你可以通过消息扩展字段传递自定义的内容，从而生成自己需要的消息类型，例如，消息中需要携带被回复的消息内容或者是图文消息等场景。
505505

506506
```java
507-
ChatMessage message = ChatMessage.createTxtSendMessage(content, toChatUsername);
507+
ChatMessage message = ChatMessage.createTextSendMessage(content, toChatUsername);
508508
// 增加自定义属性。
509509
message.setAttribute("attribute1", "value");
510510
message.setAttribute("attribute2", true);

‎docs/docs/sdk/android/multi_device.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ List<String> ids = ChatClient.getInstance().contactManager().getSelfIdsOnOtherPl
6363
// 选择一个登录 ID 作为消息接收方。
6464
String toChatUsername = ids.get(0);
6565
// 创建一条文本消息，content 为消息文字内容，toChatUsername 传入登录 ID 作为消息接收方。
66-
ChatMessage message = ChatMessage.createTxtSendMessage(content, toChatUsername);
66+
ChatMessage message = ChatMessage.createTextSendMessage(content, toChatUsername);
6767
// 发送消息。
6868
ChatClient.getInstance().chatManager().sendMessage(message);
6969
```

‎docs/docs/sdk/android/thread_message.md‎

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

4040
```java
4141
// 创建一条文本消息，`content` 为消息文字内容，`chatThreadId` 为子区 ID。
42-
ChatMessage message = ChatMessage.createTxtSendMessage(content, chatThreadId);
42+
ChatMessage message = ChatMessage.createTextSendMessage(content, chatThreadId);
4343
// 设置消息类型，子区消息需要将 `ChatType` 设置为 `GroupChat`。
4444
message.setChatType(ChatType.GroupChat);
4545
// 设置消息标记 `isChatThreadMessage` 为 `true`。

‎docs/docs/sdk/flutter/integration.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,6 @@ iOS 需要 iOS 11.0 以上版本。
4949

5050
```shell
5151
cd quick_start
52-
flutter pub add im_flutter_sdk
52+
flutter pub add shengwang_chat_sdk
5353
flutter pub get
5454
```

‎docs/docs/sdk/flutter/message_delete.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010

1111
- `ChatManager#deleteAllMessageAndConversation`：清空当前用户的聊天记录，包括单聊、群聊和聊天室的消息和会话，同时可以选择是否单向清除服务端的聊天记录。
1212
- `ChatManager#deleteRemoteMessagesBefore`/`ChatManager#deleteRemoteMessagesWithIds`：根据消息时间或消息 ID 单向删除服务端的历史消息。
13-
- `ChatManager#deleteAllMessages`：删除本地指定会话的所有消息。
14-
- `ChatManager#deleteMessagesWithTs`：删除指定时间段的本地消息。
15-
- `ChatManager#deleteMessage`：删除本地单个会话的指定消息。
13+
- `Conversation#deleteAllMessages`：删除本地指定会话的所有消息。
14+
- `Conversation#deleteMessagesWithTs`：删除指定时间段的本地消息。
15+
- `Conversation#deleteMessage`：删除本地会话的指定消息。
1616

1717
## 前提条件
1818

@@ -69,7 +69,7 @@ ChatConversation? conversation = await ChatClient.getInstance.chatManager
6969
await conversation?.deleteAllMessages();
7070
```
7171

72-
### 删除单个本地会话指定时间段的消息
72+
### 删除本地会话指定时间段的消息
7373

7474
你可以删除本地指定会话在一段时间内的本地消息，示例代码如下：
7575

@@ -79,9 +79,9 @@ ChatConversation? conversation = await ChatClient.getInstance.chatManager
7979
await conversation?.deleteMessagesWithTs(startTs, endTs);
8080
```
8181

82-
### 删除本地单个会话的指定消息
82+
### 删除本地会话的指定消息
8383

84-
你可以删除本地单个会话的指定消息，示例代码如下：
84+
你可以删除本地会话的指定消息，示例代码如下：
8585

8686
```dart
8787
ChatConversation? conversation = await ChatClient.getInstance.chatManager

‎docs/docs/sdk/harmonyos/message_delete.md‎

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

1111
- `ChatManager#removeMessagesFromServer`：按消息时间或消息 ID 单向删除服务端的历史消息。
1212
- `Conversation#clearAllMessages`：删除本地指定会话的所有消息。
13-
- `Conversation#removeMessage(targetMessageId)`：删除本地单个会话的指定消息。
13+
- `Conversation#removeMessage(targetMessageId)`：删除本地会话的指定消息。
1414

1515
## 前提条件
1616

@@ -50,9 +50,9 @@ if(conversation) {
5050
}
5151
```
5252

53-
### 删除本地单个会话的指定消息
53+
### 删除本地会话的指定消息
5454

55-
你可以删除本地单个会话的指定消息，示例代码如下：
55+
你可以删除本地会话的指定消息，示例代码如下：
5656

5757
```typescript
5858
let conversation = ChatClient.getInstance().chatManager()?.getConversation(conversationId);

0 commit comments

Comments
 (0)