Skip to content

Commit b093089

Browse files
authored
Merge pull request #97 from haoxiuwen/doc-shengwang
Modify Error 208 for SDKs
2 parents 772fbb8 + 9d431d1 commit b093089

File tree

23 files changed

+40
-6
lines changed

23 files changed

+40
-6
lines changed

docs/docs/sdk/android/error.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Android 中错误码的类为 `Error`。
3333
| 205 | USER_ILLEGAL_ARGUMENT | 用户参数不正确:例如,创建用户或更新用户属性时,用户 ID 为空或无效。 |
3434
| 206 | USER_LOGIN_ANOTHER_DEVICE | 用户在其他设备登录:如果未开启多设备登录,则在其他设备登录会将当前登录设备踢下线,用户会在当前设备收到该错误。 |
3535
| 207 | USER_REMOVED | 用户已被注销:当前的登录用户 ID 从[声网控制台](https://console.shengwang.cn/overview)删除会收到该错误。 |
36-
| 208 | USER_REG_FAILED | 用户注册失败:例如,注册用户之前未开启开放注册功能等原因|
36+
| 208 | USER_REG_FAILED | 用户注册失败,你需要在[声网控制台注册用户](login.html#用户注册)[调用 RESTful API 注册](/server-side/account_system.html#注册用户)|
3737
| 209 | USER_UPDATEINFO_FAILED | 更新推送配置错误:例如,用户更新推送昵称或设置免打扰配置时失败。 |
3838
| 210 | USER_PERMISSION_DENIED | 用户无权限:例如,如果用户被添加到黑名单后,发送消息时会提示该错误。其他报错情况包括用户修改其他用户发出的消息、修改其他用户设置的群成员属性以及普通群成员试图解散子区(仅子区所在群组的群主和群管理员有权解散子区)。|
3939
| 211 | USER_BINDDEVICETOKEN_FAILED | 绑定设备 token 失败。 |

docs/docs/sdk/android/login.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@
3434

3535
![img](/images/android/user_token.png)
3636

37+
在生产环境中,为了安全考虑,你需要部署 App Server 生成 Token,详见 [Token 鉴权文档](/server-side/token_authentication.html#搭建-app-server-生成-token)
38+
3739
## 主动登录
3840

3941
1. **用户 ID + token** 是更加安全的登录方式。

docs/docs/sdk/android/product_group_overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
| 变更群主 | 群主可以将群组的所有权转让给指定的组成员。所有权转移后,群主成为普通群成员。 |
9494
| 添加/移除/获取群管理员 | 群主可以添加成员到群组管理员列表,将管理员移出该列表。所有群成员均可获取群组下的管理员列表。 |
9595
| 群组白名单 | 群主和管理员可以将群成员加入或移出白名单。白名单中的群成员可以在全员禁言状态下发送群消息。仅群主和群管理员可以获取群组白名单列表。 |
96-
| 群组黑名单 | 群主和群管理员可以将群成员加入或移出黑名单,黑名单中的成员将被移出群且无法再次加入群。仅群主和群管理员可以获取群组白名单列表|
96+
| 群组黑名单 | 群主和群管理员可以将群成员加入或移出黑名单,黑名单中的成员将被移出群且无法再次加入群。仅群主和群管理员可以获取群组黑名单列表|
9797
| 群组禁言 | - 群主和管理员可以将群成员加入或移出禁言列表,禁言列表中的成员无法发送群消息,但可以接收群消息。<br/> - 仅群主和群管理员可以获取群组禁言列表。<br/> - 群主和管理员可以开启或关闭全员禁言。开启全员禁言后,仅群组、管理员和白名单中的成员可以发送群消息。|
9898
| 管理群成员的自定义属性 | 支持设置群成员自定义属性和获取单个群成员的自定义属性。群主可修改所有群成员的自定义属性,其他群成员只能修改自己的自定义属性。 |
9999

docs/docs/sdk/android/quickstart.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,8 @@ ChatClient.getInstance().init(context, options);
192192

193193
![img](/images/android/user_token.png)
194194

195+
在生产环境中,为了安全考虑,你需要部署 App Server 生成 Token,详见 [Token 鉴权文档](/server-side/token_authentication.html#搭建-app-server-生成-token)
196+
195197
### 3. 登录账号
196198

197199
使用如下代码实现用户登录:

docs/docs/sdk/applet/login.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@
3434

3535
![img](/images/android/user_token.png)
3636

37+
在生产环境中,为了安全考虑,你需要部署 App Server 生成 Token,详见 [Token 鉴权文档](/server-side/token_authentication.html#搭建-app-server-生成-token)
38+
3739
## 登录方式
3840

3941
1. **用户 ID + token** 是更加安全的登录方式。

docs/docs/sdk/flutter/login.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@
3434

3535
![img](/images/android/user_token.png)
3636

37+
在生产环境中,为了安全考虑,你需要部署 App Server 生成 Token,详见 [Token 鉴权文档](/server-side/token_authentication.html#搭建-app-server-生成-token)
38+
3739
## 主动登录
3840

3941
1. **用户 ID + token** 是更加安全的登录方式。使用 token 登录时需要处理 token 过期的问题,比如在每次登录时更新 token 等机制。

docs/docs/sdk/flutter/quickstart.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,8 @@ void _initSDK() async {
269269

270270
![img](/images/android/user_token.png)
271271

272+
在生产环境中,为了安全考虑,你需要部署 App Server 生成 Token,详见 [Token 鉴权文档](/server-side/token_authentication.html#搭建-app-server-生成-token)
273+
272274
### 添加登录
273275

274276
`_signIn` 方法中添加登录代码。

docs/docs/sdk/harmonyos/error.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ HarmonyOS 中错误码的类为 `ChatError`。
3232
| 205 | USER_ILLEGAL_ARGUMENT | 用户参数不正确:例如,创建用户或更新用户属性时,用户 ID 为空或无效。 |
3333
| 206 | USER_LOGIN_ANOTHER_DEVICE | 用户在其他设备登录:如果未开启多设备登录,则在其他设备登录会将当前登录设备踢下线,用户会在当前设备收到该错误。 |
3434
| 207 | USER_REMOVED | 用户已被注销:当前的登录用户 ID 从[声网控制台](https://console.shengwang.cn/overview)删除会收到该错误。 |
35-
| 208 | USER_REG_FAILED | 用户注册失败:例如,注册用户之前未开启开放注册功能等原因|
35+
| 208 | USER_REG_FAILED | 用户注册失败,你需要在[声网控制台注册用户](login.html#用户注册)[调用 RESTful API 注册](/server-side/account_system.html#注册用户)|
3636
| 209 | USER_UPDATEINFO_FAILED | 更新推送配置错误:例如,用户更新推送昵称或设置免打扰配置时失败。 |
3737
| 210 | USER_PERMISSION_DENIED | 用户无权限:例如,如果用户被添加到黑名单后,发送消息时会提示该错误。其他报错情况包括用户修改其他用户发出的消息、修改其他用户设置的群成员属性以及普通群成员试图解散子区(仅子区所在群组的群主和群管理员有权解散子区)。|
3838
| 213 | USER_BIND_ANOTHER_DEVICE | 用户已在其他设备登录:在单设备登录场景中,默认情况下,后登录的设备会踢掉当前设备的登录。若设置为先登录的设备优先,则后登录设备登录失败并提示该错误。 |

docs/docs/sdk/harmonyos/login.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@
3434

3535
![img](/images/android/user_token.png)
3636

37+
在生产环境中,为了安全考虑,你需要部署 App Server 生成 Token,详见 [Token 鉴权文档](/server-side/token_authentication.html#搭建-app-server-生成-token)
38+
3739
## 主动登录
3840

3941
**用户 ID + token** 是更加安全的登录方式。

docs/docs/sdk/harmonyos/quickstart.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,8 @@ ChatClient.getInstance().init(context, options);
143143

144144
![img](/images/android/user_token.png)
145145

146+
在生产环境中,为了安全考虑,你需要部署 App Server 生成 Token,详见 [Token 鉴权文档](/server-side/token_authentication.html#搭建-app-server-生成-token)
147+
146148
### 3. 登录账号
147149

148150
使用如下代码实现用户登录:

0 commit comments

Comments
 (0)