tt.checkSession
收藏我的收藏
收藏基础库 1.0.0 开始支持本方法，这是一个异步方法。
用户的登录态具有时效性，随着用户未使用小程序的时间增加，用户的登录态越容易失效；反之，则用户登录态可持续保持有效。使用该 API 可检查用户当前的 session 状态是否有效，登录态过期后开发者可以再调用 tt.login 获取新的用户登录态。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 |
|
| 支持沙盒 | 否 |
| 相关教程 | 无 |
语法
tt.checkSession(options)
参数说明
options 为 object 类型，属性如下：
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | 1.0.0 |
回调成功
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "checkSession:ok" | 1.0.0 |
回调失败
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "checkSession:fail " + 详细错误信息 | 1.0.0 |
错误码
| errorCode | errMsg | errorType | 说明 | 最低支持版本 |
|---|---|---|---|---|
| 113101 | checkSession:fail session is empty | D | session为空 无需处理 | 1.0.0 |
| 113102 | checkSession:fail session is expired | D | session过期 无需处理 | 1.0.0 |
| 113191 | checkSession:fail Internal error: get platformSessionExpiredTime fa | F | 小程序框架内部错误，有需要请创建工单咨询 | 1.0.0 |
| 113184 | checkSession:fail unregistered API | D | 开发者错误，调用了不支持的API，应该使用caniuse判断 请在调用该方法前使用 tt.canIUse 判断该方法是否可用 | 1.0.0 |
扫码体验
请使用字节宿主APP扫码
