Skip to content

Commit

Permalink
Merge pull request #1012 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history
Modify IM Docs
  • Loading branch information
haoxiuwen authored Oct 29, 2024
2 parents c520330 + 7b35348 commit f7f1aab
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions docs/document/android/conversation_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@
| getMessage | 根据消息 ID 获取已读的消息。 |
| getAllMessages | 获取该会话当前内存中的所有消息。 |
| removeMessage | 删除本地数据库中的一条指定消息。 |
| getLastMessage | 获取会话中的最新一条消息。 |
| getLatestMessageFromOthers | 获取会话中收到的最新一条消息 |
| getLastMessage | 获取会话中的最新一条消息。该消息可能是当前用户发送的,也可能是对端用户发送。 |
| getLatestMessageFromOthers | 获取会话中收到的最新一条消息,即当前用户收到的对端用户发送的最新消息。 |
| clear | 清除会话中的所有消息。只清除内存的,不清除本地数据库的消息。 |
| clearAllMessages | 清除内存和数据库中指定会话中的消息。 |
| setExtField | 设置会话的扩展字段。 |
Expand Down
4 changes: 2 additions & 2 deletions docs/document/flutter/conversation_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
| isPinned | 是否为置顶会话。 |
| pinnedTime | 会话置顶的 UNIX 时间戳,单位为毫秒。未置顶时值为 `0`|
| setExt | 获取会话扩展属性。 |
| latestMessage | 获取会话的最新一条消息。 |
| lastReceivedMessage | 获取最近收到的一条消息|
| latestMessage | 获取会话中的最新一条消息。该消息可能是当前用户发送的,也可能是对端用户发送。 |
| lastReceivedMessage | 获取会话中收到的最新一条消息,即当前用户收到的对端用户发送的最新消息|
| unreadCount | 获取会话的消息未读数。 |
| markMessageAsRead | 将消息标为已读。 |
| markAllMessagesAsRead | 将所有消息标为已读。 |
Expand Down
2 changes: 1 addition & 1 deletion docs/document/flutter/room_members.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ try {

#### 开启聊天室全员禁言

仅聊天室所有者和管理员可以调用 `EMChatRoomManager#muteAllChatRoomMembers` 方法开启全员禁言。全员禁言开启后不会在一段时间内自动解除禁言,需要调用 `unmuteAllMembers` 方法解除全员禁言。
仅聊天室所有者和管理员可以调用 `EMChatRoomManager#muteAllChatRoomMembers` 方法开启全员禁言。全员禁言开启后不会在一段时间内自动解除禁言,需要调用 `EMChatRoomManager#unMuteAllChatRoomMembers` 方法解除全员禁言。

全员禁言开启后,除了在白名单中的成员,其他成员不能发言。调用成功后,聊天室成员会收到 `EMChatRoomEventHandler#onAllChatRoomMemberMuteStateChanged` 事件。

Expand Down
4 changes: 2 additions & 2 deletions docs/document/harmonyos/conversation_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@
| searchMessagesBetweenTime(startTimestamp: number, endTimestamp: number, maxCount: number) | 从本地数据库中搜索指定时间段内发送或接收的一定数量的消息。 |
| getMessage | 根据消息 ID 获取已读的消息。 |
| removeMessage | 删除本地数据库中的一条指定消息。 |
| getLatestMessage | 获取会话中的最新一条消息。 |
| getLatestMessageFromOthers | 获取会话中收到的最新一条消息 |
| getLatestMessage | 获取会话中的最新一条消息。该消息可能是当前用户发送的,也可能是对端用户发送。 |
| getLatestMessageFromOthers | 获取会话中收到的最新一条消息,即当前用户收到的对端用户发送的最新消息。 |
| clearAllMessages | 清除内存和数据库中指定会话中的消息。 |
| setExtField | 设置会话的扩展字段。 |
| getExtField | 获取会话的扩展字段。 |
Expand Down
6 changes: 3 additions & 3 deletions docs/document/ios/conversation_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@
| isPinned | 是否为置顶会话。 |
| pinnedTime | 会话置顶的 UNIX 时间戳,单位为毫秒。未置顶时值为 `0`|
| marks | 会话标记。 |
| lastReceivedMessage | 收到的对方发送的最后一条消息|
| insertMessage | 插入一条消息在 SDK 本地数据库。消息的会话 ID 应与会话的 ID 保持一致。消息会根据消息里的时间戳被插入 SDK 本地数据库,SDK 会更新会话的 `latestMessage` 等属性。 |
| appendMessage | 插入一条消息到 SDK 本地数据库会话尾部。消息的会话 ID 应该和目标会话的 ID 一致。消息会被插入 SDK 本地数据库,并且更新会话的 `latestMessage` 等属性。 |
| lastReceivedMessage | 获取会话中收到的最新一条消息,即当前用户收到的对端用户发送的最新消息|
| insertMessage | 插入一条消息在 SDK 本地数据库。消息的会话 ID 应与会话的 ID 保持一致。消息会根据消息里的时间戳被插入 SDK 本地数据库,SDK 会更新会话的 `EMChatMessage#latestMessage` 等属性。 |
| appendMessage | 插入一条消息到 SDK 本地数据库会话尾部。消息的会话 ID 应该和目标会话的 ID 一致。消息会被插入 SDK 本地数据库,并且更新会话的 `EMChatMessage#latestMessage` 等属性。 |
| deleteMessageWithId | 从 SDK 本地数据库删除一条消息。 |
| deleteAllMessages | 清除内存和数据库中指定会话中的消息。 |
| removeMessagesFromServerMessageIds | 从会话中删除消息(包括本地存储和服务器存储)。 |
Expand Down
4 changes: 2 additions & 2 deletions docs/document/react-native/conversation_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
| getUnreadCount | 获取会话的未读消息数量。 |
| getMessageCount | 获取会话中的消息数量。 |
| getLatestMessage | 获取指定会话的最新消息。 |
| getLatestReceivedMessage | 获取指定会话中最近接收到的消息。 |
| setConversationExtension | 设置指定会话的自定义扩展信息。 |
| getLatestReceivedMessage | 获取会话中的最新一条消息。该消息可能是当前用户发送的,也可能是对端用户发送。 |
| setConversationExtension | 获取会话中收到的最新一条消息,即当前用户收到的对端用户发送的最新消息。 |
| markMessageAsRead | 标记指定消息为已读。 |
| markAllMessagesAsRead | 标记所有消息为已读。 |
| updateMessage | 更新本地数据库的指定消息。 |
Expand Down
4 changes: 2 additions & 2 deletions docs/document/unity/conversation_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
| IsThread | 判断该会话是否为子区会话。 |
| IsPinned | 判断该会话是否被置顶。 |
| PinnedTime | 会话置顶时间戳(毫秒)。如果 `IsPinned``false`,将返回 `0`|
| LastMessage | 获取指定会话的最新消息。该方法的调用不影响会话的未读消息数。 SDK 首先从内存中获取最新消息,若在内存中未找到,则从数据库中加载,然后将其存放在内存中。 |
| LastReceivedMessage | 获取指定会话中收到的最新消息。 |
| LastMessage | 获取指定会话的最新消息。该消息可能是当前用户发送的,也可能是对端用户发送。该方法的调用不影响会话的未读消息数。 SDK 首先从内存中获取最新消息,若在内存中未找到,则从数据库中加载,然后将其存放在内存中。 |
| LastReceivedMessage | 获取会话中收到的最新一条消息,即当前用户收到的对端用户发送的最新消息。 |
| Ext | 获取指定会话的扩展信息。 |
| UnReadCount | 获取指定会话的未读消息数。 |
| MarkMessageAsRead | 设置指定消息为已读。 |
Expand Down
4 changes: 2 additions & 2 deletions docs/document/windows/conversation_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
| IsThread | 判断该会话是否为子区会话。 |
| IsPinned | 判断该会话是否被置顶。 |
| PinnedTime | 会话置顶时间戳(毫秒)。如果 `IsPinned``false`,将返回 `0`|
| LastMessage | 获取指定会话的最新消息。该方法的调用不影响会话的未读消息数。 SDK 首先从内存中获取最新消息,若在内存中未找到,则从数据库中加载,然后将其存放在内存中。 |
| LastReceivedMessage | 获取指定会话中收到的最新消息。 |
| LastMessage | 获取会话中的最新一条消息。该消息可能是当前用户发送的,也可能是对端用户发送。该方法的调用不影响会话的未读消息数。SDK 首先从内存中获取最新消息,若在内存中未找到,则从数据库中加载,然后将其存放在内存中。 |
| LastReceivedMessage | 获取会话中收到的最新一条消息,即当前用户收到的对端用户发送的最新消息。 |
| Ext | 获取指定会话的扩展信息。 |
| UnReadCount | 获取指定会话的未读消息数。 |
| MarkMessageAsRead | 设置指定消息为已读。 |
Expand Down

0 comments on commit f7f1aab

Please sign in to comment.