Skip to content

Commit

Permalink
Merge pull request #1053 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history
Modify IM Doc
  • Loading branch information
haoxiuwen authored Nov 25, 2024
2 parents 8fa1e5f + 458d419 commit de9a07f
Show file tree
Hide file tree
Showing 10 changed files with 11 additions and 11 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. 推送模板相关的数据结构,详见[推送扩展字段](https://doc.easemob.com/document/server-side/push_extension.html)
2. 推送模板相关的数据结构,详见[推送扩展字段](/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 @@

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

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

## 设置自定义推送字段

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

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

对于推送扩展字段,详见[离线推送扩展字段文档](https://doc.easemob.com/document/server-side/push_extension.html)
对于推送扩展字段,详见[离线推送扩展字段文档](/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. 推送模板相关的数据结构,详见[推送扩展字段](https://doc.easemob.com/document/server-side/push_extension.html)
2. 推送模板相关的数据结构,详见[推送扩展字段](/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 @@

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

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

## 设置自定义推送字段

Expand Down
1 change: 1 addition & 0 deletions docs/document/server-side/group_file.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -
| HTTP 状态码 | 错误类型 | 错误提示 | 可能原因 | 处理建议 |
| :----------- | :--- | :------------- | :----------- | :----------- |
| 400 | illegal_argument | announcement is null | 没有传递公告内容。 | 需传递公告内容。 |
| 403 | group_announce_violation | group announcement is violation, please change it. | 群公告不合法。 | 使用合法的群公告。 |
| 401 | unauthorized | Unable to authenticate (OAuth) | token 不合法,可能过期或 token 错误。 | 使用新的 token 访问。 |
| 404 | resource_not_found | grpID XX does not exist! | 群组不存在。 | 使用合法的群 ID。 |
| 403 | FORBIDDEN | announce info length exceeds limit! | 设置公告长度超限制。 | 设置较短的公告 |
Expand Down
1 change: 0 additions & 1 deletion docs/document/server-side/group_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,6 @@ curl -X PUT -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToke
| :----------- | :--- | :------------- | :----------- | :----------- |
| 401 | unauthorized | Unable to authenticate (OAuth) | token 不合法,可能过期或 token 错误。 | 使用新的 token 访问。 |
| 403 | group_name_violation | XX is violation, please change it. | 群组名称不合法。 | 使用合法的群组名称。 |
| 403 | group_announce_violation | group announcement is violation, please change it. | 群公告不合法。 | 使用合法的群公告。 |
| 404 | resource_not_found | grpID XX does not exist! | 群组不存在。 | 使用合法的群 ID。 |
| 400 | invalid_parameter | "some of [groupid] are not valid fields" | 修改的群组信息时,传入的参数不支持,例如修改 `groupid`|

Expand Down
6 changes: 3 additions & 3 deletions docs/document/server-side/push_extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@

| 字段 | 类型 | 作用 |
| -------------- | ------------- | ---------------- |
| `target` | Array<String> | 用户 ID 列表,传入的用户 ID 必须为全部小写,否则不生效。 |
| `target` | `Array<String>` | 用户 ID 列表,传入的用户 ID 必须为全部小写,否则不生效。 |
| `name` | String | 推送模板名称。 |
| `title_args` | Array<String> | 推送模板标题。 |
| `content_args` | Array<String> | 推送模板内容。 |
| `title_args` | `Array<String>` | 推送模板标题。 |
| `content_args` | `Array<String>` | 推送模板内容。 |

关于如何使用定向模板,详见[使用示例](#使用定向模板)

Expand Down

0 comments on commit de9a07f

Please sign in to comment.