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

    模块 protocol

    接口

    DeleteCurrentUserLeaderboardEntryPayload
    DeleteCurrentUserLeaderboardEntryResult
    DirectoryCreatePayload
    DirectoryExistsPayload
    DirectoryListPayload
    DirectoryRemovePayload
    DownloadProgressPayload
    FileCreatePayload
    FileExistsPayload
    FileReadBytesPayload
    FileReadTextPayload
    FileRemovePayload
    FileStatPayload
    FileWriteBytesPayload
    FileWriteTextPayload
    GetCurrentUserLeaderboardEntryPayload
    GetLeaderboardInfoPayload
    GetLeaderboardInfoResult
    GetLeaderboardListPayload
    GetLeaderboardListResult
    GetStoragePayload
    GetStorageResult
    LeaderboardEntry
    LoginResult
    MediaPickImageItem

    media.pick 的图片结果;不携带 durationMs。

    MediaPickItemBase

    media.pick 单项结果的公共字段。

    MediaPickPayload

    media.pick 的 wire payload;省略时使用全部默认值。

    MediaPickVideoItem

    media.pick 的视频结果。

    MiniProgramBridgeCancelMessage

    SDK 与 Host Runtime 跨 iframe 传输时共用的顶层 bridge envelope。

    MiniProgramBridgeError
    MiniProgramBridgeMessage

    SDK 与 Host Runtime 跨 iframe 传输时共用的顶层 bridge envelope。

    MiniProgramBridgeProgressMessage

    SDK 与 Host Runtime 跨 iframe 传输时共用的顶层 bridge envelope。

    MiniProgramCapabilityDefinition

    单个公开 bridge method 的机器可读协议元数据。

    MiniProgramCapabilityPayloadMap
    MiniProgramCapabilityResultMap
    MiniProgramDirectDirectoryRef
    MiniProgramDirectFileRef
    MiniProgramDirectoryDescriptor
    MiniProgramFileDescriptor
    MiniProgramFileStat
    MiniProgramRuntimeEnvironmentInfo

    Runtime 在握手期间下发的环境快照。

    MiniProgramRuntimePermissionEntry
    MiniProgramRuntimePermissionsSnapshot
    MiniProgramSafeArea
    MiniProgramSandboxRootRef
    MiniProgramScreenshotRect
    MiniProgramSharePostOptions

    社区发帖页的可编辑分区与话题预置。

    MiniProgramWindowInfoResult
    NetworkRequestPayload
    NetworkResponsePayload
    ParsedMiniProgramRuntimePermissions

    parseMiniProgramRuntimePermissions() 返回的独立 canonical 视图。

    SaveFilePayload
    SDKHandshakePayload
    SDKHandshakeResult

    Runtime 对 SDK 握手的可选扩展响应。

    SetClipboardPayload
    SetStoragePayload
    ShowLoadingPayload
    ShowToastPayload
    SteamGameListData

    Steam 游戏库的 offset 分页结果。

    SteamGameListItem

    经过 Host Runtime 规范化的 Steam 游戏条目;无效必填字段会导致整条记录被移除。

    SubmitLeaderboardEntryPayload
    UploadProgressPayload

    上传进度只统计文件内容,不包含 multipart 边界与文本字段。

    VibratePayload

    类型别名

    ClosePayload

    navigation.close 的无参 wire payload。

    CloseResult

    Host 接受关闭请求后的 wire 结果为 undefined。

    CopyLinkPayload
    CopyLinkResult
    DirectoryCreateResult
    DirectoryExistsResult
    DirectoryListResult
    DirectoryRemoveResult
    FileCreateResult
    FileExistsResult
    FileReadBytesResult
    FileReadTextResult
    FileRemoveResult
    FileStatResult
    FileWriteBytesResult
    FileWriteTextResult
    GetAccountStatePayload

    静默读取当前账号,不接收页面提供的小程序或用户身份。

    GetCurrentUserLeaderboardEntryResult
    GetSteamGameListPayload

    user.getSteamGameList 的可选 wire payload;undefined 使用全部默认查询值。

    GetSteamGameListResult

    user.getSteamGameList 的判别联合结果。

    GetUserInfoPayload

    user.getInfo 不接收入参,也不能由页面指定小程序或用户身份。

    GetUserInfoResult

    user.getInfo 的判别联合返回值;先判断 isHeyboxAppLoggedIn,再判断 userInfo。

    GetWindowInfoPayload
    GetWindowInfoResult
    HideLoadingPayload
    HideLoadingResult
    LeaderboardOrder
    LoginPayload
    LoginScope

    登录请求使用与用户信息授权相同的 canonical scope。

    MediaPickItem

    media.pick 的单项结果判别联合。

    MediaPickResult

    media.pick 的 wire 结果。

    MiniProgramAuthMethod
    MiniProgramBridgeMessageType
    MiniProgramBridgeMethod
    MiniProgramCapabilityModule
    MiniProgramCapabilityPayload
    MiniProgramCapabilityResult
    MiniProgramCapabilityRisk
    MiniProgramCloudMethod
    MiniProgramDeviceMethod
    MiniProgramDirectoryMethod
    MiniProgramDirectoryRef
    MiniProgramFileMethod
    MiniProgramFileMode
    MiniProgramFileRef
    MiniProgramFilesMethod
    MiniProgramFileSystemEntityDescriptor
    MiniProgramFileSystemEntityRef
    MiniProgramMediaMethod
    MiniProgramMediaSelectionType

    media.pick 允许选择的媒体类型。

    MiniProgramMediaSource

    media.pick 的媒体来源。

    MiniProgramNavigationBarForegroundStyle
    MiniProgramNavigationMethod
    MiniProgramNetworkHeaders
    MiniProgramNetworkMethod
    MiniProgramNetworkParams
    MiniProgramNetworkRequestMethod
    MiniProgramPathRootRef
    MiniProgramRuntimePermissionStatus
    MiniProgramShareChannel

    公开分享渠道;Host 可以只支持其中一部分,值区分大小写。

    MiniProgramShareMethod
    MiniProgramStorageMethod
    MiniProgramToastStatus
    MiniProgramUiMethod
    MiniProgramUserMethod
    MiniProgramVibrateIntensity
    MiniProgramViewportMethod
    NetworkDownloadPayload
    NetworkDownloadResult
    NetworkUploadPayload
    OpenAppPagePayload

    navigation.openAppPage 的判别联合 wire payload。

    OpenAppPageResult

    Host 接收参数并发起受控路由后的结果为 undefined。

    OpenGameDetailAppPagePayload

    打开游戏详情页的规范化 wire payload。

    OpenMiniProgramAppPagePayload

    打开另一个公开发布小程序的 wire payload;目标版本与访问性由 Host 决定。

    OpenPostDetailAppPagePayload

    打开帖子详情页的规范化 wire payload。

    OpenUserDetailAppPagePayload

    打开用户详情页的规范化 wire payload。

    PickDirectoryPayload
    PickDirectoryResult
    PickFilesPayload
    PickFilesResult
    ReloadPayload

    navigation.reload 的无参 wire payload。

    ReloadResult

    Host 接受 reload 请求后的 wire 结果为 undefined。

    RevokeAuthorizationPayload

    user.revokeAuthorization 不接受 wire payload。

    RevokeAuthorizationResult

    撤销成功后的 wire 结果为 undefined。

    SaveFileResult
    ScreenshotPayload
    ScreenshotResult
    SetClipboardResult
    SetNavigationBarStylePayload
    SetNavigationBarStyleResult
    ShowLoadingResult
    ShowShareMenuPayload

    share.showShareMenu 的 wire payload;落地页由 Runtime 固定生成,不接受 url 字段。

    ShowShareMenuResult

    Host 分享面板返回的不透明值。

    ShowToastResult
    SteamGameListSort

    Steam 游戏库排序维度:weeks 按最近两周时长,all 按累计时长,achieved 按成就数。

    SubmitLeaderboardEntryResult
    VibrateResult

    变量

    AUTH_GET_ACCOUNT_STATE_METHOD
    AUTH_LOGIN_METHOD
    CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD
    CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD
    CLOUD_LEADERBOARD_GET_INFO_METHOD
    CLOUD_LEADERBOARD_GET_LIST_METHOD
    CLOUD_LEADERBOARD_SUBMIT_METHOD
    CLOUD_STORAGE_GET_KEYS_METHOD
    CLOUD_STORAGE_GET_STORAGE_METHOD
    CLOUD_STORAGE_REMOVE_ITEM_METHOD
    CLOUD_STORAGE_SET_STORAGE_METHOD
    DEVICE_EXECUTE_PROTOCOL_METHOD
    DEVICE_SET_CLIPBOARD_METHOD
    DEVICE_VIBRATE_METHOD
    DIRECTORY_CREATE_METHOD
    DIRECTORY_EXISTS_METHOD
    DIRECTORY_LIST_METHOD
    DIRECTORY_REMOVE_METHOD
    FILE_CREATE_METHOD
    FILE_EXISTS_METHOD
    FILE_READ_BYTES_METHOD
    FILE_READ_TEXT_METHOD
    FILE_REMOVE_METHOD
    FILE_STAT_METHOD
    FILE_WRITE_BYTES_METHOD
    FILE_WRITE_TEXT_METHOD
    FILES_PICK_DIRECTORY_METHOD
    FILES_PICK_FILES_METHOD
    FILES_SAVE_FILE_METHOD
    MEDIA_PICK_METHOD
    MINI_PROGRAM_BRIDGE_NONCE_PARAM

    Runtime 在 iframe URL 中传递 bridge nonce 的 query 参数名。

    MINI_PROGRAM_MESSAGE_NAMESPACE

    所有小程序 iframe bridge envelope 共用的固定 namespace。

    MINI_PROGRAM_MESSAGE_VERSION

    新消息默认发送的当前 bridge wire 版本。

    MINI_PROGRAM_OPERATION_PROGRESS_METHOD
    MINI_PROGRAM_PROTOCOL_CAPABILITIES

    所有公开小程序 bridge method 的权威 method-level 目录。

    NETWORK_DOWNLOAD_METHOD
    NETWORK_REQUEST_METHOD
    NETWORK_UPLOAD_METHOD
    SDK_HANDSHAKE_METHOD

    SDK 发起 bridge 握手时使用的保留 method。

    SHARE_SCREENSHOT_METHOD
    SHARE_SHOW_SHARE_MENU_METHOD
    STORAGE_GET_STORAGE_METHOD
    STORAGE_SET_STORAGE_METHOD
    UI_HIDE_LOADING_METHOD
    UI_SHOW_LOADING_METHOD
    UI_SHOW_TOAST_METHOD
    USER_GET_FOLLOW_STATUS_METHOD
    USER_GET_INFO_METHOD
    USER_GET_STEAM_GAME_LIST_METHOD
    USER_REQUEST_FOLLOW_AUTHOR_METHOD
    USER_REVOKE_AUTHORIZATION_METHOD
    VIEWPORT_GET_WINDOW_INFO_METHOD
    VIEWPORT_SET_DISPLAY_METHOD
    VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD

    函数

    isManagedMiniProgramRuntimePermissionKey

    判断字符串是否是当前协议目录管理的 canonical runtime permission key。

    isMiniProgramBridgeMessage

    判断不可信输入是否具有受支持的小程序 bridge 消息结构。

    isMiniProgramByteArray

    判断未知值是否为使用普通 ArrayBuffer 存储的 Uint8Array 字节视图。

    isMiniProgramDirectoryDescriptor

    判断未知值是否具有目录 descriptor 的精确 wire 结构。

    isMiniProgramDirectoryRef

    判断未知值是否为 direct handle 或 path-derived 目录引用。

    isMiniProgramDownloadProgressPayload

    判断未知值是否为单个 network.download 进度 payload。

    isMiniProgramFileDescriptor

    判断未知值是否具有文件 descriptor 的最低 wire 结构。

    isMiniProgramFileRef

    判断未知值是否为 direct handle 或 path-derived 文件引用。

    isMiniProgramFileStat

    判断未知值是否具有文件元数据快照的最低 wire 结构。

    isMiniProgramFileSystemEntityDescriptor

    判断未知值是否为文件或目录 descriptor。

    isMiniProgramMediaPickItem

    判断未知值是否为单个 media.pick 媒体项。

    isMiniProgramMediaPickPayload

    判断未知值是否具有 media.pick payload 的最低 wire 结构。

    isMiniProgramMediaPickResult

    判断未知值是否为整批 media.pick 结果。

    isMiniProgramPathRootRef

    判断未知值是否可作为 derived file/directory ref 的逻辑路径 root。

    isMiniProgramRelativePath

    判断未知值是否为以 / 分隔的规范逻辑相对路径。

    parseMiniProgramRuntimePermissions

    将不可信的 schema v1 runtime permission snapshot 解析为独立的 canonical 权限映射。