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

    接口 MiniProgramEventPayloadMap

    公开事件名与对应载荷的映射,供 SDK 的类型化事件监听使用。

    生命周期 timestamp 是 Runtime 发出通知时的 Unix 毫秒时间,不是 iframe 收到事件的 时间或单调时钟。事件只通知已注册的监听器;业务需要当前状态时应使用相应读取 API。

    interface MiniProgramEventPayloadMap {
        "companion.session.exit": CompanionSessionExitPayload;
        "companion.session.output": CompanionSessionOutputPayload;
        "companion.session.ownershipLost": CompanionSessionOwnershipLostPayload;
        display_change: MiniProgramDisplayState & { source?: "user" | "api" };
        error: MiniProgramBridgeError;
        heybox_app_login_change: {
            accountKey?: string | null;
            isHeyboxAppLoggedIn: boolean;
        };
        hide: { source?: string; timestamp: number };
        launch: { timestamp: number; url?: string };
        ready: { timestamp: number };
        show: { source?: string; timestamp: number };
        unload: { timestamp: number };
        user_info_authorization_change: UserInfoAuthorization;
        viewport_change: MiniProgramWindowInfoResult;
        workspace_cards_launch_context_change: WorkspaceCardLaunchContext | null;
    }
    索引

    属性

    "companion.session.exit": CompanionSessionExitPayload

    Companion session 的进程退出通知。

    "companion.session.output": CompanionSessionOutputPayload

    当前 Companion controller 收到的输出片段;去重与确认依据见载荷中的 sequence。

    "companion.session.ownershipLost": CompanionSessionOwnershipLostPayload

    当前 controller 失去 Companion session 控制权的通知。

    display_change: MiniProgramDisplayState & { source?: "user" | "api" }

    展示状态实际变化后通知;不回放初始状态,不支持或失败时不通知。

    类型声明

    • 可选source?: "user" | "api"

      api 为开发者调用;user 为用户点击宿主退出全屏按钮。同目标合并时保留首次发起来源。旧宿主可能不提供。

    结构化 Runtime 错误通知;载荷不是 JavaScript Error 实例。

    heybox_app_login_change: {
        accountKey?: string | null;
        isHeyboxAppLoggedIn: boolean;
    }

    Host 当前登录状态通知;相同状态可能重复出现,不能仅凭事件判断账号身份是否变化。

    类型声明

    • 可选accountKey?: string | null

      本地账号比较标识;旧 Host 或映射读取期间可能缺失,表示待确认。

    • isHeyboxAppLoggedIn: boolean

      Host 当前是否有已登录的小黑盒账号,不表示开发者服务端会话状态。

    hide: { source?: string; timestamp: number }

    Host 通知小程序进入隐藏状态。

    类型声明

    • 可选source?: string

      Host 可选提供的来源描述;不保证存在或采用固定枚举。

    • timestamp: number

      Runtime 发出通知时的 Unix 毫秒时间。

    launch: { timestamp: number; url?: string }

    初次握手时的启动通知;晚订阅不能补收。

    类型声明

    • timestamp: number

      Runtime 发出通知时的 Unix 毫秒时间。

    • 可选url?: string

      Host 加载 iframe 时的启动 URL;可缺失,不代表页面当前导航地址。

    ready: { timestamp: number }

    握手成功通知;重复握手可再次产生,应查询持久握手状态驱动 UI。

    类型声明

    • timestamp: number

      Runtime 发出通知时的 Unix 毫秒时间。

    show: { source?: string; timestamp: number }

    Host 通知小程序进入展示状态。

    类型声明

    • 可选source?: string

      Host 可选提供的来源描述;不保证存在或采用固定枚举。

    • timestamp: number

      Runtime 发出通知时的 Unix 毫秒时间。

    unload: { timestamp: number }

    Runtime 卸载的尽力通知;不能保证页面销毁前一定收到。

    类型声明

    • timestamp: number

      Runtime 发出通知时的 Unix 毫秒时间。

    user_info_authorization_change: UserInfoAuthorization

    当前用户授权状态通知;可包含可选 steam_account,不是 Manifest 权限状态。

    窗口信息变化通知;载荷与 viewport.getWindowInfo() 的结果结构一致。

    workspace_cards_launch_context_change: WorkspaceCardLaunchContext | null