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 |
扫码体验
请使用字节宿主APP扫码
代码示例
tt.checkSession({
success() {
console.log(`session 未过期`);
},
fail() {
console.log(`session 已过期,需要重新登录`);
tt.login({
success: (res) => {
console.log("登录成功", res);
},
fail: (err) => {
console.log("登录失败", err);
},
});
},
});
Bug & Tip
- Tip:只有成功调用
tt.login
才会生成 session,tt.checkSession
也会因此进入 success 回调,当用户退出登录会清除 session。
点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助