74 lines
2.4 KiB
Markdown
74 lines
2.4 KiB
Markdown
# 用户对象说明
|
|
|
|
## User
|
|
|
|
| 字段 | 类型 | 说明 |
|
|
|---|---|---|
|
|
| id | String | 用户 ID |
|
|
| createdAt | Long | 创建时间，Unix 时间戳毫秒 |
|
|
| updatedAt | Long | 更新时间，Unix 时间戳毫秒 |
|
|
| deletedAt | Long | 删除时间，Unix 时间戳毫秒 |
|
|
| name | String | 登录名，系统内唯一 |
|
|
| nick | String | 用户昵称 |
|
|
| password | String | 明文密码，请求时填写，响应通常不返回 |
|
|
| email | String | 邮箱地址 |
|
|
| emailVerifyAt | Long | 邮箱验证时间，Unix 时间戳毫秒 |
|
|
| phoneNo | String | 手机号，11 位大陆手机号 |
|
|
| phoneNoVerifyAt | Long | 手机号验证时间，Unix 时间戳毫秒 |
|
|
| wrapperType | ImageType | 背景图渲染算法，详见 `ImageType` |
|
|
| avatarType | ImageType | 头像渲染算法，详见 `ImageType` |
|
|
| exp | Integer | 经验值 |
|
|
| sex | Integer | 性别，当前代码未定义枚举说明 |
|
|
| birthdate | Long | 出生日期，Unix 时间戳毫秒 |
|
|
| qq | String | QQ 号 |
|
|
| description | String | 个人说明 |
|
|
| lastLoginIP | String | 上次登录 IP |
|
|
| lastLoginAt | Long | 上次登录时间，Unix 时间戳毫秒 |
|
|
| unmuteAt | Long | 解除禁言时间，Unix 时间戳毫秒 |
|
|
| unbanAt | Long | 解除封禁时间，Unix 时间戳毫秒 |
|
|
| roleList | List<String> | 角色代码列表 |
|
|
| permissionList | List<String> | 权限代码列表 |
|
|
| attachmentList | List<Attachment> | 附件列表 |
|
|
| settingList | List<Setting> | 设置列表 |
|
|
|
|
## LoginRequest
|
|
|
|
| 字段 | 类型 | 说明 |
|
|
|---|---|---|
|
|
| user | String | 用户标识，可能是 UID、邮箱或用户名 |
|
|
| password | String | 明文密码 |
|
|
|
|
## LoginResponse
|
|
|
|
| 字段 | 类型 | 说明 |
|
|
|---|---|---|
|
|
| token | String | 登录令牌 |
|
|
| expireAt | Long | 令牌过期时间，Unix 时间戳毫秒 |
|
|
| user | User | 当前登录用户 |
|
|
|
|
## UpdatePasswordRequest
|
|
|
|
| 字段 | 类型 | 说明 |
|
|
|---|---|---|
|
|
| oldValue | String | 原密码 |
|
|
| newValue | String | 新密码 |
|
|
|
|
## PhoneVerifyCodeSendRequest
|
|
|
|
| 字段 | 类型 | 说明 |
|
|
|---|---|---|
|
|
| phoneNo | String | 手机号，必须为 11 位大陆手机号 |
|
|
|
|
## PhoneVerifyRequest
|
|
|
|
| 字段 | 类型 | 说明 |
|
|
|---|---|---|
|
|
| phoneNo | String | 手机号，必须为 11 位大陆手机号 |
|
|
| verifyCode | String | 6 位数字验证码 |
|
|
|
|
## CancelRequest
|
|
|
|
| 字段 | 类型 | 说明 |
|
|
|---|---|---|
|
|
| password | String | 当前密码，用于确认注销 |
|