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

    接口 AuthorizedUserInfo

    已获准向当前小程序披露的用户资料。

    当前黑盒 APP 用户已登录时,Runtime 会隐式授予 identity 与 profile,静默建立或 读取隔离身份,并由 user.getInfo() 返回该对象。此过程只要求 Manifest 声明 userInfo,不要求公开 network 权限,也不会返回授权码或创建开发者服务端会话。 支持 Steam 账号能力的 Host 还会授予 steam_account;已授权且有主绑定时才包含 steam_id。

    撤销授权后旧身份失效;调用方应停止使用旧值,并清理本地缓存与开发者服务端会话。 再次调用 user.getInfo() 会按当前账号重新建立隔离身份,不能假定新旧 app_user_id 相同。

    interface AuthorizedUserInfo {
        app_user_id: string;
        profile: { avatar: string; nickname: string } | null;
        steam_id?: string;
    }
    索引

    属性

    app_user_id: string

    当前用户在当前小程序与当前授权有效期内稳定的隔离标识;不是黑盒用户 ID 或登录凭据。

    该值在当前授权有效期内可作为“当前用户 × 当前小程序”的稳定关联键;同一用户在不同 小程序中的值不同,授权撤销后旧值失效。它不是黑盒用户 ID、登录凭据或主站私有接口凭据。 示例: au_1_x7K9mQ2pL4vN8cR3tY6wB1zD5fH。调用方必须把完整值视为不透明字符串, 不应解析格式、依赖固定长度或尝试跨小程序关联用户。

    profile: { avatar: string; nickname: string } | null

    profile 获准披露时返回公开资料:nickname 是展示昵称,avatar 是头像资源字符串; 未获准披露时为 null。

    类型声明

    • { avatar: string; nickname: string }
      • avatar: string

        当前小黑盒账号的公开头像资源字符串;空字符串表示本次未取得可展示头像。

      • nickname: string

        当前小黑盒账号的公开展示昵称;空字符串表示本次未取得可展示昵称。

    • null

    当前 Runtime 的静默读取会授予 profile;资料读取暂时失败时仍可能返回对象,但 nickname 或 avatar 为空字符串。它们只适合展示,不应作为登录态、授权状态、 唯一用户标识或鉴权依据。

    steam_id?: string

    steam_account 已授权且当前已绑定 Steam 时返回 canonical SteamID64。

    始终表示为 string,禁止作为 JSON number 使用;未绑定时省略该字段,不返回空字符串或 null。只返回主绑定 SteamID64,不包含 Steam 昵称、头像、好友码、公开状态或绑定来源。