Merge pull request #965 from haoxiuwen/doc-v2

Optimize Error Code 202 for Android/iOS/HarmonyOS/Unity/Windows
easemob · Sep 26, 2024 · 1bf9123 · 1bf9123
2 parents e229df1 + a698530
commit 1bf9123
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 6 deletions.
diff --git a/docs/document/android/error.md b/docs/document/android/error.md
@@ -28,7 +28,7 @@ Android 中错误码的类为 `EMError`。
 | 110    |          INVALID_PARAM          | 参数无效。                          |
 | 200    |       USER_ALREADY_LOGIN        | 用户已登录：该用户 ID 已经登录。            |
 | 201    |         USER_NOT_LOGIN          | 用户未登录：例如，如果未登录成功时发送消息或者使用群组操作的 API，SDK 会提示该错误。 |
-| 202    |   USER_AUTHENTICATION_FAILED    | 用户鉴权失败：一般为 token 无效或已过期。   |
+| 202    |   USER_AUTHENTICATION_FAILED    | 用户鉴权失败：<br/> - 若使用用户 ID 和密码登录，用户 ID 或密码不正确时会上报改错误；<br/> - 若使用用户 ID 和用户 token 登录，一般为用户 token 无效或已过期。   |
 | 203    |       USER_ALREADY_EXIST        | 用户已经存在：注册用户时，传入的的用户 ID 已经存在会提示该错误。 |
 | 204    |         USER_NOT_FOUND          | 用户不存在：例如，登录或获取用户会话列表时，用户 ID 不存在。 |
 | 205    |      USER_ILLEGAL_ARGUMENT      | 用户参数不正确：例如，创建用户或更新用户属性时，用户 ID 为空或无效。 |

diff --git a/docs/document/harmonyos/error.md b/docs/document/harmonyos/error.md
@@ -27,7 +27,7 @@ HarmonyOS 中错误码的类为 `ChatError`。
 | 110    |          INVALID_PARAM          | 参数无效。                          |
 | 200    |       USER_ALREADY_LOGIN        | 用户已登录：该用户 ID 已经登录。            |
 | 201    |         USER_NOT_LOGIN          | 用户未登录：例如，如果未登录成功时发送消息或者使用群组操作的 API，SDK 会提示该错误。 |
-| 202    |   USER_AUTHENTICATION_FAILED    | 用户鉴权失败：一般为 token 无效或已过期。   |
+| 202    |   USER_AUTHENTICATION_FAILED    | 用户鉴权失败：<br/> - 若使用用户 ID 和密码登录，用户 ID 或密码不正确时会上报改错误；<br/> - 若使用用户 ID 和用户 token 登录，一般为用户 token 无效或已过期。 |
 | 203    |       USER_ALREADY_EXIST        | 用户已经存在：注册用户时，传入的的用户 ID 已经存在会提示该错误。 |
 | 204    |         USER_NOT_FOUND          | 用户不存在：例如，登录或获取用户会话列表时，用户 ID 不存在。 |
 | 205    |      USER_ILLEGAL_ARGUMENT      | 用户参数不正确：例如，创建用户或更新用户属性时，用户 ID 为空或无效。 |

diff --git a/docs/document/ios/error.md b/docs/document/ios/error.md
@@ -30,7 +30,7 @@ iOS 的错误码只有当操作出错的时候才会有返回值，否则返回
 | 110    |       EMErrorInvalidParam        | 参数无效。  |
 | 200    |     EMErrorUserAlreadyLoginSame     | 当前用户已经登录：该用户 ID 已经登录。 |
 | 201    |         EMErrorUserNotLogin         | 用户未登录：例如，如果未登录成功时调用发送消息或群组操作的 API 会提示该错误。 |
-| 202    |   EMErrorUserAuthenticationFailed   | 用户鉴权失败：一般为 token 无效或已过期。 |
+| 202    |   EMErrorUserAuthenticationFailed   | 用户鉴权失败：<br/> - 若使用用户 ID 和密码登录，用户 ID 或密码不正确时会上报改错误；<br/> - 若使用用户 ID 和用户 token 登录，一般为用户 token 无效或已过期。 |
 | 203    |       EMErrorUserAlreadyExist       | 用户已经存在：注册用户时，传入的的用户 ID 已经存在会提示该错误。 |
 | 204    |         EMErrorUserNotFound         | 用户不存在：例如，登录或获取用户会话列表时，用户 ID 不存在。|
 | 205    |     EMErrorUserIllegalArgument      | 用户参数不正确：例如，创建用户或更新用户属性时，用户 ID 为空或无效。 |

diff --git a/docs/document/server-side/chatroom_attribute.md b/docs/document/server-side/chatroom_attribute.md
@@ -463,7 +463,7 @@ DELETE https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user
 ```shell
 # 将 <YourAppToken> 替换为你在服务端生成的 App Token
 
-DELETE -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{
+curl -X DELETE POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{
     "keys": ["key1","key2"]
  }' 'https://XXXX/XXXX/XXXX/metadata/chatroom/662XXXX13/user/user1'
 ```

diff --git a/docs/document/unity/error.md b/docs/document/unity/error.md
@@ -49,7 +49,7 @@ SDKClient.Instance.Login(username, passwd,
 | 110    | INVALID_PARAM    | 参数无效。                          |
 | 200    | USER_ALREADY_LOGIN                    | 用户已登录：该用户 ID 已经登录。   |
 | 201    | USER_NOT_LOGIN                        | 用户未登录：例如，如果未登录成功时发送消息或者使用群组操作的 API，SDK 会提示该错误。 |
-| 202    | USER_AUTHENTICATION_FAILED            | 用户鉴权失败：一般为 token 无效或已过期。 |
+| 202    | USER_AUTHENTICATION_FAILED            | 用户鉴权失败：<br/> - 若使用用户 ID 和密码登录，用户 ID 或密码不正确时会上报改错误；<br/> - 若使用用户 ID 和用户 token 登录，一般为用户 token 无效或已过期。 |
 | 203    | USER_ALREADY_EXIST                    | 用户已经存在：注册用户时，传入的的用户 ID 已经存在会提示该错误。 |
 | 204    | USER_NOT_FOUND                        | 用户不存在：例如，登录或获取用户会话列表时，用户 ID 不存在。 |
 | 205    | USER_ILLEGAL_ARGUMENT                 | 用户参数不正确：例如，创建用户或更新用户属性时，用户 ID 为空或无效。 |

diff --git a/docs/document/windows/error.md b/docs/document/windows/error.md
@@ -48,7 +48,7 @@ SDKClient.Instance.Login(username, passwd,
 | 109    | TOKEN_WILL_EXPIRE                     | 声网 token 即将过期：超出声网 token 有效期一半时间时会开始回调此错误码。        |
 | 200    | USER_ALREADY_LOGIN                    | 用户已经登录：同一个用户 ID 已经登录。                                                                                                                                                |
 | 201    | USER_NOT_LOGIN                        | 用户未登录：例如，如果未登录成功时发送消息，或者使用群组操作的 API，SDK 会提示该错误。                                                                                                      |
-| 202    | USER_AUTHENTICATION_FAILED            | 用户鉴权失败：一般是 token 鉴权失败或者 token 已经过期。    |
+| 202    | USER_AUTHENTICATION_FAILED            | 用户鉴权失败：<br/> - 若使用用户 ID 和密码登录，用户 ID 或密码不正确时会上报改错误；<br/> - 若使用用户 ID 和用户 token 登录，一般为用户 token 无效或已过期。 |
 | 203    | USER_ALREADY_EXIST                    | 用户已经存在：注册用户 ID 时如果该 ID 已经存在会提示该错误。  |
 | 204    | USER_NOT_FOUND                        | 用户不存在：例如，登录或者获取用户会话列表时用户 ID 不存在。    |
 | 205    | USER_ILLEGAL_ARGUMENT                 | 用户参数不正确：比如创建用户 ID 时不符合格式要求， 或者更新用户属性时用户参数为空等。      |