Skip to content

Commit

Permalink
Merge pull request #1065 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history
Modify IM Doc
  • Loading branch information
haoxiuwen authored Nov 29, 2024
2 parents e28d225 + 0050a65 commit cbc53c9
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 14 deletions.
4 changes: 2 additions & 2 deletions docs/document/android/easecallkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ EaseCallKit 集成在环信开源 IM Demo 中,你可以通过进入 [环信 De

集成该库之前,你需要满足以下条件:

- 分别创建 [环信应用](/product/enable_and_configure_IM.html)[声网应用](https://docportal.shengwang.cn/cn/video-legacy/run_demo_video_call_ios?platform=iOS#1-创建声网项目)
- 分别创建 [环信应用](/product/enable_and_configure_IM.html)[声网应用](https://doc.shengwang.cn/doc/rtc/android/get-started/enable-service#创建声网项目)
- 已完成环信 IM 的基本功能,包括登录、好友、群组以及会话等的集成;
- 上线之前开通声网 Token 验证时,用户需要实现自己的 [App Server](https://github.com/easemob/easemob-im-app-server/tree/master/agora-app-server),用于生成 Token。具体请参见 [创建 Token 服务及使用 App Server 生成 Token](https://docportal.shengwang.cn/cn/video-call-4.x/token_server_ios_ng)
- 上线之前开通声网 Token 验证时,用户需要实现自己的 [App Server](https://github.com/easemob/easemob-im-app-server/tree/master/agora-app-server),用于生成 Token。具体请参见 [创建 Token 服务及使用 App Server 生成 Token](https://doc.shengwang.cn/doc/rtc/android/basic-features/token-authentication)

## 快速集成

Expand Down
4 changes: 2 additions & 2 deletions docs/document/android/error.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ Android 中错误码的类为 `EMError`。
| 103 | INVALID_URL | URL 不正确:该错误码已废弃。 |
| 104 | INVALID_TOKEN | 用户 token 不正确:登录时提供的 token 为空或不正确。 |
| 105 | USER_NAME_TOO_LONG | 用户 ID 过长:用户 ID 长度不能超过 64 字节。 |
| 108 | TOKEN_EXPIRED | 声网 token 已过期:超出声网 token 有效期时间。 |
| 109 | TOKEN_WILL_EXPIRE | 声网 token 即将过期:超出声网 token 有效期一半时间时会开始回调此错误码。 |
| 108 | TOKEN_EXPIRED | 用户 token 已过期:超出 token 有效期时间。 |
| 109 | TOKEN_WILL_EXPIRE | 用户 token 即将过期:超出 token 有效期一半时间时会开始回调此错误码。 |
| 110 | INVALID_PARAM | 参数无效。 |
| 200 | USER_ALREADY_LOGIN | 用户已登录:该用户 ID 已经登录。 |
| 201 | USER_NOT_LOGIN | 用户未登录:例如,如果未登录成功时发送消息或者使用群组操作的 API,SDK 会提示该错误。 |
Expand Down
4 changes: 2 additions & 2 deletions docs/document/harmonyos/error.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ HarmonyOS 中错误码的类为 `ChatError`。
| 102 | INVALID_PASSWORD | 用户密码不正确:登录时提供的密码为空或不正确。 |
| 104 | INVALID_TOKEN | 用户 token 不正确:登录时提供的 token 为空或不正确。 |
| 105 | USER_NAME_TOO_LONG | 用户 ID 过长:用户 ID 长度不能超过 64 字节。 |
| 108 | TOKEN_EXPIRED | 声网 token 已过期:超出声网 token 有效期时间。 |
| 109 | TOKEN_WILL_EXPIRE | 声网 token 即将过期:超出声网 token 有效期一半时间时会开始回调此错误码。 |
| 108 | TOKEN_EXPIRED | 用户 token 已过期:超出 token 有效期时间。 |
| 109 | TOKEN_WILL_EXPIRE | 用户 token 即将过期:超出 token 有效期一半时间时会开始回调此错误码。 |
| 110 | INVALID_PARAM | 参数无效。 |
| 200 | USER_ALREADY_LOGIN | 用户已登录:该用户 ID 已经登录。 |
| 201 | USER_NOT_LOGIN | 用户未登录:例如,如果未登录成功时发送消息或者使用群组操作的 API,SDK 会提示该错误。 |
Expand Down
4 changes: 2 additions & 2 deletions docs/document/ios/easecallkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ pod install

在集成该库前,你需要满足以下条件:

- 分别创建 [环信应用](/product/enable_and_configure_IM.html)[声网应用](https://docportal.shengwang.cn/cn/video-legacy/run_demo_video_call_ios?platform=iOS#1-创建声网项目)
- 分别创建 [环信应用](/product/enable_and_configure_IM.html)[声网应用](https://doc.shengwang.cn/doc/rtc/ios/get-started/enable-service#创建声网项目)
- 已完成环信 IM 的基本功能,包括登录、好友、群组以及会话等的集成;
- 上线之前开通声网 token 验证时,用户需要实现自己的 [App Server](https://github.com/easemob/easemob-im-app-server/tree/master/agora-app-server),用于生成 token。利用 App Server 生成 token 的过程参见 [声网 token](https://docportal.shengwang.cn/cn/video-call-4.x/token_server_ios_ng?platform=iOS)
- 上线之前开通声网 token 验证时,用户需要实现自己的 [App Server](https://github.com/easemob/easemob-im-app-server/tree/master/agora-app-server),用于生成 token。利用 App Server 生成 token 的过程参见 [声网 token](https://doc.shengwang.cn/doc/rtc/ios/basic-features/token-authentication)

## 快速集成

Expand Down
4 changes: 2 additions & 2 deletions docs/document/ios/error.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ iOS 的错误码只有当操作出错的时候才会有返回值,否则返回
| 103 | EMErrorInvalidURL | URL 不正确,该错误码已废弃。 |
| 104 | EMErrorInvalidToken | 用户 token 不正确:登录时提供的 token 为空或不正确。 |
| 105 | EMErrorUsernameTooLong | 用户 ID 过长:用户 ID 长度不能超过 64 字节。 |
| 108 | EMErrorTokenExpire | 声网 token 已过期:超出声网 token 有效期时间。 |
| 109 | EMErrorTokeWillExpire | 声网 token 即将过期:超出声网 token 有效期一半时间时会开始回调此错误码。 |
| 108 | EMErrorTokenExpire | 用户 token 已过期:超出用户 token 有效期时间。 |
| 109 | EMErrorTokeWillExpire | 用户 token 即将过期:超出 token 有效期一半时间时会开始回调此错误码。 |
| 110 | EMErrorInvalidParam | 参数无效。 |
| 200 | EMErrorUserAlreadyLoginSame | 当前用户已经登录:该用户 ID 已经登录。 |
| 201 | EMErrorUserNotLogin | 用户未登录:例如,如果未登录成功时调用发送消息或群组操作的 API 会提示该错误。 |
Expand Down
4 changes: 2 additions & 2 deletions docs/document/unity/error.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ SDKClient.Instance.Login(username, passwd,
| 102 | INVALID_PASSWORD | 用户密码不正确:登录时提供的密码为空或不正确。 |
| 104 | INVALID_TOKEN | 用户 token 不正确:登录时提供的 token 为空或不正确。 |
| 105 | USER_NAME_TOO_LONG | 用户 ID 过长:用户 ID 长度不能超过 64 字节。 |
| 108 | TOKEN_EXPIRED | 声网 token 已过期:超出声网 token 有效期。 |
| 109 | TOKEN_WILL_EXPIRE | 声网 token 即将过期:超出声网 token 的一半有效期时会开始回调此错误码。 |
| 108 | TOKEN_EXPIRED | 用户 token 已过期:超出 token 有效期。 |
| 109 | TOKEN_WILL_EXPIRE | 用户 token 即将过期:超出 token 的一半有效期时会开始回调此错误码。 |
| 110 | INVALID_PARAM | 参数无效。 |
| 200 | USER_ALREADY_LOGIN | 用户已登录:该用户 ID 已经登录。 |
| 201 | USER_NOT_LOGIN | 用户未登录:例如,如果未登录成功时发送消息或者使用群组操作的 API,SDK 会提示该错误。 |
Expand Down
4 changes: 2 additions & 2 deletions docs/document/windows/error.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ SDKClient.Instance.Login(username, passwd,
| 102 | INVALID_PASSWORD | 用户密码不正确:登录时提供的密码为空或不正确。 |
| 104 | INVALID_TOKEN | 登录时提供的 token 为空或不正确。 |
| 105 | USER_NAME_TOO_LONG | 用户 ID 过长:用户名长度限制 64 个字节。 |
| 108 | TOKEN_EXPIRED | 声网 token 已过期:超出声网 token 有效期时间。 |
| 109 | TOKEN_WILL_EXPIRE | 声网 token 即将过期:超出声网 token 有效期一半时间时会开始回调此错误码。 |
| 108 | TOKEN_EXPIRED | 用户 token 已过期:超出 token 有效期时间。 |
| 109 | TOKEN_WILL_EXPIRE | 用户 token 即将过期:超出 token 有效期一半时间时会开始回调此错误码。 |
| 200 | USER_ALREADY_LOGIN | 用户已经登录:同一个用户 ID 已经登录。 |
| 201 | USER_NOT_LOGIN | 用户未登录:例如,如果未登录成功时发送消息,或者使用群组操作的 API,SDK 会提示该错误。 |
| 202 | USER_AUTHENTICATION_FAILED | 用户鉴权失败:<br/> - 若使用用户 ID 和密码登录,用户 ID 或密码不正确时会上报改错误;<br/> - 若使用用户 ID 和用户 token 登录,一般为用户 token 无效或已过期。 |
Expand Down

0 comments on commit cbc53c9

Please sign in to comment.