@heybox/hb-sdk API Reference - v0.9.5
    正在准备搜索索引...

    类型别名 MiniProgramUserInfoResult

    MiniProgramUserInfoResult:
        | { authorization: null; isHeyboxAppLoggedIn: false; userInfo: null }
        | {
            authorization: UserInfoAuthorization;
            isHeyboxAppLoggedIn: true;
            userInfo: AuthorizedUserInfo | null;
        }

    当前黑盒 APP 登录态、授权状态和已获准披露的用户资料。

    类型声明

    • { authorization: null; isHeyboxAppLoggedIn: false; userInfo: null }
      • authorization: null

        未登录时没有当前小程序的用户授权上下文。

      • isHeyboxAppLoggedIn: false

        false 是未登录分支的稳定判别值。

      • userInfo: null

        未登录时不会披露隔离身份或公开资料。

    • {
          authorization: UserInfoAuthorization;
          isHeyboxAppLoggedIn: true;
          userInfo: AuthorizedUserInfo | null;
      }
      • authorization: UserInfoAuthorization

        当前小程序的用户授权状态;与 Manifest 权限声明是两层独立门禁。

      • isHeyboxAppLoggedIn: true

        true 表示 Host 当前有已登录的小黑盒账号,不等同于开发者服务端已建立会话。

      • userInfo: AuthorizedUserInfo | null

        已获准披露的隔离身份与公开资料;兼容 Host 可能返回 null。

    以 isHeyboxAppLoggedIn 作为判别字段处理返回值:

    • false:当前 Host 没有已登录的小黑盒账号,authorization 与 userInfo 固定为 null。 这是正常业务分支,不会抛出登录错误。
    • true 且 userInfo 非空:authorization 必含 identity、profile,支持时还包含 steam_account; userInfo 包含当前小程序隔离的 app_user_id,而 profile 仍需独立判空。
    • true 且 userInfo 为 null:公共协议为兼容 Host 保留的“已登录但资料未披露/不可用”分支。 当前 Runtime 成功读取隔离身份时返回非空对象,但调用方仍应按类型处理该分支。

    user.getInfo() 不返回 code、token、cookie 或黑盒用户 ID。需要建立开发者服务端会话时, 应在可信用户操作中调用 auth.login(),再把一次性 code 交给开发者自己的服务端。