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

    接口 MiniProgramCapabilityPayloadMap

    interface MiniProgramCapabilityPayloadMap {
        "auth.getAccountState": void;
        "auth.login": LoginPayload;
        "cloud.leaderboard.deleteCurrentUserEntry":
            | DeleteCurrentUserLeaderboardEntryPayload
            | undefined;
        "cloud.leaderboard.getCurrentUserEntry": | GetCurrentUserLeaderboardEntryPayload
        | undefined;
        "cloud.leaderboard.getInfo": GetLeaderboardInfoPayload
        | undefined;
        "cloud.leaderboard.getList": GetLeaderboardListPayload | undefined;
        "cloud.leaderboard.submit": SubmitLeaderboardEntryPayload;
        "cloud.storage.getKeys": Record<string, never> | undefined;
        "cloud.storage.getStorage": { key: string };
        "cloud.storage.removeItem": { key: string };
        "cloud.storage.setStorage": { key: string; value: string };
        "companion.cancelPreparation": CompanionAliasPayload;
        "companion.getActiveSession": CompanionAliasPayload;
        "companion.getInfo": CompanionAliasPayload;
        "companion.getPreparationStatus": CompanionAliasPayload;
        "companion.launch": CompanionAliasPayload;
        "companion.openAttachment": CompanionOpenAttachmentPayload;
        "companion.prepare": CompanionAliasPayload;
        "companion.session.ackOutput": CompanionSessionAckOutputPayload;
        "companion.session.closeStdin": CompanionSessionControllerPayload;
        "companion.session.terminate": CompanionSessionControllerPayload;
        "companion.session.write": CompanionSessionWritePayload;
        "companion.showNotification": CompanionShowNotificationPayload;
        "device.executeProtocol": ExecuteProtocolInput;
        "device.setClipboard": SetClipboardPayload;
        "device.vibrate": VibratePayload;
        "directory.create": DirectoryCreatePayload;
        "directory.exists": DirectoryExistsPayload;
        "directory.list": DirectoryListPayload;
        "directory.remove": DirectoryRemovePayload;
        "file.create": FileCreatePayload;
        "file.exists": FileExistsPayload;
        "file.readBytes": FileReadBytesPayload;
        "file.readText": FileReadTextPayload;
        "file.remove": FileRemovePayload;
        "file.stat": FileStatPayload;
        "file.writeBytes": FileWriteBytesPayload;
        "file.writeText": FileWriteTextPayload;
        "files.pickDirectory": PickDirectoryPayload;
        "files.pickFiles": PickFilesPayload;
        "files.saveFile": SaveFilePayload;
        "gameSaves.getFile": GameSavesFileOptions;
        "gameSaves.list": GameSavesListOptions;
        "gameSaves.readParsedData": GameSavesReadParsedDataOptions;
        "gameSaves.sync": GameSavesSyncOptions;
        "media.pick": MediaPickPayload | undefined;
        "navigation.close": void;
        "navigation.openAppPage": OpenAppPagePayload;
        "navigation.reload": void;
        "network.download": NetworkDownloadPayload;
        "network.request": NetworkRequestPayload;
        "network.upload": NetworkUploadPayload;
        "share.copyLink": CopyLinkPayload;
        "share.screenshot": ScreenshotPayload;
        "share.showShareMenu": ShowShareMenuPayload;
        "storage.getStorage": GetStoragePayload;
        "storage.setStorage": SetStoragePayload;
        "ui.hideLoading": void;
        "ui.showLoading": ShowLoadingPayload;
        "ui.showToast": ShowToastPayload;
        "user.getFollowStatus": void;
        "user.getInfo": void;
        "user.getSteamGameList": GetSteamGameListPayload;
        "user.requestFollowAuthor": void;
        "user.revokeAuthorization": void;
        "viewport.getWindowInfo": void;
        "viewport.setDisplay": SetDisplayPayload;
        "viewport.setNavigationBarStyle": SetNavigationBarStylePayload;
        "workspaceCards.requestRefresh": WorkspaceCardsRefreshOptions;
    }
    索引

    属性

    "auth.getAccountState": void
    "auth.login": LoginPayload
    "cloud.leaderboard.deleteCurrentUserEntry":
        | DeleteCurrentUserLeaderboardEntryPayload
        | undefined
    "cloud.leaderboard.getCurrentUserEntry":
        | GetCurrentUserLeaderboardEntryPayload
        | undefined
    "cloud.leaderboard.getInfo": GetLeaderboardInfoPayload | undefined
    "cloud.leaderboard.getList": GetLeaderboardListPayload | undefined
    "cloud.leaderboard.submit": SubmitLeaderboardEntryPayload
    "cloud.storage.getKeys": Record<string, never> | undefined
    "cloud.storage.getStorage": { key: string }
    "cloud.storage.removeItem": { key: string }
    "cloud.storage.setStorage": { key: string; value: string }
    "companion.cancelPreparation": CompanionAliasPayload
    "companion.getActiveSession": CompanionAliasPayload
    "companion.getInfo": CompanionAliasPayload
    "companion.getPreparationStatus": CompanionAliasPayload
    "companion.launch": CompanionAliasPayload
    "companion.openAttachment": CompanionOpenAttachmentPayload
    "companion.prepare": CompanionAliasPayload
    "companion.session.ackOutput": CompanionSessionAckOutputPayload
    "companion.session.closeStdin": CompanionSessionControllerPayload
    "companion.session.terminate": CompanionSessionControllerPayload
    "companion.session.write": CompanionSessionWritePayload
    "companion.showNotification": CompanionShowNotificationPayload
    "device.executeProtocol": ExecuteProtocolInput
    "device.setClipboard": SetClipboardPayload
    "device.vibrate": VibratePayload
    "directory.create": DirectoryCreatePayload
    "directory.exists": DirectoryExistsPayload
    "directory.list": DirectoryListPayload
    "directory.remove": DirectoryRemovePayload
    "file.create": FileCreatePayload
    "file.exists": FileExistsPayload
    "file.readBytes": FileReadBytesPayload
    "file.readText": FileReadTextPayload
    "file.remove": FileRemovePayload
    "file.stat": FileStatPayload
    "file.writeBytes": FileWriteBytesPayload
    "file.writeText": FileWriteTextPayload
    "files.pickDirectory": PickDirectoryPayload
    "files.pickFiles": PickFilesPayload
    "files.saveFile": SaveFilePayload
    "gameSaves.getFile": GameSavesFileOptions
    "gameSaves.list": GameSavesListOptions
    "gameSaves.readParsedData": GameSavesReadParsedDataOptions
    "gameSaves.sync": GameSavesSyncOptions
    "media.pick": MediaPickPayload | undefined
    "navigation.close": void
    "navigation.openAppPage": OpenAppPagePayload
    "navigation.reload": void
    "network.download": NetworkDownloadPayload
    "network.request": NetworkRequestPayload
    "network.upload": NetworkUploadPayload
    "share.copyLink": CopyLinkPayload
    "share.screenshot": ScreenshotPayload
    "share.showShareMenu": ShowShareMenuPayload
    "storage.getStorage": GetStoragePayload
    "storage.setStorage": SetStoragePayload
    "ui.hideLoading": void
    "ui.showLoading": ShowLoadingPayload
    "ui.showToast": ShowToastPayload
    "user.getFollowStatus": void
    "user.getInfo": void
    "user.getSteamGameList": GetSteamGameListPayload
    "user.requestFollowAuthor": void
    "user.revokeAuthorization": void
    "viewport.getWindowInfo": void
    "viewport.setDisplay": SetDisplayPayload
    "viewport.setNavigationBarStyle": SetNavigationBarStylePayload
    "workspaceCards.requestRefresh": WorkspaceCardsRefreshOptions