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

    变量 MINI_PROGRAM_PROTOCOL_CAPABILITIES常量

    MINI_PROGRAM_PROTOCOL_CAPABILITIES: readonly (
        | {
            capability: | "gameSaves.list"
            | "gameSaves.sync"
            | "gameSaves.getFile"
            | "gameSaves.readParsedData";
            method: | "gameSaves.list"
            | "gameSaves.sync"
            | "gameSaves.getFile"
            | "gameSaves.readParsedData";
            module: "gameSaves";
            requirement: { kind: "all"; permissions: readonly ["gameSaves"] };
            risk: "high";
        }
        | {
            capability: | "companion.getInfo"
            | "companion.getPreparationStatus"
            | "companion.prepare"
            | "companion.cancelPreparation"
            | "companion.getActiveSession"
            | "companion.launch"
            | "companion.session.write"
            | "companion.session.closeStdin"
            | "companion.session.terminate"
            | "companion.session.ackOutput"
            | "companion.openAttachment"
            | "companion.showNotification";
            method: | "companion.getInfo"
            | "companion.getPreparationStatus"
            | "companion.prepare"
            | "companion.cancelPreparation"
            | "companion.getActiveSession"
            | "companion.launch"
            | "companion.session.write"
            | "companion.session.closeStdin"
            | "companion.session.terminate"
            | "companion.session.ackOutput"
            | "companion.openAttachment"
            | "companion.showNotification";
            module: "companion";
            requirement: { kind: "all"; permissions: "companion"[] };
            risk: "high";
        }
        | {
            capability: "workspaceCards.requestRefresh";
            method: "workspaceCards.requestRefresh";
            module: "workspaceCards";
            requirement: { kind: "all"; permissions: readonly ["workspaceCards"] };
            risk: "high";
        }
        | {
            capability: "auth.getAccountState";
            method: "auth.getAccountState";
            module: "auth";
            requirement: { kind: "none"; permissions?: undefined };
            risk: "low";
        }
        | {
            capability: "auth.login";
            method: "auth.login";
            module: "auth";
            requirement: { kind: "all"; permissions: readonly ["userInfo"] };
            risk: "medium";
        }
        | {
            capability: "user.getFollowStatus";
            method: "user.getFollowStatus";
            module: "user";
            requirement: { kind: "none"; permissions?: undefined };
            risk: "low";
        }
        | {
            capability: "user.requestFollowAuthor";
            method: "user.requestFollowAuthor";
            module: "user";
            requirement: { kind: "none"; permissions?: undefined };
            risk: "high";
        }
        | {
            capability: "user.getInfo";
            method: "user.getInfo";
            module: "user";
            requirement: { kind: "all"; permissions: readonly ["userInfo"] };
            risk: "medium";
        }
        | {
            capability: "user.revokeAuthorization";
            method: "user.revokeAuthorization";
            module: "user";
            requirement: { kind: "none"; permissions?: undefined };
            risk: "high";
        }
        | {
            capability: "user.getSteamGameList";
            method: "user.getSteamGameList";
            module: "user";
            requirement: { kind: "all"; permissions: readonly ["steamLibrary"] };
            risk: "high";
        }
        | {
            capability: "share.copyLink";
            method: "share.copyLink";
            module: "share";
            requirement: { kind: "all"; permissions: readonly ["share"] };
            risk: "medium";
        }
        | {
            capability: "share.showShareMenu";
            method: "share.showShareMenu";
            module: "share";
            requirement: { kind: "all"; permissions: readonly ["share"] };
            risk: "low";
        }
        | {
            capability: "share.screenshot";
            method: "share.screenshot";
            module: "share";
            requirement: { kind: "all"; permissions: readonly ["share"] };
            risk: "medium";
        }
        | {
            capability: "viewport.getWindowInfo";
            method: "viewport.getWindowInfo";
            module: "viewport";
            requirement: { kind: "none"; permissions?: undefined };
            risk: "low";
        }
        | {
            capability: "viewport.setNavigationBarStyle";
            method: "viewport.setNavigationBarStyle";
            module: "viewport";
            requirement: { kind: "none"; permissions?: undefined };
            risk: "low";
        }
        | {
            capability: "viewport.setDisplay";
            method: "viewport.setDisplay";
            module: "viewport";
            requirement: { kind: "none"; permissions?: undefined };
            risk: "low";
        }
        | {
            capability: "storage.getStorage";
            method: "storage.getStorage";
            module: "storage";
            requirement: { kind: "all"; permissions: readonly ["storage"] };
            risk: "low";
        }
        | {
            capability: "storage.setStorage";
            method: "storage.setStorage";
            module: "storage";
            requirement: { kind: "all"; permissions: readonly ["storage"] };
            risk: "medium";
        }
        | {
            capability: "network.request";
            method: "network.request";
            module: "network";
            requirement: { kind: "all"; permissions: readonly ["network"] };
            risk: "high";
        }
        | {
            capability: "network.download";
            method: "network.download";
            module: "network";
            requirement: {
                kind: "all";
                permissions: readonly ["network", "filesystem"];
            };
            risk: "high";
        }
        | {
            capability: "network.upload";
            method: "network.upload";
            module: "network";
            requirement: {
                kind: "all";
                permissions: readonly ["network", "filesystem"];
            };
            risk: "high";
        }
        | {
            capability: "files.pickFiles";
            method: "files.pickFiles";
            module: "files";
            requirement: { kind: "all"; permissions: readonly ["filesystem"] };
            risk: "high";
        }
        | {
            capability: "files.pickDirectory";
            method: "files.pickDirectory";
            module: "files";
            requirement: { kind: "all"; permissions: readonly ["filesystem"] };
            risk: "high";
        }
        | {
            capability: "files.saveFile";
            method: "files.saveFile";
            module: "files";
            requirement: { kind: "all"; permissions: readonly ["filesystem"] };
            risk: "high";
        }
        | {
            capability: "file.create";
            method: "file.create";
            module: "file";
            requirement: { kind: "all"; permissions: readonly ["filesystem"] };
            risk: "high";
        }
        | {
            capability: "file.remove";
            method: "file.remove";
            module: "file";
            requirement: { kind: "all"; permissions: readonly ["filesystem"] };
            risk: "high";
        }
        | {
            capability: "file.exists";
            method: "file.exists";
            module: "file";
            requirement: { kind: "all"; permissions: readonly ["filesystem"] };
            risk: "high";
        }
        | {
            capability: "file.readText";
            method: "file.readText";
            module: "file";
            requirement: { kind: "all"; permissions: readonly ["filesystem"] };
            risk: "high";
        }
        | {
            capability: "file.writeText";
            method: "file.writeText";
            module: "file";
            requirement: { kind: "all"; permissions: readonly ["filesystem"] };
            risk: "high";
        }
        | {
            capability: "file.readBytes";
            method: "file.readBytes";
            module: "file";
            requirement: { kind: "all"; permissions: readonly ["filesystem"] };
            risk: "high";
        }
        | {
            capability: "file.writeBytes";
            method: "file.writeBytes";
            module: "file";
            requirement: { kind: "all"; permissions: readonly ["filesystem"] };
            risk: "high";
        }
        | {
            capability: "file.stat";
            method: "file.stat";
            module: "file";
            requirement: { kind: "all"; permissions: readonly ["filesystem"] };
            risk: "high";
        }
        | {
            capability: "directory.create";
            method: "directory.create";
            module: "directory";
            requirement: { kind: "all"; permissions: readonly ["filesystem"] };
            risk: "high";
        }
        | {
            capability: "directory.remove";
            method: "directory.remove";
            module: "directory";
            requirement: { kind: "all"; permissions: readonly ["filesystem"] };
            risk: "high";
        }
        | {
            capability: "directory.exists";
            method: "directory.exists";
            module: "directory";
            requirement: { kind: "all"; permissions: readonly ["filesystem"] };
            risk: "high";
        }
        | {
            capability: "directory.list";
            method: "directory.list";
            module: "directory";
            requirement: { kind: "all"; permissions: readonly ["filesystem"] };
            risk: "high";
        }
        | {
            capability: "media.pick";
            method: "media.pick";
            module: "media";
            requirement: { kind: "all"; permissions: readonly ["media"] };
            risk: "high";
        }
        | {
            capability: "ui.showToast";
            method: "ui.showToast";
            module: "ui";
            requirement: { kind: "none"; permissions?: undefined };
            risk: "low";
        }
        | {
            capability: "ui.showLoading";
            method: "ui.showLoading";
            module: "ui";
            requirement: { kind: "none"; permissions?: undefined };
            risk: "low";
        }
        | {
            capability: "ui.hideLoading";
            method: "ui.hideLoading";
            module: "ui";
            requirement: { kind: "none"; permissions?: undefined };
            risk: "low";
        }
        | {
            capability: "device.vibrate";
            method: "device.vibrate";
            module: "device";
            requirement: { kind: "none"; permissions?: undefined };
            risk: "low";
        }
        | {
            capability: "device.setClipboard";
            method: "device.setClipboard";
            module: "device";
            requirement: { kind: "all"; permissions: readonly ["clipboard"] };
            risk: "medium";
        }
        | {
            capability: "device.executeProtocol";
            method: "device.executeProtocol";
            module: "device";
            requirement: { kind: "all"; permissions: readonly ["appProtocol"] };
            risk: "high";
        }
        | {
            capability: "navigation.close";
            method: "navigation.close";
            module: "navigation";
            requirement: { kind: "none"; permissions?: undefined };
            risk: "medium";
        }
        | {
            capability: "navigation.reload";
            method: "navigation.reload";
            module: "navigation";
            requirement: { kind: "none"; permissions?: undefined };
            risk: "medium";
        }
        | {
            capability: "navigation.openAppPage";
            method: "navigation.openAppPage";
            module: "navigation";
            requirement: { kind: "none"; permissions?: undefined };
            risk: "medium";
        }
        | {
            capability: "cloud.leaderboard.submit";
            method: "cloud.leaderboard.submit";
            module: "cloud";
            requirement: { kind: "all"; permissions: readonly ["leaderboard"] };
            risk: "medium";
        }
        | {
            capability: "cloud.leaderboard.getList";
            method: "cloud.leaderboard.getList";
            module: "cloud";
            requirement: { kind: "all"; permissions: readonly ["leaderboard"] };
            risk: "low";
        }
        | {
            capability: "cloud.leaderboard.getCurrentUserEntry";
            method: "cloud.leaderboard.getCurrentUserEntry";
            module: "cloud";
            requirement: { kind: "all"; permissions: readonly ["leaderboard"] };
            risk: "medium";
        }
        | {
            capability: "cloud.leaderboard.deleteCurrentUserEntry";
            method: "cloud.leaderboard.deleteCurrentUserEntry";
            module: "cloud";
            requirement: { kind: "all"; permissions: readonly ["leaderboard"] };
            risk: "medium";
        }
        | {
            capability: "cloud.leaderboard.getInfo";
            method: "cloud.leaderboard.getInfo";
            module: "cloud";
            requirement: { kind: "all"; permissions: readonly ["leaderboard"] };
            risk: "low";
        }
        | {
            capability: "cloud.storage.getStorage";
            method: "cloud.storage.getStorage";
            module: "cloud";
            requirement: { kind: "all"; permissions: readonly ["cloud_storage"] };
            risk: "low";
        }
        | {
            capability: "cloud.storage.setStorage";
            method: "cloud.storage.setStorage";
            module: "cloud";
            requirement: { kind: "all"; permissions: readonly ["cloud_storage"] };
            risk: "medium";
        }
        | {
            capability: "cloud.storage.removeItem";
            method: "cloud.storage.removeItem";
            module: "cloud";
            requirement: { kind: "all"; permissions: readonly ["cloud_storage"] };
            risk: "medium";
        }
        | {
            capability: "cloud.storage.getKeys";
            method: "cloud.storage.getKeys";
            module: "cloud";
            requirement: { kind: "all"; permissions: readonly ["cloud_storage"] };
            risk: "low";
        }
    )[] = ...

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

    Host Runtime、文档生成器和一致性测试使用该目录判断 method 是否属于协议、由哪个 module 持有,以及调用前需要满足哪些声明权限。每个 MiniProgramBridgeMethod 必须且只能出现 一次;消费者不应另建 method、module、requirement 或 risk 的平行目录。

    该目录只拥有 method metadata。精确 payload/result 类型分别由 MiniProgramCapabilityPayloadMap 与 MiniProgramCapabilityResultMap 定义,权限的 展示名称、配置字段和平台审批属性由 MINI_PROGRAM_PERMISSION_CATALOG 定义。kind: 'none' 仅表示无需 Manifest 权限声明,不表示绕过参数校验、Host 能力、可信手势或业务策略。