Skip to content

Commit

Permalink
Merge pull request #1052 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history
Modify IM Docs
  • Loading branch information
haoxiuwen authored Nov 22, 2024
2 parents 25c0938 + 82a60c4 commit 8fa1e5f
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/document/android/push/push_display.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ EMPushManager.DisplayStyle style = pushConfigs.getDisplayStyle();
:::tip
1. 设置推送模板为推送的高级功能,使用前需要在[环信即时通讯控制台](https://console.easemob.com/user/login)**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务,因为该操作会删除所有相关配置。

2. 推送模板相关的数据结构,详见[推送扩展字段](/document/server-side/push_extension.html)
2. 推送模板相关的数据结构,详见[推送扩展字段](https://doc.easemob.com/document/server-side/push_extension.html)
:::

### 发消息时使用推送模板
Expand Down
2 changes: 1 addition & 1 deletion docs/document/android/push/push_extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

你可以利用扩展字段实现自定义推送设置,本文以强制推送和发送静默消息为例介绍如何实现推送扩展功能。

对于推送扩展字段,详见[离线推送扩展字段文档](/document/server-side/push_extension.html)
对于推送扩展字段,详见[离线推送扩展字段文档](https://doc.easemob.com/document/server-side/push_extension.html)

## 设置自定义推送字段

Expand Down
22 changes: 18 additions & 4 deletions docs/document/flutter/group_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,9 @@ try {

1. 调用 `EMGroupManager#fetchPublicGroupsFromServer` 方法从服务器获取公开群列表,查询到想要加入的群组 ID。
2. 根据加群是否需要验证,调用不同的方法:

- 若无需验证,调用 `EMGroupManager#joinPublicGroup` 方法传入群组 ID,申请加入对应群组。
- 若需要验证,调用 `requestToJoinPublicGroup` 方法传入群组 ID,申请加入对应群组。

示例代码如下:


```dart
// 获取公开群组列表
try {
Expand All @@ -127,6 +125,22 @@ try {
}
```

若需要验证,调用 `requestToJoinPublicGroup` 方法传入群组 ID,申请加入对应群组。

```dart
// 获取公开群组列表
try {
EMCursorResult<EMGroupInfo> result =
await EMClient.getInstance.groupManager.fetchPublicGroupsFromServer();
} on EMError catch (e) {
}
// 申请加入群组
try {
await EMClient.getInstance.groupManager.requestToJoinPublicGroup('groupId');
} on EMError catch (e) {}
```

### 退出群组

群成员可以调用 `LeaveGroup` 方法退出群组,其他成员收到 `EMGroupEventHandler#onMemberExitedFromGroup` 事件。退出群组后,该用户将不再收到群消息。群主不能调用该接口退出群组,只能调用 [`DestroyGroup`](#解散群组) 解散群组。
Expand Down
6 changes: 3 additions & 3 deletions docs/document/flutter/presence.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
- `publishPresence`:发布自定义在线状态;
- `subscribe`:订阅用户的在线状态;
- `onPresenceStatusChanged` 被订阅用户的在线状态变更时,订阅者收到监听回调;
- `unSubscribe`:无需关注用户的在线状态时,取消订阅;
- `unsubscribe`:无需关注用户的在线状态时,取消订阅;
- `fetchSubscribedMembers` 获取订阅列表;
- `fetchPresenceStatus` 获取指定用户状态;

Expand Down Expand Up @@ -105,12 +105,12 @@ try {

### 取消订阅指定用户的在线状态

若取消指定用户的在线状态订阅,可调用 `EMPresenceManager#unSubscribe` 方法,示例代码如下:
若取消指定用户的在线状态订阅,可调用 `EMPresenceManager#unsubscribe` 方法,示例代码如下:

```dart
// members: 将要取消订阅的用户列表
try {
await EMClient.getInstance.presenceManager.unSubscribe(
await EMClient.getInstance.presenceManager.unsubscribe(
members: members,
);
} on EMError catch (e) {
Expand Down
2 changes: 1 addition & 1 deletion docs/document/harmonyos/push/push_display.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ ChatClient.getInstance().pushManager()?.updatePushDisplayStyle(displayStyle).the
:::tip
1. 设置推送模板为推送的高级功能,使用前需要在[环信即时通讯控制台](https://console.easemob.com/user/login)**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务,因为该操作会删除所有相关配置。

2. 推送模板相关的数据结构,详见[推送扩展字段](/document/server-side/push_extension.html)
2. 推送模板相关的数据结构,详见[推送扩展字段](https://doc.easemob.com/document/server-side/push_extension.html)
:::

#### **发送消息时使用推送模板**
Expand Down
2 changes: 1 addition & 1 deletion docs/document/ios/push/push_display.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
:::tip
1. 设置推送模板为推送的高级功能,使用前需要在[环信即时通讯控制台](https://console.easemob.com/user/login)的**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务,因为该操作会删除所有相关配置。
2. 推送模板相关的数据结构,详见[推送扩展字段](/document/server-side/push_extension.html)。
2. 推送模板相关的数据结构,详见[推送扩展字段](https://doc.easemob.com/document/server-side/push_extension.html)。
:::
### 发送消息时使用推送模板
Expand Down
2 changes: 1 addition & 1 deletion docs/document/ios/push/push_extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

你可以利用扩展字段实现自定义推送设置,本文以强制推送、发送静默消息和富文本推送为例介绍如何实现推送扩展功能。

对于推送扩展字段,详见[离线推送扩展字段文档](/document/server-side/push_extension.html)
对于推送扩展字段,详见[离线推送扩展字段文档](https://doc.easemob.com/document/server-side/push_extension.html)

## 自定义推送字段

Expand Down
2 changes: 1 addition & 1 deletion docs/document/react-native/push/push_display.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ ChatClient.getInstance()
:::tip
1. 设置推送模板为推送的高级功能,使用前需要在[环信即时通讯控制台](https://console.easemob.com/user/login)**即时通讯 > 功能配置 > 功能配置总览**页面激活推送高级功能。如需关闭推送高级功能必须联系商务,因为该操作会删除所有相关配置。

2. 推送模板相关的数据结构,详见[推送扩展字段](/document/server-side/push_extension.html)
2. 推送模板相关的数据结构,详见[推送扩展字段](https://doc.easemob.com/document/server-side/push_extension.html)
:::

### 发消息时使用推送模板
Expand Down
2 changes: 1 addition & 1 deletion docs/document/react-native/push/push_extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

你可以利用扩展字段实现自定义推送设置,本文以强制推送和发送静默消息为例介绍如何实现推送扩展功能。

对于推送扩展字段,详见[离线推送扩展字段文档](/document/server-side/push_extension.html)
对于推送扩展字段,详见[离线推送扩展字段文档](https://doc.easemob.com/document/server-side/push_extension.html)

## 设置自定义推送字段

Expand Down

0 comments on commit 8fa1e5f

Please sign in to comment.