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

    模块 index

    类

    HbMiniProgramNetworkError

    SDK 对外抛出的 HTTP 错误类型。

    HbMiniProgramSDKError

    SDK 对外抛出的标准 bridge / runtime 错误类型。

    接口

    AuthorizedUserInfo

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

    CompanionAttachments

    Companion 产生的受控附件访问能力。

    CompanionInfo

    Host 针对当前小程序版本与当前平台确认的 Companion 描述快照。

    CompanionNotification

    请求 Host 展示的固定类别通知。

    CompanionNotifications

    Companion 请求 Host 展示固定类别系统通知的能力。

    CompanionPrepareOptions

    companion.prepare 的进度与取消配置。

    CompanionSession

    受 Host 监管的 Companion 活动进程 Session。

    CompanionStdio

    Companion 的标准输入输出能力。

    CreateOptions
    DeleteCurrentUserLeaderboardEntryPayload

    cloud.leaderboard.deleteCurrentUserEntry 的可选参数。

    DeleteCurrentUserLeaderboardEntryResult

    删除当前用户排行榜记录的结果。

    DirectoryHandle

    当前 SDK session 中的目录代理。

    DownloadBaseOptions

    流式下载两种 target 分支共享的地址、限制、取消与进度选项。

    DownloadProgress

    流式下载的 request-scoped 进度。

    ExecuteProtocolObject

    device.executeProtocol 的 JSON 协议对象形态。

    FileHandle

    当前 SDK session 中的文件代理。

    FilesModule

    Mini-program 对外文件能力。

    FileStat

    FileHandle.stat 返回的文件元数据快照。

    FileSystem

    Mini-program 私有 sandbox 的逻辑根。

    GameSaveFileInfo

    list 返回的存档文件;元数据不会触发下载,调用 downloadFile 后才下载。

    GameSaveInfo
    GameSavesFileOptions

    文件对象已绑定查询时的游戏、账号、存档和文件,只需指定取消信号。

    GameSavesModule

    游戏存档;需声明 gameSaves,无需单独弹窗确认,服务端校验当前账号及存档归属。

    GameSavesSyncOptions

    同步由 Runtime 等待至终态;取消仅停止等待,不撤销已经创建的服务端任务。

    GetCurrentUserLeaderboardEntryPayload

    cloud.leaderboard.getCurrentUserEntry 的可选参数。

    GetLeaderboardInfoPayload

    cloud.leaderboard.getInfo 的可选参数。

    GetLeaderboardInfoResult

    排行榜创建时确定的基础配置。

    GetLeaderboardListPayload

    cloud.leaderboard.getList 的分页参数。

    GetLeaderboardListResult

    排行榜列表的一页规范化结果。

    GetSteamGameListOptions

    Steam 游戏库查询与 offset 分页参数。

    GetStoragePayload

    storage.getStorage 入参。

    GetStorageResult

    storage.getStorage 返回值。

    LeaderboardEntry

    平台托管的排行榜记录。

    ListOptions

    枚举目录直接子项时的选项。

    LoginOptions

    auth.login 的可选配置。

    LoginResult

    小程序服务端用于换取当前用户身份的短期授权码。

    MediaImageItem

    选择的图片项。

    MediaModule

    当前 SDK session 的媒体选择模块。

    MediaVideoItem

    选择的视频项,额外携带时长。

    MiniProgramAuthModule

    外部小程序可调用的授权模块。

    MiniProgramCloudLeaderboardModule

    外部小程序可调用的云端排行榜模块。

    MiniProgramCloudModule

    外部小程序可调用的云端能力模块。

    MiniProgramCloudStorageModule

    当前用户在当前小程序下的字符串云存储;需声明 cloud_storage 权限。

    MiniProgramCompanionModule
    MiniProgramCopyLinkOptions

    复制当前小程序通用分享链接的配置。

    MiniProgramDeviceModule

    外部小程序可调用的 device 模块。

    MiniProgramDisplayState

    宿主确认生效的小程序展示状态;不表示手机旋转传感器状态。

    MiniProgramEnvironmentInfo

    当前小程序实例的只读环境快照。

    MiniProgramEnvironmentModule

    外部小程序可调用的 environment 模块。

    MiniProgramEventPayloadMap

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

    MiniProgramNavigationModule

    外部小程序可调用的 navigation 模块。

    MiniProgramNetworkModule

    Mini-program 可调用的受控网络模块。

    MiniProgramNetworkRequestConfig

    对外开放的网络请求配置。

    MiniProgramNetworkResponse

    SDK 对外暴露的网络响应。

    MiniProgramSafeArea

    小程序安全区域信息。

    MiniProgramScreenshotOptions

    截图分享配置。

    MiniProgramScreenshotRect

    截图区域。

    MiniProgramSetNavigationBarStyleOptions

    设置导航栏样式的配置。

    MiniProgramShareModule

    外部小程序可调用的分享模块。

    MiniProgramSharePostOptions

    客户端“转发到社区”发帖页的可编辑预置。

    MiniProgramShowShareMenuOptions

    展示基础分享面板的配置。

    MiniProgramStorageModule

    外部小程序可调用的 storage 模块。

    MiniProgramUiModule

    外部小程序可调用的 Host UI 反馈模块。

    MiniProgramUserModule

    外部小程序可调用的用户模块。

    MiniProgramViewportModule

    外部小程序可调用的 Viewport 模块。

    MiniProgramWindowInfoResult

    小程序窗口信息。

    NetworkRequestPayload

    bridge / runtime 可消费的网络请求 payload。

    NetworkResponsePayload

    bridge / runtime 返回的标准化 HTTP 响应。

    OpenGameDetailAppPageOptions

    打开游戏详情页的公共参数。

    OpenMiniProgramAppPageOptions

    打开另一个公开发布小程序的参数。

    OpenPostDetailAppPageOptions

    打开小黑盒帖子详情页的公共参数;当前 PC Host 不支持该目标。

    OpenUserDetailAppPageOptions

    打开小黑盒用户详情页的公共参数;当前 PC Host 不支持该目标。

    PathRoot

    可同步派生 lazy File/Directory proxy 的逻辑根。

    PickDirectoryOptions

    用户选择目录时的授权选项。

    PickFilesOptions

    用户选择文件时的筛选和授权选项。

    RemoveOptions

    删除目录时的选项。

    SaveFileOptions

    用户选择精确保存目标时的选项。

    SetClipboardPayload

    device.setClipboard 入参。

    SetDisplayPayload
    SetStoragePayload

    storage.setStorage 入参。

    ShowLoadingPayload

    ui.showLoading 的展示配置。

    ShowToastPayload

    ui.showToast 的展示配置。

    SteamGameListData

    Steam 游戏库的 offset 分页数据。

    SteamGameListItem

    经过 Runtime 规范化的 Steam 游戏库条目。

    SubmitLeaderboardEntryPayload

    cloud.leaderboard.submit 的提交参数。

    UploadBaseOptions

    单文件流式上传的公共选项。

    UploadProgress

    上传进度仅统计文件内容字节;100% 不表示服务端已经接受本次上传。

    UploadResponse

    上传完成后的 HTTP 响应;data 的泛型不执行运行时 schema 校验。

    UserInfoAuthorization

    当前小程序对 canonical 用户信息 scope 的授权状态。

    VibratePayload

    device.vibrate 入参。

    WorkspaceCardLaunchContext
    WorkspaceCardsModule

    工作区卡片前台模块;调用不会创建新的工作区。

    WorkspaceCardsRefreshOptions

    类型别名

    AccountState

    Host 本地、按小程序隔离的账号比较状态;不是服务端登录凭据。

    AuthorFollowStatus

    当前账号与小程序作者的关注关系,取值见 AuthorFollowStatus。

    ClosePayload

    navigation.close 的无参 payload。

    CloseResult

    navigation.close 的成功结果为 undefined。

    CompanionCapability

    当前 Companion 产物声明并由 Host 确认的可选能力。

    CompanionExit

    Companion Session 的一次性退出结果。

    CompanionExitHandler

    Companion Session 退出时调用的同步回调。

    CompanionNotificationCategory

    桌面辅助应用通知的语义类别:completed 为完成,failed 为失败,stopped 为停止, attention 为需要用户关注。它只选择通知类别,不会改变进程或 session 状态。

    CompanionOutputHandler

    Companion stdout/stderr 单个原始输出 chunk 的同步回调。

    CompanionOwnershipLostHandler

    Companion Session controller 转移时调用的无参同步回调。

    CompanionPreparationStatus

    当前小程序版本、当前平台与指定 alias 对应的 Host 准备状态快照。

    CompanionPrepareProgress

    Host 持有的 Companion 准备操作的最近进度快照。

    CompanionState

    Session 的生命周期状态;退出后不会回到 running。

    CompanionStateChangeHandler

    Companion Session 状态变化回调。

    CompanionTarget

    当前 Host 为 Companion 选择的目标制品。

    CopyLinkPayload

    share.copyLink 入参;省略后生成不带 extra 的通用分享链接。

    CopyLinkResult

    share.copyLink 返回值;内容与 Host 已写入系统剪贴板的完整分享链接一致。

    DownloadOptions

    下载目标选项。

    ExecuteProtocolInput

    device.executeProtocol 的入参:完整协议字符串或 JSON 协议对象。

    ExecuteProtocolResult

    成功只表示协议已投递,不表示业务动作完成。

    FileMode

    File/Directory 访问模式。

    FileSystemEntity

    目录枚举返回的文件或目录代理。

    GameSaveStructuredData

    最新已有的完整结构化业务数据;不保证对应某个存档批次或 ZIP。 data 保留各游戏的业务字段;超出 JavaScript 安全整数范围的整数使用字符串。

    GetCurrentUserLeaderboardEntryResult

    当前用户排行榜记录,或表示“没有记录”的 undefined。

    GetFollowStatusResult

    查询不触发登录或弹框,不披露账号标识;失败不缓存。

    GetSteamGameListPayload

    user.getSteamGameList 请求参数;省略时使用默认 Steam 账号和全部默认查询值。

    GetSteamGameListResult

    user.getSteamGameList 返回当前用户的 Steam 绑定状态和游戏库。

    GetUserInfoPayload

    user.getInfo 不需要入参;调用时不要传小程序 ID 或用户 ID。

    GetUserInfoResult

    user.getInfo 返回当前用户登录态与公开基础资料。

    GetWindowInfoPayload

    viewport.getWindowInfo 不接收 options 或 payload,调用时无需传入参数。

    GetWindowInfoResult

    viewport.getWindowInfo 返回调用时经过 Runtime 归一化的窗口快照。

    HideLoadingPayload

    ui.hideLoading 的空 payload。

    HideLoadingResult

    ui.hideLoading 的空结果。

    LeaderboardOrder

    排行榜排序方向。

    LoginPayload

    auth.login 的请求载荷;不传配置时为 undefined。

    LoginScope

    登录时可请求的用户信息 scope。

    MediaItem

    单次媒体选择的返回项。

    MediaSelectionType

    系统选择器的媒体类型筛选。

    MediaType

    可选择的媒体类型。

    MiniProgramAppPageTarget

    小程序可请求打开的黑盒 App 页面目标。

    MiniProgramEventHandler

    小程序生命周期或业务事件监听函数。

    MiniProgramEventName

    小程序可订阅的生命周期、展示状态及业务事件名。

    MiniProgramGameDetailGameType

    游戏详情的游戏平台类型:pc、console(主机)或 mobile(移动游戏)。 值区分大小写,不接受平台别名。

    MiniProgramGameDetailPage

    游戏详情首屏:game 为详情主页,wiki 为百科页;省略时由 Host 选择默认页。

    MiniProgramNavigationBarForegroundStyle

    导航栏关闭按钮与状态栏图标/文字的前景样式。

    MiniProgramNetworkHeaders

    network.request 请求头。

    MiniProgramNetworkParams

    network.request 查询参数,由 Host 编码到请求 URL。

    MiniProgramNetworkRequestMethod

    network.request 支持的 HTTP 方法;省略时使用 GET。

    MiniProgramNetworkValidateStatus

    SDK 侧可配置的状态校验函数。

    MiniProgramOperatingSystemName

    Host 明确提供的操作系统名称。

    MiniProgramOrientationMode

    小程序窗口方向。

    MiniProgramRuntimeMode

    当前小程序实例的运行模式。

    MiniProgramSDKHandshakeState

    SDK 与 Host 握手的持久状态。

    MiniProgramSDKHandshakeStateHandler

    SDK 握手状态变化处理函数。

    MiniProgramShareChannel

    小程序可选分享渠道。

    MiniProgramShareExtraValue

    分享扩展数据支持的 JSON-compatible 类型。

    MiniProgramToastStatus

    Toast 的语义状态。

    MiniProgramUserInfoResult

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

    MiniProgramVibrateIntensity

    震动强度。

    OpenAppPageOptions

    打开黑盒 App 页面的判别联合参数。

    OpenAppPagePayload

    navigation.openAppPage 发送给 Host Runtime 的判别联合 payload。

    OpenAppPageResult

    navigation.openAppPage 成功时 resolve undefined。

    OpenGameDetailAppPagePayload

    打开游戏详情页的规范化 bridge payload;appId 与可选 skuId 已转换为非空字符串。

    OpenMiniProgramAppPagePayload

    打开目标小程序的规范化 bridge payload;miniProgramId 已 trim。

    OpenPostDetailAppPagePayload

    打开帖子详情页的规范化 bridge payload;帖子与评论 ID 均为非空字符串。

    OpenUserDetailAppPagePayload

    打开用户详情页的规范化 bridge payload;userId 已 trim 为非空字符串。

    PickMediaOptions

    media.pick() 的选择选项。

    ReloadPayload

    navigation.reload 的无参 payload。

    ReloadResult

    navigation.reload 的成功结果为 undefined。

    RequestFollowAuthorResult

    成功返回已关注或作者本人;用户取消会 reject。

    RevokeAuthorizationPayload

    user.revokeAuthorization 不接收入参。

    RevokeAuthorizationResult

    撤销成功后不返回用户身份或资料,Promise resolve 值为 undefined。

    ScreenshotPayload

    share.screenshot 的可选入参;省略时截取调用时的当前可见窗口。

    ScreenshotResult

    share.screenshot 透传的 Host 截图分享结果。

    SetClipboardResult

    device.setClipboard 无稳定返回值。

    SetDisplayResult

    本次展示设置的原生支持结果;不支持时保留原生状态,宿主仍可尽力收起 H5 顶部栏。

    SetNavigationBarStylePayload

    viewport.setNavigationBarStyle 的必填入参。

    SetNavigationBarStyleResult

    viewport.setNavigationBarStyle 的结果;Host 完成设置后固定以 undefined resolve。

    ShowLoadingResult

    ui.showLoading 的空结果。

    ShowShareMenuPayload

    share.showShareMenu 入参;落地页固定为当前小程序的通用分享页。

    ShowShareMenuResult

    客户端分享面板返回的不透明值。

    ShowToastResult

    ui.showToast 的空结果。

    SteamGameListSort

    Steam 游戏库的服务端排序维度。

    SubmitLeaderboardEntryResult

    提交完成后服务端为当前用户保留的最终 LeaderboardEntry。

    UploadOptions

    raw 默认 PUT,也支持 POST;multipart 固定 POST 且仅含一个文件。

    UserInfoAuthorizationScope

    用户信息授权 scope。

    UserInfoAuthorizationStatus

    单个用户信息 scope 对当前小程序的授权状态。

    VibrateResult

    device.vibrate 的空结果。

    变量

    AuthorFollowStatus

    当前账号与小程序作者的关注关系枚举常量。

    companion

    默认 SDK 实例的受管桌面程序模块。

    environment

    默认 SDK 实例的 environment 模块。

    gameSaves

    当前用户的游戏存档能力。

    media

    默认 SDK 实例的 media 模块。

    USER_INFO_AUTHORIZATION_SCOPES

    当前用户信息与登录能力支持的完整 scope 目录(canonical 顺序)。

    workspaceCards

    默认 SDK 的工作区卡片模块。

    函数

    getHandshakeState

    获取默认 SDK 实例的当前握手状态。

    off

    移除默认 SDK 实例的事件监听。

    on

    注册默认 SDK 实例的事件监听。

    onHandshakeStateChange

    订阅默认 SDK 实例的握手状态,并立即接收当前状态。