登录信息 (Login)
类型定义
Login
| 字段 | 类型 | 描述 |
|---|---|---|
sn | number | 序列号[1] 实验性 |
platform | string?[3] | 平台名称 |
user | User?[3] | 用户对象[2] |
status | LoginStatus | 登录状态 |
adapter | string | 适配器名称 实验性 |
features | string[]? | 平台特性列表 实验性 |
TIP
[1] login.sn 仅用于标识 Login 对象，与平台逻辑无关 (意味着任何平台相关的 API 调用都不需要传入这个 sn)，也不进行持久化 (意味着两次连接中同一个登录号的 sn 可能是不同的，不同登录号的 sn 可能是相同的)。请尤其注意与 login.user.id 区分。
TIP
[2] login.user 并不一定是真实存在的平台用户，也可以是平台分配的机器人或者应用身份。
TIP
[3] 当 login.status 不为 ONLINE 时，platform 和 user 可能为空。但实际上，所有的非登录事件中均确保 login 处于 ONLINE 状态，因此 platform 和 user 总是有值的。从 SDK 开发的角度，为登录事件和非登录事件提供不同的类型是比较好的做法。
LoginStatus
| 名称 | 值 | 描述 |
|---|---|---|
OFFLINE | 0 | 离线 |
ONLINE | 1 | 在线 |
CONNECT | 2 | 正在连接 |
DISCONNECT | 3 | 正在断开连接 |
RECONNECT | 4 | 正在重新连接 |
API
获取登录信息
POST /login.get获取登录信息。返回一个 Login 对象。
事件
login-added
登录被创建时触发。必需资源：login。
login-removed
登录被删除时触发。必需资源：login。
login-updated
登录信息更新时触发。必需资源：login。