Skip to content

Commit

Permalink
Merge pull request #509 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history
Modify EMOptions for Chat Room Leaving Attribute
  • Loading branch information
haoxiuwen authored Nov 20, 2023
2 parents 822d7eb + 2283ff5 commit 216d987
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/document/android/room_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ EMOptions options = new EMOptions();
options.setDeleteMessagesAsExitChatRoom(false);
```

与群主无法退出群组不同,聊天室所有者可以离开聊天室,例如,所有者从服务器下线则 2 分钟后自动离开聊天室。如果所有者重新进入聊天室仍是该聊天室的所有者。`EMOptions#allowChatroomOwnerLeave` 参数在初始化时设置为 `false`,聊天室所有者调用 `leaveChatRoom` 方法离开聊天室时会提示错误 706 `CHATROOM_OWNER_NOT_ALLOW_LEAVE`
与群主无法退出群组不同,聊天室所有者可以离开聊天室,重新进入聊天室仍是该聊天室的所有者。`EMOptions#allowChatroomOwnerLeave` 参数在初始化时设置为 `true` 时,聊天室所有者可以离开聊天室;若该参数设置为 `false`,聊天室所有者调用 `leaveChatRoom` 方法离开聊天室时会提示错误 706 `CHATROOM_OWNER_NOT_ALLOW_LEAVE`

### 解散聊天室

Expand Down
3 changes: 2 additions & 1 deletion docs/document/flutter/room_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,8 @@ EMOptions options = EMOptions(
);
```

与群主无法退出群组不同,聊天室所有者可以离开聊天室,例如所有者从服务器下线则 2 分钟后自动离开聊天室。如果所有者重新进入聊天室仍是该聊天室的所有者。
与群主无法退出群组不同,聊天室所有者可以离开聊天室,离开后重新进入仍是该聊天室的所有者。若 `ChatOptions#isChatRoomOwnerLeaveAllowed
` 参数在初始化时设置为 `true` 时,聊天室所有者可以离开聊天室;若该参数设置为 `false`,聊天室所有者调用 `leaveChatRoom` 方法离开聊天室时会提示错误 706。

### 解散聊天室

Expand Down
2 changes: 1 addition & 1 deletion docs/document/ios/room_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ EMOptions *retOpt = [EMOptions optionsWithAppkey:@"appkey"];
retOpt.isDeleteMessagesWhenExitChatRoom = NO;
```
与群主无法退出群组不同,聊天室所有者可以离开聊天室,例如所有者从服务器下线则 2 分钟后自动离开聊天室。如果所有者重新进入聊天室仍是该聊天室的所有者。若 `EMOptions#canChatroomOwnerLeave` 参数在初始化时设置为 `false`,聊天室所有者调用 `leaveChatroom` 方法离开聊天室时会提示错误 706 `EMErrorChatroomOwnerNotAllowLeave`。
与群主无法退出群组不同,聊天室所有者可以离开聊天室,重新进入聊天室仍是该聊天室的所有者。若 `EMOptions#canChatroomOwnerLeave` 参数在初始化时设置为 `YES` 时,聊天室所有者可以离开聊天室;若该参数设置为 `NO`,聊天室所有者调用 `leaveChatroom` 方法离开聊天室时会提示错误 706 `EMErrorChatroomOwnerNotAllowLeave`。
### 解散聊天室
Expand Down
3 changes: 2 additions & 1 deletion docs/document/react-native/room_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,8 @@ ChatOptions options = new ChatOptions();
options.deleteMessagesAsExitChatRoom = false;
```

与群主无法退出群组不同,聊天室所有者可以离开聊天室,例如所有者从服务器下线则 2 分钟后自动离开聊天室。如果所有者重新进入聊天室仍是该聊天室的所有者。
与群主无法退出群组不同,聊天室所有者可以离开聊天室,离开后重新进入仍是该聊天室的所有者。若 `ChatOptions#isChatRoomOwnerLeaveAllowed
` 参数在初始化时设置为 `true` 时,聊天室所有者可以离开聊天室;若该参数设置为 `false`,聊天室所有者调用 `leaveChatRoom` 方法离开聊天室时会提示错误 706。

### 解散聊天室

Expand Down
3 changes: 2 additions & 1 deletion docs/document/unity/room_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,8 @@ Options options = new Options();
options. DeleteMessagesAsExitRoom = false;
```

与群主无法退出群组不同,聊天室所有者可以离开聊天室,例如所有者从服务器下线则 2 分钟后自动离开聊天室。如果所有者重新进入聊天室仍是该聊天室的所有者。
与群主无法退出群组不同,聊天室所有者可以离开聊天室,离开后重新进入聊天室仍是该聊天室的所有者。若 `Options#IsRoomOwnerLeaveAllowed
` 参数在初始化时设置为 `true` 时,聊天室所有者可以离开聊天室;若该参数设置为 `false`,聊天室所有者调用 `LeaveRoom` 方法离开聊天室时会提示错误 706。

### 解散聊天室

Expand Down
2 changes: 1 addition & 1 deletion docs/document/web/room_members.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ conn.listChatRoomMembers(option).then(res => console.log(res))

#### 成员主动退出聊天室

聊天室所有成员均可以调用 `leaveChatRoom` 退出当前聊天室。成员退出聊天室时,其他成员收到 `memberAbsence` 事件。与群主无法退出群组不同,聊天室所有者可以离开聊天室,如果所有者从服务器下线则 2 分钟后自动离开聊天室。如果所有者重新进入聊天室仍是该聊天室的所有者
聊天室所有成员均可以调用 `leaveChatRoom` 退出当前聊天室。成员退出聊天室时,其他成员收到 `memberAbsence` 事件。与群主无法退出群组不同,聊天室所有者可以离开聊天室,退出后重新进入仍是该聊天室的所有者

示例代码如下:

Expand Down
3 changes: 2 additions & 1 deletion docs/document/windows/room_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,8 @@ Options options = new Options();
options. DeleteMessagesAsExitRoom = false;
```

与群主无法退出群组不同,聊天室所有者可以离开聊天室,例如所有者从服务器下线则 2 分钟后自动离开聊天室。如果所有者重新进入聊天室仍是该聊天室的所有者。
与群主无法退出群组不同,聊天室所有者可以离开聊天室,离开后重新进入仍是该聊天室的所有者。若 `Options#IsRoomOwnerLeaveAllowed
` 参数在初始化时设置为 `true` 时,聊天室所有者可以离开聊天室;若该参数设置为 `false`,聊天室所有者调用 `LeaveRoom` 方法离开聊天室时会提示错误 706。

### 解散聊天室

Expand Down
4 changes: 2 additions & 2 deletions docs/push/push_notification_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
| `content` | String | 通知栏展示的通知内容。默认为“请及时查看”。该字段长度不能超过 100 个字符(一个汉字相当于两个字符)。 | iOS & Android ||
| `ext` | Object | 推送自定义扩展信息,为自定义 key-value 键值对。键值对个数不能超过 10 且长度不能超过 1024 个字符。 | iOS & Android ||
| `config` | Object | 与用户点击通知相关的操作。以及角标的配置,包含 `clickAction``badge` 字段。 | iOS & Android ||
| `config.clickAction` | Object | 在通知栏中点击触发的动作,均为字符串类型:<br/> - `url`:打开自定义的 URL;<br/> - `action`:打开应用的指定页面;<br/> - `activity`:打开应用包名或 Activity 组件路径。若不传该字段,默认打开应用的首页。 | Android ||
| `config.clickAction` | Object | 在通知栏中点击触发的动作,均为字符串类型:<br/> - `url`:打开自定义的 URL;<br/> - `action`:打开应用的指定页面;<br/> - `activity`:打开应用包名或 Activity 组件路径。若不传该字段,默认打开应用的首页。<br/><Container type="notice" title="注意">环信 iOS 推送通道只支持设置为 `url`。</Container> | Android ||
| `config.badge` | Object | 推送角标,包含以下三个字段:<br/> - `addNum`:整型,表示推送通知到达设备时,角标数字累加的值。<br/> - `setNum`:整型,表示推送通知到达设备时,角标数字显示的值。<br/> - `activity`:字符串类型,入口类(华为角标需要配置)。 | Android ||

## 各厂商推送配置
Expand Down Expand Up @@ -108,7 +108,7 @@
| `needNotification` | boolean | 是否弹出通知:<br/> - (默认)`true`:通知消息;<br/> - `false`:透传消息。 | iOS & Android |
| `badge` | Object | 推送角标。详见 [基本推送配置](#基本推送配置)中的角标说明。 | iOS & Android |
| `operation` | Object | 在通知栏中点击触发的动作。 | iOS & Android |
| `operation.type` | Int | 在通知栏中点击触发的动作类型。<br/> - (默认)`0`:启动应用。<br/> - `1`:打开自定义的 URL。需设置 `openUrl` 字段为自定义的 URL,若不设置,点击无效果。<br/> - `2`:打开应用的指定页面。需设置 `openAction` 为打开的应用页面的地址。若不设置,点击无效果。 | iOS & Android |
| `operation.type` | Int | 在通知栏中点击触发的动作类型。<br/> - (默认)`0`:启动应用。<br/> - `1`:打开自定义的 URL。需设置 `openUrl` 字段为自定义的 URL,若不设置,点击无效果。<br/> - `2`:打开应用的指定页面。需设置 `openAction` 为打开的应用页面的地址。若不设置,点击无效果。 <br/><Container type="notice" title="注意">环信 iOS 推送通道只支持启动应用和打开自定义 URL,因此只能设置为 `0``1`。</Container>| iOS & Android |
| `channelId` | String | 通知渠道 ID,默认为 `chat`。客户端渠道存在则通知。若客户端渠道不存在,则结合 channelName,channelLevel 创建新通道。 | Android |
| `channelName` | String | 通知渠道名称,默认为 `消息`。只有第一次创建通道时使用。 | Android |
| `channelLevel` | Int | 通知级别,只有第一次创建通道时使用。<br/> - `0`:最低;<br/> - `3`:默认;<br/> - `4`:高。 | Android |
Expand Down

0 comments on commit 216d987

Please sign in to comment.