Skip to content

Commit

Permalink
Merge pull request #1023 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history
Modify IM Doc
  • Loading branch information
haoxiuwen authored Nov 5, 2024
2 parents 2c98f92 + e25b21e commit 1a5b805
Show file tree
Hide file tree
Showing 14 changed files with 21 additions and 21 deletions.
4 changes: 2 additions & 2 deletions docs/document/android/room_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
- 完成 SDK 初始化,详见 [快速开始](quickstart.html)
- 了解环信即时通讯 IM 的 [使用限制](/product/limitation.html)
- 了解环信即时通讯 IM 不同版本的聊天室相关数量限制,详见 [环信即时通讯 IM 价格](https://www.easemob.com/pricing/im)
- 只有超级管理员才有创建聊天室的权限,因此你还需要确保已调用 RESTful API 添加了超级管理员,详见 [添加聊天室超级管理员](/document/server-side/chatroom.html#添加超级管理员)
- 只有超级管理员才有创建聊天室的权限,因此你还需要确保已调用 RESTful API 添加了超级管理员,详见 [添加聊天室超级管理员](/document/server-side/chatroom_superadmin.html)
- 聊天室创建者和管理员的数量之和不能超过 100,即管理员最多可添加 99 个。

## 实现方法
Expand All @@ -36,7 +36,7 @@

### 创建聊天室

[超级管理员](/document/server-side/chatroom.html#管理超级管理员) 可以调用 `createChatRoom` 方法创建聊天室,并设置聊天室的名称、描述、最大成员数等信息。成功创建聊天室后,该超级管理员为该聊天室的所有者。
[超级管理员](/document/server-side/chatroom_superadmin.html) 可以调用 `createChatRoom` 方法创建聊天室,并设置聊天室的名称、描述、最大成员数等信息。成功创建聊天室后,该超级管理员为该聊天室的所有者。

建议直接调用 REST API [从服务端创建聊天室](/document/server-side/chatroom.html#创建聊天室)

Expand Down
4 changes: 2 additions & 2 deletions docs/document/flutter/room_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
- 完成 SDK 初始化,详见 [快速开始](quickstart.html)
- 了解环信即时通讯 IM 的 [使用限制](/product/limitation.html)
- 了解环信即时通讯 IM 不同版本的聊天室相关数量限制,详见 [环信即时通讯 IM 价格](https://www.easemob.com/pricing/im)
- 只有超级管理员才有创建聊天室的权限,因此你还需要确保已调用 RESTful API 添加了超级管理员,详见 [添加聊天室超级管理员](/document/server-side/chatroom.html#添加超级管理员)
- 只有超级管理员才有创建聊天室的权限,因此你还需要确保已调用 RESTful API 添加了超级管理员,详见 [添加聊天室超级管理员](/document/server-side/chatroom_superadmin.html)
- 聊天室创建者和管理员的数量之和不能超过 100,即管理员最多可添加 99 个。

## 实现方法
Expand All @@ -37,7 +37,7 @@

### 创建聊天室

[超级管理员](/document/server-side/chatroom.html#管理超级管理员) 可以调用 `EMChatRoomManager#createChatRoom` 方法创建聊天室,并设置聊天室的名称、描述、最大成员数等信息。成功创建聊天室后,该超级管理员为该聊天室的所有者。
[超级管理员](/document/server-side/chatroom_superadmin.html) 可以调用 `EMChatRoomManager#createChatRoom` 方法创建聊天室,并设置聊天室的名称、描述、最大成员数等信息。成功创建聊天室后,该超级管理员为该聊天室的所有者。

建议直接调用 REST API [从服务端创建聊天室](/document/server-side/chatroom.html#创建聊天室)

Expand Down
2 changes: 1 addition & 1 deletion docs/document/harmonyos/room_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
- 完成 SDK 初始化,详见 [快速开始](quickstart.html)
- 了解环信即时通讯 IM 的 [使用限制](/product/limitation.html)
- 了解环信即时通讯 IM 不同版本的聊天室相关数量限制,详见 [环信即时通讯 IM 价格](https://www.easemob.com/pricing/im)
- 只有超级管理员才有创建聊天室的权限,因此你还需要确保已调用 RESTful API 添加了超级管理员,详见 [添加聊天室超级管理员](/document/server-side/chatroom.html#添加超级管理员)
- 只有超级管理员才有创建聊天室的权限,因此你还需要确保已调用 RESTful API 添加了超级管理员,详见 [添加聊天室超级管理员](/document/server-side/chatroom_superadmin.html)
- 聊天室创建者和管理员的数量之和不能超过 100,即管理员最多可添加 99 个。

## 实现方法
Expand Down
4 changes: 2 additions & 2 deletions docs/document/ios/room_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
- 完成 SDK 初始化,详见 [快速开始](quickstart.html)
- 了解环信即时通讯 IM 的 [使用限制](/product/limitation.html)
- 了解环信即时通讯 IM 不同版本的聊天室相关数量限制,详见 [环信即时通讯 IM 价格](https://www.easemob.com/pricing/im)
- 只有超级管理员才有创建聊天室的权限,因此你还需要确保已调用 RESTful API 添加了超级管理员,详见 [添加聊天室超级管理员](/document/server-side/chatroom.html#添加超级管理员)
- 只有超级管理员才有创建聊天室的权限,因此你还需要确保已调用 RESTful API 添加了超级管理员,详见 [添加聊天室超级管理员](/document/server-side/chatroom_superadmin.html)
- 聊天室创建者和管理员的数量之和不能超过 100 ,即管理员最多可添加 99 个。

## 实现方法
Expand All @@ -37,7 +37,7 @@

### 创建聊天室

[超级管理员](/document/server-side/chatroom.html#管理超级管理员) 可以调用 `createChatroomWithSubject` 方法创建聊天室,并设置聊天室的名称、描述、最大成员数等信息。成功创建聊天室后,该超级管理员为该聊天室的所有者。
[超级管理员](/document/server-side/chatroom_superadmin.html) 可以调用 `createChatroomWithSubject` 方法创建聊天室,并设置聊天室的名称、描述、最大成员数等信息。成功创建聊天室后,该超级管理员为该聊天室的所有者。

建议直接调用 REST API [从服务端创建聊天室](/document/server-side/chatroom.html#创建聊天室)

Expand Down
4 changes: 2 additions & 2 deletions docs/document/react-native/room_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
- 完成 SDK 初始化,详见 [快速开始](quickstart.html)[SDK 集成概述](overview.html)
- 了解环信即时通讯 IM 的 [使用限制](/product/limitation.html)
- 了解环信即时通讯 IM 不同版本的聊天室相关数量限制,详见 [环信即时通讯 IM 价格](https://www.easemob.com/pricing/im)
- 只有超级管理员才有创建聊天室的权限,因此你还需要确保已调用 RESTful API 添加了超级管理员,详见 [添加聊天室超级管理员](/document/server-side/chatroom.html#添加超级管理员)
- 只有超级管理员才有创建聊天室的权限,因此你还需要确保已调用 RESTful API 添加了超级管理员,详见 [添加聊天室超级管理员](/document/server-side/chatroom_superadmin.html)
- 聊天室创建者和管理员的数量之和不能超过 100,即管理员最多可添加 99 个。

## 实现方法
Expand All @@ -36,7 +36,7 @@

### 创建聊天室

[超级管理员](/document/server-side/chatroom.html#管理超级管理员) 可以调用 `createChatRoom` 方法创建聊天室,并设置聊天室的名称、描述、最大成员数等信息。成功创建聊天室后,该超级管理员为该聊天室的所有者。
[超级管理员](/document/server-side/chatroom_superadmin.html) 可以调用 `createChatRoom` 方法创建聊天室,并设置聊天室的名称、描述、最大成员数等信息。成功创建聊天室后,该超级管理员为该聊天室的所有者。

建议直接调用 REST API [从服务端创建聊天室](/document/server-side/chatroom.html#创建聊天室)

Expand Down
2 changes: 1 addition & 1 deletion docs/document/server-side/account_system.md
Original file line number Diff line number Diff line change
Expand Up @@ -753,7 +753,7 @@ curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppT

删除某个 App 下指定数量的用户账号。建议一次删除的用户数量不要超过 100。

需要注意的是,这里只指定了要删除的用户数量,并未指定要删除的具体用户,你可以在响应中查看删除的用户。如果删除的多个用户中包含群组或者聊天室的管理员,该用户管理的群组和聊天室也会相应删除。若删除了群主或聊天室所有者,对应的群组或聊天室会解散。
需要注意的是,这里只指定了要删除的用户数量,并未指定要删除的具体用户,你可以在响应中查看删除的用户。如果删除的多个用户中包含群主或聊天室所有者,对应的群组或聊天室会解散。

:::tip
该 API 用于删除你在集成了即时通讯 IM 后上线前的测试阶段创建的用户。
Expand Down
2 changes: 1 addition & 1 deletion docs/document/server-side/chatroom_superadmin.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 聊天室管理
# 管理聊天室超级管理员

<Toc />

Expand Down
4 changes: 2 additions & 2 deletions docs/document/unity/room_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
- 完成 SDK 初始化,详见 [快速开始](quickstart.html)
- 了解环信即时通讯 IM 的 [使用限制](/product/limitation.html)
- 了解环信即时通讯 IM 不同版本的聊天室相关数量限制,详见 [环信即时通讯 IM 价格](https://www.easemob.com/pricing/im)
- 只有超级管理员才有创建聊天室的权限,因此你还需要确保已调用 RESTful API 添加了超级管理员,详见 [添加聊天室超级管理员](/document/server-side/chatroom.html#添加超级管理员)
- 只有超级管理员才有创建聊天室的权限,因此你还需要确保已调用 RESTful API 添加了超级管理员,详见 [添加聊天室超级管理员](/document/server-side/chatroom_superadmin.html)
- 聊天室创建者和管理员的数量之和不能超过 100,即管理员最多可添加 99 个。

## 实现方法
Expand All @@ -37,7 +37,7 @@

### 创建聊天室

[超级管理员](/document/server-side/chatroom.html#管理超级管理员) 可以调用 `CreateRoom` 方法创建聊天室,并设置聊天室的名称、描述、最大成员数等信息。成功创建聊天室后,该超级管理员为该聊天室的所有者。
[超级管理员](/document/server-side/chatroom_superadmin.html) 可以调用 `CreateRoom` 方法创建聊天室,并设置聊天室的名称、描述、最大成员数等信息。成功创建聊天室后,该超级管理员为该聊天室的所有者。

建议直接调用 REST API [从服务端创建聊天室](/document/server-side/chatroom.html#创建聊天室)

Expand Down
2 changes: 1 addition & 1 deletion docs/document/web/error.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ error.type === statusCode.WEBIM_CONNCTION_USER_NOT_ASSIGN_ERROR 其中 `error`
| 200 | WEBIM_DOWNLOADFILE_ERROR | 下载文件失败:如超时、网络错误。 |
| 204 | USER_NOT_FOUND | 用户不存在,如创建群拉人时不存在的用户报错。 |
| 205 | MESSAGE_PARAMETER_ERROR | 消息参数错误。如撤回消息时未传消息 ID 或者发送消息时未传消息接收方的用户 ID。|
| 206 | WEBIM_CONNCTION_USER_LOGIN_ANOTHER_DEVICE | 用户在其他设备登录:如果没有开启多设备登录,则在其他设备登录会将当前登录的设备踢下线,用户会收到此错误。 |
| 206 | WEBIM_CONNCTION_USER_LOGIN_ANOTHER_DEVICE | 用户在其他设备登录:如果没有开启多设备登录,则在其他设备登录会将当前登录的设备踢下线,用户会收到此错误。若开启了多设备登录并配置了支持的设备数量,设备间的互踢策略与 `ConnectionParameters#isFixedDeviceId` 参数有关,详见[多设备文档](multi_device.html) |
| 207 | WEBIM_CONNCTION_USER_REMOVED | 用户已经被注销:如果登录用户的 ID 被管理员从管理后台删除则会收到此错误。 |
| 208 | WEBIM_USER_ALREADY_LOGIN | 用户已登录。单设备登录时,若调用 open 方法用户已经登录,会提示该错误。 |
| 216 | WEBIM_CONNCTION_USER_KICKED_BY_CHANGE_PASSWORD | 用户密码更新:当前登录的用户密码被修改后,当前登录会断开并提示该错误。 |
Expand Down
2 changes: 1 addition & 1 deletion docs/document/web/multi_device.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

| 单端登录 | 多端登录 |其他说明 |
| :--------- | :----- | :------- |
| 新登录的设备会将当前在线设备踢下线。 | 若一端的登录设备数量达到了上限,最新登录的设备会将该端最早登录的设备踢下线。即时通讯 IM 仅支持同端互踢,不支持各端之间互踢。<br/>多端登录时,是否使用固定的设备 ID 对设备互踢策略存在影响:SDK 会为设备生成设备 ID,作为设备的唯一标识。之前,每个 SDK 实例连接时,SDK 均使用不同的随机字符串作为设备标识。自从 4.8.0 版本开始,Web SDK 新增了 `ConnectionParameters#isFixedDeviceId` 参数,你可以在 SDK 初始化时设置使用随机的设备 ID 或固定设备 ID:<br/>- (默认)`true`:使用固定的设备 ID。设备标识存入本地存储,即对一个浏览器来说,所有 SDK 实例的连接都被认为是同一设备。<br/>- `false`:使用随机设备 ID。每个 SDK 实例采用的不同的设备连接。 | 环信服务器提供 RESTful 接口[查询每个账号已登录设备列表](/document/server-side/account_system.html#获取指定账号的在线登录设备列表)、[将账号从已登录设备强制下线](/document/server-side/account_system.html#强制用户下线)和将指定账号强制[从单个设备下线](/document/server-side/account_system.html#强制用户从单设备下线)。 |
| 新登录的设备会将当前在线设备踢下线。 | 若一端的登录设备数量达到了上限,最新登录的设备会将该端最早登录的设备踢下线。即时通讯 IM 仅支持同端互踢,不支持各端之间互踢。<br/>多端登录时,是否使用固定的设备 ID 对设备互踢策略存在影响:SDK 会为设备生成设备 ID,作为设备的唯一标识。之前,每个 SDK 实例连接时,SDK 均使用不同的随机字符串作为设备标识。自从 4.8.0 版本开始,Web SDK 新增了 `ConnectionParameters#isFixedDeviceId` 参数,你可以在 SDK 初始化时设置使用随机的设备 ID 或固定设备 ID:<br/>- (默认)`true`:使用固定的设备 ID。设备标识存入本地存储,即使在多设备登录情况下,同一浏览器只能打开一个页签,若打开两个,新页签会将上一个踢掉。<br/>- `false`:使用随机设备 ID。每个页签采用不同的设备 ID。多设备登录情况下,同一浏览器可打开多个页签,若超过允许的设备数量,则新页签会将最先打开的页签踢掉。 | 环信服务器提供 RESTful 接口[查询每个账号已登录设备列表](/document/server-side/account_system.html#获取指定账号的在线登录设备列表)、[将账号从已登录设备强制下线](/document/server-side/account_system.html#强制用户下线)和将指定账号强制[从单个设备下线](/document/server-side/account_system.html#强制用户从单设备下线)。 |

## 技术原理

Expand Down
4 changes: 2 additions & 2 deletions docs/document/web/room_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
- 完成 SDK 初始化,详见 [快速开始](quickstart.html)
- 了解环信即时通讯 IM 的 API 使用限制,详见 [使用限制](/product/limitation)
- 了解环信即时通讯 IM 聊天室不同版本的数量限制,详见 [环信即时通讯 IM 价格](https://www.easemob.com/pricing/im)
-[超级管理员](/document/server-side/chatroom.html#管理超级管理员) 可以创建聊天室;
-[超级管理员](/document/server-side/chatroom_superadmin.html) 可以创建聊天室;
- 聊天室创建者和管理员的数量之和不能超过 100 ,即管理员最多可添加 99 个。

## 实现方法
Expand All @@ -37,7 +37,7 @@

### 创建聊天室

[超级管理员](/document/server-side/chatroom.html#管理超级管理员) 可以调用 `createChatRoom` 方法创建聊天室,并设置聊天室的名称、描述、最大成员数等信息。成功创建聊天室后,该超级管理员为该聊天室的所有者。
[超级管理员](/document/server-side/chatroom_superadmin.html) 可以调用 `createChatRoom` 方法创建聊天室,并设置聊天室的名称、描述、最大成员数等信息。成功创建聊天室后,该超级管理员为该聊天室的所有者。

建议直接调用 REST API [从服务端创建聊天室](/document/server-side/chatroom.html#创建聊天室)

Expand Down
2 changes: 1 addition & 1 deletion docs/document/web/room_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@

| 功能 | 描述 |
| :------------- | :----------------------------------------------------------- |
| 创建聊天室 | 只有被赋予 [超级管理员](/document/server-side/chatroom.html#管理超级管理员) 权限的用户有权限创建聊天室。聊天室成员数会受到版本指定聊天室最大成员数的限制。 |
| 创建聊天室 | 只有被赋予 [超级管理员](/document/server-side/chatroom_superadmin.html) 权限的用户有权限创建聊天室。聊天室成员数会受到版本指定聊天室最大成员数的限制。 |
| 加入聊天室 | 没有被加入黑名单的所有 app 用户可自由加入聊天室。 |
| 离开聊天室 | 所有聊天室成员都可以自由退出聊天室;也可能被动离开聊天室,原因分为:被管理员移出聊天室、聊天室解散和用户账号离线。 |
| 解散聊天室 | 需要聊天室所有者权限。 |
Expand Down
4 changes: 2 additions & 2 deletions docs/document/windows/room_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
- 完成 SDK 初始化,详见 [快速开始](quickstart.html)
- 了解环信即时通讯 IM 的 [使用限制](/product/limitation.html)
- 了解环信即时通讯 IM 不同版本的聊天室相关数量限制,详见 [环信即时通讯 IM 价格](https://www.easemob.com/pricing/im)
- 只有超级管理员才有创建聊天室的权限,因此你还需要确保已调用 RESTful API 添加了超级管理员,详见 [添加聊天室超级管理员](/document/server-side/chatroom.html#添加超级管理员)
- 只有超级管理员才有创建聊天室的权限,因此你还需要确保已调用 RESTful API 添加了超级管理员,详见 [添加聊天室超级管理员](/document/server-side/chatroom_superadmin.html)
- 聊天室创建者和管理员的数量之和不能超过 100,即管理员最多可添加 99 个。

## 实现方法
Expand All @@ -37,7 +37,7 @@

### 创建聊天室

[超级管理员](/document/server-side/chatroom.html#管理超级管理员) 可以调用 `CreateRoom` 方法创建聊天室,并设置聊天室的名称、描述、最大成员数等信息。成功创建聊天室后,该超级管理员为该聊天室的所有者。
[超级管理员](/document/server-side/chatroom_superadmin.html) 可以调用 `CreateRoom` 方法创建聊天室,并设置聊天室的名称、描述、最大成员数等信息。成功创建聊天室后,该超级管理员为该聊天室的所有者。

建议直接调用 REST API [从服务端创建聊天室](/document/server-side/chatroom.html#创建聊天室)

Expand Down
Loading

0 comments on commit 1a5b805

Please sign in to comment.