开发 API 开放接口 登录 ks.checkSession
# ks.checkSession
更新时间:2024-09-19 14:44:22
检查登录态是否有效。
通过 ks.login 接口获取的用户登录态具有一定的时效性,与用户最近是否使用小程序有关,具体时效逻辑由快手维护。登录态过期后开发者可以调用 ks.login 获取新的用户登录态。
# checkSession(options?: CheckSessionOptions): Promise<void>
# 参数
| 参数 | 类型 | 必填 |
|---|---|---|
| options | CheckSessionOptions | 否 |
# CheckSessionOptions
属性
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | (result: void) => void | 否 | 接口调用成功的回调函数 |
| fail | (error: APIError) => void | 否 | 接口调用失败的回调函数 |
| complete | (resultOrError: void | APIError) => void | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
# 返回值
# Promise<void>
# 错误信息
| 错误信息 | 错误说明 |
|---|---|
| session expired | 会话已过期 |
| Invalid app | 应用不存在 |
| beyond token/app/authorized scope | 请求被拒绝,可能是无效token或应用/用户不允许访问该接口 |
| not exist user | 用户信息不存在 |
| invalid scope | 请求授权的scope错误 |
# 示例代码
上一篇:《ks.authorize》
下一篇:《ks.login》
仍有疑问? 前往社区提问