Skip to content

Commit a7e736f

Browse files
authored
Merge pull request #30 from haoxiuwen/doc-shengwang
Modify REST API Function Activation and Flutter API Reference
2 parents 68e6019 + d67a9b1 commit a7e736f

File tree

10 files changed

+285
-289
lines changed

10 files changed

+285
-289
lines changed
-86.4 KB
Binary file not shown.

docs/.vuepress/sidebar/document.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,9 +116,9 @@ const documentSidebar = [
116116
{ text: '更新消息', link: 'message_update.html', except: ['web']},
117117
{ text: '删除消息', link: 'message_delete.html' },
118118
{ text: '置顶消息', link: 'message_pin.html'},
119-
{ text: '翻译消息', link: 'message_translation.html', except: ['harmonyos']},
119+
// { text: '翻译消息', link: 'message_translation.html', except: ['harmonyos']},
120120
{ text: '只投在线用户', link: 'message_deliver_only_online.html'},
121-
{ text: '消息审核(举报)', link: 'moderation.html', except: ['harmonyos']},
121+
// { text: '消息审核(举报)', link: 'moderation.html', except: ['harmonyos']},
122122
{ text: '获取消息流量统计', link: 'message_traffic_statis.html', only: ['android', 'ios'] },
123123
]
124124
},
@@ -275,7 +275,7 @@ const documentSidebar = [
275275
{ text: '修改消息', link: 'message_modify.html' },
276276
{ text: '删除消息', link: 'message_delete.html' },
277277
{ text: '置顶消息', link: 'message_pin.html' },
278-
{ text: '翻译消息', link: 'message_translation.html' },
278+
// { text: '翻译消息', link: 'message_translation.html' },
279279
{ text: '只投在线用户', link: 'message_deliver_only_online.html'},
280280
{ text: '消息审核(举报)', link: 'moderation.html'},
281281
]

docs/document/android/presence.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22

33
<Toc />
44

5-
用户在线状态(即 Presence)包含用户的在线、离线以及自定义状态。
5+
用户在线状态(即 Presence)包含用户的在线、离线以及自定义状态。**若你当前套餐不支持该功能,需升级产品套餐。**
66

7-
本文介绍如何在即时通讯应用中发布、订阅和查询用户的在线状态。
8-
9-
关于用户的在线、离线和自定义状态的定义、变更以及用户的实时感知,详见[用户在线状态管理](/product/product_user_presence.html)
7+
本文介绍如何在即时通讯应用中发布、订阅和查询用户的在线状态。关于用户的在线、离线和自定义状态的定义、变更以及用户的实时感知,详见[用户在线状态管理](/product/product_user_presence.html)
108

119
## 技术原理
1210

docs/document/flutter/api_reference_overview.md

Lines changed: 267 additions & 267 deletions
Large diffs are not rendered by default.

docs/document/server-side/chatroom_label_mute.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
要调用声网即时通讯 RESTful API,请确保满足以下要求:
1010

11-
- 已在[声网控制台](https://console.shengwang.cn/overview) [开通配置声网即时通讯 IM 服务](enable_im.html)
11+
- 已联系声网商务开通该功能
1212
- 已从服务端获取 app token,详见 [使用 Token 鉴权](token_authentication.html)
1313
- 了解声网即时通讯 IM API 的调用频率限制,详见 [接口频率限制](limitationapi.html)
1414
- 了解聊天室成员相关限制,详见[使用限制](limitation.html#聊天室成员)

docs/document/server-side/group_thread.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# 子区管理
22

3-
即时通讯 IM 提供多个接口实现子区管理,包括子区的创建、获取、修改和删除等。
3+
即时通讯 IM 提供多个接口实现子区管理,包括子区的创建、获取、修改和删除等。**若你当前套餐不支持该功能,需升级产品套餐。**
44

55
单个 app 下的子区总数默认为 10 万,如需调整请联系声网商务。
66

77
## 前提条件
88

99
要调用声网即时通讯 RESTful API,请确保满足以下要求:
1010

11-
- 已在[声网控制台](https://console.shengwang.cn/overview) [开通配置即时通讯 IM 服务](enable_im.html)
11+
- 产品套餐包支持子区功能
1212
- 已从服务端获取 app token,详见 [使用 Token 鉴权](token_authentication.html)
1313
- 了解即时通讯 IM API 的调用频率限制,详见 [接口频率限制](limitationapi.html)
1414

docs/document/server-side/presence.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@
22

33
<Toc />
44

5-
在线状态(Presence)表示用户的当前状态信息。除了声网即时通讯 IM 内置的在线和离线状态,你还可以添加自定义在线状态,例如忙碌、马上回来、离开、接听电话、外出就餐等。本文展示如何调用声网即时通讯 RESTful API 实现用户在线状态(Presence)订阅,包括设置用户在线状态信息、批量订阅和获取在线状态、取消订阅以及查询订阅列表。
5+
在线状态(Presence)表示用户的当前状态信息。除了声网即时通讯 IM 内置的在线和离线状态,你还可以添加自定义在线状态,例如忙碌、马上回来、离开、接听电话、外出就餐等。**若你当前套餐不支持该功能,需升级产品套餐。**
66

7-
关于用户的在线、离线和自定义状态的定义,详见[用户在线状态管理](/product/product_user_presence.html)
7+
本文展示如何调用声网即时通讯 RESTful API 实现用户在线状态(Presence)订阅,包括设置用户在线状态信息、批量订阅和获取在线状态、取消订阅以及查询订阅列表
88

9-
:::tip
10-
使用该特性前,你需要联系商务开通。
11-
:::
9+
关于用户的在线、离线和自定义状态的定义,详见[用户在线状态管理](product_user_presence.html)
1210

1311
## 公共参数
1412

@@ -26,7 +24,7 @@
2624

2725
要调用声网即时通讯 RESTful API,请确保满足以下要求:
2826

29-
- 已在[声网控制台](https://console.shengwang.cn/overview) [开通配置声网即时通讯 IM 服务](enable_im.html)
27+
- 产品套餐包支持 Presence 功能
3028
- 已从服务端获取 app token,详见 [使用 Token 鉴权](token_authentication.html)
3129
- 了解声网即时通讯 IM API 的调用频率限制,详见 [接口频率限制](limitationapi.html)
3230

docs/document/server-side/push_result_statistics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 查询离线推送结果统计数据
22

3-
要查询离线推送结果,你需要联系声网商务开通该功能。该功能开通后,声网离线推送服务会产生推送结果消息。
3+
要查询离线推送结果,**你需要联系声网商务开通该功能**。该功能开通后,声网离线推送服务会产生推送结果消息。
44

55
## 离线推送结果查询方式
66

docs/document/server-side/reaction.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
<Toc />
44

5-
消息表情回复(“Reaction”)指用户在单聊和群聊场景中对单条消息回复表情,可丰富用户聊天时的互动方式。对于单个消息,一个消息表情即为一个 Reaction,若不同用户重复添加同一消息表情,Reaction 数量计为 1。每条消息默认可添加 20 个 Reaction,若需提升该上限,需联系声网商务。
5+
消息表情回复(“Reaction”)指用户在单聊和群聊场景中对单条消息回复表情,可丰富用户聊天时的互动方式。**若你当前套餐不支持该功能,需升级产品套餐。**
66

7-
本页介绍如何使用即时通讯 IM RESTful API 实现 Reaction 功能
7+
对于单个消息,一个消息表情即为一个 Reaction,若不同用户重复添加同一消息表情,Reaction 数量计为 1。每条消息默认可添加 20 个 Reaction,若需提升该上限,需联系声网商务
88

99
## 前提条件
1010

1111
要调用声网即时通讯 RESTful API,请确保满足以下要求:
1212

13-
- 已在[声网控制台](https://console.shengwang.cn/overview) [开通配置声网即时通讯 IM 服务](enable_im.html)
13+
- 产品套餐包支持 Reaction 功能
1414
- 已从服务端获取 app token,详见 [使用 Token 鉴权](token_authentication.html)
1515
- 了解声网即时通讯 IM API 的调用频率限制,详见 [接口频率限制](limitationapi.html)
1616

docs/document/server-side/user_global_mute.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
该功能可广泛用于实时互动 app 中,例如发现某用户频繁向多个聊天室发送违规广告,则可以对该用户开启全局聊天室禁言 15 天;发现某用户发表触犯红线的政治言论,则可以全局永久禁言,用户申诉通过后可以解禁。
1010

11-
使用该功能前,你需先查看你的 IM 套餐版本是否开通了该功能。该功能与 IM 套餐包版本之间的开通关系,详见[产品计费](/product/pricing.html#套餐包功能详情)
11+
**使用该功能前,需联系声网商务开通。**
1212

1313
## 公共参数
1414

@@ -36,7 +36,7 @@
3636

3737
要调用声网即时通讯 RESTful API,请确保满足以下要求:
3838

39-
- 已在[声网控制台](https://console.shengwang.cn/overview) [开通配置声网即时通讯 IM 服务](enable_im.html)
39+
- 已联系声网商务开通该功能
4040
- 已从服务端获取 app token,详见 [使用 Token 鉴权](token_authentication.html)
4141
- 了解声网即时通讯 IM API 的调用频率限制,详见 [接口频率限制](limitationapi.html)
4242

0 commit comments

Comments
 (0)