Skip to content

Commit df758db

Browse files
authored
Merge pull request #1015 from haoxiuwen/doc-v2
Add Product Introductions
2 parents 50fc290 + 16bf81c commit df758db

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+1265
-675
lines changed
24.8 KB
Loading
47.3 KB
Loading

docs/.vuepress/sidebar/index.ts

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,40 @@ export const zhSidebar = sidebar({
1919
text: "产品简介",
2020
children: [
2121
{ text: "产品概述", link: "introduction.html" },
22+
{ text: "特性介绍",
23+
children: [
24+
{ text: "消息",
25+
collapsible: true,
26+
children: [
27+
{ text: "消息概述", link: "product_message_overview.html" },
28+
{ text: "消息格式", link: "product_message_format.html" },
29+
],
30+
},
31+
{ text: "用户账号",
32+
collapsible: true,
33+
children: [
34+
{ text: "用户注册与登录", link: "product_user_registration_login.html" },
35+
{ text: "在线状态管理", link: "product_user_presence.html" },
36+
],
37+
},
38+
{ text: "用户属性与用户关系",
39+
collapsible: true,
40+
children: [
41+
{ text: "用户属性", link: "product_user_attribute.html" },
42+
{ text: "用户关系", link: "product_user_relationship.html" },
43+
],
44+
},
45+
{ text: "群组",
46+
collapsible: true,
47+
children: [
48+
{ text: "群组概述", link: "product_group_overview.html" },
49+
{ text: "子区", link: "product_thread_overview.html" },
50+
],
51+
},
52+
{ text: "聊天室", link: "product_chatroom_overview.html" },
53+
{ text: "离线推送", link: "product_offline_push_overview.html" },
54+
],
55+
},
2256
{ text: "数据中心", link: "data_center.html" },
2357
{ text: "产品动态", link: "product_dynamics.html" },
2458
{ text: "IM 产品使用限制", link: "limitation.html" },
Lines changed: 6 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,6 @@
1-
# 群组概述
2-
3-
<Toc />
4-
5-
## 功能描述
6-
7-
群组是支持多人沟通的即时通讯系统,成员关系相对稳定。所有群成员可以收到群中的消息,可以在群中发送消息。群成员离线时可以收到推送消息。群组成员支持多种角色:群主、群管理员和普通成员。群组提供丰富的管理能力,如群组禁言、群公告和群文件等。
8-
9-
如需查看消息相关内容,参见 <Link title="消息管理" to="message_overview.html" />。
10-
11-
群组支持两种加入授权方式:
12-
13-
- 需要群主授权加入;
14-
- 不需要群主授权即可加入。
15-
16-
### 群组与聊天室的区别
17-
18-
群组和聊天室均为支持多人沟通的即时通讯系统。两者的区别在于,群组中的成员会有固定的强的关系,成员加入后会长时间在群组中。聊天室中的成员没有固定关系,类似于一个开放的空间,大家可以自由加入,离开即退出聊天室。以下为功能对比:
19-
20-
| 功能<div style="width: 100px;"></div> | 群组<div style="width: 300px;"></div> | 聊天室 |
21-
| :----------- | :----------------------------------------------------------- | :----------------------------------------------------------- |
22-
| 使用场景 | 类似于 Signal,Skype 里的群聊,所有加入的用户拥有固定的关系。 | 类似 Twitch 的直播间,成员间没有固定关系,离开即退出。 |
23-
| 创建方式 | 所有 app 用户都可以创建群组。 |[超级管理员](/document/server-side/chatroom.html#管理超级管理员) 有权限创建聊天室。 |
24-
| 类型 | 分为公开群和私有群,创建群组时可设置入群是否需获得群主和群管理员的同意,支持不同使用场景。 | 没有公开和私有之分,所有用户均可自由加入或退出。 |
25-
| 最大成员数 | 成员数支持取决于所选择的版本,最高版本支持 8,000 人。 | 成员数支持取决于所选择的版本,最高版本支持 10,000 人。如需提升该上限,请联系商务。 |
26-
| 离线消息存储 | 支持离线消息存储。用户离线时,服务器会先保存发送给这些用户的消息,等待这些用户上线时发送。对于单个终端用户来说,服务器最多可保存 200 条离线消息。 | 不支持离线消息存储。离线时,不会收到推送消息;成员(除聊天室白名单中的成员)离线超过 2 分钟会自动退出聊天室。 |
27-
| 漫游消息/历史消息记录存储 | 支持漫游消息和历史记录的存储。<br/> - 服务器存储漫游消息和历史消息记录的时间取决于你订阅的 IM 套餐包,详见[产品价格](/product/pricing.html#套餐包功能详情)。<br/> - 你可以[调用 REST API 接口从服务端获取历史消息记录 JSON 文件](/document/server-side/message_historical.html)。<br/> - 你还可以[调用客户端接口从服务端获取指定会话的漫游消息](message_retrieve.html#从服务器获取指定会话的消息),在多设备间同步。 | 支持漫游消息和历史记录的存储。<br/> - 若要获取聊天室的漫游消息,需联系环信商务。如果需要用户新加入聊天室时服务器推送最近的漫游消息,可以联系商务开通,每个会话默认支持 10 条消息,最多可调整至 200 条。<br/> - 服务器存储历史消息记录的时间取决于你订阅的 IM 套餐包,详见[产品价格](/product/pricing.html#套餐包功能详情)。<br/> - 你可以[调用 REST API 接口从服务端获取历史消息记录 JSON 文件](/document/server-side/message_historical.html)。<br/> - 你还可以[调用客户端接口从服务端获取指定会话的漫游消息](message_retrieve.html#从服务器获取指定会话的消息),在多设备间同步。|
28-
| 消息可靠性 | 群组中发送的所有消息,用户都会收到。 | 当消息量大时,聊天室中超过阈值的消息会被丢弃。消息开始丢弃的阈值为每秒 100 条消息,可以根据需求进行调整。 |
29-
30-
### 群组成员角色
31-
32-
| 群成员角色<div style="width: 100px;"></div> | 描述<div style="width: 384px;"></div> | 管理权限 |
33-
| :--------- | :------------------------------------------------- | :----------------------------------------------------------- |
34-
| 普通成员 | 不具备管理权限的普通成员。 | 普通成员可以收发消息,查看群组描述信息。 |
35-
| 群管理员 | 由群主指定,协助群主进行管理,拥有一定的管理权限。 | 管理员可以更改群组名称和描述信息、对群成员进行管理。 |
36-
| 群主 | 群组的创建者,在群中拥有最高权限。 | 群主可以指定管理员、解散群组、将群主权限转移给他人、更改群组名称和描述信息和对群成员进行管理。 |
37-
38-
### 群组分类
39-
40-
- 群组按照是否对用户公开,可以分为公开群和私有群。
41-
42-
| 群组分类 | 加群方式 | 获取群组信息 |
43-
| :------- | :---------- | :---------- |
44-
| 公开群 | 任何用户可以搜索到该群,可申请加入群或者被管理员和群主邀请入群。任何用户均可申请入群,是否需要群主和群管理员审批,取决于群组的设置,例如 Android 为 `EMGroupStyle` 参数。 | - 对于群组详情和公开群列表,用户即使不加入群也能获取。<br/> - 对于群公告和群共享文件列表,用户只有加入群时才能获取。 |
45-
| 私有群 | 群外用户不能搜索到此类群组,需要被邀请才能入群。除了群主和群管理员,群成员是否也能邀请其他用户进群取决于群组的设置,例如 Android 为 `EMGroupStyle` 参数。 | 用户只有加入群后才能获取群详情、群公告、群共享文件列表、和群成员列表等群组信息。 |
46-
47-
:::tip
48-
若群组的成员数超过了 3000人,默认不支持离线推送。对于超过 3000 人的群组,若希望提供离线推送功能,你必须在创建群组之前联系商务开通,否则群组创建后无法再开通该功能。
49-
:::
50-
51-
### 群组功能
52-
53-
群组功能主要分为群组的建立和管理,群成员管理,以及群属性管理。
54-
55-
#### 创建和管理群组
56-
57-
| 功能 | 描述 |
58-
| :----------------- | :----------------------------------------------------------- |
59-
| 创建群组 | 群组分为公开群和私有群,可以对加群的方式进行设置。任何用户都可以创建群组。群组创建者为群组。群组数量和群成员数量根据套餐版本有所不同。详见 [环信即时通讯 IM 价格](https://www.easemob.com/pricing/im)|
60-
| 解散群组 | 只有群主才能解散群组。群组一旦解散,所有本地群组数据都会被删除,所有群成员都被强制退出群。 |
61-
| 获取群组详情 | 群成员可以从内存获取群组详情。返回的结果包括群组 ID、群组名称、群组描述、群组基本属性、群主、群组管理员列表,默认不包含群成员。 |
62-
| 获取群成员列表 | 所有群组用户都可以从服务器获取群组成员的分页列表。成员按加入群组时的时间戳降序显示。 |
63-
| 获取群组列表 | 用户可以获取公开群列表和自己创建或加入的群组列表。 |
64-
| 屏蔽和解除群消息 | 所有群组成员都可以屏蔽和取消屏蔽群组消息。用户屏蔽群组消息后,他们将不再收到来自指定群组的消息。 |
65-
| 监听群组事件 | 你可以监听群组事件,例如用户何时加入和离开群组,并根据需要添加应用逻辑。 |
66-
67-
#### 群成员管理
68-
69-
| 功能 | 描述 |
70-
| :--------------------- | :----------------------------------------------------------- |
71-
| 加入群组 | 公开群和私有群中,群主和管理员均可以邀请用户加入群。<br/>支持需要用户确认后,再加入群。 此外用户也可以申请加入公开群。|
72-
| 退出群组 | 群主不支持退群操作,只能解散群。退出群组分为主动退群和被动退群。被动退群即为被群主和群管理员踢出群。 |
73-
| 变更群主 | 群主可以将群组的所有权转让给指定的组成员。所有权转移后,群主成为普通群成员。 |
74-
| 添加和移除群管理员 | 群主可以添加成员到群组管理员列表,也可以将管理员移出该列表。管理员列表中的成员获得所有的群管理员权限。 |
75-
| 群组白名单 | 群主和管理员可以将群成员加入或移出白名单。白名单中的群成员可以在全员禁言状态下发送群消息。 |
76-
| 群组黑名单 | 群主和群管理员可以将群成员加入或移出黑名单,黑名单中的成员将被移出群且无法再次加入群。 |
77-
| 群组禁言 | <ul><li>群主和管理员可以将群成员加入或移出禁言列表,禁言列表中的成员无法发送群消息,但可以接收群消息。</li><li>群主和管理员可以开启或关闭全员禁言,开启全员禁言后,仅群主、管理员和白名单中的成员可以发送群消息。</li></ul> |
78-
79-
#### 群属性管理
80-
81-
| 功能 | 描述 |
82-
| :--------------- | :----------------------------------------------------------- |
83-
| 修改群名称和描述 | 群主和群管理员可以修改群名称和群组描述。 |
84-
| 管理群公告 | 群主和群管理员可以设置和更新群公告,群成员可以获取群公告。 |
85-
| 管理共享文件 | 群主和群管理员可以上传文件并删除所有群共享文件,群成员只能删除自己上传的文件。 |
86-
| 更新群扩展字段 | 群主和群管理员可以修改群组的扩展字段。你可以通过群扩展字段设置 JSON 格式的数据,添加群组扩展信息。群扩展字段的长度限制为 8 KB。 |
87-
88-
### 群组人数限制
89-
90-
群成员的数量根据不同的套餐版本而不同,详见[产品价格](/product/pricing.html#套餐包功能详情)
1+
---
2+
{
3+
pageUri: "/product/product_group_overview.html",
4+
title: "群组概述"
5+
}
6+
---

0 commit comments

Comments
 (0)