Skip to content

Commit

Permalink
Merge pull request #522 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history
Modify Message Recipient Validity Period
  • Loading branch information
haoxiuwen authored Nov 29, 2023
2 parents cd65162 + 0a676ac commit 29351bb
Show file tree
Hide file tree
Showing 19 changed files with 76 additions and 30 deletions.
4 changes: 4 additions & 0 deletions docs/document/android/group_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,10 @@ EMClient.getInstance().groupManager().destroyGroup(groupId);

群成员也可以调用 `getGroupFromServer(String groupId, boolean fetchMembers)` 方法从服务器获取群组详情。返回的结果包括群组 ID、群组名称、群组描述、群组基本属性、群主、群组管理员列表、是否已屏蔽群组消息以及群组是否禁用等信息。另外,若将该方法的 `fetchMembers` 参数设置为 `true`,可获取群成员列表,默认最多包括 200 个成员。

:::tip
对于公有群,用户即使不加入群也能获取群组详情,而对于私有群,用户只有加入了群组才能获取群详情。
:::

示例代码如下:

```java
Expand Down
2 changes: 1 addition & 1 deletion docs/document/android/group_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
- 群组按照是否对用户公开,可以分为公开群和私有群。

| 群组分类 | 加群方式 | 获取群组信息 |
| :------- | :---------- | :---------- | :---------- |
| :------- | :---------- | :---------- |
| 公开群 | 任何用户可以搜索到该群,可申请加入群或者被管理员和群主邀请入群。任何用户均可申请入群,是否需要群主和群管理员审批,取决于群组的设置,例如 Android 为 `EMGroupStyle` 参数。 | - 对于群组详情和公开群列表,用户即使不加入群也能获取。<br/> - 对于群公告和群共享文件列表,用户只有加入群时才能获取。 |
| 私有群 | 群外用户不能搜索到此类群组,需要被邀请才能入群。除了群主和群管理员,群成员是否也能邀请其他用户进群取决于群组的设置,例如 Android 为 `EMGroupStyle` 参数。 | 用户只有加入群后才能获取群详情、群公告、群共享文件列表、和群成员列表等群组信息。 |

Expand Down
11 changes: 7 additions & 4 deletions docs/document/android/message_receipt.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

单聊会话支持消息送达回执、会话已读回执和消息已读回执,发送方发送消息后可及时了解接收方是否及时收到并阅读了信息,也可以了解整个会话是否已读。

群聊会话只支持消息已读回执。群主和群管理员在发送消息时,可以设置该消息是否需要已读回执。仅旗舰版及以上版本支持群消息已读回执功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。
群聊会话只支持消息已读回执。群主和群管理员在发送消息时,可以设置该消息是否需要已读回执。仅专业版及以上版本支持群消息已读回执功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。

本文介绍如何使用环信即时通讯 IM Android SDK 实现单聊和群聊的消息回执功能。

Expand Down Expand Up @@ -41,7 +41,7 @@

- 完成 SDK 初始化,并连接到服务器,详见 [快速开始](quickstart.html)
- 了解环信即时通讯 IM 的使用限制,详见 [使用限制](/product/limitation.html)
- 群消息已读回执功能仅在环信 IM 旗舰版及以上版本支持该功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。
- 群消息已读回执功能仅在环信 IM 专业版及以上版本支持该功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。

## 实现方法

Expand Down Expand Up @@ -90,7 +90,6 @@ EMClient.getInstance().chatManager().removeMessageListener(msgListener);
Options.setRequireAck = true;
```


##### 会话已读回执

参考以下步骤在单聊中实现会话已读回执。
Expand Down Expand Up @@ -125,6 +124,8 @@ EMClient.getInstance().chatManager().addConversationListener(new EMConversationL
##### 消息已读回执

单聊消息的已读回执有效期与消息在服务端的存储时间一致,即在服务器存储消息期间均可发送已读回执。关于消息在服务端的存储时间与你订阅的套餐包有关,详见[产品价格](/product/pricing.html#套餐包功能详情)

参考如下步骤在单聊中实现消息已读回执。

1. 接收方发送已读回执消息。
Expand Down Expand Up @@ -200,7 +201,9 @@ EMClient.getInstance().chatManager().addMessageListener(new EMMessageListener()

对于群聊,群主和群管理员发送消息时,可以设置该消息是否需要已读回执。若需要,每个群成员在阅读消息后,SDK 均会发送已读回执,即阅读该消息的群成员数量即为已读回执的数量。

仅旗舰版及以上版本支持群消息已读回执功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。
群聊已读回执的有效期为 3 天,即群组中的消息发送时间超过 3 天,服务器不记录阅读该条消息的群组成员,也不会发送已读回执。

仅专业版及以上版本支持群消息已读回执功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。

1. 群主或群管理员发送消息时若需已读回执,需设置 `EMMessage` 的方法 `setIsNeedGroupAck()``YES`

Expand Down
10 changes: 6 additions & 4 deletions docs/document/flutter/message_receipt.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

单聊会话支持消息送达回执、会话已读回执和消息已读回执,发送方发送消息后可及时了解接收方是否及时收到并阅读了信息,也可以了解整个会话是否已读。

群聊会话只支持消息已读回执。群主和群管理员在发送消息时,可以设置该消息是否需要已读回执。仅旗舰版及以上版本支持群消息已读回执功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。
群聊会话只支持消息已读回执。群主和群管理员在发送消息时,可以设置该消息是否需要已读回执。仅专业版及以上版本支持群消息已读回执功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。

本文介绍如何使用环信即时通讯 IM Flutter SDK 实现单聊和群聊的消息回执功能。

Expand Down Expand Up @@ -37,7 +37,7 @@

- 完成 SDK 初始化,并连接到服务器,详见 [快速开始](quickstart.html)
- 了解环信即时通讯 IM 的使用限制,详见 [使用限制](/product/limitation.html)
- 群消息已读回执功能仅在环信 IM 旗舰版及以上版本支持该功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。
- 群消息已读回执功能仅在环信 IM 专业版及以上版本支持该功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。

## 实现方法

Expand Down Expand Up @@ -120,6 +120,8 @@ EMClient.getInstance.chatManager.addEventHandler(
##### 消息已读回执

单聊消息的已读回执有效期与消息在服务端的存储时间一致,即在服务器存储消息期间均可发送已读回执。关于消息在服务端的存储时间与你订阅的套餐包有关,详见[产品价格](/product/pricing.html#套餐包功能详情)

参考如下步骤在单聊中实现消息已读回执。

1. 开启全局的消息已读回执开关。如果全局设置不开启,消息和会话的相应设置也无法生效。
Expand Down Expand Up @@ -155,9 +157,9 @@ try {

### 群聊

对于群聊,群主和群管理员发送消息时,可以设置该消息是否需要已读回执。若需要,每个群成员在阅读消息后,SDK 均会发送已读回执,即阅读该消息的群成员数量即为已读回执的数量。
对于群聊,群主和群管理员发送消息时,可以设置该消息是否需要已读回执。若需要,每个群成员在阅读消息后,SDK 均会发送已读回执,即阅读该消息的群成员数量即为已读回执的数量。群聊已读回执的有效期为 3 天,即群组中的消息发送时间超过 3 天,服务器不记录阅读该条消息的群组成员,也不会发送已读回执。

仅旗舰版及以上版本支持群消息已读回执功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。
仅专业版及以上版本支持群消息已读回执功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。

1. 消息发送方需要知道群组消息是否已读,需要监听 `onGroupMessageRead` 事件。

Expand Down
3 changes: 2 additions & 1 deletion docs/document/ios/group_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,8 @@ NSArray *members = @{@"member1",@"member2"};
### 获取群组详情

:::notice
从 3.7.4 版本开始支持是否获取群组成员参数 `fetchMembers`
从 3.7.4 版本开始支持是否获取群组成员参数 `fetchMembers`
对于公有群,用户即使不加入群也能获取群组详情,而对于私有群,用户只有加入了群组才能获取群详情。
:::

群成员也可以调用 `getGroupSpecificationFromServerWithId` 方法从服务器获取群组详情。返回的结果包括群组 ID、群组名称、群组描述、群组基本属性、群主、群组管理员列表、是否已屏蔽群组消息以及群组是否禁用。另外,若将该方法的 `fetchMembers` 参数设置为 `true`,可获取群成员列表,默认最多包括 200 个成员。
Expand Down
10 changes: 7 additions & 3 deletions docs/document/ios/message_receipt.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

单聊会话支持消息送达回执、会话已读回执和消息已读回执,发送方发送消息后可及时了解接收方是否及时收到并阅读了信息,也可以了解整个会话是否已读。

群聊会话只支持消息已读回执。群主和群管理员在发送消息时,可以设置该消息是否需要已读回执。仅旗舰版及以上版本支持群消息已读回执功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。
群聊会话只支持消息已读回执。群主和群管理员在发送消息时,可以设置该消息是否需要已读回执。仅专业版及以上版本支持群消息已读回执功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。

本文介绍如何使用环信即时通讯 IM iOS SDK 实现单聊和群聊的消息回执功能。

Expand Down Expand Up @@ -41,7 +41,7 @@

- 完成 SDK 初始化,并连接到服务器,详见 [快速开始](quickstart.html)
- 了解环信即时通讯 IM 的使用限制,详见 [使用限制](/product/limitation.html)
- 群消息已读回执功能仅在环信 IM 旗舰版及以上版本支持该功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。
- 群消息已读回执功能仅在环信 IM 专业版及以上版本支持该功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。

## 实现方法

Expand Down Expand Up @@ -122,6 +122,8 @@ EMChatManagerDelegate

##### 消息已读回执

单聊消息的已读回执有效期与消息在服务端的存储时间一致,即在服务器存储消息期间均可发送已读回执。关于消息在服务端的存储时间与你订阅的套餐包有关,详见[产品价格](/product/pricing.html#套餐包功能详情)

参考如下步骤在单聊中实现消息已读回执。

1. 接收方发送已读回执消息。
Expand Down Expand Up @@ -189,7 +191,9 @@ EMChatManagerDelegate
对于群聊,群主和群管理员发送消息时,可以设置该消息是否需要已读回执。若需要,每个群成员在阅读消息后,SDK 均会发送已读回执,即阅读该消息的群成员数量即为已读回执的数量。
仅旗舰版及以上版本支持群消息已读回执功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。
群聊已读回执的有效期为 3 天,即群组中的消息发送时间超过 3 天,服务器不记录阅读该条消息的群组成员,也不会发送已读回执。
仅专业版及以上版本支持群消息已读回执功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。
1. 群主或群管理员设置 `EMChatMessage` 的属性 `isNeedGroupAck` 为 `YES`。
Expand Down
4 changes: 4 additions & 0 deletions docs/document/react-native/group_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,10 @@ ChatClient.getInstance()
- `getGroupWithId`:从内存获取群组详情。返回的结果包括群组 ID、群组名称、群组描述、群主、公告信息、群成员列表数量、消息屏蔽、是否全体禁言、权限类型等,默认不包含群成员。
- `fetchGroupInfoFromServer`:从服务器获取群组详情。返回的结果包括群组 ID、群组名称、群组描述、群组基本属性、群主、群组管理员列表、是否已屏蔽群组消息和群组是否禁用等信息。若将该方法的 `fetchMembers` 参数设置为 `true`,可获取群成员列表,默认最多包括 200 个成员。

:::tip
对于公有群,用户即使不加入群也能获取群组详情,而对于私有群,用户只有加入了群组才能获取群详情。
:::

```typescript
// 从本地获取群组详情。
ChatClient.getInstance()
Expand Down
10 changes: 7 additions & 3 deletions docs/document/react-native/message_receipt.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<Toc />
单聊会话支持消息送达回执、会话已读回执和消息已读回执,发送方发送消息后可及时了解接收方是否及时收到并阅读了信息,也可以了解整个会话是否已读。

群聊会话只支持消息已读回执。群主和群管理员在发送消息时,可以设置该消息是否需要已读回执。仅旗舰版及以上版本支持群消息已读回执功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。
群聊会话只支持消息已读回执。群主和群管理员在发送消息时,可以设置该消息是否需要已读回执。仅专业版及以上版本支持群消息已读回执功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。

本文介绍如何使用环信即时通讯 IM React Native SDK 实现单聊和群聊的消息回执功能。

Expand Down Expand Up @@ -37,7 +37,7 @@

- 完成 SDK 初始化,并连接到服务器,详见 [快速开始](quickstart.html)[SDK 集成概述](overview.html)
- 了解环信即时通讯 IM 的使用限制,详见 [使用限制](/product/limitation.html)
- 群消息已读回执功能仅在环信 IM 旗舰版及以上版本支持该功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。
- 群消息已读回执功能仅在环信 IM 专业版及以上版本支持该功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。

## 实现方法

Expand Down Expand Up @@ -151,6 +151,8 @@ ChatClient.getInstance().chatManager.addMessageListener(listener);
##### 消息已读回执

单聊消息的已读回执有效期与消息在服务端的存储时间一致,即在服务器存储消息期间均可发送已读回执。关于消息在服务端的存储时间与你订阅的套餐包有关,详见[产品价格](/product/pricing.html#套餐包功能详情)

参考如下步骤在单聊中实现消息已读回执。

1. 开启全局的消息已读回执开关。如果全局设置不开启,消息和会话的相应设置也无法生效。
Expand Down Expand Up @@ -230,7 +232,9 @@ ChatClient.getInstance()

对于群聊,群主和群管理员发送消息时,可以设置该消息是否需要已读回执。若需要,每个群成员在阅读消息后,SDK 均会发送已读回执,即阅读该消息的群成员数量即为已读回执的数量。

仅旗舰版及以上版本支持群消息已读回执功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。
群聊已读回执的有效期为 3 天,即群组中的消息发送时间超过 3 天,服务器不记录阅读该条消息的群组成员,也不会发送已读回执。

仅专业版及以上版本支持群消息已读回执功能。若要使用该功能,需在[环信即时通讯云控制台](https://console.easemob.com/user/login)开通。

1. 消息发送方需要知道群组消息是否已读,需要监听 `onGroupMessageRead` 事件。

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

回调功能,即环信 IM 服务器会在事件发生之前或之后,向你的应用服务器发送请求,你可以根据业务需求来干预事件的后续处理流程(发送前回调),或据此进行必要的数据同步(发送后回调)。

一般发送前回调是对用户发送的消息内容的处理,发送后回调还包括送达回执和已读回执、群组或聊天室操作、好友关系操作和用户状态变化等事件,具体见 [用户在线状态回调](user_status_callback.html) 和发送后回调过滤规则设置
一般发送前回调是对用户发送的消息内容的处理,发送后回调还包括送达回执和已读回执、群组或聊天室操作、好友关系操作和用户状态变化等事件,详见发送后回调过滤规则设置

设置消息内容回调的规则可以在环信即时通讯云控制台实现,如需单独设置特定类型不回调,请联系环信商务经理。

Expand Down
4 changes: 4 additions & 0 deletions docs/document/unity/group_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,10 @@ SDKClient.Instance.GroupManager.LeaveGroup(groupId, new CallBack(

群成员也可以调用 `GetGroupSpecificationFromServer` 方法从服务器获取群组详情。返回结果包括:群组 ID、群组名称、群组描述、群主、群组管理员列表、是否已屏蔽群组消息以及群组是否禁用等信息,不包括群成员列表。

:::tip
对于公有群,用户即使不加入群也能获取群组详情,而对于私有群,用户只有加入了群组才能获取群详情。
:::

示例代码如下:

```csharp
Expand Down
Loading

0 comments on commit 29351bb

Please sign in to comment.