Skip to content

Commit 1081f59

Browse files
skiffer-gitskiffer-git
committed
doc
1 parent 0fbb43a commit 1081f59

1 file changed

Lines changed: 98 additions & 88 deletions

File tree

‎i18n/en/docusaurus-plugin-content-docs-guides/current/termDefinition.mdx‎

Lines changed: 98 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1,147 +1,157 @@
1+
Here is the translation of your document into natural English:
2+
13
---
2-
title: '概念解释'
4+
5+
title: 'Concept Explanation'
36
hide_title: true
47
sidebar_position: 2
8+
59
---
6-
# 概念解释
710

8-
## 用户类型
11+
# Concept Explanation
912

10-
在 OpenIM 系统中，用户分为三种类型：**普通用户**、**APP 管理员**和**通知号**。
13+
## User Types
1114

12-
### 普通用户
15+
In the OpenIM system, users are categorized into three types: **Regular User**, **APP Administrator**, and **Notification Account**.
1316

14-
- **组成**：`userID`、`faceURL`、`nickname`、`ex`
15-
- **描述**：普通用户通常由外部业务系统导入，代表 OpenIM 系统的标准终端用户。ex字段作为扩展字段供业务使用。
17+
### Regular User
1618

17-
### APP 管理员
19+
- **Components**: `userID`, `faceURL`, `nickname`, `ex`
20+
- **Description**: Regular users are typically imported from external business systems and represent the standard terminal users of the OpenIM system. The `ex` field is an extension field for business use.
1821

19-
- **权限**：拥有超级权限
20-
- **用途**：通过 APP 管理员的身份调用 REST API 直接操作 OpenIM 系统。
21-
- **内置管理员**：OpenIM 服务器内置一个 APP 管理员，其 `userID` 为 **imAdmin**。
22+
### APP Administrator
2223

23-
### 通知号
24+
- **Permissions**: Superuser privileges.
25+
- **Purpose**: The APP Administrator can invoke the REST API to directly operate the OpenIM system.
26+
- **Built-in Administrator**: The OpenIM server has a built-in APP Administrator with the `userID` of **imAdmin**.
2427

25-
- **功能**：APP 管理员以系统通知号的身份发送通知消息，不受好友关系和群组权限的约束。可通过REST API增加通知号，以及修改通知号昵称和头像。
26-
- **用户体验**：用户收到消息后，消息会以通知号的头像和昵称显示在会话中。
28+
### Notification Account
29+
30+
- **Function**: APP Administrators can send notification messages as a system notification account, which bypasses friend relationships and group permissions. Notification accounts can be added through the REST API, and their nickname and avatar can be modified.
31+
- **User Experience**: When users receive messages, the messages will be displayed with the notification account's avatar and nickname in the conversation.
2732

2833
---
2934

30-
## 群组
35+
## Groups
3136

32-
在 OpenIM 系统中，群组功能包括以下几个方面：
37+
In the OpenIM system, the group functionality includes the following aspects:
3338

34-
### 群组类型
39+
### Group Types
3540

36-
- **单一群组类型**：当前系统仅支持一种群组类型，不区分小群或大群。
41+
- **Single Group Type**: The current system supports only one type of group, without differentiating between small or large groups.
3742

38-
### 群成员限制
43+
### Group Member Limits
3944

40-
- **成员上限**：群成员数量无限制，最高支持 **100,000** 名成员。
45+
- **Member Limit**: There is no restriction on the number of group members, with a maximum of **100,000** members supported.
4146

42-
### 进群方式
47+
### Methods for Joining Groups
4348

44-
用户可以通过以下三种方式加入群组：
49+
Users can join a group through one of the following three methods:
4550

46-
1. **群成员邀请**：现有群成员可以邀请新成员直接加入群组。
47-
2. **发送进群申请**：用户需提交申请，等待群主或管理员批准后方可加入。
48-
3. **允许所有人加群**：任何用户都可以自由加入群组，无需审批。
51+
1. **Group Member Invitation**: Existing group members can invite new members to join the group directly.
52+
2. **Send Join Request**: Users must submit a request and wait for approval from the group owner or administrator to join.
53+
3. **Allow Anyone to Join**: Any user can freely join the group without approval.
4954

50-
### 群组角色及权限
55+
### Group Roles and Permissions
5156

52-
群组内共有三种身份，权限依次递减：
57+
There are three roles in a group, with decreasing levels of permissions:
5358

54-
1. **群主**
55-
2. **管理员**
56-
3. **普通成员**
59+
1. **Group Owner**
60+
2. **Administrator**
61+
3. **Regular Member**
5762

58-
#### 群主
63+
#### Group Owner
5964

60-
- **权限**：拥有最高权限。
61-
- **管理功能**：
62-
- 设置多个管理员，管理员之间权限相同。
63-
- 解散群组。
64-
- 转让群主身份给其他群成员。
65-
- 退群前必须先转让群主身份。
66-
- 处理进群申请。
67-
- 管理群设置，如群公告、群名称等。
65+
- **Permissions**: The highest level of permissions.
66+
- **Management Functions**:
67+
- Set multiple administrators, all of whom have the same permissions.
68+
- Dissolve the group.
69+
- Transfer ownership to another group member.
70+
- Must transfer ownership before leaving the group.
71+
- Handle group join requests.
72+
- Manage group settings, such as group announcements and group name.
6873

69-
#### 管理员
74+
#### Administrator
7075

71-
- **权限**：与其他管理员权限相同，次于群主。
72-
- **管理功能**：
73-
- 处理进群申请。
74-
- 管理群设置，如群公告、群名称等。
75-
- 对普通成员进行管理操作，例如踢出群成员、禁言成员。
76+
- **Permissions**: Same as other administrators, subordinate to the group owner.
77+
- **Management Functions**:
78+
- Handle group join requests.
79+
- Manage group settings, such as group announcements and group name.
80+
- Perform management tasks on regular members, such as kicking out members or muting them.
7681

77-
#### 普通成员
82+
#### Regular Member
7883

79-
- **权限**：拥有基本的群组使用权限。
80-
- **功能**：参与群聊，查看群公告，发送消息等。
84+
- **Permissions**: Basic group usage permissions.
85+
- **Functions**: Participate in group chats, view group announcements, send messages, etc.
8186

82-
### 权限管理
87+
### Permissions Management
8388

84-
- **高权限身份操作**：群主和管理员可以对低权限身份进行操作，如踢出群、禁言等。
85-
- **管理员之间权限相同**：管理员之间无上下级关系，彼此权限平等。
89+
- **High-Permission Role Operations**: Group owners and administrators can perform operations on lower-permission roles, such as kicking members out or muting them.
90+
- **Equal Permissions Among Administrators**: Administrators have equal permissions and do not have a hierarchical relationship.
8691

87-
### 群主与管理员的管理功能
92+
### Group Owner and Administrator Management Functions
8893

89-
- **处理进群申请**：群主和管理员可以审核并处理用户的进群申请。
90-
- **群组设置管理**：包括编辑群公告、修改群名称等。
94+
- **Handle Join Requests**: Group owners and administrators can review and handle user join requests.
95+
- **Group Settings Management**: Includes editing group announcements, changing group names, etc.
9196

9297
---
9398

94-
## 消息和通知
99+
## Messages and Notifications
95100

96-
### 消息
101+
### Messages
97102

98-
- **定义**：消息指由用户或系统发送的实际内容，包括文字、图片、视频等多媒体形式。
99-
- **功能**：
100-
- **传输内容**：将消息内容传送至接收者。
101-
- **展示与显示**：在接收端清晰展示消息内容，确保用户能够理解和查看。
103+
- **Definition**: A message refers to the actual content sent by a user or the system, including text, images, videos, and other multimedia forms.
104+
- **Functions**:
105+
- **Content Transmission**: Transmits message content to the receiver.
106+
- **Display and Presentation**: Ensures that the message content is clearly displayed on the receiving end so that the user can understand and view it.
102107

103-
### 通知
108+
### Notifications
104109

105-
- **定义**：通知指由用户或系统触发的行为，以通知形式发送给相关方。
106-
- **用途**：
107-
- **系统同步**：用于同步系统状态或操作，如群成员同步、好友列表同步等。
108-
- **信息展示**：用于向用户展示重要事件或操作结果，例如进群通知、系统公告等。
110+
- **Definition**: A notification refers to an action triggered by a user or system and sent to the relevant parties in the form of a notification.
111+
- **Uses**:
112+
- **System Synchronization**: Used to synchronize system states or actions, such as group member synchronization or friend list synchronization.
113+
- **Information Display**: Used to display important events or action results to users, such as join group notifications or system announcements.
109114

110115
---
111116

112-
## 消息推送
117+
## Message Push
113118

114-
### 在线推送
119+
### Online Push
115120

116-
- **定义**：当用户在线时，OpenIM 优先使用自己的长连接通道进行消息推送，此时称为在线推送。
117-
- **特点**：
118-
- **实时性强**：消息能立即传达给接收者。
119-
- **稳定性**：依赖长连接通道，确保消息传输的可靠性。
121+
- **Definition**: When the user is online, OpenIM prioritizes using its own long connection channel for message push. This is called online push.
122+
- **Characteristics**:
123+
- **High Real-time**: Messages are delivered to the recipient immediately.
124+
- **Stability**: Relies on the long connection channel, ensuring message transmission reliability.
120125

121-
### 离线推送
126+
### Offline Push
122127

123-
- **定义**：当用户不在线时，或者 APP 被杀死，此时 OpenIM 长连接无法推送消息，必须借用第三方推送服务。
124-
- **实现方式**：
125-
- **厂商推送**：利用如 APNs（苹果推送通知服务）等厂商的推送服务进行消息传递。
126-
- **中国境内**：一般使用**个推**服务。
127-
- **境外**：一般使用**Firebase**服务。
128-
- **特点**：
129-
- **覆盖广**：适用于各种网络环境，确保消息能在用户恢复上线时被接收。
128+
- **Definition**: When the user is offline, or if the app is killed, OpenIM cannot push messages through the long connection and must use a third-party push service.
129+
- **Implementation Methods**:
130+
- **Vendor Push**: Uses push services from vendors such as APNs (Apple Push Notification Service) to deliver messages.
131+
- **In Mainland China**: Generally uses **GeTui** service.
132+
- **Outside China**: Generally uses **Firebase** service.
133+
- **Characteristics**:
134+
- **Wide Coverage**: Suitable for various network environments, ensuring that messages are received when the user comes online again.
130135

131136
---
132137

133-
## 消息存储类型
138+
## Message Storage Types
139+
140+
### Local Messages
134141

135-
### 本地消息
136-
- 除了 jssdk 外，OpenIM 的消息会根据需要进行拉取加载。对于客户端已拉取的消息，系统会将其存储在本地，统称为“本地消息” 。
142+
- Apart from the JS SDK, OpenIM stores messages locally as needed. For messages already fetched by the client, the system stores them locally, collectively called **"Local Messages"** 🗄️.
137143

138-
### 多端同步消息
139-
- 用户通常会使用多种设备，当用户从设备 A 发送消息时，该消息会同步到设备 B，这类消息称为“多端同步消息” 。
144+
### Multi-Device Sync Messages
140145

141-
### 离线消息
142-
- 用户在离线期间接收到的消息，系统会在用户重新登录后根据需要从服务器同步并加载，这些消息称为“离线消息” 。
146+
- Users often use multiple devices. When a message is sent from device A, it will be synced to device B. These messages are called **"Multi-Device Sync Messages"** 🔄.
143147

144-
### 漫游消息
145-
- 当用户更换设备或重新安装应用时，系统会拉取并同步这些历史消息，这些消息被称为“漫游消息” 。
148+
### Offline Messages
149+
150+
- Messages received while the user is offline are called **"Offline Messages"** 📩. The system will sync these messages when the user logs back in.
151+
152+
### Roaming Messages
153+
154+
- When the user switches devices or reinstalls the app, the system will fetch and sync these historical messages. These messages are referred to as **"Roaming Messages"** 🌍.
146155

147156
---
157+

0 commit comments

Comments
 (0)