小程序开放平台

文档中心
基础
界面
网络
数据缓存
媒体
位置
开放接口
登录
checkSession
login
授权
设置
发小红书笔记
跳转 AI 能力法务协议
设备
XHSML
性能
文件
数据分析
画布

xhs.checkSession

开发
>
JS API
>
开放接口
>
登录
>
checkSession
>
更新时间:2024-11-13 19:05:30

以Promise风格调用: 支持

检查登录态是否过期。 通过 xhs.login 接口获得的用户登录态拥有一定的时效性。用户越久未使用小程序,用户登录态越有可能失效。反之如果用户一直在使用小程序,则用户登录态一直保持有效。具体时效逻辑由小红书维护,对开发者透明。开发者只需要调用 xhs.checkSession 接口检测当前用户登录态是否有效。登录态过期后开发者可以再调用 xhs.login 获取新的用户登录态。调用成功说明当前 session_key 未过期,调用失败说明 session_key 已过期。

参数

Object object

属性
类型
默认值
必填
说明
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

属性
类型
说明
errMsgstring

实例代码

xhs.checkSession({
  success () {
    //session_key 未过期,并且在本生命周期一直有效
  },
  fail () {
    // session_key 已经失效,需要重新执行登录流程
    xhs.login() //重新登录
  }
})