From 6eb9cbb187956954047c1af33e33f5e82be8ea56 Mon Sep 17 00:00:00 2001 From: Caelan Sayler Date: Sun, 17 Mar 2024 12:20:18 +0000 Subject: [PATCH] remove all the translations because crowdin MT is not good. --- .github/workflows/daily.yml | 58 --- crowdin.yml | 12 - daily-tasks.mjs | 47 -- dfmg.yaml | 2 - docusaurus.config.ts | 29 +- i18n/de/code.json | 324 ------------ .../options.json | 14 - .../current.json | 130 ----- .../current/contributing/compiling.mdx | 71 --- .../current/distributing/deploy-cli.mdx | 43 -- .../current/distributing/github-actions.mdx | 109 ---- .../current/distributing/overview.mdx | 98 ---- .../current/getting-started/cpp.mdx | 85 --- .../current/getting-started/csharp.mdx | 48 -- .../current/getting-started/electron.mdx | 79 --- .../current/getting-started/fusion-cli.mdx | 128 ----- .../current/getting-started/rust.mdx | 72 --- .../current/index.mdx | 57 --- .../current/integrating/hooks.mdx | 31 -- .../current/integrating/overview.mdx | 132 ----- .../current/integrating/preserved-files.mdx | 22 - .../current/integrating/release-notes.mdx | 23 - .../current/integrating/shortcuts.mdx | 19 - .../integrating/switching-channels.mdx | 30 -- .../current/migrating/squirrel.mdx | 70 --- .../current/packaging/bootstrapping.mdx | 86 ---- .../current/packaging/channels.mdx | 41 -- .../current/packaging/deltas.mdx | 47 -- .../current/packaging/installer.mdx | 52 -- .../packaging/operating-systems/linux.mdx | 48 -- .../packaging/operating-systems/macos.mdx | 37 -- .../packaging/operating-systems/windows.mdx | 61 --- .../current/packaging/overview.mdx | 77 --- .../current/packaging/rid.mdx | 26 - .../current/packaging/signing.mdx | 194 ------- .../current/reference/cpp/api.md | 428 ---------------- .../ChecksumFailedException.md | 30 -- .../Velopack.Compression.md | 8 - .../cs/Velopack.Locators/IVelopackLocator.md | 101 ---- .../Velopack.Locators/LinuxVelopackLocator.md | 92 ---- .../Velopack.Locators/OsxVelopackLocator.md | 74 --- .../Velopack.Locators/TestVelopackLocator.md | 81 --- .../cs/Velopack.Locators/Velopack.Locators.md | 23 - .../cs/Velopack.Locators/VelopackLocator.md | 153 ------ .../WindowsVelopackLocator.md | 66 --- .../cs/Velopack.NuGet/PackageManifest.md | 196 ------- .../cs/Velopack.NuGet/Velopack.NuGet.md | 12 - .../reference/cs/Velopack.NuGet/ZipPackage.md | 52 -- .../cs/Velopack.NuGet/ZipPackageFile.md | 132 ----- .../GitBase`T`.GitBaseAsset.md | 30 -- .../cs/Velopack.Sources/GitBase`T`.md | 143 ------ .../cs/Velopack.Sources/GithubRelease.md | 38 -- .../cs/Velopack.Sources/GithubReleaseAsset.md | 42 -- .../cs/Velopack.Sources/GithubSource.md | 80 --- .../cs/Velopack.Sources/GitlabRelease.md | 38 -- .../cs/Velopack.Sources/GitlabReleaseAsset.md | 26 - .../cs/Velopack.Sources/GitlabReleaseLink.md | 41 -- .../cs/Velopack.Sources/GitlabSource.md | 63 --- .../HttpClientFileDownloader.md | 141 ----- .../cs/Velopack.Sources/IFileDownloader.md | 75 --- .../cs/Velopack.Sources/IUpdateSource.md | 67 --- .../cs/Velopack.Sources/SimpleFileSource.md | 79 --- .../cs/Velopack.Sources/SimpleWebSource.md | 87 ---- .../cs/Velopack.Sources/Velopack.Sources.md | 43 -- .../VelopackFlowUpdateSource.md | 83 --- .../FileIcon.SHGetFileInfoConstants.md | 116 ----- .../reference/cs/Velopack.Windows/FileIcon.md | 48 -- .../Velopack.Windows/Runtimes.DotnetInfo.md | 190 ------- .../Runtimes.DotnetRuntimeType.md | 32 -- .../Runtimes.FrameworkInfo.md | 59 --- .../Velopack.Windows/Runtimes.RuntimeInfo.md | 119 ----- .../Runtimes.RuntimeInstallResult.md | 44 -- .../Velopack.Windows/Runtimes.VCRedist00.md | 33 -- .../Velopack.Windows/Runtimes.VCRedist14.md | 26 - .../Velopack.Windows/Runtimes.VCRedistInfo.md | 52 -- .../reference/cs/Velopack.Windows/Runtimes.md | 283 ---------- .../ShellLink.EShellLinkResolveFlags.md | 87 ---- .../ShellLink.LinkDisplayMode.md | 31 -- .../Velopack.Windows/ShellLink.PROPERTYKEY.md | 38 -- .../Velopack.Windows/ShellLink.PropVariant.md | 84 --- .../cs/Velopack.Windows/ShellLink.md | 211 -------- .../cs/Velopack.Windows/ShortcutLocation.md | 45 -- .../cs/Velopack.Windows/Shortcuts.md | 145 ------ .../cs/Velopack.Windows/Velopack.Windows.md | 46 -- .../current/reference/cs/Velopack/RID.md | 153 ------ .../reference/cs/Velopack/ReleaseEntry.md | 287 ----------- .../reference/cs/Velopack/ReleaseEntryName.md | 70 --- .../cs/Velopack/ReleaseNotesFormat.md | 27 - .../reference/cs/Velopack/RidDisplayType.md | 31 -- .../reference/cs/Velopack/RuntimeCpu.md | 38 -- .../reference/cs/Velopack/RuntimeOs.md | 41 -- .../reference/cs/Velopack/RuntimeVersion.md | 117 ----- .../reference/cs/Velopack/UpdateExe.md | 43 -- .../reference/cs/Velopack/UpdateInfo.md | 42 -- .../reference/cs/Velopack/UpdateManager.md | 279 ---------- .../reference/cs/Velopack/UpdateOptions.md | 34 -- .../current/reference/cs/Velopack/Velopack.md | 50 -- .../reference/cs/Velopack/VelopackApp.md | 209 -------- .../reference/cs/Velopack/VelopackAsset.md | 107 ---- .../cs/Velopack/VelopackAssetFeed.md | 45 -- .../cs/Velopack/VelopackAssetType.md | 26 - .../reference/cs/Velopack/VelopackHook.md | 13 - .../cs/Velopack/VelopackRuntimeInfo.md | 111 ---- .../current/reference/index.mdx | 9 - .../current/reference/js/classes/JsonNode.md | 301 ----------- .../reference/js/classes/UpdateInfo.md | 61 --- .../reference/js/classes/UpdateManager.md | 482 ------------------ .../reference/js/classes/UpdateManagerSync.md | 354 ------------- .../reference/js/classes/VelopackApp.md | 46 -- .../reference/js/classes/VelopackAsset.md | 153 ------ .../reference/js/enums/JsonNodeType.md | 61 --- .../reference/js/enums/VelopackAssetType.md | 31 -- .../current/troubleshooting/cli.mdx | 89 ---- .../current/troubleshooting/debugging.mdx | 48 -- .../current/troubleshooting/faq.mdx | 16 - i18n/de/docusaurus-theme-classic/navbar.json | 18 - i18n/en/code.json | 324 ------------ .../options.json | 14 - .../current.json | 130 ----- i18n/en/docusaurus-theme-classic/navbar.json | 18 - i18n/ru/code.json | 324 ------------ .../options.json | 14 - .../current.json | 130 ----- .../current/contributing/compiling.mdx | 71 --- .../current/distributing/deploy-cli.mdx | 43 -- .../current/distributing/github-actions.mdx | 109 ---- .../current/distributing/overview.mdx | 98 ---- .../current/getting-started/cpp.mdx | 85 --- .../current/getting-started/csharp.mdx | 48 -- .../current/getting-started/electron.mdx | 79 --- .../current/getting-started/fusion-cli.mdx | 128 ----- .../current/getting-started/rust.mdx | 72 --- .../current/index.mdx | 57 --- .../current/integrating/hooks.mdx | 31 -- .../current/integrating/overview.mdx | 132 ----- .../current/integrating/preserved-files.mdx | 22 - .../current/integrating/release-notes.mdx | 23 - .../current/integrating/shortcuts.mdx | 19 - .../integrating/switching-channels.mdx | 30 -- .../current/migrating/squirrel.mdx | 70 --- .../current/packaging/bootstrapping.mdx | 86 ---- .../current/packaging/channels.mdx | 41 -- .../current/packaging/deltas.mdx | 47 -- .../current/packaging/installer.mdx | 52 -- .../packaging/operating-systems/linux.mdx | 48 -- .../packaging/operating-systems/macos.mdx | 37 -- .../packaging/operating-systems/windows.mdx | 61 --- .../current/packaging/overview.mdx | 77 --- .../current/packaging/rid.mdx | 26 - .../current/packaging/signing.mdx | 194 ------- .../current/reference/cpp/api.md | 428 ---------------- .../ChecksumFailedException.md | 30 -- .../Velopack.Compression.md | 8 - .../cs/Velopack.Locators/IVelopackLocator.md | 101 ---- .../Velopack.Locators/LinuxVelopackLocator.md | 92 ---- .../Velopack.Locators/OsxVelopackLocator.md | 74 --- .../Velopack.Locators/TestVelopackLocator.md | 81 --- .../cs/Velopack.Locators/Velopack.Locators.md | 23 - .../cs/Velopack.Locators/VelopackLocator.md | 153 ------ .../WindowsVelopackLocator.md | 66 --- .../cs/Velopack.NuGet/PackageManifest.md | 196 ------- .../cs/Velopack.NuGet/Velopack.NuGet.md | 12 - .../reference/cs/Velopack.NuGet/ZipPackage.md | 52 -- .../cs/Velopack.NuGet/ZipPackageFile.md | 132 ----- .../GitBase`T`.GitBaseAsset.md | 30 -- .../cs/Velopack.Sources/GitBase`T`.md | 143 ------ .../cs/Velopack.Sources/GithubRelease.md | 38 -- .../cs/Velopack.Sources/GithubReleaseAsset.md | 42 -- .../cs/Velopack.Sources/GithubSource.md | 80 --- .../cs/Velopack.Sources/GitlabRelease.md | 38 -- .../cs/Velopack.Sources/GitlabReleaseAsset.md | 26 - .../cs/Velopack.Sources/GitlabReleaseLink.md | 41 -- .../cs/Velopack.Sources/GitlabSource.md | 63 --- .../HttpClientFileDownloader.md | 141 ----- .../cs/Velopack.Sources/IFileDownloader.md | 75 --- .../cs/Velopack.Sources/IUpdateSource.md | 67 --- .../cs/Velopack.Sources/SimpleFileSource.md | 79 --- .../cs/Velopack.Sources/SimpleWebSource.md | 87 ---- .../cs/Velopack.Sources/Velopack.Sources.md | 43 -- .../VelopackFlowUpdateSource.md | 83 --- .../FileIcon.SHGetFileInfoConstants.md | 116 ----- .../reference/cs/Velopack.Windows/FileIcon.md | 48 -- .../Velopack.Windows/Runtimes.DotnetInfo.md | 190 ------- .../Runtimes.DotnetRuntimeType.md | 32 -- .../Runtimes.FrameworkInfo.md | 59 --- .../Velopack.Windows/Runtimes.RuntimeInfo.md | 119 ----- .../Runtimes.RuntimeInstallResult.md | 44 -- .../Velopack.Windows/Runtimes.VCRedist00.md | 33 -- .../Velopack.Windows/Runtimes.VCRedist14.md | 26 - .../Velopack.Windows/Runtimes.VCRedistInfo.md | 52 -- .../reference/cs/Velopack.Windows/Runtimes.md | 283 ---------- .../ShellLink.EShellLinkResolveFlags.md | 87 ---- .../ShellLink.LinkDisplayMode.md | 31 -- .../Velopack.Windows/ShellLink.PROPERTYKEY.md | 38 -- .../Velopack.Windows/ShellLink.PropVariant.md | 84 --- .../cs/Velopack.Windows/ShellLink.md | 211 -------- .../cs/Velopack.Windows/ShortcutLocation.md | 45 -- .../cs/Velopack.Windows/Shortcuts.md | 145 ------ .../cs/Velopack.Windows/Velopack.Windows.md | 46 -- .../current/reference/cs/Velopack/RID.md | 153 ------ .../reference/cs/Velopack/ReleaseEntry.md | 287 ----------- .../reference/cs/Velopack/ReleaseEntryName.md | 70 --- .../cs/Velopack/ReleaseNotesFormat.md | 27 - .../reference/cs/Velopack/RidDisplayType.md | 31 -- .../reference/cs/Velopack/RuntimeCpu.md | 38 -- .../reference/cs/Velopack/RuntimeOs.md | 41 -- .../reference/cs/Velopack/RuntimeVersion.md | 117 ----- .../reference/cs/Velopack/UpdateExe.md | 43 -- .../reference/cs/Velopack/UpdateInfo.md | 42 -- .../reference/cs/Velopack/UpdateManager.md | 279 ---------- .../reference/cs/Velopack/UpdateOptions.md | 34 -- .../current/reference/cs/Velopack/Velopack.md | 50 -- .../reference/cs/Velopack/VelopackApp.md | 209 -------- .../reference/cs/Velopack/VelopackAsset.md | 107 ---- .../cs/Velopack/VelopackAssetFeed.md | 45 -- .../cs/Velopack/VelopackAssetType.md | 26 - .../reference/cs/Velopack/VelopackHook.md | 13 - .../cs/Velopack/VelopackRuntimeInfo.md | 111 ---- .../current/reference/index.mdx | 9 - .../current/reference/js/classes/JsonNode.md | 301 ----------- .../reference/js/classes/UpdateInfo.md | 61 --- .../reference/js/classes/UpdateManager.md | 482 ------------------ .../reference/js/classes/UpdateManagerSync.md | 354 ------------- .../reference/js/classes/VelopackApp.md | 46 -- .../reference/js/classes/VelopackAsset.md | 153 ------ .../reference/js/enums/JsonNodeType.md | 61 --- .../reference/js/enums/VelopackAssetType.md | 31 -- .../current/troubleshooting/cli.mdx | 89 ---- .../current/troubleshooting/debugging.mdx | 48 -- .../current/troubleshooting/faq.mdx | 16 - i18n/ru/docusaurus-theme-classic/navbar.json | 18 - i18n/zh-CN/code.json | 324 ------------ .../options.json | 14 - .../current.json | 130 ----- .../current/contributing/compiling.mdx | 71 --- .../current/distributing/deploy-cli.mdx | 43 -- .../current/distributing/github-actions.mdx | 109 ---- .../current/distributing/overview.mdx | 98 ---- .../current/getting-started/cpp.mdx | 85 --- .../current/getting-started/csharp.mdx | 48 -- .../current/getting-started/electron.mdx | 79 --- .../current/getting-started/fusion-cli.mdx | 128 ----- .../current/getting-started/rust.mdx | 72 --- .../current/index.mdx | 57 --- .../current/integrating/hooks.mdx | 31 -- .../current/integrating/overview.mdx | 132 ----- .../current/integrating/preserved-files.mdx | 22 - .../current/integrating/release-notes.mdx | 23 - .../current/integrating/shortcuts.mdx | 19 - .../integrating/switching-channels.mdx | 30 -- .../current/migrating/squirrel.mdx | 70 --- .../current/packaging/bootstrapping.mdx | 86 ---- .../current/packaging/channels.mdx | 41 -- .../current/packaging/deltas.mdx | 47 -- .../current/packaging/installer.mdx | 52 -- .../packaging/operating-systems/linux.mdx | 48 -- .../packaging/operating-systems/macos.mdx | 37 -- .../packaging/operating-systems/windows.mdx | 61 --- .../current/packaging/overview.mdx | 77 --- .../current/packaging/rid.mdx | 26 - .../current/packaging/signing.mdx | 194 ------- .../current/reference/cpp/api.md | 428 ---------------- .../ChecksumFailedException.md | 30 -- .../Velopack.Compression.md | 8 - .../cs/Velopack.Locators/IVelopackLocator.md | 101 ---- .../Velopack.Locators/LinuxVelopackLocator.md | 92 ---- .../Velopack.Locators/OsxVelopackLocator.md | 74 --- .../Velopack.Locators/TestVelopackLocator.md | 81 --- .../cs/Velopack.Locators/Velopack.Locators.md | 23 - .../cs/Velopack.Locators/VelopackLocator.md | 153 ------ .../WindowsVelopackLocator.md | 66 --- .../cs/Velopack.NuGet/PackageManifest.md | 196 ------- .../cs/Velopack.NuGet/Velopack.NuGet.md | 12 - .../reference/cs/Velopack.NuGet/ZipPackage.md | 52 -- .../cs/Velopack.NuGet/ZipPackageFile.md | 132 ----- .../GitBase`T`.GitBaseAsset.md | 30 -- .../cs/Velopack.Sources/GitBase`T`.md | 143 ------ .../cs/Velopack.Sources/GithubRelease.md | 38 -- .../cs/Velopack.Sources/GithubReleaseAsset.md | 42 -- .../cs/Velopack.Sources/GithubSource.md | 80 --- .../cs/Velopack.Sources/GitlabRelease.md | 38 -- .../cs/Velopack.Sources/GitlabReleaseAsset.md | 26 - .../cs/Velopack.Sources/GitlabReleaseLink.md | 41 -- .../cs/Velopack.Sources/GitlabSource.md | 63 --- .../HttpClientFileDownloader.md | 141 ----- .../cs/Velopack.Sources/IFileDownloader.md | 75 --- .../cs/Velopack.Sources/IUpdateSource.md | 67 --- .../cs/Velopack.Sources/SimpleFileSource.md | 79 --- .../cs/Velopack.Sources/SimpleWebSource.md | 87 ---- .../cs/Velopack.Sources/Velopack.Sources.md | 43 -- .../VelopackFlowUpdateSource.md | 83 --- .../FileIcon.SHGetFileInfoConstants.md | 116 ----- .../reference/cs/Velopack.Windows/FileIcon.md | 48 -- .../Velopack.Windows/Runtimes.DotnetInfo.md | 190 ------- .../Runtimes.DotnetRuntimeType.md | 32 -- .../Runtimes.FrameworkInfo.md | 59 --- .../Velopack.Windows/Runtimes.RuntimeInfo.md | 119 ----- .../Runtimes.RuntimeInstallResult.md | 44 -- .../Velopack.Windows/Runtimes.VCRedist00.md | 33 -- .../Velopack.Windows/Runtimes.VCRedist14.md | 26 - .../Velopack.Windows/Runtimes.VCRedistInfo.md | 52 -- .../reference/cs/Velopack.Windows/Runtimes.md | 283 ---------- .../ShellLink.EShellLinkResolveFlags.md | 87 ---- .../ShellLink.LinkDisplayMode.md | 31 -- .../Velopack.Windows/ShellLink.PROPERTYKEY.md | 38 -- .../Velopack.Windows/ShellLink.PropVariant.md | 84 --- .../cs/Velopack.Windows/ShellLink.md | 211 -------- .../cs/Velopack.Windows/ShortcutLocation.md | 45 -- .../cs/Velopack.Windows/Shortcuts.md | 145 ------ .../cs/Velopack.Windows/Velopack.Windows.md | 46 -- .../current/reference/cs/Velopack/RID.md | 153 ------ .../reference/cs/Velopack/ReleaseEntry.md | 287 ----------- .../reference/cs/Velopack/ReleaseEntryName.md | 70 --- .../cs/Velopack/ReleaseNotesFormat.md | 27 - .../reference/cs/Velopack/RidDisplayType.md | 31 -- .../reference/cs/Velopack/RuntimeCpu.md | 38 -- .../reference/cs/Velopack/RuntimeOs.md | 41 -- .../reference/cs/Velopack/RuntimeVersion.md | 117 ----- .../reference/cs/Velopack/UpdateExe.md | 43 -- .../reference/cs/Velopack/UpdateInfo.md | 42 -- .../reference/cs/Velopack/UpdateManager.md | 279 ---------- .../reference/cs/Velopack/UpdateOptions.md | 34 -- .../current/reference/cs/Velopack/Velopack.md | 50 -- .../reference/cs/Velopack/VelopackApp.md | 209 -------- .../reference/cs/Velopack/VelopackAsset.md | 107 ---- .../cs/Velopack/VelopackAssetFeed.md | 45 -- .../cs/Velopack/VelopackAssetType.md | 26 - .../reference/cs/Velopack/VelopackHook.md | 13 - .../cs/Velopack/VelopackRuntimeInfo.md | 111 ---- .../current/reference/index.mdx | 9 - .../current/reference/js/classes/JsonNode.md | 301 ----------- .../reference/js/classes/UpdateInfo.md | 61 --- .../reference/js/classes/UpdateManager.md | 482 ------------------ .../reference/js/classes/UpdateManagerSync.md | 354 ------------- .../reference/js/classes/VelopackApp.md | 46 -- .../reference/js/classes/VelopackAsset.md | 153 ------ .../reference/js/enums/JsonNodeType.md | 61 --- .../reference/js/enums/VelopackAssetType.md | 31 -- .../current/troubleshooting/cli.mdx | 89 ---- .../current/troubleshooting/debugging.mdx | 48 -- .../current/troubleshooting/faq.mdx | 16 - .../docusaurus-theme-classic/navbar.json | 18 - package.json | 5 +- 343 files changed, 16 insertions(+), 30200 deletions(-) delete mode 100644 .github/workflows/daily.yml delete mode 100644 crowdin.yml delete mode 100644 daily-tasks.mjs delete mode 100644 dfmg.yaml delete mode 100644 i18n/de/code.json delete mode 100644 i18n/de/docusaurus-plugin-content-blog/options.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current.json delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/contributing/compiling.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/distributing/deploy-cli.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/distributing/github-actions.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/distributing/overview.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/getting-started/cpp.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/getting-started/csharp.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/getting-started/electron.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/getting-started/fusion-cli.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/getting-started/rust.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/index.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/integrating/hooks.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/integrating/overview.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/integrating/preserved-files.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/integrating/release-notes.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/integrating/shortcuts.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/integrating/switching-channels.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/migrating/squirrel.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/packaging/bootstrapping.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/packaging/channels.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/packaging/deltas.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/packaging/installer.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/packaging/operating-systems/linux.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/packaging/operating-systems/macos.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/packaging/operating-systems/windows.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/packaging/overview.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/packaging/rid.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/packaging/signing.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cpp/api.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/ChecksumFailedException.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/Velopack.Compression.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/IVelopackLocator.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/LinuxVelopackLocator.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/OsxVelopackLocator.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/TestVelopackLocator.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/Velopack.Locators.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/VelopackLocator.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/WindowsVelopackLocator.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/PackageManifest.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/Velopack.NuGet.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackage.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackageFile.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.GitBaseAsset.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubRelease.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubReleaseAsset.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubSource.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabRelease.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseAsset.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseLink.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabSource.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/HttpClientFileDownloader.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IFileDownloader.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IUpdateSource.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleFileSource.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleWebSource.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/Velopack.Sources.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/VelopackFlowUpdateSource.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.SHGetFileInfoConstants.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetInfo.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetRuntimeType.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.FrameworkInfo.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInfo.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInstallResult.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist00.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist14.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedistInfo.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.EShellLinkResolveFlags.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.LinkDisplayMode.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PROPERTYKEY.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PropVariant.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShortcutLocation.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Shortcuts.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Velopack.Windows.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RID.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntry.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntryName.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseNotesFormat.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RidDisplayType.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeCpu.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeOs.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeVersion.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateExe.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateInfo.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateManager.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateOptions.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/Velopack.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackApp.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAsset.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetFeed.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetType.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackHook.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackRuntimeInfo.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/index.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/JsonNode.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateInfo.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManager.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManagerSync.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackApp.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackAsset.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/js/enums/JsonNodeType.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/reference/js/enums/VelopackAssetType.md delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/troubleshooting/cli.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/troubleshooting/debugging.mdx delete mode 100644 i18n/de/docusaurus-plugin-content-docs/current/troubleshooting/faq.mdx delete mode 100644 i18n/de/docusaurus-theme-classic/navbar.json delete mode 100644 i18n/en/code.json delete mode 100644 i18n/en/docusaurus-plugin-content-blog/options.json delete mode 100644 i18n/en/docusaurus-plugin-content-docs/current.json delete mode 100644 i18n/en/docusaurus-theme-classic/navbar.json delete mode 100644 i18n/ru/code.json delete mode 100644 i18n/ru/docusaurus-plugin-content-blog/options.json delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current.json delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/contributing/compiling.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/distributing/deploy-cli.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/distributing/github-actions.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/distributing/overview.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/getting-started/cpp.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/getting-started/csharp.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/getting-started/electron.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/getting-started/fusion-cli.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/getting-started/rust.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/index.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/integrating/hooks.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/integrating/overview.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/integrating/preserved-files.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/integrating/release-notes.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/integrating/shortcuts.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/integrating/switching-channels.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/migrating/squirrel.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/packaging/bootstrapping.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/packaging/channels.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/packaging/deltas.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/packaging/installer.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/packaging/operating-systems/linux.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/packaging/operating-systems/macos.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/packaging/operating-systems/windows.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/packaging/overview.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/packaging/rid.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/packaging/signing.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cpp/api.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/ChecksumFailedException.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/Velopack.Compression.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/IVelopackLocator.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/LinuxVelopackLocator.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/OsxVelopackLocator.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/TestVelopackLocator.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/Velopack.Locators.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/VelopackLocator.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/WindowsVelopackLocator.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/PackageManifest.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/Velopack.NuGet.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackage.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackageFile.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.GitBaseAsset.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubRelease.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubReleaseAsset.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubSource.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabRelease.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseAsset.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseLink.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabSource.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/HttpClientFileDownloader.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IFileDownloader.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IUpdateSource.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleFileSource.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleWebSource.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/Velopack.Sources.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/VelopackFlowUpdateSource.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.SHGetFileInfoConstants.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetInfo.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetRuntimeType.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.FrameworkInfo.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInfo.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInstallResult.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist00.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist14.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedistInfo.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.EShellLinkResolveFlags.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.LinkDisplayMode.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PROPERTYKEY.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PropVariant.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShortcutLocation.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Shortcuts.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Velopack.Windows.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RID.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntry.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntryName.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseNotesFormat.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RidDisplayType.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeCpu.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeOs.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeVersion.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateExe.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateInfo.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateManager.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateOptions.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/Velopack.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackApp.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAsset.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetFeed.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetType.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackHook.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackRuntimeInfo.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/index.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/JsonNode.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateInfo.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManager.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManagerSync.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackApp.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackAsset.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/js/enums/JsonNodeType.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/reference/js/enums/VelopackAssetType.md delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/troubleshooting/cli.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/troubleshooting/debugging.mdx delete mode 100644 i18n/ru/docusaurus-plugin-content-docs/current/troubleshooting/faq.mdx delete mode 100644 i18n/ru/docusaurus-theme-classic/navbar.json delete mode 100644 i18n/zh-CN/code.json delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-blog/options.json delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current.json delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/contributing/compiling.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/distributing/deploy-cli.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/distributing/github-actions.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/distributing/overview.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/cpp.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/csharp.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/electron.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/fusion-cli.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/rust.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/index.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/hooks.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/overview.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/preserved-files.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/release-notes.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/shortcuts.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/switching-channels.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/migrating/squirrel.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/bootstrapping.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/channels.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/deltas.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/installer.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/operating-systems/linux.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/operating-systems/macos.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/operating-systems/windows.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/overview.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/rid.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/signing.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cpp/api.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/ChecksumFailedException.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/Velopack.Compression.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/IVelopackLocator.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/LinuxVelopackLocator.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/OsxVelopackLocator.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/TestVelopackLocator.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/Velopack.Locators.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/VelopackLocator.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/WindowsVelopackLocator.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/PackageManifest.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/Velopack.NuGet.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackage.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackageFile.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.GitBaseAsset.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubRelease.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubReleaseAsset.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubSource.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabRelease.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseAsset.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseLink.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabSource.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/HttpClientFileDownloader.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IFileDownloader.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IUpdateSource.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleFileSource.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleWebSource.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/Velopack.Sources.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/VelopackFlowUpdateSource.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.SHGetFileInfoConstants.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetInfo.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetRuntimeType.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.FrameworkInfo.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInfo.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInstallResult.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist00.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist14.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedistInfo.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.EShellLinkResolveFlags.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.LinkDisplayMode.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PROPERTYKEY.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PropVariant.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShortcutLocation.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Shortcuts.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Velopack.Windows.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RID.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntry.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntryName.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseNotesFormat.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RidDisplayType.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeCpu.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeOs.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeVersion.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateExe.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateInfo.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateManager.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateOptions.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/Velopack.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackApp.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAsset.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetFeed.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetType.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackHook.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackRuntimeInfo.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/index.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/JsonNode.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateInfo.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManager.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManagerSync.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackApp.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackAsset.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/enums/JsonNodeType.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/enums/VelopackAssetType.md delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/troubleshooting/cli.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/troubleshooting/debugging.mdx delete mode 100644 i18n/zh-CN/docusaurus-plugin-content-docs/current/troubleshooting/faq.mdx delete mode 100644 i18n/zh-CN/docusaurus-theme-classic/navbar.json diff --git a/.github/workflows/daily.yml b/.github/workflows/daily.yml deleted file mode 100644 index 2b314a6..0000000 --- a/.github/workflows/daily.yml +++ /dev/null @@ -1,58 +0,0 @@ -name: Run Daily Tasks - -on: - schedule: - - cron: "0 1 * * *" - workflow_dispatch: - -permissions: - contents: write - id-token: write - -concurrency: - group: "pages" - cancel-in-progress: true - -jobs: - deploy: - runs-on: ubuntu-latest - steps: - - name: Print dotnet version - run: dotnet --info - - - name: Checkout Docs - uses: actions/checkout@v4 - with: - path: velopack.docs - - - name: Checkout Velopack - uses: actions/checkout@v4 - with: - fetch-depth: 0 - repository: velopack/velopack - path: velopack - - - name: Checkout Fusion - uses: actions/checkout@v4 - with: - fetch-depth: 0 - repository: velopack/velopack.fusion - path: velopack.fusion - - - name: Install dotnet tools - run: dotnet tool install -g docfx - - - name: Install dependencies - working-directory: velopack.docs - run: npm ci - - - name: Run Tasks - working-directory: velopack.docs - run: npm run daily-tasks - - - uses: actions4git/add-commit-push@v1 - with: - path: velopack.docs - commit-author: github-actions - commit-message: "Update translations / reference libraries" - diff --git a/crowdin.yml b/crowdin.yml deleted file mode 100644 index d30c7e9..0000000 --- a/crowdin.yml +++ /dev/null @@ -1,12 +0,0 @@ -project_id: '657310' -api_token_env: CROWDIN_PERSONAL_TOKEN -preserve_hierarchy: true -files: - # JSON translation files - - source: /i18n/en/**/*.json - translation: /i18n/%two_letters_code%/**/%original_file_name% - # Docs Markdown files - - source: /docs/**/*.mdx - translation: /i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name% - ignore: - - /docs/reference/**/* \ No newline at end of file diff --git a/daily-tasks.mjs b/daily-tasks.mjs deleted file mode 100644 index ef9c5ad..0000000 --- a/daily-tasks.mjs +++ /dev/null @@ -1,47 +0,0 @@ -import fs from 'fs'; -import path from 'path'; -import { execSync } from 'child_process'; -import { setTimeout } from 'timers/promises'; -import { fileURLToPath } from 'url'; - -// config -const __filename = fileURLToPath(import.meta.url); -const __dirname = path.dirname(__filename); -const locales = ['de', 'ru', 'zh-CN']; -const i18nDir = path.join(__dirname, 'i18n'); - -// update reference libraries -console.log("Updating reference libraries"); -execSync("npm run generate", { stdio: 'inherit' }); - -// publish latest documentation to crowdin -console.log("Writing docusaurus translations"); -execSync("npm run write-translations", { stdio: 'inherit' }); - -// give crowdin time to process uploaded files -await setTimeout(10 * 1000); - -// download and fix up translations from crowdin -console.log("Preparing to download translations from Crowdin"); -if (fs.existsSync(i18nDir)) { - locales.forEach(locale => { - const localeDir = path.join(i18nDir, locale); - if (fs.existsSync(localeDir)) { - console.log(`Cleaning "${locale}"`); - fs.rmSync(localeDir, { recursive: true }); - } - }); -} - -console.log('Downloading translations from Crowdin'); -execSync("npm run crowdin-download", { stdio: 'inherit' }); - -console.log('Renaming "zh" directory to "zh-CN"'); -fs.renameSync(path.join(i18nDir, 'zh'), path.join(i18nDir, 'zh-CN')); - -const referenceDir = path.join(__dirname, 'docs', 'reference'); -locales.forEach(locale => { - const localeDir = path.join(i18nDir, locale, 'docusaurus-plugin-content-docs', 'current', 'reference'); - console.log(`Copying reference lib to "${locale}"`); - fs.cpSync(referenceDir, localeDir, { recursive: true }); -}); \ No newline at end of file diff --git a/dfmg.yaml b/dfmg.yaml deleted file mode 100644 index 9f021f4..0000000 --- a/dfmg.yaml +++ /dev/null @@ -1,2 +0,0 @@ -outputPath: ./docs/reference/cs -yamlPath: ../velopack/_docyml \ No newline at end of file diff --git a/docusaurus.config.ts b/docusaurus.config.ts index e52538e..e25274b 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -14,7 +14,7 @@ const config: Config = { onBrokenMarkdownLinks: 'throw', i18n: { defaultLocale: 'en', - locales: ['en', 'zh-CN', 'de', 'ru'], + locales: ['en'], }, themes: [ ['@easyops-cn/docusaurus-search-local', { @@ -51,7 +51,8 @@ const config: Config = { return null; // reference pages can't be edited } if (locale != 'en') { - return 'https://crowdin.com/project/velopack/invite?h=88bec14b5657f004fe5ba325090df5ba2031736'; + return null; + // return 'https://crowdin.com/project/velopack/invite?h=88bec14b5657f004fe5ba325090df5ba2031736'; } return `https://github.com/velopack/velopack.docs/tree/master/${versionDocsDirPath}/${docPath}`; }, @@ -103,18 +104,18 @@ const config: Config = { label: 'Blog', position: 'left' }, - { - type: 'localeDropdown', - position: 'right', - dropdownItemsAfter: [ - { - href: 'https://crowdin.com/project/velopack/invite?h=88bec14b5657f004fe5ba325090df5ba2031736', - label: 'Help Translate', - target: '_blank', - rel: null, - }, - ], - }, + // { + // type: 'localeDropdown', + // position: 'right', + // dropdownItemsAfter: [ + // { + // href: 'https://crowdin.com/project/velopack/invite?h=88bec14b5657f004fe5ba325090df5ba2031736', + // label: 'Help Translate', + // target: '_blank', + // rel: null, + // }, + // ], + // }, { href: 'https://github.com/velopack/velopack', position: 'right', diff --git a/i18n/de/code.json b/i18n/de/code.json deleted file mode 100644 index be43c1e..0000000 --- a/i18n/de/code.json +++ /dev/null @@ -1,324 +0,0 @@ -{ - "theme.ErrorPageContent.title": { - "message": "This page crashed.", - "description": "The title of the fallback page when the page crashed" - }, - "theme.BackToTopButton.buttonAriaLabel": { - "message": "Scroll back to top", - "description": "The ARIA label for the back to top button" - }, - "theme.blog.archive.title": { - "message": "Archive", - "description": "The page & hero title of the blog archive page" - }, - "theme.blog.archive.description": { - "message": "Archive", - "description": "The page & hero description of the blog archive page" - }, - "theme.blog.paginator.navAriaLabel": { - "message": "Blog list page navigation", - "description": "The ARIA label for the blog pagination" - }, - "theme.blog.paginator.newerEntries": { - "message": "Newer Entries", - "description": "The label used to navigate to the newer blog posts page (previous page)" - }, - "theme.blog.paginator.olderEntries": { - "message": "Older Entries", - "description": "The label used to navigate to the older blog posts page (next page)" - }, - "theme.blog.post.paginator.navAriaLabel": { - "message": "Blog post page navigation", - "description": "The ARIA label for the blog posts pagination" - }, - "theme.blog.post.paginator.newerPost": { - "message": "Newer Post", - "description": "The blog post button label to navigate to the newer/previous post" - }, - "theme.blog.post.paginator.olderPost": { - "message": "Older Post", - "description": "The blog post button label to navigate to the older/next post" - }, - "theme.blog.post.plurals": { - "message": "One post|{count} posts", - "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.blog.tagTitle": { - "message": "{nPosts} tagged with \"{tagName}\"", - "description": "The title of the page for a blog tag" - }, - "theme.tags.tagsPageLink": { - "message": "View All Tags", - "description": "The label of the link targeting the tag list page" - }, - "theme.colorToggle.ariaLabel": { - "message": "Switch between dark and light mode (currently {mode})", - "description": "The ARIA label for the navbar color mode toggle" - }, - "theme.colorToggle.ariaLabel.mode.dark": { - "message": "dark mode", - "description": "The name for the dark color mode" - }, - "theme.colorToggle.ariaLabel.mode.light": { - "message": "light mode", - "description": "The name for the light color mode" - }, - "theme.docs.breadcrumbs.navAriaLabel": { - "message": "Breadcrumbs", - "description": "The ARIA label for the breadcrumbs" - }, - "theme.docs.DocCard.categoryDescription": { - "message": "{count} items", - "description": "The default description for a category card in the generated index about how many items this category includes" - }, - "theme.docs.paginator.navAriaLabel": { - "message": "Docs pages", - "description": "The ARIA label for the docs pagination" - }, - "theme.docs.paginator.previous": { - "message": "Previous", - "description": "The label used to navigate to the previous doc" - }, - "theme.docs.paginator.next": { - "message": "Next", - "description": "The label used to navigate to the next doc" - }, - "theme.docs.tagDocListPageTitle.nDocsTagged": { - "message": "One doc tagged|{count} docs tagged", - "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.tagDocListPageTitle": { - "message": "{nDocsTagged} with \"{tagName}\"", - "description": "The title of the page for a docs tag" - }, - "theme.docs.versionBadge.label": { - "message": "Version: {versionLabel}" - }, - "theme.docs.versions.unreleasedVersionLabel": { - "message": "This is unreleased documentation for {siteTitle} {versionLabel} version.", - "description": "The label used to tell the user that he's browsing an unreleased doc version" - }, - "theme.docs.versions.unmaintainedVersionLabel": { - "message": "This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.", - "description": "The label used to tell the user that he's browsing an unmaintained doc version" - }, - "theme.docs.versions.latestVersionSuggestionLabel": { - "message": "For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).", - "description": "The label used to tell the user to check the latest version" - }, - "theme.docs.versions.latestVersionLinkLabel": { - "message": "latest version", - "description": "The label used for the latest version suggestion link label" - }, - "theme.common.editThisPage": { - "message": "Edit this page", - "description": "The link label to edit the current page" - }, - "theme.common.headingLinkTitle": { - "message": "Direct link to {heading}", - "description": "Title for link to heading" - }, - "theme.lastUpdated.atDate": { - "message": " on {date}", - "description": "The words used to describe on which date a page has been last updated" - }, - "theme.lastUpdated.byUser": { - "message": " by {user}", - "description": "The words used to describe by who the page has been last updated" - }, - "theme.lastUpdated.lastUpdatedAtBy": { - "message": "Last updated{atDate}{byUser}", - "description": "The sentence used to display when a page has been last updated, and by who" - }, - "theme.NotFound.title": { - "message": "Page Not Found", - "description": "The title of the 404 page" - }, - "theme.navbar.mobileVersionsDropdown.label": { - "message": "Versions", - "description": "The label for the navbar versions dropdown on mobile view" - }, - "theme.tags.tagsListLabel": { - "message": "Tags:", - "description": "The label alongside a tag list" - }, - "theme.admonition.caution": { - "message": "caution", - "description": "The default label used for the Caution admonition (:::caution)" - }, - "theme.admonition.danger": { - "message": "danger", - "description": "The default label used for the Danger admonition (:::danger)" - }, - "theme.admonition.info": { - "message": "info", - "description": "The default label used for the Info admonition (:::info)" - }, - "theme.admonition.note": { - "message": "note", - "description": "The default label used for the Note admonition (:::note)" - }, - "theme.admonition.tip": { - "message": "tip", - "description": "The default label used for the Tip admonition (:::tip)" - }, - "theme.admonition.warning": { - "message": "warning", - "description": "The default label used for the Warning admonition (:::warning)" - }, - "theme.AnnouncementBar.closeButtonAriaLabel": { - "message": "Close", - "description": "The ARIA label for close button of announcement bar" - }, - "theme.blog.sidebar.navAriaLabel": { - "message": "Blog recent posts navigation", - "description": "The ARIA label for recent posts in the blog sidebar" - }, - "theme.CodeBlock.copied": { - "message": "Copied", - "description": "The copied button label on code blocks" - }, - "theme.CodeBlock.copyButtonAriaLabel": { - "message": "Copy code to clipboard", - "description": "The ARIA label for copy code blocks button" - }, - "theme.CodeBlock.copy": { - "message": "Copy", - "description": "The copy button label on code blocks" - }, - "theme.CodeBlock.wordWrapToggle": { - "message": "Toggle word wrap", - "description": "The title attribute for toggle word wrapping button of code block lines" - }, - "theme.DocSidebarItem.expandCategoryAriaLabel": { - "message": "Expand sidebar category '{label}'", - "description": "The ARIA label to expand the sidebar category" - }, - "theme.DocSidebarItem.collapseCategoryAriaLabel": { - "message": "Collapse sidebar category '{label}'", - "description": "The ARIA label to collapse the sidebar category" - }, - "theme.NavBar.navAriaLabel": { - "message": "Main", - "description": "The ARIA label for the main navigation" - }, - "theme.NotFound.p1": { - "message": "We could not find what you were looking for.", - "description": "The first paragraph of the 404 page" - }, - "theme.NotFound.p2": { - "message": "Please contact the owner of the site that linked you to the original URL and let them know their link is broken.", - "description": "The 2nd paragraph of the 404 page" - }, - "theme.navbar.mobileLanguageDropdown.label": { - "message": "Languages", - "description": "The label for the mobile language switcher dropdown" - }, - "theme.TOCCollapsible.toggleButtonLabel": { - "message": "On this page", - "description": "The label used by the button on the collapsible TOC component" - }, - "theme.blog.post.readMore": { - "message": "Read More", - "description": "The label used in blog post item excerpts to link to full blog posts" - }, - "theme.blog.post.readMoreLabel": { - "message": "Read more about {title}", - "description": "The ARIA label for the link to full blog posts from excerpts" - }, - "theme.blog.post.readingTime.plurals": { - "message": "One min read|{readingTime} min read", - "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.breadcrumbs.home": { - "message": "Home page", - "description": "The ARIA label for the home page in the breadcrumbs" - }, - "theme.docs.sidebar.collapseButtonTitle": { - "message": "Collapse sidebar", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.collapseButtonAriaLabel": { - "message": "Collapse sidebar", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.navAriaLabel": { - "message": "Docs sidebar", - "description": "The ARIA label for the sidebar navigation" - }, - "theme.docs.sidebar.closeSidebarButtonAriaLabel": { - "message": "Close navigation bar", - "description": "The ARIA label for close button of mobile sidebar" - }, - "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { - "message": "← Back to main menu", - "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" - }, - "theme.docs.sidebar.toggleSidebarButtonAriaLabel": { - "message": "Toggle navigation bar", - "description": "The ARIA label for hamburger menu button of mobile navigation" - }, - "theme.docs.sidebar.expandButtonTitle": { - "message": "Expand sidebar", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.docs.sidebar.expandButtonAriaLabel": { - "message": "Expand sidebar", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.SearchBar.noResultsText": { - "message": "No results" - }, - "theme.SearchBar.seeAllOutsideContext": { - "message": "See results outside {context}" - }, - "theme.SearchBar.searchInContext": { - "message": "See all results in {context}" - }, - "theme.SearchBar.seeAll": { - "message": "See all results" - }, - "theme.SearchBar.label": { - "message": "Search", - "description": "The ARIA label and placeholder for search button" - }, - "theme.SearchPage.existingResultsTitle": { - "message": "Search results for \"{query}\"", - "description": "The search page title for non-empty query" - }, - "theme.SearchPage.emptyResultsTitle": { - "message": "Search the documentation", - "description": "The search page title for empty query" - }, - "theme.SearchPage.searchContext.everywhere": { - "message": "everywhere" - }, - "theme.SearchPage.documentsFound.plurals": { - "message": "1 document found|{count} documents found", - "description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.SearchPage.noResultsText": { - "message": "No documents were found", - "description": "The paragraph for empty search result" - }, - "theme.ErrorPageContent.tryAgain": { - "message": "Try again", - "description": "The label of the button to try again rendering when the React error boundary captures an error" - }, - "theme.common.skipToMainContent": { - "message": "Skip to main content", - "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" - }, - "theme.tags.tagsPageTitle": { - "message": "Tags", - "description": "The title of the tag list page" - }, - "theme.unlistedContent.title": { - "message": "Unlisted page", - "description": "The unlisted content banner title" - }, - "theme.unlistedContent.message": { - "message": "This page is unlisted. Search engines will not index it, and only users having a direct link can access it.", - "description": "The unlisted content banner message" - } -} diff --git a/i18n/de/docusaurus-plugin-content-blog/options.json b/i18n/de/docusaurus-plugin-content-blog/options.json deleted file mode 100644 index 9239ff7..0000000 --- a/i18n/de/docusaurus-plugin-content-blog/options.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "title": { - "message": "Blog", - "description": "The title for the blog used in SEO" - }, - "description": { - "message": "Blog", - "description": "The description for the blog used in SEO" - }, - "sidebar.title": { - "message": "Recent posts", - "description": "The label for the left sidebar" - } -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current.json b/i18n/de/docusaurus-plugin-content-docs/current.json deleted file mode 100644 index 171e544..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current.json +++ /dev/null @@ -1,130 +0,0 @@ -{ - "version.label": { - "message": "Next", - "description": "The label for version current" - }, - "sidebar.mainSidebar.category.Quick Start": { - "message": "Quick Start", - "description": "The label for category Quick Start in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Sample Apps": { - "message": "Sample Apps", - "description": "The label for category Sample Apps in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Integrating": { - "message": "Integrating", - "description": "The label for category Integrating in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Packaging": { - "message": "Packaging", - "description": "The label for category Packaging in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Operating Systems": { - "message": "Operating Systems", - "description": "The label for category Operating Systems in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Operating Systems.link.generated-index.title": { - "message": "Operating Systems Overview", - "description": "The generated-index page title for category Operating Systems in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Distributing": { - "message": "Distributing", - "description": "The label for category Distributing in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Troubleshooting": { - "message": "Troubleshooting", - "description": "The label for category Troubleshooting in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Contributing": { - "message": "Contributing", - "description": "The label for category Contributing in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Migrating": { - "message": "Migrating", - "description": "The label for category Migrating in sidebar mainSidebar" - }, - "sidebar.mainSidebar.link.C# / AvaloniaUI": { - "message": "C# / AvaloniaUI", - "description": "The label for link C# / AvaloniaUI in sidebar mainSidebar, linking to https://github.com/velopack/velopack/tree/master/samples/AvaloniaCrossPlat" - }, - "sidebar.mainSidebar.link.C# / WPF": { - "message": "C# / WPF", - "description": "The label for link C# / WPF in sidebar mainSidebar, linking to https://github.com/velopack/velopack/tree/master/samples/VeloWpfSample" - }, - "sidebar.mainSidebar.link.C++ / Win32": { - "message": "C++ / Win32", - "description": "The label for link C++ / Win32 in sidebar mainSidebar, linking to https://github.com/velopack/velopack.fusion/tree/master/for-cpp/samples/win32" - }, - "sidebar.mainSidebar.link.JS / Electron": { - "message": "JS / Electron", - "description": "The label for link JS / Electron in sidebar mainSidebar, linking to https://github.com/velopack/velopack.fusion/tree/master/for-js/samples/electron-forge" - }, - "sidebar.mainSidebar.link.Rust / Iced": { - "message": "Rust / Iced", - "description": "The label for link Rust / Iced in sidebar mainSidebar, linking to https://github.com/velopack/velopack.fusion/tree/master/for-rust/samples/iced" - }, - "sidebar.mainSidebar.doc.C# .NET": { - "message": "C# .NET", - "description": "The label for the doc item C# .NET in sidebar mainSidebar, linking to the doc getting-started/csharp" - }, - "sidebar.mainSidebar.doc.C++": { - "message": "C++", - "description": "The label for the doc item C++ in sidebar mainSidebar, linking to the doc getting-started/cpp" - }, - "sidebar.mainSidebar.doc.JS / Electron": { - "message": "JS / Electron", - "description": "The label for the doc item JS / Electron in sidebar mainSidebar, linking to the doc getting-started/electron" - }, - "sidebar.mainSidebar.doc.Rust": { - "message": "Rust", - "description": "The label for the doc item Rust in sidebar mainSidebar, linking to the doc getting-started/rust" - }, - "sidebar.mainSidebar.doc.Fusion CLI": { - "message": "Fusion CLI", - "description": "The label for the doc item Fusion CLI in sidebar mainSidebar, linking to the doc getting-started/fusion-cli" - }, - "sidebar.referenceSidebar.category.Library Reference": { - "message": "Library Reference", - "description": "The label for category Library Reference in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.C#": { - "message": "C#", - "description": "The label for category C# in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack": { - "message": "Velopack", - "description": "The label for category Velopack in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.Compression": { - "message": "Velopack.Compression", - "description": "The label for category Velopack.Compression in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.Locators": { - "message": "Velopack.Locators", - "description": "The label for category Velopack.Locators in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.NuGet": { - "message": "Velopack.NuGet", - "description": "The label for category Velopack.NuGet in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.Sources": { - "message": "Velopack.Sources", - "description": "The label for category Velopack.Sources in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.Windows": { - "message": "Velopack.Windows", - "description": "The label for category Velopack.Windows in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.JS": { - "message": "JS", - "description": "The label for category JS in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.link.Rust": { - "message": "Rust", - "description": "The label for link Rust in sidebar referenceSidebar, linking to https://docs.rs/velopack" - }, - "sidebar.referenceSidebar.doc.C++": { - "message": "C++", - "description": "The label for the doc item C++ in sidebar referenceSidebar, linking to the doc reference/cpp/api" - } -} diff --git a/i18n/de/docusaurus-plugin-content-docs/current/contributing/compiling.mdx b/i18n/de/docusaurus-plugin-content-docs/current/contributing/compiling.mdx deleted file mode 100644 index b66a6eb..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/contributing/compiling.mdx +++ /dev/null @@ -1,71 +0,0 @@ -# Build Velopack SDK - - -The Velopack SDK is responsible for compiling releases and installers. - -It is made up of: - -- Rust binaries which are re-distributed with installed apps, -- .NET NuGet package (`Velopack`), -- .NET command line tool (`vpk`). - -In order to test the project, you need to build the Rust binaries before compiling dotnet. - -### Prerequisites - -- [.NET 6 SDK](https://dotnet.microsoft.com/download/dotnet/6.0) -- [.NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0) -- [Rust / Cargo](https://www.rust-lang.org/tools/install) -- `dotnet tool install -g dotnet-coverage` -- `dotnet tool install -g nbgv` - -### Debug / Test - -On windows, you need to build the Rust binaries using the `windows` feature before running tests. On OSX, you should run `cargo build` instead. - -```shell -git clone https://github.com/velopack/velopack.git -cd velopack/src/Rust -cargo build --features windows -cd ../../ -dotnet build -dotnet test --no-build -``` - -### Release / Build - -This is slightly complicated, because you will need to compile Rust on x64 OSX and x64 Windows before creating the final packages. - -On OSX: - -```shell -git clone https://github.com/velopack/velopack.git -cd velopack/src/Rust -cargo build --release -``` - -On Windows: - -```shell -git clone https://github.com/velopack/velopack.git -cd velopack/src/Rust -cargo build --release --features windows -copy {path_to_osx_update} target/release/updatemac -dotnet build -c Release /p:PackRustAssets=true -``` - -### Compiling on Linux - -If you are on Linux (tested on Ubuntu), there are additional package pre-requisites: - -```sh -sudo apt install libssl-dev pkg-config -``` - -You need to verify that `nbgv` is working on the command line, you may be missing a `DOTNET_ROOT` variable in your bash profile, which might need to point at `/usr/share/dotnet` or `$HOME/.dotnet`. - -If you are missing localisation packages, you can search for them or add the following to your bash profile: - -```bash -export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/distributing/deploy-cli.mdx b/i18n/de/docusaurus-plugin-content-docs/current/distributing/deploy-cli.mdx deleted file mode 100644 index fcfd41c..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/distributing/deploy-cli.mdx +++ /dev/null @@ -1,43 +0,0 @@ -# Deployment CLI - - -The general process for deploying a Velopack release (`download -> pack -> upload`) can be greatly simplified by using the `download` and `upload` commands which are built into the `vpk` command line tool. - -## Packing your new release with delta's - -In order for delta's to be generated during the `pack` command, you need to first download the current latest release. This should be done with the download command: - -```cmd -vpk download http --url https://the.place/you-host/updates -vpk pack -u YourAppId -v 1.0.1 -p {buildOutput} -``` - -There are providers for various sources, such GitHub, S3, HTTP, etc. - -## Deploying releases - -In the previous example, we used the `http` source, while that is very generic it does not provide any information about how to upload the releases, so in the following deployment example we will use [AWS S3](https://aws.amazon.com/s3/). - -:::tip -Most cloud storage providers today have an S3-compatible API ([GCP](https://cloud.google.com/storage/docs/interoperability), [BackBlaze B2](https://www.backblaze.com/docs/cloud-storage-s3-compatible-api), [DigitalOcean](https://docs.digitalocean.com/products/spaces/how-to/use-aws-sdks/), [Linode](https://www.linode.com/docs/products/storage/object-storage/), [IBM Cloud](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-compatibility-api), and so forth) and can be used with this command - it is not limited to AWS. -::: - -Using AWS, you can [authenticate using the `aws` command line tool](https://docs.aws.amazon.com/sdk-for-net/v3/developer-guide/creds-idc.html) or you can provide access keys as below. - -If you are using AWS SSO, you should check the [AWS CLI SSO](https://aws.amazon.com/blogs/security/aws-single-sign-on-now-enables-command-line-interface-access-for-aws-accounts-using-corporate-credentials/) doc and [AWS session authentication](https://docs.aws.amazon.com/STS/latest/APIReference/API_GetSessionToken.html). - -```cmd -vpk download s3 --bucket MyApp --region us-west-1 --keyId {accessKeyId} --secret {accessKeySecret} -vpk pack -u YourAppId -v 1.0.1 -p {buildOutput} -vpk upload s3 --bucket MyApp --region us-west-1 --keyId {accessKeyId} --secret {accessKeySecret} -``` - -Note that you can specify most of these argumentsas environment variables too. You can review the [AWS SDK environment variables here](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html) and every `vpk` option can be provided as an environment variable too, to list these in the help text use `vpk -H` instead of `vpk -h`. - -When using a non-AWS S3-compatible API (eg. BackBlaze B2), you need to specify an endpoint instead of a region: - -```cmd -vpk download s3 --bucket MyApp --endpoint https://s3.eu-central-003.backblazeb2.com --keyId {accessKeyId} --secret {accessKeySecret} -vpk pack -u YourAppId -v 1.0.1 -p {buildOutput} -vpk upload s3 --bucket MyApp --endpoint https://s3.eu-central-003.backblazeb2.com --keyId {accessKeyId} --secret {accessKeySecret} -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/distributing/github-actions.mdx b/i18n/de/docusaurus-plugin-content-docs/current/distributing/github-actions.mdx deleted file mode 100644 index 16b0269..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/distributing/github-actions.mdx +++ /dev/null @@ -1,109 +0,0 @@ -# GitHub Actions - - - -This section assumes you have a basic knowledge of GitHub Actions. You can learn more about -creating workflows [here](https://docs.github.com/en/actions/deployment/about-deployments/deploying-with-github-actions). - -### Creating the Workflow - -The following example assumes you are building for Windows, but you can adapt the workflow for other platforms as well. - -First create a workflow in your repository at `.github/workflows` with the `.yml` extension, for example -`.github/workflows/main.yml`. This example workflow will run when code is pushed to the `main` branch. Refer to -documentation linked above if you would prefer a different trigger. - -```yml -name: Deploy to GitHub Releases - -on: - push: - branches: - - main -``` - -Create the job that will run when the trigger is activated. This example will run on a `windows-latest` machine as we're -packaging for Windows. - -```yml -jobs: - deploy-to-github-releases: - runs-on: windows-latest - steps: -``` - -### Compiling the Application - -First, add a step to checkout your repository to get all the files needed to compile your application. - -```yml - - name: Checkout Repository - uses: actions/checkout@v4 -``` - -You will need the version number of your release for packing with Velopack. There are many ways to handle this. -If you are using GitHub Action variables to handle this, you can skip this step. This example will extract the -version number from the `` tag in the `.csproj` of the application. The `bash` shell is defined here -as this command will fail when running on Windows otherwise. The command works by using a regular expression -with `grep` to extract the value between `` and `` in the csproj file, and store it in a -variable called `version` in the current run of the workflow. - -```yml - - name: Get Version from Project File - id: get-version - shell: bash - run: echo "version=$(grep -oE '[^<]+' MyApplication/MyApplication.csproj | sed 's///')" >> $GITHUB_OUTPUT -``` - -Next, add a step to install .NET so the application can be compiled. Set the `dotnet-version` to the version needed by -your application. - -```yml - - name: Install .NET - uses: actions/setup-dotnet@v4 - with: - dotnet-version: 8.0.x -``` - -Compile your application. This example will do so by publishing the application to a folder in a self-contained manner. -You can publish without the self-contained flag if using Velopack to install such dependencies -(see [Bootstrapping](../packaging/bootstrapping.mdx) for details). This command uses the `-c` flag to set the build -configuration to `Release` mode, `-o` to set the output directory to `publish`, `-r` to set the runtime -to `win-x64` for distributing on 64-bit Windows, and `--self-contained` to publish the .NET runtime with the -application. Adapt this command to your needs. You can learn more about -`dotnet publish` in the [Microsoft Documentation](https://learn.microsoft.com/dotnet/core/tools/dotnet-publish). - -```yml - - name: Publish Application - run: dotnet publish MyProject/MyProject.csproj -c Release -o publish -r win-x64 --self-contained true -``` - -### Deploying the Release - -Finally, use Velopack to package your application and deploy your release. Create a step that runs several commands -on the commandline. - -Let's break down what each line does. - -1. Installs the Velopack CLI. -2. Downloads the latest release of your repository. This is needed so that Velopack can create the delta package - between the current release and the new one, as well as populating the releases files. -3. Invokes the Velopack CLI to package your application. The `-v` argument calls upon - the `version` variable assigned earlier, which is accessed using the `id` of the step that assigned it (`get-version`). - `-p` is pointed at the `publish` directory that was used in the previous step. For more information on the Velopack CLI - and which flags are available for the `pack` command, [see here](../packaging/overview.mdx). -4. Creates a new release in your repository and uploads the necessary files to it automatically. - -:::tip -If your repository is private, you will need to provide Velopack with an OAuth token when using the `vpk download` -and `vpk upload` commands. Simply append the following to both commands: `--token ${{ secrets.GITHUB_TOKEN }}`. -::: - -```yml - - name: Create Velopack Release - run: | - dotnet tool install -g vpk - vpk download github --repoUrl https://github.com/Myname/Myrepo - vpk pack -u MyUniqueIdentifier -v ${{ steps.get-version.outputs.version }} -p publish - vpk upload github --repoUrl https://github.com/Myname/Myrepo --publish --releaseName "MyProject ${{ steps.get-version.outputs.version }}" --tag v${{ steps.get-version.outputs.version }} -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/distributing/overview.mdx b/i18n/de/docusaurus-plugin-content-docs/current/distributing/overview.mdx deleted file mode 100644 index 2f2d684..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/distributing/overview.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -sidebar_label: Overview -sidebar_position: 0 ---- - -# Distributing Overview - - -Distributing with Velopack is extremely easy, it's usually just as simple as uploading your files somewhere that can be downloaded with HTTP. This means you could host them on an IIS or nodejs site, on shared file hosting such as AWS S3, Azure Storage, BackBlaze B2, or even for free on GitHub/GitLab releases if your project is open source. - -The general steps for creating and deploying a Velopack release are: - -1. Download the latest published release (eg. 1.0.0). -2. Run `vpk pack` to create your new release (eg. 1.0.1). -3. Upload your newly created 1.0.1 assets. -4. Update the remote `releases.{channel}.json` to reflect the newly uploaded assets. - -See also: [Deployment commands](deploy-cli.mdx) can make this process much easier. - -## List of assets produced - -After packing a release with Velopack, you should have something like the following in your output directory: - -``` -Releases -├── YourAppId-1.0.1-full.nupkg -├── YourAppId-1.0.1-delta.nupkg -├── YourAppId-Setup.exe -├── YourAppId-Portable.zip -├── releases.{channel}.json -├── assets.{channel}.json -└── RELEASES -``` - -### Full and delta nupkg's - -These are the update packages that installed applications use to find/install the latest version. Full packages contain an entire replication of your input files, plus some files Velopack adds. A delta package is a diff from the previously created full package. You need to have the previous version (eg. 1.0.0 in the above example) downloaded and in the output directory for a delta to be created (in this case, `1.0.0->1.0.0`). There are helpful [deployment commands](deploy-cli.mdx) which can download the latest version for you, so that deltas will be generated automatically. - -You must distribute these packages in the same folder as the `releases.{channel}.json` file for updates to work. - -### Setup and portable - -This is what your user should download and run to install your app. On MacOS, you'll get a `.pkg` instead of a `-Setup.exe`. On Linux, there is no setup produced - only a portable `.AppImage`. The reason for this is that `.AppImage`'s are completely portable to any relatively recent distro of linux. - -### Release feed (`releases.{channel}.json`) - -This file should be distributed in the same folder as the `nupkg` files are deployed. It contains a list of all available releases. - -When you provide a HTTP url to `UpdateManager`, it will search for this file. For example, if you `new UpdateManager("https://the.place/you-host/updates")`, then UpdateManager will request for `https://the.place/you-host/updates/releases.{channel}.json`. The channel UpdateManager uses in the request is automatic, you can [read more here about channels](../packaging/channels.mdx). - -For example, if you packed `1.0.0` and then `1.0.1` immediately after, the contents of this file might look like: - -```json title="releases.win.json" -{ - "Assets": [ - { - "PackageId": "YourAppId", - "Version": "1.0.1", - "Type": "Full", - "FileName": "YourAppId-1.0.1-full.nupkg", - "SHA1": "537EC0F4E1C4263A230353FAB4150216E5AF3724", - "Size": 1588612 - }, - { - "PackageId": "YourAppId", - "Version": "1.0.1", - "Type": "Delta", - "FileName": "YourAppId-1.0.1-delta.nupkg", - "SHA1": "9615D266DDBCADF3B9CD82BABF9DA571A0EE2B83", - "Size": 3606 - }, - { - "PackageId": "YourAppId", - "Version": "1.0.0", - "Type": "Full", - "FileName": "YourAppId-1.0.0-full.nupkg", - "SHA1": "69122BABCEEEF9F653BFE59D87DDAEF363F9476F", - "Size": 1588613 - } - ] -} -``` - -The releases file should always mirror what files are _actually available_ in the remote folder that contains the releases file. So if you delete a nupkg release from the remote server, you should delete it from your remote release file too. If you are deploying newly created local files to a remote server which already contains some releases, then you should copy the assets from your local file to the remote releases file. - -:::warning -This file is the only way that UpdateManager can discover releases, if you do not update it properly it may result in your users not getting updates. -::: - -It is tedious to update this file manually, so Velopack CLI provides deployment commands which can deploy assets and update this file automatically for you, as well as apply rentention policies around the number of releases to keep. [\[Read more\]](deploy-cli.mdx) - -### Legacy release feed (`RELEASES`) - -This releases format was used by Clowd.Squirrel and Squirrel.Windows, and is still produced by Velopack to allow you to migrate an application using one of those frameworks to Velopack. If you do not have any legacy users which need to migrate to Velopack, you can safely ignore this file. - -### Assets file - -This file contains a list of assets produced by the latest `pack` command. It is used by the [Velopack deployment commands](deploy-cli.mdx) to know which files should be uploaded. It can be ignored / deleted if you do not intend to use these commands to deploy releases and automatically update your release feed. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/getting-started/cpp.mdx b/i18n/de/docusaurus-plugin-content-docs/current/getting-started/cpp.mdx deleted file mode 100644 index d236db3..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/getting-started/cpp.mdx +++ /dev/null @@ -1,85 +0,0 @@ -# Getting Started: C++ - - -Get started with our cross-platform C++ header library. - -1. Copy [Velopack.hpp](https://github.com/velopack/velopack.fusion/blob/master/for-cpp/Velopack.hpp) and [Velopack.cpp](https://github.com/velopack/velopack.fusion/blob/master/for-cpp/Velopack.cpp) into your project. - -2. Configure Unicode Support: - #### Windows - On Windows, to enable unicode support for this library you **_must_** - [configure the UTF-8 code page](https://learn.microsoft.com/en-us/windows/apps/design/globalizing/use-utf8-code-page) via your application - manifest. Failure to do so will potentially result in your application **_failing to update_** if there are any unicode characters in your user's - file paths, username, etc. - ```xml - - - - - UTF-8 - - - - ``` - #### Linux & MacOS - - If you are using Qt and `QString` is available, there's nothing further you need to do. - - If you are not using Qt, you'll need to [install ICU4C](https://icu.unicode.org/). Like many other C libraries, - installing the development package with your package manager (`apt`, `brew` etc) _should_ be sufficient to make it available to compilers. - -3. Add the `Velopack::startup()` to your entry point (eg. `main()` or `wmain()`) as early as possible, ideally the first statement to run: - - ```cpp - #include "Velopack.hpp" - - wmain(int argc**, wchar_t *argv[ ], wchar_t *envp[ ]) - { - // Velopack may exit / restart your app at this statement - Velopack::startup(argv, argc); - - // ... your other startup code here - } - ``` - -4. Add auto-updates somewhere to your app: - - ```cpp - #include "Velopack.hpp" - #include - - static void update_app() - { - Velopack::UpdateManagerSync manager{}; - manager.setUrlOrPath("https://the.place/you-host/updates"); - - auto updInfo = manager.checkForUpdates(); - if (updInfo == nullptr) { - return; // no updates available - } - - manager.downloadUpdates(updInfo->targetFullRelease.get()); - manager.applyUpdatesAndRestart(updInfo->targetFullRelease.get()); - } - ``` - -5. Install the `vpk` command line tool: - ```sh - dotnet tool update -g vpk - ``` - :::tip - **_You must have the .NET Core SDK 6 installed to use and update `vpk`_** - ::: - -6. Compile your app to a program using your usual compiler (eg. msvc, cmake, gcc, etc) - -7. Copy `Vfusion.exe`, `VfusionMac` or `VfusionNix` to your build output folder. This is a manual step for now, but may be automated in the future. You can compile this yourself, download a [recent build artifact](https://github.com/velopack/velopack.fusion/actions), or grab the latest [npm release](https://www.npmjs.com/package/velopack?activeTab=code) which also bundles the binaries. - :::warning - Until this is automated, failing to copy the fusion binary to your update directory will result in your app being unable to update. - ::: - -8. Package your Velopack release / installers: - ```sh - vpk pack -u MyAppUniqueId -v 1.0.0 -p /myBuildDir -e myexename.exe - ``` - -✅ You're Done! Your app now has auto-updates and an installer. -You can upload your release to your website, or use the `vpk upload` command to publish it to the destination of your choice. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/getting-started/csharp.mdx b/i18n/de/docusaurus-plugin-content-docs/current/getting-started/csharp.mdx deleted file mode 100644 index ce13114..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/getting-started/csharp.mdx +++ /dev/null @@ -1,48 +0,0 @@ -# Getting Started: .NET - - -Get started with .NET 5+ (cross-platform) or .Net Framework. - -1. Install the [Velopack NuGet Package](https://www.nuget.org/packages/velopack) in your main project: - ```cmd - dotnet add package Velopack - ``` -2. Configure your Velopack app at the beginning of `Program.Main`: - ```cs - static void Main(string[] args) - { - VelopackApp.Build().Run(); - // ... your other startup code below - } - ``` -3. Add automatic updating to your app: - - ```cs - private static async Task UpdateMyApp() - { - var mgr = new UpdateManager("https://the.place/you-host/updates"); - - // check for new version - var newVersion = await mgr.CheckForUpdatesAsync(); - if (newVersion == null) - return; // no update available - - // download new version - await mgr.DownloadUpdatesAsync(newVersion); - - // install new version and restart app - mgr.ApplyUpdatesAndRestart(newVersion); - } - ``` -4. Install the command line tool `vpk`: - ```cmd - dotnet tool update -g vpk - ``` -5. Publish dotnet and build your first Velopack release! 🎉 - ```batch - dotnet publish -c Release --self-contained -r win-x64 -o .\publish - vpk pack -u YourAppId -v 1.0.0 -p .\publish -e yourMainApp.exe - ``` - -✅ You're Done! Your app now has auto-updates and an installer. -You can upload your release to your website, or use the `vpk upload` command to publish it to the destination of your choice. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/getting-started/electron.mdx b/i18n/de/docusaurus-plugin-content-docs/current/getting-started/electron.mdx deleted file mode 100644 index 9e4513b..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/getting-started/electron.mdx +++ /dev/null @@ -1,79 +0,0 @@ -# Getting Started: JS / Electron - - -Get started with our NPM package for JS & Electron. - -If you are using pure nodejs and bundling your app using [pkg](https://github.com/vercel/pkg) or similar you can ignore Electron-specific steps. - -1. Add Velopack to your `package.json`: - ```txt - npm install velopack - ``` - -2. Add the following code to your entry point (eg. `index.js`) as early as possible (before any electron startup code etc.): - - ```js - const { VelopackApp } = require('velopack'); - - // Velopack builder needs to be the first thing to run in the main process. - // In some cases, it might quit/restart the process to perform tasks. - VelopackApp.build().run(); - - // ... your other app startup code here - ``` - -3. Add auto-updates somewhere to your app: - - ```js - const { UpdateManager } = require('velopack'); - - async function updateApp() - { - const um = new UpdateManager(); - um.setUrlOrPath("https://the.place/you-host/updates"); - - const updateInfo = await um.checkForUpdatesAsync(); - if (!updateInfo) { - return; // no update available - } - - await um.downloadUpdatesAsync(updateInfo.targetFullRelease, p => { - console.log(`progress: ${p}%`); - }); - - um.applyUpdatesAndRestart(updateInfo.targetFullRelease); - } - ``` - -4. If you are using electron/forge, you will need to add an asar unpack rule: - ```js - module.exports = { - packagerConfig: { - asar: { - // velopack contains native binaries which must remain unpacked - unpack: '**/node_modules/velopack/**', - }, - }, - } - ``` - -5. Compile your app to a binary (eg. `.exe` on Windows). Example using electron forge: - ```sh - npx electron-forge package - ``` - -6. Install the `vpk` command line tool: - ```sh - dotnet tool update -g vpk - ``` - :::tip - **_You must have the .NET Core SDK 6 installed to use and update `vpk`_** - ::: - -7. Package your Velopack release / installers: - ```sh - vpk pack -u MyAppUniqueId -v 1.0.0 -p /myBuildDir -e myexename.exe - ``` - -✅ You're Done! Your app now has auto-updates and an installer. -You can upload your release to your website, or use the `vpk upload` command to publish it to the destination of your choice. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/getting-started/fusion-cli.mdx b/i18n/de/docusaurus-plugin-content-docs/current/getting-started/fusion-cli.mdx deleted file mode 100644 index a5c1879..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/getting-started/fusion-cli.mdx +++ /dev/null @@ -1,128 +0,0 @@ -# Fusion CLI - - -Integrate directly using the command line interface. - -If there isn't a native library, or command line bindings for your language yet, you can directly integrate Velopack using the command line. - -**_There are two binaries needed._** - -## Fusion - -`Vfusion.exe` / `VfusionMac` / `VFusionNix`
-Provides support for getting current version, checking for updates, downloading updates etc. - -:::warning -At this time, the fusion binary is not automatically distributed, and you need to copy this into your compiler output directory. -You can download a [recent build artifact](https://github.com/velopack/velopack.fusion/actions) and make sure it's copied to your output dir during builds. -::: - -### Example - -``` -> Vfusion.exe check --url https://the.place/you-host/updates -``` - -These are the possible outputs: - -- **No updates are available:** empty stdout and `exitCode == 0`. -- **Unrecoverable error:** empty stdout and `exitCode != 0`. A [log file](#logging) will be created. -- **Update is availble:** stdout contains json object and `exitCode == 0`. - -When an update is available, you'll receive an [UpdateInfo](../reference/cs/Velopack/UpdateInfo.md) object via stdout: - -```json -{ - "isDowngrade": false, - "targetFullRelease": { - "packageId": "YourPackageId", - "version": "2.0.1", - "type": "Full", - "fileName": "YourPackageId-2.0.1-full.nupkg", - "sha1": "331a4f44a6a875b2ce139ae0c9ce5bb5e1ec0d97", - "size": 90654, - "notesMarkdown": "# Release v2.0.1 \n Your message here", - "notesHtml": "

Release v2.0.1


Your message here" - } -} -``` - -The next step is to download an update to disk, using the `fileName` property from the previous command: - -``` -> Vfusion.exe download \ - --url https://the.place/you-host/updates \ - --name YourPackageId-2.0.1-full.nupkg -``` - -During this command, fusion will output the current download progress to stdout. For example: - -``` -10 -20 -30 -40 -... -``` - -You can parse each line of stdout (split by `\n`) and show progress to your users. - -If `exitCode == 0` the command was successful. - -To get the final path to the downloaded asset, you can combine the result of `Vfusion.exe get-packages` and `fileName`. - -To install the update, please see the next section. - -:::tip -There are other commands (eg. `get-version`) which may be useful, explore them with `Vfusion.exe -h` -::: - -## Updater - -`Update.exe` / `UpdateMac` / `UpdateNix`
-Provides support for installing downloaded updates, prompting for elevation (if required), bootstrapping [dependencies](../packaging/bootstrapping.mdx), and so forth. - -:::info -This binary is automatically copied into your package when building `vpk`, you just need to locate it relative to your main executable. -::: - -You will use the `update apply` command to install a downloaded update. - -### Example - -``` -> Update.exe apply --restart -``` - -Running the above command will immediately close your program, install the update, and restart your app on the new version. - -:::tip -If called with no arguments, Update will apply the newest downloaded release, as long as it's newer than the currently installed release. -If you would like to install an older release, you need to specify the `--package` parameter. -::: - -All of the available apply options are below: - -``` -update apply: -Applies a staged / prepared update, installing prerequisite runtimes if necessary - -r, --restart Restart the application after the update - -w, --wait Wait for the parent process to terminate before applying the update - --waitPid Wait for the specified process to terminate before applying the update - -p, --package Update package to apply - -h, --help Print help - [EXE_ARGS]... Arguments to pass to the restarted executable. Must be preceeded by '--'. -``` - -## Logging - -Since errors are not printed on stdout, it is important to know where to locate log files to diagnose errors. - -### Windows - -Updater will log to it's own directory, and Fusion will log to the folder one above itself. -In a typical installation, this will result in both the Fusion logs and Updater log being merged into one log file. - -### Linux and MacOS - -On UNIX-like operating systems, the logs for these binaries always go to `/tmp/velopack.log`. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/getting-started/rust.mdx b/i18n/de/docusaurus-plugin-content-docs/current/getting-started/rust.mdx deleted file mode 100644 index 1f1780e..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/getting-started/rust.mdx +++ /dev/null @@ -1,72 +0,0 @@ -# Getting Started: Rust - - -Get started with our official cross-platform Rust Crate. - -1. Add Velopack to your `Cargo.toml`: - ```toml - [dependencies] - velopack = { version = "0.0", features = ["async"] } - # Replace above with actual version and desired features - ``` - -2. Add the following code to your `main()` function: - ```rust - use velopack::*; - fn main() { - // VelopackApp should be the first thing to run. - // In some circumstances it may terminate/restart - // the process during update/install. - VelopackApp::build().run(); - - // ... your other app startup code here - } - ``` - -3. Add auto-updates somewhere to your app: - - ```rust - use velopack::*; - use anyhow::Result; - - fn update_my_app() -> Result<()> { - let um = UpdateManager::new("https://the.place/you-host/updates", None)?; - - // check for updates - let updates: Option = um.check_for_updates()?; - if updates.is_none() { - return Ok(()); // no updates available - } - - // download updates - let updates = updates.unwrap(); - um.download_updates(&updates, |progress| { - println!("Download progress: {}%", progress); - })?; - - // apply updates - um.apply_updates_and_restart(&updates, RestartArgs::None)?; - Ok(()) - } - ``` - -4. Build your app with cargo: - ```sh - cargo build --release - ``` - -5. Install the `vpk` command line tool: - ```sh - dotnet tool update -g vpk - ``` - :::tip - **_You must have the .NET Core SDK 6 installed to use and update `vpk`_** - ::: - -6. Package your Velopack release / installers: - ```sh - vpk pack -u MyAppUniqueId -v 1.0.0 -p /target/release -e myexename.exe - ``` - -✅ You're Done! Your app now has auto-updates and an installer. -You can upload your release to your website, or use the `vpk upload` command to publish it to the destination of your choice. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/index.mdx b/i18n/de/docusaurus-plugin-content-docs/current/index.mdx deleted file mode 100644 index 81b7e42..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/index.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -disable_comments: true ---- - -# Introduction - -Velopack is an installation and auto-update framework for cross-platform desktop applications. It's opinionated, extremely easy to use with zero config needed. With just one command you can be up and running with an installable application, and it's lightning fast for your users, too. - -Be sure to check us out on [GitHub](https://github.com/velopack/velopack) and [join our Discord](https://discord.gg/CjrCrNzd3F) for any questions/support! - -## Overview - -To enable your application to make full use of Velopack, you need to do 3 things: - - -### Integrate the SDK & check for updates -We have client libraries for some [languages below](#language-support), or if we don't support your language yet you can use [our CLI](./getting-started/fusion-cli.mdx).
-[Read more →](integrating/overview.mdx) - - - -### Build a Velopack release -Our command-line tool `vpk` can help you build update packages and installers in just one command.
-[Read more →](packaging/overview.mdx) - - - -### Upload your releases somewhere -You can host updates anywhere static files can be served, eg. cloud file storage, GitHub Releases, and more.
-[Read more →](distributing/overview.mdx) - - -## Language Support - -There are libraries planned or supported for the languages below. - -| Lang | Status | Runtime Deps | Async | Links | | -| :----: | ------- | -------------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | -| C# | ✅ Ready | ✅ None | ✅ Yes | [quick start](./getting-started/csharp.mdx), [docs](./reference/cs/Velopack/), [samples](https://github.com/velopack/velopack/tree/master/samples), [nuget.org](https://nuget.org/packages/velopack) | | -| JS | ✅ Ready | ✅ None | ✅ Yes | [quick start](./getting-started/electron.mdx), [docs](./reference/js/classes/UpdateManager.md), [samples](https://github.com/velopack/velopack.fusion/tree/master/for-js/samples), [npmjs.com](https://www.npmjs.com/package/velopack) | | -| Rust | ✅ Ready | ✅ None | ✅ Yes | [quick start](./getting-started/rust.mdx), [docs](https://docs.rs/velopack), [samples](https://github.com/velopack/velopack.fusion/tree/master/for-rust/samples), [crates.io](https://crates.io/crates/velopack) | | -| C++ | ✅ Ready | 🔶 vfusion.exe | ❌ No | [quick start](./getting-started/cpp.mdx), [docs](./reference/cpp/api.md), [samples](https://github.com/velopack/velopack.fusion/tree/master/for-cpp/samples), [velopack.hpp](https://github.com/velopack/velopack.fusion/tree/master/for-cpp) | | -| Java | Planned | - | - | - | - | -| Python | Planned | - | - | - | - | -| Swift | Planned | - | - | - | - | -| Go | Planned | - | - | - | - | - -:::info -If your language is not listed, you can [**open an issue to request it**](https://github.com/velopack/velopack.fusion/issues), -or if your language supports running a process you can [**integrate directly with the Fusion CLI**](./getting-started/fusion-cli.mdx). -::: - - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/integrating/hooks.mdx b/i18n/de/docusaurus-plugin-content-docs/current/integrating/hooks.mdx deleted file mode 100644 index f300775..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/integrating/hooks.mdx +++ /dev/null @@ -1,31 +0,0 @@ -# App Hooks - - - -Hooks allow your application to run logic at various stages of the install/update/uninstall process. - -In general, I don't recommend trying to handle hooks manually - and instead refer to the available [VelopackApp](../reference/cs/Velopack/VelopackApp.md) options. - -If you wish to handle these yourself, an SDK doesn't exist for your language, or you just want to learn more about it, read on. - -## Command line hooks - -At various stages of the install/update/uninstall process, Velopack will execute your main executable (the one specified when packaging with `--mainExe {exeName}`) with certain cli arguments and expect your app to exit as quickly as possible. - -- `--veloapp-install {version}` Occurs after the program has been extracted, but before the install has finished. App must handle and exit within 30 seconds. -- `--veloapp-obsolete {version}` Runs on the old version of the app, before an update is applied. App must handle and exit within 15 seconds. -- `--veloapp-updated {version}` Runs on the new version of the app, after an update is applied. App must handle and exit within 15 seconds. -- `--veloapp-uninstall {version}` Runs before an uninstall takes place. App must handle and exit within 30 seconds. - -At this time, there is no way to provide feedback during the hooks that you would like to cancel the install/uninstall/update etc, and you may not show any UI to the user. - -:::warning -If your application receives one of these arguments and does not exit within the alloted time, it will be killed. -::: - -## Environment variable hooks - -There are also two environment variables that get set, if these are detected your app does not need to exit. - -- `VELOPACK_FIRSTRUN` is true if this is the first run after the app was installed. -- `VELOPACK_RESTART` is true if the application was restarted by Velopack (usually because an update was applied.) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/integrating/overview.mdx b/i18n/de/docusaurus-plugin-content-docs/current/integrating/overview.mdx deleted file mode 100644 index 1b56f44..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/integrating/overview.mdx +++ /dev/null @@ -1,132 +0,0 @@ ---- -sidebar_label: Overview -sidebar_position: 0 ---- - -# Integrating Overview - - - -To integrate Velopack into your application, you _must_ initialise the Velopack as early as possible in app startup, and you _should_ add update checking code somewhere. - -For .NET applications, you should first install the [Velopack Nuget Package](https://nuget.org/packages/velopack). - -## Application Startup - -Velopack requires you add some code to your application startup to handle hooks. This is because Velopack will run your main binary at certain stages of the install/update process with special arguments, to allow you to customise behavior. It expects your app to respond to these arguments in the right way and then exit as soon as possible. - -The simplest/minimal way to handle this properly is to add the SDK startup code to your `Main()` method. This should be in the "main" binary (the one specified when packaging with `--mainExe {exeName}`). - -```cs -static void Main(string[] args) -{ - VelopackApp.Build().Run(); - // ... your other startup code below -} -``` - -There are a variety of options / callbacks you can specify here to customise Velopack, for example: - -```cs -static void Main(string[] args) -{ - ILogger log = CreateLogger(); - VelopackApp.Build() - .WithBeforeUninstallFastCallback((v) => { - // delete / clean up some files before uninstallation - }) - .WithFirstRun((v) => { - MessageBox.Show("Thanks for installing my application!"); - }) - .Run(log); -} -``` - -The full list of options [for VelopackApp is available here](../reference/cs//Velopack/VelopackApp.md). You can also read more about [how hooks work](./hooks.mdx). - -:::warning -A "FastCallback" requires that your application show no UI and exit quickly. When the callback returns, your application will exit. If you do not exit this callback quickly enough your process will be killed. -::: - -## Configuring Updates - -Updates can be accomplished by adding [UpdateManager](../reference/cs/Velopack/UpdateManager.md) to your app: - -```cs -private static async Task UpdateMyApp() -{ - var mgr = new UpdateManager("https://the.place/you-host/updates"); - - // check for new version - var newVersion = await mgr.CheckForUpdatesAsync(); - if (newVersion == null) - return; // no update available - - // download new version - await mgr.DownloadUpdatesAsync(newVersion); - - // install new version and restart app - mgr.ApplyUpdatesAndRestart(newVersion); -} -``` - -:::tip -Updates can be done silently in the background, or integrated into your application UI. It's always up to you. -::: - -You can host your update packages basically anywhere, here are a few examples: - -- Local directory:
`new UpdateManager("C:\Updates")` -- HTTP server, or S3, Azure Storage, etc:
`new UpdateManager("https://the.place/you-host/updates")` -- GitHub Releases:
`new UpdateManager(new GitHubSource("https://github.com/yourName/yourRepo")` - -There are a variety of built-in sources (eg. [GithubSource](../reference/cs/Velopack.Sources/GithubSource.md), [SimpleWebSource](../reference/cs/Velopack.Sources/SimpleWebSource.md)) you can use when checking for updates, but you can also build your own by [deriving from IUpdateSource](../reference/cs/Velopack.Sources/IUpdateSource.md). - -### Check for updates - -`CheckForUpdatesAsync` will read the provided update source for a `releases.{channel}.json` file to retrieve available updates ([Read about channels](../packaging/channels.mdx)). If there is an update available, a non-null [UpdateInfo](../reference/cs/Velopack/UpdateInfo.md) will be returned with some details about the update. You can also [retrieve any release notes](release-notes.mdx) which were provided when the update was packaged. - -There are [also some options](../reference/cs/Velopack/UpdateOptions.md) which can be passed in to [UpdateManager](../reference/cs/Velopack/UpdateManager.md) to customise how updates are handled, eg. to allow things like [switching channels](switching-channels.mdx). - -### Download updates - -`DownloadUpdatesAsync` will attempt to download deltas (if available) and re-construct the latest full release. If there are no deltas available, or the delta reconstruction fails, the latest full release package will be downloaded instead. Note that if an option like `AllowVersionDowngrade` is specified, the downloaded version might be older than the currently executing version. - -### Apply updates - -Once the update has downloaded, you have a few options available. Calling `ApplyUpdatesAndRestart` or `ApplyUpdatesAndExit` will exit your app, install any [bootstrap prerequisites](../packaging/bootstrapping.mdx), install the update, and then optionally restart your app right away. - -If you do not want to exit your app immediately, you can call `WaitExitThenApplyUpdates` instead, which will launch Update.exe and wait for 60 seconds before proceeding. If your app has not exited within 60 seconds it will be killed. - -Lastly, if you do not call any of these "Apply" methods, when you re-launch your app, by default, Velopack will detect that there is a pending update and install it then. If you wish to disable this, you should call `VelopackApp.Build().SetAutoApplyOnStartup(false)`. - -:::tip -It is recommended that you use one of the functions which explicitly applies a package (eg. `ApplyUpdatesAndRestart`), and do not rely on the AutoApply behavior as a rule of thumb. The auto behavior will only apply a downloaded version if it is > the currently installed version, so will not work if trying to downgrade or switch channels, and if more than one instance of your process is running it could result in the update failing or those other processes being terminated. -::: - -## How updates work - -### On Windows - -In a typical Windows install the application structure will look like this: - -``` -%LocalAppData% -└── {packId} - ├── current - │ ├── YourFile.dll - │ ├── sq.version - │ └── YourApp.exe - └── Update.exe -``` - -`sq.version` is a special file created by Velopack which contains some metadata about your currently installed application. During install/uninstall, the entire `{packId}` folder is replaced or removed. During updates, only the `current` folder is replaced. If you store settings in the same folder as your main binary, they will be erased during updates. - -:::warning -Since `current` is replaced with the new version during updates, it's not safe to store settings, logs, etc in the `current` dir where your app lives. See **_[Preserving Files](./preserved-files.mdx)_** for more info. -::: - -### On Linux & Mac - -On these platforms, the app is stored as a single (typically read-only) bundle like `.app` or `.AppImage`. The bundle is replaced during updates in a single atomic operation. -If you have any files you wish to persist (settings, logs, etc) you must find a directory elsewhere on the filesystem to store these files. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/integrating/preserved-files.mdx b/i18n/de/docusaurus-plugin-content-docs/current/integrating/preserved-files.mdx deleted file mode 100644 index f8bf052..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/integrating/preserved-files.mdx +++ /dev/null @@ -1,22 +0,0 @@ -# Preserving Files & Settings - - -Your application binary files get completely replaced during updates, so you should not store important files in the same directory as your application binary files. - -## Application Settings - -If you want to create settings that persist through updates, but are erased when the app is uninstalled, on Windows you should store them one level up (`..\`) outside of the `current` dir. - -If you want to create files which persist even if the app is uninstalled (eg. important user settings) then you should store them in `%AppData%\{packId}` (that's the **_roaming app data_**, not local app data where the app lives). - -## Sentry / Crashpad / Error Reporting - -Many error crash handling utilities will store error/crash reports to the application directory by default, and will upload them as a report the next time the application starts. - -You need to ensure any of these libraries can be configured with a database / storage directory outside of the current application directory somewhere. -On Windows, you just need to be outside the `%LocalAppData\{packId}\current` directory. So you could use `..\` (this is the same as `%LocalAppData\{packId}`). - -## Non-Windows - -For other non-Windows operating systems, you should search online to find best practices about where to store settings/log files for installed apps. -The recommended location is OS / distro specific, and might be in `/var` or somewhere in user home `~` (eg. `~/Library/Application Support` on MacOS). diff --git a/i18n/de/docusaurus-plugin-content-docs/current/integrating/release-notes.mdx b/i18n/de/docusaurus-plugin-content-docs/current/integrating/release-notes.mdx deleted file mode 100644 index ca495b8..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/integrating/release-notes.mdx +++ /dev/null @@ -1,23 +0,0 @@ -# Release Notes - - -It is possible to store release notes (Markdown) in update packages and access it while Updating. This could be useful, for example, to show a user a list of changes before downloading a update. - -- Write your release notes to a file (eg. releasenotes.mdx). -- While packing your release, provide these to Velopack with `--releaseNotes {path/to/releasenotes.md}` - -The Velopack builder will render this to HTML for your convenience, and store both the HTML and the markdown into your update package. - -Now, release notes will be available while checking for updates, for example: - -```cs -private static async Task UpdateMyApp() -{ - var mgr = new UpdateManager("https://the.place/you-host/updates"); - - var newVersion = await mgr.CheckForUpdatesAsync(); - if (newVersion != null) { - new ReleaseNotesHtmlWindow(newVersion.TargetFullRelease.ReleaseNotesHtml).Show(); - } -} -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/integrating/shortcuts.mdx b/i18n/de/docusaurus-plugin-content-docs/current/integrating/shortcuts.mdx deleted file mode 100644 index b654642..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/integrating/shortcuts.mdx +++ /dev/null @@ -1,19 +0,0 @@ -# Windows Shortcuts - - -By default, during installation Velopack will create a shortcut on the Desktop and in the StartMenuRoot. It will automatically delete any shortcuts it finds when uninstalling the application. - -The name of the shortcuts will be determined by the `--packTitle` vpk argument. For example, if you pass `--packTitle "My Fancy App"`, then the shortcuts created will be created as `"My Fancy App.lnk"`. - -If you need to create shortcuts in any extra locations, the `Velopack.Windows.Shortcuts` and `Velopack.Windows.ShellLink` classes are provided. These classes are provided for legacy reasons, and in general the stability of such functions is not guarenteed. - -For example, if you wished to create a shortcut during the install of your app, you might do the following: - -```cs -using Velopack; -using Velopack.Windows; - -VelopackApp.Build() - .WithAfterInstallFastCallback((v) => new Shortcuts().CreateShortcutForThisExe(ShortcutLocation.Desktop)) - .Run() -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/integrating/switching-channels.mdx b/i18n/de/docusaurus-plugin-content-docs/current/integrating/switching-channels.mdx deleted file mode 100644 index d70d44c..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/integrating/switching-channels.mdx +++ /dev/null @@ -1,30 +0,0 @@ -# Switching Channels - - -By default, `UpdateManager` will try and search for releases in the same channel that it was built for. You can [read more about packaging channels here](../packaging/channels.mdx). So normally, you should not provide a channel at all to the `UpdateManager` constructor. - -However, from time to time, it may be useful to allow a user to switch channels without re-installing the application. For example, a user opts into getting "beta" features via your application settings. In that case, you can provide the channel explicitly: - -```cs -new UpdateManager("https://the.place/you-host/updates", new UpdateOptions { - ExplicitChannel = "beta" -}); -``` - -Also by default, the UpdateManager will only update to versions which are newer than the current version, leading to suboptimal behavior because often you may be switching to a version which is lower than the current version. Imagine the following scenario: - -- You publish 2.0.0 to the `stable` channel. -- You publish 2.0.1 through 2.0.5 to the `beta` channel. -- Your user installs 2.0.0 `stable`, and then opts-in to `beta` via settings. -- Your user can update from 2.0.0 -> 2.0.5 fine, because 2.0.5 is a newer version. -- Your user encounters a bug and turns off `beta` via settings. -- By default, UpdateManager will not install stable 2.0.0 because it is a lower version than 2.0.5. - -It's for this reason I recommend always using the `ExplicitChannel` option with the `AllowVersionDowngrade` option. For example: - -```cs -new UpdateManager("https://the.place/you-host/updates", new UpdateOptions { - ExplicitChannel = "beta", - AllowVersionDowngrade = true, -}); -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/migrating/squirrel.mdx b/i18n/de/docusaurus-plugin-content-docs/current/migrating/squirrel.mdx deleted file mode 100644 index 4623fcb..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/migrating/squirrel.mdx +++ /dev/null @@ -1,70 +0,0 @@ -# From Squirrel - - -Migrate `Squirrel.Windows` or `Clowd.Squirrel` to Velopack. - -Here are the general steps needed: - -1. Replace the `Squirrel.Windows` or `Clowd.Squirrel` nuget package with the latest [Velopack NuGet Package](https://www.nuget.org/packages/velopack). - -2. Install the `vpk` command line tool, as this is what you'll use to build Velopack releases. - ```cmd - dotnet tool install -g vpk - ``` - -3. You will need to replace `SquirrelAwareApp` at the beginning of your app to `VelopackApp.Build().Run()`. Shortcuts [\[Read more\]](integrating/shortcuts.mdx) and registry entries are managed automatically for you in Velopack, so if you are currently doing this in `SquirrelAwareApp` hooks they should be removed. For example, if your hooks were this before: - - ```cs - public static void Main(string[] args) - { - SquirrelAwareApp.HandleEvents( - onInitialInstall: OnAppInstall, - onAppUninstall: OnAppUninstall, - onEveryRun: OnAppRun); - } - - private static void OnAppInstall(SemanticVersion version, IAppTools tools) - { - tools.CreateShortcutForThisExe(ShortcutLocation.StartMenu | ShortcutLocation.Desktop); - } - - private static void OnAppUninstall(SemanticVersion version, IAppTools tools) - { - tools.RemoveShortcutForThisExe(ShortcutLocation.StartMenu | ShortcutLocation.Desktop); - } - - private static void OnAppRun(SemanticVersion version, IAppTools tools, bool firstRun) - { - if (firstRun) MessageBox.Show("Thanks for installing my application!"); - } - ``` - - Then you would migrate to the following code, removing the shortcut hooks: - - ```cs - public static void Main(string[] args) - { - // Thank the user for installing the app on first run. - // Note that the MessageBox class below comes from WinForms or WPF. - VelopackApp.Build() - .WithFirstRun(v => MessageBox.Show("Thanks for installing my application!")) - .Run(); - } - ``` - -4. The concept of `SquirrelAwareApp` no longer exists, so if you've added any attributes, assembly manifest entries, or other files to indicate that your binary is now aware, you can remove that. Every Velopack package has exactly one "VelopackApp" binary, which must implement the above interface at the top of `Main`. By default, Velopack will search for a binary in `{packDir}\{packId}.exe`. If your main VelopackApp exe is named differently, you should provide the name with the `--mainExe yourApp.exe` argument. - -5. The "RELEASES" file is no longer a format that Velopack uses, but it will produce one when building packages on windows with the default channel (eg. no channel argument provided). Instead, Velopack will produce `releases.{channel}.json` files, which should be treated in the same way. If you are wishing for a legacy windows app to migrate to Velopack, you should upload both the `RELEASES` file and the `releases.win.json` file which is produced by Velopack to your update feed. - -6. In general, the command line supports all of the same features, but argument names or commands may have changed. Velopack no longer supports taking a `.nupkg` which was created by dotnet or nuget.exe. You should publish your app, and use `vpk pack` instead. A very simple example might look like this - - ```cmd - dotnet publish --self-contined -r win-x64 -o publish - vpk pack -u YourAppId -v 1.0.0 -p publish -e yourMainBinary.exe - ``` - - Please review the vpk command line help for more details: - - ```cmd - vpk -h - ``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/packaging/bootstrapping.mdx b/i18n/de/docusaurus-plugin-content-docs/current/packaging/bootstrapping.mdx deleted file mode 100644 index 7f3fb31..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/packaging/bootstrapping.mdx +++ /dev/null @@ -1,86 +0,0 @@ -# Bootstrapping - - -Install .NET, vcredist, webview2, and more while installing Velopack applications on Windows using the `--framework` / `-f` argument. - -It is possibly to specify more than one requirement, using a comma delimited list. For example: - -```cmd -vpk pack ... --framework net6.0-x64-desktop,vcredist142-x64 -``` - -These dependencies will be downloaded and installed before your application will be installed. - -:::warning -If you are building a dotnet application with `--self-contained`, you should **NOT** provide a `--framework` argument specifying that your app requires dotnet installed, because your application already has the runtime bundled in. If you are publishing your application with `--no-self-contained`, then you should provide the `--framework` argument. -::: - -## Adding dependencies during updates - -Velopack will check that all required dependencies are installed before applying new updates. This means if a new version of your app adds a new dependency, the user will be prompted to install it before your new version is applied. - -## List of supported frameworks - -Any of the following can be passed via the `--framework` argument. - -### Edge WebView2 - -- `webview2` - -### vcredist - -- `vcredist100-x86` (VC++ 10.0 / VS 2010) -- `vcredist100-x64` (VC++ 10.0 / VS 2010) -- `vcredist110-x86` (VC++ 11.0 / VS 2012) -- `vcredist110-x64` (VC++ 11.0 / VS 2012) -- `vcredist120-x86` (VC++ 12.0 / VS 2013) -- `vcredist120-x64` (VC++ 12.0 / VS 2013) -- `vcredist140-x86` (VC++ 14.0 / VS 2015) -- `vcredist140-x64` (VC++ 14.0 / VS 2015) -- `vcredist141-x86` (VC++ 14.1 / VS 2017) -- `vcredist141-x64` (VC++ 14.1 / VS 2017) -- `vcredist142-x86` (VC++ 14.2 / VS 2019) -- `vcredist142-x64` (VC++ 14.2 / VS 2019) -- `vcredist143-x86` (VC++ 14.3 / VS 2022) -- `vcredist143-x64` (VC++ 14.3 / VS 2022) -- `vcredist143-arm64` (VC++ 14.3 / VS 2022) - -### .Net Framework - -- `net45` -- `net451` -- `net452` -- `net46` -- `net461` -- `net462` -- `net47` -- `net471` -- `net472` -- `net48` -- `net481` - -### dotnet - -Every version of dotnet is supported >= 5.0. The framework argument should be supplied in the format `$"net{major.minor}-{arch}-{type}"`. - -The valid `{arch}` values are - -- x86 -- x64 -- arm64 - -The valid `{type}` values are - -- runtime -- aspnetcore -- desktop - -Here are some examples: - -- .NET 6.0 Desktop Runtime (x64) `--framework net6.0-x64-desktop` -- .NET 8.0 Runtime (arm64) `--framework net8.0-arm64-runtime` -- .NET 5.0 AspNetCore (x86) `--framework net5.0-x86-aspnetcore` - -By default, Velopack will accept any installed release, but always install the latest. That is to say, if your dependency is specified as `net6.0-x64-desktop` and version `6.0.2` is installed, it will be accepted. If it's not installed, Velopack will download the latest available version (at the time of writing, that's `6.0.26`). - -If you need a specific version of dotnet, (eg. `6.0.11`) - you can specify a third version part in your dependency string: `--framework net6.0.11-x64-desktop`. In this case, if the installed version is `< 6.0.11`, then it will be upgraded to the latest available. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/packaging/channels.mdx b/i18n/de/docusaurus-plugin-content-docs/current/packaging/channels.mdx deleted file mode 100644 index b20b7a3..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/packaging/channels.mdx +++ /dev/null @@ -1,41 +0,0 @@ -# Release Channels - - -Channels is a fundemental part of how Velopack understands and builds releases. Every release must belong to a channel. If you do not specify a channel when building a release (via the `--channel`) argument, the default channel will be the name of the target Operating System (eg. `win`, `osx`, or `linux`). - -When building releases, Velopack will create a `releases.{channel}.json` file, that should be uploaded with your other assets (eg. `.nupkg`). This is how `UpdateManager` knows what releases are available. - -In general, you should not provide a channel to the `UpdateManager` constructor (leave it null). In this case, it will only search for update packages in the same channel that the current release was built for. For example, if you provided the `--channel stable` argument to `vpk`, and installed your app, then `UpdateManager` will automatically be searching for the file `releases.stable.json` when checking for updates. - -:::tip -For legacy purposes, Velopack will also generate a `RELEASES` file (for the `win` channel), or a `RELEASES-{channel}` file (for any other channel). By deploying these files as well as the `releases.{channel}.json` will allow legacy apps to upgrade to Velopack. If you do not have any users on legacy versions of your software, you can ignore these files. -::: - -## Switching channels in installed apps - -It is often desirable to allow users to switch channels easily. For example, if your users downloaded an installer for a "stable" version of your app, they will only receive updates for the "stable" channel. Later on, they decide they wish to switch to the "beta" channel to try some experimental features in your app. - -This can be done by supplying a non-null channel argument to the UpdateManager constructor. So you would instantiate as `new UpdateManager("https://the.place/you-store/updates", "beta")` and then perform an update process as usual. - -## Deploying cross-platform apps - -It's important when deploying cross platform (or cross-architecture) apps that every unique os/rid has it's own channel. It wouldn't be good if your Windows app tried to install an OSX package etc! - -The default channels are, `win`, `osx`, or `linux`, so if you are only distributing one release per platform, you do not need to specify a channel argument, everything should work automatically. If you are distributing feature channels (eg. 'stable', 'beta') or need to distribute multiple versions of your app per os (eg. `win-x64`, `win-arm64`) then you will need to define a channel strategy that does not collide. - -For example, if I was distributing an app on windows and osx which needed to support x64, and arm64, and also needed to support "stable" and "beta", then I would need the following 8 channels: - -- win-x64-stable -- win-x64-beta -- win-arm64-stable -- win-arm64-beta -- osx-x64-stable -- osx-x64-beta -- osx-arm64-stable -- osx-arm64-beta - -## Renaming a channel - -You can't rename a channel per-say, but you can supercede it (ie. force all your users to switch to the new channel). Imagine you have been publishing an app that only supports x64 windows to the channel `stable` until now, but you now would like to release an arm64 version of your app. So you want to migrate all the users on `stable` to `win-x64`, while also creating a new channel named `win-arm64`. - -You should publish your next update (say v2.0.0) using `--channel win-x64`, which will create a new `releases.win-x64.json` file. You can now copy this file and rename it to `releases.stable.json` and deploy both files along with your v2.0.0 `.nupkg` to your update server. Any users on the "stable" channel will find the `releases.stable.json` file and update to your v2.0.0 win-x64 release, and once done will search for future updates at `releases.win-x64.json`. You only need to do this once, you will not need to update the `releases.stable.json` file again, however you may not want to delete it so users who have not opened your app in some time can still find the new updates. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/packaging/deltas.mdx b/i18n/de/docusaurus-plugin-content-docs/current/packaging/deltas.mdx deleted file mode 100644 index 59b5111..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/packaging/deltas.mdx +++ /dev/null @@ -1,47 +0,0 @@ -# Delta Updates - - -Delta updates provide speedy updates for even the biggest of applications. - -By default, as long as there is a previous release in your `--outputDir` / `-o` directory, Velopack will automatically generate a delta when creating a new release. - -:::tip -If you don't have the latest local release, eg. you're running in CI, you can use the `vpk download` command to automatically fetch it so delta's can be created. -::: - -Delta packages use [Zstandard](https://github.com/facebook/zstd) to create binary patches of individual files in your package. Due to limitations of Zstandard, no single file can be bigger than 2 GB. - -## Optimising for size - -The default parameters picked for patch generation are to provide a good balance of size and speed. -If you would like to optimize for size, you can do this with the `--delta BestSize` argument. -YMMV, for some appliations this may give you big size savings, for others it may not. Either way it will be a lot slower, about on-par with the `bsdiff` algorithm. - -## How delta's work - -During updates, Velopack will look for possibly more than one delta to download. Imagine you have published the following releases: - -- `1.0.0` -- `1.0.1` -- `1.0.2` -- `1.0.3` - -If a user has not opened your app in a while, and has `1.0.0` installed, the next time they open the app, -3 delta's will be downloaded: `1.0.1-delta`, `1.0.2-delta`, and `1.0.3-delta`. - -The previously downloaded/installed package is stored in `%LocalAppData\{packId}\packages`, so Velopack will then apply those 3 delta's sequentially -on top of the local package that exists in that directory. - -Once the delta's have been applied, and the `1.0.3` release has been reconstructed, it will be ready for applying. - -There is a heuristic in Velopack which will attempt to decide whether it is better to download N delta's or download the latest full release instead. -This is based on a number of factors (eg. size of the full release, sum size of the delta's, total number of delta's between the current & target version). - -## GitHub Releases - -There is special support for GitHub Releases in `UpdateManager` which will search through a number of previous GitHub Releases for available delta's. -This means any one GitHub release must only have 1 full package and 1 delta update to facilitate proper updating. - -## Disabling delta's - -If for some reason you don't want to deploy delta's, you can disable them with the `--delta none` argument. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/packaging/installer.mdx b/i18n/de/docusaurus-plugin-content-docs/current/packaging/installer.mdx deleted file mode 100644 index 6c74d51..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/packaging/installer.mdx +++ /dev/null @@ -1,52 +0,0 @@ -# Installers - - -Velopack takes a relatively light-touch when it comes to installers, so there is not a lot of customisation available like you would find in other installation frameworks. This is the tradeoff Velopack makes to ensure that the developer/user experience is as fast and easy as possible. - -In both operating systems, if [code signing is configured](signing.mdx) the installer will also be signed. (This is _required_ on MacOS) - -## Windows Overview - -The Windows installer is currently a "one-click" installer, meaning when the `Setup.exe` binary is run, Velopack will not show any questions / wizards to the user, it will simply attempt to install the app as fast as possible and then launch it. - -The setup will install a shortcut to `StartMenuRoot` and `Desktop` by default. [\[Read more\]](../integrating/shortcuts.mdx) - -The key options which will customize the installer are as follows: - -- `--packTitle {app name}` customizes shortcut names, the Apps & Features name, and the portable entry exe name. -- `--icon {path}` sets the .ico on Update.exe and Setup.exe (and also the icon of any dialogs shown) -- `--splashImage {path}` sets the (possibly animated) splash image to be shown while installing. - -The splash image can be a `jpeg`, `png`, or `gif`. In the latter case, it will be animated. - -You can also [bootstrap required frameworks](bootstrapping.mdx) before installing your app. - -The Windows installer will extract the application to `%LocalAppData%\{packId}`, and the directory structure will look like: - -``` -{packId} -├── current -│ ├── YourFile.dll -│ ├── sq.version -│ └── YourApp.exe -└── Update.exe -``` - -The `current` directory will be fully replaced [while doing updates](../integrating/overview.mdx). The other two files added by Velopack (`Update.exe` and `sq.version`) are crucial and are required files for Velopack to be able to properly update your application. - -## MacOS Overview - -The MacOS installer will be a standard `.pkg` - which is just a bundle where the UI is provided by the operating system, allowing the user to pick the install location. The app will be launched automatically after the install (mirroring the behavior on Windows) because of a `postinstall` script added by Velopack. - -The key options which will customize the installer are as follows: - -- `--packTitle {app name}` customizes the name of the `.app` bundle and the app name shown in the `.pkg` -- `--pkgWelcome {path}` adds a Welcome page -- `--pkgReadme {path}` adds a Readme page -- `--pkgLicense {path}` adds a License Acceptance page -- `--pkgConclusion {path}` adds a Conclusion page -- `--noPkg` disable generating a `.pkg` installer entirely - -The pkgPage arguments can be a `.rtf` or a `.html` file. - -The `.app` package can be extracted to `/Applications` or `~/Applications`, this is selected by the user while installing. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/packaging/operating-systems/linux.mdx b/i18n/de/docusaurus-plugin-content-docs/current/packaging/operating-systems/linux.mdx deleted file mode 100644 index 41b3412..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/packaging/operating-systems/linux.mdx +++ /dev/null @@ -1,48 +0,0 @@ -# Linux Overview - - -Linux specific notes about creating and using Velopack packages. - -On Linux, Velopack does not create an installer, it simply creates an `.AppImage` file. - -The user will: - -- Download the `.AppImage` file -- Set permission with `chmod +x YourFile.AppImage` -- Run with `./YourFile.AppImage` - -## Packaging - -An icon is required to build an AppImage, and it ideally should be in PNG format. This can be provided with the `--icon` argument. - -It is possible for `vpk` to fully create the AppImage/AppDir structure for you automatically, given your build directory as usual. -Optionally, you can pre-build your AppImage/AppDir structure to the [following specification](https://github.com/AppImage/AppImageKit/wiki/AppDir). -If you have staged your AppDir, use the `--appDir` argument _instead of_ the `--packDir / -p` argument. -Also, it's expected that the icon and `.desktop` file will already exist, so you should no longer provide the `--icon` argument with `--appDir`. - -## Updating - -During updates, packages are downloaded to a temporary location (`/var/tmp`) and then the `.AppImage` is replaced. -If the `.AppImage` is in a privileged folder, the updater will automatically prompt for sudo using `pkexec`. -The app can technically be updated while it's running, although Velopack will make an effort to close/restart it to clear out any old versions curently running. - -## What is an AppImage? - -AppImage does not install software in the traditional sense (i.e., it do not put files all over the place in the system). - -It use one file per application. Each one is self-contained: it includes all libraries the application depends on and that are not part of the base system. -In this regard, it is similar to "application virtualization". -One can use a AppImage file even if they are not a superuser, or they are using a live CD. -AppImage files are often simpler than compiling and installing an application, as no installation actually took place. -The AppImage file is a compressed image which is temporarily mounted to allow access to the program, but not having to extract the program or modify the underlying system. - -## Why AppImage, and not deb, snap, etc? - -- AppImage is a format for binary software distribution. Software packaged as AppImage is intended to be as binary-compatible as possible with as many systems as possible. -- An AppImage should run on pretty much all base operating systems (distributions). For example, you could target Ubuntu 9.10, openSUSE 11.2, and Fedora 13 (and later versions) at the same time, without having to create and maintain separate packages for each target system. -- AppImages are relocatable and portable, and do not modify the operating system in any way. This means it can be directly run on a Live CD, USB stick, etc. - -## Can an AppImage be "installed"? - -Yes, it can - but this exercise is generally left up to the user. There are frameworks which will install an AppImage on first run, by moving it to a pre-determined location, adding a dock/launcher/desktop shortcut etc. -One such framework is [AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher), but there are also others. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/packaging/operating-systems/macos.mdx b/i18n/de/docusaurus-plugin-content-docs/current/packaging/operating-systems/macos.mdx deleted file mode 100644 index d10cd7f..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/packaging/operating-systems/macos.mdx +++ /dev/null @@ -1,37 +0,0 @@ -# MacOS Overview - - -MacOS specific notes about creating and using Velopack packages. - -For Mac, applications are distributed as `.app` bundles. These are special folders that appear in Finder like a single file. - -## Packaging - -If you are creating a custom bundle, you can provide a folder ending in `.app` to the `--packDir` / `-p` argument, Velopack will copy and use this directly. -If you do not wish to create the `.app` bundle manually, Velopack can do this for you, so just supply any other folder (which does not end in `.app`) to the `--packDir` argument. - -If you wish for Velopack to automatically create a bundle, the only additional argument you need to provide is `--icon`, and this must be a valid `.icns` file. - -:::warning -[Code signing and notarization](../signing.mdx) is required by Apple before shipping your releases to users, or your app won't run. -::: - -## Updating - -During updates, packages are downloaded to `/tmp`, and during apply step the `.app` bundle will be extracted and replaced. - -If the `.app` is installed to `/Applications` (and not `~/Applications` for example), elevation may be required. -In this case, the updater will use AppleScrpt to request elevation and complete the update. -The `.app` bundle created by Velopack does not need to be in `/Applications` to support updates, it is a portable / self contained bundle -and if it is moved by the user it is still capable of applying updates. - -The app can technically be updated while it's running, although Velopack will make an effort to close/restart it to clear out any old versions curently running. - -## Installing - -Velopack will automatically generate and sign a `.pkg` installer for you, which allows you to show a readme, conclusion, license page, etc. -See the command line help for a complete list of options. -It also allows the user to choose whether to install to `/Applications` or `~/Applications`, and will launch the app automatically after it's been installed. - -If you do not wish to ship a pkg, Velopack also creates a portable `.zip` which will be automatically extracted if clicked by the user in Finder. -If you wish to ship a DMG instead, you can unzip this portable package and create a DMG that way. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/packaging/operating-systems/windows.mdx b/i18n/de/docusaurus-plugin-content-docs/current/packaging/operating-systems/windows.mdx deleted file mode 100644 index 219255b..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/packaging/operating-systems/windows.mdx +++ /dev/null @@ -1,61 +0,0 @@ -# Windows Overview - - -Windows specific notes about creating and using Velopack packages. - -For Windows, Velopack creates and installs a folder structure which looks like the following: - -``` -%LocalAppData% -└── {packId} - ├── current - │ ├── YourFile.dll - │ ├── sq.version - │ └── YourApp.exe - └── Update.exe -``` - -## Packaging - -There are no special requirements to package a program for Windows, although you may wish to customise the installer -using `--packTitle`, `--splashImage`, `--icon` etc. See the command line help for a complete list of options. - -It's also very recommended (but not required) that you [code sign](../signing.mdx) before shipping to your users. If you do not do this, -your app may be flagged as a virus. - -## Updating - -During updates, the entire `current` directory will be replaced, so if you need to store settings, logs, crash reports, and so on, -please see [Preserving Files](../../integrating/preserved-files.mdx). - -On Windows, if any of the files inside `current` are in-use, the folder can not be moved/renamed/deleted, etc. -There lots of things that could lock this folder. For example: - -- A process running inside `current` -- A process running outside of `current`, which has opened a file inside `current` for reading. -- Anti-virus / Windows Defender, etc -- A process with it's CWD (current working dir) inside that folder (for example, a `cmd.exe` process). - -If the folder can not be renamed during the update process, Velopack's updater will attempt to automatically kill any processes running inside `current`. -If the folder is still locked and can not be renamed, the updater will search for other processes on the system which may be locking the folder - -and if any are found, it will open a dialog to the user offering to kill them or abort the update. If the locking process could not be identified, -(for example, if the locking process is running as Administrator) then an error message will be shown to the user, and the old version of the -application will be launched. - -:::info -Currently, neither the updater nor the installer support privileged directories such as `C:\Program Files`, but support for this is planned in the future. -::: - -## Installing - -The setup produced by Velopack is a one-click installer, which will show the splash image of your choice (PNG, JPG, or animated GIF), -or if you do not provide an image it will be a simple progress bar. - -By default the installer will install to `%LocalAppData%\{packId}` but this can be overridden at runtime with the `Setup.exe --installto {dir}` argument. - -Before starting installation, the installer will check that the [App RID](../rid.mdx) is compatible with the current operating system, -and also check for any missing [boostrapping dependencies](../bootstrapping.mdx). - -Also, during installation the installer will run [App Hooks](../../integrating/hooks.mdx), as well as launch the application for the first time -once installation has completed. If you would like to prevent the application from being launched after install has completed, -you can do this with the `Setup.exe --silent` argument. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/packaging/overview.mdx b/i18n/de/docusaurus-plugin-content-docs/current/packaging/overview.mdx deleted file mode 100644 index e170fe5..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/packaging/overview.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_label: Overview -sidebar_position: 0 ---- - -# Packaging Overview - - - -Packaging a release is accomplished with the `pack` command in Velopack. Regardless of your operating system, the common required arguments are roughly the same. - -## Creating your first release - -You first should compile your application with whatever toolchain you would normally use (eg. `dotnet publish`, `msbuild.exe`, so forth). -Henceforth this will be called `{build_dir}`. - -### Required arguments - -- `--packId {id}` The unique ID of your application. This should be unique enough to avoid other application authors from colliding with your app. -- `--packVersion {version}` The current version you are releasing - in [semver2 format](https://semver.org/) (eg. `1.0.0-build.23+metadata`). -- `--packDir {build_dir}` The folder containing your compiled application. -- `--mainExe {exeName}` The main executable to be started after install, and the binary that will [handle Velopack Hooks](../integrating/overview.mdx). -- `--icon {path}` The icon used to bundle your app. Only required on MacOS and Linux. - -:::tip -Velopack does not support 4 part versions (eg. `1.0.0.0`), as it would not be practical to support both formats simultaneously and semver2 offers a lot more flexibility. -::: - -A complete example: - -```cmd -dotnet publish -c Release -r win-x64 -o publish -vpk pack --packId MyAppId -packVersion 1.0.0 --packDir publish --mainExe MyApp.exe -``` - -### Optional recommended arguments - -There are many optional arguments, the best way to see what features are available for your operating system is to check `vpk pack -h`. To mention a couple: - -- `--packTitle {name}` The friendly name for your app, shown to users in dialogs, shortcuts, etc. -- `--outputDir {path}` The location Velopack should create the final releases (defaults to `.\Releases`) - -### Release output - -When building a release has completed, you should have the following assets in your `--outputDir`: - -- `MyAppId-1.0.0-full.nupkg` - Full Release: contains your entire update package. -- `MyAppId-1.0.0-delta.nupkg` - Delta Release: only if there was a previous release to build a delta from. These are optional to build/deploy, but speeds up the updating process for sers because they only need to download what's changed between versions instead of the full package. -- `MyAppId-Portable.zip` - Portable Release: Can deploy this optionally to allow users to run and update your app without installing. -- `MyAppId-Setup.exe` - Installer: Used by most users to install the app to the local filesystem. -- `releases.{channel}.json` - Releases Index: a list of every available release. Used by `UpdateManager` to locate the latest applicable release. -- `RELEASES` - Legacy Releases File: only used for clients [migrating to Velopack](../migrating/squirrel.mdx) from Squirrel. -- `assets.{channel}.json` - Build Assets: A list of assets created in the most recent build. Used by [Velopack deployment commands](../distributing/overview.mdx). - -You do not need to deploy all of these files to allow users to update, so you should review the [deployment guide](../distributing/overview.mdx) for more information on which files to distribute. - -:::tip -There is no setup/installer package for Linux. The program is distributed as a self-updating `.AppImage`. The reason is that `.AppImage` will run on pretty much every modern distro with no extra dependencies needed. Just download the `.AppImage`, run `chmod +x`, and click it to start. It is possible to install an `.AppImage`, but this is left up to the user to install something like [appimaged](https://github.com/probonopd/go-appimage/blob/master/src/appimaged/README.mdx) or [AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher). -::: - -## Code signing - -While this is not required for local builds / testing, you should always code-sign your application before distributing your application to users. - -:::tip -If you do not code-sign, your application may fail to run. [\[Read more\]](signing.mdx) -::: - -## Customising the installer - -On platforms which ship installers, you can customise the behavior. [\[Read more\]](installer.mdx) - -## Other recommended arguments - -- If your application is operating-system or CPU architecture specific you should consider adding an `--rid`. [\[Read more\]](rid.mdx) -- If you plan on distributing release channels for different architectures or features, consider adding a `--channel` [\[Read more\]](channels.mdx) -- If your app requires additional frameworks (eg. vcredist) consider `--framework` [\[Read more\]](bootstrapping.mdx) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/packaging/rid.mdx b/i18n/de/docusaurus-plugin-content-docs/current/packaging/rid.mdx deleted file mode 100644 index 8762851..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/packaging/rid.mdx +++ /dev/null @@ -1,26 +0,0 @@ -# RID (Runtime Identifier) - - - -Similar to how you provide a RID to dotnet to designate your target operating system and architecture, you can do the same for Velopack to tell it what your application supports. - -An RID is composed of three parts (`{os}{version?}-{arch}`) - -- os: operating system (`win`, `osx`, or `linux`) -- version: optionally, specify minimum supported version (eg. `win7`, `win8.1`, `win10.0.18362`) -- arch: optionaly, specify supported CPU architecture (eg.`win-x86`, `win-x64`, `win-arm64`) - -If you were to provide the RID `--rid win10-arm64`, any users trying to install your app on Windows 7, 8, or 8.1 will receive a message saying their operating system is not supported. Similarly, if a Windows 11 user with an x64 cpu were trying to install - it would also fail with a helpful message. - -If trying to target Windows 11, they did not increment the major build number from 10 to 11. Anything >= build 22000 is classified as Windows 11. For example: - -- `win11 == win10.0.22000` -- `win11.0.22621 == win10.0.22621` - -On MacOS, the RID (min version and arch) is just stored as metadata in the `.pkg` which will be handled natively by the operating system. - -#### Also read - -- [Windows 10 version history](https://en.wikipedia.org/wiki/Windows_10_version_history) -- [Windows 11 version history](https://en.wikipedia.org/wiki/Windows_11_version_history) -- [.NET RID Catalog](https://learn.microsoft.com/dotnet/core/rid-catalog) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/packaging/signing.mdx b/i18n/de/docusaurus-plugin-content-docs/current/packaging/signing.mdx deleted file mode 100644 index 02bff96..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/packaging/signing.mdx +++ /dev/null @@ -1,194 +0,0 @@ -# Code Signing - - - -Code signing is an essential part of application distribution. On Windows, applications without code signatures are likely to be flagged as viruses. On OSX, codesigning and Notarization is required before your application can be run by users. - -On both platforms, signing needs to be performed by Velopack itself, this is because the Velopack binaries (such as Update and Setup) need to be signed at different points in the package build process. - -## Signing on Windows - -Here is the general rule of thumb for Windows Defender/Smart Screen warnings: - -- You don't sign your code. You release MyApp-v1.exe. People get smart screen warnings for a while until the reputation on that file increases. You release MyApp-v2.exe. People get warnings again until MyApp-v2.exe builds up enough reputation. -- You sign your code with an OV certificate. You release MyApp-v1.exe. People get smart screen warnings for a while until the reputation on that certificate increases. You release MyApp-v2.exe. People don't get warnings because the certificate already has a good reputation. Eventually your certificate expires and it comes time to release MyApp-v47.exe. You renew your certificate, and people get warnings again until the new certificate builds up reputation. -- You sign your code with an EV certificate. People never get warnings. - -### Acquiring a code signing certificate - -First, you need to acquire a code-signing certificate from a reputable brand. Microsoft lists the following trusted issuers [in their documentation](https://learn.microsoft.com/windows-hardware/drivers/dashboard/code-signing-cert-manage): - -- [Certum](https://shop.certum.eu/data-safety/code-signing-certificates/certum-ev-code-sigining.html) -- [SSL.com](https://www.ssl.com/certificates/ev-code-signing/) -- [DigiCert](https://www.digicert.com/signing/code-signing-certificates) -- [Entrust](https://www.entrustdatacard.com/products/digital-signing-certificates/code-signing-certificates) -- [GlobalSign](https://go.microsoft.com/fwlink/p/?LinkId=620888) -- [IdenTrust](https://www.identrust.com/digital-certificates/trustid-ev-code-signing) -- [Sectigo (formerly Comodo)](https://sectigo.com/ssl-certificates-tls/code-signing) - -:::tip -Note that since June 1, 2023 there [has been a policy change](https://knowledge.digicert.com/general-information/new-private-key-storage-requirement-for-standard-code-signing-certificates-november-2022), meaning it is no longer possible to directly download your code signing certificate private key as a file from issuers. This means most signing options available today will require you to participate in Cloud Code Signing, or install your certificate to a HSM (usb / hardware module). Some issurs may allow you to install your cert to a pre-owned/generic HSM, and some may force you to purchase and ship their own brand of HSM. CI/CD may not be possible with some issuers unless they provide tools specifically designed to do that. -::: - -It may be possible to get official certificates from an authorised reseller at a cheaper price: - -- [SignMyCode](https://signmycode.com/) -- [GoGetSSL](https://www.gogetssl.com/code-signing-ssl/) - -If looking for a cheap option, at the time of writing Certum does an [Open Source Cloud Signing Certificate](https://certum.store/data-safety/code-signing-certificates.html?as_dane_w_certyfikacie=5720) for $58. Note that it is not possible to automate Certum certificates with CI/CD because they require you to install virtual signing drivers (SimpleSign Desktop) and sign in to it with their 2FA SimplySign app. - -:::warning -This document is by no means a recommendation or advice to purchase from any particular code-signing certificate issuer. This is just general guidance for the process one might follow to purchase a certificate, and you must validate for yourself that the issuer you choose is fit for your use-case. -::: - -### Signing via `signtool.exe` - -Usually signing is accomplished via `signtool.exe`. If you already use this tool to sign your application, you can just pass your sign parameters straight to Velopack (minus the 'sign' command). - -For example, if your signing command before was: - -```cmd -signtool.exe sign /td sha256 /fd sha256 /f yourCert.pfx /tr http://timestamp.comodoca.com -``` - -Then now with `--signParams` it would be: - -```cmd -vpk pack ... --signParams "/td sha256 /fd sha256 /f yourCert.pfx /tr http://timestamp.comodoca.com" -``` - -If you are new to using `signtool.exe`, you can check the [command line reference here](https://learn.microsoft.com/dotnet/framework/tools/signtool-exe). I recommend getting signing working on a single binary first, using `signtool.exe`, before trying to get things working with the Velopack CLI. - -If you are using a USB / HSM and have the following signing error `Error: SignerSign() failed." (-2147023673/0x800704c7)`, this means that you are missing a password / unlock token. This can be added to your signing command with the `/csp /k` parameters. [\[Read more\]](https://stackoverflow.com/questions/17927895/automate-extended-validation-ev-code-signing-with-safenet-etoken/54439759#54439759) - -:::warning -Take care when providing parameters with spaces. You must wrap anything containing spaces with quotes and escape with a backslash. For example, `--signParams "/n \"My Cert Name\""`. If you are using an MSBuild `` task or similar, you will need to use `"` instead. -::: - -By default, Velopack will sign 10 files per call to `signtool.exe`, to speed up signing and reduce the number of times you need to interact with the console if you are using some kind of interactive signing method. This can be disabled with the `--signParallel 1` argument. - -### Custom signing commands and tools - -If you have more advanced signing requirements, such as a custom signing tool (eg. `AzureSignTool.exe`), then you can provide a command template instead, where `{{file}}` is the binary that Velopack will substitute and sign: - -```cmd -vpk pack ... --signTemplate "AzureSignTool.exe sign ... {{file}}" -``` - -## Signing & Notarizing on OSX - -Codesigning and Notarization is required before your application can be run by users, therefore it is a required step before deploying your application. - -### Creating code signing certificates - -1. First, you will need to create an account at https://developer.apple.com, pay the annual developer fee, and accept any license agreements. -2. Navigate to your certificates: https://developer.apple.com/account/resources/certificates -3. Click the (+) icon to create new certificates. You need to create both a `Developer ID Installer` and a `Developer ID Application` certificate for distribution of Velopack apps outside the Mac App Store. - ![apple certificate list](/images/apple_certificate_list.png) -4. Open both certificates by clicking on them, press Download, and then double click the ".cer" file to install it to your local keychain. - -### Setting up a NotaryTool profile - -1. Create an app-specific password: https://support.apple.com/en-us/102654. You will only be shown this password once, so save or write it down somewhere. -2. Find your apple team ID: https://developer.apple.com/account#MembershipDetailsCard -3. Store your Apple account credentials to a new NotaryTool profile: - ```sh - xcrun notarytool store-credentials \ - --apple-id "yourapple@account.com" \ - --team-id "your-located-team-id" \ - --password "your-generated-app-specific-password" \ - "your-local-profile-name-here" - ``` - -### Putting it all together - -Now that you have your NotaryTool profile and code signing certificates installed, you can add the following parameters to your `pack` command: - -```sh -vpk pack \ - ... - --signAppIdentity "Developer ID Application: Your Name" \ - --signInstallIdentity "Developer ID Installer: Your Name" \ - --notaryProfile "your-local-profile-name-here" \ -``` - -When these parameters are specified and valid, Velopack will automatically code sign and notarize your application and installer packages. - -### Automate signing in CI/CD (Github Actions) - -It is also posible to store your certificates and notary credentials as Action Secrets and sign your code during CI builds. - -1. Launch Keychain Access and open the "My Certificates" pane. - -2. Select both certificates, right click and select "Export". Save as a p12 file and make note of the password. You can use the same password for both certificates. - -3. Copy the contents of the certificate to clipboard as base64, example: - ```sh - base64 -i CERT.p12 | pbcopy - ``` - -4. Create 7 [Github Secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) for your Actions workflows - - `BUILD_CERTIFICATE_BASE64` (b64 of your app cert) - - `INSTALLER_CERTIFICATE_BASE64` (b64 of your installer cert) - - `P12_PASSWORD` (password for the certificates) - - `APPLE_ID` (your apple username) - - `APPLE_PASSWORD` (your app-specific password from earlier) - - `APPLE_TEAM` (your team id from earlier) - - `KEYCHAIN_PASSWORD` (can be any random string, will be used to create a new keychain) - -5. Add a step to your workflow which installs the certificates and keychain profile. Here is an example: - - ```yml - name: App build & sign - on: push - jobs: - build_with_signing: - runs-on: macos-latest - steps: - - name: Checkout repository - uses: actions/checkout@v4 - - - name: Install Apple certificates and notary profile - env: - BUILD_CERTIFICATE_BASE64: ${{ secrets.BUILD_CERTIFICATE_BASE64 }} - INSTALLER_CERTIFICATE_BASE64: ${{ secrets.INSTALLER_CERTIFICATE_BASE64 }} - P12_PASSWORD: ${{ secrets.P12_PASSWORD }} - APPLE_ID: ${{ secrets.APPLE_ID }} - APPLE_PASSWORD: ${{ secrets.APPLE_PASSWORD }} - APPLE_TEAM: ${{ secrets.APPLE_TEAM }} - KEYCHAIN_PASSWORD: ${{ secrets.KEYCHAIN_PASSWORD }} - run: | - # create variables for file paths - CERT_BUILD_PATH=$RUNNER_TEMP/build_certificate.p12 - CERT_INSTALLER_PATH=$RUNNER_TEMP/installer_certificate.p12 - KEYCHAIN_PATH=$RUNNER_TEMP/app-signing.keychain-db - - # import certificates from secrets - echo -n "$BUILD_CERTIFICATE_BASE64" | base64 --decode -o $CERT_BUILD_PATH - echo -n "$INSTALLER_CERTIFICATE_BASE64" | base64 --decode -o $CERT_INSTALLER_PATH - - # create temporary keychain - security create-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH - security set-keychain-settings -lut 21600 $KEYCHAIN_PATH - security unlock-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH - - # import certificates to keychain - security import $CERT_BUILD_PATH -P "$P12_PASSWORD" -A -t cert -f pkcs12 -k $KEYCHAIN_PATH - security import $CERT_INSTALLER_PATH -P "$P12_PASSWORD" -A -t cert -f pkcs12 -k $KEYCHAIN_PATH - security list-keychain -d user -s $KEYCHAIN_PATH - - # create notarytool profile - xcrun notarytool store-credentials --apple-id "$APPLE_ID" --team-id "$APPLE_TEAM" --password "$APPLE_PASSWORD" velopack-profile - - - name: Build app - ... - - - name: Create Velopack Release - run: | - dotnet tool install -g vpk - vpk ... --signAppIdentity "Developer ID Application: Your Name" --signInstallIdentity "Developer ID Installer: Your Name" --notaryProfile "velopack-profile" - - - name: Clean up keychain - if: ${{ always() }} - run: security delete-keychain $RUNNER_TEMP/app-signing.keychain-db - ``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cpp/api.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cpp/api.md deleted file mode 100644 index 7c75513..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cpp/api.md +++ /dev/null @@ -1,428 +0,0 @@ -# Velopack C++ Reference - - Members | Descriptions ---------------------------------|--------------------------------------------- -`namespace `[`Velopack`](#namespace_velopack) | -`struct `[`subprocess_s`](#structsubprocess__s) | - -## namespace `Velopack` {#namespace_velopack} - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`enum `[`JsonNodeType`](#_velopack_8hpp_1a7dfd07faa4d65bbd8e7f1d0d0b5c5a04) | -`enum `[`JsonToken`](#_velopack_8hpp_1acaf7690482eab17e0269860d1860c9e2) | -`enum `[`VelopackAssetType`](#_velopack_8hpp_1aa83ef9d579b9fc2e42294528577ee904) | -`public void `[`startup`](#_velopack_8cpp_1a1a2c6842876e9c322e26c977f7bce384)`(char ** args,size_t c_args)` | -`class `[`Velopack::JsonNode`](#class_velopack_1_1_json_node) | -`class `[`Velopack::JsonParser`](#class_velopack_1_1_json_parser) | -`class `[`Velopack::Platform`](#class_velopack_1_1_platform) | -`class `[`Velopack::StringStream`](#class_velopack_1_1_string_stream) | -`class `[`Velopack::UpdateInfo`](#class_velopack_1_1_update_info) | Holds information about the current version and pending updates, such as how many there are, and access to release notes. -`class `[`Velopack::UpdateManagerSync`](#class_velopack_1_1_update_manager_sync) | This class is used to check for updates, download updates, and apply updates. It is a synchronous version of the UpdateManager class. This class is not recommended for use in GUI applications, as it will block the main thread, so you may want to use the async UpdateManager class instead, if it is supported for your programming language. -`class `[`Velopack::VelopackAsset`](#class_velopack_1_1_velopack_asset) | An individual Velopack asset, could refer to an asset on-disk or in a remote package feed. - -#### Members - -#### `enum `[`JsonNodeType`](#_velopack_8hpp_1a7dfd07faa4d65bbd8e7f1d0d0b5c5a04) {#_velopack_8hpp_1a7dfd07faa4d65bbd8e7f1d0d0b5c5a04} - - Values | Descriptions ---------------------------------|--------------------------------------------- -null | -bool_ | -array | -object | -number | -string | - -#### `enum `[`JsonToken`](#_velopack_8hpp_1acaf7690482eab17e0269860d1860c9e2) {#_velopack_8hpp_1acaf7690482eab17e0269860d1860c9e2} - - Values | Descriptions ---------------------------------|--------------------------------------------- -none | -curlyOpen | -curlyClose | -squareOpen | -squareClose | -colon | -comma | -string | -number | -bool_ | -null | - -#### `enum `[`VelopackAssetType`](#_velopack_8hpp_1aa83ef9d579b9fc2e42294528577ee904) {#_velopack_8hpp_1aa83ef9d579b9fc2e42294528577ee904} - - Values | Descriptions ---------------------------------|--------------------------------------------- -unknown | -full | -delta | - -#### `public void `[`startup`](#_velopack_8cpp_1a1a2c6842876e9c322e26c977f7bce384)`(char ** args,size_t c_args)` {#_velopack_8cpp_1a1a2c6842876e9c322e26c977f7bce384} - -## class `Velopack::JsonNode` {#class_velopack_1_1_json_node} - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public `[`JsonNode`](#class_velopack_1_1_json_node_1a1bf6d106ebbd1776709cf085fe333d76)`() = default` | -`public JsonNodeType `[`getKind`](#class_velopack_1_1_json_node_1a923b2b13759e54b9072645a022c2f272)`() const` | Get the type of this node, such as string, object, array, etc. You should use this function and then call the corresponding AsObject, AsArray, AsString, etc. functions to get the actual parsed json information. -`public bool `[`isNull`](#class_velopack_1_1_json_node_1afb83035b3d626688d24493c86001d1d7)`() const` | Check if the JSON value is null. -`public bool `[`isEmpty`](#class_velopack_1_1_json_node_1ab56188938000f8fa88bc6a5a1c652ef5)`() const` | Check if the JSON value is empty - eg. an empty string, array, or object. -`public const std::unordered_map< std::string, std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > > * `[`asObject`](#class_velopack_1_1_json_node_1a87d696801e278b663c10289276cb1ca2)`() const` | Reinterpret a JSON value as an object. Throws exception if the value type was not an object. -`public const std::vector< std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > > * `[`asArray`](#class_velopack_1_1_json_node_1a76dbd4e67e4a58dafaeb80ebccd5b31b)`() const` | Reinterpret a JSON value as an array. Throws exception if the value type was not an array. -`public double `[`asNumber`](#class_velopack_1_1_json_node_1ae8b23482fd05ad4aaf67a842a55865f8)`() const` | Reinterpret a JSON value as a number. Throws exception if the value type was not a double. -`public bool `[`asBool`](#class_velopack_1_1_json_node_1a90b0d98c2b9ae42d7c83d00dbc64077b)`() const` | Reinterpret a JSON value as a boolean. Throws exception if the value type was not a boolean. -`public std::string_view `[`asString`](#class_velopack_1_1_json_node_1a7463c87e96a2dc5cf6cabf3ad7f0a577)`() const` | Reinterpret a JSON value as a string. Throws exception if the value type was not a string. -`public void `[`initBool`](#class_velopack_1_1_json_node_1a18a1848f9b1bd6ac76a884bbf3a2da92)`(bool value)` | -`public void `[`initArray`](#class_velopack_1_1_json_node_1ac3d67c1ddb1b68382489368aa9c45314)`()` | -`public void `[`addArrayChild`](#class_velopack_1_1_json_node_1abbacfa7b09b2f0df9c8c711025081eee)`(std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > child)` | -`public void `[`initObject`](#class_velopack_1_1_json_node_1a1092f357911d35eaeb2364ad0567f0af)`()` | -`public void `[`addObjectChild`](#class_velopack_1_1_json_node_1a59c8ef42ce80b470f71e38bb6f6c0aaf)`(std::string_view key,std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > child)` | -`public void `[`initNumber`](#class_velopack_1_1_json_node_1aa0e4f7f297bc29dd23904de4b18910ed)`(double value)` | -`public void `[`initString`](#class_velopack_1_1_json_node_1aa1f5ca52183d31e0c832d7530227b35d)`(std::string_view value)` | - -#### Members - -#### `public `[`JsonNode`](#class_velopack_1_1_json_node_1a1bf6d106ebbd1776709cf085fe333d76)`() = default` {#class_velopack_1_1_json_node_1a1bf6d106ebbd1776709cf085fe333d76} - -#### `public JsonNodeType `[`getKind`](#class_velopack_1_1_json_node_1a923b2b13759e54b9072645a022c2f272)`() const` {#class_velopack_1_1_json_node_1a923b2b13759e54b9072645a022c2f272} - -Get the type of this node, such as string, object, array, etc. You should use this function and then call the corresponding AsObject, AsArray, AsString, etc. functions to get the actual parsed json information. - -#### `public bool `[`isNull`](#class_velopack_1_1_json_node_1afb83035b3d626688d24493c86001d1d7)`() const` {#class_velopack_1_1_json_node_1afb83035b3d626688d24493c86001d1d7} - -Check if the JSON value is null. - -#### `public bool `[`isEmpty`](#class_velopack_1_1_json_node_1ab56188938000f8fa88bc6a5a1c652ef5)`() const` {#class_velopack_1_1_json_node_1ab56188938000f8fa88bc6a5a1c652ef5} - -Check if the JSON value is empty - eg. an empty string, array, or object. - -#### `public const std::unordered_map< std::string, std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > > * `[`asObject`](#class_velopack_1_1_json_node_1a87d696801e278b663c10289276cb1ca2)`() const` {#class_velopack_1_1_json_node_1a87d696801e278b663c10289276cb1ca2} - -Reinterpret a JSON value as an object. Throws exception if the value type was not an object. - -#### `public const std::vector< std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > > * `[`asArray`](#class_velopack_1_1_json_node_1a76dbd4e67e4a58dafaeb80ebccd5b31b)`() const` {#class_velopack_1_1_json_node_1a76dbd4e67e4a58dafaeb80ebccd5b31b} - -Reinterpret a JSON value as an array. Throws exception if the value type was not an array. - -#### `public double `[`asNumber`](#class_velopack_1_1_json_node_1ae8b23482fd05ad4aaf67a842a55865f8)`() const` {#class_velopack_1_1_json_node_1ae8b23482fd05ad4aaf67a842a55865f8} - -Reinterpret a JSON value as a number. Throws exception if the value type was not a double. - -#### `public bool `[`asBool`](#class_velopack_1_1_json_node_1a90b0d98c2b9ae42d7c83d00dbc64077b)`() const` {#class_velopack_1_1_json_node_1a90b0d98c2b9ae42d7c83d00dbc64077b} - -Reinterpret a JSON value as a boolean. Throws exception if the value type was not a boolean. - -#### `public std::string_view `[`asString`](#class_velopack_1_1_json_node_1a7463c87e96a2dc5cf6cabf3ad7f0a577)`() const` {#class_velopack_1_1_json_node_1a7463c87e96a2dc5cf6cabf3ad7f0a577} - -Reinterpret a JSON value as a string. Throws exception if the value type was not a string. - -#### `public void `[`initBool`](#class_velopack_1_1_json_node_1a18a1848f9b1bd6ac76a884bbf3a2da92)`(bool value)` {#class_velopack_1_1_json_node_1a18a1848f9b1bd6ac76a884bbf3a2da92} - -#### `public void `[`initArray`](#class_velopack_1_1_json_node_1ac3d67c1ddb1b68382489368aa9c45314)`()` {#class_velopack_1_1_json_node_1ac3d67c1ddb1b68382489368aa9c45314} - -#### `public void `[`addArrayChild`](#class_velopack_1_1_json_node_1abbacfa7b09b2f0df9c8c711025081eee)`(std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > child)` {#class_velopack_1_1_json_node_1abbacfa7b09b2f0df9c8c711025081eee} - -#### `public void `[`initObject`](#class_velopack_1_1_json_node_1a1092f357911d35eaeb2364ad0567f0af)`()` {#class_velopack_1_1_json_node_1a1092f357911d35eaeb2364ad0567f0af} - -#### `public void `[`addObjectChild`](#class_velopack_1_1_json_node_1a59c8ef42ce80b470f71e38bb6f6c0aaf)`(std::string_view key,std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > child)` {#class_velopack_1_1_json_node_1a59c8ef42ce80b470f71e38bb6f6c0aaf} - -#### `public void `[`initNumber`](#class_velopack_1_1_json_node_1aa0e4f7f297bc29dd23904de4b18910ed)`(double value)` {#class_velopack_1_1_json_node_1aa0e4f7f297bc29dd23904de4b18910ed} - -#### `public void `[`initString`](#class_velopack_1_1_json_node_1aa1f5ca52183d31e0c832d7530227b35d)`(std::string_view value)` {#class_velopack_1_1_json_node_1aa1f5ca52183d31e0c832d7530227b35d} - -## class `Velopack::JsonParser` {#class_velopack_1_1_json_parser} - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public `[`JsonParser`](#class_velopack_1_1_json_parser_1a8ba6193b9910a65ea83b1805c4de2ae9)`() = default` | -`public void `[`load`](#class_velopack_1_1_json_parser_1ad3616e263c683611394a9ffa069af1a3)`(std::string_view text)` | -`public bool `[`endReached`](#class_velopack_1_1_json_parser_1a896ce20ecbe184cfe6474548e0b1628d)`() const` | -`public std::string `[`readN`](#class_velopack_1_1_json_parser_1ad7c785bd0b73de6ee0bf14917e664955)`(int n)` | -`public int `[`read`](#class_velopack_1_1_json_parser_1a4ca8b941e10641ba731f5e33f2015175)`()` | -`public int `[`peek`](#class_velopack_1_1_json_parser_1ab3ea02be7bacf7eb9647d1cb71092861)`() const` | -`public bool `[`peekWhitespace`](#class_velopack_1_1_json_parser_1a27372ad0097723fbc942c4a353ec88ab)`() const` | -`public bool `[`peekWordbreak`](#class_velopack_1_1_json_parser_1a87791f81b34bcb3db86f5854a1e822b3)`() const` | -`public void `[`eatWhitespace`](#class_velopack_1_1_json_parser_1a5fc6e6a6440ef530ff909b7e87d8d15c)`()` | -`public std::string `[`readWord`](#class_velopack_1_1_json_parser_1a7ed0c81806d36f272d31a8ed5ccc30fa)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseNull`](#class_velopack_1_1_json_parser_1a05611896186a61087f0bf12dc25b6d1a)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseBool`](#class_velopack_1_1_json_parser_1a2bb75c78af5d495ed258940b2585e1a9)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseNumber`](#class_velopack_1_1_json_parser_1a73e75b51dd5922e0440e176c406dce58)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseString`](#class_velopack_1_1_json_parser_1a2eb42a0ea6db17db808548c3cb474fb5)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseObject`](#class_velopack_1_1_json_parser_1ac91bfabf5959f71ff5f068c9af912910)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseArray`](#class_velopack_1_1_json_parser_1a7659a483c15b4c3f94f8ceb7a951a4c9)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseValue`](#class_velopack_1_1_json_parser_1a585c0e240fb52c3634c0df767fba8a74)`()` | - -#### Members - -#### `public `[`JsonParser`](#class_velopack_1_1_json_parser_1a8ba6193b9910a65ea83b1805c4de2ae9)`() = default` {#class_velopack_1_1_json_parser_1a8ba6193b9910a65ea83b1805c4de2ae9} - -#### `public void `[`load`](#class_velopack_1_1_json_parser_1ad3616e263c683611394a9ffa069af1a3)`(std::string_view text)` {#class_velopack_1_1_json_parser_1ad3616e263c683611394a9ffa069af1a3} - -#### `public bool `[`endReached`](#class_velopack_1_1_json_parser_1a896ce20ecbe184cfe6474548e0b1628d)`() const` {#class_velopack_1_1_json_parser_1a896ce20ecbe184cfe6474548e0b1628d} - -#### `public std::string `[`readN`](#class_velopack_1_1_json_parser_1ad7c785bd0b73de6ee0bf14917e664955)`(int n)` {#class_velopack_1_1_json_parser_1ad7c785bd0b73de6ee0bf14917e664955} - -#### `public int `[`read`](#class_velopack_1_1_json_parser_1a4ca8b941e10641ba731f5e33f2015175)`()` {#class_velopack_1_1_json_parser_1a4ca8b941e10641ba731f5e33f2015175} - -#### `public int `[`peek`](#class_velopack_1_1_json_parser_1ab3ea02be7bacf7eb9647d1cb71092861)`() const` {#class_velopack_1_1_json_parser_1ab3ea02be7bacf7eb9647d1cb71092861} - -#### `public bool `[`peekWhitespace`](#class_velopack_1_1_json_parser_1a27372ad0097723fbc942c4a353ec88ab)`() const` {#class_velopack_1_1_json_parser_1a27372ad0097723fbc942c4a353ec88ab} - -#### `public bool `[`peekWordbreak`](#class_velopack_1_1_json_parser_1a87791f81b34bcb3db86f5854a1e822b3)`() const` {#class_velopack_1_1_json_parser_1a87791f81b34bcb3db86f5854a1e822b3} - -#### `public void `[`eatWhitespace`](#class_velopack_1_1_json_parser_1a5fc6e6a6440ef530ff909b7e87d8d15c)`()` {#class_velopack_1_1_json_parser_1a5fc6e6a6440ef530ff909b7e87d8d15c} - -#### `public std::string `[`readWord`](#class_velopack_1_1_json_parser_1a7ed0c81806d36f272d31a8ed5ccc30fa)`()` {#class_velopack_1_1_json_parser_1a7ed0c81806d36f272d31a8ed5ccc30fa} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseNull`](#class_velopack_1_1_json_parser_1a05611896186a61087f0bf12dc25b6d1a)`()` {#class_velopack_1_1_json_parser_1a05611896186a61087f0bf12dc25b6d1a} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseBool`](#class_velopack_1_1_json_parser_1a2bb75c78af5d495ed258940b2585e1a9)`()` {#class_velopack_1_1_json_parser_1a2bb75c78af5d495ed258940b2585e1a9} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseNumber`](#class_velopack_1_1_json_parser_1a73e75b51dd5922e0440e176c406dce58)`()` {#class_velopack_1_1_json_parser_1a73e75b51dd5922e0440e176c406dce58} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseString`](#class_velopack_1_1_json_parser_1a2eb42a0ea6db17db808548c3cb474fb5)`()` {#class_velopack_1_1_json_parser_1a2eb42a0ea6db17db808548c3cb474fb5} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseObject`](#class_velopack_1_1_json_parser_1ac91bfabf5959f71ff5f068c9af912910)`()` {#class_velopack_1_1_json_parser_1ac91bfabf5959f71ff5f068c9af912910} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseArray`](#class_velopack_1_1_json_parser_1a7659a483c15b4c3f94f8ceb7a951a4c9)`()` {#class_velopack_1_1_json_parser_1a7659a483c15b4c3f94f8ceb7a951a4c9} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseValue`](#class_velopack_1_1_json_parser_1a585c0e240fb52c3634c0df767fba8a74)`()` {#class_velopack_1_1_json_parser_1a585c0e240fb52c3634c0df767fba8a74} - -## class `Velopack::Platform` {#class_velopack_1_1_platform} - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- - -#### Members - -## class `Velopack::StringStream` {#class_velopack_1_1_string_stream} - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public `[`StringStream`](#class_velopack_1_1_string_stream_1a7881ca72f76249dc905e83208adba0ba)`() = default` | -`public void `[`clear`](#class_velopack_1_1_string_stream_1a25286df2ff42d828f4b7273bfcaa1ac1)`()` | -`public void `[`write`](#class_velopack_1_1_string_stream_1a74de3a26bf75823586ac4e0ce9e57f12)`(std::string s)` | -`public void `[`writeLine`](#class_velopack_1_1_string_stream_1afd73beeb474374ad0d9d5feca92d3dba)`(std::string s)` | -`public void `[`writeChar`](#class_velopack_1_1_string_stream_1ad025e53ac91373dbe983128c7cb62519)`(int c)` | -`public std::string `[`toString`](#class_velopack_1_1_string_stream_1ac9e5b82f2a193256d9e1ae94198d7f09)`() const` | - -#### Members - -#### `public `[`StringStream`](#class_velopack_1_1_string_stream_1a7881ca72f76249dc905e83208adba0ba)`() = default` {#class_velopack_1_1_string_stream_1a7881ca72f76249dc905e83208adba0ba} - -#### `public void `[`clear`](#class_velopack_1_1_string_stream_1a25286df2ff42d828f4b7273bfcaa1ac1)`()` {#class_velopack_1_1_string_stream_1a25286df2ff42d828f4b7273bfcaa1ac1} - -#### `public void `[`write`](#class_velopack_1_1_string_stream_1a74de3a26bf75823586ac4e0ce9e57f12)`(std::string s)` {#class_velopack_1_1_string_stream_1a74de3a26bf75823586ac4e0ce9e57f12} - -#### `public void `[`writeLine`](#class_velopack_1_1_string_stream_1afd73beeb474374ad0d9d5feca92d3dba)`(std::string s)` {#class_velopack_1_1_string_stream_1afd73beeb474374ad0d9d5feca92d3dba} - -#### `public void `[`writeChar`](#class_velopack_1_1_string_stream_1ad025e53ac91373dbe983128c7cb62519)`(int c)` {#class_velopack_1_1_string_stream_1ad025e53ac91373dbe983128c7cb62519} - -#### `public std::string `[`toString`](#class_velopack_1_1_string_stream_1ac9e5b82f2a193256d9e1ae94198d7f09)`() const` {#class_velopack_1_1_string_stream_1ac9e5b82f2a193256d9e1ae94198d7f09} - -## class `Velopack::UpdateInfo` {#class_velopack_1_1_update_info} - -Holds information about the current version and pending updates, such as how many there are, and access to release notes. - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public std::shared_ptr< `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` > `[`targetFullRelease`](#class_velopack_1_1_update_info_1ae48ce8dce0fbb3e509e4767e42bead66) | The available version that we are updating to. -`public bool `[`isDowngrade`](#class_velopack_1_1_update_info_1a593247b70ac2ec4cc12870a7fa544f21) | True if the update is a version downgrade or lateral move (such as when switching channels to the same version number). In this case, only full updates are allowed, and any local packages on disk newer than the downloaded version will be deleted. -`public `[`UpdateInfo`](#class_velopack_1_1_update_info_1ac124c42db882a61ca65f43a061fef338)`() = default` | - -#### Members - -#### `public std::shared_ptr< `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` > `[`targetFullRelease`](#class_velopack_1_1_update_info_1ae48ce8dce0fbb3e509e4767e42bead66) {#class_velopack_1_1_update_info_1ae48ce8dce0fbb3e509e4767e42bead66} - -The available version that we are updating to. - -#### `public bool `[`isDowngrade`](#class_velopack_1_1_update_info_1a593247b70ac2ec4cc12870a7fa544f21) {#class_velopack_1_1_update_info_1a593247b70ac2ec4cc12870a7fa544f21} - -True if the update is a version downgrade or lateral move (such as when switching channels to the same version number). In this case, only full updates are allowed, and any local packages on disk newer than the downloaded version will be deleted. - -#### `public `[`UpdateInfo`](#class_velopack_1_1_update_info_1ac124c42db882a61ca65f43a061fef338)`() = default` {#class_velopack_1_1_update_info_1ac124c42db882a61ca65f43a061fef338} - -## class `Velopack::UpdateManagerSync` {#class_velopack_1_1_update_manager_sync} - -This class is used to check for updates, download updates, and apply updates. It is a synchronous version of the UpdateManager class. This class is not recommended for use in GUI applications, as it will block the main thread, so you may want to use the async UpdateManager class instead, if it is supported for your programming language. - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public `[`UpdateManagerSync`](#class_velopack_1_1_update_manager_sync_1a0725c325f7dfd276d8f4320b7e6524ff)`() = default` | -`public void `[`setUrlOrPath`](#class_velopack_1_1_update_manager_sync_1ae56a277bbd4898786d73b61993640ecb)`(std::string urlOrPath)` | Set the URL or local file path to the update server. This is required before calling CheckForUpdates or DownloadUpdates. -`public void `[`setAllowDowngrade`](#class_velopack_1_1_update_manager_sync_1a85fc4369fadd9046d074feb2c86cfa4a)`(bool allowDowngrade)` | Allows UpdateManager to update to a version that's lower than the current version (i.e. downgrading). This could happen if a release has bugs and was retracted from the release feed, or if you're using ExplicitChannel to switch channels to another channel where the latest version on that channel is lower than the current version. -`public void `[`setExplicitChannel`](#class_velopack_1_1_update_manager_sync_1a0734f2d9c7aaf25c103fd5c5b469a212)`(std::string explicitChannel)` | This option should usually be left null. Overrides the default channel used to fetch updates. The default channel will be whatever channel was specified on the command line when building this release. For example, if the current release was packaged with 'channel beta', then the default channel will be 'beta'. This allows users to automatically receive updates from the same channel they installed from. This options allows you to explicitly switch channels, for example if the user wished to switch back to the 'stable' channel without having to reinstall the application. -`public bool `[`isInstalled`](#class_velopack_1_1_update_manager_sync_1a1c00744efbf661f9cbda40207fd8d670)`() const` | Returns true if the current app is installed, false otherwise. If the app is not installed, other functions in UpdateManager may throw exceptions, so you may want to check this before calling other functions. -`public std::string `[`getCurrentVersion`](#class_velopack_1_1_update_manager_sync_1a9b46af25127ae7267726cb8f48dc7c37)`() const` | Get the currently installed version of the application. If the application is not installed, this function will throw an exception. -`public std::shared_ptr< `[`UpdateInfo`](#class_velopack_1_1_update_info)` > `[`checkForUpdates`](#class_velopack_1_1_update_manager_sync_1a71e4aad5ba207741c10866e844341325)`() const` | This function will check for updates, and return information about the latest available release. This function runs synchronously and may take some time to complete, depending on the network speed and the number of updates available. -`public void `[`downloadUpdates`](#class_velopack_1_1_update_manager_sync_1abdbd2cf84cf64eed79f550e3277cdb6a)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toDownload) const` | Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock so may fail if there is already another update operation in progress. -`public void `[`applyUpdatesAndExit`](#class_velopack_1_1_update_manager_sync_1a5e1009cf9e2d7b852732e876f1c2188f)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply) const` | This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified restart arguments. If you need to save state or clean up, you should do that before calling this method. The user may be prompted during the update, if the update requires additional frameworks to be installed etc. -`public void `[`applyUpdatesAndRestart`](#class_velopack_1_1_update_manager_sync_1a69a296e31573c3173c418758d333dc51)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply,const std::vector< std::string > * restartArgs) const` | This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified restart arguments. If you need to save state or clean up, you should do that before calling this method. The user may be prompted during the update, if the update requires additional frameworks to be installed etc. -`public void `[`waitExitThenApplyUpdates`](#class_velopack_1_1_update_manager_sync_1aa6b15d1cf21d21aee749b38a224570c3)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply,bool silent,bool restart,const std::vector< std::string > * restartArgs) const` | This will launch the Velopack updater and tell it to wait for this program to exit gracefully. You should then clean up any state and exit your app. The updater will apply updates and then optionally restart your app. The updater will only wait for 60 seconds before giving up. -`protected std::vector< std::string > `[`getCurrentVersionCommand`](#class_velopack_1_1_update_manager_sync_1adb80fec8671f6ad9b4e3cf9fa5dbe458)`() const` | Returns the command line arguments to get the current version of the application. -`protected std::vector< std::string > `[`getCheckForUpdatesCommand`](#class_velopack_1_1_update_manager_sync_1a4d66d76a07cddda53ce3fd3a3306e6a9)`() const` | Returns the command line arguments to check for updates. -`protected std::vector< std::string > `[`getDownloadUpdatesCommand`](#class_velopack_1_1_update_manager_sync_1aa28503793c51523b98d5384ad3f6a28f)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toDownload) const` | Returns the command line arguments to download the specified update. -`protected std::vector< std::string > `[`getUpdateApplyCommand`](#class_velopack_1_1_update_manager_sync_1a47232672aab9d74f593a2bfe29f5eb3d)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply,bool silent,bool restart,bool wait,const std::vector< std::string > * restartArgs) const` | Returns the command line arguments to apply the specified update. -`protected std::string `[`getPackagesDir`](#class_velopack_1_1_update_manager_sync_1a8b0d484bcc50fc316ef662ecd5e09093)`() const` | Returns the path to the app's packages directory. This is where updates are downloaded to. - -#### Members - -#### `public `[`UpdateManagerSync`](#class_velopack_1_1_update_manager_sync_1a0725c325f7dfd276d8f4320b7e6524ff)`() = default` {#class_velopack_1_1_update_manager_sync_1a0725c325f7dfd276d8f4320b7e6524ff} - -#### `public void `[`setUrlOrPath`](#class_velopack_1_1_update_manager_sync_1ae56a277bbd4898786d73b61993640ecb)`(std::string urlOrPath)` {#class_velopack_1_1_update_manager_sync_1ae56a277bbd4898786d73b61993640ecb} - -Set the URL or local file path to the update server. This is required before calling CheckForUpdates or DownloadUpdates. - -#### `public void `[`setAllowDowngrade`](#class_velopack_1_1_update_manager_sync_1a85fc4369fadd9046d074feb2c86cfa4a)`(bool allowDowngrade)` {#class_velopack_1_1_update_manager_sync_1a85fc4369fadd9046d074feb2c86cfa4a} - -Allows UpdateManager to update to a version that's lower than the current version (i.e. downgrading). This could happen if a release has bugs and was retracted from the release feed, or if you're using ExplicitChannel to switch channels to another channel where the latest version on that channel is lower than the current version. - -#### `public void `[`setExplicitChannel`](#class_velopack_1_1_update_manager_sync_1a0734f2d9c7aaf25c103fd5c5b469a212)`(std::string explicitChannel)` {#class_velopack_1_1_update_manager_sync_1a0734f2d9c7aaf25c103fd5c5b469a212} - -This option should usually be left null. Overrides the default channel used to fetch updates. The default channel will be whatever channel was specified on the command line when building this release. For example, if the current release was packaged with 'channel beta', then the default channel will be 'beta'. This allows users to automatically receive updates from the same channel they installed from. This options allows you to explicitly switch channels, for example if the user wished to switch back to the 'stable' channel without having to reinstall the application. - -#### `public bool `[`isInstalled`](#class_velopack_1_1_update_manager_sync_1a1c00744efbf661f9cbda40207fd8d670)`() const` {#class_velopack_1_1_update_manager_sync_1a1c00744efbf661f9cbda40207fd8d670} - -Returns true if the current app is installed, false otherwise. If the app is not installed, other functions in UpdateManager may throw exceptions, so you may want to check this before calling other functions. - -#### `public std::string `[`getCurrentVersion`](#class_velopack_1_1_update_manager_sync_1a9b46af25127ae7267726cb8f48dc7c37)`() const` {#class_velopack_1_1_update_manager_sync_1a9b46af25127ae7267726cb8f48dc7c37} - -Get the currently installed version of the application. If the application is not installed, this function will throw an exception. - -#### `public std::shared_ptr< `[`UpdateInfo`](#class_velopack_1_1_update_info)` > `[`checkForUpdates`](#class_velopack_1_1_update_manager_sync_1a71e4aad5ba207741c10866e844341325)`() const` {#class_velopack_1_1_update_manager_sync_1a71e4aad5ba207741c10866e844341325} - -This function will check for updates, and return information about the latest available release. This function runs synchronously and may take some time to complete, depending on the network speed and the number of updates available. - -#### `public void `[`downloadUpdates`](#class_velopack_1_1_update_manager_sync_1abdbd2cf84cf64eed79f550e3277cdb6a)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toDownload) const` {#class_velopack_1_1_update_manager_sync_1abdbd2cf84cf64eed79f550e3277cdb6a} - -Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock so may fail if there is already another update operation in progress. - -#### `public void `[`applyUpdatesAndExit`](#class_velopack_1_1_update_manager_sync_1a5e1009cf9e2d7b852732e876f1c2188f)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply) const` {#class_velopack_1_1_update_manager_sync_1a5e1009cf9e2d7b852732e876f1c2188f} - -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified restart arguments. If you need to save state or clean up, you should do that before calling this method. The user may be prompted during the update, if the update requires additional frameworks to be installed etc. - -#### `public void `[`applyUpdatesAndRestart`](#class_velopack_1_1_update_manager_sync_1a69a296e31573c3173c418758d333dc51)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply,const std::vector< std::string > * restartArgs) const` {#class_velopack_1_1_update_manager_sync_1a69a296e31573c3173c418758d333dc51} - -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified restart arguments. If you need to save state or clean up, you should do that before calling this method. The user may be prompted during the update, if the update requires additional frameworks to be installed etc. - -#### `public void `[`waitExitThenApplyUpdates`](#class_velopack_1_1_update_manager_sync_1aa6b15d1cf21d21aee749b38a224570c3)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply,bool silent,bool restart,const std::vector< std::string > * restartArgs) const` {#class_velopack_1_1_update_manager_sync_1aa6b15d1cf21d21aee749b38a224570c3} - -This will launch the Velopack updater and tell it to wait for this program to exit gracefully. You should then clean up any state and exit your app. The updater will apply updates and then optionally restart your app. The updater will only wait for 60 seconds before giving up. - -#### `protected std::vector< std::string > `[`getCurrentVersionCommand`](#class_velopack_1_1_update_manager_sync_1adb80fec8671f6ad9b4e3cf9fa5dbe458)`() const` {#class_velopack_1_1_update_manager_sync_1adb80fec8671f6ad9b4e3cf9fa5dbe458} - -Returns the command line arguments to get the current version of the application. - -#### `protected std::vector< std::string > `[`getCheckForUpdatesCommand`](#class_velopack_1_1_update_manager_sync_1a4d66d76a07cddda53ce3fd3a3306e6a9)`() const` {#class_velopack_1_1_update_manager_sync_1a4d66d76a07cddda53ce3fd3a3306e6a9} - -Returns the command line arguments to check for updates. - -#### `protected std::vector< std::string > `[`getDownloadUpdatesCommand`](#class_velopack_1_1_update_manager_sync_1aa28503793c51523b98d5384ad3f6a28f)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toDownload) const` {#class_velopack_1_1_update_manager_sync_1aa28503793c51523b98d5384ad3f6a28f} - -Returns the command line arguments to download the specified update. - -#### `protected std::vector< std::string > `[`getUpdateApplyCommand`](#class_velopack_1_1_update_manager_sync_1a47232672aab9d74f593a2bfe29f5eb3d)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply,bool silent,bool restart,bool wait,const std::vector< std::string > * restartArgs) const` {#class_velopack_1_1_update_manager_sync_1a47232672aab9d74f593a2bfe29f5eb3d} - -Returns the command line arguments to apply the specified update. - -#### `protected std::string `[`getPackagesDir`](#class_velopack_1_1_update_manager_sync_1a8b0d484bcc50fc316ef662ecd5e09093)`() const` {#class_velopack_1_1_update_manager_sync_1a8b0d484bcc50fc316ef662ecd5e09093} - -Returns the path to the app's packages directory. This is where updates are downloaded to. - -## class `Velopack::VelopackAsset` {#class_velopack_1_1_velopack_asset} - -An individual Velopack asset, could refer to an asset on-disk or in a remote package feed. - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public std::string `[`packageId`](#class_velopack_1_1_velopack_asset_1a644d04e0fcd56f7639db2d912a575d72) | The name or Id of the package containing this release. -`public std::string `[`version`](#class_velopack_1_1_velopack_asset_1a7afd3e784db4b8141e1abe936d91ed11) | The version of this release. -`public VelopackAssetType `[`type`](#class_velopack_1_1_velopack_asset_1a3bbb06f6e4d755e2a84e1df058e0aadd) | The type of asset (eg. full or delta). -`public std::string `[`fileName`](#class_velopack_1_1_velopack_asset_1ae1d567970986a7d24cfea97fe6834f1a) | The filename of the update package containing this release. -`public std::string `[`sha1`](#class_velopack_1_1_velopack_asset_1afe7b08c38ffad131e0d1edbc12847373) | The SHA1 checksum of the update package containing this release. -`public int64_t `[`size`](#class_velopack_1_1_velopack_asset_1a6ca5d1466adf5159e95f9656c62bc92a) | The size in bytes of the update package containing this release. -`public std::string `[`notesMarkdown`](#class_velopack_1_1_velopack_asset_1a3b904d81dda60c6953fedc54d058da9e) | The release notes in markdown format, as passed to Velopack when packaging the release. -`public std::string `[`notesHTML`](#class_velopack_1_1_velopack_asset_1aa8d00f3e2a6d7735a37663e7531791a1) | The release notes in HTML format, transformed from Markdown when packaging the release. -`public `[`VelopackAsset`](#class_velopack_1_1_velopack_asset_1a8185777fc17f66b0258e949c3e421231)`() = default` | - -#### Members - -#### `public std::string `[`packageId`](#class_velopack_1_1_velopack_asset_1a644d04e0fcd56f7639db2d912a575d72) {#class_velopack_1_1_velopack_asset_1a644d04e0fcd56f7639db2d912a575d72} - -The name or Id of the package containing this release. - -#### `public std::string `[`version`](#class_velopack_1_1_velopack_asset_1a7afd3e784db4b8141e1abe936d91ed11) {#class_velopack_1_1_velopack_asset_1a7afd3e784db4b8141e1abe936d91ed11} - -The version of this release. - -#### `public VelopackAssetType `[`type`](#class_velopack_1_1_velopack_asset_1a3bbb06f6e4d755e2a84e1df058e0aadd) {#class_velopack_1_1_velopack_asset_1a3bbb06f6e4d755e2a84e1df058e0aadd} - -The type of asset (eg. full or delta). - -#### `public std::string `[`fileName`](#class_velopack_1_1_velopack_asset_1ae1d567970986a7d24cfea97fe6834f1a) {#class_velopack_1_1_velopack_asset_1ae1d567970986a7d24cfea97fe6834f1a} - -The filename of the update package containing this release. - -#### `public std::string `[`sha1`](#class_velopack_1_1_velopack_asset_1afe7b08c38ffad131e0d1edbc12847373) {#class_velopack_1_1_velopack_asset_1afe7b08c38ffad131e0d1edbc12847373} - -The SHA1 checksum of the update package containing this release. - -#### `public int64_t `[`size`](#class_velopack_1_1_velopack_asset_1a6ca5d1466adf5159e95f9656c62bc92a) {#class_velopack_1_1_velopack_asset_1a6ca5d1466adf5159e95f9656c62bc92a} - -The size in bytes of the update package containing this release. - -#### `public std::string `[`notesMarkdown`](#class_velopack_1_1_velopack_asset_1a3b904d81dda60c6953fedc54d058da9e) {#class_velopack_1_1_velopack_asset_1a3b904d81dda60c6953fedc54d058da9e} - -The release notes in markdown format, as passed to Velopack when packaging the release. - -#### `public std::string `[`notesHTML`](#class_velopack_1_1_velopack_asset_1aa8d00f3e2a6d7735a37663e7531791a1) {#class_velopack_1_1_velopack_asset_1aa8d00f3e2a6d7735a37663e7531791a1} - -The release notes in HTML format, transformed from Markdown when packaging the release. - -#### `public `[`VelopackAsset`](#class_velopack_1_1_velopack_asset_1a8185777fc17f66b0258e949c3e421231)`() = default` {#class_velopack_1_1_velopack_asset_1a8185777fc17f66b0258e949c3e421231} - -## struct `subprocess_s` {#structsubprocess__s} - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public FILE * `[`stdin_file`](#structsubprocess__s_1ada32f1e1e07a418e4a4d7d57677e44f0) | -`public FILE * `[`stdout_file`](#structsubprocess__s_1a49ea739e96d4555a1de30358de62034c) | -`public FILE * `[`stderr_file`](#structsubprocess__s_1ac44a1727285472c541281bada32db7ea) | -`public pid_t `[`child`](#structsubprocess__s_1a30b0a7616f06a6374de9c52268e6c9e3) | -`public int `[`return_status`](#structsubprocess__s_1a4a6027dbf0c75e5adee516ddf0c99860) | -`public subprocess_size_t `[`alive`](#structsubprocess__s_1ae931c423d39d981ab8b10cbdd49ae5ad) | - -#### Members - -#### `public FILE * `[`stdin_file`](#structsubprocess__s_1ada32f1e1e07a418e4a4d7d57677e44f0) {#structsubprocess__s_1ada32f1e1e07a418e4a4d7d57677e44f0} - -#### `public FILE * `[`stdout_file`](#structsubprocess__s_1a49ea739e96d4555a1de30358de62034c) {#structsubprocess__s_1a49ea739e96d4555a1de30358de62034c} - -#### `public FILE * `[`stderr_file`](#structsubprocess__s_1ac44a1727285472c541281bada32db7ea) {#structsubprocess__s_1ac44a1727285472c541281bada32db7ea} - -#### `public pid_t `[`child`](#structsubprocess__s_1a30b0a7616f06a6374de9c52268e6c9e3) {#structsubprocess__s_1a30b0a7616f06a6374de9c52268e6c9e3} - -#### `public int `[`return_status`](#structsubprocess__s_1a4a6027dbf0c75e5adee516ddf0c99860) {#structsubprocess__s_1a4a6027dbf0c75e5adee516ddf0c99860} - -#### `public subprocess_size_t `[`alive`](#structsubprocess__s_1ae931c423d39d981ab8b10cbdd49ae5ad) {#structsubprocess__s_1ae931c423d39d981ab8b10cbdd49ae5ad} - -Generated by [Moxygen](https://sourcey.com/moxygen) \ No newline at end of file diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/ChecksumFailedException.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/ChecksumFailedException.md deleted file mode 100644 index 590eee3..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/ChecksumFailedException.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Class ChecksumFailedException -sidebar_label: ChecksumFailedException -description: "Represents an error that occurs when a package does not match it's expected SHA checksum" ---- -# Class ChecksumFailedException -Represents an error that occurs when a package does not match it's expected SHA checksum - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Compression/ChecksumFailedException.cs#L9) -```csharp title="Declaration" -public class ChecksumFailedException : Exception, ISerializable, _Exception -``` -**Inheritance:** `System.Object` -> `System.Exception` - -**Implements:** -`System.Runtime.Serialization.ISerializable`, `System.Runtime.InteropServices._Exception` - -## Properties -### FilePath -The filename of the package which failed validation -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Compression/ChecksumFailedException.cs#L15) -```csharp title="Declaration" -public string FilePath { get; } -``` - -## Implements - -* `System.Runtime.Serialization.ISerializable` -* `System.Runtime.InteropServices._Exception` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/Velopack.Compression.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/Velopack.Compression.md deleted file mode 100644 index 70d33ef..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/Velopack.Compression.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Namespace Velopack.Compression -sidebar_label: Velopack.Compression ---- -# Namespace Velopack.Compression -## Classes -### [ChecksumFailedException](../Velopack.Compression/ChecksumFailedException) -Represents an error that occurs when a package does not match it's expected SHA checksum diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/IVelopackLocator.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/IVelopackLocator.md deleted file mode 100644 index 4bb7bf6..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/IVelopackLocator.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: Interface IVelopackLocator -sidebar_label: IVelopackLocator -description: "An interface describing where Velopack can find key folders and files." ---- -# Interface IVelopackLocator -An interface describing where Velopack can find key folders and files. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L10) -```csharp title="Declaration" -public interface IVelopackLocator -``` -## Properties -### AppId -The unique application Id. This is used in various app paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L13) -```csharp title="Declaration" -string? AppId { get; } -``` -### RootAppDir -The root directory of the application. On Windows, this folder contains all -the application files, but that may not be the case on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L19) -```csharp title="Declaration" -string? RootAppDir { get; } -``` -### PackagesDir -The directory in which nupkg files are stored for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L22) -```csharp title="Declaration" -string? PackagesDir { get; } -``` -### AppContentDir -The directory in which versioned application files are stored. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L25) -```csharp title="Declaration" -string? AppContentDir { get; } -``` -### AppTempDir -The temporary directory for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L28) -```csharp title="Declaration" -string? AppTempDir { get; } -``` -### UpdateExePath -The path to the current Update.exe or similar on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L31) -```csharp title="Declaration" -string? UpdateExePath { get; } -``` -### CurrentlyInstalledVersion -The currently installed version of the application, or null if the app is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L34) -```csharp title="Declaration" -SemanticVersion? CurrentlyInstalledVersion { get; } -``` -### ThisExeRelativePath -The path from [Velopack.Locators.IVelopackLocator.AppContentDir](../Velopack.Locators/IVelopackLocator#appcontentdir) to this executable. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L37) -```csharp title="Declaration" -string? ThisExeRelativePath { get; } -``` -### Channel -The release channel this package was built for. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L40) -```csharp title="Declaration" -string? Channel { get; } -``` -## Methods -### GetLocalPackages() -Finds .nupkg files in the PackagesDir and returns a list of ReleaseEntryName objects. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L45) -```csharp title="Declaration" -List GetLocalPackages() -``` - -##### Returns - -`System.Collections.Generic.List` -### GetLatestLocalFullPackage() -Finds latest .nupkg file in the PackagesDir or null if not found. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L50) -```csharp title="Declaration" -VelopackAsset? GetLatestLocalFullPackage() -``` - -##### Returns - -[Velopack.VelopackAsset](../Velopack/VelopackAsset) -### GetOrCreateStagedUserId() -Unique identifier for this user which is used to calculate whether this user is eligible for -staged roll outs. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L56) -```csharp title="Declaration" -Guid? GetOrCreateStagedUserId() -``` - -##### Returns - -`System.Nullable` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/LinuxVelopackLocator.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/LinuxVelopackLocator.md deleted file mode 100644 index c7c3511..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/LinuxVelopackLocator.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Class LinuxVelopackLocator -sidebar_label: LinuxVelopackLocator -description: "The default for OSX. All application files will remain in the '.app'. -All additional files (log, etc) will be placed in a temporary directory." ---- -# Class LinuxVelopackLocator -The default for OSX. All application files will remain in the '.app'. -All additional files (log, etc) will be placed in a temporary directory. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L14) -```csharp title="Declaration" -public class LinuxVelopackLocator : VelopackLocator, IVelopackLocator -``` -**Inheritance:** `System.Object` -> [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator) - -**Implements:** -[Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) - -## Properties -### AppId -The unique application Id. This is used in various app paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L18) -```csharp title="Declaration" -public override string? AppId { get; } -``` -### RootAppDir -The root directory of the application. On Windows, this folder contains all -the application files, but that may not be the case on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L21) -```csharp title="Declaration" -public override string? RootAppDir { get; } -``` -### UpdateExePath -The path to the current Update.exe or similar on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L24) -```csharp title="Declaration" -public override string? UpdateExePath { get; } -``` -### CurrentlyInstalledVersion -The currently installed version of the application, or null if the app is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L27) -```csharp title="Declaration" -public override SemanticVersion? CurrentlyInstalledVersion { get; } -``` -### AppContentDir -The directory in which versioned application files are stored. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L30) -```csharp title="Declaration" -public override string? AppContentDir { get; } -``` -### Channel -The release channel this package was built for. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L33) -```csharp title="Declaration" -public override string? Channel { get; } -``` -### AppTempDir -The temporary directory for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L36) -```csharp title="Declaration" -public override string? AppTempDir { get; } -``` -### PackagesDir -The directory in which nupkg files are stored for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L39) -```csharp title="Declaration" -public override string? PackagesDir { get; } -``` -### PersistentTempDir -/var/tmp/{velopack}/{appid}, for storing app specific files which need to be preserved. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L42) -```csharp title="Declaration" -public string? PersistentTempDir { get; } -``` -### PersistentVelopackDir -A pointer to /var/tmp/{velopack}, a location on linux which is semi-persistent. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L45) -```csharp title="Declaration" -public string? PersistentVelopackDir { get; } -``` -### AppImagePath -File path of the .AppImage which mounted and ran this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L48) -```csharp title="Declaration" -public string? AppImagePath { get; } -``` - -## Implements - -* [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/OsxVelopackLocator.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/OsxVelopackLocator.md deleted file mode 100644 index 6cb13de..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/OsxVelopackLocator.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: Class OsxVelopackLocator -sidebar_label: OsxVelopackLocator -description: "The default for OSX. All application files will remain in the '.app'. -All additional files (log, etc) will be placed in a temporary directory." ---- -# Class OsxVelopackLocator -The default for OSX. All application files will remain in the '.app'. -All additional files (log, etc) will be placed in a temporary directory. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L14) -```csharp title="Declaration" -public class OsxVelopackLocator : VelopackLocator, IVelopackLocator -``` -**Inheritance:** `System.Object` -> [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator) - -**Implements:** -[Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) - -## Properties -### AppId -The unique application Id. This is used in various app paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L18) -```csharp title="Declaration" -public override string? AppId { get; } -``` -### RootAppDir -The root directory of the application. On Windows, this folder contains all -the application files, but that may not be the case on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L21) -```csharp title="Declaration" -public override string? RootAppDir { get; } -``` -### UpdateExePath -The path to the current Update.exe or similar on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L24) -```csharp title="Declaration" -public override string? UpdateExePath { get; } -``` -### CurrentlyInstalledVersion -The currently installed version of the application, or null if the app is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L27) -```csharp title="Declaration" -public override SemanticVersion? CurrentlyInstalledVersion { get; } -``` -### AppContentDir -The directory in which versioned application files are stored. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L30) -```csharp title="Declaration" -public override string? AppContentDir { get; } -``` -### AppTempDir -The temporary directory for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L33) -```csharp title="Declaration" -public override string? AppTempDir { get; } -``` -### PackagesDir -The directory in which nupkg files are stored for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L36) -```csharp title="Declaration" -public override string? PackagesDir { get; } -``` -### Channel -The release channel this package was built for. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L39) -```csharp title="Declaration" -public override string? Channel { get; } -``` - -## Implements - -* [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/TestVelopackLocator.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/TestVelopackLocator.md deleted file mode 100644 index 28055a7..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/TestVelopackLocator.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: Class TestVelopackLocator -sidebar_label: TestVelopackLocator -description: "Provides a mock / test implementation of [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator). This can be used to verify that -your application is able to find and prepare updates from your chosen update source without actually -having an installed application. This could be used in a CI/CD pipeline, or unit tests etc." ---- -# Class TestVelopackLocator -Provides a mock / test implementation of [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator). This can be used to verify that -your application is able to find and prepare updates from your chosen update source without actually -having an installed application. This could be used in a CI/CD pipeline, or unit tests etc. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L13) -```csharp title="Declaration" -public class TestVelopackLocator : VelopackLocator, IVelopackLocator -``` -**Inheritance:** `System.Object` -> [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator) - -**Implements:** -[Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) - -## Properties -### AppId -The unique application Id. This is used in various app paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L17) -```csharp title="Declaration" -public override string? AppId { get; } -``` -### RootAppDir -The root directory of the application. On Windows, this folder contains all -the application files, but that may not be the case on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L27) -```csharp title="Declaration" -public override string? RootAppDir { get; } -``` -### PackagesDir -The directory in which nupkg files are stored for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L37) -```csharp title="Declaration" -public override string? PackagesDir { get; } -``` -### UpdateExePath -The path to the current Update.exe or similar on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L47) -```csharp title="Declaration" -public override string? UpdateExePath { get; } -``` -### CurrentlyInstalledVersion -The currently installed version of the application, or null if the app is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L57) -```csharp title="Declaration" -public override SemanticVersion? CurrentlyInstalledVersion { get; } -``` -### AppContentDir -The directory in which versioned application files are stored. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L67) -```csharp title="Declaration" -public override string? AppContentDir { get; } -``` -### Channel -The release channel this package was built for. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L77) -```csharp title="Declaration" -public override string? Channel { get; } -``` -## Methods -### GetLatestLocalFullPackage() -Finds latest .nupkg file in the PackagesDir or null if not found. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L84) -```csharp title="Declaration" -public override VelopackAsset? GetLatestLocalFullPackage() -``` - -##### Returns - -[Velopack.VelopackAsset](../Velopack/VelopackAsset) - -## Implements - -* [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/Velopack.Locators.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/Velopack.Locators.md deleted file mode 100644 index 71cef3e..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/Velopack.Locators.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Namespace Velopack.Locators -sidebar_label: Velopack.Locators ---- -# Namespace Velopack.Locators -## Classes -### [LinuxVelopackLocator](../Velopack.Locators/LinuxVelopackLocator) -The default for OSX. All application files will remain in the '.app'. -All additional files (log, etc) will be placed in a temporary directory. -### [OsxVelopackLocator](../Velopack.Locators/OsxVelopackLocator) -The default for OSX. All application files will remain in the '.app'. -All additional files (log, etc) will be placed in a temporary directory. -### [TestVelopackLocator](../Velopack.Locators/TestVelopackLocator) -Provides a mock / test implementation of [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator). This can be used to verify that -your application is able to find and prepare updates from your chosen update source without actually -having an installed application. This could be used in a CI/CD pipeline, or unit tests etc. -### [VelopackLocator](../Velopack.Locators/VelopackLocator) -A base class describing where Velopack can find key folders and files. -### [WindowsVelopackLocator](../Velopack.Locators/WindowsVelopackLocator) -An implementation for Windows which uses the default paths. -## Interfaces -### [IVelopackLocator](../Velopack.Locators/IVelopackLocator) -An interface describing where Velopack can find key folders and files. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/VelopackLocator.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/VelopackLocator.md deleted file mode 100644 index 3770641..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/VelopackLocator.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: Class VelopackLocator -sidebar_label: VelopackLocator -description: "A base class describing where Velopack can find key folders and files." ---- -# Class VelopackLocator -A base class describing where Velopack can find key folders and files. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L15) -```csharp title="Declaration" -public abstract class VelopackLocator : IVelopackLocator -``` -**Derived:** -[Velopack.Locators.LinuxVelopackLocator](../Velopack.Locators/LinuxVelopackLocator), [Velopack.Locators.OsxVelopackLocator](../Velopack.Locators/OsxVelopackLocator), [Velopack.Locators.TestVelopackLocator](../Velopack.Locators/TestVelopackLocator), [Velopack.Locators.WindowsVelopackLocator](../Velopack.Locators/WindowsVelopackLocator) - -**Implements:** -[Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) - -## Properties -### AppId -The unique application Id. This is used in various app paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L42) -```csharp title="Declaration" -public abstract string? AppId { get; } -``` -### RootAppDir -The root directory of the application. On Windows, this folder contains all -the application files, but that may not be the case on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L45) -```csharp title="Declaration" -public abstract string? RootAppDir { get; } -``` -### PackagesDir -The directory in which nupkg files are stored for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L48) -```csharp title="Declaration" -public abstract string? PackagesDir { get; } -``` -### AppTempDir -The temporary directory for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L51) -```csharp title="Declaration" -public virtual string? AppTempDir { get; } -``` -### UpdateExePath -The path to the current Update.exe or similar on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L54) -```csharp title="Declaration" -public abstract string? UpdateExePath { get; } -``` -### AppContentDir -The directory in which versioned application files are stored. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L57) -```csharp title="Declaration" -public abstract string? AppContentDir { get; } -``` -### Channel -The release channel this package was built for. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L60) -```csharp title="Declaration" -public abstract string? Channel { get; } -``` -### ThisExeRelativePath -The path from [Velopack.Locators.IVelopackLocator.AppContentDir](../Velopack.Locators/IVelopackLocator#appcontentdir) to this executable. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L63) -```csharp title="Declaration" -public virtual string? ThisExeRelativePath { get; } -``` -### CurrentlyInstalledVersion -The currently installed version of the application, or null if the app is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L76) -```csharp title="Declaration" -public abstract SemanticVersion? CurrentlyInstalledVersion { get; } -``` -### Log -The log interface to use for diagnostic messages. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L79) -```csharp title="Declaration" -protected ILogger Log { get; } -``` -## Methods -### GetDefault(ILogger?) -Auto-detect the platform from the current operating system. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L22) -```csharp title="Declaration" -public static VelopackLocator GetDefault(ILogger? logger) -``` - -##### Returns - -[Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | - -### GetLocalPackages() -Finds .nupkg files in the PackagesDir and returns a list of ReleaseEntryName objects. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L88) -```csharp title="Declaration" -public virtual List GetLocalPackages() -``` - -##### Returns - -`System.Collections.Generic.List` -### GetLatestLocalFullPackage() -Finds latest .nupkg file in the PackagesDir or null if not found. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L115) -```csharp title="Declaration" -public virtual VelopackAsset? GetLatestLocalFullPackage() -``` - -##### Returns - -[Velopack.VelopackAsset](../Velopack/VelopackAsset) -### CreateSubDirIfDoesNotExist(string?, string?) -Given a base dir and a directory name, will create a new sub directory of that name. -Will return null if baseDir is null, or if baseDir does not exist. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L127) -```csharp title="Declaration" -protected static string? CreateSubDirIfDoesNotExist(string? baseDir, string? newDir) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *baseDir* | -| `System.String` | *newDir* | - -### GetOrCreateStagedUserId() -Unique identifier for this user which is used to calculate whether this user is eligible for -staged roll outs. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L138) -```csharp title="Declaration" -public Guid? GetOrCreateStagedUserId() -``` - -##### Returns - -`System.Nullable` - -## Implements - -* [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/WindowsVelopackLocator.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/WindowsVelopackLocator.md deleted file mode 100644 index 447e77f..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/WindowsVelopackLocator.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: Class WindowsVelopackLocator -sidebar_label: WindowsVelopackLocator -description: "An implementation for Windows which uses the default paths." ---- -# Class WindowsVelopackLocator -An implementation for Windows which uses the default paths. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L13) -```csharp title="Declaration" -public class WindowsVelopackLocator : VelopackLocator, IVelopackLocator -``` -**Inheritance:** `System.Object` -> [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator) - -**Implements:** -[Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) - -## Properties -### AppId -The unique application Id. This is used in various app paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L17) -```csharp title="Declaration" -public override string? AppId { get; } -``` -### RootAppDir -The root directory of the application. On Windows, this folder contains all -the application files, but that may not be the case on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L20) -```csharp title="Declaration" -public override string? RootAppDir { get; } -``` -### UpdateExePath -The path to the current Update.exe or similar on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L23) -```csharp title="Declaration" -public override string? UpdateExePath { get; } -``` -### AppContentDir -The directory in which versioned application files are stored. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L26) -```csharp title="Declaration" -public override string? AppContentDir { get; } -``` -### CurrentlyInstalledVersion -The currently installed version of the application, or null if the app is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L29) -```csharp title="Declaration" -public override SemanticVersion? CurrentlyInstalledVersion { get; } -``` -### PackagesDir -The directory in which nupkg files are stored for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L32) -```csharp title="Declaration" -public override string? PackagesDir { get; } -``` -### Channel -The release channel this package was built for. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L35) -```csharp title="Declaration" -public override string? Channel { get; } -``` - -## Implements - -* [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/PackageManifest.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/PackageManifest.md deleted file mode 100644 index fb6bf8d..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/PackageManifest.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: Class PackageManifest -sidebar_label: PackageManifest ---- -# Class PackageManifest - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L11) -```csharp title="Declaration" -public class PackageManifest -``` -**Derived:** -[Velopack.NuGet.ZipPackage](../Velopack.NuGet/ZipPackage) - -## Properties -### ProductName - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L13) -```csharp title="Declaration" -public string? ProductName { get; } -``` -### ProductDescription - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L14) -```csharp title="Declaration" -public string? ProductDescription { get; } -``` -### ProductCompany - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L15) -```csharp title="Declaration" -public string? ProductCompany { get; } -``` -### ProductCopyright - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L16) -```csharp title="Declaration" -public string? ProductCopyright { get; } -``` -### Id - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L17) -```csharp title="Declaration" -public string? Id { get; } -``` -### Version - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L18) -```csharp title="Declaration" -public SemanticVersion? Version { get; } -``` -### ProjectUrl - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L19) -```csharp title="Declaration" -public Uri? ProjectUrl { get; } -``` -### ReleaseNotes - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L20) -```csharp title="Declaration" -public string? ReleaseNotes { get; } -``` -### ReleaseNotesHtml - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L21) -```csharp title="Declaration" -public string? ReleaseNotesHtml { get; } -``` -### IconUrl - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L22) -```csharp title="Declaration" -public Uri? IconUrl { get; } -``` -### Language - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L23) -```csharp title="Declaration" -public string? Language { get; } -``` -### Channel - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L24) -```csharp title="Declaration" -public string? Channel { get; } -``` -### Description - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L25) -```csharp title="Declaration" -public string? Description { get; } -``` -### Owners - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L26) -```csharp title="Declaration" -public string? Owners { get; } -``` -### Title - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L27) -```csharp title="Declaration" -public string? Title { get; } -``` -### Summary - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L28) -```csharp title="Declaration" -public string? Summary { get; } -``` -### Copyright - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L29) -```csharp title="Declaration" -public string? Copyright { get; } -``` -### Authors - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L30) -```csharp title="Declaration" -public IEnumerable Authors { get; } -``` -### RuntimeDependencies - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L31) -```csharp title="Declaration" -public IEnumerable RuntimeDependencies { get; } -``` -## Methods -### ParseFromFile(string) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L37) -```csharp title="Declaration" -public static PackageManifest ParseFromFile(string filePath) -``` - -##### Returns - -[Velopack.NuGet.PackageManifest](../Velopack.NuGet/PackageManifest) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *filePath* | - -### TryParseFromFile(string, out PackageManifest) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L46) -```csharp title="Declaration" -public static bool TryParseFromFile(string filePath, out PackageManifest manifest) -``` - -##### Returns - -`System.Boolean` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *filePath* | -| [Velopack.NuGet.PackageManifest](../Velopack.NuGet/PackageManifest) | *manifest* | - -### ReadManifest(Stream) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L57) -```csharp title="Declaration" -protected void ReadManifest(Stream manifestStream) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.IO.Stream` | *manifestStream* | - -### IsPackageFile(string) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L143) -```csharp title="Declaration" -protected bool IsPackageFile(string partPath) -``` - -##### Returns - -`System.Boolean` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *partPath* | - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/Velopack.NuGet.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/Velopack.NuGet.md deleted file mode 100644 index 306de1c..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/Velopack.NuGet.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Namespace Velopack.NuGet -sidebar_label: Velopack.NuGet ---- -# Namespace Velopack.NuGet -## Classes -### [PackageManifest](../Velopack.NuGet/PackageManifest) - -### [ZipPackage](../Velopack.NuGet/ZipPackage) - -### [ZipPackageFile](../Velopack.NuGet/ZipPackageFile) - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackage.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackage.md deleted file mode 100644 index 92c79b2..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackage.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Class ZipPackage -sidebar_label: ZipPackage ---- -# Class ZipPackage - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackage.cs#L10) -```csharp title="Declaration" -public class ZipPackage : PackageManifest -``` -**Inheritance:** `System.Object` -> [Velopack.NuGet.PackageManifest](../Velopack.NuGet/PackageManifest) - -## Properties -### Files - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackage.cs#L12) -```csharp title="Declaration" -public IEnumerable Files { get; } -``` -### UpdateExeBytes - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackage.cs#L14) -```csharp title="Declaration" -public byte[]? UpdateExeBytes { get; } -``` -### LoadedFromPath - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackage.cs#L16) -```csharp title="Declaration" -public string LoadedFromPath { get; } -``` -## Methods -### ReadFile(ZipArchive, Func<ZipArchiveEntry, bool>) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackage.cs#L33) -```csharp title="Declaration" -protected byte[]? ReadFile(ZipArchive archive, Func predicate) -``` - -##### Returns - -`System.Byte[]` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.IO.Compression.ZipArchive` | *archive* | -| `System.Func` | *predicate* | - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackageFile.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackageFile.md deleted file mode 100644 index 55b3735..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackageFile.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -title: Class ZipPackageFile -sidebar_label: ZipPackageFile ---- -# Class ZipPackageFile - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L6) -```csharp title="Declaration" -public class ZipPackageFile : IEquatable -``` -**Implements:** -`System.IEquatable` - -## Properties -### Key - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L8) -```csharp title="Declaration" -public Uri Key { get; } -``` -### EffectivePath - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L9) -```csharp title="Declaration" -public string EffectivePath { get; } -``` -### TargetFramework - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L10) -```csharp title="Declaration" -public string TargetFramework { get; } -``` -### Path - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L11) -```csharp title="Declaration" -public string Path { get; } -``` -## Methods -### IsLibFile() - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L21) -```csharp title="Declaration" -public bool IsLibFile() -``` - -##### Returns - -`System.Boolean` -### IsContentFile() - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L22) -```csharp title="Declaration" -public bool IsContentFile() -``` - -##### Returns - -`System.Boolean` -### IsFileInTopDirectory(string) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L24) -```csharp title="Declaration" -public bool IsFileInTopDirectory(string directory) -``` - -##### Returns - -`System.Boolean` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *directory* | - -### ToString() -Returns a string that represents the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L30) -```csharp title="Declaration" -public override string ToString() -``` - -##### Returns - -`System.String`: A string that represents the current object.### GetHashCode() -Serves as the default hash function. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L32) -```csharp title="Declaration" -public override int GetHashCode() -``` - -##### Returns - -`System.Int32`: A hash code for the current object.### Equals(object?) -Determines whether the specified object is equal to the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L34) -```csharp title="Declaration" -public override bool Equals(object? obj) -``` - -##### Returns - -`System.Boolean`: true if the specified object is equal to the current object; otherwise, false. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.Object` | *obj* | The object to compare with the current object. | - -### Equals(ZipPackageFile?) -Indicates whether the current object is equal to another object of the same type. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L41) -```csharp title="Declaration" -public bool Equals(ZipPackageFile? other) -``` - -##### Returns - -`System.Boolean`: true if the current object is equal to the <code class="paramref">other</code> parameter; otherwise, false. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.NuGet.ZipPackageFile](../Velopack.NuGet/ZipPackageFile) | *other* | An object to compare with this object. | - - -## Implements - -* `System.IEquatable` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.GitBaseAsset.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.GitBaseAsset.md deleted file mode 100644 index a9cbc6c..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.GitBaseAsset.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Class GitBase.GitBaseAsset -sidebar_label: GitBase.GitBaseAsset -description: "Provides a wrapper around [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) which also contains a Git Release." ---- -# Class GitBase<T>.GitBaseAsset -Provides a wrapper around [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) which also contains a Git Release. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L114) -```csharp title="Declaration" -protected record GitBase.GitBaseAsset : VelopackAsset, IEquatable, IEquatable.GitBaseAsset> -``` -**Inheritance:** `System.Object` -> [Velopack.VelopackAsset](../Velopack/VelopackAsset) - -**Implements:** -`System.IEquatable`, `System.IEquatable` - -## Properties -### Release -The Github release which contains this release package. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L117) -```csharp title="Declaration" -public T Release { get; init; } -``` - -## Implements - -* `System.IEquatable` -* `System.IEquatable` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.md deleted file mode 100644 index b1d70c5..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -title: Class GitBase -sidebar_label: GitBase -description: "Base class to provide some shared implementation between sources which download releases from a Git repository." ---- -# Class GitBase<T> -Base class to provide some shared implementation between sources which download releases from a Git repository. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L13) -```csharp title="Declaration" -public abstract class GitBase : IUpdateSource -``` -**Derived:** -[Velopack.Sources.GithubSource](../Velopack.Sources/GithubSource), [Velopack.Sources.GitlabSource](../Velopack.Sources/GitlabSource) - -**Implements:** -[Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) - -## Properties -### RepoUri -The URL of the repository to download releases from. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L18) -```csharp title="Declaration" -public virtual Uri RepoUri { get; } -``` -### Prerelease -If true, the latest upcoming/prerelease release will be downloaded. If false, the latest -stable release will be downloaded. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L24) -```csharp title="Declaration" -public virtual bool Prerelease { get; } -``` -### Downloader -The file downloader used to perform HTTP requests. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L29) -```csharp title="Declaration" -public virtual IFileDownloader Downloader { get; } -``` -### AccessToken -The GitLab access token to use with the request to download releases. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L34) -```csharp title="Declaration" -protected virtual string? AccessToken { get; } -``` -### Authorization -The Bearer token used in the request. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L39) -```csharp title="Declaration" -protected virtual string? Authorization { get; } -``` -## Methods -### DownloadReleaseEntry(ILogger, VelopackAsset, string, Action<int>, CancellationToken) -Download the specified [Velopack.VelopackAsset](../Velopack/VelopackAsset) to the provided local file path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L51) -```csharp title="Declaration" -public virtual Task DownloadReleaseEntry(ILogger logger, VelopackAsset releaseEntry, string localFile, Action progress, CancellationToken cancelToken) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *releaseEntry* | The release to download. | -| `System.String` | *localFile* | The path on the local disk to store the file. If this file exists, - it will be overwritten. | -| `System.Action` | *progress* | This delegate will be executed with values from 0-100 as the - download is being processed. | -| `System.Threading.CancellationToken` | *cancelToken* | A token to use to cancel the request. | - -### GetReleaseFeed(ILogger, string, Guid?, VelopackAsset?) -Retrieve the list of available remote releases from the package source. These releases -can subsequently be downloaded with `Velopack.Sources.IUpdateSource.DownloadReleaseEntry(Microsoft.Extensions.Logging.ILogger%2cVelopack.VelopackAsset%2cSystem.String%2cSystem.Action%7bSystem.Int32%7d%2cSystem.Threading.CancellationToken)`. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L64) -```csharp title="Declaration" -public virtual Task GetReleaseFeed(ILogger logger, string channel, Guid? stagingId = null, VelopackAsset? latestLocalRelease = null) -``` - -##### Returns - -`System.Threading.Tasks.Task`: An array of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) objects that are available for download - and are applicable to this user. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| `System.String` | *channel* | Release channel to filter packages by. Can be null, which is the - default channel for this operating system. | -| `System.Nullable` | *stagingId* | A persistent user-id, used for calculating whether a specific - release should be available to this user or not. (eg, for the purposes of rolling out - an update to only a small portion of users at a time). | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestLocalRelease* | The latest / current local release. If specified, - metadata from this package may be provided to the remote server (such as package id, - or cpu architecture) to ensure that the correct package is downloaded for this user. | - -### GetReleases(bool) -Retrieves a list of [Velopack.Sources.GithubRelease](../Velopack.Sources/GithubRelease) from the current repository. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L101) -```csharp title="Declaration" -protected abstract Task GetReleases(bool includePrereleases) -``` - -##### Returns - -`System.Threading.Tasks.Task<[]>` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Boolean` | *includePrereleases* | - -### GetAssetUrlFromName(T, string) -Given a [Velopack.Sources.GithubRelease](../Velopack.Sources/GithubRelease) and an asset filename (eg. 'RELEASES') this -function will return either [Velopack.Sources.GithubReleaseAsset.BrowserDownloadUrl](../Velopack.Sources/GithubReleaseAsset#browserdownloadurl) or -[Velopack.Sources.GithubReleaseAsset.Url](../Velopack.Sources/GithubReleaseAsset#url), depending whether an access token is available -or not. Throws if the specified release has no matching assets. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L109) -```csharp title="Declaration" -protected abstract string GetAssetUrlFromName(T release, string assetName) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `` | *release* | -| `System.String` | *assetName* | - - -## Implements - -* [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubRelease.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubRelease.md deleted file mode 100644 index 8a809ce..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubRelease.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Class GithubRelease -sidebar_label: GithubRelease -description: "Describes a GitHub release, including attached assets." ---- -# Class GithubRelease -Describes a GitHub release, including attached assets. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L11) -```csharp title="Declaration" -public class GithubRelease -``` -## Properties -### Name -The name of this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L14) -```csharp title="Declaration" -public string? Name { get; set; } -``` -### Prerelease -True if this release is a prerelease. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L18) -```csharp title="Declaration" -public bool Prerelease { get; set; } -``` -### PublishedAt -The date which this release was published publicly. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L22) -```csharp title="Declaration" -public DateTime? PublishedAt { get; set; } -``` -### Assets -A list of assets (files) uploaded to this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L26) -```csharp title="Declaration" -public GithubReleaseAsset[] Assets { get; set; } -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubReleaseAsset.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubReleaseAsset.md deleted file mode 100644 index df17efd..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubReleaseAsset.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Class GithubReleaseAsset -sidebar_label: GithubReleaseAsset -description: "Describes a asset (file) uploaded to a GitHub release." ---- -# Class GithubReleaseAsset -Describes a asset (file) uploaded to a GitHub release. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L31) -```csharp title="Declaration" -public class GithubReleaseAsset -``` -## Properties -### Url -The asset URL for this release asset. Requests to this URL will use API -quota and return JSON unless the 'Accept' header is "application/octet-stream". -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L37) -```csharp title="Declaration" -public string? Url { get; set; } -``` -### BrowserDownloadUrl -The browser URL for this release asset. This does not use API quota, -however this URL only works for public repositories. If downloading -assets from a private repository, the [Velopack.Sources.GithubReleaseAsset.Url](../Velopack.Sources/GithubReleaseAsset#url) property must -be used with an appropriate access token. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L46) -```csharp title="Declaration" -public string? BrowserDownloadUrl { get; set; } -``` -### Name -The name of this release asset. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L50) -```csharp title="Declaration" -public string? Name { get; set; } -``` -### ContentType -The mime type of this release asset (as detected by GitHub). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L54) -```csharp title="Declaration" -public string? ContentType { get; set; } -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubSource.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubSource.md deleted file mode 100644 index cc1caa1..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubSource.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: Class GithubSource -sidebar_label: GithubSource -description: "Retrieves available releases from a GitHub repository." ---- -# Class GithubSource -Retrieves available releases from a GitHub repository. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L61) -```csharp title="Declaration" -public class GithubSource : GitBase, IUpdateSource -``` -**Inheritance:** `System.Object` -> [Velopack.Sources.GitBase<T>](../Velopack.Sources/GitBase`T`) - -**Implements:** -[Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) - -## Methods -### GetReleases(bool) -Retrieves a list of [Velopack.Sources.GithubRelease](../Velopack.Sources/GithubRelease) from the current repository. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L86) -```csharp title="Declaration" -protected override Task GetReleases(bool includePrereleases) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Boolean` | *includePrereleases* | - -### GetAssetUrlFromName(GithubRelease, string) -Given a [Velopack.Sources.GithubRelease](../Velopack.Sources/GithubRelease) and an asset filename (eg. 'RELEASES') this -function will return either [Velopack.Sources.GithubReleaseAsset.BrowserDownloadUrl](../Velopack.Sources/GithubReleaseAsset#browserdownloadurl) or -[Velopack.Sources.GithubReleaseAsset.Url](../Velopack.Sources/GithubReleaseAsset#url), depending whether an access token is available -or not. Throws if the specified release has no matching assets. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L101) -```csharp title="Declaration" -protected override string GetAssetUrlFromName(GithubRelease release, string assetName) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Sources.GithubRelease](../Velopack.Sources/GithubRelease) | *release* | -| `System.String` | *assetName* | - -### GetApiBaseUrl(Uri) -Given a repository URL (e.g. https://github.com/myuser/myrepo) this function -returns the API base for performing requests. (eg. "https://api.github.com/" -or http://internal.github.server.local/api/v3) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L135) -```csharp title="Declaration" -protected virtual Uri GetApiBaseUrl(Uri repoUrl) -``` - -##### Returns - -`System.Uri` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Uri` | *repoUrl* | - - -## Implements - -* [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabRelease.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabRelease.md deleted file mode 100644 index 8c99ff2..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabRelease.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Class GitlabRelease -sidebar_label: GitlabRelease -description: "Describes a Gitlab release, plus any assets that are attached." ---- -# Class GitlabRelease -Describes a Gitlab release, plus any assets that are attached. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L13) -```csharp title="Declaration" -public class GitlabRelease -``` -## Properties -### Name -The name of the release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L18) -```csharp title="Declaration" -public string? Name { get; set; } -``` -### UpcomingRelease -True if this is intended for an upcoming release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L24) -```csharp title="Declaration" -public bool UpcomingRelease { get; set; } -``` -### ReleasedAt -The date which this release was published publicly. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L30) -```csharp title="Declaration" -public DateTime? ReleasedAt { get; set; } -``` -### Assets -A container for the assets (files) uploaded to this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L36) -```csharp title="Declaration" -public GitlabReleaseAsset? Assets { get; set; } -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseAsset.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseAsset.md deleted file mode 100644 index baf160e..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseAsset.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Class GitlabReleaseAsset -sidebar_label: GitlabReleaseAsset -description: "Describes a container for the assets attached to a release." ---- -# Class GitlabReleaseAsset -Describes a container for the assets attached to a release. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L43) -```csharp title="Declaration" -public class GitlabReleaseAsset -``` -## Properties -### Count -The amount of assets linked to the release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L48) -```csharp title="Declaration" -public int Count { get; set; } -``` -### Links -A list of asset (file) links. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L54) -```csharp title="Declaration" -public GitlabReleaseLink[] Links { get; set; } -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseLink.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseLink.md deleted file mode 100644 index b070c2c..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseLink.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Class GitlabReleaseLink -sidebar_label: GitlabReleaseLink -description: "Describes a container for the links of assets attached to a release." ---- -# Class GitlabReleaseLink -Describes a container for the links of assets attached to a release. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L61) -```csharp title="Declaration" -public class GitlabReleaseLink -``` -## Properties -### Name -Name of the asset (file) linked. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L66) -```csharp title="Declaration" -public string? Name { get; set; } -``` -### Url -The url for the asset. This make use of the Gitlab API. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L72) -```csharp title="Declaration" -public string? Url { get; set; } -``` -### DirectAssetUrl -A direct url to the asset, via a traditional URl. -As a posed to using the API. -This links directly to the raw asset (file). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L80) -```csharp title="Declaration" -public string? DirectAssetUrl { get; set; } -``` -### Type -The category type that the asset is listed under. -Options: 'Package', 'Image', 'Runbook', 'Other' -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L87) -```csharp title="Declaration" -public string? Type { get; set; } -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabSource.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabSource.md deleted file mode 100644 index 1f80b20..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabSource.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Class GitlabSource -sidebar_label: GitlabSource -description: "Retrieves available releases from a GitLab repository. This class only -downloads assets from the very latest GitLab release." ---- -# Class GitlabSource -Retrieves available releases from a GitLab repository. This class only -downloads assets from the very latest GitLab release. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L95) -```csharp title="Declaration" -public class GitlabSource : GitBase, IUpdateSource -``` -**Inheritance:** `System.Object` -> [Velopack.Sources.GitBase<T>](../Velopack.Sources/GitBase`T`) - -**Implements:** -[Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) - -## Methods -### GetAssetUrlFromName(GitlabRelease, string) -Given a [Velopack.Sources.GitlabRelease](../Velopack.Sources/GitlabRelease) and an asset filename (eg. 'RELEASES') this -function will return either [Velopack.Sources.GitlabReleaseLink.DirectAssetUrl](../Velopack.Sources/GitlabReleaseLink#directasseturl) or -[Velopack.Sources.GitlabReleaseLink.Url](../Velopack.Sources/GitlabReleaseLink#url), depending whether an access token is available -or not. Throws if the specified release has no matching assets. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L123) -```csharp title="Declaration" -protected override string GetAssetUrlFromName(GitlabRelease release, string assetName) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Sources.GitlabRelease](../Velopack.Sources/GitlabRelease) | *release* | -| `System.String` | *assetName* | - -### GetReleases(bool) -Retrieves a list of [Velopack.Sources.GitlabRelease](../Velopack.Sources/GitlabRelease) from the current repository. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L147) -```csharp title="Declaration" -protected override Task GetReleases(bool includePrereleases) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Boolean` | *includePrereleases* | - - -## Implements - -* [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/HttpClientFileDownloader.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/HttpClientFileDownloader.md deleted file mode 100644 index c9303dd..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/HttpClientFileDownloader.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: Class HttpClientFileDownloader -sidebar_label: HttpClientFileDownloader -description: "A simple abstractable file downloader" ---- -# Class HttpClientFileDownloader -A simple abstractable file downloader - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L13) -```csharp title="Declaration" -public class HttpClientFileDownloader : IFileDownloader -``` -**Implements:** -[Velopack.Sources.IFileDownloader](../Velopack.Sources/IFileDownloader) - -## Properties -### UserAgent -The User-Agent sent with requests -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L18) -```csharp title="Declaration" -public static ProductInfoHeaderValue UserAgent { get; } -``` -## Methods -### DownloadFile(string, string, Action<int>, string?, string?, CancellationToken) -Downloads a remote file to the specified local path -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L21) -```csharp title="Declaration" -public virtual Task DownloadFile(string url, string targetFile, Action progress, string? authorization, string? accept, CancellationToken cancelToken = default) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *url* | The url which will be downloaded. | -| `System.String` | *targetFile* | The local path where the file will be stored -If a file exists at this path, it will be overwritten. | -| `System.Action` | *progress* | A delegate for reporting download progress, with expected values from 0-100. | -| `System.String` | *authorization* | Text to be sent in the 'Authorization' header of the request. | -| `System.String` | *accept* | Text to be sent in the 'Accept' header of the request. | -| `System.Threading.CancellationToken` | *cancelToken* | Optional token to cancel the request. | - -### DownloadBytes(string, string?, string?) -Returns a byte array containing the contents of the file at the specified url -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L38) -```csharp title="Declaration" -public virtual Task DownloadBytes(string url, string? authorization, string? accept) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *url* | -| `System.String` | *authorization* | -| `System.String` | *accept* | - -### DownloadString(string, string?, string?) -Returns a string containing the contents of the specified url -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L51) -```csharp title="Declaration" -public virtual Task DownloadString(string url, string? authorization, string? accept) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *url* | -| `System.String` | *authorization* | -| `System.String` | *accept* | - -### DownloadToStreamInternal(HttpClient, string, Stream, Action<int>?, CancellationToken) -Asynchronously downloads a remote url to the specified destination stream while -providing progress updates. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L67) -```csharp title="Declaration" -protected virtual Task DownloadToStreamInternal(HttpClient client, string requestUri, Stream destination, Action? progress = null, CancellationToken cancelToken = default) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Net.Http.HttpClient` | *client* | -| `System.String` | *requestUri* | -| `System.IO.Stream` | *destination* | -| `System.Action` | *progress* | -| `System.Threading.CancellationToken` | *cancelToken* | - -### CreateHttpClientHandler() -Creates a new `System.Net.Http.HttpClientHandler` with default settings, used for -new `System.Net.Http.HttpClient`'s. Override this function to add client certificates, -proxy configurations, cookies, or change other http behaviors. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L111) -```csharp title="Declaration" -protected virtual HttpClientHandler CreateHttpClientHandler() -``` - -##### Returns - -`System.Net.Http.HttpClientHandler` -### CreateHttpClient(string?, string?) -Creates a new `System.Net.Http.HttpClient` for every request. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L123) -```csharp title="Declaration" -protected virtual HttpClient CreateHttpClient(string? authorization, string? accept) -``` - -##### Returns - -`System.Net.Http.HttpClient` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *authorization* | -| `System.String` | *accept* | - - -## Implements - -* [Velopack.Sources.IFileDownloader](../Velopack.Sources/IFileDownloader) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IFileDownloader.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IFileDownloader.md deleted file mode 100644 index 8c57f1a..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IFileDownloader.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: Interface IFileDownloader -sidebar_label: IFileDownloader -description: "A simple abstractable file downloader" ---- -# Interface IFileDownloader -A simple abstractable file downloader - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IFileDownloader.cs#L10) -```csharp title="Declaration" -public interface IFileDownloader -``` -## Methods -### DownloadFile(string, string, Action<int>, string?, string?, CancellationToken) -Downloads a remote file to the specified local path -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IFileDownloader.cs#L29) -```csharp title="Declaration" -Task DownloadFile(string url, string targetFile, Action progress, string? authorization = null, string? accept = null, CancellationToken cancelToken = default) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *url* | The url which will be downloaded. | -| `System.String` | *targetFile* | The local path where the file will be stored -If a file exists at this path, it will be overwritten. | -| `System.Action` | *progress* | A delegate for reporting download progress, with expected values from 0-100. | -| `System.String` | *authorization* | Text to be sent in the 'Authorization' header of the request. | -| `System.String` | *accept* | Text to be sent in the 'Accept' header of the request. | -| `System.Threading.CancellationToken` | *cancelToken* | Optional token to cancel the request. | - -### DownloadBytes(string, string?, string?) -Returns a byte array containing the contents of the file at the specified url -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IFileDownloader.cs#L34) -```csharp title="Declaration" -Task DownloadBytes(string url, string? authorization = null, string? accept = null) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *url* | -| `System.String` | *authorization* | -| `System.String` | *accept* | - -### DownloadString(string, string?, string?) -Returns a string containing the contents of the specified url -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IFileDownloader.cs#L39) -```csharp title="Declaration" -Task DownloadString(string url, string? authorization = null, string? accept = null) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *url* | -| `System.String` | *authorization* | -| `System.String` | *accept* | - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IUpdateSource.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IUpdateSource.md deleted file mode 100644 index d9e91ba..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IUpdateSource.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Interface IUpdateSource -sidebar_label: IUpdateSource -description: "Abstraction for finding and downloading updates from a package source / repository. -An implementation may copy a file from a local repository, download from a web address, -or even use third party services and parse proprietary data to produce a package feed." ---- -# Interface IUpdateSource -Abstraction for finding and downloading updates from a package source / repository. -An implementation may copy a file from a local repository, download from a web address, -or even use third party services and parse proprietary data to produce a package feed. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IUpdateSource.cs#L13) -```csharp title="Declaration" -public interface IUpdateSource -``` -## Methods -### GetReleaseFeed(ILogger, string, Guid?, VelopackAsset?) -Retrieve the list of available remote releases from the package source. These releases -can subsequently be downloaded with `Velopack.Sources.IUpdateSource.DownloadReleaseEntry(Microsoft.Extensions.Logging.ILogger%2cVelopack.VelopackAsset%2cSystem.String%2cSystem.Action%7bSystem.Int32%7d%2cSystem.Threading.CancellationToken)`. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IUpdateSource.cs#L31) -```csharp title="Declaration" -Task GetReleaseFeed(ILogger logger, string channel, Guid? stagingId = null, VelopackAsset? latestLocalRelease = null) -``` - -##### Returns - -`System.Threading.Tasks.Task`: An array of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) objects that are available for download - and are applicable to this user. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| `System.String` | *channel* | Release channel to filter packages by. Can be null, which is the - default channel for this operating system. | -| `System.Nullable` | *stagingId* | A persistent user-id, used for calculating whether a specific - release should be available to this user or not. (eg, for the purposes of rolling out - an update to only a small portion of users at a time). | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestLocalRelease* | The latest / current local release. If specified, - metadata from this package may be provided to the remote server (such as package id, - or cpu architecture) to ensure that the correct package is downloaded for this user. | - -### DownloadReleaseEntry(ILogger, VelopackAsset, string, Action<int>, CancellationToken) -Download the specified [Velopack.VelopackAsset](../Velopack/VelopackAsset) to the provided local file path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IUpdateSource.cs#L43) -```csharp title="Declaration" -Task DownloadReleaseEntry(ILogger logger, VelopackAsset releaseEntry, string localFile, Action progress, CancellationToken cancelToken = default) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *releaseEntry* | The release to download. | -| `System.String` | *localFile* | The path on the local disk to store the file. If this file exists, - it will be overwritten. | -| `System.Action` | *progress* | This delegate will be executed with values from 0-100 as the - download is being processed. | -| `System.Threading.CancellationToken` | *cancelToken* | A token to use to cancel the request. | - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleFileSource.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleFileSource.md deleted file mode 100644 index ee07429..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleFileSource.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: Class SimpleFileSource -sidebar_label: SimpleFileSource -description: "Retrieves available updates from a local or network-attached disk. The directory -must contain one or more valid packages, as well as a 'releases.{channel}.json' index file." ---- -# Class SimpleFileSource -Retrieves available updates from a local or network-attached disk. The directory -must contain one or more valid packages, as well as a 'releases.{channel}.json' index file. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleFileSource.cs#L15) -```csharp title="Declaration" -public class SimpleFileSource : IUpdateSource -``` -**Implements:** -[Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) - -## Properties -### BaseDirectory -The local directory containing packages to update to. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleFileSource.cs#L18) -```csharp title="Declaration" -public virtual DirectoryInfo BaseDirectory { get; } -``` -## Methods -### GetReleaseFeed(ILogger, string, Guid?, VelopackAsset?) -Retrieve the list of available remote releases from the package source. These releases -can subsequently be downloaded with `Velopack.Sources.IUpdateSource.DownloadReleaseEntry(Microsoft.Extensions.Logging.ILogger%2cVelopack.VelopackAsset%2cSystem.String%2cSystem.Action%7bSystem.Int32%7d%2cSystem.Threading.CancellationToken)`. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleFileSource.cs#L27) -```csharp title="Declaration" -public Task GetReleaseFeed(ILogger logger, string channel, Guid? stagingId = null, VelopackAsset? latestLocalRelease = null) -``` - -##### Returns - -`System.Threading.Tasks.Task`: An array of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) objects that are available for download - and are applicable to this user. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| `System.String` | *channel* | Release channel to filter packages by. Can be null, which is the - default channel for this operating system. | -| `System.Nullable` | *stagingId* | A persistent user-id, used for calculating whether a specific - release should be available to this user or not. (eg, for the purposes of rolling out - an update to only a small portion of users at a time). | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestLocalRelease* | The latest / current local release. If specified, - metadata from this package may be provided to the remote server (such as package id, - or cpu architecture) to ensure that the correct package is downloaded for this user. | - -### DownloadReleaseEntry(ILogger, VelopackAsset, string, Action<int>, CancellationToken) -Download the specified [Velopack.VelopackAsset](../Velopack/VelopackAsset) to the provided local file path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleFileSource.cs#L67) -```csharp title="Declaration" -public Task DownloadReleaseEntry(ILogger logger, VelopackAsset releaseEntry, string localFile, Action progress, CancellationToken cancelToken) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *releaseEntry* | The release to download. | -| `System.String` | *localFile* | The path on the local disk to store the file. If this file exists, - it will be overwritten. | -| `System.Action` | *progress* | This delegate will be executed with values from 0-100 as the - download is being processed. | -| `System.Threading.CancellationToken` | *cancelToken* | A token to use to cancel the request. | - - -## Implements - -* [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleWebSource.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleWebSource.md deleted file mode 100644 index a68ba7b..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleWebSource.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: Class SimpleWebSource -sidebar_label: SimpleWebSource -description: "Retrieves updates from a static file host or other web server. -Will perform a request for '{baseUri}/RELEASES' to locate the available packages, -and provides query parameters to specify the name of the requested package." ---- -# Class SimpleWebSource -Retrieves updates from a static file host or other web server. -Will perform a request for '{baseUri}/RELEASES' to locate the available packages, -and provides query parameters to specify the name of the requested package. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleWebSource.cs#L14) -```csharp title="Declaration" -public class SimpleWebSource : IUpdateSource -``` -**Implements:** -[Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) - -## Properties -### BaseUri -The URL of the server hosting packages to update to. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleWebSource.cs#L17) -```csharp title="Declaration" -public virtual Uri BaseUri { get; } -``` -### Downloader -The [Velopack.Sources.IFileDownloader](../Velopack.Sources/IFileDownloader) to be used for performing http requests. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleWebSource.cs#L20) -```csharp title="Declaration" -public virtual IFileDownloader Downloader { get; } -``` -## Methods -### GetReleaseFeed(ILogger, string, Guid?, VelopackAsset?) -Retrieve the list of available remote releases from the package source. These releases -can subsequently be downloaded with `Velopack.Sources.IUpdateSource.DownloadReleaseEntry(Microsoft.Extensions.Logging.ILogger%2cVelopack.VelopackAsset%2cSystem.String%2cSystem.Action%7bSystem.Int32%7d%2cSystem.Threading.CancellationToken)`. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleWebSource.cs#L35) -```csharp title="Declaration" -public Task GetReleaseFeed(ILogger logger, string channel, Guid? stagingId = null, VelopackAsset? latestLocalRelease = null) -``` - -##### Returns - -`System.Threading.Tasks.Task`: An array of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) objects that are available for download - and are applicable to this user. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| `System.String` | *channel* | Release channel to filter packages by. Can be null, which is the - default channel for this operating system. | -| `System.Nullable` | *stagingId* | A persistent user-id, used for calculating whether a specific - release should be available to this user or not. (eg, for the purposes of rolling out - an update to only a small portion of users at a time). | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestLocalRelease* | The latest / current local release. If specified, - metadata from this package may be provided to the remote server (such as package id, - or cpu architecture) to ensure that the correct package is downloaded for this user. | - -### DownloadReleaseEntry(ILogger, VelopackAsset, string, Action<int>, CancellationToken) -Download the specified [Velopack.VelopackAsset](../Velopack/VelopackAsset) to the provided local file path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleWebSource.cs#L63) -```csharp title="Declaration" -public Task DownloadReleaseEntry(ILogger logger, VelopackAsset releaseEntry, string localFile, Action progress, CancellationToken cancelToken) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *releaseEntry* | The release to download. | -| `System.String` | *localFile* | The path on the local disk to store the file. If this file exists, - it will be overwritten. | -| `System.Action` | *progress* | This delegate will be executed with values from 0-100 as the - download is being processed. | -| `System.Threading.CancellationToken` | *cancelToken* | A token to use to cancel the request. | - - -## Implements - -* [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/Velopack.Sources.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/Velopack.Sources.md deleted file mode 100644 index 6f5e72c..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/Velopack.Sources.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Namespace Velopack.Sources -sidebar_label: Velopack.Sources ---- -# Namespace Velopack.Sources -## Classes -### [GitBase<T>](../Velopack.Sources/GitBase`T`) -Base class to provide some shared implementation between sources which download releases from a Git repository. -### [GitBase<T>.GitBaseAsset](../Velopack.Sources/GitBase`T`.GitBaseAsset) -Provides a wrapper around [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) which also contains a Git Release. -### [GithubRelease](../Velopack.Sources/GithubRelease) -Describes a GitHub release, including attached assets. -### [GithubReleaseAsset](../Velopack.Sources/GithubReleaseAsset) -Describes a asset (file) uploaded to a GitHub release. -### [GithubSource](../Velopack.Sources/GithubSource) -Retrieves available releases from a GitHub repository. -### [GitlabRelease](../Velopack.Sources/GitlabRelease) -Describes a Gitlab release, plus any assets that are attached. -### [GitlabReleaseAsset](../Velopack.Sources/GitlabReleaseAsset) -Describes a container for the assets attached to a release. -### [GitlabReleaseLink](../Velopack.Sources/GitlabReleaseLink) -Describes a container for the links of assets attached to a release. -### [GitlabSource](../Velopack.Sources/GitlabSource) -Retrieves available releases from a GitLab repository. This class only -downloads assets from the very latest GitLab release. -### [HttpClientFileDownloader](../Velopack.Sources/HttpClientFileDownloader) -A simple abstractable file downloader -### [SimpleFileSource](../Velopack.Sources/SimpleFileSource) -Retrieves available updates from a local or network-attached disk. The directory -must contain one or more valid packages, as well as a 'releases.{channel}.json' index file. -### [SimpleWebSource](../Velopack.Sources/SimpleWebSource) -Retrieves updates from a static file host or other web server. -Will perform a request for '{baseUri}/RELEASES' to locate the available packages, -and provides query parameters to specify the name of the requested package. -### [VelopackFlowUpdateSource](../Velopack.Sources/VelopackFlowUpdateSource) -Retrieves updates from the hosted Velopack service. -## Interfaces -### [IFileDownloader](../Velopack.Sources/IFileDownloader) -A simple abstractable file downloader -### [IUpdateSource](../Velopack.Sources/IUpdateSource) -Abstraction for finding and downloading updates from a package source / repository. -An implementation may copy a file from a local repository, download from a web address, -or even use third party services and parse proprietary data to produce a package feed. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/VelopackFlowUpdateSource.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/VelopackFlowUpdateSource.md deleted file mode 100644 index 9d8896c..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/VelopackFlowUpdateSource.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: Class VelopackFlowUpdateSource -sidebar_label: VelopackFlowUpdateSource -description: "Retrieves updates from the hosted Velopack service." ---- -# Class VelopackFlowUpdateSource -Retrieves updates from the hosted Velopack service. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/VelopackFlowUpdateSource.cs#L14) -```csharp title="Declaration" -public sealed class VelopackFlowUpdateSource : IUpdateSource -``` -**Implements:** -[Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) - -## Properties -### BaseUri -The URL of the server hosting packages to update to. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/VelopackFlowUpdateSource.cs#L26) -```csharp title="Declaration" -public Uri BaseUri { get; } -``` -### Downloader -The [Velopack.Sources.IFileDownloader](../Velopack.Sources/IFileDownloader) to be used for performing http requests. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/VelopackFlowUpdateSource.cs#L29) -```csharp title="Declaration" -public IFileDownloader Downloader { get; } -``` -## Methods -### GetReleaseFeed(ILogger, string, Guid?, VelopackAsset?) -Retrieve the list of available remote releases from the package source. These releases -can subsequently be downloaded with `Velopack.Sources.IUpdateSource.DownloadReleaseEntry(Microsoft.Extensions.Logging.ILogger%2cVelopack.VelopackAsset%2cSystem.String%2cSystem.Action%7bSystem.Int32%7d%2cSystem.Threading.CancellationToken)`. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/VelopackFlowUpdateSource.cs#L32) -```csharp title="Declaration" -public Task GetReleaseFeed(ILogger logger, string channel, Guid? stagingId = null, VelopackAsset? latestLocalRelease = null) -``` - -##### Returns - -`System.Threading.Tasks.Task`: An array of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) objects that are available for download - and are applicable to this user. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| `System.String` | *channel* | Release channel to filter packages by. Can be null, which is the - default channel for this operating system. | -| `System.Nullable` | *stagingId* | A persistent user-id, used for calculating whether a specific - release should be available to this user or not. (eg, for the purposes of rolling out - an update to only a small portion of users at a time). | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestLocalRelease* | The latest / current local release. If specified, - metadata from this package may be provided to the remote server (such as package id, - or cpu architecture) to ensure that the correct package is downloaded for this user. | - -### DownloadReleaseEntry(ILogger, VelopackAsset, string, Action<int>, CancellationToken) -Download the specified [Velopack.VelopackAsset](../Velopack/VelopackAsset) to the provided local file path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/VelopackFlowUpdateSource.cs#L68) -```csharp title="Declaration" -public Task DownloadReleaseEntry(ILogger logger, VelopackAsset releaseEntry, string localFile, Action progress, CancellationToken cancelToken = default) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *releaseEntry* | The release to download. | -| `System.String` | *localFile* | The path on the local disk to store the file. If this file exists, - it will be overwritten. | -| `System.Action` | *progress* | This delegate will be executed with values from 0-100 as the - download is being processed. | -| `System.Threading.CancellationToken` | *cancelToken* | A token to use to cancel the request. | - - -## Implements - -* [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.SHGetFileInfoConstants.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.SHGetFileInfoConstants.md deleted file mode 100644 index c553fbf..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.SHGetFileInfoConstants.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: Enum FileIcon.SHGetFileInfoConstants -sidebar_label: FileIcon.SHGetFileInfoConstants ---- -# Enum FileIcon.SHGetFileInfoConstants - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L996) -```csharp title="Declaration" -[Flags] -public enum FileIcon.SHGetFileInfoConstants -``` -## Fields -### SHGFI_ICON - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L999) -```csharp title="Declaration" -SHGFI_ICON = 256 -``` -### SHGFI_DISPLAYNAME - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1000) -```csharp title="Declaration" -SHGFI_DISPLAYNAME = 512 -``` -### SHGFI_TYPENAME - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1001) -```csharp title="Declaration" -SHGFI_TYPENAME = 1024 -``` -### SHGFI_ATTRIBUTES - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1002) -```csharp title="Declaration" -SHGFI_ATTRIBUTES = 2048 -``` -### SHGFI_ICONLOCATION - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1003) -```csharp title="Declaration" -SHGFI_ICONLOCATION = 4096 -``` -### SHGFI_EXETYPE - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1004) -```csharp title="Declaration" -SHGFI_EXETYPE = 8192 -``` -### SHGFI_SYSICONINDEX - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1005) -```csharp title="Declaration" -SHGFI_SYSICONINDEX = 16384 -``` -### SHGFI_LINKOVERLAY - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1006) -```csharp title="Declaration" -SHGFI_LINKOVERLAY = 32768 -``` -### SHGFI_SELECTED - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1007) -```csharp title="Declaration" -SHGFI_SELECTED = 65536 -``` -### SHGFI_ATTR_SPECIFIED - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1008) -```csharp title="Declaration" -SHGFI_ATTR_SPECIFIED = 131072 -``` -### SHGFI_LARGEICON - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1009) -```csharp title="Declaration" -SHGFI_LARGEICON = 0 -``` -### SHGFI_SMALLICON - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1010) -```csharp title="Declaration" -SHGFI_SMALLICON = 1 -``` -### SHGFI_OPENICON - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1011) -```csharp title="Declaration" -SHGFI_OPENICON = 2 -``` -### SHGFI_SHELLICONSIZE - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1012) -```csharp title="Declaration" -SHGFI_SHELLICONSIZE = 4 -``` -### SHGFI_USEFILEATTRIBUTES - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1014) -```csharp title="Declaration" -SHGFI_USEFILEATTRIBUTES = 16 -``` -### SHGFI_ADDOVERLAYS - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1015) -```csharp title="Declaration" -SHGFI_ADDOVERLAYS = 32 -``` -### SHGFI_OVERLAYINDEX - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1016) -```csharp title="Declaration" -SHGFI_OVERLAYINDEX = 64 -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.md deleted file mode 100644 index abeef0f..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Class FileIcon -sidebar_label: FileIcon -description: "Enables extraction of icons for any file type from -the Shell." ---- -# Class FileIcon -Enables extraction of icons for any file type from -the Shell. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L938) -```csharp title="Declaration" -public class FileIcon -``` -## Properties -### Flags -Gets/sets the flags used to extract the icon -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1022) -```csharp title="Declaration" -public FileIcon.SHGetFileInfoConstants Flags { get; set; } -``` -### FileName -Gets/sets the filename to get the icon for -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1030) -```csharp title="Declaration" -public string FileName { get; set; } -``` -### ShellIcon -Gets the icon for the chosen file -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1038) -```csharp title="Declaration" -public IntPtr ShellIcon { get; } -``` -### DisplayName -Gets the display name for the selected file -if the SHGFI_DISPLAYNAME flag was set. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1046) -```csharp title="Declaration" -public string DisplayName { get; } -``` -### TypeName -Gets the type name for the selected file -if the SHGFI_TYPENAME flag was set. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1054) -```csharp title="Declaration" -public string TypeName { get; } -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetInfo.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetInfo.md deleted file mode 100644 index 0211480..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetInfo.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -title: Class Runtimes.DotnetInfo -sidebar_label: Runtimes.DotnetInfo -description: "Represents a modern DOTNET runtime where versions are deployed independenly of the operating system" ---- -# Class Runtimes.DotnetInfo -Represents a modern DOTNET runtime where versions are deployed independenly of the operating system - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L163) -```csharp title="Declaration" -public class Runtimes.DotnetInfo : Runtimes.RuntimeInfo -``` -**Inheritance:** `System.Object` -> [Velopack.Windows.Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) - -## Properties -### Id -The unique Id of this runtime. Can be used to retrieve a runtime instance with [Velopack.Windows.Runtimes.GetRuntimeByName(string)](../Velopack.Windows/Runtimes#getruntimebynamestring) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L166) -```csharp title="Declaration" -public override string Id { get; } -``` -### DisplayName -The human-friendly name of this runtime - for displaying to users -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L170) -```csharp title="Declaration" -public override string DisplayName { get; } -``` -### MinVersion -The minimum compatible version that must be installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L174) -```csharp title="Declaration" -public NuGetVersion MinVersion { get; } -``` -### CpuArchitecture -The CPU architecture of the runtime. This must match the RID of the app being deployed. - For example, if the app was deployed with 'win-x64', this must be X64 also. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L178) -```csharp title="Declaration" -public RuntimeCpu CpuArchitecture { get; } -``` -### RuntimeType -The type of runtime required, eg. Windows Desktop, AspNetCore, Sdk. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L181) -```csharp title="Declaration" -public Runtimes.DotnetRuntimeType RuntimeType { get; } -``` -## Methods -### CheckIsInstalled() -Check if a runtime compatible with the current instance is installed on this system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L206) -```csharp title="Declaration" -public override Task CheckIsInstalled() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### CheckIsSupported() -Check if this runtime is supported on the current system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L223) -```csharp title="Declaration" -public override Task CheckIsSupported() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### GetDownloadUrl() -Retrieves the web url to the latest compatible runtime installer exe -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L288) -```csharp title="Declaration" -public override Task GetDownloadUrl() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### Parse(string) -Parses a string such as 'net6' or net5.0.14-x86 into a DotnetInfo class capable of checking -the current system for installed status, or downloading / installing. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L309) -```csharp title="Declaration" -public static Runtimes.DotnetInfo Parse(string input) -``` - -##### Returns - -[Velopack.Windows.Runtimes.DotnetInfo](../Velopack.Windows/Runtimes.DotnetInfo) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *input* | - -### TryParse(string, out DotnetInfo) -Parses a string such as 'net6' or net5.0.14-x86 into a DotnetInfo class capable of checking -the current system for installed status, or downloading / installing. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L340) -```csharp title="Declaration" -public static bool TryParse(string input, out Runtimes.DotnetInfo info) -``` - -##### Returns - -`System.Boolean` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *input* | -| [Velopack.Windows.Runtimes.DotnetInfo](../Velopack.Windows/Runtimes.DotnetInfo) | *info* | - -### ParseVersion(string) -Safely converts a version string into a version structure, and provides some validation for invalid/unsupported versions. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L354) -```csharp title="Declaration" -protected static Version ParseVersion(string input) -``` - -##### Returns - -`System.Version` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *input* | - -### TrimVersion(NuGetVersion) -Converts a version structure into the shortest string possible, by trimming trailing zeros. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L375) -```csharp title="Declaration" -protected static string TrimVersion(NuGetVersion ver) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `NuGet.Versioning.NuGetVersion` | *ver* | - -### GetLatestDotNetVersion(DotnetRuntimeType, string, IFileDownloader) -Get latest available version of dotnet. Channel can be 'LTS', 'current', or a two part version -(eg. '6.0') to get the latest minor release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L394) -```csharp title="Declaration" -public static Task GetLatestDotNetVersion(Runtimes.DotnetRuntimeType runtimeType, string channel, IFileDownloader downloader = null) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Windows.Runtimes.DotnetRuntimeType](../Velopack.Windows/Runtimes.DotnetRuntimeType) | *runtimeType* | -| `System.String` | *channel* | -| [Velopack.Sources.IFileDownloader](../Velopack.Sources/IFileDownloader) | *downloader* | - -### GetDotNetDownloadUrl(DotnetRuntimeType, string, string) -Get download url for a specific version of dotnet. Version must be an absolute version, such as one -returned by `Velopack.Windows.Runtimes.DotnetInfo.GetLatestDotNetVersion(Velopack.Windows.Runtimes.DotnetRuntimeType%2cSystem.String%2cVelopack.Sources.IFileDownloader)`. cpuarch should be either -'x86', 'x64', or 'arm64'. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L419) -```csharp title="Declaration" -public static string GetDotNetDownloadUrl(Runtimes.DotnetRuntimeType runtimeType, string version, string cpuarch) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Windows.Runtimes.DotnetRuntimeType](../Velopack.Windows/Runtimes.DotnetRuntimeType) | *runtimeType* | -| `System.String` | *version* | -| `System.String` | *cpuarch* | - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetRuntimeType.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetRuntimeType.md deleted file mode 100644 index caf2780..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetRuntimeType.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Enum Runtimes.DotnetRuntimeType -sidebar_label: Runtimes.DotnetRuntimeType -description: "Dotnet Runtime SKU" ---- -# Enum Runtimes.DotnetRuntimeType -Dotnet Runtime SKU - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L20) -```csharp title="Declaration" -public enum Runtimes.DotnetRuntimeType -``` -## Fields -### Runtime -The .NET Runtime contains just the components needed to run a console app -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L23) -```csharp title="Declaration" -Runtime = 1 -``` -### AspNetCore -The The ASP.NET Core Runtime enables you to run existing web/server applications -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L25) -```csharp title="Declaration" -AspNetCore = 2 -``` -### WindowsDesktop -The .NET Desktop Runtime enables you to run existing Windows desktop applications -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L27) -```csharp title="Declaration" -WindowsDesktop = 3 -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.FrameworkInfo.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.FrameworkInfo.md deleted file mode 100644 index 277339a..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.FrameworkInfo.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Class Runtimes.FrameworkInfo -sidebar_label: Runtimes.FrameworkInfo -description: "Represents a full .NET Framework runtime, usually included in Windows automatically through Windows Update" ---- -# Class Runtimes.FrameworkInfo -Represents a full .NET Framework runtime, usually included in Windows automatically through Windows Update - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L116) -```csharp title="Declaration" -public class Runtimes.FrameworkInfo : Runtimes.RuntimeInfo -``` -**Inheritance:** `System.Object` -> [Velopack.Windows.Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) - -## Properties -### DownloadUrl -Permalink to the installer for this runtime -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L119) -```csharp title="Declaration" -public string DownloadUrl { get; } -``` -### ReleaseVersion -The minimum compatible release version for this runtime -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L122) -```csharp title="Declaration" -public int ReleaseVersion { get; } -``` -## Methods -### GetDownloadUrl() -Retrieves the web url to the latest compatible runtime installer exe -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L134) -```csharp title="Declaration" -public override Task GetDownloadUrl() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### CheckIsSupported() -Check if this runtime is supported on the current system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L140) -```csharp title="Declaration" -public override Task CheckIsSupported() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### CheckIsInstalled() -Check if a runtime compatible with the current instance is installed on this system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L148) -```csharp title="Declaration" -public override Task CheckIsInstalled() -``` - -##### Returns - -`System.Threading.Tasks.Task` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInfo.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInfo.md deleted file mode 100644 index acc5b8d..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInfo.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: Class Runtimes.RuntimeInfo -sidebar_label: Runtimes.RuntimeInfo -description: "Base type containing information about a runtime in relation to the current operating system" ---- -# Class Runtimes.RuntimeInfo -Base type containing information about a runtime in relation to the current operating system - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L46) -```csharp title="Declaration" -public abstract class Runtimes.RuntimeInfo -``` -**Derived:** -[Velopack.Windows.Runtimes.DotnetInfo](../Velopack.Windows/Runtimes.DotnetInfo), [Velopack.Windows.Runtimes.FrameworkInfo](../Velopack.Windows/Runtimes.FrameworkInfo), [Velopack.Windows.Runtimes.VCRedistInfo](../Velopack.Windows/Runtimes.VCRedistInfo) - -## Properties -### Id -The unique Id of this runtime. Can be used to retrieve a runtime instance with [Velopack.Windows.Runtimes.GetRuntimeByName(string)](../Velopack.Windows/Runtimes#getruntimebynamestring) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L49) -```csharp title="Declaration" -public virtual string Id { get; } -``` -### DisplayName -The human-friendly name of this runtime - for displaying to users -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L52) -```csharp title="Declaration" -public virtual string DisplayName { get; } -``` -## Methods -### GetDownloadUrl() -Retrieves the web url to the latest compatible runtime installer exe -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L65) -```csharp title="Declaration" -public abstract Task GetDownloadUrl() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### CheckIsInstalled() -Check if a runtime compatible with the current instance is installed on this system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L68) -```csharp title="Declaration" -public abstract Task CheckIsInstalled() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### CheckIsSupported() -Check if this runtime is supported on the current system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L72) -```csharp title="Declaration" -public abstract Task CheckIsSupported() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### DownloadToFile(string, Action<int>, IFileDownloader, ILogger) -Download the latest installer for this runtime to the specified file -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L76) -```csharp title="Declaration" -public virtual Task DownloadToFile(string localPath, Action progress = null, IFileDownloader downloader = null, ILogger log = null) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *localPath* | -| `System.Action` | *progress* | -| [Velopack.Sources.IFileDownloader](../Velopack.Sources/IFileDownloader) | *downloader* | -| `Microsoft.Extensions.Logging.ILogger` | *log* | - -### InvokeInstaller(string, bool, ILogger) -Execute a runtime installer at a local file path. Typically used after `Velopack.Windows.Runtimes.RuntimeInfo.DownloadToFile(System.String%2cSystem.Action%7bSystem.Int32%7d%2cVelopack.Sources.IFileDownloader%2cMicrosoft.Extensions.Logging.ILogger)` -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L85) -```csharp title="Declaration" -public virtual Task InvokeInstaller(string pathToInstaller, bool isQuiet, ILogger log = null) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *pathToInstaller* | -| `System.Boolean` | *isQuiet* | -| `Microsoft.Extensions.Logging.ILogger` | *log* | - -### ToString() -The unique string representation of this runtime -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L109) -```csharp title="Declaration" -public override string ToString() -``` - -##### Returns - -`System.String` -### GetHashCode() -The unique hash code of this runtime -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L112) -```csharp title="Declaration" -public override int GetHashCode() -``` - -##### Returns - -`System.Int32` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInstallResult.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInstallResult.md deleted file mode 100644 index 8a73321..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInstallResult.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Enum Runtimes.RuntimeInstallResult -sidebar_label: Runtimes.RuntimeInstallResult -description: "Runtime installation result code" ---- -# Enum Runtimes.RuntimeInstallResult -Runtime installation result code - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L31) -```csharp title="Declaration" -public enum Runtimes.RuntimeInstallResult -``` -## Fields -### InstallSuccess -The install was successful -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L34) -```csharp title="Declaration" -InstallSuccess = 0 -``` -### UserCancelled -The install failed because it was cancelled by the user -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L36) -```csharp title="Declaration" -UserCancelled = 1602 -``` -### AnotherInstallInProgress -The install failed because another install is in progress, try again later -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L38) -```csharp title="Declaration" -AnotherInstallInProgress = 1618 -``` -### RestartRequired -The install failed because a system restart is required before continuing -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L40) -```csharp title="Declaration" -RestartRequired = 3010 -``` -### SystemDoesNotMeetRequirements -The install failed because the current system does not support this runtime (outdated/unsupported) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L42) -```csharp title="Declaration" -SystemDoesNotMeetRequirements = 5100 -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist00.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist00.md deleted file mode 100644 index 7368e78..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist00.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Class Runtimes.VCRedist00 -sidebar_label: Runtimes.VCRedist00 -description: "Represents a VC++ redistributable package which is referenced by a permalink" ---- -# Class Runtimes.VCRedist00 -Represents a VC++ redistributable package which is referenced by a permalink - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L563) -```csharp title="Declaration" -public class Runtimes.VCRedist00 : Runtimes.VCRedistInfo -``` -**Inheritance:** `System.Object` -> [Velopack.Windows.Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) -> [Velopack.Windows.Runtimes.VCRedistInfo](../Velopack.Windows/Runtimes.VCRedistInfo) - -## Properties -### DownloadUrl -Permalink to the installer for this runtime -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L566) -```csharp title="Declaration" -public string DownloadUrl { get; } -``` -## Methods -### GetDownloadUrl() -Retrieves the web url to the latest compatible runtime installer exe -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L576) -```csharp title="Declaration" -public override Task GetDownloadUrl() -``` - -##### Returns - -`System.Threading.Tasks.Task` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist14.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist14.md deleted file mode 100644 index aa4b995..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist14.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Class Runtimes.VCRedist14 -sidebar_label: Runtimes.VCRedist14 -description: "Represents a VC++ 2015-2022 redistributable package." ---- -# Class Runtimes.VCRedist14 -Represents a VC++ 2015-2022 redistributable package. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L539) -```csharp title="Declaration" -public class Runtimes.VCRedist14 : Runtimes.VCRedistInfo -``` -**Inheritance:** `System.Object` -> [Velopack.Windows.Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) -> [Velopack.Windows.Runtimes.VCRedistInfo](../Velopack.Windows/Runtimes.VCRedistInfo) - -## Methods -### GetDownloadUrl() -Retrieves the web url to the latest compatible runtime installer exe -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L548) -```csharp title="Declaration" -public override Task GetDownloadUrl() -``` - -##### Returns - -`System.Threading.Tasks.Task` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedistInfo.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedistInfo.md deleted file mode 100644 index 71fb1c3..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedistInfo.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Class Runtimes.VCRedistInfo -sidebar_label: Runtimes.VCRedistInfo -description: "The base class for a VC++ redistributable package." ---- -# Class Runtimes.VCRedistInfo -The base class for a VC++ redistributable package. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L435) -```csharp title="Declaration" -public abstract class Runtimes.VCRedistInfo : Runtimes.RuntimeInfo -``` -**Inheritance:** `System.Object` -> [Velopack.Windows.Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) - -**Derived:** -[Velopack.Windows.Runtimes.VCRedist00](../Velopack.Windows/Runtimes.VCRedist00), [Velopack.Windows.Runtimes.VCRedist14](../Velopack.Windows/Runtimes.VCRedist14) - -## Properties -### MinVersion -The minimum compatible version that must be installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L438) -```csharp title="Declaration" -public NuGetVersion MinVersion { get; } -``` -### CpuArchitecture -The CPU architecture of the runtime. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L441) -```csharp title="Declaration" -public RuntimeCpu CpuArchitecture { get; } -``` -## Methods -### CheckIsInstalled() -Check if a runtime compatible with the current instance is installed on this system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L451) -```csharp title="Declaration" -public override Task CheckIsInstalled() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### CheckIsSupported() -Check if this runtime is supported on the current system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L461) -```csharp title="Declaration" -public override Task CheckIsSupported() -``` - -##### Returns - -`System.Threading.Tasks.Task` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.md deleted file mode 100644 index 53b9a1c..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.md +++ /dev/null @@ -1,283 +0,0 @@ ---- -title: Class Runtimes -sidebar_label: Runtimes -description: "Contains static properties to access common supported runtimes, and a function to search for a runtime by name" ---- -# Class Runtimes -Contains static properties to access common supported runtimes, and a function to search for a runtime by name - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L10) -```csharp title="Declaration" -[Obsolete("These classes are no longer used by Velopack, and does not represent the current supported runtimes. https://github.com/velopack/velopack/blob/master/docs/bootstrapping.md")] -public static class Runtimes -``` -## Fields -### NETFRAMEWORK45 -Runtime for .NET Framework 4.5 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L15) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK45 -``` -### NETFRAMEWORK451 -Runtime for .NET Framework 4.5.1 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L18) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK451 -``` -### NETFRAMEWORK452 -Runtime for .NET Framework 4.5.2 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L21) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK452 -``` -### NETFRAMEWORK46 -Runtime for .NET Framework 4.6 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L24) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK46 -``` -### NETFRAMEWORK461 -Runtime for .NET Framework 4.6.1 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L27) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK461 -``` -### NETFRAMEWORK462 -Runtime for .NET Framework 4.6.2 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L29) -```csharp title="Declaration" -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK462 -``` -### NETFRAMEWORK47 -Runtime for .NET Framework 4.7 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L31) -```csharp title="Declaration" -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK47 -``` -### NETFRAMEWORK471 -Runtime for .NET Framework 4.7.1 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L33) -```csharp title="Declaration" -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK471 -``` -### NETFRAMEWORK472 -Runtime for .NET Framework 4.7.2 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L35) -```csharp title="Declaration" -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK472 -``` -### NETFRAMEWORK48 -Runtime for .NET Framework 4.8 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L37) -```csharp title="Declaration" -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK48 -``` -### NETFRAMEWORK481 -Runtime for .NET Framework 4.8.1 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L39) -```csharp title="Declaration" -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK481 -``` -### DOTNETCORE31_X86 -Runtime for .NET Core 3.1 Desktop Runtime (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L44) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.DotnetInfo DOTNETCORE31_X86 -``` -### DOTNETCORE31_X64 -Runtime for .NET Core 3.1 Desktop Runtime (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L47) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.DotnetInfo DOTNETCORE31_X64 -``` -### DOTNET5_X86 -Runtime for .NET 5.0 Desktop Runtime (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L50) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.DotnetInfo DOTNET5_X86 -``` -### DOTNET5_X64 -Runtime for .NET 5.0 Desktop Runtime (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L53) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.DotnetInfo DOTNET5_X64 -``` -### DOTNET6_X86 -Runtime for .NET 6.0 Desktop Runtime (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L55) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET6_X86 -``` -### DOTNET6_X64 -Runtime for .NET 6.0 Desktop Runtime (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L57) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET6_X64 -``` -### DOTNET6_ARM64 -Runtime for .NET 6.0 Desktop Runtime (arm64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L59) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET6_ARM64 -``` -### DOTNET7_X86 -Runtime for .NET 7.0 Desktop Runtime (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L61) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET7_X86 -``` -### DOTNET7_X64 -Runtime for .NET 7.0 Desktop Runtime (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L63) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET7_X64 -``` -### DOTNET7_ARM64 -Runtime for .NET 7.0 Desktop Runtime (arm64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L65) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET7_ARM64 -``` -### DOTNET8_X86 -Runtime for .NET 8.0 Desktop Runtime (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L67) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET8_X86 -``` -### DOTNET8_X64 -Runtime for .NET 8.0 Desktop Runtime (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L69) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET8_X64 -``` -### DOTNET8_ARM64 -Runtime for .NET 8.0 Desktop Runtime (arm64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L71) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET8_ARM64 -``` -### VCREDIST100_X86 -Runtime for Visual C++ 2010 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L75) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist00 VCREDIST100_X86 -``` -### VCREDIST100_X64 -Runtime for Visual C++ 2010 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L78) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist00 VCREDIST100_X64 -``` -### VCREDIST110_X86 -Runtime for Visual C++ 2012 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L81) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist00 VCREDIST110_X86 -``` -### VCREDIST110_X64 -Runtime for Visual C++ 2012 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L84) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist00 VCREDIST110_X64 -``` -### VCREDIST120_X86 -Runtime for Visual C++ 2013 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L87) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist00 VCREDIST120_X86 -``` -### VCREDIST120_X64 -Runtime for Visual C++ 2013 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L90) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist00 VCREDIST120_X64 -``` -### VCREDIST140_X86 -Runtime for Visual C++ 2015 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L93) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST140_X86 -``` -### VCREDIST140_X64 -Runtime for Visual C++ 2015 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L95) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST140_X64 -``` -### VCREDIST141_X86 -Runtime for Visual C++ 2017 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L97) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST141_X86 -``` -### VCREDIST141_X64 -Runtime for Visual C++ 2017 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L99) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST141_X64 -``` -### VCREDIST142_X86 -Runtime for Visual C++ 2019 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L101) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST142_X86 -``` -### VCREDIST142_X64 -Runtime for Visual C++ 2019 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L103) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST142_X64 -``` -### VCREDIST143_X86 -Runtime for Visual C++ 2022 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L105) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST143_X86 -``` -### VCREDIST143_X64 -Runtime for Visual C++ 2022 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L107) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST143_X64 -``` -### VCREDIST143_ARM64 -Runtime for Visual C++ 2022 Redistributable (arm64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L109) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST143_ARM64 -``` -### All -An array of all the currently supported runtimes -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L112) -```csharp title="Declaration" -public static readonly Runtimes.RuntimeInfo[] All -``` -## Methods -### GetRuntimeByName(string) -Search for a runtime by name. If a platform architecture is not specified, the default is x64. -Returns null if no match is found. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L127) -```csharp title="Declaration" -public static Runtimes.RuntimeInfo GetRuntimeByName(string name) -``` - -##### Returns - -[Velopack.Windows.Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *name* | - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.EShellLinkResolveFlags.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.EShellLinkResolveFlags.md deleted file mode 100644 index 96b4f90..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.EShellLinkResolveFlags.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: Enum ShellLink.EShellLinkResolveFlags -sidebar_label: ShellLink.EShellLinkResolveFlags -description: "Flags determining how the links with missing -targets are resolved." ---- -# Enum ShellLink.EShellLinkResolveFlags -Flags determining how the links with missing -targets are resolved. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L410) -```csharp title="Declaration" -[Flags] -public enum ShellLink.EShellLinkResolveFlags : uint -``` -## Fields -### SLR_ANY_MATCH -Allow any match during resolution. Has no effect -on ME/2000 or above, use the other flags instead. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L417) -```csharp title="Declaration" -SLR_ANY_MATCH = 2 -``` -### SLR_INVOKE_MSI -Call the Microsoft Windows Installer. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L422) -```csharp title="Declaration" -SLR_INVOKE_MSI = 128 -``` -### SLR_NOLINKINFO -Disable distributed link tracking. By default, -distributed link tracking tracks removable media -across multiple devices based on the volume name. -It also uses the UNC path to track remote file -systems whose drive letter has changed. Setting -SLR_NOLINKINFO disables both types of tracking. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L432) -```csharp title="Declaration" -SLR_NOLINKINFO = 64 -``` -### SLR_NO_UI -Do not display a dialog box if the link cannot be resolved. -When SLR_NO_UI is set, a time-out value that specifies the -maximum amount of time to be spent resolving the link can -be specified in milliseconds. The function returns if the -link cannot be resolved within the time-out duration. -If the timeout is not set, the time-out duration will be -set to the default value of 3,000 milliseconds (3 seconds). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L443) -```csharp title="Declaration" -SLR_NO_UI = 1 -``` -### SLR_NO_UI_WITH_MSG_PUMP -Not documented in SDK. Assume same as SLR_NO_UI but -intended for applications without a hWnd. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L449) -```csharp title="Declaration" -SLR_NO_UI_WITH_MSG_PUMP = 257 -``` -### SLR_NOUPDATE -Do not update the link information. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L454) -```csharp title="Declaration" -SLR_NOUPDATE = 8 -``` -### SLR_NOSEARCH -Do not execute the search heuristics. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L459) -```csharp title="Declaration" -SLR_NOSEARCH = 16 -``` -### SLR_NOTRACK -Do not use distributed link tracking. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L464) -```csharp title="Declaration" -SLR_NOTRACK = 32 -``` -### SLR_UPDATE -If the link object has changed, update its path and list -of identifiers. If SLR_UPDATE is set, you do not need to -call IPersistFile::IsDirty to determine whether or not -the link object has changed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L472) -```csharp title="Declaration" -SLR_UPDATE = 4 -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.LinkDisplayMode.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.LinkDisplayMode.md deleted file mode 100644 index 3aebf71..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.LinkDisplayMode.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Enum ShellLink.LinkDisplayMode -sidebar_label: ShellLink.LinkDisplayMode ---- -# Enum ShellLink.LinkDisplayMode - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L475) -```csharp title="Declaration" -public enum ShellLink.LinkDisplayMode : uint -``` -## Fields -### edmNormal - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L477) -```csharp title="Declaration" -edmNormal = 1 -``` -### edmMinimized - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L478) -```csharp title="Declaration" -edmMinimized = 7 -``` -### edmMaximized - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L479) -```csharp title="Declaration" -edmMaximized = 3 -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PROPERTYKEY.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PROPERTYKEY.md deleted file mode 100644 index db0d31c..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PROPERTYKEY.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Struct ShellLink.PROPERTYKEY -sidebar_label: ShellLink.PROPERTYKEY ---- -# Struct ShellLink.PROPERTYKEY - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L109) -```csharp title="Declaration" -public struct ShellLink.PROPERTYKEY -``` -## Properties -### PKEY_AppUserModel_ID - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L115) -```csharp title="Declaration" -public static ShellLink.PROPERTYKEY PKEY_AppUserModel_ID { get; } -``` -### PKEY_AppUserModel_ToastActivatorCLSID - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L124) -```csharp title="Declaration" -public static ShellLink.PROPERTYKEY PKEY_AppUserModel_ToastActivatorCLSID { get; } -``` -## Fields -### fmtid - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L112) -```csharp title="Declaration" -public Guid fmtid -``` -### pid - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L113) -```csharp title="Declaration" -public UIntPtr pid -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PropVariant.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PropVariant.md deleted file mode 100644 index d0cd38d..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PropVariant.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: Struct ShellLink.PropVariant -sidebar_label: ShellLink.PropVariant ---- -# Struct ShellLink.PropVariant - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L62) -```csharp title="Declaration" -public struct ShellLink.PropVariant -``` -## Fields -### variantType - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L65) -```csharp title="Declaration" -public short variantType -``` -### Reserved1 - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L66) -```csharp title="Declaration" -public short Reserved1 -``` -### Reserved2 - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L66) -```csharp title="Declaration" -public short Reserved2 -``` -### Reserved3 - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L66) -```csharp title="Declaration" -public short Reserved3 -``` -### pointerValue - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L67) -```csharp title="Declaration" -public IntPtr pointerValue -``` -## Methods -### FromString(string) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L69) -```csharp title="Declaration" -public static ShellLink.PropVariant FromString(string str) -``` - -##### Returns - -[Velopack.Windows.ShellLink.PropVariant](../Velopack.Windows/ShellLink.PropVariant) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *str* | - -### FromGuid(Guid) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L79) -```csharp title="Declaration" -public static ShellLink.PropVariant FromGuid(Guid guid) -``` - -##### Returns - -[Velopack.Windows.ShellLink.PropVariant](../Velopack.Windows/ShellLink.PropVariant) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Guid` | *guid* | - -### Clear() -Called to clear the PropVariant's referenced and local memory. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L103) -```csharp title="Declaration" -public void Clear() -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.md deleted file mode 100644 index 32f1678..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -title: Class ShellLink -sidebar_label: ShellLink -description: "Summary description for ShellLink." ---- -# Class ShellLink -Summary description for ShellLink. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L17) -```csharp title="Declaration" -public class ShellLink : IDisposable -``` -**Implements:** -`System.IDisposable` - -## Properties -### ShortCutFile - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L532) -```csharp title="Declaration" -public string ShortCutFile { get; set; } -``` -### IconPath -Gets the path to the file containing the icon for this shortcut. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L594) -```csharp title="Declaration" -public string IconPath { get; set; } -``` -### IconIndex -Gets the index of this icon within the icon path's resources -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L628) -```csharp title="Declaration" -public int IconIndex { get; set; } -``` -### Target -Gets/sets the fully qualified path to the link's target -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L662) -```csharp title="Declaration" -public string Target { get; set; } -``` -### WorkingDirectory -Gets/sets the Working Directory for the Link -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L688) -```csharp title="Declaration" -public string WorkingDirectory { get; set; } -``` -### Description -Gets/sets the description of the link -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L710) -```csharp title="Declaration" -public string Description { get; set; } -``` -### Arguments -Gets/sets any command line arguments associated with the link -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L732) -```csharp title="Declaration" -public string Arguments { get; set; } -``` -### DisplayMode -Gets/sets the initial display mode when the shortcut is -run -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L755) -```csharp title="Declaration" -public ShellLink.LinkDisplayMode DisplayMode { get; set; } -``` -### HotKey -Gets/sets the HotKey to start the shortcut (if any) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L777) -```csharp title="Declaration" -public short HotKey { get; set; } -``` -## Methods -### ~ShellLink() -Call dispose just in case it hasn't happened yet -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L512) -```csharp title="Declaration" -protected ~ShellLink() -``` -### Dispose() -Dispose the object, releasing the COM ShellLink object -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L520) -```csharp title="Declaration" -public void Dispose() -``` -### GetIcon(bool) -This pointer must be destroyed with DistroyIcon when you are done with it. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L541) -```csharp title="Declaration" -public IntPtr GetIcon(bool large) -``` - -##### Returns - -`System.IntPtr` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.Boolean` | *large* | Whether to return the small or large icon | - -### SetAppUserModelId(string) -Sets the appUserModelId -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L799) -```csharp title="Declaration" -public void SetAppUserModelId(string appId) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *appId* | - -### SetToastActivatorCLSID(string) -Sets the ToastActivatorCLSID -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L810) -```csharp title="Declaration" -public void SetToastActivatorCLSID(string clsid) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *clsid* | - -### SetToastActivatorCLSID(Guid) -Sets the ToastActivatorCLSID -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L819) -```csharp title="Declaration" -public void SetToastActivatorCLSID(Guid clsid) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Guid` | *clsid* | - -### Save() -Saves the shortcut to ShortCutFile. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L840) -```csharp title="Declaration" -public void Save() -``` -### Save(string) -Saves the shortcut to the specified file -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L849) -```csharp title="Declaration" -public void Save(string linkFile) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *linkFile* | The shortcut file (.lnk) | - -### Open(string) -Loads a shortcut from the specified file -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L867) -```csharp title="Declaration" -public void Open(string linkFile) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *linkFile* | The shortcut file (.lnk) to load | - -### Open(string, IntPtr, EShellLinkResolveFlags) -Loads a shortcut from the specified file, and allows flags controlling -the UI behaviour if the shortcut's target isn't found to be set. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L885) -```csharp title="Declaration" -public void Open(string linkFile, IntPtr hWnd, ShellLink.EShellLinkResolveFlags resolveFlags) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *linkFile* | The shortcut file (.lnk) to load | -| `System.IntPtr` | *hWnd* | The window handle of the application's UI, if any | -| [Velopack.Windows.ShellLink.EShellLinkResolveFlags](../Velopack.Windows/ShellLink.EShellLinkResolveFlags) | *resolveFlags* | Flags controlling resolution behaviour | - -### Open(string, IntPtr, EShellLinkResolveFlags, ushort) -Loads a shortcut from the specified file, and allows flags controlling -the UI behaviour if the shortcut's target isn't found to be set. If -no SLR_NO_UI is specified, you can also specify a timeout. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L906) -```csharp title="Declaration" -public void Open(string linkFile, IntPtr hWnd, ShellLink.EShellLinkResolveFlags resolveFlags, ushort timeOut) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *linkFile* | The shortcut file (.lnk) to load | -| `System.IntPtr` | *hWnd* | The window handle of the application's UI, if any | -| [Velopack.Windows.ShellLink.EShellLinkResolveFlags](../Velopack.Windows/ShellLink.EShellLinkResolveFlags) | *resolveFlags* | Flags controlling resolution behaviour | -| `System.UInt16` | *timeOut* | Timeout if SLR_NO_UI is specified, in ms. | - - -## Implements - -* `System.IDisposable` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShortcutLocation.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShortcutLocation.md deleted file mode 100644 index e98bc9f..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShortcutLocation.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Enum ShortcutLocation -sidebar_label: ShortcutLocation -description: "Specifies several common places where shortcuts can be installed on a user's system" ---- -# Enum ShortcutLocation -Specifies several common places where shortcuts can be installed on a user's system - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L18) -```csharp title="Declaration" -[Flags] -public enum ShortcutLocation -``` -## Fields -### StartMenu -A shortcut in ProgramFiles within a publisher sub-directory -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L24) -```csharp title="Declaration" -StartMenu = 1 -``` -### Desktop -A shortcut on the current user desktop -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L29) -```csharp title="Declaration" -Desktop = 2 -``` -### Startup -A shortcut in Startup/Run folder will cause the app to be automatially started on user login. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L34) -```csharp title="Declaration" -Startup = 4 -``` -### AppRoot -A shortcut in the application folder, useful for portable applications. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L39) -```csharp title="Declaration" -AppRoot = 8 -``` -### StartMenuRoot -A shortcut in ProgramFiles root folder (not in a company/publisher sub-directory). This is commonplace as of more recent versions of windows. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L44) -```csharp title="Declaration" -StartMenuRoot = 16 -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Shortcuts.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Shortcuts.md deleted file mode 100644 index 0dbb8a4..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Shortcuts.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -title: Class Shortcuts -sidebar_label: Shortcuts -description: "A helper class to create or delete windows shortcuts." ---- -# Class Shortcuts -A helper class to create or delete windows shortcuts. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L50) -```csharp title="Declaration" -[Obsolete("Desktop and StartMenuRoot shortcuts are now created and removed automatically when your app is installed / uninstalled.")] -public class Shortcuts -``` -## Properties -### Log -Log for diagnostic messages. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L55) -```csharp title="Declaration" -protected ILogger Log { get; } -``` -### Locator -Locator to use for finding important application paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L58) -```csharp title="Declaration" -protected IVelopackLocator Locator { get; } -``` -## Methods -### CreateShortcutForThisExe(ShortcutLocation) -Create a shortcut to the currently running executable at the specified locations. -See `Velopack.Windows.Shortcuts.CreateShortcut(System.String%2cVelopack.Windows.ShortcutLocation%2cSystem.Boolean%2cSystem.String%2cSystem.String)` to create a shortcut to a different program -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L71) -```csharp title="Declaration" -public void CreateShortcutForThisExe(ShortcutLocation location = ShortcutLocation.Desktop | ShortcutLocation.StartMenuRoot) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *location* | - -### RemoveShortcutForThisExe(ShortcutLocation) -Removes a shortcut for the currently running executable at the specified locations -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L84) -```csharp title="Declaration" -public void RemoveShortcutForThisExe(ShortcutLocation location = ShortcutLocation.StartMenu | ShortcutLocation.Desktop | ShortcutLocation.StartMenuRoot) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *location* | - -### FindShortcuts(string, ShortcutLocation) -Searches for existing shortcuts to an executable inside the current package. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L96) -```csharp title="Declaration" -public Dictionary FindShortcuts(string relativeExeName, ShortcutLocation locations) -``` - -##### Returns - -`System.Collections.Generic.Dictionary` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *relativeExeName* | The relative path or filename of the executable (from the current app dir). | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *locations* | The locations to search. | - -### CreateShortcut(string, ShortcutLocation, bool, string, string) -Creates new shortcuts to the specified executable at the specified locations. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L132) -```csharp title="Declaration" -public void CreateShortcut(string relativeExeName, ShortcutLocation locations, bool updateOnly, string programArguments, string icon = null) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *relativeExeName* | The relative path or filename of the executable (from the current app dir). | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *locations* | The locations to create shortcuts. | -| `System.Boolean` | *updateOnly* | If true, shortcuts will be updated instead of created. | -| `System.String` | *programArguments* | The arguments the application should be launched with | -| `System.String` | *icon* | Path to a specific icon to use instead of the exe icon. | - -### DeleteShortcuts(string, ShortcutLocation) -Delete all the shortcuts for the specified executable in the specified locations. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L198) -```csharp title="Declaration" -public void DeleteShortcuts(string relativeExeName, ShortcutLocation locations) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *relativeExeName* | The relative path or filename of the executable (from the current app dir). | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *locations* | The locations to create shortcuts. | - -### LinkPathForVersionInfo(ShortcutLocation, ZipPackage, FileVersionInfo, string) -Given an [Velopack.NuGet.ZipPackage](../Velopack.NuGet/ZipPackage) and `System.Diagnostics.FileVersionInfo` return the target shortcut path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L228) -```csharp title="Declaration" -protected virtual string LinkPathForVersionInfo(ShortcutLocation location, ZipPackage package, FileVersionInfo versionInfo, string rootdir) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *location* | -| [Velopack.NuGet.ZipPackage](../Velopack.NuGet/ZipPackage) | *package* | -| `System.Diagnostics.FileVersionInfo` | *versionInfo* | -| `System.String` | *rootdir* | - -### GetLinkPath(ShortcutLocation, string, string, string, bool) -Given the application info, return the shortcut target path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L251) -```csharp title="Declaration" -protected virtual string GetLinkPath(ShortcutLocation location, string title, string applicationName, string rootdir, bool createDirectoryIfNecessary = true) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *location* | -| `System.String` | *title* | -| `System.String` | *applicationName* | -| `System.String` | *rootdir* | -| `System.Boolean` | *createDirectoryIfNecessary* | - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Velopack.Windows.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Velopack.Windows.md deleted file mode 100644 index c13b236..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Velopack.Windows.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Namespace Velopack.Windows -sidebar_label: Velopack.Windows ---- -# Namespace Velopack.Windows -## Classes -### [FileIcon](../Velopack.Windows/FileIcon) -Enables extraction of icons for any file type from -the Shell. -### [Runtimes](../Velopack.Windows/Runtimes) -Contains static properties to access common supported runtimes, and a function to search for a runtime by name -### [Runtimes.DotnetInfo](../Velopack.Windows/Runtimes.DotnetInfo) -Represents a modern DOTNET runtime where versions are deployed independenly of the operating system -### [Runtimes.FrameworkInfo](../Velopack.Windows/Runtimes.FrameworkInfo) -Represents a full .NET Framework runtime, usually included in Windows automatically through Windows Update -### [Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) -Base type containing information about a runtime in relation to the current operating system -### [Runtimes.VCRedist00](../Velopack.Windows/Runtimes.VCRedist00) -Represents a VC++ redistributable package which is referenced by a permalink -### [Runtimes.VCRedist14](../Velopack.Windows/Runtimes.VCRedist14) -Represents a VC++ 2015-2022 redistributable package. -### [Runtimes.VCRedistInfo](../Velopack.Windows/Runtimes.VCRedistInfo) -The base class for a VC++ redistributable package. -### [ShellLink](../Velopack.Windows/ShellLink) -Summary description for ShellLink. -### [Shortcuts](../Velopack.Windows/Shortcuts) -A helper class to create or delete windows shortcuts. -## Structs -### [ShellLink.PROPERTYKEY](../Velopack.Windows/ShellLink.PROPERTYKEY) - -### [ShellLink.PropVariant](../Velopack.Windows/ShellLink.PropVariant) - -## Enums -### [FileIcon.SHGetFileInfoConstants](../Velopack.Windows/FileIcon.SHGetFileInfoConstants) - -### [Runtimes.DotnetRuntimeType](../Velopack.Windows/Runtimes.DotnetRuntimeType) -Dotnet Runtime SKU -### [Runtimes.RuntimeInstallResult](../Velopack.Windows/Runtimes.RuntimeInstallResult) -Runtime installation result code -### [ShellLink.EShellLinkResolveFlags](../Velopack.Windows/ShellLink.EShellLinkResolveFlags) -Flags determining how the links with missing -targets are resolved. -### [ShellLink.LinkDisplayMode](../Velopack.Windows/ShellLink.LinkDisplayMode) - -### [ShortcutLocation](../Velopack.Windows/ShortcutLocation) -Specifies several common places where shortcuts can be installed on a user's system diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RID.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RID.md deleted file mode 100644 index 8166a26..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RID.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: Class RID -sidebar_label: RID ---- -# Class RID - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L147) -```csharp title="Declaration" -public class RID : IEquatable -``` -**Implements:** -`System.IEquatable` - -## Properties -### BaseRID - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L153) -```csharp title="Declaration" -public RuntimeOs BaseRID { get; set; } -``` -### Version - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L155) -```csharp title="Declaration" -public RuntimeVersion Version { get; set; } -``` -### Architecture - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L156) -```csharp title="Declaration" -public RuntimeCpu Architecture { get; set; } -``` -### Qualifier - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L157) -```csharp title="Declaration" -public string Qualifier { get; set; } -``` -### HasVersion - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L313) -```csharp title="Declaration" -public bool HasVersion { get; } -``` -### HasArchitecture - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L315) -```csharp title="Declaration" -public bool HasArchitecture { get; } -``` -### HasQualifier - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L317) -```csharp title="Declaration" -public bool HasQualifier { get; } -``` -### IsValid - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L319) -```csharp title="Declaration" -public bool IsValid { get; } -``` -## Methods -### ToString() -Returns a string that represents the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L159) -```csharp title="Declaration" -public override string ToString() -``` - -##### Returns - -`System.String`: A string that represents the current object.### ToDisplay(RidDisplayType) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L161) -```csharp title="Declaration" -public string ToDisplay(RidDisplayType type) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.RidDisplayType](../Velopack/RidDisplayType) | *type* | - -### Parse(string) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L200) -```csharp title="Declaration" -public static RID Parse(string runtimeIdentifier) -``` - -##### Returns - -[Velopack.RID](../Velopack/RID) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *runtimeIdentifier* | - -### Equals(object) -Determines whether the specified object is equal to the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L321) -```csharp title="Declaration" -public override bool Equals(object obj) -``` - -##### Returns - -`System.Boolean`: true if the specified object is equal to the current object; otherwise, false. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.Object` | *obj* | The object to compare with the current object. | - -### Equals(RID) -Indicates whether the current object is equal to another object of the same type. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L326) -```csharp title="Declaration" -public bool Equals(RID obj) -``` - -##### Returns - -`System.Boolean`: true if the current object is equal to the <code class="paramref">other</code> parameter; otherwise, false. -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.RID](../Velopack/RID) | *obj* | - -### GetHashCode() -Serves as the default hash function. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L349) -```csharp title="Declaration" -public override int GetHashCode() -``` - -##### Returns - -`System.Int32`: A hash code for the current object. -## Implements - -* `System.IEquatable` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntry.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntry.md deleted file mode 100644 index 1553fe2..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntry.md +++ /dev/null @@ -1,287 +0,0 @@ ---- -title: Class ReleaseEntry -sidebar_label: ReleaseEntry -description: "Represents a Velopack release, as described in a RELEASES file - usually also with an -accompanying package containing the files needed to apply the release." ---- -# Class ReleaseEntry -Represents a Velopack release, as described in a RELEASES file - usually also with an -accompanying package containing the files needed to apply the release. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L96) -```csharp title="Declaration" -[DataContract] -[Obsolete("This release format has been replaced by VelopackRelease")] -public class ReleaseEntry -``` -## Properties -### Identity -The release identity - including id, version and so forth. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L101) -```csharp title="Declaration" -[IgnoreDataMember] -public ReleaseEntryName Identity { get; protected set; } -``` -### PackageId -The name or Id of the package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L104) -```csharp title="Declaration" -[DataMember] -public string PackageId { get; } -``` -### Version -The version of this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L107) -```csharp title="Declaration" -[DataMember] -public SemanticVersion Version { get; } -``` -### IsDelta -Whether this package represents a full update, or a delta update. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L110) -```csharp title="Declaration" -[DataMember] -public bool IsDelta { get; } -``` -### SHA1 -The SHA1 checksum of the update package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L113) -```csharp title="Declaration" -[DataMember] -public string SHA1 { get; protected set; } -``` -### BaseUrl -If the release corresponds to a remote http location, this will be the base url. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L116) -```csharp title="Declaration" -[DataMember] -public string BaseUrl { get; protected set; } -``` -### Query -The http url query (if applicable). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L119) -```csharp title="Declaration" -[DataMember] -public string Query { get; protected set; } -``` -### Filesize -The size in bytes of the update package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L122) -```csharp title="Declaration" -[DataMember] -public long Filesize { get; protected set; } -``` -### StagingPercentage -The percentage of users this package has been released to. This release -may or may not be applied if the current user is not in the staging group. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L128) -```csharp title="Declaration" -[DataMember] -public float? StagingPercentage { get; protected set; } -``` -### OriginalFilename -The filename of the update package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L131) -```csharp title="Declaration" -[DataMember] -public string OriginalFilename { get; protected set; } -``` -### EntryAsString -The unparsed text used to construct this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L134) -```csharp title="Declaration" -[IgnoreDataMember] -public string EntryAsString { get; } -``` -## Methods -### FromVelopackAsset(VelopackAsset) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L189) -```csharp title="Declaration" -public static ReleaseEntry FromVelopackAsset(VelopackAsset asset) -``` - -##### Returns - -[Velopack.ReleaseEntry](../Velopack/ReleaseEntry) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *asset* | - -### ParseReleaseEntry(string) -Parses an string entry from a RELEASES file and returns a [Velopack.ReleaseEntry](../Velopack/ReleaseEntry). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L197) -```csharp title="Declaration" -public static ReleaseEntry ParseReleaseEntry(string entry) -``` - -##### Returns - -[Velopack.ReleaseEntry](../Velopack/ReleaseEntry) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *entry* | - -### IsStagingMatch(Guid?) -Checks if the current user is eligible for the current staging percentage. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L261) -```csharp title="Declaration" -public bool IsStagingMatch(Guid? userId) -``` - -##### Returns - -`System.Boolean` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Nullable` | *userId* | - -### ParseReleaseFile(string) -Parse the contents of a RELEASES file into a list of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry)'s. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L278) -```csharp title="Declaration" -public static IEnumerable ParseReleaseFile(string fileContents) -``` - -##### Returns - -`System.Collections.Generic.IEnumerable` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *fileContents* | - -### ParseReleaseFileAndApplyStaging(string, Guid?) -Parse the contents of a RELEASES file into a list of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry)'s, -with any staging-ineligible releases removed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L299) -```csharp title="Declaration" -public static IEnumerable ParseReleaseFileAndApplyStaging(string fileContents, Guid? userToken) -``` - -##### Returns - -`System.Collections.Generic.IEnumerable` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *fileContents* | -| `System.Nullable` | *userToken* | - -### WriteReleaseFile(IEnumerable<ReleaseEntry>, Stream) -Write a list of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry)'s to a stream -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L319) -```csharp title="Declaration" -public static void WriteReleaseFile(IEnumerable releaseEntries, Stream stream) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Collections.Generic.IEnumerable` | *releaseEntries* | -| `System.IO.Stream` | *stream* | - -### WriteReleaseFile(IEnumerable<ReleaseEntry>, string) -Write a list of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry)'s to a local file -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L335) -```csharp title="Declaration" -public static void WriteReleaseFile(IEnumerable releaseEntries, string path) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Collections.Generic.IEnumerable` | *releaseEntries* | -| `System.String` | *path* | - -### GenerateFromFile(Stream, string, string) -Generates a [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) from a local update package file (such as a nupkg). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L348) -```csharp title="Declaration" -public static ReleaseEntry GenerateFromFile(Stream file, string filename, string baseUrl = null) -``` - -##### Returns - -[Velopack.ReleaseEntry](../Velopack/ReleaseEntry) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.IO.Stream` | *file* | -| `System.String` | *filename* | -| `System.String` | *baseUrl* | - -### GenerateFromFile(string, string) -Generates a [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) from a local update package file (such as a nupkg). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L360) -```csharp title="Declaration" -public static ReleaseEntry GenerateFromFile(string path, string baseUrl = null) -``` - -##### Returns - -[Velopack.ReleaseEntry](../Velopack/ReleaseEntry) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *path* | -| `System.String` | *baseUrl* | - -### BuildReleasesFile(string, bool) -Generates a list of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry)'s from a local directory containing -package files. Also writes/updates a RELEASES file in the specified directory -to match the packages the are currently present. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L373) -```csharp title="Declaration" -public static List BuildReleasesFile(string releasePackagesDir, bool writeToDisk = true) -``` - -##### Returns - -`System.Collections.Generic.List`: The list of packages in the directory -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *releasePackagesDir* | -| `System.Boolean` | *writeToDisk* | - -### ToString() -Returns a string that represents the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L411) -```csharp title="Declaration" -public override string ToString() -``` - -##### Returns - -`System.String`: A string that represents the current object.### GetHashCode() -Serves as the default hash function. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L414) -```csharp title="Declaration" -public override int GetHashCode() -``` - -##### Returns - -`System.Int32`: A hash code for the current object. \ No newline at end of file diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntryName.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntryName.md deleted file mode 100644 index 97f1aa2..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntryName.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: Class ReleaseEntryName -sidebar_label: ReleaseEntryName -description: "Represents the information that can be parsed from a release entry filename." ---- -# Class ReleaseEntryName -Represents the information that can be parsed from a release entry filename. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L32) -```csharp title="Declaration" -[Obsolete("This release format has been replaced by VelopackRelease")] -public sealed record ReleaseEntryName : IEquatable -``` -**Implements:** -`System.IEquatable` - -## Properties -### PackageId -The package Id. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L36) -```csharp title="Declaration" -public string PackageId { get; } -``` -### Version -The package version. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L39) -```csharp title="Declaration" -public SemanticVersion Version { get; } -``` -### IsDelta -Whether this is a delta (patch) package, or a full update package. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L42) -```csharp title="Declaration" -public bool IsDelta { get; } -``` -## Methods -### FromEntryFileName(string) -Takes a filename such as 'My-Cool3-App-1.0.1-build.23-full.nupkg' and separates it into -it's name and version (eg. 'My-Cool3-App', and '1.0.1-build.23'). Returns null values if -the filename can not be parsed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L62) -```csharp title="Declaration" -public static ReleaseEntryName FromEntryFileName(string fileName) -``` - -##### Returns - -[Velopack.ReleaseEntryName](../Velopack/ReleaseEntryName) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *fileName* | - -### ToFileName() -Generate the file name which would represent this ReleaseEntryName. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L88) -```csharp title="Declaration" -public string ToFileName() -``` - -##### Returns - -`System.String` - -## Implements - -* `System.IEquatable` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseNotesFormat.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseNotesFormat.md deleted file mode 100644 index edef525..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseNotesFormat.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Enum ReleaseNotesFormat -sidebar_label: ReleaseNotesFormat -description: "Describes the requested release notes text format." ---- -# Enum ReleaseNotesFormat -Describes the requested release notes text format. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L20) -```csharp title="Declaration" -[Obsolete("This release format has been replaced by VelopackRelease")] -public enum ReleaseNotesFormat -``` -## Fields -### Markdown -The original markdown release notes. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L24) -```csharp title="Declaration" -Markdown = 0 -``` -### Html -Release notes translated into HTML. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L26) -```csharp title="Declaration" -Html = 1 -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RidDisplayType.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RidDisplayType.md deleted file mode 100644 index aa5c5cb..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RidDisplayType.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Enum RidDisplayType -sidebar_label: RidDisplayType ---- -# Enum RidDisplayType - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L140) -```csharp title="Declaration" -public enum RidDisplayType -``` -## Fields -### NoVersion - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L142) -```csharp title="Declaration" -NoVersion = 0 -``` -### ShortVersion - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L143) -```csharp title="Declaration" -ShortVersion = 1 -``` -### FullVersion - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L144) -```csharp title="Declaration" -FullVersion = 2 -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeCpu.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeCpu.md deleted file mode 100644 index ba47e39..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeCpu.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Enum RuntimeCpu -sidebar_label: RuntimeCpu -description: "The Runtime CPU Architecture" ---- -# Enum RuntimeCpu -The Runtime CPU Architecture - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L44) -```csharp title="Declaration" -public enum RuntimeCpu : ushort -``` -## Fields -### Unknown -Unknown or unsupported -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L47) -```csharp title="Declaration" -Unknown = 0 -``` -### x86 -Intel x86 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L50) -```csharp title="Declaration" -x86 = 332 -``` -### x64 -x64 / Amd64 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L53) -```csharp title="Declaration" -x64 = 34404 -``` -### arm64 -Arm64 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L56) -```csharp title="Declaration" -arm64 = 43620 -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeOs.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeOs.md deleted file mode 100644 index 1e6523f..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeOs.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Enum RuntimeOs -sidebar_label: RuntimeOs -description: "The Runtime OS" ---- -# Enum RuntimeOs -The Runtime OS - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L60) -```csharp title="Declaration" -public enum RuntimeOs -``` -## Fields -### Unknown -Unknown or unsupported -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L63) -```csharp title="Declaration" -Unknown = 0 -``` -### Windows -Windows -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L66) -```csharp title="Declaration" -Windows = 1 -``` -### Linux -Linux -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L69) -```csharp title="Declaration" -Linux = 2 -``` -### OSX -OSX -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L72) -```csharp title="Declaration" -OSX = 3 -``` -## Extension Methods -* [Velopack.VelopackRuntimeInfo.GetOsLongName(Velopack.RuntimeOs)](../Velopack/VelopackRuntimeInfo#getoslongnameruntimeos) -* [Velopack.VelopackRuntimeInfo.GetOsShortName(Velopack.RuntimeOs)](../Velopack/VelopackRuntimeInfo#getosshortnameruntimeos) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeVersion.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeVersion.md deleted file mode 100644 index f886408..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeVersion.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -title: Class RuntimeVersion -sidebar_label: RuntimeVersion -description: "A Version class that also supports a single integer (major only)" ---- -# Class RuntimeVersion -A Version class that also supports a single integer (major only) - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L14) -```csharp title="Declaration" -public sealed class RuntimeVersion : IComparable, IComparable, IEquatable -``` -**Implements:** -`System.IComparable`, `System.IComparable`, `System.IEquatable` - -## Properties -### Major - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L16) -```csharp title="Declaration" -public int Major { get; } -``` -## Methods -### CompareTo(object) -Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L48) -```csharp title="Declaration" -public int CompareTo(object obj) -``` - -##### Returns - -`System.Int32`: A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes <code class="paramref">obj</code> in the sort order. Zero This instance occurs in the same position in the sort order as <code class="paramref">obj</code>. Greater than zero This instance follows <code class="paramref">obj</code> in the sort order. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.Object` | *obj* | An object to compare with this instance. | - - -##### Exceptions - -`System.ArgumentException` -<code class="paramref">obj</code> is not the same type as this instance. -### CompareTo(RuntimeVersion) -Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L61) -```csharp title="Declaration" -public int CompareTo(RuntimeVersion other) -``` - -##### Returns - -`System.Int32`: A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes <code class="paramref">other</code> in the sort order. Zero This instance occurs in the same position in the sort order as <code class="paramref">other</code>. Greater than zero This instance follows <code class="paramref">other</code> in the sort order. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.RuntimeVersion](../Velopack/RuntimeVersion) | *other* | An object to compare with this instance. | - -### Equals(RuntimeVersion) -Indicates whether the current object is equal to another object of the same type. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L84) -```csharp title="Declaration" -public bool Equals(RuntimeVersion other) -``` - -##### Returns - -`System.Boolean`: true if the current object is equal to the <code class="paramref">other</code> parameter; otherwise, false. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.RuntimeVersion](../Velopack/RuntimeVersion) | *other* | An object to compare with this object. | - -### Equals(object) -Determines whether the specified object is equal to the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L91) -```csharp title="Declaration" -public override bool Equals(object obj) -``` - -##### Returns - -`System.Boolean`: true if the specified object is equal to the current object; otherwise, false. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.Object` | *obj* | The object to compare with the current object. | - -### GetHashCode() -Serves as the default hash function. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L96) -```csharp title="Declaration" -public override int GetHashCode() -``` - -##### Returns - -`System.Int32`: A hash code for the current object.### ToString() -Returns a string that represents the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L101) -```csharp title="Declaration" -public override string ToString() -``` - -##### Returns - -`System.String`: A string that represents the current object. -## Implements - -* `System.IComparable` -* `System.IComparable` -* `System.IEquatable` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateExe.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateExe.md deleted file mode 100644 index d585126..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateExe.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Class UpdateExe -sidebar_label: UpdateExe -description: "A static helper class to assist in running Update.exe CLI commands. You probably should not invoke this directly, -instead you should use the relevant methods on [Velopack.UpdateManager](../Velopack/UpdateManager). For example: -[Velopack.UpdateManager.ApplyUpdatesAndExit(Velopack.VelopackAsset?)](../Velopack/UpdateManager#applyupdatesandexitvelopackasset), or `Velopack.UpdateManager.ApplyUpdatesAndRestart(Velopack.VelopackAsset%2cSystem.String%5b%5d)`." ---- -# Class UpdateExe -A static helper class to assist in running Update.exe CLI commands. You probably should not invoke this directly, -instead you should use the relevant methods on [Velopack.UpdateManager](../Velopack/UpdateManager). For example: -[Velopack.UpdateManager.ApplyUpdatesAndExit(Velopack.VelopackAsset?)](../Velopack/UpdateManager#applyupdatesandexitvelopackasset), or `Velopack.UpdateManager.ApplyUpdatesAndRestart(Velopack.VelopackAsset%2cSystem.String%5b%5d)`. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateExe.cs#L18) -```csharp title="Declaration" -public static class UpdateExe -``` -## Methods -### Apply(IVelopackLocator?, VelopackAsset?, bool, bool, string[]?, ILogger?) -Runs Update.exe in the current working directory to apply updates, optionally restarting the application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateExe.cs#L36) -```csharp title="Declaration" -public static void Apply(IVelopackLocator? locator, VelopackAsset? toApply, bool silent, bool restart, string[]? restartArgs = null, ILogger? logger = null) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) | *locator* | The locator to use to find the path to Update.exe and the packages directory. | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *toApply* | The update package you wish to apply, can be left null. | -| `System.Boolean` | *silent* | If true, no dialogs will be shown during the update process. This could result - in an update failing to install, such as when we need to ask the user for permission to install - a new framework dependency. | -| `System.Boolean` | *restart* | If true, restarts the application after updates are applied (or if they failed) | -| `System.String[]` | *restartArgs* | The arguments to pass to the application when it is restarted. | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for diagnostic messages | - - -##### Exceptions - -`System.Exception` -Thrown if Update.exe does not initialize properly. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateInfo.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateInfo.md deleted file mode 100644 index 4b215b4..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateInfo.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Class UpdateInfo -sidebar_label: UpdateInfo -description: "Holds information about the current version and pending updates, such as how many there are, and access to release notes." ---- -# Class UpdateInfo -Holds information about the current version and pending updates, such as how many there are, and access to release notes. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateInfo.cs#L6) -```csharp title="Declaration" -public class UpdateInfo -``` -## Properties -### TargetFullRelease -The available version that we are updating to. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateInfo.cs#L11) -```csharp title="Declaration" -public VelopackAsset TargetFullRelease { get; } -``` -### IsDowngrade -True if the update is a version downgrade or lateral move (such as when switching channels to the same version number). -In this case, only full updates are allowed, and any local packages on disk newer than the downloaded version will be -deleted. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateInfo.cs#L18) -```csharp title="Declaration" -public bool IsDowngrade { get; } -``` -### BaseRelease -The base release that we are to apply delta updates from. If null, we can try doing a delta update from -the currently installed version. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateInfo.cs#L24) -```csharp title="Declaration" -public VelopackAsset? BaseRelease { get; } -``` -### DeltasToTarget -The list of delta versions between the current version and [Velopack.UpdateInfo.TargetFullRelease](../Velopack/UpdateInfo#targetfullrelease). -These will be applied in order. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateInfo.cs#L30) -```csharp title="Declaration" -public VelopackAsset[] DeltasToTarget { get; } -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateManager.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateManager.md deleted file mode 100644 index 2f45db6..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateManager.md +++ /dev/null @@ -1,279 +0,0 @@ ---- -title: Class UpdateManager -sidebar_label: UpdateManager -description: "Provides functionality for checking for updates, downloading updates, and applying updates to the current application." ---- -# Class UpdateManager -Provides functionality for checking for updates, downloading updates, and applying updates to the current application. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.Helpers.cs#L6) -```csharp title="Declaration" -public class UpdateManager -``` -## Properties -### AppId -The currently installed application Id. This would be what you set when you create your release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L22) -```csharp title="Declaration" -public virtual string? AppId { get; } -``` -### IsInstalled -True if this application is currently installed, and is able to download/check for updates. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L25) -```csharp title="Declaration" -public virtual bool IsInstalled { get; } -``` -### IsUpdatePendingRestart -True if there is a local update prepared that requires a call to `Velopack.UpdateManager.ApplyUpdatesAndRestart(Velopack.VelopackAsset%2cSystem.String%5b%5d)` to be applied. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L28) -```csharp title="Declaration" -public virtual bool IsUpdatePendingRestart { get; } -``` -### CurrentVersion -The currently installed app version when you created your release. Null if this is not a currently installed app. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L38) -```csharp title="Declaration" -public virtual SemanticVersion? CurrentVersion { get; } -``` -### Source -The update source to use when checking for/downloading updates. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L41) -```csharp title="Declaration" -protected IUpdateSource Source { get; } -``` -### Log -The logger to use for diagnostic messages. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L44) -```csharp title="Declaration" -protected ILogger Log { get; } -``` -### Locator -The locator to use when searching for local file paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L47) -```csharp title="Declaration" -protected IVelopackLocator Locator { get; } -``` -### Channel -The channel to use when searching for packages. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L50) -```csharp title="Declaration" -protected string Channel { get; } -``` -### DefaultChannel -The default channel to search for packages in, if one was not provided by the user. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L53) -```csharp title="Declaration" -protected string DefaultChannel { get; } -``` -### IsNonDefaultChannel -If true, an explicit channel was provided by the user, and it's different than the default channel. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L56) -```csharp title="Declaration" -protected bool IsNonDefaultChannel { get; } -``` -### ShouldAllowVersionDowngrade -If true, UpdateManager should return the latest asset in the feed, even if that version is lower than the current version. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L59) -```csharp title="Declaration" -protected bool ShouldAllowVersionDowngrade { get; } -``` -## Methods -### CheckForUpdates() -Checks for updates, returning null if there are none available. If there are updates available, this method will return an -UpdateInfo object containing the latest available release, and any delta updates that can be applied if they are available. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L98) -```csharp title="Declaration" -public UpdateInfo? CheckForUpdates() -``` - -##### Returns - -[Velopack.UpdateInfo](../Velopack/UpdateInfo): Null if no updates, otherwise [Velopack.UpdateInfo](../Velopack/UpdateInfo) containing the version of the latest update available.### CheckForUpdatesAsync() -Checks for updates, returning null if there are none available. If there are updates available, this method will return an -UpdateInfo object containing the latest available release, and any delta updates that can be applied if they are available. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L109) -```csharp title="Declaration" -public virtual Task CheckForUpdatesAsync() -``` - -##### Returns - -`System.Threading.Tasks.Task`: Null if no updates, otherwise [Velopack.UpdateInfo](../Velopack/UpdateInfo) containing the version of the latest update available.### CreateDeltaUpdateStrategy(VelopackAsset[], VelopackAsset?, VelopackAsset) -Given a feed of releases, and the latest local full release, and the latest remote full release, this method will return a delta -update strategy to be used by `Velopack.UpdateManager.DownloadUpdatesAsync(Velopack.UpdateInfo%2cSystem.Action%7bSystem.Int32%7d%2cSystem.Boolean%2cSystem.Threading.CancellationToken)`. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L155) -```csharp title="Declaration" -protected virtual UpdateInfo CreateDeltaUpdateStrategy(VelopackAsset[] feed, VelopackAsset? latestLocalFull, VelopackAsset latestRemoteFull) -``` - -##### Returns - -[Velopack.UpdateInfo](../Velopack/UpdateInfo) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `Velopack.VelopackAsset[]` | *feed* | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestLocalFull* | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestRemoteFull* | - -### DownloadUpdates(UpdateInfo, Action<int>?, bool) -Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, -this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta -packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock -so may fail if there is already another update operation in progress. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L183) -```csharp title="Declaration" -public void DownloadUpdates(UpdateInfo updates, Action? progress = null, bool ignoreDeltas = false) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.UpdateInfo](../Velopack/UpdateInfo) | *updates* | The updates to download. Should be retrieved from [Velopack.UpdateManager.CheckForUpdates()](../Velopack/UpdateManager#checkforupdates). | -| `System.Action` | *progress* | The progress callback. Will be called with values from 0-100. | -| `System.Boolean` | *ignoreDeltas* | Whether to attempt downloading delta's or skip to full package download. | - -### DownloadUpdatesAsync(UpdateInfo, Action<int>?, bool, CancellationToken) -Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, -this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta -packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock -so may fail if there is already another update operation in progress. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L199) -```csharp title="Declaration" -public virtual Task DownloadUpdatesAsync(UpdateInfo updates, Action? progress = null, bool ignoreDeltas = false, CancellationToken cancelToken = default) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.UpdateInfo](../Velopack/UpdateInfo) | *updates* | The updates to download. Should be retrieved from [Velopack.UpdateManager.CheckForUpdates()](../Velopack/UpdateManager#checkforupdates). | -| `System.Action` | *progress* | The progress callback. Will be called with values from 0-100. | -| `System.Boolean` | *ignoreDeltas* | Whether to attempt downloading delta's or skip to full package download. | -| `System.Threading.CancellationToken` | *cancelToken* | An optional cancellation token if you wish to stop this operation. | - -### DownloadAndApplyDeltaUpdates(string, UpdateInfo, Action<int>, CancellationToken) -Given a folder containing the extracted base package, and a list of delta updates, downloads and applies the -delta updates to the base package. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L328) -```csharp title="Declaration" -protected virtual Task DownloadAndApplyDeltaUpdates(string extractedBasePackage, UpdateInfo updates, Action progress, CancellationToken cancelToken) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *extractedBasePackage* | A folder containing the application files to apply the delta's to. | -| [Velopack.UpdateInfo](../Velopack/UpdateInfo) | *updates* | An update object containing one or more delta's | -| `System.Action` | *progress* | A callback reporting process of delta application progress (from 0-100). | -| `System.Threading.CancellationToken` | *cancelToken* | A token to use to cancel the request. | - -### CleanPackagesExcept(string?) -Removes any incomplete files (.partial) and packages (.nupkg) from the packages directory that does not match -the provided asset. If assetToKeep is null, all packages will be deleted. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L379) -```csharp title="Declaration" -protected virtual void CleanPackagesExcept(string? assetToKeep) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *assetToKeep* | - -### VerifyPackageChecksum(VelopackAsset, string?) -Check a package checksum against the one in the release entry, and throws if the checksum does not match. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L416) -```csharp title="Declaration" -protected virtual void VerifyPackageChecksum(VelopackAsset release, string? filePathOverride = null) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *release* | The entry to check | -| `System.String` | *filePathOverride* | Optional file path, if not specified the package will be loaded from %pkgdir%/release.OriginalFilename. | - -### EnsureInstalled() -Throws an exception if the current application is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L439) -```csharp title="Declaration" -protected virtual void EnsureInstalled() -``` -### AcquireUpdateLock() -Acquires a globally unique mutex/lock for the current application, to avoid concurrent install/uninstall/update operations. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L448) -```csharp title="Declaration" -protected virtual Mutex AcquireUpdateLock() -``` - -##### Returns - -`System.Threading.Mutex` -### ApplyUpdatesAndRestart(VelopackAsset?, string[]?) -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified -restart arguments. If you need to save state or clean up, you should do that before calling this method. -The user may be prompted during the update, if the update requires additional frameworks to be installed etc. -You can check if there are pending updates by checking [Velopack.UpdateManager.IsUpdatePendingRestart](../Velopack/UpdateManager#isupdatependingrestart). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.Helpers.cs#L22) -```csharp title="Declaration" -public void ApplyUpdatesAndRestart(VelopackAsset? toApply, string[]? restartArgs = null) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *toApply* | The target release to apply. Can be left null to auto-apply the newest downloaded release. | -| `System.String[]` | *restartArgs* | The arguments to pass to the application when it is restarted. | - -### ApplyUpdatesAndExit(VelopackAsset?) -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified -restart arguments. If you need to save state or clean up, you should do that before calling this method. -The user may be prompted during the update, if the update requires additional frameworks to be installed etc. -You can check if there are pending updates by checking [Velopack.UpdateManager.IsUpdatePendingRestart](../Velopack/UpdateManager#isupdatependingrestart). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.Helpers.cs#L41) -```csharp title="Declaration" -public void ApplyUpdatesAndExit(VelopackAsset? toApply) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *toApply* | The target release to apply. Can be left null to auto-apply the newest downloaded release. | - -### WaitExitThenApplyUpdates(VelopackAsset?, bool, bool, string[]?) -This will launch the Velopack updater and tell it to wait for this program to exit gracefully. -You should then clean up any state and exit your app. The updater will apply updates and then -optionally restart your app. The updater will only wait for 60 seconds before giving up. -You can check if there are pending updates by checking [Velopack.UpdateManager.IsUpdatePendingRestart](../Velopack/UpdateManager#isupdatependingrestart). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.Helpers.cs#L57) -```csharp title="Declaration" -public void WaitExitThenApplyUpdates(VelopackAsset? toApply, bool silent = false, bool restart = true, string[]? restartArgs = null) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *toApply* | The target release to apply. Can be left null to auto-apply the newest downloaded release. | -| `System.Boolean` | *silent* | Configure whether Velopack should show a progress window / dialogs during the updates or not. | -| `System.Boolean` | *restart* | Configure whether Velopack should restart the app after the updates have been applied. | -| `System.String[]` | *restartArgs* | The arguments to pass to the application when it is restarted. | - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateOptions.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateOptions.md deleted file mode 100644 index 543b510..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateOptions.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Class UpdateOptions -sidebar_label: UpdateOptions -description: "Options to customise the behaviour of [Velopack.UpdateManager](../Velopack/UpdateManager)." ---- -# Class UpdateOptions -Options to customise the behaviour of [Velopack.UpdateManager](../Velopack/UpdateManager). - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateOptions.cs#L6) -```csharp title="Declaration" -public class UpdateOptions -``` -## Properties -### AllowVersionDowngrade -Allows UpdateManager to update to a version that's lower than the current version (i.e. downgrading). -This could happen if a release has bugs and was retracted from the release feed, or if you're using -[Velopack.UpdateOptions.ExplicitChannel](../Velopack/UpdateOptions#explicitchannel) to switch channels to another channel where the latest version on that -channel is lower than the current version. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateOptions.cs#L14) -```csharp title="Declaration" -public bool AllowVersionDowngrade { get; set; } -``` -### ExplicitChannel -<b>This option should usually be left null</b>. Overrides the default channel used to fetch updates. -The default channel will be whatever channel was specified on the command line when building this release. -For example, if the current release was packaged with '--channel beta', then the default channel will be 'beta'. -This allows users to automatically receive updates from the same channel they installed from. This options -allows you to explicitly switch channels, for example if the user wished to switch back to the 'stable' channel -without having to reinstall the application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateOptions.cs#L24) -```csharp title="Declaration" -public string? ExplicitChannel { get; set; } -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/Velopack.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/Velopack.md deleted file mode 100644 index 01742fc..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/Velopack.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Namespace Velopack -sidebar_label: Velopack ---- -# Namespace Velopack -## Classes -### [ReleaseEntry](../Velopack/ReleaseEntry) -Represents a Velopack release, as described in a RELEASES file - usually also with an -accompanying package containing the files needed to apply the release. -### [ReleaseEntryName](../Velopack/ReleaseEntryName) -Represents the information that can be parsed from a release entry filename. -### [RID](../Velopack/RID) - -### [RuntimeVersion](../Velopack/RuntimeVersion) -A Version class that also supports a single integer (major only) -### [UpdateExe](../Velopack/UpdateExe) -A static helper class to assist in running Update.exe CLI commands. You probably should not invoke this directly, -instead you should use the relevant methods on [Velopack.UpdateManager](../Velopack/UpdateManager). For example: -[Velopack.UpdateManager.ApplyUpdatesAndExit(Velopack.VelopackAsset?)](../Velopack/UpdateManager#applyupdatesandexitvelopackasset), or `Velopack.UpdateManager.ApplyUpdatesAndRestart(Velopack.VelopackAsset%2cSystem.String%5b%5d)`. -### [UpdateInfo](../Velopack/UpdateInfo) -Holds information about the current version and pending updates, such as how many there are, and access to release notes. -### [UpdateManager](../Velopack/UpdateManager) -Provides functionality for checking for updates, downloading updates, and applying updates to the current application. -### [UpdateOptions](../Velopack/UpdateOptions) -Options to customise the behaviour of [Velopack.UpdateManager](../Velopack/UpdateManager). -### [VelopackApp](../Velopack/VelopackApp) -VelopackApp helps you to handle app activation events correctly. -This should be used as early as possible in your application startup code. -(eg. the beginning of Main() in Program.cs) -### [VelopackAsset](../Velopack/VelopackAsset) -An individual Velopack asset, could refer to an asset on-disk or in a remote package feed. -### [VelopackAssetFeed](../Velopack/VelopackAssetFeed) -A feed of Velopack assets, usually returned from an [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource). -### [VelopackRuntimeInfo](../Velopack/VelopackRuntimeInfo) -Convenience class which provides runtime information about the current executing process, -in a way that is safe in older and newer versions of the framework. -## Enums -### [ReleaseNotesFormat](../Velopack/ReleaseNotesFormat) -Describes the requested release notes text format. -### [RidDisplayType](../Velopack/RidDisplayType) - -### [RuntimeCpu](../Velopack/RuntimeCpu) -The Runtime CPU Architecture -### [RuntimeOs](../Velopack/RuntimeOs) -The Runtime OS -### [VelopackAssetType](../Velopack/VelopackAssetType) -Represents a Velopack Asset Type. -## Delegates -### [VelopackHook](../Velopack/VelopackHook) -A delegate type for handling Velopack startup events diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackApp.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackApp.md deleted file mode 100644 index b0df302..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackApp.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -title: Class VelopackApp -sidebar_label: VelopackApp -description: "VelopackApp helps you to handle app activation events correctly. -This should be used as early as possible in your application startup code. -(eg. the beginning of Main() in Program.cs)" ---- -# Class VelopackApp -VelopackApp helps you to handle app activation events correctly. -This should be used as early as possible in your application startup code. -(eg. the beginning of Main() in Program.cs) - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L23) -```csharp title="Declaration" -public sealed class VelopackApp -``` -## Methods -### Build() -Creates and returns a new Velopack application builder. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L45) -```csharp title="Declaration" -public static VelopackApp Build() -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) -### SetArgs(string[]) -Override the command line arguments used to determine the Velopack hook to run. -If this is not set, the command line arguments passed to the application will be used. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L51) -```csharp title="Declaration" -public VelopackApp SetArgs(string[] args) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String[]` | *args* | - -### SetAutoApplyOnStartup(bool) -Set whether to automatically apply downloaded updates on startup. This is ON by default. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L60) -```csharp title="Declaration" -public VelopackApp SetAutoApplyOnStartup(bool autoApply) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Boolean` | *autoApply* | - -### SetLocator(IVelopackLocator) -Override the default [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) used to search for application paths. -This will be cached and potentially re-used throughout the lifetime of the application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L70) -```csharp title="Declaration" -public VelopackApp SetLocator(IVelopackLocator locator) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) | *locator* | - -### WithFirstRun(VelopackHook) -This hook is triggered when the application is started for the first time after installation. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L79) -```csharp title="Declaration" -public VelopackApp WithFirstRun(VelopackHook hook) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackHook](../Velopack/VelopackHook) | *hook* | - -### WithRestarted(VelopackHook) -This hook is triggered when the application is restarted by Velopack after installing updates. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L88) -```csharp title="Declaration" -public VelopackApp WithRestarted(VelopackHook hook) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackHook](../Velopack/VelopackHook) | *hook* | - -### WithAfterInstallFastCallback(VelopackHook) -WARNING: FastCallback hooks are run during critical stages of Velopack operations. -Your code will be run and then `System.Environment.Exit(System.Int32)` will be called. -If your code has not completed within 30 seconds, it will be terminated. -Only supported on windows; On other operating systems, this will never be called. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L100) -```csharp title="Declaration" -public VelopackApp WithAfterInstallFastCallback(VelopackHook hook) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackHook](../Velopack/VelopackHook) | *hook* | - -### WithAfterUpdateFastCallback(VelopackHook) -WARNING: FastCallback hooks are run during critical stages of Velopack operations. -Your code will be run and then `System.Environment.Exit(System.Int32)` will be called. -If your code has not completed within 15 seconds, it will be terminated. -Only supported on windows; On other operating systems, this will never be called. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L113) -```csharp title="Declaration" -public VelopackApp WithAfterUpdateFastCallback(VelopackHook hook) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackHook](../Velopack/VelopackHook) | *hook* | - -### WithBeforeUpdateFastCallback(VelopackHook) -WARNING: FastCallback hooks are run during critical stages of Velopack operations. -Your code will be run and then `System.Environment.Exit(System.Int32)` will be called. -If your code has not completed within 15 seconds, it will be terminated. -Only supported on windows; On other operating systems, this will never be called. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L126) -```csharp title="Declaration" -public VelopackApp WithBeforeUpdateFastCallback(VelopackHook hook) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackHook](../Velopack/VelopackHook) | *hook* | - -### WithBeforeUninstallFastCallback(VelopackHook) -WARNING: FastCallback hooks are run during critical stages of Velopack operations. -Your code will be run and then `System.Environment.Exit(System.Int32)` will be called. -If your code has not completed within 30 seconds, it will be terminated. -Only supported on windows; On other operating systems, this will never be called. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L139) -```csharp title="Declaration" -public VelopackApp WithBeforeUninstallFastCallback(VelopackHook hook) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackHook](../Velopack/VelopackHook) | *hook* | - -### Run(ILogger?) -Runs the Velopack application startup code and triggers any configured hooks. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L151) -```csharp title="Declaration" -public void Run(ILogger? logger = null) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | A logging interface for diagnostic messages. This will be - cached and potentially re-used throughout the lifetime of the application. | - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAsset.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAsset.md deleted file mode 100644 index cd7e855..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAsset.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: Class VelopackAsset -sidebar_label: VelopackAsset -description: "An individual Velopack asset, could refer to an asset on-disk or in a remote package feed." ---- -# Class VelopackAsset -An individual Velopack asset, could refer to an asset on-disk or in a remote package feed. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L43) -```csharp title="Declaration" -public record VelopackAsset : IEquatable -``` -**Derived:** -[Velopack.Sources.GitBase<T>.GitBaseAsset](../Velopack.Sources/GitBase`T`.GitBaseAsset) - -**Implements:** -`System.IEquatable` - -## Properties -### PackageId -The name or Id of the package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L46) -```csharp title="Declaration" -public string PackageId { get; init; } -``` -### Version -The version of this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L49) -```csharp title="Declaration" -public SemanticVersion Version { get; init; } -``` -### Type -The type of asset (eg. full or delta). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L52) -```csharp title="Declaration" -public VelopackAssetType Type { get; init; } -``` -### FileName -The filename of the update package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L55) -```csharp title="Declaration" -public string FileName { get; init; } -``` -### SHA1 -The SHA1 checksum of the update package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L58) -```csharp title="Declaration" -public string SHA1 { get; init; } -``` -### Size -The size in bytes of the update package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L61) -```csharp title="Declaration" -public long Size { get; init; } -``` -### NotesMarkdown -The release notes in markdown format, as passed to Velopack when packaging the release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L64) -```csharp title="Declaration" -public string NotesMarkdown { get; init; } -``` -### NotesHTML -The release notes in HTML format, transformed from Markdown when packaging the release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L67) -```csharp title="Declaration" -public string NotesHTML { get; init; } -``` -## Methods -### FromZipPackage(ZipPackage) -Convert a [Velopack.NuGet.ZipPackage](../Velopack.NuGet/ZipPackage) to a [Velopack.VelopackAsset](../Velopack/VelopackAsset). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L72) -```csharp title="Declaration" -public static VelopackAsset FromZipPackage(ZipPackage zip) -``` - -##### Returns - -[Velopack.VelopackAsset](../Velopack/VelopackAsset) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.NuGet.ZipPackage](../Velopack.NuGet/ZipPackage) | *zip* | - -### FromNupkg(string) -Load a [Velopack.VelopackAsset](../Velopack/VelopackAsset) from a .nupkg file on disk. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L90) -```csharp title="Declaration" -public static VelopackAsset FromNupkg(string filePath) -``` - -##### Returns - -[Velopack.VelopackAsset](../Velopack/VelopackAsset) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *filePath* | - - -## Implements - -* `System.IEquatable` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetFeed.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetFeed.md deleted file mode 100644 index 50df326..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetFeed.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Class VelopackAssetFeed -sidebar_label: VelopackAssetFeed -description: "A feed of Velopack assets, usually returned from an [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource)." ---- -# Class VelopackAssetFeed -A feed of Velopack assets, usually returned from an [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource). - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L24) -```csharp title="Declaration" -public record VelopackAssetFeed : IEquatable -``` -**Implements:** -`System.IEquatable` - -## Properties -### Assets -A list of assets available in this feed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L29) -```csharp title="Declaration" -public VelopackAsset[] Assets { get; init; } -``` -## Methods -### FromJson(string) -Parse a json string into a [Velopack.VelopackAssetFeed](../Velopack/VelopackAssetFeed). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L34) -```csharp title="Declaration" -public static VelopackAssetFeed FromJson(string json) -``` - -##### Returns - -[Velopack.VelopackAssetFeed](../Velopack/VelopackAssetFeed) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *json* | - - -## Implements - -* `System.IEquatable` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetType.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetType.md deleted file mode 100644 index 95b81ac..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetType.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Enum VelopackAssetType -sidebar_label: VelopackAssetType -description: "Represents a Velopack Asset Type." ---- -# Enum VelopackAssetType -Represents a Velopack Asset Type. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L13) -```csharp title="Declaration" -public enum VelopackAssetType -``` -## Fields -### Full -A full update package. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L16) -```csharp title="Declaration" -Full = 1 -``` -### Delta -A delta update package. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L18) -```csharp title="Declaration" -Delta = 2 -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackHook.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackHook.md deleted file mode 100644 index 35668b9..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackHook.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Delegate VelopackHook -sidebar_label: VelopackHook -description: "A delegate type for handling Velopack startup events" ---- -# Delegate VelopackHook -A delegate type for handling Velopack startup events - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L16) -```csharp title="Declaration" -public delegate void VelopackHook(SemanticVersion version) -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackRuntimeInfo.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackRuntimeInfo.md deleted file mode 100644 index 6378364..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackRuntimeInfo.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: Class VelopackRuntimeInfo -sidebar_label: VelopackRuntimeInfo -description: "Convenience class which provides runtime information about the current executing process, -in a way that is safe in older and newer versions of the framework." ---- -# Class VelopackRuntimeInfo -Convenience class which provides runtime information about the current executing process, -in a way that is safe in older and newer versions of the framework. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L79) -```csharp title="Declaration" -public static class VelopackRuntimeInfo -``` -## Properties -### VelopackDisplayVersion -The current compiled Velopack display version. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L82) -```csharp title="Declaration" -public static string VelopackDisplayVersion { get; } -``` -### VelopackNugetVersion -The current compiled Velopack NuGetVersion. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L85) -```csharp title="Declaration" -public static NuGetVersion VelopackNugetVersion { get; } -``` -### VelopackProductVersion -The current compiled Velopack ProductVersion. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L88) -```csharp title="Declaration" -public static NuGetVersion VelopackProductVersion { get; } -``` -### EntryExePath -The path on disk of the entry assembly. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L91) -```csharp title="Declaration" -public static string EntryExePath { get; } -``` -### SystemArch -The current machine architecture, ignoring the current process / pe architecture. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L94) -```csharp title="Declaration" -public static RuntimeCpu SystemArch { get; } -``` -### SystemOs -The name of the current OS - eg. 'windows', 'linux', or 'osx'. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L97) -```csharp title="Declaration" -public static RuntimeOs SystemOs { get; } -``` -### SystemRid -The current system RID. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L100) -```csharp title="Declaration" -public static string SystemRid { get; } -``` -### IsWindows -True if executing on a Windows platform. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L103) -```csharp title="Declaration" -public static bool IsWindows { get; } -``` -### IsLinux -True if executing on a Linux platform. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L107) -```csharp title="Declaration" -public static bool IsLinux { get; } -``` -### IsOSX -True if executing on a MacOS / OSX platform. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L111) -```csharp title="Declaration" -public static bool IsOSX { get; } -``` -## Methods -### GetOsShortName(RuntimeOs) -Returns the shortened OS name as a string, suitable for creating an RID. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L185) -```csharp title="Declaration" -public static string GetOsShortName(this RuntimeOs os) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.RuntimeOs](../Velopack/RuntimeOs) | *os* | - -### GetOsLongName(RuntimeOs) -Returns the long OS name, suitable for showing to a human. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L198) -```csharp title="Declaration" -public static string GetOsLongName(this RuntimeOs os) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.RuntimeOs](../Velopack/RuntimeOs) | *os* | - diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/index.mdx b/i18n/de/docusaurus-plugin-content-docs/current/reference/index.mdx deleted file mode 100644 index 0f574b7..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ -import DocCardList from '@theme/DocCardList'; - -# Library Reference -The documentation in this library reference is auto-generated from inline comments in the library code. - -If there are inaccuracies here, please submit a PR to the code comments on the library repository itself -rather than to the docs repository. - - \ No newline at end of file diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/JsonNode.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/JsonNode.md deleted file mode 100644 index 821fbd4..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/JsonNode.md +++ /dev/null @@ -1,301 +0,0 @@ -# Class: JsonNode - -## Constructors - -### constructor - -• **new JsonNode**(): [`JsonNode`](JsonNode.md) - -#### Returns - -[`JsonNode`](JsonNode.md) - -## Properties - -### #private - -• `Private` **#private**: `any` - -#### Defined in - -[Velopack.d.ts:10](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L10) - -## Methods - -### addArrayChild - -▸ **addArrayChild**(`child`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `child` | [`JsonNode`](JsonNode.md) | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:49](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L49) - -___ - -### addObjectChild - -▸ **addObjectChild**(`key`, `child`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `child` | [`JsonNode`](JsonNode.md) | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:51](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L51) - -___ - -### asArray - -▸ **asArray**(): readonly [`JsonNode`](JsonNode.md)[] - -Reinterpret a JSON value as an array. Throws exception if the value type was not an array. - -#### Returns - -readonly [`JsonNode`](JsonNode.md)[] - -#### Defined in - -[Velopack.d.ts:33](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L33) - -___ - -### asBool - -▸ **asBool**(): `boolean` - -Reinterpret a JSON value as a boolean. Throws exception if the value type was not a boolean. - -#### Returns - -`boolean` - -#### Defined in - -[Velopack.d.ts:41](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L41) - -___ - -### asNumber - -▸ **asNumber**(): `number` - -Reinterpret a JSON value as a number. Throws exception if the value type was not a double. - -#### Returns - -`number` - -#### Defined in - -[Velopack.d.ts:37](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L37) - -___ - -### asObject - -▸ **asObject**(): `Readonly`\<`Record`\<`string`, [`JsonNode`](JsonNode.md)\>\> - -Reinterpret a JSON value as an object. Throws exception if the value type was not an object. - -#### Returns - -`Readonly`\<`Record`\<`string`, [`JsonNode`](JsonNode.md)\>\> - -#### Defined in - -[Velopack.d.ts:29](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L29) - -___ - -### asString - -▸ **asString**(): `string` - -Reinterpret a JSON value as a string. Throws exception if the value type was not a string. - -#### Returns - -`string` - -#### Defined in - -[Velopack.d.ts:45](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L45) - -___ - -### getKind - -▸ **getKind**(): [`JsonNodeType`](../enums/JsonNodeType.md) - -Get the type of this node, such as string, object, array, etc. -You should use this function and then call the corresponding -AsObject, AsArray, AsString, etc. functions to get the actual -parsed json information. - -#### Returns - -[`JsonNodeType`](../enums/JsonNodeType.md) - -#### Defined in - -[Velopack.d.ts:17](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L17) - -___ - -### initArray - -▸ **initArray**(): `void` - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:48](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L48) - -___ - -### initBool - -▸ **initBool**(`value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:47](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L47) - -___ - -### initNumber - -▸ **initNumber**(`value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:52](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L52) - -___ - -### initObject - -▸ **initObject**(): `void` - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:50](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L50) - -___ - -### initString - -▸ **initString**(`value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:53](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L53) - -___ - -### isEmpty - -▸ **isEmpty**(): `boolean` - -Check if the JSON value is empty - eg. an empty string, array, or object. - -#### Returns - -`boolean` - -#### Defined in - -[Velopack.d.ts:25](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L25) - -___ - -### isNull - -▸ **isNull**(): `boolean` - -Check if the JSON value is null. - -#### Returns - -`boolean` - -#### Defined in - -[Velopack.d.ts:21](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L21) - -___ - -### parse - -▸ **parse**(`text`): [`JsonNode`](JsonNode.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `text` | `string` | - -#### Returns - -[`JsonNode`](JsonNode.md) - -#### Defined in - -[Velopack.d.ts:46](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L46) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateInfo.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateInfo.md deleted file mode 100644 index b0c5cab..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateInfo.md +++ /dev/null @@ -1,61 +0,0 @@ -# Class: UpdateInfo - -Holds information about the current version and pending updates, such as how many there are, and access to release notes. - -## Constructors - -### constructor - -• **new UpdateInfo**(): [`UpdateInfo`](UpdateInfo.md) - -#### Returns - -[`UpdateInfo`](UpdateInfo.md) - -## Properties - -### isDowngrade - -• **isDowngrade**: `boolean` - -True if the update is a version downgrade or lateral move (such as when switching channels to the same version number). -In this case, only full updates are allowed, and any local packages on disk newer than the downloaded version will be -deleted. - -#### Defined in - -[Velopack.d.ts:118](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L118) - -___ - -### targetFullRelease - -• **targetFullRelease**: [`VelopackAsset`](VelopackAsset.md) - -The available version that we are updating to. - -#### Defined in - -[Velopack.d.ts:112](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L112) - -## Methods - -### fromJson - -▸ **fromJson**(`json`): [`UpdateInfo`](UpdateInfo.md) - -Parses a JSON string into an UpdateInfo object. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `json` | `string` | - -#### Returns - -[`UpdateInfo`](UpdateInfo.md) - -#### Defined in - -[Velopack.d.ts:122](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L122) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManager.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManager.md deleted file mode 100644 index 4b131d3..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManager.md +++ /dev/null @@ -1,482 +0,0 @@ -# Class: UpdateManager - -This class is used to check for updates, download updates, and apply updates. -It provides the asynchronous functions of the UpdateManager class. - -## Hierarchy - -- [`UpdateManagerSync`](UpdateManagerSync.md) - - ↳ **`UpdateManager`** - -## Constructors - -### constructor - -• **new UpdateManager**(): [`UpdateManager`](UpdateManager.md) - -#### Returns - -[`UpdateManager`](UpdateManager.md) - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[constructor](UpdateManagerSync.md#constructor) - -## Properties - -### #private - -• `Private` **#private**: `any` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[#private](UpdateManagerSync.md##private) - -#### Defined in - -[Velopack.d.ts:130](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L130) - -## Methods - -### applyUpdatesAndExit - -▸ **applyUpdatesAndExit**(`toApply`): `void` - -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified -restart arguments. If you need to save state or clean up, you should do that before calling this method. -The user may be prompted during the update, if the update requires additional frameworks to be installed etc. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[applyUpdatesAndExit](UpdateManagerSync.md#applyupdatesandexit) - -#### Defined in - -[Velopack.d.ts:199](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L199) - -___ - -### applyUpdatesAndRestart - -▸ **applyUpdatesAndRestart**(`toApply`, `restartArgs?`): `void` - -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified -restart arguments. If you need to save state or clean up, you should do that before calling this method. -The user may be prompted during the update, if the update requires additional frameworks to be installed etc. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | -| `restartArgs?` | readonly `string`[] | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[applyUpdatesAndRestart](UpdateManagerSync.md#applyupdatesandrestart) - -#### Defined in - -[Velopack.d.ts:205](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L205) - -___ - -### checkForUpdates - -▸ **checkForUpdates**(): [`UpdateInfo`](UpdateInfo.md) - -This function will check for updates, and return information about the latest -available release. This function runs synchronously and may take some time to -complete, depending on the network speed and the number of updates available. - -#### Returns - -[`UpdateInfo`](UpdateInfo.md) - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[checkForUpdates](UpdateManagerSync.md#checkforupdates) - -#### Defined in - -[Velopack.d.ts:186](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L186) - -___ - -### checkForUpdatesAsync - -▸ **checkForUpdatesAsync**(): `Promise`\<[`UpdateInfo`](UpdateInfo.md)\> - -This function will check for updates, and return information about the latest -available release. This function runs synchronously and may take some time to -complete, depending on the network speed and the number of updates available. - -#### Returns - -`Promise`\<[`UpdateInfo`](UpdateInfo.md)\> - -#### Defined in - -[Velopack.d.ts:243](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L243) - -___ - -### downloadUpdates - -▸ **downloadUpdates**(`toDownload`): `void` - -Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, -this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta -packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock -so may fail if there is already another update operation in progress. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toDownload` | [`VelopackAsset`](VelopackAsset.md) | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[downloadUpdates](UpdateManagerSync.md#downloadupdates) - -#### Defined in - -[Velopack.d.ts:193](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L193) - -___ - -### downloadUpdatesAsync - -▸ **downloadUpdatesAsync**(`toDownload`, `progress`): `Promise`\<`void`\> - -Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, -this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta -packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock -so may fail if there is already another update operation in progress. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toDownload` | [`VelopackAsset`](VelopackAsset.md) | -| `progress` | (`arg`: `number`) => `void` | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[Velopack.d.ts:250](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L250) - -___ - -### getCheckForUpdatesCommand - -▸ **getCheckForUpdatesCommand**(): `string`[] - -Returns the command line arguments to check for updates. - -#### Returns - -`string`[] - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[getCheckForUpdatesCommand](UpdateManagerSync.md#getcheckforupdatescommand) - -#### Defined in - -[Velopack.d.ts:158](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L158) - -___ - -### getCurrentVersion - -▸ **getCurrentVersion**(): `string` - -Get the currently installed version of the application. -If the application is not installed, this function will throw an exception. - -#### Returns - -`string` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[getCurrentVersion](UpdateManagerSync.md#getcurrentversion) - -#### Defined in - -[Velopack.d.ts:180](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L180) - -___ - -### getCurrentVersionAsync - -▸ **getCurrentVersionAsync**(): `Promise`\<`string`\> - -Checks for updates, returning null if there are none available. If there are updates available, this method will return an -UpdateInfo object containing the latest available release, and any delta updates that can be applied if they are available. - -#### Returns - -`Promise`\<`string`\> - -#### Defined in - -[Velopack.d.ts:237](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L237) - -___ - -### getCurrentVersionCommand - -▸ **getCurrentVersionCommand**(): `string`[] - -Returns the command line arguments to get the current version of the application. - -#### Returns - -`string`[] - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[getCurrentVersionCommand](UpdateManagerSync.md#getcurrentversioncommand) - -#### Defined in - -[Velopack.d.ts:154](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L154) - -___ - -### getDownloadUpdatesCommand - -▸ **getDownloadUpdatesCommand**(`toDownload`): `string`[] - -Returns the command line arguments to download the specified update. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toDownload` | [`VelopackAsset`](VelopackAsset.md) | - -#### Returns - -`string`[] - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[getDownloadUpdatesCommand](UpdateManagerSync.md#getdownloadupdatescommand) - -#### Defined in - -[Velopack.d.ts:162](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L162) - -___ - -### getPackagesDir - -▸ **getPackagesDir**(): `string` - -Returns the path to the app's packages directory. This is where updates are downloaded to. - -#### Returns - -`string` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[getPackagesDir](UpdateManagerSync.md#getpackagesdir) - -#### Defined in - -[Velopack.d.ts:170](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L170) - -___ - -### getUpdateApplyCommand - -▸ **getUpdateApplyCommand**(`toApply`, `silent`, `restart`, `wait`, `restartArgs?`): `string`[] - -Returns the command line arguments to apply the specified update. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | -| `silent` | `boolean` | -| `restart` | `boolean` | -| `wait` | `boolean` | -| `restartArgs?` | readonly `string`[] | - -#### Returns - -`string`[] - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[getUpdateApplyCommand](UpdateManagerSync.md#getupdateapplycommand) - -#### Defined in - -[Velopack.d.ts:166](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L166) - -___ - -### isInstalled - -▸ **isInstalled**(): `boolean` - -Returns true if the current app is installed, false otherwise. If the app is not installed, other functions in -UpdateManager may throw exceptions, so you may want to check this before calling other functions. - -#### Returns - -`boolean` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[isInstalled](UpdateManagerSync.md#isinstalled) - -#### Defined in - -[Velopack.d.ts:175](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L175) - -___ - -### setAllowDowngrade - -▸ **setAllowDowngrade**(`allowDowngrade`): `void` - -Allows UpdateManager to update to a version that's lower than the current version (i.e. downgrading). -This could happen if a release has bugs and was retracted from the release feed, or if you're using -ExplicitChannel to switch channels to another channel where the latest version on that -channel is lower than the current version. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `allowDowngrade` | `boolean` | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[setAllowDowngrade](UpdateManagerSync.md#setallowdowngrade) - -#### Defined in - -[Velopack.d.ts:141](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L141) - -___ - -### setExplicitChannel - -▸ **setExplicitChannel**(`explicitChannel`): `void` - -This option should usually be left null. Overrides the default channel used to fetch updates. -The default channel will be whatever channel was specified on the command line when building this release. -For example, if the current release was packaged with '--channel beta', then the default channel will be 'beta'. -This allows users to automatically receive updates from the same channel they installed from. This options -allows you to explicitly switch channels, for example if the user wished to switch back to the 'stable' channel -without having to reinstall the application. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `explicitChannel` | `string` | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[setExplicitChannel](UpdateManagerSync.md#setexplicitchannel) - -#### Defined in - -[Velopack.d.ts:150](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L150) - -___ - -### setUrlOrPath - -▸ **setUrlOrPath**(`urlOrPath`): `void` - -Set the URL or local file path to the update server. This is required before calling CheckForUpdates or DownloadUpdates. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `urlOrPath` | `string` | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[setUrlOrPath](UpdateManagerSync.md#seturlorpath) - -#### Defined in - -[Velopack.d.ts:134](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L134) - -___ - -### waitExitThenApplyUpdates - -▸ **waitExitThenApplyUpdates**(`toApply`, `silent`, `restart`, `restartArgs?`): `void` - -This will launch the Velopack updater and tell it to wait for this program to exit gracefully. -You should then clean up any state and exit your app. The updater will apply updates and then -optionally restart your app. The updater will only wait for 60 seconds before giving up. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | -| `silent` | `boolean` | -| `restart` | `boolean` | -| `restartArgs?` | readonly `string`[] | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[waitExitThenApplyUpdates](UpdateManagerSync.md#waitexitthenapplyupdates) - -#### Defined in - -[Velopack.d.ts:211](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L211) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManagerSync.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManagerSync.md deleted file mode 100644 index 7ceadd5..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManagerSync.md +++ /dev/null @@ -1,354 +0,0 @@ -# Class: UpdateManagerSync - -This class is used to check for updates, download updates, and apply updates. It is a synchronous version of the UpdateManager class. -This class is not recommended for use in GUI applications, as it will block the main thread, so you may want to use the async -UpdateManager class instead, if it is supported for your programming language. - -## Hierarchy - -- **`UpdateManagerSync`** - - ↳ [`UpdateManager`](UpdateManager.md) - -## Constructors - -### constructor - -• **new UpdateManagerSync**(): [`UpdateManagerSync`](UpdateManagerSync.md) - -#### Returns - -[`UpdateManagerSync`](UpdateManagerSync.md) - -## Properties - -### #private - -• `Private` **#private**: `any` - -#### Defined in - -[Velopack.d.ts:130](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L130) - -## Methods - -### applyUpdatesAndExit - -▸ **applyUpdatesAndExit**(`toApply`): `void` - -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified -restart arguments. If you need to save state or clean up, you should do that before calling this method. -The user may be prompted during the update, if the update requires additional frameworks to be installed etc. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:199](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L199) - -___ - -### applyUpdatesAndRestart - -▸ **applyUpdatesAndRestart**(`toApply`, `restartArgs?`): `void` - -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified -restart arguments. If you need to save state or clean up, you should do that before calling this method. -The user may be prompted during the update, if the update requires additional frameworks to be installed etc. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | -| `restartArgs?` | readonly `string`[] | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:205](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L205) - -___ - -### checkForUpdates - -▸ **checkForUpdates**(): [`UpdateInfo`](UpdateInfo.md) - -This function will check for updates, and return information about the latest -available release. This function runs synchronously and may take some time to -complete, depending on the network speed and the number of updates available. - -#### Returns - -[`UpdateInfo`](UpdateInfo.md) - -#### Defined in - -[Velopack.d.ts:186](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L186) - -___ - -### downloadUpdates - -▸ **downloadUpdates**(`toDownload`): `void` - -Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, -this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta -packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock -so may fail if there is already another update operation in progress. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toDownload` | [`VelopackAsset`](VelopackAsset.md) | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:193](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L193) - -___ - -### getCheckForUpdatesCommand - -▸ **getCheckForUpdatesCommand**(): `string`[] - -Returns the command line arguments to check for updates. - -#### Returns - -`string`[] - -#### Defined in - -[Velopack.d.ts:158](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L158) - -___ - -### getCurrentVersion - -▸ **getCurrentVersion**(): `string` - -Get the currently installed version of the application. -If the application is not installed, this function will throw an exception. - -#### Returns - -`string` - -#### Defined in - -[Velopack.d.ts:180](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L180) - -___ - -### getCurrentVersionCommand - -▸ **getCurrentVersionCommand**(): `string`[] - -Returns the command line arguments to get the current version of the application. - -#### Returns - -`string`[] - -#### Defined in - -[Velopack.d.ts:154](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L154) - -___ - -### getDownloadUpdatesCommand - -▸ **getDownloadUpdatesCommand**(`toDownload`): `string`[] - -Returns the command line arguments to download the specified update. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toDownload` | [`VelopackAsset`](VelopackAsset.md) | - -#### Returns - -`string`[] - -#### Defined in - -[Velopack.d.ts:162](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L162) - -___ - -### getPackagesDir - -▸ **getPackagesDir**(): `string` - -Returns the path to the app's packages directory. This is where updates are downloaded to. - -#### Returns - -`string` - -#### Defined in - -[Velopack.d.ts:170](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L170) - -___ - -### getUpdateApplyCommand - -▸ **getUpdateApplyCommand**(`toApply`, `silent`, `restart`, `wait`, `restartArgs?`): `string`[] - -Returns the command line arguments to apply the specified update. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | -| `silent` | `boolean` | -| `restart` | `boolean` | -| `wait` | `boolean` | -| `restartArgs?` | readonly `string`[] | - -#### Returns - -`string`[] - -#### Defined in - -[Velopack.d.ts:166](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L166) - -___ - -### isInstalled - -▸ **isInstalled**(): `boolean` - -Returns true if the current app is installed, false otherwise. If the app is not installed, other functions in -UpdateManager may throw exceptions, so you may want to check this before calling other functions. - -#### Returns - -`boolean` - -#### Defined in - -[Velopack.d.ts:175](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L175) - -___ - -### setAllowDowngrade - -▸ **setAllowDowngrade**(`allowDowngrade`): `void` - -Allows UpdateManager to update to a version that's lower than the current version (i.e. downgrading). -This could happen if a release has bugs and was retracted from the release feed, or if you're using -ExplicitChannel to switch channels to another channel where the latest version on that -channel is lower than the current version. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `allowDowngrade` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:141](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L141) - -___ - -### setExplicitChannel - -▸ **setExplicitChannel**(`explicitChannel`): `void` - -This option should usually be left null. Overrides the default channel used to fetch updates. -The default channel will be whatever channel was specified on the command line when building this release. -For example, if the current release was packaged with '--channel beta', then the default channel will be 'beta'. -This allows users to automatically receive updates from the same channel they installed from. This options -allows you to explicitly switch channels, for example if the user wished to switch back to the 'stable' channel -without having to reinstall the application. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `explicitChannel` | `string` | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:150](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L150) - -___ - -### setUrlOrPath - -▸ **setUrlOrPath**(`urlOrPath`): `void` - -Set the URL or local file path to the update server. This is required before calling CheckForUpdates or DownloadUpdates. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `urlOrPath` | `string` | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:134](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L134) - -___ - -### waitExitThenApplyUpdates - -▸ **waitExitThenApplyUpdates**(`toApply`, `silent`, `restart`, `restartArgs?`): `void` - -This will launch the Velopack updater and tell it to wait for this program to exit gracefully. -You should then clean up any state and exit your app. The updater will apply updates and then -optionally restart your app. The updater will only wait for 60 seconds before giving up. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | -| `silent` | `boolean` | -| `restart` | `boolean` | -| `restartArgs?` | readonly `string`[] | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:211](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L211) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackApp.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackApp.md deleted file mode 100644 index 8543d24..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackApp.md +++ /dev/null @@ -1,46 +0,0 @@ -# Class: VelopackApp - -The main VelopackApp struct. This is the main entry point for your app. - -## Constructors - -### constructor - -• **new VelopackApp**(): [`VelopackApp`](VelopackApp.md) - -#### Returns - -[`VelopackApp`](VelopackApp.md) - -## Methods - -### run - -▸ **run**(): `void` - -Runs the Velopack startup logic. This should be the first thing to run in your app. -In some circumstances it may terminate/restart the process to perform tasks. - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:225](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L225) - -___ - -### build - -▸ **build**(): [`VelopackApp`](VelopackApp.md) - -Create a new VelopackApp instance. - -#### Returns - -[`VelopackApp`](VelopackApp.md) - -#### Defined in - -[Velopack.d.ts:220](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L220) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackAsset.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackAsset.md deleted file mode 100644 index 5a46db5..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackAsset.md +++ /dev/null @@ -1,153 +0,0 @@ -# Class: VelopackAsset - -An individual Velopack asset, could refer to an asset on-disk or in a remote package feed. - -## Constructors - -### constructor - -• **new VelopackAsset**(): [`VelopackAsset`](VelopackAsset.md) - -#### Returns - -[`VelopackAsset`](VelopackAsset.md) - -## Properties - -### fileName - -• **fileName**: `string` - -The filename of the update package containing this release. - -#### Defined in - -[Velopack.d.ts:79](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L79) - -___ - -### notesHTML - -• **notesHTML**: `string` - -The release notes in HTML format, transformed from Markdown when packaging the release. - -#### Defined in - -[Velopack.d.ts:95](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L95) - -___ - -### notesMarkdown - -• **notesMarkdown**: `string` - -The release notes in markdown format, as passed to Velopack when packaging the release. - -#### Defined in - -[Velopack.d.ts:91](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L91) - -___ - -### packageId - -• **packageId**: `string` - -The name or Id of the package containing this release. - -#### Defined in - -[Velopack.d.ts:67](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L67) - -___ - -### sha1 - -• **sha1**: `string` - -The SHA1 checksum of the update package containing this release. - -#### Defined in - -[Velopack.d.ts:83](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L83) - -___ - -### size - -• **size**: `bigint` - -The size in bytes of the update package containing this release. - -#### Defined in - -[Velopack.d.ts:87](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L87) - -___ - -### type - -• **type**: [`VelopackAssetType`](../enums/VelopackAssetType.md) - -The type of asset (eg. full or delta). - -#### Defined in - -[Velopack.d.ts:75](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L75) - -___ - -### version - -• **version**: `string` - -The version of this release. - -#### Defined in - -[Velopack.d.ts:71](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L71) - -## Methods - -### fromJson - -▸ **fromJson**(`json`): [`VelopackAsset`](VelopackAsset.md) - -Parses a JSON string into a VelopackAsset object. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `json` | `string` | - -#### Returns - -[`VelopackAsset`](VelopackAsset.md) - -#### Defined in - -[Velopack.d.ts:99](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L99) - -___ - -### fromNode - -▸ **fromNode**(`node`): [`VelopackAsset`](VelopackAsset.md) - -Parses a JSON node into a VelopackAsset object. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `node` | [`JsonNode`](JsonNode.md) | - -#### Returns - -[`VelopackAsset`](VelopackAsset.md) - -#### Defined in - -[Velopack.d.ts:103](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L103) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/js/enums/JsonNodeType.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/js/enums/JsonNodeType.md deleted file mode 100644 index 470409c..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/js/enums/JsonNodeType.md +++ /dev/null @@ -1,61 +0,0 @@ -# Enumeration: JsonNodeType - -## Enumeration Members - -### ARRAY - -• **ARRAY** = ``2`` - -#### Defined in - -[Velopack.d.ts:4](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L4) - -___ - -### BOOL - -• **BOOL** = ``1`` - -#### Defined in - -[Velopack.d.ts:3](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L3) - -___ - -### NULL - -• **NULL** = ``0`` - -#### Defined in - -[Velopack.d.ts:2](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L2) - -___ - -### NUMBER - -• **NUMBER** = ``4`` - -#### Defined in - -[Velopack.d.ts:6](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L6) - -___ - -### OBJECT - -• **OBJECT** = ``3`` - -#### Defined in - -[Velopack.d.ts:5](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L5) - -___ - -### STRING - -• **STRING** = ``5`` - -#### Defined in - -[Velopack.d.ts:7](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L7) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/reference/js/enums/VelopackAssetType.md b/i18n/de/docusaurus-plugin-content-docs/current/reference/js/enums/VelopackAssetType.md deleted file mode 100644 index 73a29ca..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/reference/js/enums/VelopackAssetType.md +++ /dev/null @@ -1,31 +0,0 @@ -# Enumeration: VelopackAssetType - -## Enumeration Members - -### DELTA - -• **DELTA** = ``2`` - -#### Defined in - -[Velopack.d.ts:58](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L58) - -___ - -### FULL - -• **FULL** = ``1`` - -#### Defined in - -[Velopack.d.ts:57](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L57) - -___ - -### UNKNOWN - -• **UNKNOWN** = ``0`` - -#### Defined in - -[Velopack.d.ts:56](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L56) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/troubleshooting/cli.mdx b/i18n/de/docusaurus-plugin-content-docs/current/troubleshooting/cli.mdx deleted file mode 100644 index 80c5d05..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/troubleshooting/cli.mdx +++ /dev/null @@ -1,89 +0,0 @@ -# CLI Reference - - -Overview of Velopack binary command line options. - -## vpk - -```txt -Description: - Velopack CLI 0.0.61-g2e7ffeb (prerelease) for creating and distributing releases. - -Usage: - vpk [command] [options] - -Options: - -?, -h, --help Show help and usage information - --version Show version information - --verbose Print diagnostic messages. - -Commands: - pack Creates a release from a folder containing application files. - download Download's the latest release from a remote update source. - upload Upload local package(s) to a remote update source. - delta Utilities for creating or applying delta packages. -``` - -## Update.exe & UpdateMac - -```txt -Velopack Updater (0.0.66) manages packages and installs updates. -https://github.com/velopack/velopack - -Usage: update [OPTIONS] - update apply [OPTIONS] [-- [EXE_ARGS]...] - update patch [OPTIONS] --old --patch --output - update start [OPTIONS] [EXE_NAME] [-- [EXE_ARGS]...] - update uninstall [OPTIONS] - -Options: - --verbose Print debug messages to console / log - -s, --silent Don't show any prompts / dialogs - -l, --log Override the default log file location - -h, --help Print help - -V, --version Print version - -update apply: -Applies a staged / prepared update, installing prerequisite runtimes if necessary - -r, --restart Restart the application after the update - -w, --wait Wait for the parent process to terminate before applying the update - -p, --package Update package to apply - --noelevate If the application does not have sufficient privileges, do not elevate to admin - -h, --help Print help - [EXE_ARGS]... Arguments to pass to the started executable. Must be preceeded by '--'. - -update patch: -Applies a Zstd patch file - --old Base / old file to apply the patch to - --patch The Zstd patch to apply to the old file - --output The file to create with the patch applied - -h, --help Print help - -update start: -Starts the currently installed version of the application - -w, --wait Wait for the parent process to terminate before starting the application - -h, --help Print help - [EXE_ARGS]... Arguments to pass to the started executable. Must be preceeded by '--'. - [EXE_NAME] The optional name of the binary to execute - -update uninstall: -Remove all app shortcuts, files, and registry entries. - -h, --help Print help -``` - -## Setup.exe - -```txt -Velopack Setup (0.0.66) installs applications. -https://github.com/velopack/velopack - -Usage: setup [OPTIONS] - -Options: - -s, --silent Hides all dialogs and answers 'yes' to all prompts - -v, --verbose Print debug messages to console - -l, --log Enable file logging and set location - -t, --installto Installation directory to install the application - -d, --debug Debug mode, install from a nupkg file - -h, --help Print help -``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/troubleshooting/debugging.mdx b/i18n/de/docusaurus-plugin-content-docs/current/troubleshooting/debugging.mdx deleted file mode 100644 index a690be8..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/troubleshooting/debugging.mdx +++ /dev/null @@ -1,48 +0,0 @@ -# Debugging & Logging - - -Find or configure application logs to find runtime issues. - -## Logging - -All parts of Velopack have logging built in to help troubleshoot issues, and you should provide these logs when opening a GitHub issue about a potential bug. - -### UpdateManager / In your application - -You should provide an instance of `Microsoft.Extensions.Logging.ILogger` to `VelopackApp.Run(ILogger)` and to `UpdateManager` to record potential issues. If you are not using Microsoft Hosting or Logging already, it is very simple to implement this interface yourself and log to a file, or integrate with another logging framework. - -For example: - -```cs -using Microsoft.Extensions.Logging; - -// ... - -class ConsoleLogger : ILogger -{ - public IDisposable BeginScope(TState state) where TState : notnull => null; - public bool IsEnabled(LogLevel logLevel) => true; - public void Log(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func formatter) - => Console.WriteLine(formatter(state, exception)); -} - -// ... - -new UpdateManager("https://path.to/your-updates", logger: new ConsoleLogger()); -``` - -### Windows - -Running Update.exe will log most output to it's base directory as `Velopack.log`. Setup.exe will not log to file by default. However, you can override the log location for both binaries with the `--log {path}` parameter. You can also use the `--verbose` flag to capture debug/trace output to log. Unfortunately, on Windows, to avoid showing up as a console window, these binaries are compiled as a WinExe and there will be no console output by default. Please see the [command line reference](cli.mdx) for a comprehensive list of arguments supported. - -### MacOS / Linux - -All logs will be sent to `/tmp/velopack.log`. - -## Advanced Debugging - -The debug builds of Velopack binaries have additional logging/debugging capabilities, and will produce console output. In some instances, it may be useful to [compile Velopack](../contributing/compiling.mdx) for your platform, and replace the release binaries of Setup.exe and Update.exe with debug versions. - -If your issue is with package building, after building the rust binaries in Debug mode, it can also be useful to run the Velopack.Vpk project from Visual Studio with your intended command line arguments rather than running the `vpk` tool directly. - -If doing this has not helped, you may need to debug and step through the rust binaries - for which I recommend the CodeLLDB VSCode extension. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/troubleshooting/faq.mdx b/i18n/de/docusaurus-plugin-content-docs/current/troubleshooting/faq.mdx deleted file mode 100644 index 76537a6..0000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/troubleshooting/faq.mdx +++ /dev/null @@ -1,16 +0,0 @@ -# FAQ - - -Commonly asked questions about Velopack. - -- **My application was detected as a virus?**
- Velopack can't help with this, but you can [code-sign](packaging/signing.mdx) your app and check [other suggestions here](https://github.com/clowd/Clowd.Squirrel/issues/28#issuecomment-1016241760). -- **What happened to SquirrelAwareApp? / Shortcuts**
- This concept no longer exists in Velopack. You can create hooks on install/update in a similar way using the `VelopackApp` builder. Although note that reating shortcuts or registry entries yourself during hooks is no longer required. -- **Can Velopack bootstrap new runtimes during updates?**
- Yes, this is fully supported. Before installing updates, Velopack will prompt the user to install any missing updates. -- **How do I install the `vpk` tool? / I've installed the tool but it doesn't work** - For now, you need to install `dotnet` runtime 6.0 or 8.0 for your platform, and then run `dotnet tool update -g vpk`. - If you get a message that it was installed successfully, but running it in your terminal results in a "binary/command not found" message, it's probably because your PATH is not set-up properly. For windows, `%USERPROFILE%\.dotnet\tools` should be on the PATH. For macos, [see this issue](https://github.com/dotnet/sdk/issues/9415). In general, dotnet should set these paths up for you, but that is what you should check if things are not working. -- **Can I use a 4 part version (1.0.0.0) instead of SemVer2?** - Velopack only supports a 3 part version with tags and metadata (1.0.0-build.23+metadata) following the SemVer2 standard. Some people choose to version with the date, 2024.01.12 for example. It's also possible to get automated git commit based versioning [using something like nbgv](https://github.com/dotnet/Nerdbank.GitVersioning). The reason Velopack supports SemVer2 and not traditional 4 part versions is that it's possible to provide a lot more information in SemVer2 versions, and it is not feasible for us to support both formats throughout the framework. diff --git a/i18n/de/docusaurus-theme-classic/navbar.json b/i18n/de/docusaurus-theme-classic/navbar.json deleted file mode 100644 index bedfd41..0000000 --- a/i18n/de/docusaurus-theme-classic/navbar.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "logo.alt": { - "message": "Velopack Logo", - "description": "The alt text of navbar logo" - }, - "item.label.Guides": { - "message": "Guides", - "description": "Navbar item with label Guides" - }, - "item.label.Reference": { - "message": "Reference", - "description": "Navbar item with label Reference" - }, - "item.label.Blog": { - "message": "Blog", - "description": "Navbar item with label Blog" - } -} diff --git a/i18n/en/code.json b/i18n/en/code.json deleted file mode 100644 index be43c1e..0000000 --- a/i18n/en/code.json +++ /dev/null @@ -1,324 +0,0 @@ -{ - "theme.ErrorPageContent.title": { - "message": "This page crashed.", - "description": "The title of the fallback page when the page crashed" - }, - "theme.BackToTopButton.buttonAriaLabel": { - "message": "Scroll back to top", - "description": "The ARIA label for the back to top button" - }, - "theme.blog.archive.title": { - "message": "Archive", - "description": "The page & hero title of the blog archive page" - }, - "theme.blog.archive.description": { - "message": "Archive", - "description": "The page & hero description of the blog archive page" - }, - "theme.blog.paginator.navAriaLabel": { - "message": "Blog list page navigation", - "description": "The ARIA label for the blog pagination" - }, - "theme.blog.paginator.newerEntries": { - "message": "Newer Entries", - "description": "The label used to navigate to the newer blog posts page (previous page)" - }, - "theme.blog.paginator.olderEntries": { - "message": "Older Entries", - "description": "The label used to navigate to the older blog posts page (next page)" - }, - "theme.blog.post.paginator.navAriaLabel": { - "message": "Blog post page navigation", - "description": "The ARIA label for the blog posts pagination" - }, - "theme.blog.post.paginator.newerPost": { - "message": "Newer Post", - "description": "The blog post button label to navigate to the newer/previous post" - }, - "theme.blog.post.paginator.olderPost": { - "message": "Older Post", - "description": "The blog post button label to navigate to the older/next post" - }, - "theme.blog.post.plurals": { - "message": "One post|{count} posts", - "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.blog.tagTitle": { - "message": "{nPosts} tagged with \"{tagName}\"", - "description": "The title of the page for a blog tag" - }, - "theme.tags.tagsPageLink": { - "message": "View All Tags", - "description": "The label of the link targeting the tag list page" - }, - "theme.colorToggle.ariaLabel": { - "message": "Switch between dark and light mode (currently {mode})", - "description": "The ARIA label for the navbar color mode toggle" - }, - "theme.colorToggle.ariaLabel.mode.dark": { - "message": "dark mode", - "description": "The name for the dark color mode" - }, - "theme.colorToggle.ariaLabel.mode.light": { - "message": "light mode", - "description": "The name for the light color mode" - }, - "theme.docs.breadcrumbs.navAriaLabel": { - "message": "Breadcrumbs", - "description": "The ARIA label for the breadcrumbs" - }, - "theme.docs.DocCard.categoryDescription": { - "message": "{count} items", - "description": "The default description for a category card in the generated index about how many items this category includes" - }, - "theme.docs.paginator.navAriaLabel": { - "message": "Docs pages", - "description": "The ARIA label for the docs pagination" - }, - "theme.docs.paginator.previous": { - "message": "Previous", - "description": "The label used to navigate to the previous doc" - }, - "theme.docs.paginator.next": { - "message": "Next", - "description": "The label used to navigate to the next doc" - }, - "theme.docs.tagDocListPageTitle.nDocsTagged": { - "message": "One doc tagged|{count} docs tagged", - "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.tagDocListPageTitle": { - "message": "{nDocsTagged} with \"{tagName}\"", - "description": "The title of the page for a docs tag" - }, - "theme.docs.versionBadge.label": { - "message": "Version: {versionLabel}" - }, - "theme.docs.versions.unreleasedVersionLabel": { - "message": "This is unreleased documentation for {siteTitle} {versionLabel} version.", - "description": "The label used to tell the user that he's browsing an unreleased doc version" - }, - "theme.docs.versions.unmaintainedVersionLabel": { - "message": "This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.", - "description": "The label used to tell the user that he's browsing an unmaintained doc version" - }, - "theme.docs.versions.latestVersionSuggestionLabel": { - "message": "For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).", - "description": "The label used to tell the user to check the latest version" - }, - "theme.docs.versions.latestVersionLinkLabel": { - "message": "latest version", - "description": "The label used for the latest version suggestion link label" - }, - "theme.common.editThisPage": { - "message": "Edit this page", - "description": "The link label to edit the current page" - }, - "theme.common.headingLinkTitle": { - "message": "Direct link to {heading}", - "description": "Title for link to heading" - }, - "theme.lastUpdated.atDate": { - "message": " on {date}", - "description": "The words used to describe on which date a page has been last updated" - }, - "theme.lastUpdated.byUser": { - "message": " by {user}", - "description": "The words used to describe by who the page has been last updated" - }, - "theme.lastUpdated.lastUpdatedAtBy": { - "message": "Last updated{atDate}{byUser}", - "description": "The sentence used to display when a page has been last updated, and by who" - }, - "theme.NotFound.title": { - "message": "Page Not Found", - "description": "The title of the 404 page" - }, - "theme.navbar.mobileVersionsDropdown.label": { - "message": "Versions", - "description": "The label for the navbar versions dropdown on mobile view" - }, - "theme.tags.tagsListLabel": { - "message": "Tags:", - "description": "The label alongside a tag list" - }, - "theme.admonition.caution": { - "message": "caution", - "description": "The default label used for the Caution admonition (:::caution)" - }, - "theme.admonition.danger": { - "message": "danger", - "description": "The default label used for the Danger admonition (:::danger)" - }, - "theme.admonition.info": { - "message": "info", - "description": "The default label used for the Info admonition (:::info)" - }, - "theme.admonition.note": { - "message": "note", - "description": "The default label used for the Note admonition (:::note)" - }, - "theme.admonition.tip": { - "message": "tip", - "description": "The default label used for the Tip admonition (:::tip)" - }, - "theme.admonition.warning": { - "message": "warning", - "description": "The default label used for the Warning admonition (:::warning)" - }, - "theme.AnnouncementBar.closeButtonAriaLabel": { - "message": "Close", - "description": "The ARIA label for close button of announcement bar" - }, - "theme.blog.sidebar.navAriaLabel": { - "message": "Blog recent posts navigation", - "description": "The ARIA label for recent posts in the blog sidebar" - }, - "theme.CodeBlock.copied": { - "message": "Copied", - "description": "The copied button label on code blocks" - }, - "theme.CodeBlock.copyButtonAriaLabel": { - "message": "Copy code to clipboard", - "description": "The ARIA label for copy code blocks button" - }, - "theme.CodeBlock.copy": { - "message": "Copy", - "description": "The copy button label on code blocks" - }, - "theme.CodeBlock.wordWrapToggle": { - "message": "Toggle word wrap", - "description": "The title attribute for toggle word wrapping button of code block lines" - }, - "theme.DocSidebarItem.expandCategoryAriaLabel": { - "message": "Expand sidebar category '{label}'", - "description": "The ARIA label to expand the sidebar category" - }, - "theme.DocSidebarItem.collapseCategoryAriaLabel": { - "message": "Collapse sidebar category '{label}'", - "description": "The ARIA label to collapse the sidebar category" - }, - "theme.NavBar.navAriaLabel": { - "message": "Main", - "description": "The ARIA label for the main navigation" - }, - "theme.NotFound.p1": { - "message": "We could not find what you were looking for.", - "description": "The first paragraph of the 404 page" - }, - "theme.NotFound.p2": { - "message": "Please contact the owner of the site that linked you to the original URL and let them know their link is broken.", - "description": "The 2nd paragraph of the 404 page" - }, - "theme.navbar.mobileLanguageDropdown.label": { - "message": "Languages", - "description": "The label for the mobile language switcher dropdown" - }, - "theme.TOCCollapsible.toggleButtonLabel": { - "message": "On this page", - "description": "The label used by the button on the collapsible TOC component" - }, - "theme.blog.post.readMore": { - "message": "Read More", - "description": "The label used in blog post item excerpts to link to full blog posts" - }, - "theme.blog.post.readMoreLabel": { - "message": "Read more about {title}", - "description": "The ARIA label for the link to full blog posts from excerpts" - }, - "theme.blog.post.readingTime.plurals": { - "message": "One min read|{readingTime} min read", - "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.breadcrumbs.home": { - "message": "Home page", - "description": "The ARIA label for the home page in the breadcrumbs" - }, - "theme.docs.sidebar.collapseButtonTitle": { - "message": "Collapse sidebar", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.collapseButtonAriaLabel": { - "message": "Collapse sidebar", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.navAriaLabel": { - "message": "Docs sidebar", - "description": "The ARIA label for the sidebar navigation" - }, - "theme.docs.sidebar.closeSidebarButtonAriaLabel": { - "message": "Close navigation bar", - "description": "The ARIA label for close button of mobile sidebar" - }, - "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { - "message": "← Back to main menu", - "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" - }, - "theme.docs.sidebar.toggleSidebarButtonAriaLabel": { - "message": "Toggle navigation bar", - "description": "The ARIA label for hamburger menu button of mobile navigation" - }, - "theme.docs.sidebar.expandButtonTitle": { - "message": "Expand sidebar", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.docs.sidebar.expandButtonAriaLabel": { - "message": "Expand sidebar", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.SearchBar.noResultsText": { - "message": "No results" - }, - "theme.SearchBar.seeAllOutsideContext": { - "message": "See results outside {context}" - }, - "theme.SearchBar.searchInContext": { - "message": "See all results in {context}" - }, - "theme.SearchBar.seeAll": { - "message": "See all results" - }, - "theme.SearchBar.label": { - "message": "Search", - "description": "The ARIA label and placeholder for search button" - }, - "theme.SearchPage.existingResultsTitle": { - "message": "Search results for \"{query}\"", - "description": "The search page title for non-empty query" - }, - "theme.SearchPage.emptyResultsTitle": { - "message": "Search the documentation", - "description": "The search page title for empty query" - }, - "theme.SearchPage.searchContext.everywhere": { - "message": "everywhere" - }, - "theme.SearchPage.documentsFound.plurals": { - "message": "1 document found|{count} documents found", - "description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.SearchPage.noResultsText": { - "message": "No documents were found", - "description": "The paragraph for empty search result" - }, - "theme.ErrorPageContent.tryAgain": { - "message": "Try again", - "description": "The label of the button to try again rendering when the React error boundary captures an error" - }, - "theme.common.skipToMainContent": { - "message": "Skip to main content", - "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" - }, - "theme.tags.tagsPageTitle": { - "message": "Tags", - "description": "The title of the tag list page" - }, - "theme.unlistedContent.title": { - "message": "Unlisted page", - "description": "The unlisted content banner title" - }, - "theme.unlistedContent.message": { - "message": "This page is unlisted. Search engines will not index it, and only users having a direct link can access it.", - "description": "The unlisted content banner message" - } -} diff --git a/i18n/en/docusaurus-plugin-content-blog/options.json b/i18n/en/docusaurus-plugin-content-blog/options.json deleted file mode 100644 index 9239ff7..0000000 --- a/i18n/en/docusaurus-plugin-content-blog/options.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "title": { - "message": "Blog", - "description": "The title for the blog used in SEO" - }, - "description": { - "message": "Blog", - "description": "The description for the blog used in SEO" - }, - "sidebar.title": { - "message": "Recent posts", - "description": "The label for the left sidebar" - } -} diff --git a/i18n/en/docusaurus-plugin-content-docs/current.json b/i18n/en/docusaurus-plugin-content-docs/current.json deleted file mode 100644 index 171e544..0000000 --- a/i18n/en/docusaurus-plugin-content-docs/current.json +++ /dev/null @@ -1,130 +0,0 @@ -{ - "version.label": { - "message": "Next", - "description": "The label for version current" - }, - "sidebar.mainSidebar.category.Quick Start": { - "message": "Quick Start", - "description": "The label for category Quick Start in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Sample Apps": { - "message": "Sample Apps", - "description": "The label for category Sample Apps in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Integrating": { - "message": "Integrating", - "description": "The label for category Integrating in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Packaging": { - "message": "Packaging", - "description": "The label for category Packaging in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Operating Systems": { - "message": "Operating Systems", - "description": "The label for category Operating Systems in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Operating Systems.link.generated-index.title": { - "message": "Operating Systems Overview", - "description": "The generated-index page title for category Operating Systems in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Distributing": { - "message": "Distributing", - "description": "The label for category Distributing in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Troubleshooting": { - "message": "Troubleshooting", - "description": "The label for category Troubleshooting in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Contributing": { - "message": "Contributing", - "description": "The label for category Contributing in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Migrating": { - "message": "Migrating", - "description": "The label for category Migrating in sidebar mainSidebar" - }, - "sidebar.mainSidebar.link.C# / AvaloniaUI": { - "message": "C# / AvaloniaUI", - "description": "The label for link C# / AvaloniaUI in sidebar mainSidebar, linking to https://github.com/velopack/velopack/tree/master/samples/AvaloniaCrossPlat" - }, - "sidebar.mainSidebar.link.C# / WPF": { - "message": "C# / WPF", - "description": "The label for link C# / WPF in sidebar mainSidebar, linking to https://github.com/velopack/velopack/tree/master/samples/VeloWpfSample" - }, - "sidebar.mainSidebar.link.C++ / Win32": { - "message": "C++ / Win32", - "description": "The label for link C++ / Win32 in sidebar mainSidebar, linking to https://github.com/velopack/velopack.fusion/tree/master/for-cpp/samples/win32" - }, - "sidebar.mainSidebar.link.JS / Electron": { - "message": "JS / Electron", - "description": "The label for link JS / Electron in sidebar mainSidebar, linking to https://github.com/velopack/velopack.fusion/tree/master/for-js/samples/electron-forge" - }, - "sidebar.mainSidebar.link.Rust / Iced": { - "message": "Rust / Iced", - "description": "The label for link Rust / Iced in sidebar mainSidebar, linking to https://github.com/velopack/velopack.fusion/tree/master/for-rust/samples/iced" - }, - "sidebar.mainSidebar.doc.C# .NET": { - "message": "C# .NET", - "description": "The label for the doc item C# .NET in sidebar mainSidebar, linking to the doc getting-started/csharp" - }, - "sidebar.mainSidebar.doc.C++": { - "message": "C++", - "description": "The label for the doc item C++ in sidebar mainSidebar, linking to the doc getting-started/cpp" - }, - "sidebar.mainSidebar.doc.JS / Electron": { - "message": "JS / Electron", - "description": "The label for the doc item JS / Electron in sidebar mainSidebar, linking to the doc getting-started/electron" - }, - "sidebar.mainSidebar.doc.Rust": { - "message": "Rust", - "description": "The label for the doc item Rust in sidebar mainSidebar, linking to the doc getting-started/rust" - }, - "sidebar.mainSidebar.doc.Fusion CLI": { - "message": "Fusion CLI", - "description": "The label for the doc item Fusion CLI in sidebar mainSidebar, linking to the doc getting-started/fusion-cli" - }, - "sidebar.referenceSidebar.category.Library Reference": { - "message": "Library Reference", - "description": "The label for category Library Reference in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.C#": { - "message": "C#", - "description": "The label for category C# in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack": { - "message": "Velopack", - "description": "The label for category Velopack in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.Compression": { - "message": "Velopack.Compression", - "description": "The label for category Velopack.Compression in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.Locators": { - "message": "Velopack.Locators", - "description": "The label for category Velopack.Locators in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.NuGet": { - "message": "Velopack.NuGet", - "description": "The label for category Velopack.NuGet in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.Sources": { - "message": "Velopack.Sources", - "description": "The label for category Velopack.Sources in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.Windows": { - "message": "Velopack.Windows", - "description": "The label for category Velopack.Windows in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.JS": { - "message": "JS", - "description": "The label for category JS in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.link.Rust": { - "message": "Rust", - "description": "The label for link Rust in sidebar referenceSidebar, linking to https://docs.rs/velopack" - }, - "sidebar.referenceSidebar.doc.C++": { - "message": "C++", - "description": "The label for the doc item C++ in sidebar referenceSidebar, linking to the doc reference/cpp/api" - } -} diff --git a/i18n/en/docusaurus-theme-classic/navbar.json b/i18n/en/docusaurus-theme-classic/navbar.json deleted file mode 100644 index bedfd41..0000000 --- a/i18n/en/docusaurus-theme-classic/navbar.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "logo.alt": { - "message": "Velopack Logo", - "description": "The alt text of navbar logo" - }, - "item.label.Guides": { - "message": "Guides", - "description": "Navbar item with label Guides" - }, - "item.label.Reference": { - "message": "Reference", - "description": "Navbar item with label Reference" - }, - "item.label.Blog": { - "message": "Blog", - "description": "Navbar item with label Blog" - } -} diff --git a/i18n/ru/code.json b/i18n/ru/code.json deleted file mode 100644 index e86c0ae..0000000 --- a/i18n/ru/code.json +++ /dev/null @@ -1,324 +0,0 @@ -{ - "theme.ErrorPageContent.title": { - "message": "Эта страница потерпела крах.", - "description": "The title of the fallback page when the page crashed" - }, - "theme.BackToTopButton.buttonAriaLabel": { - "message": "Прокрутите назад наверх", - "description": "The ARIA label for the back to top button" - }, - "theme.blog.archive.title": { - "message": "Архив", - "description": "The page & hero title of the blog archive page" - }, - "theme.blog.archive.description": { - "message": "Архив", - "description": "The page & hero description of the blog archive page" - }, - "theme.blog.paginator.navAriaLabel": { - "message": "Навигация по страницам списка блогов", - "description": "The ARIA label for the blog pagination" - }, - "theme.blog.paginator.newerEntries": { - "message": "Новые записи", - "description": "The label used to navigate to the newer blog posts page (previous page)" - }, - "theme.blog.paginator.olderEntries": { - "message": "Старые записи", - "description": "The label used to navigate to the older blog posts page (next page)" - }, - "theme.blog.post.paginator.navAriaLabel": { - "message": "Навигация по страницам постов блога", - "description": "The ARIA label for the blog posts pagination" - }, - "theme.blog.post.paginator.newerPost": { - "message": "Новое сообщение", - "description": "The blog post button label to navigate to the newer/previous post" - }, - "theme.blog.post.paginator.olderPost": { - "message": "Предыдущее сообщение", - "description": "The blog post button label to navigate to the older/next post" - }, - "theme.blog.post.plurals": { - "message": "Один пост|{count} сообщений", - "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.blog.tagTitle": { - "message": "{nPosts} с тегом \"{tagName}\"", - "description": "The title of the page for a blog tag" - }, - "theme.tags.tagsPageLink": { - "message": "Просмотреть все теги", - "description": "The label of the link targeting the tag list page" - }, - "theme.colorToggle.ariaLabel": { - "message": "Переключение между темным и светлым режимом (на данный момент {mode})", - "description": "The ARIA label for the navbar color mode toggle" - }, - "theme.colorToggle.ariaLabel.mode.dark": { - "message": "темный режим", - "description": "The name for the dark color mode" - }, - "theme.colorToggle.ariaLabel.mode.light": { - "message": "световой режим", - "description": "The name for the light color mode" - }, - "theme.docs.breadcrumbs.navAriaLabel": { - "message": "Панировочные сухари", - "description": "The ARIA label for the breadcrumbs" - }, - "theme.docs.DocCard.categoryDescription": { - "message": "{count} предметов", - "description": "The default description for a category card in the generated index about how many items this category includes" - }, - "theme.docs.paginator.navAriaLabel": { - "message": "Страницы документации", - "description": "The ARIA label for the docs pagination" - }, - "theme.docs.paginator.previous": { - "message": "Предыдущий", - "description": "The label used to navigate to the previous doc" - }, - "theme.docs.paginator.next": { - "message": "Следующий", - "description": "The label used to navigate to the next doc" - }, - "theme.docs.tagDocListPageTitle.nDocsTagged": { - "message": "Один документ с пометкой |{count} документы с тегами", - "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.tagDocListPageTitle": { - "message": "{nDocsTagged} с помощью «{tagName}»", - "description": "The title of the page for a docs tag" - }, - "theme.docs.versionBadge.label": { - "message": "Версия: {versionLabel}" - }, - "theme.docs.versions.unreleasedVersionLabel": { - "message": "Это неизданная документация для версии {siteTitle} {versionLabel} .", - "description": "The label used to tell the user that he's browsing an unreleased doc version" - }, - "theme.docs.versions.unmaintainedVersionLabel": { - "message": "Это документация для {siteTitle} {versionLabel}, которая больше не поддерживается.", - "description": "The label used to tell the user that he's browsing an unmaintained doc version" - }, - "theme.docs.versions.latestVersionSuggestionLabel": { - "message": "Актуальную документацию см. в {latestVersionLink} ({versionLabel}).", - "description": "The label used to tell the user to check the latest version" - }, - "theme.docs.versions.latestVersionLinkLabel": { - "message": "Последняя версия", - "description": "The label used for the latest version suggestion link label" - }, - "theme.common.editThisPage": { - "message": "Редактировать эту страницу", - "description": "The link label to edit the current page" - }, - "theme.common.headingLinkTitle": { - "message": "Прямая ссылка на {heading}", - "description": "Title for link to heading" - }, - "theme.lastUpdated.atDate": { - "message": " на {date}", - "description": "The words used to describe on which date a page has been last updated" - }, - "theme.lastUpdated.byUser": { - "message": " автор {user}", - "description": "The words used to describe by who the page has been last updated" - }, - "theme.lastUpdated.lastUpdatedAtBy": { - "message": "Последнее обновление{atDate}{byUser}", - "description": "The sentence used to display when a page has been last updated, and by who" - }, - "theme.NotFound.title": { - "message": "Страница не найдена", - "description": "The title of the 404 page" - }, - "theme.navbar.mobileVersionsDropdown.label": { - "message": "Версии", - "description": "The label for the navbar versions dropdown on mobile view" - }, - "theme.tags.tagsListLabel": { - "message": "Теги:", - "description": "The label alongside a tag list" - }, - "theme.admonition.caution": { - "message": "осторожность", - "description": "The default label used for the Caution admonition (:::caution)" - }, - "theme.admonition.danger": { - "message": "Опасность", - "description": "The default label used for the Danger admonition (:::danger)" - }, - "theme.admonition.info": { - "message": "Информация", - "description": "The default label used for the Info admonition (:::info)" - }, - "theme.admonition.note": { - "message": "примечание", - "description": "The default label used for the Note admonition (:::note)" - }, - "theme.admonition.tip": { - "message": "кончик", - "description": "The default label used for the Tip admonition (:::tip)" - }, - "theme.admonition.warning": { - "message": "предупреждение", - "description": "The default label used for the Warning admonition (:::warning)" - }, - "theme.AnnouncementBar.closeButtonAriaLabel": { - "message": "Закрывать", - "description": "The ARIA label for close button of announcement bar" - }, - "theme.blog.sidebar.navAriaLabel": { - "message": "Навигация по последним сообщениям блога", - "description": "The ARIA label for recent posts in the blog sidebar" - }, - "theme.CodeBlock.copied": { - "message": "Скопировано", - "description": "The copied button label on code blocks" - }, - "theme.CodeBlock.copyButtonAriaLabel": { - "message": "Скопировать код в буфер обмена", - "description": "The ARIA label for copy code blocks button" - }, - "theme.CodeBlock.copy": { - "message": "Копировать", - "description": "The copy button label on code blocks" - }, - "theme.CodeBlock.wordWrapToggle": { - "message": "Переключить перенос слов", - "description": "The title attribute for toggle word wrapping button of code block lines" - }, - "theme.DocSidebarItem.expandCategoryAriaLabel": { - "message": "Развернуть категорию боковой панели '{label}'", - "description": "The ARIA label to expand the sidebar category" - }, - "theme.DocSidebarItem.collapseCategoryAriaLabel": { - "message": "Свернуть категорию боковой панели '{label}'", - "description": "The ARIA label to collapse the sidebar category" - }, - "theme.NavBar.navAriaLabel": { - "message": "Основной", - "description": "The ARIA label for the main navigation" - }, - "theme.NotFound.p1": { - "message": "Мы не смогли найти то, что вы искали.", - "description": "The first paragraph of the 404 page" - }, - "theme.NotFound.p2": { - "message": "Свяжитесь с владельцем сайта, который связал вас с исходным URL-адресом, и сообщите ему, что его ссылка не работает.", - "description": "The 2nd paragraph of the 404 page" - }, - "theme.navbar.mobileLanguageDropdown.label": { - "message": "Языки", - "description": "The label for the mobile language switcher dropdown" - }, - "theme.TOCCollapsible.toggleButtonLabel": { - "message": "На этой странице", - "description": "The label used by the button on the collapsible TOC component" - }, - "theme.blog.post.readMore": { - "message": "Читать далее", - "description": "The label used in blog post item excerpts to link to full blog posts" - }, - "theme.blog.post.readMoreLabel": { - "message": "Подробнее о {title}", - "description": "The ARIA label for the link to full blog posts from excerpts" - }, - "theme.blog.post.readingTime.plurals": { - "message": "Одна минута чтения |{readingTime} минута чтения", - "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.breadcrumbs.home": { - "message": "Домашняя страница", - "description": "The ARIA label for the home page in the breadcrumbs" - }, - "theme.docs.sidebar.collapseButtonTitle": { - "message": "Свернуть боковую панель", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.collapseButtonAriaLabel": { - "message": "Свернуть боковую панель", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.navAriaLabel": { - "message": "Боковая панель Документов", - "description": "The ARIA label for the sidebar navigation" - }, - "theme.docs.sidebar.closeSidebarButtonAriaLabel": { - "message": "Закрыть панель навигации", - "description": "The ARIA label for close button of mobile sidebar" - }, - "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { - "message": "← Вернуться в главное меню", - "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" - }, - "theme.docs.sidebar.toggleSidebarButtonAriaLabel": { - "message": "Переключить панель навигации", - "description": "The ARIA label for hamburger menu button of mobile navigation" - }, - "theme.docs.sidebar.expandButtonTitle": { - "message": "Развернуть боковую панель", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.docs.sidebar.expandButtonAriaLabel": { - "message": "Развернуть боковую панель", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.SearchBar.noResultsText": { - "message": "Без результатов" - }, - "theme.SearchBar.seeAllOutsideContext": { - "message": "Посмотреть результаты за пределами {context}" - }, - "theme.SearchBar.searchInContext": { - "message": "Посмотреть все результаты в {context}" - }, - "theme.SearchBar.seeAll": { - "message": "Посмотреть все результаты" - }, - "theme.SearchBar.label": { - "message": "Поиск", - "description": "The ARIA label and placeholder for search button" - }, - "theme.SearchPage.existingResultsTitle": { - "message": "Результаты поиска по запросу \"{query}\"", - "description": "The search page title for non-empty query" - }, - "theme.SearchPage.emptyResultsTitle": { - "message": "Поиск в документации", - "description": "The search page title for empty query" - }, - "theme.SearchPage.searchContext.everywhere": { - "message": "повсюду" - }, - "theme.SearchPage.documentsFound.plurals": { - "message": "Найдено 1 документ|{count} документы найдены", - "description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.SearchPage.noResultsText": { - "message": "Документы не найдены", - "description": "The paragraph for empty search result" - }, - "theme.ErrorPageContent.tryAgain": { - "message": "Попробуйте еще раз", - "description": "The label of the button to try again rendering when the React error boundary captures an error" - }, - "theme.common.skipToMainContent": { - "message": "Перейти к основному содержанию", - "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" - }, - "theme.tags.tagsPageTitle": { - "message": "Теги", - "description": "The title of the tag list page" - }, - "theme.unlistedContent.title": { - "message": "Частная страница", - "description": "The unlisted content banner title" - }, - "theme.unlistedContent.message": { - "message": "Эта страница отсутствует в списке. Поисковые системы не будут его индексировать, и доступ к нему смогут получить только пользователи, имеющие прямую ссылку.", - "description": "The unlisted content banner message" - } -} diff --git a/i18n/ru/docusaurus-plugin-content-blog/options.json b/i18n/ru/docusaurus-plugin-content-blog/options.json deleted file mode 100644 index ff706f5..0000000 --- a/i18n/ru/docusaurus-plugin-content-blog/options.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "title": { - "message": "Блог", - "description": "The title for the blog used in SEO" - }, - "description": { - "message": "Блог", - "description": "The description for the blog used in SEO" - }, - "sidebar.title": { - "message": "Недавние Посты", - "description": "The label for the left sidebar" - } -} diff --git a/i18n/ru/docusaurus-plugin-content-docs/current.json b/i18n/ru/docusaurus-plugin-content-docs/current.json deleted file mode 100644 index 740dd46..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current.json +++ /dev/null @@ -1,130 +0,0 @@ -{ - "version.label": { - "message": "Следующий", - "description": "The label for version current" - }, - "sidebar.mainSidebar.category.Quick Start": { - "message": "Быстрый старт", - "description": "The label for category Quick Start in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Sample Apps": { - "message": "Примеры приложений", - "description": "The label for category Sample Apps in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Integrating": { - "message": "Интеграция", - "description": "The label for category Integrating in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Packaging": { - "message": "Упаковка", - "description": "The label for category Packaging in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Operating Systems": { - "message": "Операционные системы", - "description": "The label for category Operating Systems in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Operating Systems.link.generated-index.title": { - "message": "Обзор операционных систем", - "description": "The generated-index page title for category Operating Systems in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Distributing": { - "message": "Распространение", - "description": "The label for category Distributing in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Troubleshooting": { - "message": "Поиск неисправностей", - "description": "The label for category Troubleshooting in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Contributing": { - "message": "Содействие", - "description": "The label for category Contributing in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Migrating": { - "message": "Миграция", - "description": "The label for category Migrating in sidebar mainSidebar" - }, - "sidebar.mainSidebar.link.C# / AvaloniaUI": { - "message": "C#/АвалонияUI", - "description": "The label for link C# / AvaloniaUI in sidebar mainSidebar, linking to https://github.com/velopack/velopack/tree/master/samples/AvaloniaCrossPlat" - }, - "sidebar.mainSidebar.link.C# / WPF": { - "message": "С#/WPF", - "description": "The label for link C# / WPF in sidebar mainSidebar, linking to https://github.com/velopack/velopack/tree/master/samples/VeloWpfSample" - }, - "sidebar.mainSidebar.link.C++ / Win32": { - "message": "С++/Win32", - "description": "The label for link C++ / Win32 in sidebar mainSidebar, linking to https://github.com/velopack/velopack.fusion/tree/master/for-cpp/samples/win32" - }, - "sidebar.mainSidebar.link.JS / Electron": { - "message": "JS / Электрон", - "description": "The label for link JS / Electron in sidebar mainSidebar, linking to https://github.com/velopack/velopack.fusion/tree/master/for-js/samples/electron-forge" - }, - "sidebar.mainSidebar.link.Rust / Iced": { - "message": "Ржавчина / Обледенение", - "description": "The label for link Rust / Iced in sidebar mainSidebar, linking to https://github.com/velopack/velopack.fusion/tree/master/for-rust/samples/iced" - }, - "sidebar.mainSidebar.doc.C# .NET": { - "message": "С# .NET", - "description": "The label for the doc item C# .NET in sidebar mainSidebar, linking to the doc getting-started/csharp" - }, - "sidebar.mainSidebar.doc.C++": { - "message": "С++", - "description": "The label for the doc item C++ in sidebar mainSidebar, linking to the doc getting-started/cpp" - }, - "sidebar.mainSidebar.doc.JS / Electron": { - "message": "JS / Электрон", - "description": "The label for the doc item JS / Electron in sidebar mainSidebar, linking to the doc getting-started/electron" - }, - "sidebar.mainSidebar.doc.Rust": { - "message": "Ржавчина", - "description": "The label for the doc item Rust in sidebar mainSidebar, linking to the doc getting-started/rust" - }, - "sidebar.mainSidebar.doc.Fusion CLI": { - "message": "Слияние CLI", - "description": "The label for the doc item Fusion CLI in sidebar mainSidebar, linking to the doc getting-started/fusion-cli" - }, - "sidebar.referenceSidebar.category.Library Reference": { - "message": "Справочник библиотеки", - "description": "The label for category Library Reference in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.C#": { - "message": "С#", - "description": "The label for category C# in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack": { - "message": "Велопак", - "description": "The label for category Velopack in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.Compression": { - "message": "Велопак.Сжатие", - "description": "The label for category Velopack.Compression in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.Locators": { - "message": "Велопак.Локаторы", - "description": "The label for category Velopack.Locators in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.NuGet": { - "message": "Велопак.NuGet", - "description": "The label for category Velopack.NuGet in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.Sources": { - "message": "Велопак.Источники", - "description": "The label for category Velopack.Sources in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.Windows": { - "message": "Велопак.Окна", - "description": "The label for category Velopack.Windows in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.JS": { - "message": "JS", - "description": "The label for category JS in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.link.Rust": { - "message": "Ржавчина", - "description": "The label for link Rust in sidebar referenceSidebar, linking to https://docs.rs/velopack" - }, - "sidebar.referenceSidebar.doc.C++": { - "message": "С++", - "description": "The label for the doc item C++ in sidebar referenceSidebar, linking to the doc reference/cpp/api" - } -} diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/contributing/compiling.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/contributing/compiling.mdx deleted file mode 100644 index 3cbad7a..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/contributing/compiling.mdx +++ /dev/null @@ -1,71 +0,0 @@ -# Сборка Velopack SDK - - -Velopack SDK отвечает за компиляцию выпусков и установщиков. - -Он состоит из: - -- Бинарные файлы Rust, которые перераспределяются вместе с установленными приложениями, -- пакет .NET NuGet («Велопак»), -- Инструмент командной строки .NET («vpk»). - -Чтобы протестировать проект, вам необходимо собрать двоичные файлы Rust перед компиляцией dotnet. - -### Предварительные условия - -- [SDK .NET 6](https://dotnet.microsoft.com/download/dotnet/6.0) -- [SDK .NET 8](https://dotnet.microsoft.com/download/dotnet/8.0) -- [Rust/Cargo](https://www.rust-lang.org/tools/install) -- `dotnet Tool install -g dotnet-coverage` -- `dotnet Tool install -g nbgv` - -### Отладка/тестирование - -В Windows вам необходимо собрать двоичные файлы Rust, используя функцию Windows, прежде чем запускать тесты. В OSX вместо этого вам следует запустить `cargo build`. - -```shell -git clone https://github.com/velopack/velopack.git -cd velopack/src/Rust -cargo build --features windows -cd ../../ -dotnet build -dotnet test --no-build -``` - -### Выпуск/Сборка - -Это немного сложно, потому что вам нужно будет скомпилировать Rust для x64 OSX и x64 Windows перед созданием окончательных пакетов. - -В OSX: - -```shell -git clone https://github.com/velopack/velopack.git -cd velopack/src/Rust -грузовая сборка --release -``` - -В Windows: - -```shell -git clone https://github.com/velopack/velopack.git -cd velopack/src/Rust -cargo build --release --features windows -copy {path_to_osx_update} target/release/updatemac -dotnet build -c Release /p:PackRustAssets=true -``` - -### Компиляция в Linux - -Если вы используете Linux (протестировано на Ubuntu), существуют дополнительные предварительные требования к пакету: - -```sh -sudo apt установить libssl-dev pkg-config -``` - -Вам необходимо убедиться, что `nbgv` работает в командной строке. Возможно, в вашем профиле bash отсутствует переменная `DOTNET_ROOT`, которая может указывать на `/usr/share/dotnet` или `$HOME/.dotnet`. - -Если вам не хватает пакетов локализации, вы можете найти их или добавить в свой профиль bash следующее: - -```bash -экспортировать DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/distributing/deploy-cli.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/distributing/deploy-cli.mdx deleted file mode 100644 index 2ba9bae..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/distributing/deploy-cli.mdx +++ /dev/null @@ -1,43 +0,0 @@ -# Интерфейс командной строки развертывания - - -Общий процесс развертывания выпуска Velopack («загрузка -> пакет -> загрузка») можно значительно упростить, используя команды «download» и «upload», встроенные в ` vpk` инструмент командной строки. - -## Упаковка вашего нового релиза с помощью delta - -Чтобы во время команды `pack` были сгенерированы дельты, вам необходимо сначала загрузить текущую последнюю версию. Это нужно сделать с помощью команды загрузки: - -```cmd -скачать vpk http --url https://the.place/you-host/updates -vpk package -u YourAppId -v 1.0.1 -p {buildOutput} -``` - -Существуют провайдеры для различных источников, таких как GitHub, S3, HTTP и т. д. - -## Развертывание релизов - -В предыдущем примере мы использовали источник http, хотя он и очень общий, он не предоставляет никакой информации о том, как загружать выпуски, поэтому в следующем примере развертывания мы будем использовать [AWS S3]\(https://aws .amazon.com/s3/). - -:::tip -Большинство поставщиков облачных хранилищ сегодня имеют S3-совместимый API ([GCP](https://cloud.google.com/storage/docs/interoperability), [BackBlaze B2]\(https://www.backblaze.com/docs/ cloud-storage-s3-совместимый-api), [DigitalOcean](https://docs.digitalocean.com/products/spaces/how-to/use-aws-sdks/), [Linode]\(https://www .linode.com/docs/products/storage/object-storage/), [IBM Cloud]\(https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-compatibility- api) и т. д.) и может использоваться с этой командой — она не ограничивается AWS. -::: - -Используя AWS, вы можете [аутентифицироваться с помощью инструмента командной строки `aws`](https://docs.aws.amazon.com/sdk-for-net/v3/developer-guide/creds-idc.html) или предоставьте ключи доступа, как показано ниже. - -Если вы используете AWS SSO, вам следует проверить [AWS CLI SSO]\(https://aws.amazon.com/blogs/security/aws-single-sign-on-now-enables-command-line-interface-access -for-aws-accounts-using-corporate-credentials/) и [аутентификация сеанса AWS] \(https://docs.aws.amazon.com/STS/latest/APIReference/API_GetSessionToken.html). - -```cmd -vpk download s3 --bucket MyApp --region us-west-1 --keyId {accessKeyId} --secret {accessKeySecret} -vpk pack -u YourAppId -v 1.0.1 -p {buildOutput} -vpk upload s3 --bucket MyApp --region us-west-1 --keyId {accessKeyId} --secret {accessKeySecret} -``` - -Обратите внимание, что вы также можете указать большинство этих аргументов как переменные среды. Вы можете просмотреть [переменные среды AWS SDK здесь] \(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html), и каждый параметр `vpk` может быть предоставлен в качестве среды. переменную тоже, чтобы перечислить их в тексте справки, используйте `vpk -H` вместо `vpk -h`. - -При использовании API, не совместимого с AWS S3 (например, BackBlaze B2), вам необходимо указать конечную точку вместо региона: - -```cmd -vpk download s3 --bucket MyApp --endpoint https://s3.eu-central-003.backblazeb2.com --keyId {accessKeyId} --secret {accessKeySecret} -vpk pack -u YourAppId -v 1.0.1 -p {buildOutput} -vpk upload s3 --bucket MyApp --endpoint https://s3.eu-central-003.backblazeb2.com --keyId {accessKeyId} --secret {accessKeySecret} -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/distributing/github-actions.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/distributing/github-actions.mdx deleted file mode 100644 index 0526be1..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/distributing/github-actions.mdx +++ /dev/null @@ -1,109 +0,0 @@ -# Действия GitHub - - - -В этом разделе предполагается, что у вас есть базовые знания о действиях GitHub. Вы можете узнать больше о -создании рабочих процессов [здесь](https://docs.github.com/en/actions/deployment/about-deployments/deploying-with-github-actions). - -### Создание рабочего процесса - -В следующем примере предполагается, что вы создаете приложение для Windows, но вы можете адаптировать рабочий процесс и для других платформ. - -Сначала создайте рабочий процесс в своем репозитории по адресу `.github/workflows` с расширением `.yml`, например -`.github/workflows/main.yml`. Этот пример рабочего процесса будет запущен, когда код будет отправлен в ветку `main`. Если вы предпочитаете другой триггер, обратитесь к документации -, указанной выше. - -```yml -имя: Развертывание в выпусках GitHub - -on: - push: - ветки: - - main -``` - -Создайте задание, которое будет запускаться при активации триггера. Этот пример будет работать на машине с `windows-latest`, поскольку мы -упаковываем для Windows. - -```yml -задания: - развертывание-на-GitHub-релизы: - запуск: Windows-последние - шаги: -``` - -### Компиляция приложения - -Сначала добавьте шаг по извлечению вашего репозитория, чтобы получить все файлы, необходимые для компиляции вашего приложения. - -```yml - - имя: Репозиторий Checkout - использует: action/checkout@v4 -``` - -Для упаковки с помощью Velopack вам понадобится номер версии вашего релиза. Есть много способов справиться с этим. -Если для этого вы используете переменные действий GitHub, вы можете пропустить этот шаг. В этом примере номер версии -будет извлечен из тега `` в `.csproj` приложения. Оболочка `bash` определена здесь -, так как в противном случае эта команда завершится ошибкой при запуске в Windows. The command works by using a regular expression -with `grep` to extract the value between `` and `` in the csproj file, and store it in a -variable called `version` in the current run of the workflow. - -```yml - - имя: Получить версию из файла проекта - id: get-version - оболочка: bash - запустить: echo "version=$(grep -oE '[^ <]+' MyApplication/MyApplication.csproj | sed 's///')" >> $GITHUB_OUTPUT -``` - -Затем добавьте шаг по установке .NET, чтобы приложение можно было скомпилировать. Установите `dotnet-version` на версию, необходимую -вашему приложению. - -```yml - - имя: Install .NET - использует: action/setup-dotnet@v4 - с: - версия dotnet: 8.0.x -``` - -Скомпилируйте ваше приложение. В этом примере это будет сделано путем публикации приложения в папке автономным образом. -Вы можете публиковать без флага автономности, если используете Velopack для установки таких зависимостей -(подробности см. в разделе [Загрузка](../packaging/bootstrapping.mdx). This command uses the `-c` flag to set the build -configuration to `Release` mode, `-o` to set the output directory to `publish`, `-r` to set the runtime -to `win-x64` for distributing on 64-bit Windows, and `--self-contained` to publish the .NET runtime with the -application. Адаптируйте эту команду к своим потребностям. Дополнительную информацию о -`dotnetPublish` можно узнать в [Документации Microsoft](https://learn.microsoft.com/dotnet/core/tools/dotnet-publish). - -```yml - - имя: Опубликовать приложение - запустить: dotnetPublish MyProject/MyProject.csproj -c Release -oPublish -r win-x64 --self-contained true -``` - -### Развертывание релиза - -Наконец, используйте Velopack для упаковки вашего приложения и развертывания выпуска. Создайте шаг, который запускает несколько команд -в командной строке. - -Давайте разберем, что делает каждая строка. - -1. Устанавливает интерфейс командной строки Velopack. -2. Загружает последнюю версию вашего репозитория. Это необходимо для того, чтобы Velopack мог создать дельта-пакет - между текущим выпуском и новым, а также заполнить файлы выпусков. -3. Вызывает интерфейс командной строки Velopack для упаковки вашего приложения. Аргумент `-v` вызывает - назначенную ранее переменную `version`, доступ к которой осуществляется с использованием `id` шага, который ее назначил (`get-version`). - `-p` указывает на каталог `publish`, который использовался на предыдущем шаге. Для получения дополнительной информации о интерфейсе командной строки Velopack - и о том, какие флаги доступны для команды `pack`, [см. здесь](../packaging/overview.mdx). -4. Создает новый релиз в вашем репозитории и автоматически загружает в него необходимые файлы. - -:::tip -Если ваш репозиторий является частным, вам необходимо будет предоставить Velopack токен OAuth при использовании команд `vpk download` -и `vpk upload`. Просто добавьте к обеим командам следующее: `--token ${{ secrets.GITHUB_TOKEN }}`. -::: - -```yml - - name: Create Velopack Release - run: | - dotnet tool install -g vpk - vpk download github --repoUrl https://github.com/Myname/Myrepo - vpk pack -u MyUniqueIdentifier -v ${{ steps.get-version.outputs.version }} -p publish - vpk upload github --repoUrl https://github.com/Myname/Myrepo --publish --releaseName "MyProject ${{ steps.get-version.outputs.version }}" --tag v${{ steps.get-version.outputs.version }} -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/distributing/overview.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/distributing/overview.mdx deleted file mode 100644 index 30ddba6..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/distributing/overview.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -sidebar_label: Обзор -sidebar_position: 0 ---- - -# Обзор распространения - - -Распространять с помощью Velopack чрезвычайно просто: обычно это так же просто, как загрузить куда-нибудь файлы, которые можно будет загрузить по HTTP. Это означает, что вы можете разместить их на сайте IIS или nodejs, на общем хостинге файлов, таком как AWS S3, Azure Storage, BackBlaze B2, или даже бесплатно в выпусках GitHub/GitLab, если ваш проект имеет открытый исходный код. - -Общие шаги по созданию и развертыванию выпуска Velopack: - -1. Загрузите последнюю опубликованную версию (например, 1.0.0). -2. Запустите `vpk package`, чтобы создать новую версию (например, 1.0.1). -3. Загрузите недавно созданные ресурсы 1.0.1. -4. Обновите удаленные релизы.{channel}.json\`, чтобы отразить недавно загруженные ресурсы. - -См. также: [Команды развертывания](deploy-cli.mdx) могут значительно упростить этот процесс. - -## Список произведенных активов - -После упаковки релиза с помощью Velopack в выходном каталоге у вас должно быть что-то вроде следующего: - -``` -Releases -├── YourAppId-1.0.1-full.nupkg -├── YourAppId-1.0.1-delta.nupkg -├── YourAppId-Setup.exe -├── YourAppId-Portable.zip -├── releases.{channel}.json -├── assets.{channel}.json -└── RELEASES -``` - -### Полные и дельта-нупки - -Это пакеты обновлений, которые установленные приложения используют для поиска/установки последней версии. Полные пакеты содержат полную копию ваших входных файлов, а также некоторые файлы, которые добавляет Velopack. Дельта-пакет — это отличие от ранее созданного полного пакета. Вам необходимо загрузить предыдущую версию (например, 1.0.0 в приведенном выше примере) и разместить ее в выходном каталоге для создания дельты (в данном случае `1.0.0->1.0.0`). Существуют полезные [команды развертывания] \(deploy-cli.mdx), которые могут загрузить для вас последнюю версию, чтобы изменения создавались автоматически. - -Вы должны распространять эти пакеты в той же папке, что и файлы Releases.{channel}.json\` для работы обновлений. - -### Настройка и портативность - -Это то, что ваш пользователь должен загрузить и запустить, чтобы установить ваше приложение. В MacOS вы получите .pkg вместо -Setup.exe. В Linux установка не производится - только портативный `.AppImage`. Причина этого в том, что .AppImage полностью переносимы на любой относительно недавний дистрибутив Linux. - -### Лента релизов (`releases.{channel}.json`) - -Этот файл следует распространять в той же папке, где развертываются файлы `nupkg`. Он содержит список всех доступных выпусков. - -Когда вы предоставляете URL-адрес HTTP для UpdateManager, он будет искать этот файл. Например, если вы используете новый UpdateManager("https://the.place/you-host/updates"), то UpdateManager запросит https://the.place/you-host/updates/releases.{channel}.json\`. Канал, который UpdateManager использует в запросе, является автоматическим, вы можете [подробнее узнать о каналах здесь](../packaging/channels.mdx). - -Например, если вы упаковали «1.0.0», а затем сразу после этого «1.0.1», содержимое этого файла может выглядеть так: - -```json title="releases.win.json" -{ - "Assets": [ - { - "PackageId": "YourAppId", - "Version": "1.0.1", - "Type": "Full", - "FileName": "YourAppId-1.0.1-full.nupkg", - "SHA1": "537EC0F4E1C4263A230353FAB4150216E5AF3724", - "Size": 1588612 - }, - { - "PackageId": "YourAppId", - "Version": "1.0.1", - "Type": "Delta", - "FileName": "YourAppId-1.0.1-delta.nupkg", - "SHA1": "9615D266DDBCADF3B9CD82BABF9DA571A0EE2B83", - "Size": 3606 - }, - { - "PackageId": "YourAppId", - "Version": "1.0.0", - "Type": "Full", - "FileName": "YourAppId-1.0.0-full.nupkg", - "SHA1": "69122BABCEEEF9F653BFE59D87DDAEF363F9476F", - "Size": 1588613 - } - ] -} -``` - -Файл выпусков всегда должен отражать файлы, которые _действительно доступны_ в удаленной папке, содержащей файл выпусков. Поэтому, если вы удаляете выпуск nupkg с удаленного сервера, вам следует удалить его и из файла удаленного выпуска. Если вы развертываете вновь созданные локальные файлы на удаленном сервере, который уже содержит некоторые выпуски, вам следует скопировать ресурсы из локального файла в файл удаленных выпусков. - -:::warning -Этот файл — единственный способ, с помощью которого UpdateManager может обнаруживать выпуски. Если вы не обновите его должным образом, это может привести к тому, что ваши пользователи не будут получать обновления. -::: - -Обновлять этот файл вручную утомительно, поэтому Velopack CLI предоставляет команды развертывания, которые могут развертывать ресурсы и автоматически обновлять этот файл для вас, а также применять политики хранения в отношении количества сохраняемых выпусков. [\[Подробнее\]](deploy-cli.mdx) - -### Фид устаревших выпусков ("РЕЛИЗЫ") - -Этот формат выпусков использовался Clowd.Squirrel и Squirrel.Windows и до сих пор создается Velopack, чтобы позволить вам перенести приложение с использованием одной из этих платформ на Velopack. Если у вас нет устаревших пользователей, которым необходимо перейти на Velopack, вы можете смело игнорировать этот файл. - -### Файл ресурсов - -Этот файл содержит список ресурсов, созданных последней командой Pack. Он используется [командами развертывания Velopack] \(deploy-cli.mdx), чтобы узнать, какие файлы следует загрузить. Его можно игнорировать/удалять, если вы не собираетесь использовать эти команды для развертывания выпусков и автоматического обновления ленты выпусков. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/getting-started/cpp.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/getting-started/cpp.mdx deleted file mode 100644 index 1500d21..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/getting-started/cpp.mdx +++ /dev/null @@ -1,85 +0,0 @@ -# Начало работы: С++ - - -Начните работу с нашей кроссплатформенной библиотекой заголовков C++. - -1. Скопируйте [Velopack.hpp](https://github.com/velopack/velopack.fusion/blob/master/for-cpp/Velopack.hpp) и [Velopack.cpp]\(https://github.com/velopack/ velopack.fusion/blob/master/for-cpp/Velopack.cpp) в свой проект. - -2. Настройте поддержку Unicode: - #### Окна - В Windows, чтобы включить поддержку Юникода для этой библиотеки, вы **_должны_** - [настроить кодовую страницу UTF-8]\(https://learn.microsoft.com/en-us/windows/apps /design/globalizing/use-utf8-code-page) через манифест вашего приложения - . Невыполнение этого требования потенциально может привести к тому, что ваше приложение **_не сможет обновить_**, если в путях к файлам - вашего пользователя, имени пользователя и т. д. есть символы Юникода. - ```xml - - - - - UTF-8 - - - - ``` - #### Linux и MacOS - - Если вы используете Qt и доступен `QString`, вам больше ничего делать не нужно. - - Если вы не используете Qt, вам необходимо [установить ICU4C](https://icu.unicode.org/). Как и во многих других библиотеках C, - установки пакета разработки с помощью вашего менеджера пакетов (`apt`, `brew` и т.д.) _должно_ быть достаточно, чтобы сделать его доступным для компиляторов. - -3. Добавьте `Velopack::startup()` в вашу точку входа (например, `main()` или `wmain()`) как можно раньше, в идеале первым запускаемым оператором: - - ```cpp - #include "Velopack.hpp" - - wmain(int argc**, wchar_t *argv[ ], wchar_t *envp[ ]) - { - // Velopack может выйти/перезапустить ваш приложение в этом операторе - Velopack::startup(argv, argc); - - // ... здесь ваш другой стартовый код - } - ``` - -4. Добавьте где-нибудь в свое приложение автоматические обновления: - - ```cpp - #include "Velopack.hpp" - #include - - static void update_app() - { - Velopack::UpdateManagerSync Manager{}; - Manager.setUrlOrPath("https://the.place/you-host/updates"); - - auto updInfo = Manager.checkForUpdates(); - if (updInfo == nullptr) { - return; // обновлений нет - } - - Manager.downloadUpdates(updInfo->targetFullRelease.get()); - менеджер.applyUpdatesAndRestart(updInfo->targetFullRelease.get()); - } - ``` - -5. Установите инструмент командной строки `vpk`: - ```sh - обновление инструмента dotnet -g vpk - ``` - :::tip - **_Для использования и обновления `vpk`_** - у вас должен быть установлен .NET Core SDK 6 ::: - -6. Скомпилируйте свое приложение в программу, используя обычный компилятор (например, msvc, cmake, gcc и т. д.). - -7. Скопируйте `Vfusion.exe`, `VfusionMac` или `VfusionNix` в папку вывода вашей сборки. На данный момент это выполняется вручную, но в будущем может быть автоматизировано. Вы можете скомпилировать это самостоятельно, загрузить [артефакт последней сборки] \(https://github.com/velopack/velopack.fusion/actions) или получить последнюю версию [выпуска npm] \(https://www.npmjs.com/ package/velopack?activeTab=code), который также включает в себя двоичные файлы. - :::предупреждение - Пока это не будет автоматизировано, невозможность копирования двоичного файла fusion в каталог обновлений приведет к тому, что ваше приложение не сможет обновиться. - ::: - -8. Упакуйте релиз/установщики Velopack: - ```sh - vpk package -u MyAppUniqueId -v 1.0.0 -p /myBuildDir -e myexename.exe - ``` - -✅ Готово! Теперь в вашем приложении есть автоматические обновления и установщик. -Вы можете загрузить свой релиз на свой веб-сайт или использовать команду `vpk upload`, чтобы опубликовать его в выбранном вами месте. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/getting-started/csharp.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/getting-started/csharp.mdx deleted file mode 100644 index 2717206..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/getting-started/csharp.mdx +++ /dev/null @@ -1,48 +0,0 @@ -# Начало работы: .NET - - -Начните работу с .NET 5+ (кроссплатформенная) или .Net Framework. - -1. Установите [Пакет Velopack NuGet](https://www.nuget.org/packages/velopack) в свой основной проект: - ```cmd - dotnet добавить пакет Velopack - ``` -2. Настройте приложение Velopack в начале Program.Main: - ```cs - static void Main(string[] args) - { - VelopackApp.Build().Run(); - // ... ваш другой код запуска ниже - } - ``` -3. Добавьте автоматическое обновление в свое приложение: - - ```cs - частная статическая асинхронная задача UpdateMyApp() - { - var mgr = new UpdateManager("https://the.place/you-host/updates"); - - // проверка наличия новой версии - var newVersion = await mgr.CheckForUpdatesAsync(); - if (newVersion == null) - return; // обновление отсутствует - - // загрузка новой версии - await mgr.DownloadUpdatesAsync(newVersion); - - // устанавливаем новую версию и перезапускаем приложение - mgr.ApplyUpdatesAndRestart(newVersion); - } - ``` -4. Установите инструмент командной строки `vpk`: - ```cmd - обновление инструмента dotnet -g vpk - ``` -5. Опубликуйте dotnet и создайте свой первый выпуск Velopack! 🎉 - ```batch - dotnetPublish -c Release --self-contained -r win-x64 -o .\publish - vpk package -u YourAppId -v 1.0.0 -p .\publish -e yourMainApp.exe - ``` - -✅ Готово! Теперь в вашем приложении есть автоматические обновления и установщик. -Вы можете загрузить свой релиз на свой веб-сайт или использовать команду `vpk upload`, чтобы опубликовать его в выбранном вами месте. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/getting-started/electron.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/getting-started/electron.mdx deleted file mode 100644 index e8001ed..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/getting-started/electron.mdx +++ /dev/null @@ -1,79 +0,0 @@ -# Начало работы: JS/электрон - - -Начните работу с нашим пакетом NPM для JS и Electron. - -Если вы используете чистый nodejs и объединяете свое приложение с помощью [pkg](https://github.com/vercel/pkg) или аналогичного, вы можете игнорировать шаги, специфичные для Electron. - -1. Добавьте Velopack в ваш package.json: - ```txt - npm установить велопак - ``` - -2. Добавьте следующий код в свою точку входа (например, `index.js`) как можно раньше (перед любым электронным кодом запуска и т. д.): - - ```js - const { VelopackApp } = require('velopack'); - - // Сборщик Velopack должен быть запущен первым в основном процессе. - // В некоторых случаях процесс может завершиться/перезапуститься для выполнения задач. - VelopackApp.build().run(); - - // ... здесь код запуска вашего другого приложения - ``` - -3. Добавьте где-нибудь в свое приложение автоматические обновления: - - ```js - const { UpdateManager } = require('velopack'); - - асинхронная функция updateApp() - { - const um = new UpdateManager(); - um.setUrlOrPath("https://the.place/you-host/updates"); - - const updateInfo = await um.checkForUpdatesAsync(); - if (!updateInfo) { - return; // нет доступных обновлений - } - - await um.downloadUpdatesAsync(updateInfo.targetFullRelease, p => { - console.log(`progress: ${p}%`); - }); - - um.applyUpdatesAndRestart(updateInfo.targetFullRelease); - } - ``` - -4. Если вы используете Electron/Forge, вам нужно будет добавить правило распаковки asar: - ```js - module.exports = { - packagerConfig: { - asar: { - // velopack содержит собственные двоичные файлы, которые должны оставаться распакованными - unpack: '**/node_modules/velopack /**', - }, - }, - } - ``` - -5. Скомпилируйте приложение в двоичный файл (например, «.exe» в Windows). Пример использования электронной кузницы: - ```sh - пакет npx для электронной кузницы - ``` - -6. Установите инструмент командной строки `vpk`: - ```sh - обновление инструмента dotnet -g vpk - ``` - :::tip - **_Для использования и обновления `vpk`_** - у вас должен быть установлен .NET Core SDK 6 ::: - -7. Упакуйте релиз/установщики Velopack: - ```sh - vpk package -u MyAppUniqueId -v 1.0.0 -p /myBuildDir -e myexename.exe - ``` - -✅ Готово! Теперь в вашем приложении есть автоматические обновления и установщик. -Вы можете загрузить свой релиз на свой веб-сайт или использовать команду `vpk upload`, чтобы опубликовать его в выбранном вами месте. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/getting-started/fusion-cli.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/getting-started/fusion-cli.mdx deleted file mode 100644 index 6db4ffa..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/getting-started/fusion-cli.mdx +++ /dev/null @@ -1,128 +0,0 @@ -# Слияние CLI - - -Интегрируйте напрямую с помощью интерфейса командной строки. - -Если для вашего языка еще нет встроенной библиотеки или привязок командной строки, вы можете напрямую интегрировать Velopack с помощью командной строки. - -**_Необходимы два двоичных файла._** - -## Слияние - -`Vfusion.exe` / `VfusionMac` / `VFusionNix`
-Обеспечивает поддержку получения текущей версии, проверки наличия обновлений, загрузки обновлений и т. д. - -:::warning -В настоящее время двоичный файл fusion не распространяется автоматически, и вам необходимо скопировать его в выходной каталог компилятора. -Вы можете загрузить [артефакт недавней сборки] \(https://github.com/velopack/velopack.fusion/actions) и убедиться, что он скопирован в выходной каталог во время сборки. -::: - -### Пример - -``` -> Проверка Vfusion.exe --url https://the.place/you-host/updates -``` - -Вот возможные результаты: - -- **Обновления недоступны:** пустой стандартный вывод и `exitCode == 0`. -- **Неустранимая ошибка:** пустой стандартный вывод и `exitCode != 0`. Будет создан [файл журнала](#logging). -- **Доступно обновление:** стандартный вывод содержит объект json и `exitCode == 0`. - -Когда обновление станет доступным, вы получите объект [UpdateInfo](../reference/cs/Velopack/UpdateInfo.md) через стандартный вывод: - -```json -{ - "isDowngrade": false, - "targetFullRelease": { - "packageId": "YourPackageId", - "version": "2.0.1", - "type": "Full", - "fileName": "YourPackageId-2.0.1-full.nupkg", - "sha1": "331a4f44a6a875b2ce139ae0c9ce5bb5e1ec0d97", - "size": 90654, - "notesMarkdown": "# Release v2.0.1 \n Your message here", - "notesHtml": "

Release v2.0.1


Your message here" - } -} -``` - -Следующим шагом будет загрузка обновления на диск, используя свойство fileName из предыдущей команды: - -``` -> Загрузка Vfusion.exe \ - --url https://the.place/you-host/updates \ - --name YourPackageId-2.0.1-full.nupkg -``` - -Во время выполнения этой команды fusion выведет текущий прогресс загрузки на стандартный вывод. Например: - -``` -10 -20 -30 -40 -... -``` - -Вы можете проанализировать каждую строку стандартного вывода (разделенную на `\n`) и показать прогресс своим пользователям. - -Если `exitCode == 0`, команда выполнена успешно. - -Чтобы получить окончательный путь к загруженному ресурсу, вы можете объединить результаты `Vfusion.exe get-packages` и `fileName`. - -Чтобы установить обновление, обратитесь к следующему разделу. - -:::tip -Существуют и другие команды (например, `get-version`), которые могут быть полезны, изучите их с помощью `Vfusion.exe -h` -::: - -## Программа обновлений - -`Update.exe` / `UpdateMac` / `UpdateNix`
-Обеспечивает поддержку установки загруженных обновлений, запрос на повышение прав (при необходимости), загрузку [зависимостей]\(../packaging/bootstrapping. mdx) и так далее. - -:::info -Этот двоичный файл автоматически копируется в ваш пакет при сборке `vpk`, вам просто нужно расположить его относительно вашего основного исполняемого файла. -::: - -Вы будете использовать команду update apply для установки загруженного обновления. - -### Пример - -``` -> Update.exe применить --перезапустить -``` - -Выполнение приведенной выше команды немедленно закроет вашу программу, установит обновление и перезапустит приложение в новой версии. - -:::tip -При вызове без аргументов Update применит новейшую загруженную версию, если она новее установленной в данный момент версии. -Если вы хотите установить более старую версию, вам необходимо указать параметр --package. -::: - -Все доступные варианты подачи заявки приведены ниже: - -``` -update apply: -Применяет поэтапное/подготовленное обновление, при необходимости устанавливая необходимые среды выполнения - -r, --restart Перезапустить приложение после обновления - -w, --wait Дождитесь родительский процесс должен завершиться перед применением обновления - --waitPid Дождитесь завершения указанного процесса перед применением обновления - -p, --package Update пакет для применения - -h, --help Распечатать справку - [EXE_ARGS]... Аргументы для передачи перезапускаемому исполняемому файлу. Перед ним должен стоять '--'. -``` - -## Ведение журнала - -Поскольку ошибки не выводятся на стандартный вывод, важно знать, где найти файлы журналов для диагностики ошибок. - -### Окна - -Программа обновления выполнит вход в свой собственный каталог, а Fusion — в папку над собой. -При типичной установке это приведет к объединению журналов Fusion и журнала Updater в один файл журнала. - -### Линукс и МакОС - -В UNIX-подобных операционных системах журналы этих двоичных файлов всегда хранятся в `/tmp/velopack.log`. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/getting-started/rust.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/getting-started/rust.mdx deleted file mode 100644 index e2c23d5..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/getting-started/rust.mdx +++ /dev/null @@ -1,72 +0,0 @@ -# Начало работы: ржавчина - - -Начните работу с нашим официальным кроссплатформенным Rust Crate. - -1. Добавьте Velopack в свой Cargo.toml: - ```toml - [зависимости] - velopack = { version = "0.0", Features = ["async"] } - # Замените приведенное выше актуальной версией и желаемыми функциями. - ``` - -2. Добавьте следующий код в функцию main(): - ```rust - используйте велопак::*; - fn main() { - // VelopackApp должен быть запущен первым. - // В некоторых случаях он может завершить/перезапустить - // процесс во время обновления/установки. - VelopackApp::build().run(); - - // ... здесь код запуска вашего другого приложения - } - ``` - -3. Добавьте где-нибудь в свое приложение автоматические обновления: - - ```rust - используйте велопак::*; - использовать в любом случае::Result; - - fn update_my_app() -> Result<()> { - let um = UpdateManager::new("https://the.place/you-host/updates", None)?; - - // проверка обновлений - разрешить обновления: Option = um.check_for_updates()?; - if update.is_none() { - return Ok(()); // нет доступных обновлений - } - - // скачиваем обновления - let update = update.unwrap(); - um.download_updates(&updates, |progress| { - println!("Прогресс загрузки: {}%", Progress); - })?; - - // применяем обновления - um.apply_updates_and_restart(&updates, RestartArgs::None)?; - Ок(()) - } - ``` - -4. Создайте свое приложение с помощью Cargo: - ```sh - сборка груза -- выпуск - ``` - -5. Установите инструмент командной строки `vpk`: - ```sh - обновление инструмента dotnet -g vpk - ``` - :::tip - **_Для использования и обновления `vpk`_** - у вас должен быть установлен .NET Core SDK 6 ::: - -6. Упакуйте релиз/установщики Velopack: - ```sh - vpk package -u MyAppUniqueId -v 1.0.0 -p /target/release -e myexename.exe - ``` - -✅ Готово! Теперь в вашем приложении есть автоматические обновления и установщик. -Вы можете загрузить свой релиз на свой веб-сайт или использовать команду `vpk upload`, чтобы опубликовать его в выбранном вами месте. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/index.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/index.mdx deleted file mode 100644 index 01389a3..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/index.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -disable_comments: true ---- - -# Введение - -Velopack — это платформа установки и автоматического обновления кроссплатформенных настольных приложений. Он самоуверенный, чрезвычайно простой в использовании и не требует настройки. С помощью всего лишь одной команды вы можете запустить и запустить устанавливаемое приложение, и это также будет молниеносно для ваших пользователей. - -Обязательно посетите нас на [GitHub](https://github.com/velopack/velopack) и [присоединяйтесь к нашему Discord](https://discord.gg/CjrCrNzd3F), чтобы задать любые вопросы или получить поддержку! - -## Обзор - -Чтобы ваше приложение могло в полной мере использовать Velopack, вам необходимо сделать 3 вещи: - - -### Интегрируйте SDK и проверьте наличие обновлений -У нас есть клиентские библиотеки для некоторых [языков ниже](#language-support), или если мы не поддерживаем ваши язык, но вы можете использовать [наш CLI](./getting-started/fusion-cli.mdx).
-[Читать далее →](integrating/overview.mdx) - - - -### Сборка выпуска Velopack -Наш инструмент командной строки `vpk` может помочь вам собрать пакеты обновлений и установщики всего одной командой.
-[Читать далее →](packaging/overview.mdx) - - - -### Загрузите свои релизы куда-нибудь -Вы можете размещать обновления везде, где могут быть размещены статические файлы, например. облачное хранилище файлов, выпуски GitHub и многое другое.
-[Читать далее →](distributing/overview.mdx) - - -## Языковая поддержка - -Для языков, указанных ниже, запланированы или поддерживаются библиотеки. - -| Ланг | Положение дел | Отделы времени выполнения | Асинхронный | Ссылки | | -| :------: | ------------- | ------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | - | -| С# | ✅ Готово | ✅ Нет | ✅ Да | [быстрый старт](./getting-started/csharp.mdx), [документы](./reference/cs/Velopack/), [примеры]\(https://github.com/velopack/velopack/tree/master/ примеры), [nuget.org](https://nuget.org/packages/velopack) | | -| JS | ✅ Готово | ✅ Нет | ✅ Да | [быстрый старт](./getting-started/electron.mdx), [документы](./reference/js/classes/UpdateManager.md), [примеры]\(https://github.com/velopack/velopack.fusion /tree/master/for-js/samples), [npmjs.com](https://www.npmjs.com/package/velopack) | | -| Ржавчина | ✅ Готово | ✅ Нет | ✅ Да | [быстрый старт](./getting-started/rust.mdx), [документация](https://docs.rs/velopack), [примеры]\(https://github.com/velopack/velopack.fusion/tree /master/for-rust/samples), [crates.io](https://crates.io/crates/velopack) | | -| С++ | ✅ Готово | 🔶 vfusion.exe | ❌ Нет | [быстрый старт](./getting-started/cpp.mdx), [документы](./reference/cpp/api.md), [примеры]\(https://github.com/velopack/velopack.fusion/tree /master/for-cpp/samples), [velopack.hpp](https://github.com/velopack/velopack.fusion/tree/master/for-cpp) | | -| Джава | Планируется | - | - | - | - | -| Питон | Планируется | - | - | - | - | -| Быстрый | Планируется | - | - | - | - | -| Идти | Планируется | - | - | - | - | - -:::info -Если вашего языка нет в списке, вы можете [**открыть проблему и запросить ее**](https://github.com/velopack/velopack.fusion/issues), -или если ваш язык поддерживает запуск процесс, который вы можете [**интегрировать напрямую с Fusion CLI**](./getting-started/fusion-cli.mdx). -::: - - diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/integrating/hooks.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/integrating/hooks.mdx deleted file mode 100644 index c47997e..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/integrating/hooks.mdx +++ /dev/null @@ -1,31 +0,0 @@ -# Привязки приложений - - - -Хуки позволяют вашему приложению запускать логику на различных этапах процесса установки/обновления/удаления. - -В общем, я не рекомендую пытаться обрабатывать хуки вручную — вместо этого обратитесь к доступным опциям [VelopackApp](../reference/cs/Velopack/VelopackApp.md). - -Если вы хотите справиться с этим самостоятельно, SDK для вашего языка не существует или вы просто хотите узнать о нем больше, читайте дальше. - -## Перехватчики командной строки - -На различных этапах процесса установки/обновления/удаления Velopack выполнит ваш основной исполняемый файл (тот, который указан при упаковке с помощью `--mainExe {exeName}`) с определенными аргументами командной строки и ожидает, что ваше приложение завершит работу как можно быстрее. . - -- `--veloapp-install {version}` Происходит после распаковки программы, но до завершения установки. Приложение должно обработать и выйти в течение 30 секунд. -- `--veloapp-obsolete {version}` Запускается в старой версии приложения до применения обновления. Приложение должно обработать и выйти в течение 15 секунд. -- `--veloapp-updated {version}` Запускается в новой версии приложения после применения обновления. Приложение должно обработать и выйти в течение 15 секунд. -- `--veloapp-uninstall {version}` Запускается перед удалением. Приложение должно обработать и выйти в течение 30 секунд. - -В настоящее время во время перехватчиков нет возможности оставить отзыв о том, что вы хотели бы отменить установку/удаление/обновление и т. д., и вы не можете показывать пользователю какой-либо пользовательский интерфейс. - -:::warning -Если ваше приложение получит один из этих аргументов и не завершится в течение отведенного времени, оно будет уничтожено. -::: - -## Перехваты переменных среды - -Также устанавливаются две переменные среды, если они обнаружены, вашему приложению не нужно завершать работу. - -- `VELOPACK_FIRSTRUN` имеет значение true, если это первый запуск после установки приложения. -- `VELOPACK_RESTART` имеет значение true, если приложение было перезапущено Velopack (обычно из-за применения обновления). diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/integrating/overview.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/integrating/overview.mdx deleted file mode 100644 index 8e35e9a..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/integrating/overview.mdx +++ /dev/null @@ -1,132 +0,0 @@ ---- -sidebar_label: Обзор -sidebar_position: 0 ---- - -# Обзор интеграции - - - -Чтобы интегрировать Velopack в ваше приложение, вы _должны_ инициализировать Velopack как можно раньше при запуске приложения и _должны_ добавить куда-нибудь код проверки обновлений. - -Для приложений .NET сначала следует установить [Пакет Velopack Nuget](https://nuget.org/packages/velopack). - -## Запуск приложения - -Velopack требует, чтобы вы добавили некоторый код при запуске приложения для обработки перехватчиков. Это связано с тем, что Velopack будет запускать ваш основной двоичный файл на определенных этапах процесса установки/обновления со специальными аргументами, чтобы вы могли настроить поведение. Он ожидает, что ваше приложение правильно отреагирует на эти аргументы и завершится как можно скорее. - -Самый простой/минимальный способ справиться с этим должным образом — добавить код запуска SDK в ваш метод Main(). Он должен находиться в «основном» двоичном файле (тот, который указан при упаковке с помощью `--mainExe {exeName}`). - -```cs -static void Main(string[] args) -{ - VelopackApp.Build().Run(); - // ... ваш другой код запуска ниже -} -``` - -Здесь вы можете указать множество опций/обратных вызовов для настройки Velopack, например: - -```cs -static void Main(string[] args) -{ - ILogger log = CreateLogger(); - VelopackApp.Build() - .WithBeforeUninstallFastCallback((v) => { - // delete / clean up some files before uninstallation - }) - .WithFirstRun((v) => { - MessageBox.Show("Thanks for installing my application!"); - }) - .Run(log); -} -``` - -Полный список опций [для VelopackApp доступен здесь](../reference/cs//Velopack/VelopackApp.md). Вы также можете узнать больше о [как работают хуки] \(./hooks.mdx). - -:::warning -«FastCallback» требует, чтобы ваше приложение не отображало пользовательский интерфейс и быстро закрывалось. Когда обратный вызов вернется, ваше приложение завершится. Если вы не завершите этот обратный вызов достаточно быстро, ваш процесс будет завершен. -::: - -## Настройка обновлений - -Обновления можно выполнить, добавив [UpdateManager](../reference/cs/Velopack/UpdateManager.md) в ваше приложение: - -```cs -частная статическая асинхронная задача UpdateMyApp() -{ - var mgr = new UpdateManager("https://the.place/you-host/updates"); - - // проверка наличия новой версии - var newVersion = await mgr.CheckForUpdatesAsync(); - if (newVersion == null) - return; // обновление отсутствует - - // загрузка новой версии - await mgr.DownloadUpdatesAsync(newVersion); - - // устанавливаем новую версию и перезапускаем приложение - mgr.ApplyUpdatesAndRestart(newVersion); -} -``` - -:::tip -Обновления могут выполняться автоматически в фоновом режиме или интегрироваться в пользовательский интерфейс вашего приложения. Это всегда зависит от вас. -::: - -Вы можете размещать пакеты обновлений где угодно, вот несколько примеров: - -- Локальный каталог:
`new UpdateManager("C:\Updates")` -- HTTP-сервер или S3, хранилище Azure и т. д.:
`new UpdateManager("https://the.place/you-host/updates")` -- Релизы GitHub:
`new UpdateManager(new GitHubSource("https://github.com/yourName/yourRepo")` - -Существует множество встроенных источников (например, [GithubSource](../reference/cs/Velopack.Sources/GithubSource.md), [SimpleWebSource](../reference/cs/Velopack.Sources/SimpleWebSource.md). )) вы можете использовать при проверке обновлений, но вы также можете создать свои собственные, [на основе IUpdateSource](../reference/cs/Velopack.Sources/IUpdateSource.md). - -### Проверьте наличие обновлений - -CheckForUpdatesAsync прочитает предоставленный источник обновлений для файла Releases.{channel}.json\` файл для получения доступных обновлений ([Читать о каналах](../packaging/channels.mdx)). Если доступно обновление, будет возвращен непустой [UpdateInfo](../reference/cs/Velopack/UpdateInfo.md) с некоторыми подробностями об обновлении. Вы также можете [получить любые примечания к выпуску](release-notes.mdx), которые были предоставлены при упаковке обновления. - -Существуют [также некоторые параметры](../reference/cs/Velopack/UpdateOptions.md), которые можно передать в [UpdateManager](../reference/cs/Velopack/UpdateManager.md), чтобы настроить обработку обновлений. , напр. чтобы разрешить такие вещи, как [переключение каналов](switching-channels.mdx). - -### Загрузка обновлений - -DownloadUpdatesAsync попытается загрузить изменения (если они доступны) и воссоздать последнюю полную версию. Если доступных изменений нет или дельта-реконструкция не удалась, вместо этого будет загружен последний полный пакет выпуска. Обратите внимание: если указана такая опция, как «AllowVersionDowngrade», загруженная версия может быть старше, чем выполняющаяся в данный момент версия. - -### Применить обновления - -После загрузки обновления у вас появится несколько доступных вариантов. Вызов «ApplyUpdatesAndRestart» или «ApplyUpdatesAndExit» приведет к выходу из вашего приложения, установке всех [предварительных требований для начальной загрузки] \(../packaging/bootstrapping.mdx), установке обновления, а затем, при необходимости, сразу же перезапустите приложение. - -Если вы не хотите немедленно выходить из приложения, вы можете вместо этого вызвать WaitExitThenApplyUpdates, который запустит Update.exe и подождет 60 секунд, прежде чем продолжить. Если ваше приложение не закроется в течение 60 секунд, оно будет закрыто. - -Наконец, если вы не вызываете ни один из этих методов «Применить», то при перезапуске приложения Velopack по умолчанию обнаружит наличие ожидающего обновления и установит его. Если вы хотите отключить это, вам следует вызвать `VelopackApp.Build().SetAutoApplyOnStartup(false)`. - -:::tip -Рекомендуется использовать одну из функций, которая явно применяет пакет (например, «ApplyUpdatesAndRestart»), и не полагаться на поведение AutoApply как на практическое правило. Автоматическое поведение будет применять только загруженную версию, если она> установленной в данный момент версии, поэтому не будет работать при попытке понизить версию или переключить каналы, и если запущено более одного экземпляра вашего процесса, это может привести к сбою обновления или другие процессы завершаются. -::: - -## Как работают обновления - -### В Windows - -При типичной установке Windows структура приложения будет выглядеть следующим образом: - -``` -%LocalAppData% -└── {packId} - ├── текущий - │ ├── YourFile.dll - │ ├── sq. версия - │ └── YourApp.exe - └── Update.exe -``` - -`sq.version` — это специальный файл, созданный Velopack, который содержит некоторые метаданные об установленном вами в данный момент приложении. Во время установки/удаления вся папка `{packId}` заменяется или удаляется. Во время обновлений заменяется только текущая папка. Если вы сохраните настройки в той же папке, что и основной двоичный файл, они будут удалены во время обновлений. - -:::warning -Поскольку «текущая» версия заменяется новой версией во время обновлений, хранить настройки, журналы и т. д. в «текущем» каталоге, где находится ваше приложение, небезопасно. Дополнительную информацию см. в разделе **_[Сохранение файлов](./preserved-files.mdx)_**. -::: - -### В Linux и Mac - -На этих платформах приложение хранится как один пакет (обычно доступный только для чтения), например `.app` или `.AppImage`. Пакет заменяется во время обновлений одной атомарной операцией. -Если у вас есть какие-либо файлы, которые вы хотите сохранить (настройки, журналы и т. д.), вам необходимо найти каталог в другом месте файловой системы для хранения этих файлов. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/integrating/preserved-files.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/integrating/preserved-files.mdx deleted file mode 100644 index 49ca432..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/integrating/preserved-files.mdx +++ /dev/null @@ -1,22 +0,0 @@ -# Сохранение файлов и настроек - - -Двоичные файлы вашего приложения полностью заменяются во время обновлений, поэтому вам не следует хранить важные файлы в том же каталоге, что и двоичные файлы вашего приложения. - -## Настройки приложения - -Если вы хотите создать настройки, которые сохраняются при обновлениях, но стираются при удалении приложения, в Windows вам следует хранить их на уровень выше (`..\`) за пределами `текущего` каталога. - -Если вы хотите создавать файлы, которые сохраняются, даже если приложение удалено (например, важные пользовательские настройки), вам следует хранить их в `%AppData%\{packId}` (это **_данные перемещаемого приложения_ **, а не локальные данные приложения, в котором оно находится). - -## Sentry / Crashpad / Отчеты об ошибках - -Многие утилиты обработки сбоев по умолчанию сохраняют отчеты об ошибках/сбоях в каталоге приложения и загружают их в виде отчета при следующем запуске приложения. - -Вам необходимо убедиться, что любая из этих библиотек может быть настроена с использованием каталога базы данных/хранилища где-то за пределами текущего каталога приложения. -В Windows вам просто нужно находиться за пределами каталога `%LocalAppData\{packId}\current`. Таким образом, вы можете использовать `..\` (это то же самое, что `%LocalAppData\{packId}`). - -## Не-Windows - -Для других операционных систем, отличных от Windows, вам следует поискать в Интернете рекомендации о том, где хранить настройки/файлы журналов для установленных приложений. -Рекомендуемое расположение зависит от ОС/дистрибутива и может находиться в `/var` или где-нибудь в домашнем каталоге пользователя `~` (например, `~/Library/Application Support` в MacOS). diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/integrating/release-notes.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/integrating/release-notes.mdx deleted file mode 100644 index 3c0792a..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/integrating/release-notes.mdx +++ /dev/null @@ -1,23 +0,0 @@ -# Примечания к выпуску - - -Можно хранить примечания к выпуску (Markdown) в пакетах обновлений и получать к ним доступ во время обновления. Это может быть полезно, например, чтобы показать пользователю список изменений перед загрузкой обновления. - -- Запишите примечания к выпуску в файл (например, Releasenotes.mdx). -- Упаковывая релиз, предоставьте его Velopack с помощью `--releaseNotes {path/to/releasenotes.md}` - -Конструктор Velopack для вашего удобства преобразует это в HTML и сохранит HTML и уценку в вашем пакете обновления. - -Теперь при проверке обновлений будут доступны примечания к выпуску, например: - -```cs -частная статическая асинхронная задача UpdateMyApp() -{ - var mgr = new UpdateManager("https://the.place/you-host/updates"); - - вар newVersion = ждут mgr.CheckForUpdatesAsync(); - if (newVersion != null) { - new ReleaseNotesHtmlWindow(newVersion.TargetFullRelease.ReleaseNotesHtml).Show(); - } -} -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/integrating/shortcuts.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/integrating/shortcuts.mdx deleted file mode 100644 index f15c481..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/integrating/shortcuts.mdx +++ /dev/null @@ -1,19 +0,0 @@ -# Ярлыки Windows - - -По умолчанию во время установки Velopack создаст ярлык на рабочем столе и в StartMenuRoot. Он автоматически удалит все ярлыки, которые обнаружит при удалении приложения. - -Имя ярлыков будет определяться аргументом vpk `--packTitle`. Например, если вы передадите `--packTitle "My Fancy App"`, то созданные ярлыки будут созданы как `"My Fancy App.lnk"`. - -Если вам нужно создать ярлыки в каких-либо дополнительных местах, предусмотрены классы Velopack.Windows.Shortcuts и Velopack.Windows.ShellLink. Эти классы предоставляются по причинам устаревшего характера, и в целом стабильность таких функций не гарантируется. - -Например, если вы хотите создать ярлык во время установки приложения, вы можете сделать следующее: - -```cs -использование Велопака; -с помощью Velopack.Windows; - -VelopackApp.Build() - .WithAfterInstallFastCallback((v) => new Shortcuts().CreateShortcutForThisExe(ShortcutLocation.Desktop)) - .Run() -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/integrating/switching-channels.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/integrating/switching-channels.mdx deleted file mode 100644 index 4a2195f..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/integrating/switching-channels.mdx +++ /dev/null @@ -1,30 +0,0 @@ -# Переключение каналов - - -По умолчанию `UpdateManager` попытается найти выпуски в том же канале, для которого он был создан. Вы можете [подробнее узнать об упаковке каналов здесь](../packaging/channels.mdx). Поэтому обычно вам вообще не следует предоставлять канал конструктору UpdateManager. - -Однако время от времени может оказаться полезным разрешить пользователю переключать каналы без переустановки приложения. Например, пользователь соглашается на получение «бета-функций» через настройки вашего приложения. В этом случае вы можете указать канал явно: - -```cs -новый UpdateManager("https://the.place/you-host/updates", новый UpdateOptions { - ExplicitChannel = "beta" -}); -``` - -Кроме того, по умолчанию UpdateManager будет обновляться только до версий, более новых, чем текущая, что приводит к неоптимальному поведению, поскольку часто вы можете переключиться на версию, которая ниже текущей. Представьте себе следующий сценарий: - -- Вы публикуете версию 2.0.0 на «стабильном» канале. -- Вы публикуете версии с 2.0.1 по 2.0.5 на бета-канале. -- Ваш пользователь устанавливает «стабильную» версию 2.0.0, а затем соглашается на «бета-версию» через настройки. -- Ваш пользователь может обновиться с 2.0.0 -> 2.0.5, потому что 2.0.5 — более новая версия. -- Ваш пользователь обнаружил ошибку и отключил бета-версию в настройках. -- По умолчанию UpdateManager не устанавливает стабильную версию 2.0.0, поскольку это более ранняя версия, чем 2.0.5. - -Именно по этой причине я рекомендую всегда использовать параметр «ExplicitChannel» с параметром «AllowVersionDowngrade». Например: - -```cs -новый UpdateManager("https://the.place/you-host/updates", new UpdateOptions { - ExplicitChannel = "beta", - AllowVersionDowngrade = true, -}); -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/migrating/squirrel.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/migrating/squirrel.mdx deleted file mode 100644 index 5ec1647..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/migrating/squirrel.mdx +++ /dev/null @@ -1,70 +0,0 @@ -# От Белки - - -Перенесите `Squirrel.Windows` или `Clowd.Squirrel` в Velopack. - -Вот общие необходимые шаги: - -1. Замените пакет nuget Squirrel.Windows или Clowd.Squirrel последней версией [Пакет Velopack NuGet] \(https://www.nuget.org/packages/velopack). - -2. Установите инструмент командной строки `vpk`, так как именно его вы будете использовать для сборки выпусков Velopack. - ```cmd - установка инструмента dotnet -g vpk - ``` - -3. Вам нужно будет заменить `SquirrelAwareApp` в начале вашего приложения на `VelopackApp.Build().Run()`. Ярлыки [\[Подробнее\]](integrating/shortcuts.mdx) и записи реестра управляются автоматически в Velopack, поэтому, если вы сейчас делаете это в хуках `SquirrelAwareApp`, их следует удалить. Например, если раньше ваши крючки были такими: - - ```cs - public static void Main(string[] args) - { - SquirrelAwareApp.HandleEvents( - onInitialInstall: OnAppInstall, - onAppUninstall: OnAppUninstall, - onEveryRun: OnAppRun); - } - - Private static void OnAppInstall (версия SemanticVersion, инструменты IAppTools) - { - инструменты.CreateShortcutForThisExe(ShortcutLocation.StartMenu | ShortcutLocation.Desktop); - } - - Private static void OnAppUninstall (версия SemanticVersion, инструменты IAppTools) - { - инструменты.RemoveShortcutForThisExe(ShortcutLocation.StartMenu | ShortcutLocation.Desktop); - } - - Private static void OnAppRun(версия SemanticVersion, инструменты IAppTools, bool firstRun) - { - if (firstRun) MessageBox.Show("Спасибо за установку моего приложения !"); - } - ``` - - Затем вы должны перейти к следующему коду, удалив ярлыки: - - ```cs - public static void Main(string[] args) - { - // Благодарим пользователя за установку приложения при первом запуске. - // Обратите внимание, что приведенный ниже класс MessageBox взят из WinForms или WPF. - VelopackApp.Build() - .WithFirstRun(v => MessageBox.Show("Спасибо за установку моего приложения!")) - .Run(); - } - ``` - -4. Понятие `SquirrelAwareApp` больше не существует, поэтому, если вы добавили какие-либо атрибуты, записи манифеста сборки или другие файлы, чтобы указать, что ваш двоичный файл теперь поддерживает, вы можете удалить их. Каждый пакет Velopack имеет ровно один двоичный файл VelopackApp, который должен реализовывать указанный выше интерфейс в верхней части Main. По умолчанию Velopack будет искать двоичный файл в `{packDir}\{packId}.exe`. Если ваш основной exe-файл VelopackApp имеет другое имя, вам следует указать имя с аргументом `--mainExe yourApp.exe`. - -5. Файл «RELEASES» больше не является форматом, который использует Velopack, но он будет создавать его при сборке пакетов в Windows с каналом по умолчанию (например, без указания аргумента канала). Вместо этого Velopack будет выпускать «релизы».{channel}.json\` файлы, с которыми следует обращаться таким же образом. Если вы хотите, чтобы устаревшее приложение Windows было перенесено на Velopack, вам следует загрузить как файл RELEASES, так и файл Releases.win.json, созданный Velopack, в свой канал обновлений. - -6. В целом командная строка поддерживает все те же функции, но имена аргументов или команд могут измениться. Velopack больше не поддерживает использование файла .nupkg, созданного dotnet или nuget.exe. Вам следует опубликовать свое приложение и вместо этого использовать vpk package. Очень простой пример может выглядеть так - - ```cmd - dotnetPublish --self-contined -r win-x64 -o опубликовать - vpk package -u YourAppId -v 1.0.0 -p опубликовать -e yourMainBinary.exe - ``` - - Пожалуйста, просмотрите справку по командной строке vpk для получения более подробной информации: - - ```cmd - впк -ч - ``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/bootstrapping.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/packaging/bootstrapping.mdx deleted file mode 100644 index 6b50f72..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/bootstrapping.mdx +++ /dev/null @@ -1,86 +0,0 @@ -# Начальная загрузка - - -Установите .NET, vcredist, webview2 и другие приложения при установке приложений Velopack в Windows с использованием аргумента `--framework` / `-f`. - -Можно указать более одного требования, используя список, разделенный запятыми. Например: - -```cmd -пакет vpk... --framework net6.0-x64-desktop,vcredist142-x64 -``` - -Эти зависимости будут загружены и установлены до установки вашего приложения. - -:::warning -Если вы создаете приложение dotnet с `--self-contained`, вам не следует **НЕ** предоставлять аргумент `--framework`, указывающий, что ваше приложение требует установки dotnet, поскольку в ваше приложение уже встроена среда выполнения. Если вы публикуете свое приложение с `--no-self-contained`, вам следует указать аргумент `--framework`. -::: - -## Добавление зависимостей во время обновлений - -Перед применением новых обновлений Velopack проверит, установлены ли все необходимые зависимости. Это означает, что если в новую версию вашего приложения добавляется новая зависимость, пользователю будет предложено установить ее перед применением новой версии. - -## Список поддерживаемых фреймворков - -Любое из следующего может быть передано через аргумент --framework. - -### Пограничный веб-представление2 - -- `webview2` - -### vcredist - -- `vcredist100-x86` (VC++ 10.0/VS 2010) -- `vcredist100-x64` (VC++ 10.0/VS 2010) -- `vcredist110-x86` (VC++ 11.0/VS 2012) -- `vcredist110-x64` (VC++ 11.0/VS 2012) -- `vcredist120-x86` (VC++ 12.0/VS 2013) -- `vcredist120-x64` (VC++ 12.0/VS 2013) -- `vcredist140-x86` (VC++ 14.0/VS 2015) -- `vcredist140-x64` (VC++ 14.0/VS 2015) -- `vcredist141-x86` (VC++ 14.1/VS 2017) -- `vcredist141-x64` (VC++ 14.1/VS 2017) -- `vcredist142-x86` (VC++ 14.2/VS 2019) -- `vcredist142-x64` (VC++ 14.2/VS 2019) -- `vcredist143-x86` (VC++ 14.3/VS 2022) -- `vcredist143-x64` (VC++ 14.3/VS 2022) -- `vcredist143-arm64` (VC++ 14.3/VS 2022) - -### .NET Framework - -- `net45` -- `net451` -- `net452` -- `net46` -- `net461` -- `net462` -- `net47` -- `net471` -- `net472` -- `net48` -- `net481` - -### дотнет - -Поддерживается каждая версия dotnet >= 5.0. Аргумент framework должен быть указан в формате `$"net{major.minor}-{arch}-{type}"`. - -Допустимые значения `{arch}`: - -- х86 -- х64 -- рука64 - -Допустимые значения `{type}`: - -- время выполнения -- aspnetcore -- рабочий стол - -Вот некоторые примеры: - -- .NET 6.0 Desktop Runtime (x64) `--framework net6.0-x64-desktop` -- Среда выполнения .NET 8.0 (arm64) `--framework net8.0-arm64-runtime` -- .NET 5.0 AspNetCore (x86) `--framework net5.0-x86-aspnetcore` - -По умолчанию Velopack принимает любую установленную версию, но всегда устанавливает последнюю версию. То есть, если ваша зависимость указана как `net6.0-x64-desktop` и установлена версия `6.0.2`, она будет принята. Если он не установлен, Velopack загрузит последнюю доступную версию (на момент написания это «6.0.26»). - -Если вам нужна определенная версия dotnet (например, «6.0.11»), вы можете указать третью часть версии в строке зависимости: «--framework net6.0.11-x64-desktop». В этом случае, если установлена версия `< 6.0.11`, она будет обновлена до последней доступной. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/channels.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/packaging/channels.mdx deleted file mode 100644 index d1ba244..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/channels.mdx +++ /dev/null @@ -1,41 +0,0 @@ -# Каналы выпуска - - -Каналы — это фундаментальная часть того, как Velopack понимает и создает релизы. Каждый выпуск должен принадлежать каналу. Если вы не укажете канал при создании выпуска (с помощью аргумента `--channel`), каналом по умолчанию будет имя целевой операционной системы (например, `win`, `osx` или `linux`). . - -При создании релизов Velopack создаст файл Releases.{channel}.json`файл, который следует загрузить вместе с другими вашими ресурсами (например,`.nupkg`). Вот как `UpdateManager\` узнает, какие версии доступны. - -В общем, вам не следует предоставлять канал конструктору UpdateManager (оставьте его нулевым). В этом случае он будет искать пакеты обновлений только в том же канале, для которого была создана текущая версия. Например, если вы предоставили аргумент `--channel стабильный` для `vpk` и установили приложение, то `UpdateManager` будет автоматически искать файл `releases.stable.json` при проверке наличия обновлений. - -:::tip -Для устаревших целей Velopack также создаст файл `RELEASES` (для канала `win`) или файл `RELEASES-{channel}` (для любого другого канала). Развертывая эти файлы, а также файлы Releases.{channel}.json\` позволит устаревшим приложениям обновляться до Velopack. Если у вас нет пользователей устаревших версий вашего программного обеспечения, вы можете игнорировать эти файлы. -::: - -## Переключение каналов в установленных приложениях - -Часто желательно предоставить пользователям возможность легко переключать каналы. Например, если ваши пользователи скачали установщик «стабильной» версии вашего приложения, они будут получать обновления только для «стабильного» канала. Позже они решают переключиться на «бета-канал», чтобы опробовать некоторые экспериментальные функции вашего приложения. - -Это можно сделать, указав ненулевой аргумент канала конструктору UpdateManager. Таким образом, вы должны создать экземпляр `new UpdateManager("https://the.place/you-store/updates", "beta")`, а затем выполнить процесс обновления как обычно. - -## Развертывание кроссплатформенных приложений - -При развертывании кросс-платформенных (или кросс-архитектурных) приложений важно, чтобы каждая уникальная ОС/rid имела собственный канал. Было бы нехорошо, если бы ваше приложение для Windows попыталось установить пакет OSX и т. д.! - -Каналами по умолчанию являются `win`, `osx` или `linux`, поэтому, если вы распространяете только один выпуск на каждую платформу, вам не нужно указывать аргумент канала, все должно работать автоматически. Если вы распространяете функциональные каналы (например, «стабильная», «бета») или вам необходимо распространять несколько версий вашего приложения для каждой ОС (например, «win-x64», «win-arm64»), вам необходимо определить стратегия канала, которая не конфликтует. - -Например, если бы я распространял приложение для Windows и OSX, которое должно было поддерживать x64 и Arm64, а также поддерживать «стабильную» и «бета-версию», то мне понадобились бы следующие 8 каналов: - -- Win-x64-стабильный -- Win-x64-бета -- win-arm64-стабильный -- победа-arm64-бета -- OSX-x64-стабильный -- OSX-x64-бета -- OSX-ARM64-стабильный -- OSX-ARM64-бета - -## Переименование канала - -Вы не можете переименовать канал по отдельности, но можете заменить его (т. е. заставить всех ваших пользователей переключиться на новый канал). Представьте, что до сих пор вы публиковали приложение, которое поддерживает только Windows x64, на «стабильном» канале, но теперь вы хотите выпустить версию своего приложения для Arm64. Итак, вы хотите перевести всех пользователей со «стабильной» версии на «win-x64», а также создать новый канал с именем «win-arm64». - -Вам следует опубликовать следующее обновление (скажем, v2.0.0), используя `--channel win-x64`, что создаст новый файл `releases.win-x64.json`. Теперь вы можете скопировать этот файл, переименовать его в Releases.stable.json и развернуть оба файла вместе с файлом v2.0.0 `.nupkg` на сервере обновлений. Любые пользователи «стабильного» канала найдут файл «releases.stable.json» и обновятся до вашей версии v2.0.0 win-x64, а после этого будут искать будущие обновления по адресу «releases.win-x64.json». Вам нужно сделать это только один раз, вам не нужно будет снова обновлять файл Releases.stable.json, однако вы, возможно, не захотите его удалять, чтобы пользователи, которые не открывали ваше приложение какое-то время, могли найти новые обновления. . diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/deltas.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/packaging/deltas.mdx deleted file mode 100644 index 0d432de..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/deltas.mdx +++ /dev/null @@ -1,47 +0,0 @@ -# Дельта-обновления - - -Дельта-обновления обеспечивают быстрые обновления даже для самых крупных приложений. - -По умолчанию, пока в вашем каталоге `--outputDir`/`-o` есть предыдущая версия, Velopack автоматически генерирует дельту при создании новой версии. - -:::tip -Если у вас нет последней локальной версии, например. вы работаете в CI, вы можете использовать команду vpk download для автоматического получения данных и создания дельта-файлов. -::: - -Дельта-пакеты используют [Zstandard](https://github.com/facebook/zstd) для создания бинарных исправлений отдельных файлов в вашем пакете. Из-за ограничений Zstandard размер отдельного файла не может превышать 2 ГБ. - -## Оптимизация размера - -Параметры по умолчанию, выбранные для создания патчей, должны обеспечить хороший баланс размера и скорости. -Если вы хотите оптимизировать размер, вы можете сделать это с помощью аргумента --delta BestSize. -YMMV, для некоторых приложений это может дать вам большую экономию, а для других — нет. В любом случае это будет намного медленнее, примерно на уровне алгоритма bsdiff. - -## Как работает Дельта - -Во время обновлений Velopack будет искать, возможно, более одной дельты для загрузки. Представьте, что вы опубликовали следующие выпуски: - -- `1.0.0` -- `1.0.1` -- `1.0.2` -- `1.0.3` - -Если пользователь какое-то время не открывал ваше приложение и у него установлено `1.0.0`, при следующем открытии приложения будут загружены -3 дельты: `1.0.1-delta`, \`1.0 .2-дельта» и «1.0.3-дельта». - -Ранее загруженный/установленный пакет хранится в `%LocalAppData\{packId}\packages`, поэтому Velopack затем последовательно применит эти 3 дельты -поверх локального пакета, который существует в этом каталог. - -После применения изменений и восстановления версии 1.0.3 она будет готова к применению. - -В Velopack есть эвристика, которая пытается решить, лучше ли загрузить N delta или вместо этого загрузить последнюю полную версию. -Это основано на ряде факторов (например, размер полной версии, размер суммы дельт, общее количество дельт между текущей и целевой версией). - -## Релизы на GitHub - -Существует специальная поддержка выпусков GitHub в «UpdateManager», который будет искать доступные изменения в ряде предыдущих выпусков GitHub. -Это означает, что любой выпуск GitHub должен содержать только 1 полный пакет и 1 дельта-обновление, чтобы обеспечить правильное обновление. - -## Отключение дельты - -Если по какой-то причине вы не хотите использовать дельты, вы можете отключить их с помощью аргумента `--delta none`. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/installer.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/packaging/installer.mdx deleted file mode 100644 index 0f83c47..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/installer.mdx +++ /dev/null @@ -1,52 +0,0 @@ -# Монтажники - - -Velopack относительно легко обращается с установщиками, поэтому здесь не так много доступных настроек, как в других установочных средах. Это компромисс, на который Velopack идет, чтобы обеспечить максимально быструю и простую работу разработчика и пользователя. - -В обеих операционных системах, если [настроена подпись кода](signing.mdx), установщик также будет подписан. (Это _обязательно_ в MacOS) - -## Обзор Windows - -Установщик Windows в настоящее время представляет собой установщик «одним щелчком», то есть при запуске двоичного файла `Setup.exe` Velopack не будет показывать пользователю никаких вопросов или мастеров, он просто попытается установить приложение как можно быстрее и затем запустите его. - -Программа установки по умолчанию установит ярлыки для «StartMenuRoot» и «Рабочий стол». [\[Подробнее\]](../integrating/shortcuts.mdx) - -Ключевые параметры, которые позволяют настроить установщик, следующие: - -- `--packTitle {app name}` настраивает имена ярлыков, имя приложений и функций и имя exe-файла переносимой записи. -- `--icon {path}` устанавливает .ico для Update.exe и Setup.exe (а также значок всех отображаемых диалоговых окон) -- `--splashImage {path}` устанавливает (возможно, анимированную) заставку, которая будет отображаться во время установки. - -Заставка может быть в формате «jpeg», «png» или «gif». В последнем случае он будет анимирован. - -Вы также можете [загрузить необходимые платформы] \(bootstrapping.mdx) перед установкой приложения. - -Установщик Windows распакует приложение в `%LocalAppData%\{packId}`, и структура каталогов будет выглядеть так: - -``` -{packId} -├── текущий -│ ├── YourFile.dll -│ ├── sq.version -│ └── YourApp.exe -└── Update.exe -``` - -Текущий каталог будет полностью заменен [при выполнении обновлений] \(../integrating/overview.mdx). Два других файла, добавленные Velopack («Update.exe» и «sq.version»), имеют решающее значение и необходимы для того, чтобы Velopack мог правильно обновить ваше приложение. - -## Обзор MacOS - -Установщик MacOS будет представлять собой стандартный файл «.pkg» — это просто пакет, в котором пользовательский интерфейс предоставляется операционной системой, что позволяет пользователю выбрать место установки. Приложение будет запущено автоматически после установки (зеркало поведения в Windows) благодаря сценарию «postinstall», добавленному Velopack. - -Ключевые параметры, которые позволяют настроить установщик, следующие: - -- `--packTitle {app name}` настраивает имя пакета `.app` и имя приложения, отображаемое в `.pkg` -- `--pkgWelcome {path}` добавляет страницу приветствия -- `--pkgReadme {path}` добавляет страницу Readme -- `--pkgLicense {path}` добавляет страницу принятия лицензии -- `--pkgConclusion {path}` добавляет страницу заключения -- `--noPkg` полностью отключить создание установщика `.pkg` - -Аргументы pkgPage могут быть файлами .rtf или .html. - -Пакет `.app` может быть извлечен в `/Applications` или `~/Applications`, это выбирается пользователем при установке. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/operating-systems/linux.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/packaging/operating-systems/linux.mdx deleted file mode 100644 index 31d9975..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/operating-systems/linux.mdx +++ /dev/null @@ -1,48 +0,0 @@ -# Обзор Linux - - -Специальные замечания для Linux о создании и использовании пакетов Velopack. - -В Linux Velopack не создает установщик, он просто создает файл .AppImage. - -Пользователь будет: - -- Загрузите файл `.AppImage`. -- Установите разрешение с помощью `chmod +x YourFile.AppImage` -- Запустите с помощью `./YourFile.AppImage` - -## Упаковка - -Для создания AppImage требуется значок, в идеале он должен быть в формате PNG. Это можно предоставить с помощью аргумента `--icon`. - -`vpk` может автоматически полностью создать для вас структуру AppImage/AppDir, учитывая ваш обычный каталог сборки. -При желании вы можете предварительно создать структуру AppImage/AppDir в соответствии с [следующей спецификацией](https://github.com/AppImage/AppImageKit/wiki/AppDir). -Если вы подготовили свой AppDir, используйте аргумент `--appDir` _вместо_ аргумента `--packDir / -p`. -Кроме того, ожидается, что значок и файл `.desktop` уже существуют, поэтому вам больше не следует предоставлять аргумент `--icon` с `--appDir`. - -## Обновление - -Во время обновлений пакеты загружаются во временное расположение (/var/tmp), а затем заменяется .AppImage. -Если `.AppImage` находится в привилегированной папке, программа обновления автоматически запросит sudo с помощью `pkexec`. -Технически приложение можно обновлять во время его работы, хотя Velopack постарается закрыть/перезапустить его, чтобы удалить все старые версии, работающие в данный момент. - -## Что такое изображение приложения? - -AppImage не устанавливает программное обеспечение в традиционном смысле (т. е. не размещает файлы повсюду в системе). - -Он использует один файл для каждого приложения. Каждый из них самодостаточен: он включает в себя все библиотеки, от которых зависит приложение и которые не являются частью базовой системы. -В этом отношении это похоже на «виртуализацию приложений». -Файл AppImage можно использовать, даже если он не является суперпользователем или использует Live CD. -Файлы AppImage зачастую проще, чем компиляция и установка приложения, поскольку установка на самом деле не происходит. -Файл AppImage представляет собой сжатый образ, который временно монтируется, чтобы обеспечить доступ к программе, но без необходимости извлекать программу или изменять базовую систему. - -## Почему именно AppImage, а не deb, snap и т. д.? - -- AppImage — это формат двоичного распространения программного обеспечения. Программное обеспечение, упакованное как AppImage, должно быть максимально совместимо на двоичном уровне с как можно большим количеством систем. -- AppImage должен работать практически на всех базовых операционных системах (дистрибутивах). Например, вы можете одновременно использовать Ubuntu 9.10, openSUSE 11.2 и Fedora 13 (и более поздние версии), без необходимости создавать и поддерживать отдельные пакеты для каждой целевой системы. -- AppImages являются перемещаемыми и переносимыми и не изменяют операционную систему каким-либо образом. Это означает, что его можно запускать непосредственно с Live CD, USB-накопителя и т. д. - -## Можно ли «установить» AppImage? - -Да, может, но это упражнение обычно остается на усмотрение пользователя. Существуют платформы, которые устанавливают AppImage при первом запуске, перемещая его в заранее определенное место, добавляя ярлык на док-станции/лаунчере/рабочем столе и т. д. -Одной из таких платформ является [AppImageLauncher]\(https://github .com/TheAssassin/AppImageLauncher), но есть и другие. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/operating-systems/macos.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/packaging/operating-systems/macos.mdx deleted file mode 100644 index 2a6f6c6..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/operating-systems/macos.mdx +++ /dev/null @@ -1,37 +0,0 @@ -# Обзор MacOS - - -Специальные примечания для MacOS о создании и использовании пакетов Velopack. - -Для Mac приложения распространяются в виде пакетов .app. Это специальные папки, которые отображаются в Finder как один файл. - -## Упаковка - -Если вы создаете собственный пакет, вы можете указать папку, оканчивающуюся на `.app`, в аргументе `--packDir` / `-p`, Velopack скопирует и будет использовать ее напрямую. -Если вы не хотите создавать пакет `.app` вручную, Velopack может сделать это за вас, поэтому просто укажите любую другую папку (которая не заканчивается на `.app`) в аргументе `--packDir`. - -Если вы хотите, чтобы Velopack автоматически создавал пакет, единственным дополнительным аргументом, который вам нужно указать, является `--icon`, и это должен быть действительный файл `.icns`. - -:::warning -[Подписание кода и нотариальное заверение](../signing.mdx) требуется Apple перед отправкой ваших выпусков пользователям, иначе ваше приложение не запустится. -::: - -## Обновление - -Во время обновлений пакеты загружаются в `/tmp`, а на этапе применения пакет `.app` будет извлечен и заменен. - -Если `.app` установлен в `/Applications` (а не, например, `~/Applications`), может потребоваться повышение прав. -В этом случае программа обновления будет использовать AppleScrpt для запроса прав и завершения обновления. -Пакет `.app`, созданный Velopack, не обязательно должен находиться в `/Applications` для поддержки обновлений. Это портативный/автономный пакет -, и если он перемещается пользователем, он все равно способен применять обновления. - -Технически приложение можно обновлять во время его работы, хотя Velopack постарается закрыть/перезапустить его, чтобы удалить все старые версии, работающие в данный момент. - -## Установка - -Velopack автоматически сгенерирует и подпишет для вас установщик `.pkg`, который позволит вам показать файл readme, заключение, страницу лицензии и т. д. -Полный список параметров см. в справке по командной строке. -Он также позволяет пользователю выбрать, следует ли устанавливать его в `/Applications` или `~/Applications`, и автоматически запускает приложение после его установки. - -Если вы не хотите отправлять пакет, Velopack также создает переносимый ZIP-файл, который будет автоматически извлечен, если пользователь щелкнет его в Finder. -Если вместо этого вы хотите отправить DMG, вы можете разархивировать этот портативный пакет и таким образом создать DMG. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/operating-systems/windows.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/packaging/operating-systems/windows.mdx deleted file mode 100644 index 4bca181..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/operating-systems/windows.mdx +++ /dev/null @@ -1,61 +0,0 @@ -# Обзор Windows - - -Примечания для Windows о создании и использовании пакетов Velopack. - -Для Windows Velopack создает и устанавливает структуру папок, которая выглядит следующим образом: - -``` -%LocalAppData% -└── {packId} - ├── текущий - │ ├── YourFile.dll - │ ├── sq. версия - │ └── YourApp.exe - └── Update.exe -``` - -## Упаковка - -Для упаковки программы для Windows не существует особых требований, хотя вы можете настроить установщик -, используя `--packTitle`, `--splashImage`, `--icon` и т. д. Полный список параметров см. в справке по командной строке. - -Также настоятельно рекомендуется (но не обязательно) использовать [кодовый знак](../signing.mdx) перед отправкой пользователям. Если вы этого не сделаете, -ваше приложение может быть помечено как вирус. - -## Обновление - -Во время обновлений весь `текущий` каталог будет заменен, поэтому, если вам нужно сохранить настройки, журналы, отчеты о сбоях и т. д., -см. [Сохранение файлов]\(../../integrating/ сохраненные-файлы.mdx). - -В Windows, если какой-либо файл внутри `current` используется, папку нельзя переместить/переименовать/удалить и т. д. -Существует множество вещей, которые могут заблокировать эту папку. Например: - -- Процесс, работающий внутри `current` -- Процесс, работающий вне текущего, который открыл файл внутри текущего для чтения. -- Антивирус/Защитник Windows и т. д. -- Процесс с CWD (текущий рабочий каталог) внутри этой папки (например, процесс cmd.exe). - -Если папку невозможно переименовать в процессе обновления, программа обновления Velopack попытается автоматически завершить все процессы, запущенные внутри «current». -Если папка все еще заблокирована и не может быть переименована, программа обновления выполнит поиск других процессов в системе, которые могут блокировать папку - -, и если таковые будут найдены, она откроет пользователю диалоговое окно с предложением убейте их или прервите обновление. Если процесс блокировки не может быть идентифицирован, -(например, если процесс блокировки выполняется от имени администратора), то пользователю будет показано сообщение об ошибке и старая версия приложения -будет запущен. - -:::info -В настоящее время ни программа обновления, ни программа установки не поддерживают привилегированные каталоги, такие как `C:\Program Files`, но поддержка этого планируется в будущем. -::: - -## Установка - -Установка, созданная Velopack, представляет собой установщик одним щелчком мыши, который покажет заставку по вашему выбору (PNG, JPG или анимированный GIF), -или, если вы не предоставите изображение, это будет простой прогресс. бар. - -По умолчанию установщик выполняет установку в `%LocalAppData%\{packId}`, но это можно переопределить во время выполнения с помощью аргумента `Setup.exe --installto {dir}`. - -Перед началом установки установщик проверит, что [App RID](../rid.mdx) совместим с текущей операционной системой, -, а также проверит наличие отсутствующих [зависимостей начальной загрузки]\(../bootstrapping .mdx). - -Кроме того, во время установки установщик запустит [App Hooks](../../integrating/hooks.mdx), а также запустит приложение в первый раз -после завершения установки. Если вы хотите запретить запуск приложения после завершения установки, -вы можете сделать это с помощью аргумента `Setup.exe --silent`. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/overview.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/packaging/overview.mdx deleted file mode 100644 index 30f61c9..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/overview.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_label: Обзор -sidebar_position: 0 ---- - -# Обзор упаковки - - - -Упаковка выпуска осуществляется с помощью команды «pack» в Velopack. Независимо от вашей операционной системы, общие обязательные аргументы примерно одинаковы. - -## Создание вашего первого релиза - -Сначала вам следует скомпилировать свое приложение с помощью любой цепочки инструментов, которую вы обычно используете (например, «dotnetPublish», «msbuild.exe» и т. д.). -Впредь это будет называться `{build_dir}`. - -### Обязательные аргументы - -- `--packId {id}` Уникальный идентификатор вашего приложения. Оно должно быть достаточно уникальным, чтобы другие авторы приложений не могли столкнуться с вашим приложением. -- `--packVersion {version}` Текущая версия, которую вы выпускаете - в [формате semver2](https://semver.org/) (например, `1.0.0-build.23+metadata`). -- `--packDir {build_dir}` Папка, содержащая скомпилированное приложение. -- `--mainExe {exeName}` Основной исполняемый файл, который будет запущен после установки, и двоичный файл, который будет [обрабатывать хуки Velopack](../integrating/overview.mdx). -- `--icon {path}` Значок, используемый для связывания вашего приложения. Требуется только в MacOS и Linux. - -:::tip -Velopack не поддерживает версии из 4 частей (например, `1.0.0.0`), поскольку было бы непрактично поддерживать оба формата одновременно, а semver2 предлагает гораздо большую гибкость. -::: - -Полный пример: - -```cmd -dotnetPublish -c Release -r win-x64 -o опубликовать -vpk package --packId MyAppId -packVersion 1.0.0 --packDir опубликовать --mainExe MyApp.exe -``` - -### Необязательные рекомендуемые аргументы - -Существует множество необязательных аргументов, лучший способ узнать, какие функции доступны для вашей операционной системы, — проверить `vpk package -h`. Упомянем пару: - -- `--packTitle {name}` Понятное имя вашего приложения, отображаемое пользователям в диалоговых окнах, ярлыках и т. д. -- `--outputDir {path}` Местоположение, в котором Velopack должен создавать финальные выпуски (по умолчанию `.\Releases`) - -### Выпуск выпуска - -Когда сборка релиза завершена, в вашем `--outputDir` должны быть следующие ресурсы: - -- `MyAppId-1.0.0-full.nupkg` — полная версия: содержит весь пакет обновлений. -- `MyAppId-1.0.0-delta.nupkg` — дельта-версия: только если существовала предыдущая версия, на основе которой можно было создать дельту. Их сборка/развертывание не являются обязательными, но они ускоряют процесс обновления серверов, поскольку им нужно загружать только то, что изменилось между версиями, а не полный пакет. -- `MyAppId-Portable.zip` — портативная версия: ее можно развернуть дополнительно, чтобы пользователи могли запускать и обновлять ваше приложение без установки. -- `MyAppId-Setup.exe` — установщик: используется большинством пользователей для установки приложения в локальную файловую систему. -- `релизы.{channel}.json` — Индекс выпусков: список всех доступных выпусков. Используется UpdateManager для поиска последней применимой версии. -- `RELEASES` — файл устаревших релизов: используется только для клиентов [мигрирующих на Velopack](../migrating/squirrel.mdx) из Squirrel. -- `активы.{channel}.json` — Ресурсы сборки: список ресурсов, созданных в самой последней сборке. Используется [командами развертывания Velopack](../distributing/overview.mdx). - -Вам не нужно развертывать все эти файлы, чтобы пользователи могли обновляться, поэтому вам следует просмотреть [руководство по развертыванию](../distributing/overview.mdx) для получения дополнительной информации о том, какие файлы следует распространять. - -:::tip -Для Linux не существует пакета установки/установки. Программа распространяется как самообновляющийся файл `.AppImage`. Причина в том, что `.AppImage` будет работать практически на каждом современном дистрибутиве без каких-либо дополнительных зависимостей. Просто загрузите `.AppImage`, запустите `chmod +x` и щелкните по нему, чтобы начать. Можно установить `.AppImage`, но пользователю остается установить что-то вроде [appimaged]\(https://github.com/probonopd/go-appimage/blob/master/src/appimaged/README .mdx) или [AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher). -::: - -## Подписание кода - -Хотя это не требуется для локальных сборок/тестирования, вам всегда следует подписывать код вашего приложения перед его распространением среди пользователей. - -:::tip -Если вы не подпишете код, ваше приложение может не запуститься. [\[Подробнее\]](signing.mdx) -::: - -## Настройка установщика - -На платформах, поставляющих установщики, вы можете настроить поведение. [\[Подробнее\]](installer.mdx) - -## Другие рекомендуемые аргументы - -- Если ваше приложение зависит от операционной системы или архитектуры процессора, вам следует рассмотреть возможность добавления --rid\`. [\[Подробнее\]](rid.mdx) -- Если вы планируете распространять каналы выпусков для разных архитектур или функций, рассмотрите возможность добавления `--channel` [\[Подробнее\]](channels.mdx) -- Если вашему приложению требуются дополнительные платформы (например, vcredist), рассмотрите `--framework` [\[Подробнее\]](bootstrapping.mdx) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/rid.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/packaging/rid.mdx deleted file mode 100644 index 2efbe5c..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/rid.mdx +++ /dev/null @@ -1,26 +0,0 @@ -# RID (идентификатор времени выполнения) - - - -Подобно тому, как вы предоставляете RID в dotnet для обозначения целевой операционной системы и архитектуры, вы можете сделать то же самое для Velopack, чтобы сообщить ему, что поддерживает ваше приложение. - -RID состоит из трех частей (`{os}{версия?}-{arch}`) - -- os: операционная система (win, osx или linux). -- версия: опционально укажите минимальную поддерживаемую версию (например, `win7`, `win8.1`, `win10.0.18362`) -- Arch: опционально укажите поддерживаемую архитектуру ЦП (например, `win-x86`, `win-x64`, `win-arm64`) - -Если вы предоставите RID `--rid win10-arm64`, любые пользователи, пытающиеся установить ваше приложение в Windows 7, 8 или 8.1, получат сообщение о том, что их операционная система не поддерживается. Аналогично, если бы пользователь Windows 11 с процессором x64 пытался установить систему, она также завершится неудачно с полезным сообщением. - -При попытке настроить таргетинг на Windows 11 они не увеличили основной номер сборки с 10 до 11. Все, что >= сборка 22000, классифицируется как Windows 11. Например: - -- `win11 == win10.0.22000` -- `win11.0.22621 == win10.0.22621` - -В MacOS RID (минимальная версия и версия) просто хранится в виде метаданных в `.pkg`, который будет обрабатываться операционной системой изначально. - -#### Также читайте - -- [История версий Windows 10](https://en.wikipedia.org/wiki/Windows_10_version_history) -- [История версий Windows 11](https://en.wikipedia.org/wiki/Windows_11_version_history) -- [Каталог .NET RID](https://learn.microsoft.com/dotnet/core/rid-catalog) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/signing.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/packaging/signing.mdx deleted file mode 100644 index 61cea6f..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/packaging/signing.mdx +++ /dev/null @@ -1,194 +0,0 @@ -# Подписание кода - - - -Подписание кода — важная часть распространения приложений. В Windows приложения без подписей кода могут быть помечены как вирусы. В OSX требуется разработка кода и нотариальное заверение, прежде чем ваше приложение сможет быть запущено пользователями. - -На обеих платформах подпись должна выполняться самим Velopack, поскольку двоичные файлы Velopack (такие как обновление и установка) необходимо подписывать на разных этапах процесса сборки пакета. - -## Подписание в Windows - -Вот общее практическое правило для предупреждений Защитника Windows/Smart Screen: - -- Вы не подписываете свой код. Вы выпускаете MyApp-v1.exe. Люди получают предупреждения на интеллектуальном экране на некоторое время, пока репутация этого файла не повысится. Вы выпускаете MyApp-v2.exe. Люди снова получают предупреждения до тех пор, пока MyApp-v2.exe не наберет достаточную репутацию. -- Вы подписываете свой код сертификатом OV. Вы выпускаете MyApp-v1.exe. Люди получают предупреждения на интеллектуальном экране какое-то время, пока репутация этого сертификата не повысится. Вы выпускаете MyApp-v2.exe. Люди не получают предупреждений, поскольку сертификат уже имеет хорошую репутацию. В конце концов срок действия вашего сертификата истекает, и приходит время выпустить MyApp-v47.exe. Вы продлеваете свой сертификат, и люди снова получают предупреждения, пока новый сертификат не наберет репутацию. -- Вы подписываете свой код сертификатом EV. Люди никогда не получают предупреждений. - -### Получение сертификата подписи кода - -Во-первых, вам необходимо приобрести сертификат подписи кода от известного бренда. Microsoft перечисляет следующих доверенных эмитентов [в своей документации] \(https://learn.microsoft.com/windows-hardware/drivers/dashboard/code-signing-cert-manage): - -- [Certum](https://shop.certum.eu/data-safety/code-signing-certificates/certum-ev-code-sigining.html) -- [SSL.com](https://www.ssl.com/certificates/ev-code-signing/) -- [DigiCert](https://www.digicert.com/signing/code-signing-certificates) -- [Доверить](https://www.entrustdatacard.com/products/digital-signing-certificates/code-signing-certificates) -- [GlobalSign](https://go.microsoft.com/fwlink/p/?LinkId=620888) -- [IdenTrust](https://www.identrust.com/digital-certificates/trustid-ev-code-signing) -- [Sectigo (ранее Comodo)](https://sectigo.com/ssl-certificates-tls/code-signing) - -:::tip -Обратите внимание, что с 1 июня 2023 г. [произошло изменение политики]\(https://knowledge.digicert.com/general-information/new-private-key-storage-requirement-for-standard-code-signing-certificates- ноябрь-2022 г.), что означает, что больше невозможно напрямую загрузить закрытый ключ сертификата подписи кода в виде файла от эмитентов. Это означает, что большинство доступных сегодня вариантов подписи потребуют от вас участия в подписании облачного кода или установки сертификата на HSM (USB/аппаратный модуль). Некоторые поставщики услуг могут разрешить вам установить сертификат на бывший в употреблении или универсальный HSM, а некоторые могут потребовать от вас приобрести и отправить HSM собственной марки. CI/CD может оказаться невозможным для некоторых эмитентов, если они не предоставляют инструменты, специально предназначенные для этого. -::: - -Официальные сертификаты можно получить у авторизованного реселлера по более низкой цене: - -- [SignMyCode](https://signmycode.com/) -- [GoGetSSL](https://www.gogetssl.com/code-signing-ssl/) - -Если вы ищете дешевый вариант, на момент написания статьи Certum предлагает [Сертификат подписи облака с открытым исходным кодом] \(https://certum.store/data-safety/code-signing-certificates.html?as_dane_w_certyfikacie=5720) за 58 долларов. Обратите внимание, что сертификаты Certum невозможно автоматизировать с помощью CI/CD, поскольку они требуют установки драйверов виртуальной подписи (SimpleSign Desktop) и входа в систему с помощью приложения 2FA SimplySign. - -:::warning -Этот документ ни в коем случае не является рекомендацией или советом по покупке у какого-либо конкретного эмитента сертификата подписи кода. Это всего лишь общее руководство по процессу приобретения сертификата, и вы должны сами убедиться, что выбранный вами эмитент подходит для вашего случая использования. -::: - -### Подписание через `signtool.exe` - -Обычно подписание осуществляется с помощью `signtool.exe`. Если вы уже используете этот инструмент для подписи своего приложения, вы можете просто передать параметры подписи прямо в Velopack (без команды «подписать»). - -Например, если ваша команда подписи раньше была: - -```cmd -Signtool.exe подписывает /td sha256 /fd sha256 /f yourCert.pfx /tr http://timestamp.comodoca.com -``` - -Тогда теперь с `--signParams` это будет: - -```cmd -пакет vpk ... --signParams "/td sha256 /fd sha256 /f yourCert.pfx /tr http://timestamp.comodoca.com" -``` - -Если вы новичок в использовании `signtool.exe`, вы можете проверить [ссылку на командную строку здесь] \(https://learn.microsoft.com/dotnet/framework/tools/signtool-exe). Я рекомендую сначала начать работу с подписью на одном двоичном файле, используя `signtool.exe`, прежде чем пытаться заставить все работать с помощью Velopack CLI. - -Если вы используете USB/HSM и у вас возникла следующая ошибка подписи: «Ошибка: SignerSign() не удалось». (-2147023673/0x800704c7)`, это означает, что вам не хватает пароля/токена разблокировки. Это можно добавить в команду подписи с параметрами `/csp/k\`. [\[Подробнее\]](https://stackoverflow.com/questions/17927895/automate-extended-validation-ev-code-signing-with-safenet-etoken/54439759#54439759) - -:::warning -Будьте осторожны, указывая параметры через пробелы. Вы должны заключить все, что содержит пробелы, в кавычки и отделить их обратной косой чертой. Например, `--signParams "/n \"Имя моего сертификата\""`. Если вы используете задачу MSBuild `` или подобную, вам нужно будет использовать вместо нее `"`. -::: - -По умолчанию Velopack подписывает 10 файлов за один вызов `signtool.exe`, чтобы ускорить подписание и уменьшить количество раз, которое вам необходимо взаимодействовать с консолью, если вы используете какой-либо интерактивный метод подписи. Это можно отключить с помощью аргумента `--signParallel 1`. - -### Пользовательские команды и инструменты для подписания - -Если у вас есть более сложные требования к подписи, например специальный инструмент подписи (например, «AzureSignTool.exe»), вместо этого вы можете предоставить шаблон команды, где «{{file}}» — это двоичный файл, который Velopack заменит и подпишет. : - -```cmd -vpk package ... --signTemplate "Знак AzureSignTool.exe ... {{file}}" -``` - -## Подписание и нотариальное заверение на OSX - -Прежде чем ваше приложение сможет запускаться пользователями, необходимо разработать код и нотариально заверить его, поэтому это обязательный шаг перед развертыванием вашего приложения. - -### Создание сертификатов подписи кода - -1. Сначала вам необходимо создать учетную запись на https://developer.apple.com, оплатить годовой взнос разработчика и принять все лицензионные соглашения. -2. Перейдите к своим сертификатам: https://developer.apple.com/account/resources/certificates. -3. Нажмите значок (+), чтобы создать новые сертификаты. Вам необходимо создать сертификат «Установщик идентификатора разработчика» и сертификат «Приложение идентификатора разработчика» для распространения приложений Velopack за пределами Mac App Store. - ![список сертификатов Apple](/images/apple_certificate_list.png) -4. Откройте оба сертификата, щелкнув по ним, нажмите «Загрузить», а затем дважды щелкните файл «.cer», чтобы установить его в локальную связку ключей. - -### Настройка профиля NotaryTool - -1. Создайте пароль для конкретного приложения: https://support.apple.com/en-us/102654. Этот пароль будет показан вам только один раз, поэтому сохраните или запишите его где-нибудь. -2. Найдите идентификатор своей команды Apple: https://developer.apple.com/account#MembershipDetailsCard. -3. Сохраните учетные данные своей учетной записи Apple в новом профиле NotaryTool: - ```sh - xcrun notarytool store-credentials \ - --apple-id "yourapple@account.com" \ - --team-id "your-located-team-id" \ - - -password "пароль-вашего-сгенерированного-приложения" \ - "имя-вашего-локального-профиля" - ``` - -### Собираем все это вместе - -Теперь, когда у вас установлен профиль NotaryTool и сертификаты подписи кода, вы можете добавить следующие параметры в команду Pack: - -```sh -vpk package \ - ... - --signAppIdentity «Идентификатор разработчика приложения: ваше имя» \ - --signInstallIdentity «Установщик идентификатора разработчика: ваше имя» \ - --notaryProfile "имя-вашего-локального-профиля" \ -``` - -Если эти параметры указаны и действительны, Velopack автоматически подпишет код и нотариально заверит ваше приложение и пакеты установщика. - -### Автоматизация подписи в CI/CD (Github Actions) - -Также можно хранить ваши сертификаты и учетные данные нотариуса как секреты действий и подписывать свой код во время CI-сборок. - -1. Запустите Keychain Access и откройте панель «Мои сертификаты». - -2. Выберите оба сертификата, щелкните правой кнопкой мыши и выберите «Экспорт». Сохраните как файл p12 и запишите пароль. Вы можете использовать один и тот же пароль для обоих сертификатов. - -3. Скопируйте содержимое сертификата в буфер обмена в формате base64, пример: - ```sh - base64 -i CERT.p12 | pbcopy - ``` - -4. Создайте 7 [секретов Github](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) для ваших рабочих процессов действий. - - `BUILD_CERTIFICATE_BASE64` (b64 сертификата вашего приложения) - - `INSTALLER_CERTIFICATE_BASE64` (b64 вашего сертификата установщика) - - `P12_PASSWORD` (пароль для сертификатов) - - `APPLE_ID` (ваше имя пользователя Apple) - - `APPLE_PASSWORD` (пароль вашего приложения, указанный ранее) - - `APPLE_TEAM` (идентификатор вашей команды, указанный ранее) - - `KEYCHAIN_PASSWORD` (может быть любой случайной строкой, будет использоваться для создания новой цепочки для ключей) - -5. Добавьте в свой рабочий процесс шаг, который устанавливает сертификаты и профиль связки ключей. Вот пример: - - ```yml - name: App build & sign - on: push - jobs: - build_with_signing: - runs-on: macos-latest - steps: - - name: Checkout repository - uses: actions/checkout@v4 - - - name: Install Apple certificates and notary profile - env: - BUILD_CERTIFICATE_BASE64: ${{ secrets.BUILD_CERTIFICATE_BASE64 }} - INSTALLER_CERTIFICATE_BASE64: ${{ secrets.INSTALLER_CERTIFICATE_BASE64 }} - P12_PASSWORD: ${{ secrets.P12_PASSWORD }} - APPLE_ID: ${{ secrets.APPLE_ID }} - APPLE_PASSWORD: ${{ secrets.APPLE_PASSWORD }} - APPLE_TEAM: ${{ secrets.APPLE_TEAM }} - KEYCHAIN_PASSWORD: ${{ secrets.KEYCHAIN_PASSWORD }} - run: | - # create variables for file paths - CERT_BUILD_PATH=$RUNNER_TEMP/build_certificate.p12 - CERT_INSTALLER_PATH=$RUNNER_TEMP/installer_certificate.p12 - KEYCHAIN_PATH=$RUNNER_TEMP/app-signing.keychain-db - - # import certificates from secrets - echo -n "$BUILD_CERTIFICATE_BASE64" | base64 --decode -o $CERT_BUILD_PATH - echo -n "$INSTALLER_CERTIFICATE_BASE64" | base64 --decode -o $CERT_INSTALLER_PATH - - # create temporary keychain - security create-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH - security set-keychain-settings -lut 21600 $KEYCHAIN_PATH - security unlock-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH - - # import certificates to keychain - security import $CERT_BUILD_PATH -P "$P12_PASSWORD" -A -t cert -f pkcs12 -k $KEYCHAIN_PATH - security import $CERT_INSTALLER_PATH -P "$P12_PASSWORD" -A -t cert -f pkcs12 -k $KEYCHAIN_PATH - security list-keychain -d user -s $KEYCHAIN_PATH - - # create notarytool profile - xcrun notarytool store-credentials --apple-id "$APPLE_ID" --team-id "$APPLE_TEAM" --password "$APPLE_PASSWORD" velopack-profile - - - name: Build app - ... - - - name: Create Velopack Release - run: | - dotnet tool install -g vpk - vpk ... --signAppIdentity "Developer ID Application: Your Name" --signInstallIdentity "Developer ID Installer: Your Name" --notaryProfile "velopack-profile" - - - name: Clean up keychain - if: ${{ always() }} - run: security delete-keychain $RUNNER_TEMP/app-signing.keychain-db - ``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cpp/api.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cpp/api.md deleted file mode 100644 index 7c75513..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cpp/api.md +++ /dev/null @@ -1,428 +0,0 @@ -# Velopack C++ Reference - - Members | Descriptions ---------------------------------|--------------------------------------------- -`namespace `[`Velopack`](#namespace_velopack) | -`struct `[`subprocess_s`](#structsubprocess__s) | - -## namespace `Velopack` {#namespace_velopack} - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`enum `[`JsonNodeType`](#_velopack_8hpp_1a7dfd07faa4d65bbd8e7f1d0d0b5c5a04) | -`enum `[`JsonToken`](#_velopack_8hpp_1acaf7690482eab17e0269860d1860c9e2) | -`enum `[`VelopackAssetType`](#_velopack_8hpp_1aa83ef9d579b9fc2e42294528577ee904) | -`public void `[`startup`](#_velopack_8cpp_1a1a2c6842876e9c322e26c977f7bce384)`(char ** args,size_t c_args)` | -`class `[`Velopack::JsonNode`](#class_velopack_1_1_json_node) | -`class `[`Velopack::JsonParser`](#class_velopack_1_1_json_parser) | -`class `[`Velopack::Platform`](#class_velopack_1_1_platform) | -`class `[`Velopack::StringStream`](#class_velopack_1_1_string_stream) | -`class `[`Velopack::UpdateInfo`](#class_velopack_1_1_update_info) | Holds information about the current version and pending updates, such as how many there are, and access to release notes. -`class `[`Velopack::UpdateManagerSync`](#class_velopack_1_1_update_manager_sync) | This class is used to check for updates, download updates, and apply updates. It is a synchronous version of the UpdateManager class. This class is not recommended for use in GUI applications, as it will block the main thread, so you may want to use the async UpdateManager class instead, if it is supported for your programming language. -`class `[`Velopack::VelopackAsset`](#class_velopack_1_1_velopack_asset) | An individual Velopack asset, could refer to an asset on-disk or in a remote package feed. - -#### Members - -#### `enum `[`JsonNodeType`](#_velopack_8hpp_1a7dfd07faa4d65bbd8e7f1d0d0b5c5a04) {#_velopack_8hpp_1a7dfd07faa4d65bbd8e7f1d0d0b5c5a04} - - Values | Descriptions ---------------------------------|--------------------------------------------- -null | -bool_ | -array | -object | -number | -string | - -#### `enum `[`JsonToken`](#_velopack_8hpp_1acaf7690482eab17e0269860d1860c9e2) {#_velopack_8hpp_1acaf7690482eab17e0269860d1860c9e2} - - Values | Descriptions ---------------------------------|--------------------------------------------- -none | -curlyOpen | -curlyClose | -squareOpen | -squareClose | -colon | -comma | -string | -number | -bool_ | -null | - -#### `enum `[`VelopackAssetType`](#_velopack_8hpp_1aa83ef9d579b9fc2e42294528577ee904) {#_velopack_8hpp_1aa83ef9d579b9fc2e42294528577ee904} - - Values | Descriptions ---------------------------------|--------------------------------------------- -unknown | -full | -delta | - -#### `public void `[`startup`](#_velopack_8cpp_1a1a2c6842876e9c322e26c977f7bce384)`(char ** args,size_t c_args)` {#_velopack_8cpp_1a1a2c6842876e9c322e26c977f7bce384} - -## class `Velopack::JsonNode` {#class_velopack_1_1_json_node} - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public `[`JsonNode`](#class_velopack_1_1_json_node_1a1bf6d106ebbd1776709cf085fe333d76)`() = default` | -`public JsonNodeType `[`getKind`](#class_velopack_1_1_json_node_1a923b2b13759e54b9072645a022c2f272)`() const` | Get the type of this node, such as string, object, array, etc. You should use this function and then call the corresponding AsObject, AsArray, AsString, etc. functions to get the actual parsed json information. -`public bool `[`isNull`](#class_velopack_1_1_json_node_1afb83035b3d626688d24493c86001d1d7)`() const` | Check if the JSON value is null. -`public bool `[`isEmpty`](#class_velopack_1_1_json_node_1ab56188938000f8fa88bc6a5a1c652ef5)`() const` | Check if the JSON value is empty - eg. an empty string, array, or object. -`public const std::unordered_map< std::string, std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > > * `[`asObject`](#class_velopack_1_1_json_node_1a87d696801e278b663c10289276cb1ca2)`() const` | Reinterpret a JSON value as an object. Throws exception if the value type was not an object. -`public const std::vector< std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > > * `[`asArray`](#class_velopack_1_1_json_node_1a76dbd4e67e4a58dafaeb80ebccd5b31b)`() const` | Reinterpret a JSON value as an array. Throws exception if the value type was not an array. -`public double `[`asNumber`](#class_velopack_1_1_json_node_1ae8b23482fd05ad4aaf67a842a55865f8)`() const` | Reinterpret a JSON value as a number. Throws exception if the value type was not a double. -`public bool `[`asBool`](#class_velopack_1_1_json_node_1a90b0d98c2b9ae42d7c83d00dbc64077b)`() const` | Reinterpret a JSON value as a boolean. Throws exception if the value type was not a boolean. -`public std::string_view `[`asString`](#class_velopack_1_1_json_node_1a7463c87e96a2dc5cf6cabf3ad7f0a577)`() const` | Reinterpret a JSON value as a string. Throws exception if the value type was not a string. -`public void `[`initBool`](#class_velopack_1_1_json_node_1a18a1848f9b1bd6ac76a884bbf3a2da92)`(bool value)` | -`public void `[`initArray`](#class_velopack_1_1_json_node_1ac3d67c1ddb1b68382489368aa9c45314)`()` | -`public void `[`addArrayChild`](#class_velopack_1_1_json_node_1abbacfa7b09b2f0df9c8c711025081eee)`(std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > child)` | -`public void `[`initObject`](#class_velopack_1_1_json_node_1a1092f357911d35eaeb2364ad0567f0af)`()` | -`public void `[`addObjectChild`](#class_velopack_1_1_json_node_1a59c8ef42ce80b470f71e38bb6f6c0aaf)`(std::string_view key,std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > child)` | -`public void `[`initNumber`](#class_velopack_1_1_json_node_1aa0e4f7f297bc29dd23904de4b18910ed)`(double value)` | -`public void `[`initString`](#class_velopack_1_1_json_node_1aa1f5ca52183d31e0c832d7530227b35d)`(std::string_view value)` | - -#### Members - -#### `public `[`JsonNode`](#class_velopack_1_1_json_node_1a1bf6d106ebbd1776709cf085fe333d76)`() = default` {#class_velopack_1_1_json_node_1a1bf6d106ebbd1776709cf085fe333d76} - -#### `public JsonNodeType `[`getKind`](#class_velopack_1_1_json_node_1a923b2b13759e54b9072645a022c2f272)`() const` {#class_velopack_1_1_json_node_1a923b2b13759e54b9072645a022c2f272} - -Get the type of this node, such as string, object, array, etc. You should use this function and then call the corresponding AsObject, AsArray, AsString, etc. functions to get the actual parsed json information. - -#### `public bool `[`isNull`](#class_velopack_1_1_json_node_1afb83035b3d626688d24493c86001d1d7)`() const` {#class_velopack_1_1_json_node_1afb83035b3d626688d24493c86001d1d7} - -Check if the JSON value is null. - -#### `public bool `[`isEmpty`](#class_velopack_1_1_json_node_1ab56188938000f8fa88bc6a5a1c652ef5)`() const` {#class_velopack_1_1_json_node_1ab56188938000f8fa88bc6a5a1c652ef5} - -Check if the JSON value is empty - eg. an empty string, array, or object. - -#### `public const std::unordered_map< std::string, std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > > * `[`asObject`](#class_velopack_1_1_json_node_1a87d696801e278b663c10289276cb1ca2)`() const` {#class_velopack_1_1_json_node_1a87d696801e278b663c10289276cb1ca2} - -Reinterpret a JSON value as an object. Throws exception if the value type was not an object. - -#### `public const std::vector< std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > > * `[`asArray`](#class_velopack_1_1_json_node_1a76dbd4e67e4a58dafaeb80ebccd5b31b)`() const` {#class_velopack_1_1_json_node_1a76dbd4e67e4a58dafaeb80ebccd5b31b} - -Reinterpret a JSON value as an array. Throws exception if the value type was not an array. - -#### `public double `[`asNumber`](#class_velopack_1_1_json_node_1ae8b23482fd05ad4aaf67a842a55865f8)`() const` {#class_velopack_1_1_json_node_1ae8b23482fd05ad4aaf67a842a55865f8} - -Reinterpret a JSON value as a number. Throws exception if the value type was not a double. - -#### `public bool `[`asBool`](#class_velopack_1_1_json_node_1a90b0d98c2b9ae42d7c83d00dbc64077b)`() const` {#class_velopack_1_1_json_node_1a90b0d98c2b9ae42d7c83d00dbc64077b} - -Reinterpret a JSON value as a boolean. Throws exception if the value type was not a boolean. - -#### `public std::string_view `[`asString`](#class_velopack_1_1_json_node_1a7463c87e96a2dc5cf6cabf3ad7f0a577)`() const` {#class_velopack_1_1_json_node_1a7463c87e96a2dc5cf6cabf3ad7f0a577} - -Reinterpret a JSON value as a string. Throws exception if the value type was not a string. - -#### `public void `[`initBool`](#class_velopack_1_1_json_node_1a18a1848f9b1bd6ac76a884bbf3a2da92)`(bool value)` {#class_velopack_1_1_json_node_1a18a1848f9b1bd6ac76a884bbf3a2da92} - -#### `public void `[`initArray`](#class_velopack_1_1_json_node_1ac3d67c1ddb1b68382489368aa9c45314)`()` {#class_velopack_1_1_json_node_1ac3d67c1ddb1b68382489368aa9c45314} - -#### `public void `[`addArrayChild`](#class_velopack_1_1_json_node_1abbacfa7b09b2f0df9c8c711025081eee)`(std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > child)` {#class_velopack_1_1_json_node_1abbacfa7b09b2f0df9c8c711025081eee} - -#### `public void `[`initObject`](#class_velopack_1_1_json_node_1a1092f357911d35eaeb2364ad0567f0af)`()` {#class_velopack_1_1_json_node_1a1092f357911d35eaeb2364ad0567f0af} - -#### `public void `[`addObjectChild`](#class_velopack_1_1_json_node_1a59c8ef42ce80b470f71e38bb6f6c0aaf)`(std::string_view key,std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > child)` {#class_velopack_1_1_json_node_1a59c8ef42ce80b470f71e38bb6f6c0aaf} - -#### `public void `[`initNumber`](#class_velopack_1_1_json_node_1aa0e4f7f297bc29dd23904de4b18910ed)`(double value)` {#class_velopack_1_1_json_node_1aa0e4f7f297bc29dd23904de4b18910ed} - -#### `public void `[`initString`](#class_velopack_1_1_json_node_1aa1f5ca52183d31e0c832d7530227b35d)`(std::string_view value)` {#class_velopack_1_1_json_node_1aa1f5ca52183d31e0c832d7530227b35d} - -## class `Velopack::JsonParser` {#class_velopack_1_1_json_parser} - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public `[`JsonParser`](#class_velopack_1_1_json_parser_1a8ba6193b9910a65ea83b1805c4de2ae9)`() = default` | -`public void `[`load`](#class_velopack_1_1_json_parser_1ad3616e263c683611394a9ffa069af1a3)`(std::string_view text)` | -`public bool `[`endReached`](#class_velopack_1_1_json_parser_1a896ce20ecbe184cfe6474548e0b1628d)`() const` | -`public std::string `[`readN`](#class_velopack_1_1_json_parser_1ad7c785bd0b73de6ee0bf14917e664955)`(int n)` | -`public int `[`read`](#class_velopack_1_1_json_parser_1a4ca8b941e10641ba731f5e33f2015175)`()` | -`public int `[`peek`](#class_velopack_1_1_json_parser_1ab3ea02be7bacf7eb9647d1cb71092861)`() const` | -`public bool `[`peekWhitespace`](#class_velopack_1_1_json_parser_1a27372ad0097723fbc942c4a353ec88ab)`() const` | -`public bool `[`peekWordbreak`](#class_velopack_1_1_json_parser_1a87791f81b34bcb3db86f5854a1e822b3)`() const` | -`public void `[`eatWhitespace`](#class_velopack_1_1_json_parser_1a5fc6e6a6440ef530ff909b7e87d8d15c)`()` | -`public std::string `[`readWord`](#class_velopack_1_1_json_parser_1a7ed0c81806d36f272d31a8ed5ccc30fa)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseNull`](#class_velopack_1_1_json_parser_1a05611896186a61087f0bf12dc25b6d1a)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseBool`](#class_velopack_1_1_json_parser_1a2bb75c78af5d495ed258940b2585e1a9)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseNumber`](#class_velopack_1_1_json_parser_1a73e75b51dd5922e0440e176c406dce58)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseString`](#class_velopack_1_1_json_parser_1a2eb42a0ea6db17db808548c3cb474fb5)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseObject`](#class_velopack_1_1_json_parser_1ac91bfabf5959f71ff5f068c9af912910)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseArray`](#class_velopack_1_1_json_parser_1a7659a483c15b4c3f94f8ceb7a951a4c9)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseValue`](#class_velopack_1_1_json_parser_1a585c0e240fb52c3634c0df767fba8a74)`()` | - -#### Members - -#### `public `[`JsonParser`](#class_velopack_1_1_json_parser_1a8ba6193b9910a65ea83b1805c4de2ae9)`() = default` {#class_velopack_1_1_json_parser_1a8ba6193b9910a65ea83b1805c4de2ae9} - -#### `public void `[`load`](#class_velopack_1_1_json_parser_1ad3616e263c683611394a9ffa069af1a3)`(std::string_view text)` {#class_velopack_1_1_json_parser_1ad3616e263c683611394a9ffa069af1a3} - -#### `public bool `[`endReached`](#class_velopack_1_1_json_parser_1a896ce20ecbe184cfe6474548e0b1628d)`() const` {#class_velopack_1_1_json_parser_1a896ce20ecbe184cfe6474548e0b1628d} - -#### `public std::string `[`readN`](#class_velopack_1_1_json_parser_1ad7c785bd0b73de6ee0bf14917e664955)`(int n)` {#class_velopack_1_1_json_parser_1ad7c785bd0b73de6ee0bf14917e664955} - -#### `public int `[`read`](#class_velopack_1_1_json_parser_1a4ca8b941e10641ba731f5e33f2015175)`()` {#class_velopack_1_1_json_parser_1a4ca8b941e10641ba731f5e33f2015175} - -#### `public int `[`peek`](#class_velopack_1_1_json_parser_1ab3ea02be7bacf7eb9647d1cb71092861)`() const` {#class_velopack_1_1_json_parser_1ab3ea02be7bacf7eb9647d1cb71092861} - -#### `public bool `[`peekWhitespace`](#class_velopack_1_1_json_parser_1a27372ad0097723fbc942c4a353ec88ab)`() const` {#class_velopack_1_1_json_parser_1a27372ad0097723fbc942c4a353ec88ab} - -#### `public bool `[`peekWordbreak`](#class_velopack_1_1_json_parser_1a87791f81b34bcb3db86f5854a1e822b3)`() const` {#class_velopack_1_1_json_parser_1a87791f81b34bcb3db86f5854a1e822b3} - -#### `public void `[`eatWhitespace`](#class_velopack_1_1_json_parser_1a5fc6e6a6440ef530ff909b7e87d8d15c)`()` {#class_velopack_1_1_json_parser_1a5fc6e6a6440ef530ff909b7e87d8d15c} - -#### `public std::string `[`readWord`](#class_velopack_1_1_json_parser_1a7ed0c81806d36f272d31a8ed5ccc30fa)`()` {#class_velopack_1_1_json_parser_1a7ed0c81806d36f272d31a8ed5ccc30fa} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseNull`](#class_velopack_1_1_json_parser_1a05611896186a61087f0bf12dc25b6d1a)`()` {#class_velopack_1_1_json_parser_1a05611896186a61087f0bf12dc25b6d1a} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseBool`](#class_velopack_1_1_json_parser_1a2bb75c78af5d495ed258940b2585e1a9)`()` {#class_velopack_1_1_json_parser_1a2bb75c78af5d495ed258940b2585e1a9} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseNumber`](#class_velopack_1_1_json_parser_1a73e75b51dd5922e0440e176c406dce58)`()` {#class_velopack_1_1_json_parser_1a73e75b51dd5922e0440e176c406dce58} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseString`](#class_velopack_1_1_json_parser_1a2eb42a0ea6db17db808548c3cb474fb5)`()` {#class_velopack_1_1_json_parser_1a2eb42a0ea6db17db808548c3cb474fb5} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseObject`](#class_velopack_1_1_json_parser_1ac91bfabf5959f71ff5f068c9af912910)`()` {#class_velopack_1_1_json_parser_1ac91bfabf5959f71ff5f068c9af912910} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseArray`](#class_velopack_1_1_json_parser_1a7659a483c15b4c3f94f8ceb7a951a4c9)`()` {#class_velopack_1_1_json_parser_1a7659a483c15b4c3f94f8ceb7a951a4c9} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseValue`](#class_velopack_1_1_json_parser_1a585c0e240fb52c3634c0df767fba8a74)`()` {#class_velopack_1_1_json_parser_1a585c0e240fb52c3634c0df767fba8a74} - -## class `Velopack::Platform` {#class_velopack_1_1_platform} - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- - -#### Members - -## class `Velopack::StringStream` {#class_velopack_1_1_string_stream} - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public `[`StringStream`](#class_velopack_1_1_string_stream_1a7881ca72f76249dc905e83208adba0ba)`() = default` | -`public void `[`clear`](#class_velopack_1_1_string_stream_1a25286df2ff42d828f4b7273bfcaa1ac1)`()` | -`public void `[`write`](#class_velopack_1_1_string_stream_1a74de3a26bf75823586ac4e0ce9e57f12)`(std::string s)` | -`public void `[`writeLine`](#class_velopack_1_1_string_stream_1afd73beeb474374ad0d9d5feca92d3dba)`(std::string s)` | -`public void `[`writeChar`](#class_velopack_1_1_string_stream_1ad025e53ac91373dbe983128c7cb62519)`(int c)` | -`public std::string `[`toString`](#class_velopack_1_1_string_stream_1ac9e5b82f2a193256d9e1ae94198d7f09)`() const` | - -#### Members - -#### `public `[`StringStream`](#class_velopack_1_1_string_stream_1a7881ca72f76249dc905e83208adba0ba)`() = default` {#class_velopack_1_1_string_stream_1a7881ca72f76249dc905e83208adba0ba} - -#### `public void `[`clear`](#class_velopack_1_1_string_stream_1a25286df2ff42d828f4b7273bfcaa1ac1)`()` {#class_velopack_1_1_string_stream_1a25286df2ff42d828f4b7273bfcaa1ac1} - -#### `public void `[`write`](#class_velopack_1_1_string_stream_1a74de3a26bf75823586ac4e0ce9e57f12)`(std::string s)` {#class_velopack_1_1_string_stream_1a74de3a26bf75823586ac4e0ce9e57f12} - -#### `public void `[`writeLine`](#class_velopack_1_1_string_stream_1afd73beeb474374ad0d9d5feca92d3dba)`(std::string s)` {#class_velopack_1_1_string_stream_1afd73beeb474374ad0d9d5feca92d3dba} - -#### `public void `[`writeChar`](#class_velopack_1_1_string_stream_1ad025e53ac91373dbe983128c7cb62519)`(int c)` {#class_velopack_1_1_string_stream_1ad025e53ac91373dbe983128c7cb62519} - -#### `public std::string `[`toString`](#class_velopack_1_1_string_stream_1ac9e5b82f2a193256d9e1ae94198d7f09)`() const` {#class_velopack_1_1_string_stream_1ac9e5b82f2a193256d9e1ae94198d7f09} - -## class `Velopack::UpdateInfo` {#class_velopack_1_1_update_info} - -Holds information about the current version and pending updates, such as how many there are, and access to release notes. - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public std::shared_ptr< `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` > `[`targetFullRelease`](#class_velopack_1_1_update_info_1ae48ce8dce0fbb3e509e4767e42bead66) | The available version that we are updating to. -`public bool `[`isDowngrade`](#class_velopack_1_1_update_info_1a593247b70ac2ec4cc12870a7fa544f21) | True if the update is a version downgrade or lateral move (such as when switching channels to the same version number). In this case, only full updates are allowed, and any local packages on disk newer than the downloaded version will be deleted. -`public `[`UpdateInfo`](#class_velopack_1_1_update_info_1ac124c42db882a61ca65f43a061fef338)`() = default` | - -#### Members - -#### `public std::shared_ptr< `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` > `[`targetFullRelease`](#class_velopack_1_1_update_info_1ae48ce8dce0fbb3e509e4767e42bead66) {#class_velopack_1_1_update_info_1ae48ce8dce0fbb3e509e4767e42bead66} - -The available version that we are updating to. - -#### `public bool `[`isDowngrade`](#class_velopack_1_1_update_info_1a593247b70ac2ec4cc12870a7fa544f21) {#class_velopack_1_1_update_info_1a593247b70ac2ec4cc12870a7fa544f21} - -True if the update is a version downgrade or lateral move (such as when switching channels to the same version number). In this case, only full updates are allowed, and any local packages on disk newer than the downloaded version will be deleted. - -#### `public `[`UpdateInfo`](#class_velopack_1_1_update_info_1ac124c42db882a61ca65f43a061fef338)`() = default` {#class_velopack_1_1_update_info_1ac124c42db882a61ca65f43a061fef338} - -## class `Velopack::UpdateManagerSync` {#class_velopack_1_1_update_manager_sync} - -This class is used to check for updates, download updates, and apply updates. It is a synchronous version of the UpdateManager class. This class is not recommended for use in GUI applications, as it will block the main thread, so you may want to use the async UpdateManager class instead, if it is supported for your programming language. - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public `[`UpdateManagerSync`](#class_velopack_1_1_update_manager_sync_1a0725c325f7dfd276d8f4320b7e6524ff)`() = default` | -`public void `[`setUrlOrPath`](#class_velopack_1_1_update_manager_sync_1ae56a277bbd4898786d73b61993640ecb)`(std::string urlOrPath)` | Set the URL or local file path to the update server. This is required before calling CheckForUpdates or DownloadUpdates. -`public void `[`setAllowDowngrade`](#class_velopack_1_1_update_manager_sync_1a85fc4369fadd9046d074feb2c86cfa4a)`(bool allowDowngrade)` | Allows UpdateManager to update to a version that's lower than the current version (i.e. downgrading). This could happen if a release has bugs and was retracted from the release feed, or if you're using ExplicitChannel to switch channels to another channel where the latest version on that channel is lower than the current version. -`public void `[`setExplicitChannel`](#class_velopack_1_1_update_manager_sync_1a0734f2d9c7aaf25c103fd5c5b469a212)`(std::string explicitChannel)` | This option should usually be left null. Overrides the default channel used to fetch updates. The default channel will be whatever channel was specified on the command line when building this release. For example, if the current release was packaged with 'channel beta', then the default channel will be 'beta'. This allows users to automatically receive updates from the same channel they installed from. This options allows you to explicitly switch channels, for example if the user wished to switch back to the 'stable' channel without having to reinstall the application. -`public bool `[`isInstalled`](#class_velopack_1_1_update_manager_sync_1a1c00744efbf661f9cbda40207fd8d670)`() const` | Returns true if the current app is installed, false otherwise. If the app is not installed, other functions in UpdateManager may throw exceptions, so you may want to check this before calling other functions. -`public std::string `[`getCurrentVersion`](#class_velopack_1_1_update_manager_sync_1a9b46af25127ae7267726cb8f48dc7c37)`() const` | Get the currently installed version of the application. If the application is not installed, this function will throw an exception. -`public std::shared_ptr< `[`UpdateInfo`](#class_velopack_1_1_update_info)` > `[`checkForUpdates`](#class_velopack_1_1_update_manager_sync_1a71e4aad5ba207741c10866e844341325)`() const` | This function will check for updates, and return information about the latest available release. This function runs synchronously and may take some time to complete, depending on the network speed and the number of updates available. -`public void `[`downloadUpdates`](#class_velopack_1_1_update_manager_sync_1abdbd2cf84cf64eed79f550e3277cdb6a)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toDownload) const` | Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock so may fail if there is already another update operation in progress. -`public void `[`applyUpdatesAndExit`](#class_velopack_1_1_update_manager_sync_1a5e1009cf9e2d7b852732e876f1c2188f)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply) const` | This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified restart arguments. If you need to save state or clean up, you should do that before calling this method. The user may be prompted during the update, if the update requires additional frameworks to be installed etc. -`public void `[`applyUpdatesAndRestart`](#class_velopack_1_1_update_manager_sync_1a69a296e31573c3173c418758d333dc51)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply,const std::vector< std::string > * restartArgs) const` | This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified restart arguments. If you need to save state or clean up, you should do that before calling this method. The user may be prompted during the update, if the update requires additional frameworks to be installed etc. -`public void `[`waitExitThenApplyUpdates`](#class_velopack_1_1_update_manager_sync_1aa6b15d1cf21d21aee749b38a224570c3)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply,bool silent,bool restart,const std::vector< std::string > * restartArgs) const` | This will launch the Velopack updater and tell it to wait for this program to exit gracefully. You should then clean up any state and exit your app. The updater will apply updates and then optionally restart your app. The updater will only wait for 60 seconds before giving up. -`protected std::vector< std::string > `[`getCurrentVersionCommand`](#class_velopack_1_1_update_manager_sync_1adb80fec8671f6ad9b4e3cf9fa5dbe458)`() const` | Returns the command line arguments to get the current version of the application. -`protected std::vector< std::string > `[`getCheckForUpdatesCommand`](#class_velopack_1_1_update_manager_sync_1a4d66d76a07cddda53ce3fd3a3306e6a9)`() const` | Returns the command line arguments to check for updates. -`protected std::vector< std::string > `[`getDownloadUpdatesCommand`](#class_velopack_1_1_update_manager_sync_1aa28503793c51523b98d5384ad3f6a28f)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toDownload) const` | Returns the command line arguments to download the specified update. -`protected std::vector< std::string > `[`getUpdateApplyCommand`](#class_velopack_1_1_update_manager_sync_1a47232672aab9d74f593a2bfe29f5eb3d)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply,bool silent,bool restart,bool wait,const std::vector< std::string > * restartArgs) const` | Returns the command line arguments to apply the specified update. -`protected std::string `[`getPackagesDir`](#class_velopack_1_1_update_manager_sync_1a8b0d484bcc50fc316ef662ecd5e09093)`() const` | Returns the path to the app's packages directory. This is where updates are downloaded to. - -#### Members - -#### `public `[`UpdateManagerSync`](#class_velopack_1_1_update_manager_sync_1a0725c325f7dfd276d8f4320b7e6524ff)`() = default` {#class_velopack_1_1_update_manager_sync_1a0725c325f7dfd276d8f4320b7e6524ff} - -#### `public void `[`setUrlOrPath`](#class_velopack_1_1_update_manager_sync_1ae56a277bbd4898786d73b61993640ecb)`(std::string urlOrPath)` {#class_velopack_1_1_update_manager_sync_1ae56a277bbd4898786d73b61993640ecb} - -Set the URL or local file path to the update server. This is required before calling CheckForUpdates or DownloadUpdates. - -#### `public void `[`setAllowDowngrade`](#class_velopack_1_1_update_manager_sync_1a85fc4369fadd9046d074feb2c86cfa4a)`(bool allowDowngrade)` {#class_velopack_1_1_update_manager_sync_1a85fc4369fadd9046d074feb2c86cfa4a} - -Allows UpdateManager to update to a version that's lower than the current version (i.e. downgrading). This could happen if a release has bugs and was retracted from the release feed, or if you're using ExplicitChannel to switch channels to another channel where the latest version on that channel is lower than the current version. - -#### `public void `[`setExplicitChannel`](#class_velopack_1_1_update_manager_sync_1a0734f2d9c7aaf25c103fd5c5b469a212)`(std::string explicitChannel)` {#class_velopack_1_1_update_manager_sync_1a0734f2d9c7aaf25c103fd5c5b469a212} - -This option should usually be left null. Overrides the default channel used to fetch updates. The default channel will be whatever channel was specified on the command line when building this release. For example, if the current release was packaged with 'channel beta', then the default channel will be 'beta'. This allows users to automatically receive updates from the same channel they installed from. This options allows you to explicitly switch channels, for example if the user wished to switch back to the 'stable' channel without having to reinstall the application. - -#### `public bool `[`isInstalled`](#class_velopack_1_1_update_manager_sync_1a1c00744efbf661f9cbda40207fd8d670)`() const` {#class_velopack_1_1_update_manager_sync_1a1c00744efbf661f9cbda40207fd8d670} - -Returns true if the current app is installed, false otherwise. If the app is not installed, other functions in UpdateManager may throw exceptions, so you may want to check this before calling other functions. - -#### `public std::string `[`getCurrentVersion`](#class_velopack_1_1_update_manager_sync_1a9b46af25127ae7267726cb8f48dc7c37)`() const` {#class_velopack_1_1_update_manager_sync_1a9b46af25127ae7267726cb8f48dc7c37} - -Get the currently installed version of the application. If the application is not installed, this function will throw an exception. - -#### `public std::shared_ptr< `[`UpdateInfo`](#class_velopack_1_1_update_info)` > `[`checkForUpdates`](#class_velopack_1_1_update_manager_sync_1a71e4aad5ba207741c10866e844341325)`() const` {#class_velopack_1_1_update_manager_sync_1a71e4aad5ba207741c10866e844341325} - -This function will check for updates, and return information about the latest available release. This function runs synchronously and may take some time to complete, depending on the network speed and the number of updates available. - -#### `public void `[`downloadUpdates`](#class_velopack_1_1_update_manager_sync_1abdbd2cf84cf64eed79f550e3277cdb6a)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toDownload) const` {#class_velopack_1_1_update_manager_sync_1abdbd2cf84cf64eed79f550e3277cdb6a} - -Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock so may fail if there is already another update operation in progress. - -#### `public void `[`applyUpdatesAndExit`](#class_velopack_1_1_update_manager_sync_1a5e1009cf9e2d7b852732e876f1c2188f)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply) const` {#class_velopack_1_1_update_manager_sync_1a5e1009cf9e2d7b852732e876f1c2188f} - -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified restart arguments. If you need to save state or clean up, you should do that before calling this method. The user may be prompted during the update, if the update requires additional frameworks to be installed etc. - -#### `public void `[`applyUpdatesAndRestart`](#class_velopack_1_1_update_manager_sync_1a69a296e31573c3173c418758d333dc51)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply,const std::vector< std::string > * restartArgs) const` {#class_velopack_1_1_update_manager_sync_1a69a296e31573c3173c418758d333dc51} - -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified restart arguments. If you need to save state or clean up, you should do that before calling this method. The user may be prompted during the update, if the update requires additional frameworks to be installed etc. - -#### `public void `[`waitExitThenApplyUpdates`](#class_velopack_1_1_update_manager_sync_1aa6b15d1cf21d21aee749b38a224570c3)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply,bool silent,bool restart,const std::vector< std::string > * restartArgs) const` {#class_velopack_1_1_update_manager_sync_1aa6b15d1cf21d21aee749b38a224570c3} - -This will launch the Velopack updater and tell it to wait for this program to exit gracefully. You should then clean up any state and exit your app. The updater will apply updates and then optionally restart your app. The updater will only wait for 60 seconds before giving up. - -#### `protected std::vector< std::string > `[`getCurrentVersionCommand`](#class_velopack_1_1_update_manager_sync_1adb80fec8671f6ad9b4e3cf9fa5dbe458)`() const` {#class_velopack_1_1_update_manager_sync_1adb80fec8671f6ad9b4e3cf9fa5dbe458} - -Returns the command line arguments to get the current version of the application. - -#### `protected std::vector< std::string > `[`getCheckForUpdatesCommand`](#class_velopack_1_1_update_manager_sync_1a4d66d76a07cddda53ce3fd3a3306e6a9)`() const` {#class_velopack_1_1_update_manager_sync_1a4d66d76a07cddda53ce3fd3a3306e6a9} - -Returns the command line arguments to check for updates. - -#### `protected std::vector< std::string > `[`getDownloadUpdatesCommand`](#class_velopack_1_1_update_manager_sync_1aa28503793c51523b98d5384ad3f6a28f)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toDownload) const` {#class_velopack_1_1_update_manager_sync_1aa28503793c51523b98d5384ad3f6a28f} - -Returns the command line arguments to download the specified update. - -#### `protected std::vector< std::string > `[`getUpdateApplyCommand`](#class_velopack_1_1_update_manager_sync_1a47232672aab9d74f593a2bfe29f5eb3d)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply,bool silent,bool restart,bool wait,const std::vector< std::string > * restartArgs) const` {#class_velopack_1_1_update_manager_sync_1a47232672aab9d74f593a2bfe29f5eb3d} - -Returns the command line arguments to apply the specified update. - -#### `protected std::string `[`getPackagesDir`](#class_velopack_1_1_update_manager_sync_1a8b0d484bcc50fc316ef662ecd5e09093)`() const` {#class_velopack_1_1_update_manager_sync_1a8b0d484bcc50fc316ef662ecd5e09093} - -Returns the path to the app's packages directory. This is where updates are downloaded to. - -## class `Velopack::VelopackAsset` {#class_velopack_1_1_velopack_asset} - -An individual Velopack asset, could refer to an asset on-disk or in a remote package feed. - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public std::string `[`packageId`](#class_velopack_1_1_velopack_asset_1a644d04e0fcd56f7639db2d912a575d72) | The name or Id of the package containing this release. -`public std::string `[`version`](#class_velopack_1_1_velopack_asset_1a7afd3e784db4b8141e1abe936d91ed11) | The version of this release. -`public VelopackAssetType `[`type`](#class_velopack_1_1_velopack_asset_1a3bbb06f6e4d755e2a84e1df058e0aadd) | The type of asset (eg. full or delta). -`public std::string `[`fileName`](#class_velopack_1_1_velopack_asset_1ae1d567970986a7d24cfea97fe6834f1a) | The filename of the update package containing this release. -`public std::string `[`sha1`](#class_velopack_1_1_velopack_asset_1afe7b08c38ffad131e0d1edbc12847373) | The SHA1 checksum of the update package containing this release. -`public int64_t `[`size`](#class_velopack_1_1_velopack_asset_1a6ca5d1466adf5159e95f9656c62bc92a) | The size in bytes of the update package containing this release. -`public std::string `[`notesMarkdown`](#class_velopack_1_1_velopack_asset_1a3b904d81dda60c6953fedc54d058da9e) | The release notes in markdown format, as passed to Velopack when packaging the release. -`public std::string `[`notesHTML`](#class_velopack_1_1_velopack_asset_1aa8d00f3e2a6d7735a37663e7531791a1) | The release notes in HTML format, transformed from Markdown when packaging the release. -`public `[`VelopackAsset`](#class_velopack_1_1_velopack_asset_1a8185777fc17f66b0258e949c3e421231)`() = default` | - -#### Members - -#### `public std::string `[`packageId`](#class_velopack_1_1_velopack_asset_1a644d04e0fcd56f7639db2d912a575d72) {#class_velopack_1_1_velopack_asset_1a644d04e0fcd56f7639db2d912a575d72} - -The name or Id of the package containing this release. - -#### `public std::string `[`version`](#class_velopack_1_1_velopack_asset_1a7afd3e784db4b8141e1abe936d91ed11) {#class_velopack_1_1_velopack_asset_1a7afd3e784db4b8141e1abe936d91ed11} - -The version of this release. - -#### `public VelopackAssetType `[`type`](#class_velopack_1_1_velopack_asset_1a3bbb06f6e4d755e2a84e1df058e0aadd) {#class_velopack_1_1_velopack_asset_1a3bbb06f6e4d755e2a84e1df058e0aadd} - -The type of asset (eg. full or delta). - -#### `public std::string `[`fileName`](#class_velopack_1_1_velopack_asset_1ae1d567970986a7d24cfea97fe6834f1a) {#class_velopack_1_1_velopack_asset_1ae1d567970986a7d24cfea97fe6834f1a} - -The filename of the update package containing this release. - -#### `public std::string `[`sha1`](#class_velopack_1_1_velopack_asset_1afe7b08c38ffad131e0d1edbc12847373) {#class_velopack_1_1_velopack_asset_1afe7b08c38ffad131e0d1edbc12847373} - -The SHA1 checksum of the update package containing this release. - -#### `public int64_t `[`size`](#class_velopack_1_1_velopack_asset_1a6ca5d1466adf5159e95f9656c62bc92a) {#class_velopack_1_1_velopack_asset_1a6ca5d1466adf5159e95f9656c62bc92a} - -The size in bytes of the update package containing this release. - -#### `public std::string `[`notesMarkdown`](#class_velopack_1_1_velopack_asset_1a3b904d81dda60c6953fedc54d058da9e) {#class_velopack_1_1_velopack_asset_1a3b904d81dda60c6953fedc54d058da9e} - -The release notes in markdown format, as passed to Velopack when packaging the release. - -#### `public std::string `[`notesHTML`](#class_velopack_1_1_velopack_asset_1aa8d00f3e2a6d7735a37663e7531791a1) {#class_velopack_1_1_velopack_asset_1aa8d00f3e2a6d7735a37663e7531791a1} - -The release notes in HTML format, transformed from Markdown when packaging the release. - -#### `public `[`VelopackAsset`](#class_velopack_1_1_velopack_asset_1a8185777fc17f66b0258e949c3e421231)`() = default` {#class_velopack_1_1_velopack_asset_1a8185777fc17f66b0258e949c3e421231} - -## struct `subprocess_s` {#structsubprocess__s} - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public FILE * `[`stdin_file`](#structsubprocess__s_1ada32f1e1e07a418e4a4d7d57677e44f0) | -`public FILE * `[`stdout_file`](#structsubprocess__s_1a49ea739e96d4555a1de30358de62034c) | -`public FILE * `[`stderr_file`](#structsubprocess__s_1ac44a1727285472c541281bada32db7ea) | -`public pid_t `[`child`](#structsubprocess__s_1a30b0a7616f06a6374de9c52268e6c9e3) | -`public int `[`return_status`](#structsubprocess__s_1a4a6027dbf0c75e5adee516ddf0c99860) | -`public subprocess_size_t `[`alive`](#structsubprocess__s_1ae931c423d39d981ab8b10cbdd49ae5ad) | - -#### Members - -#### `public FILE * `[`stdin_file`](#structsubprocess__s_1ada32f1e1e07a418e4a4d7d57677e44f0) {#structsubprocess__s_1ada32f1e1e07a418e4a4d7d57677e44f0} - -#### `public FILE * `[`stdout_file`](#structsubprocess__s_1a49ea739e96d4555a1de30358de62034c) {#structsubprocess__s_1a49ea739e96d4555a1de30358de62034c} - -#### `public FILE * `[`stderr_file`](#structsubprocess__s_1ac44a1727285472c541281bada32db7ea) {#structsubprocess__s_1ac44a1727285472c541281bada32db7ea} - -#### `public pid_t `[`child`](#structsubprocess__s_1a30b0a7616f06a6374de9c52268e6c9e3) {#structsubprocess__s_1a30b0a7616f06a6374de9c52268e6c9e3} - -#### `public int `[`return_status`](#structsubprocess__s_1a4a6027dbf0c75e5adee516ddf0c99860) {#structsubprocess__s_1a4a6027dbf0c75e5adee516ddf0c99860} - -#### `public subprocess_size_t `[`alive`](#structsubprocess__s_1ae931c423d39d981ab8b10cbdd49ae5ad) {#structsubprocess__s_1ae931c423d39d981ab8b10cbdd49ae5ad} - -Generated by [Moxygen](https://sourcey.com/moxygen) \ No newline at end of file diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/ChecksumFailedException.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/ChecksumFailedException.md deleted file mode 100644 index 590eee3..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/ChecksumFailedException.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Class ChecksumFailedException -sidebar_label: ChecksumFailedException -description: "Represents an error that occurs when a package does not match it's expected SHA checksum" ---- -# Class ChecksumFailedException -Represents an error that occurs when a package does not match it's expected SHA checksum - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Compression/ChecksumFailedException.cs#L9) -```csharp title="Declaration" -public class ChecksumFailedException : Exception, ISerializable, _Exception -``` -**Inheritance:** `System.Object` -> `System.Exception` - -**Implements:** -`System.Runtime.Serialization.ISerializable`, `System.Runtime.InteropServices._Exception` - -## Properties -### FilePath -The filename of the package which failed validation -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Compression/ChecksumFailedException.cs#L15) -```csharp title="Declaration" -public string FilePath { get; } -``` - -## Implements - -* `System.Runtime.Serialization.ISerializable` -* `System.Runtime.InteropServices._Exception` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/Velopack.Compression.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/Velopack.Compression.md deleted file mode 100644 index 70d33ef..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/Velopack.Compression.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Namespace Velopack.Compression -sidebar_label: Velopack.Compression ---- -# Namespace Velopack.Compression -## Classes -### [ChecksumFailedException](../Velopack.Compression/ChecksumFailedException) -Represents an error that occurs when a package does not match it's expected SHA checksum diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/IVelopackLocator.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/IVelopackLocator.md deleted file mode 100644 index 4bb7bf6..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/IVelopackLocator.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: Interface IVelopackLocator -sidebar_label: IVelopackLocator -description: "An interface describing where Velopack can find key folders and files." ---- -# Interface IVelopackLocator -An interface describing where Velopack can find key folders and files. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L10) -```csharp title="Declaration" -public interface IVelopackLocator -``` -## Properties -### AppId -The unique application Id. This is used in various app paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L13) -```csharp title="Declaration" -string? AppId { get; } -``` -### RootAppDir -The root directory of the application. On Windows, this folder contains all -the application files, but that may not be the case on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L19) -```csharp title="Declaration" -string? RootAppDir { get; } -``` -### PackagesDir -The directory in which nupkg files are stored for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L22) -```csharp title="Declaration" -string? PackagesDir { get; } -``` -### AppContentDir -The directory in which versioned application files are stored. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L25) -```csharp title="Declaration" -string? AppContentDir { get; } -``` -### AppTempDir -The temporary directory for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L28) -```csharp title="Declaration" -string? AppTempDir { get; } -``` -### UpdateExePath -The path to the current Update.exe or similar on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L31) -```csharp title="Declaration" -string? UpdateExePath { get; } -``` -### CurrentlyInstalledVersion -The currently installed version of the application, or null if the app is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L34) -```csharp title="Declaration" -SemanticVersion? CurrentlyInstalledVersion { get; } -``` -### ThisExeRelativePath -The path from [Velopack.Locators.IVelopackLocator.AppContentDir](../Velopack.Locators/IVelopackLocator#appcontentdir) to this executable. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L37) -```csharp title="Declaration" -string? ThisExeRelativePath { get; } -``` -### Channel -The release channel this package was built for. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L40) -```csharp title="Declaration" -string? Channel { get; } -``` -## Methods -### GetLocalPackages() -Finds .nupkg files in the PackagesDir and returns a list of ReleaseEntryName objects. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L45) -```csharp title="Declaration" -List GetLocalPackages() -``` - -##### Returns - -`System.Collections.Generic.List` -### GetLatestLocalFullPackage() -Finds latest .nupkg file in the PackagesDir or null if not found. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L50) -```csharp title="Declaration" -VelopackAsset? GetLatestLocalFullPackage() -``` - -##### Returns - -[Velopack.VelopackAsset](../Velopack/VelopackAsset) -### GetOrCreateStagedUserId() -Unique identifier for this user which is used to calculate whether this user is eligible for -staged roll outs. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L56) -```csharp title="Declaration" -Guid? GetOrCreateStagedUserId() -``` - -##### Returns - -`System.Nullable` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/LinuxVelopackLocator.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/LinuxVelopackLocator.md deleted file mode 100644 index c7c3511..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/LinuxVelopackLocator.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Class LinuxVelopackLocator -sidebar_label: LinuxVelopackLocator -description: "The default for OSX. All application files will remain in the '.app'. -All additional files (log, etc) will be placed in a temporary directory." ---- -# Class LinuxVelopackLocator -The default for OSX. All application files will remain in the '.app'. -All additional files (log, etc) will be placed in a temporary directory. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L14) -```csharp title="Declaration" -public class LinuxVelopackLocator : VelopackLocator, IVelopackLocator -``` -**Inheritance:** `System.Object` -> [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator) - -**Implements:** -[Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) - -## Properties -### AppId -The unique application Id. This is used in various app paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L18) -```csharp title="Declaration" -public override string? AppId { get; } -``` -### RootAppDir -The root directory of the application. On Windows, this folder contains all -the application files, but that may not be the case on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L21) -```csharp title="Declaration" -public override string? RootAppDir { get; } -``` -### UpdateExePath -The path to the current Update.exe or similar on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L24) -```csharp title="Declaration" -public override string? UpdateExePath { get; } -``` -### CurrentlyInstalledVersion -The currently installed version of the application, or null if the app is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L27) -```csharp title="Declaration" -public override SemanticVersion? CurrentlyInstalledVersion { get; } -``` -### AppContentDir -The directory in which versioned application files are stored. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L30) -```csharp title="Declaration" -public override string? AppContentDir { get; } -``` -### Channel -The release channel this package was built for. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L33) -```csharp title="Declaration" -public override string? Channel { get; } -``` -### AppTempDir -The temporary directory for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L36) -```csharp title="Declaration" -public override string? AppTempDir { get; } -``` -### PackagesDir -The directory in which nupkg files are stored for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L39) -```csharp title="Declaration" -public override string? PackagesDir { get; } -``` -### PersistentTempDir -/var/tmp/{velopack}/{appid}, for storing app specific files which need to be preserved. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L42) -```csharp title="Declaration" -public string? PersistentTempDir { get; } -``` -### PersistentVelopackDir -A pointer to /var/tmp/{velopack}, a location on linux which is semi-persistent. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L45) -```csharp title="Declaration" -public string? PersistentVelopackDir { get; } -``` -### AppImagePath -File path of the .AppImage which mounted and ran this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L48) -```csharp title="Declaration" -public string? AppImagePath { get; } -``` - -## Implements - -* [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/OsxVelopackLocator.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/OsxVelopackLocator.md deleted file mode 100644 index 6cb13de..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/OsxVelopackLocator.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: Class OsxVelopackLocator -sidebar_label: OsxVelopackLocator -description: "The default for OSX. All application files will remain in the '.app'. -All additional files (log, etc) will be placed in a temporary directory." ---- -# Class OsxVelopackLocator -The default for OSX. All application files will remain in the '.app'. -All additional files (log, etc) will be placed in a temporary directory. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L14) -```csharp title="Declaration" -public class OsxVelopackLocator : VelopackLocator, IVelopackLocator -``` -**Inheritance:** `System.Object` -> [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator) - -**Implements:** -[Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) - -## Properties -### AppId -The unique application Id. This is used in various app paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L18) -```csharp title="Declaration" -public override string? AppId { get; } -``` -### RootAppDir -The root directory of the application. On Windows, this folder contains all -the application files, but that may not be the case on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L21) -```csharp title="Declaration" -public override string? RootAppDir { get; } -``` -### UpdateExePath -The path to the current Update.exe or similar on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L24) -```csharp title="Declaration" -public override string? UpdateExePath { get; } -``` -### CurrentlyInstalledVersion -The currently installed version of the application, or null if the app is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L27) -```csharp title="Declaration" -public override SemanticVersion? CurrentlyInstalledVersion { get; } -``` -### AppContentDir -The directory in which versioned application files are stored. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L30) -```csharp title="Declaration" -public override string? AppContentDir { get; } -``` -### AppTempDir -The temporary directory for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L33) -```csharp title="Declaration" -public override string? AppTempDir { get; } -``` -### PackagesDir -The directory in which nupkg files are stored for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L36) -```csharp title="Declaration" -public override string? PackagesDir { get; } -``` -### Channel -The release channel this package was built for. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L39) -```csharp title="Declaration" -public override string? Channel { get; } -``` - -## Implements - -* [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/TestVelopackLocator.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/TestVelopackLocator.md deleted file mode 100644 index 28055a7..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/TestVelopackLocator.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: Class TestVelopackLocator -sidebar_label: TestVelopackLocator -description: "Provides a mock / test implementation of [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator). This can be used to verify that -your application is able to find and prepare updates from your chosen update source without actually -having an installed application. This could be used in a CI/CD pipeline, or unit tests etc." ---- -# Class TestVelopackLocator -Provides a mock / test implementation of [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator). This can be used to verify that -your application is able to find and prepare updates from your chosen update source without actually -having an installed application. This could be used in a CI/CD pipeline, or unit tests etc. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L13) -```csharp title="Declaration" -public class TestVelopackLocator : VelopackLocator, IVelopackLocator -``` -**Inheritance:** `System.Object` -> [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator) - -**Implements:** -[Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) - -## Properties -### AppId -The unique application Id. This is used in various app paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L17) -```csharp title="Declaration" -public override string? AppId { get; } -``` -### RootAppDir -The root directory of the application. On Windows, this folder contains all -the application files, but that may not be the case on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L27) -```csharp title="Declaration" -public override string? RootAppDir { get; } -``` -### PackagesDir -The directory in which nupkg files are stored for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L37) -```csharp title="Declaration" -public override string? PackagesDir { get; } -``` -### UpdateExePath -The path to the current Update.exe or similar on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L47) -```csharp title="Declaration" -public override string? UpdateExePath { get; } -``` -### CurrentlyInstalledVersion -The currently installed version of the application, or null if the app is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L57) -```csharp title="Declaration" -public override SemanticVersion? CurrentlyInstalledVersion { get; } -``` -### AppContentDir -The directory in which versioned application files are stored. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L67) -```csharp title="Declaration" -public override string? AppContentDir { get; } -``` -### Channel -The release channel this package was built for. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L77) -```csharp title="Declaration" -public override string? Channel { get; } -``` -## Methods -### GetLatestLocalFullPackage() -Finds latest .nupkg file in the PackagesDir or null if not found. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L84) -```csharp title="Declaration" -public override VelopackAsset? GetLatestLocalFullPackage() -``` - -##### Returns - -[Velopack.VelopackAsset](../Velopack/VelopackAsset) - -## Implements - -* [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/Velopack.Locators.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/Velopack.Locators.md deleted file mode 100644 index 71cef3e..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/Velopack.Locators.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Namespace Velopack.Locators -sidebar_label: Velopack.Locators ---- -# Namespace Velopack.Locators -## Classes -### [LinuxVelopackLocator](../Velopack.Locators/LinuxVelopackLocator) -The default for OSX. All application files will remain in the '.app'. -All additional files (log, etc) will be placed in a temporary directory. -### [OsxVelopackLocator](../Velopack.Locators/OsxVelopackLocator) -The default for OSX. All application files will remain in the '.app'. -All additional files (log, etc) will be placed in a temporary directory. -### [TestVelopackLocator](../Velopack.Locators/TestVelopackLocator) -Provides a mock / test implementation of [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator). This can be used to verify that -your application is able to find and prepare updates from your chosen update source without actually -having an installed application. This could be used in a CI/CD pipeline, or unit tests etc. -### [VelopackLocator](../Velopack.Locators/VelopackLocator) -A base class describing where Velopack can find key folders and files. -### [WindowsVelopackLocator](../Velopack.Locators/WindowsVelopackLocator) -An implementation for Windows which uses the default paths. -## Interfaces -### [IVelopackLocator](../Velopack.Locators/IVelopackLocator) -An interface describing where Velopack can find key folders and files. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/VelopackLocator.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/VelopackLocator.md deleted file mode 100644 index 3770641..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/VelopackLocator.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: Class VelopackLocator -sidebar_label: VelopackLocator -description: "A base class describing where Velopack can find key folders and files." ---- -# Class VelopackLocator -A base class describing where Velopack can find key folders and files. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L15) -```csharp title="Declaration" -public abstract class VelopackLocator : IVelopackLocator -``` -**Derived:** -[Velopack.Locators.LinuxVelopackLocator](../Velopack.Locators/LinuxVelopackLocator), [Velopack.Locators.OsxVelopackLocator](../Velopack.Locators/OsxVelopackLocator), [Velopack.Locators.TestVelopackLocator](../Velopack.Locators/TestVelopackLocator), [Velopack.Locators.WindowsVelopackLocator](../Velopack.Locators/WindowsVelopackLocator) - -**Implements:** -[Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) - -## Properties -### AppId -The unique application Id. This is used in various app paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L42) -```csharp title="Declaration" -public abstract string? AppId { get; } -``` -### RootAppDir -The root directory of the application. On Windows, this folder contains all -the application files, but that may not be the case on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L45) -```csharp title="Declaration" -public abstract string? RootAppDir { get; } -``` -### PackagesDir -The directory in which nupkg files are stored for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L48) -```csharp title="Declaration" -public abstract string? PackagesDir { get; } -``` -### AppTempDir -The temporary directory for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L51) -```csharp title="Declaration" -public virtual string? AppTempDir { get; } -``` -### UpdateExePath -The path to the current Update.exe or similar on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L54) -```csharp title="Declaration" -public abstract string? UpdateExePath { get; } -``` -### AppContentDir -The directory in which versioned application files are stored. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L57) -```csharp title="Declaration" -public abstract string? AppContentDir { get; } -``` -### Channel -The release channel this package was built for. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L60) -```csharp title="Declaration" -public abstract string? Channel { get; } -``` -### ThisExeRelativePath -The path from [Velopack.Locators.IVelopackLocator.AppContentDir](../Velopack.Locators/IVelopackLocator#appcontentdir) to this executable. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L63) -```csharp title="Declaration" -public virtual string? ThisExeRelativePath { get; } -``` -### CurrentlyInstalledVersion -The currently installed version of the application, or null if the app is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L76) -```csharp title="Declaration" -public abstract SemanticVersion? CurrentlyInstalledVersion { get; } -``` -### Log -The log interface to use for diagnostic messages. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L79) -```csharp title="Declaration" -protected ILogger Log { get; } -``` -## Methods -### GetDefault(ILogger?) -Auto-detect the platform from the current operating system. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L22) -```csharp title="Declaration" -public static VelopackLocator GetDefault(ILogger? logger) -``` - -##### Returns - -[Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | - -### GetLocalPackages() -Finds .nupkg files in the PackagesDir and returns a list of ReleaseEntryName objects. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L88) -```csharp title="Declaration" -public virtual List GetLocalPackages() -``` - -##### Returns - -`System.Collections.Generic.List` -### GetLatestLocalFullPackage() -Finds latest .nupkg file in the PackagesDir or null if not found. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L115) -```csharp title="Declaration" -public virtual VelopackAsset? GetLatestLocalFullPackage() -``` - -##### Returns - -[Velopack.VelopackAsset](../Velopack/VelopackAsset) -### CreateSubDirIfDoesNotExist(string?, string?) -Given a base dir and a directory name, will create a new sub directory of that name. -Will return null if baseDir is null, or if baseDir does not exist. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L127) -```csharp title="Declaration" -protected static string? CreateSubDirIfDoesNotExist(string? baseDir, string? newDir) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *baseDir* | -| `System.String` | *newDir* | - -### GetOrCreateStagedUserId() -Unique identifier for this user which is used to calculate whether this user is eligible for -staged roll outs. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L138) -```csharp title="Declaration" -public Guid? GetOrCreateStagedUserId() -``` - -##### Returns - -`System.Nullable` - -## Implements - -* [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/WindowsVelopackLocator.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/WindowsVelopackLocator.md deleted file mode 100644 index 447e77f..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/WindowsVelopackLocator.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: Class WindowsVelopackLocator -sidebar_label: WindowsVelopackLocator -description: "An implementation for Windows which uses the default paths." ---- -# Class WindowsVelopackLocator -An implementation for Windows which uses the default paths. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L13) -```csharp title="Declaration" -public class WindowsVelopackLocator : VelopackLocator, IVelopackLocator -``` -**Inheritance:** `System.Object` -> [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator) - -**Implements:** -[Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) - -## Properties -### AppId -The unique application Id. This is used in various app paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L17) -```csharp title="Declaration" -public override string? AppId { get; } -``` -### RootAppDir -The root directory of the application. On Windows, this folder contains all -the application files, but that may not be the case on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L20) -```csharp title="Declaration" -public override string? RootAppDir { get; } -``` -### UpdateExePath -The path to the current Update.exe or similar on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L23) -```csharp title="Declaration" -public override string? UpdateExePath { get; } -``` -### AppContentDir -The directory in which versioned application files are stored. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L26) -```csharp title="Declaration" -public override string? AppContentDir { get; } -``` -### CurrentlyInstalledVersion -The currently installed version of the application, or null if the app is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L29) -```csharp title="Declaration" -public override SemanticVersion? CurrentlyInstalledVersion { get; } -``` -### PackagesDir -The directory in which nupkg files are stored for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L32) -```csharp title="Declaration" -public override string? PackagesDir { get; } -``` -### Channel -The release channel this package was built for. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L35) -```csharp title="Declaration" -public override string? Channel { get; } -``` - -## Implements - -* [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/PackageManifest.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/PackageManifest.md deleted file mode 100644 index fb6bf8d..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/PackageManifest.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: Class PackageManifest -sidebar_label: PackageManifest ---- -# Class PackageManifest - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L11) -```csharp title="Declaration" -public class PackageManifest -``` -**Derived:** -[Velopack.NuGet.ZipPackage](../Velopack.NuGet/ZipPackage) - -## Properties -### ProductName - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L13) -```csharp title="Declaration" -public string? ProductName { get; } -``` -### ProductDescription - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L14) -```csharp title="Declaration" -public string? ProductDescription { get; } -``` -### ProductCompany - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L15) -```csharp title="Declaration" -public string? ProductCompany { get; } -``` -### ProductCopyright - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L16) -```csharp title="Declaration" -public string? ProductCopyright { get; } -``` -### Id - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L17) -```csharp title="Declaration" -public string? Id { get; } -``` -### Version - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L18) -```csharp title="Declaration" -public SemanticVersion? Version { get; } -``` -### ProjectUrl - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L19) -```csharp title="Declaration" -public Uri? ProjectUrl { get; } -``` -### ReleaseNotes - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L20) -```csharp title="Declaration" -public string? ReleaseNotes { get; } -``` -### ReleaseNotesHtml - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L21) -```csharp title="Declaration" -public string? ReleaseNotesHtml { get; } -``` -### IconUrl - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L22) -```csharp title="Declaration" -public Uri? IconUrl { get; } -``` -### Language - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L23) -```csharp title="Declaration" -public string? Language { get; } -``` -### Channel - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L24) -```csharp title="Declaration" -public string? Channel { get; } -``` -### Description - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L25) -```csharp title="Declaration" -public string? Description { get; } -``` -### Owners - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L26) -```csharp title="Declaration" -public string? Owners { get; } -``` -### Title - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L27) -```csharp title="Declaration" -public string? Title { get; } -``` -### Summary - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L28) -```csharp title="Declaration" -public string? Summary { get; } -``` -### Copyright - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L29) -```csharp title="Declaration" -public string? Copyright { get; } -``` -### Authors - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L30) -```csharp title="Declaration" -public IEnumerable Authors { get; } -``` -### RuntimeDependencies - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L31) -```csharp title="Declaration" -public IEnumerable RuntimeDependencies { get; } -``` -## Methods -### ParseFromFile(string) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L37) -```csharp title="Declaration" -public static PackageManifest ParseFromFile(string filePath) -``` - -##### Returns - -[Velopack.NuGet.PackageManifest](../Velopack.NuGet/PackageManifest) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *filePath* | - -### TryParseFromFile(string, out PackageManifest) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L46) -```csharp title="Declaration" -public static bool TryParseFromFile(string filePath, out PackageManifest manifest) -``` - -##### Returns - -`System.Boolean` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *filePath* | -| [Velopack.NuGet.PackageManifest](../Velopack.NuGet/PackageManifest) | *manifest* | - -### ReadManifest(Stream) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L57) -```csharp title="Declaration" -protected void ReadManifest(Stream manifestStream) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.IO.Stream` | *manifestStream* | - -### IsPackageFile(string) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L143) -```csharp title="Declaration" -protected bool IsPackageFile(string partPath) -``` - -##### Returns - -`System.Boolean` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *partPath* | - diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/Velopack.NuGet.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/Velopack.NuGet.md deleted file mode 100644 index 306de1c..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/Velopack.NuGet.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Namespace Velopack.NuGet -sidebar_label: Velopack.NuGet ---- -# Namespace Velopack.NuGet -## Classes -### [PackageManifest](../Velopack.NuGet/PackageManifest) - -### [ZipPackage](../Velopack.NuGet/ZipPackage) - -### [ZipPackageFile](../Velopack.NuGet/ZipPackageFile) - diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackage.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackage.md deleted file mode 100644 index 92c79b2..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackage.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Class ZipPackage -sidebar_label: ZipPackage ---- -# Class ZipPackage - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackage.cs#L10) -```csharp title="Declaration" -public class ZipPackage : PackageManifest -``` -**Inheritance:** `System.Object` -> [Velopack.NuGet.PackageManifest](../Velopack.NuGet/PackageManifest) - -## Properties -### Files - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackage.cs#L12) -```csharp title="Declaration" -public IEnumerable Files { get; } -``` -### UpdateExeBytes - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackage.cs#L14) -```csharp title="Declaration" -public byte[]? UpdateExeBytes { get; } -``` -### LoadedFromPath - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackage.cs#L16) -```csharp title="Declaration" -public string LoadedFromPath { get; } -``` -## Methods -### ReadFile(ZipArchive, Func<ZipArchiveEntry, bool>) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackage.cs#L33) -```csharp title="Declaration" -protected byte[]? ReadFile(ZipArchive archive, Func predicate) -``` - -##### Returns - -`System.Byte[]` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.IO.Compression.ZipArchive` | *archive* | -| `System.Func` | *predicate* | - diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackageFile.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackageFile.md deleted file mode 100644 index 55b3735..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackageFile.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -title: Class ZipPackageFile -sidebar_label: ZipPackageFile ---- -# Class ZipPackageFile - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L6) -```csharp title="Declaration" -public class ZipPackageFile : IEquatable -``` -**Implements:** -`System.IEquatable` - -## Properties -### Key - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L8) -```csharp title="Declaration" -public Uri Key { get; } -``` -### EffectivePath - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L9) -```csharp title="Declaration" -public string EffectivePath { get; } -``` -### TargetFramework - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L10) -```csharp title="Declaration" -public string TargetFramework { get; } -``` -### Path - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L11) -```csharp title="Declaration" -public string Path { get; } -``` -## Methods -### IsLibFile() - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L21) -```csharp title="Declaration" -public bool IsLibFile() -``` - -##### Returns - -`System.Boolean` -### IsContentFile() - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L22) -```csharp title="Declaration" -public bool IsContentFile() -``` - -##### Returns - -`System.Boolean` -### IsFileInTopDirectory(string) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L24) -```csharp title="Declaration" -public bool IsFileInTopDirectory(string directory) -``` - -##### Returns - -`System.Boolean` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *directory* | - -### ToString() -Returns a string that represents the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L30) -```csharp title="Declaration" -public override string ToString() -``` - -##### Returns - -`System.String`: A string that represents the current object.### GetHashCode() -Serves as the default hash function. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L32) -```csharp title="Declaration" -public override int GetHashCode() -``` - -##### Returns - -`System.Int32`: A hash code for the current object.### Equals(object?) -Determines whether the specified object is equal to the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L34) -```csharp title="Declaration" -public override bool Equals(object? obj) -``` - -##### Returns - -`System.Boolean`: true if the specified object is equal to the current object; otherwise, false. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.Object` | *obj* | The object to compare with the current object. | - -### Equals(ZipPackageFile?) -Indicates whether the current object is equal to another object of the same type. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L41) -```csharp title="Declaration" -public bool Equals(ZipPackageFile? other) -``` - -##### Returns - -`System.Boolean`: true if the current object is equal to the <code class="paramref">other</code> parameter; otherwise, false. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.NuGet.ZipPackageFile](../Velopack.NuGet/ZipPackageFile) | *other* | An object to compare with this object. | - - -## Implements - -* `System.IEquatable` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.GitBaseAsset.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.GitBaseAsset.md deleted file mode 100644 index a9cbc6c..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.GitBaseAsset.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Class GitBase.GitBaseAsset -sidebar_label: GitBase.GitBaseAsset -description: "Provides a wrapper around [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) which also contains a Git Release." ---- -# Class GitBase<T>.GitBaseAsset -Provides a wrapper around [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) which also contains a Git Release. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L114) -```csharp title="Declaration" -protected record GitBase.GitBaseAsset : VelopackAsset, IEquatable, IEquatable.GitBaseAsset> -``` -**Inheritance:** `System.Object` -> [Velopack.VelopackAsset](../Velopack/VelopackAsset) - -**Implements:** -`System.IEquatable`, `System.IEquatable` - -## Properties -### Release -The Github release which contains this release package. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L117) -```csharp title="Declaration" -public T Release { get; init; } -``` - -## Implements - -* `System.IEquatable` -* `System.IEquatable` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.md deleted file mode 100644 index b1d70c5..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -title: Class GitBase -sidebar_label: GitBase -description: "Base class to provide some shared implementation between sources which download releases from a Git repository." ---- -# Class GitBase<T> -Base class to provide some shared implementation between sources which download releases from a Git repository. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L13) -```csharp title="Declaration" -public abstract class GitBase : IUpdateSource -``` -**Derived:** -[Velopack.Sources.GithubSource](../Velopack.Sources/GithubSource), [Velopack.Sources.GitlabSource](../Velopack.Sources/GitlabSource) - -**Implements:** -[Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) - -## Properties -### RepoUri -The URL of the repository to download releases from. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L18) -```csharp title="Declaration" -public virtual Uri RepoUri { get; } -``` -### Prerelease -If true, the latest upcoming/prerelease release will be downloaded. If false, the latest -stable release will be downloaded. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L24) -```csharp title="Declaration" -public virtual bool Prerelease { get; } -``` -### Downloader -The file downloader used to perform HTTP requests. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L29) -```csharp title="Declaration" -public virtual IFileDownloader Downloader { get; } -``` -### AccessToken -The GitLab access token to use with the request to download releases. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L34) -```csharp title="Declaration" -protected virtual string? AccessToken { get; } -``` -### Authorization -The Bearer token used in the request. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L39) -```csharp title="Declaration" -protected virtual string? Authorization { get; } -``` -## Methods -### DownloadReleaseEntry(ILogger, VelopackAsset, string, Action<int>, CancellationToken) -Download the specified [Velopack.VelopackAsset](../Velopack/VelopackAsset) to the provided local file path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L51) -```csharp title="Declaration" -public virtual Task DownloadReleaseEntry(ILogger logger, VelopackAsset releaseEntry, string localFile, Action progress, CancellationToken cancelToken) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *releaseEntry* | The release to download. | -| `System.String` | *localFile* | The path on the local disk to store the file. If this file exists, - it will be overwritten. | -| `System.Action` | *progress* | This delegate will be executed with values from 0-100 as the - download is being processed. | -| `System.Threading.CancellationToken` | *cancelToken* | A token to use to cancel the request. | - -### GetReleaseFeed(ILogger, string, Guid?, VelopackAsset?) -Retrieve the list of available remote releases from the package source. These releases -can subsequently be downloaded with `Velopack.Sources.IUpdateSource.DownloadReleaseEntry(Microsoft.Extensions.Logging.ILogger%2cVelopack.VelopackAsset%2cSystem.String%2cSystem.Action%7bSystem.Int32%7d%2cSystem.Threading.CancellationToken)`. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L64) -```csharp title="Declaration" -public virtual Task GetReleaseFeed(ILogger logger, string channel, Guid? stagingId = null, VelopackAsset? latestLocalRelease = null) -``` - -##### Returns - -`System.Threading.Tasks.Task`: An array of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) objects that are available for download - and are applicable to this user. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| `System.String` | *channel* | Release channel to filter packages by. Can be null, which is the - default channel for this operating system. | -| `System.Nullable` | *stagingId* | A persistent user-id, used for calculating whether a specific - release should be available to this user or not. (eg, for the purposes of rolling out - an update to only a small portion of users at a time). | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestLocalRelease* | The latest / current local release. If specified, - metadata from this package may be provided to the remote server (such as package id, - or cpu architecture) to ensure that the correct package is downloaded for this user. | - -### GetReleases(bool) -Retrieves a list of [Velopack.Sources.GithubRelease](../Velopack.Sources/GithubRelease) from the current repository. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L101) -```csharp title="Declaration" -protected abstract Task GetReleases(bool includePrereleases) -``` - -##### Returns - -`System.Threading.Tasks.Task<[]>` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Boolean` | *includePrereleases* | - -### GetAssetUrlFromName(T, string) -Given a [Velopack.Sources.GithubRelease](../Velopack.Sources/GithubRelease) and an asset filename (eg. 'RELEASES') this -function will return either [Velopack.Sources.GithubReleaseAsset.BrowserDownloadUrl](../Velopack.Sources/GithubReleaseAsset#browserdownloadurl) or -[Velopack.Sources.GithubReleaseAsset.Url](../Velopack.Sources/GithubReleaseAsset#url), depending whether an access token is available -or not. Throws if the specified release has no matching assets. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L109) -```csharp title="Declaration" -protected abstract string GetAssetUrlFromName(T release, string assetName) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `` | *release* | -| `System.String` | *assetName* | - - -## Implements - -* [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubRelease.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubRelease.md deleted file mode 100644 index 8a809ce..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubRelease.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Class GithubRelease -sidebar_label: GithubRelease -description: "Describes a GitHub release, including attached assets." ---- -# Class GithubRelease -Describes a GitHub release, including attached assets. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L11) -```csharp title="Declaration" -public class GithubRelease -``` -## Properties -### Name -The name of this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L14) -```csharp title="Declaration" -public string? Name { get; set; } -``` -### Prerelease -True if this release is a prerelease. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L18) -```csharp title="Declaration" -public bool Prerelease { get; set; } -``` -### PublishedAt -The date which this release was published publicly. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L22) -```csharp title="Declaration" -public DateTime? PublishedAt { get; set; } -``` -### Assets -A list of assets (files) uploaded to this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L26) -```csharp title="Declaration" -public GithubReleaseAsset[] Assets { get; set; } -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubReleaseAsset.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubReleaseAsset.md deleted file mode 100644 index df17efd..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubReleaseAsset.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Class GithubReleaseAsset -sidebar_label: GithubReleaseAsset -description: "Describes a asset (file) uploaded to a GitHub release." ---- -# Class GithubReleaseAsset -Describes a asset (file) uploaded to a GitHub release. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L31) -```csharp title="Declaration" -public class GithubReleaseAsset -``` -## Properties -### Url -The asset URL for this release asset. Requests to this URL will use API -quota and return JSON unless the 'Accept' header is "application/octet-stream". -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L37) -```csharp title="Declaration" -public string? Url { get; set; } -``` -### BrowserDownloadUrl -The browser URL for this release asset. This does not use API quota, -however this URL only works for public repositories. If downloading -assets from a private repository, the [Velopack.Sources.GithubReleaseAsset.Url](../Velopack.Sources/GithubReleaseAsset#url) property must -be used with an appropriate access token. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L46) -```csharp title="Declaration" -public string? BrowserDownloadUrl { get; set; } -``` -### Name -The name of this release asset. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L50) -```csharp title="Declaration" -public string? Name { get; set; } -``` -### ContentType -The mime type of this release asset (as detected by GitHub). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L54) -```csharp title="Declaration" -public string? ContentType { get; set; } -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubSource.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubSource.md deleted file mode 100644 index cc1caa1..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubSource.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: Class GithubSource -sidebar_label: GithubSource -description: "Retrieves available releases from a GitHub repository." ---- -# Class GithubSource -Retrieves available releases from a GitHub repository. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L61) -```csharp title="Declaration" -public class GithubSource : GitBase, IUpdateSource -``` -**Inheritance:** `System.Object` -> [Velopack.Sources.GitBase<T>](../Velopack.Sources/GitBase`T`) - -**Implements:** -[Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) - -## Methods -### GetReleases(bool) -Retrieves a list of [Velopack.Sources.GithubRelease](../Velopack.Sources/GithubRelease) from the current repository. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L86) -```csharp title="Declaration" -protected override Task GetReleases(bool includePrereleases) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Boolean` | *includePrereleases* | - -### GetAssetUrlFromName(GithubRelease, string) -Given a [Velopack.Sources.GithubRelease](../Velopack.Sources/GithubRelease) and an asset filename (eg. 'RELEASES') this -function will return either [Velopack.Sources.GithubReleaseAsset.BrowserDownloadUrl](../Velopack.Sources/GithubReleaseAsset#browserdownloadurl) or -[Velopack.Sources.GithubReleaseAsset.Url](../Velopack.Sources/GithubReleaseAsset#url), depending whether an access token is available -or not. Throws if the specified release has no matching assets. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L101) -```csharp title="Declaration" -protected override string GetAssetUrlFromName(GithubRelease release, string assetName) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Sources.GithubRelease](../Velopack.Sources/GithubRelease) | *release* | -| `System.String` | *assetName* | - -### GetApiBaseUrl(Uri) -Given a repository URL (e.g. https://github.com/myuser/myrepo) this function -returns the API base for performing requests. (eg. "https://api.github.com/" -or http://internal.github.server.local/api/v3) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L135) -```csharp title="Declaration" -protected virtual Uri GetApiBaseUrl(Uri repoUrl) -``` - -##### Returns - -`System.Uri` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Uri` | *repoUrl* | - - -## Implements - -* [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabRelease.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabRelease.md deleted file mode 100644 index 8c99ff2..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabRelease.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Class GitlabRelease -sidebar_label: GitlabRelease -description: "Describes a Gitlab release, plus any assets that are attached." ---- -# Class GitlabRelease -Describes a Gitlab release, plus any assets that are attached. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L13) -```csharp title="Declaration" -public class GitlabRelease -``` -## Properties -### Name -The name of the release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L18) -```csharp title="Declaration" -public string? Name { get; set; } -``` -### UpcomingRelease -True if this is intended for an upcoming release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L24) -```csharp title="Declaration" -public bool UpcomingRelease { get; set; } -``` -### ReleasedAt -The date which this release was published publicly. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L30) -```csharp title="Declaration" -public DateTime? ReleasedAt { get; set; } -``` -### Assets -A container for the assets (files) uploaded to this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L36) -```csharp title="Declaration" -public GitlabReleaseAsset? Assets { get; set; } -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseAsset.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseAsset.md deleted file mode 100644 index baf160e..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseAsset.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Class GitlabReleaseAsset -sidebar_label: GitlabReleaseAsset -description: "Describes a container for the assets attached to a release." ---- -# Class GitlabReleaseAsset -Describes a container for the assets attached to a release. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L43) -```csharp title="Declaration" -public class GitlabReleaseAsset -``` -## Properties -### Count -The amount of assets linked to the release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L48) -```csharp title="Declaration" -public int Count { get; set; } -``` -### Links -A list of asset (file) links. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L54) -```csharp title="Declaration" -public GitlabReleaseLink[] Links { get; set; } -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseLink.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseLink.md deleted file mode 100644 index b070c2c..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseLink.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Class GitlabReleaseLink -sidebar_label: GitlabReleaseLink -description: "Describes a container for the links of assets attached to a release." ---- -# Class GitlabReleaseLink -Describes a container for the links of assets attached to a release. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L61) -```csharp title="Declaration" -public class GitlabReleaseLink -``` -## Properties -### Name -Name of the asset (file) linked. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L66) -```csharp title="Declaration" -public string? Name { get; set; } -``` -### Url -The url for the asset. This make use of the Gitlab API. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L72) -```csharp title="Declaration" -public string? Url { get; set; } -``` -### DirectAssetUrl -A direct url to the asset, via a traditional URl. -As a posed to using the API. -This links directly to the raw asset (file). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L80) -```csharp title="Declaration" -public string? DirectAssetUrl { get; set; } -``` -### Type -The category type that the asset is listed under. -Options: 'Package', 'Image', 'Runbook', 'Other' -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L87) -```csharp title="Declaration" -public string? Type { get; set; } -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabSource.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabSource.md deleted file mode 100644 index 1f80b20..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabSource.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Class GitlabSource -sidebar_label: GitlabSource -description: "Retrieves available releases from a GitLab repository. This class only -downloads assets from the very latest GitLab release." ---- -# Class GitlabSource -Retrieves available releases from a GitLab repository. This class only -downloads assets from the very latest GitLab release. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L95) -```csharp title="Declaration" -public class GitlabSource : GitBase, IUpdateSource -``` -**Inheritance:** `System.Object` -> [Velopack.Sources.GitBase<T>](../Velopack.Sources/GitBase`T`) - -**Implements:** -[Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) - -## Methods -### GetAssetUrlFromName(GitlabRelease, string) -Given a [Velopack.Sources.GitlabRelease](../Velopack.Sources/GitlabRelease) and an asset filename (eg. 'RELEASES') this -function will return either [Velopack.Sources.GitlabReleaseLink.DirectAssetUrl](../Velopack.Sources/GitlabReleaseLink#directasseturl) or -[Velopack.Sources.GitlabReleaseLink.Url](../Velopack.Sources/GitlabReleaseLink#url), depending whether an access token is available -or not. Throws if the specified release has no matching assets. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L123) -```csharp title="Declaration" -protected override string GetAssetUrlFromName(GitlabRelease release, string assetName) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Sources.GitlabRelease](../Velopack.Sources/GitlabRelease) | *release* | -| `System.String` | *assetName* | - -### GetReleases(bool) -Retrieves a list of [Velopack.Sources.GitlabRelease](../Velopack.Sources/GitlabRelease) from the current repository. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L147) -```csharp title="Declaration" -protected override Task GetReleases(bool includePrereleases) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Boolean` | *includePrereleases* | - - -## Implements - -* [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/HttpClientFileDownloader.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/HttpClientFileDownloader.md deleted file mode 100644 index c9303dd..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/HttpClientFileDownloader.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: Class HttpClientFileDownloader -sidebar_label: HttpClientFileDownloader -description: "A simple abstractable file downloader" ---- -# Class HttpClientFileDownloader -A simple abstractable file downloader - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L13) -```csharp title="Declaration" -public class HttpClientFileDownloader : IFileDownloader -``` -**Implements:** -[Velopack.Sources.IFileDownloader](../Velopack.Sources/IFileDownloader) - -## Properties -### UserAgent -The User-Agent sent with requests -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L18) -```csharp title="Declaration" -public static ProductInfoHeaderValue UserAgent { get; } -``` -## Methods -### DownloadFile(string, string, Action<int>, string?, string?, CancellationToken) -Downloads a remote file to the specified local path -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L21) -```csharp title="Declaration" -public virtual Task DownloadFile(string url, string targetFile, Action progress, string? authorization, string? accept, CancellationToken cancelToken = default) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *url* | The url which will be downloaded. | -| `System.String` | *targetFile* | The local path where the file will be stored -If a file exists at this path, it will be overwritten. | -| `System.Action` | *progress* | A delegate for reporting download progress, with expected values from 0-100. | -| `System.String` | *authorization* | Text to be sent in the 'Authorization' header of the request. | -| `System.String` | *accept* | Text to be sent in the 'Accept' header of the request. | -| `System.Threading.CancellationToken` | *cancelToken* | Optional token to cancel the request. | - -### DownloadBytes(string, string?, string?) -Returns a byte array containing the contents of the file at the specified url -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L38) -```csharp title="Declaration" -public virtual Task DownloadBytes(string url, string? authorization, string? accept) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *url* | -| `System.String` | *authorization* | -| `System.String` | *accept* | - -### DownloadString(string, string?, string?) -Returns a string containing the contents of the specified url -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L51) -```csharp title="Declaration" -public virtual Task DownloadString(string url, string? authorization, string? accept) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *url* | -| `System.String` | *authorization* | -| `System.String` | *accept* | - -### DownloadToStreamInternal(HttpClient, string, Stream, Action<int>?, CancellationToken) -Asynchronously downloads a remote url to the specified destination stream while -providing progress updates. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L67) -```csharp title="Declaration" -protected virtual Task DownloadToStreamInternal(HttpClient client, string requestUri, Stream destination, Action? progress = null, CancellationToken cancelToken = default) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Net.Http.HttpClient` | *client* | -| `System.String` | *requestUri* | -| `System.IO.Stream` | *destination* | -| `System.Action` | *progress* | -| `System.Threading.CancellationToken` | *cancelToken* | - -### CreateHttpClientHandler() -Creates a new `System.Net.Http.HttpClientHandler` with default settings, used for -new `System.Net.Http.HttpClient`'s. Override this function to add client certificates, -proxy configurations, cookies, or change other http behaviors. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L111) -```csharp title="Declaration" -protected virtual HttpClientHandler CreateHttpClientHandler() -``` - -##### Returns - -`System.Net.Http.HttpClientHandler` -### CreateHttpClient(string?, string?) -Creates a new `System.Net.Http.HttpClient` for every request. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L123) -```csharp title="Declaration" -protected virtual HttpClient CreateHttpClient(string? authorization, string? accept) -``` - -##### Returns - -`System.Net.Http.HttpClient` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *authorization* | -| `System.String` | *accept* | - - -## Implements - -* [Velopack.Sources.IFileDownloader](../Velopack.Sources/IFileDownloader) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IFileDownloader.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IFileDownloader.md deleted file mode 100644 index 8c57f1a..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IFileDownloader.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: Interface IFileDownloader -sidebar_label: IFileDownloader -description: "A simple abstractable file downloader" ---- -# Interface IFileDownloader -A simple abstractable file downloader - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IFileDownloader.cs#L10) -```csharp title="Declaration" -public interface IFileDownloader -``` -## Methods -### DownloadFile(string, string, Action<int>, string?, string?, CancellationToken) -Downloads a remote file to the specified local path -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IFileDownloader.cs#L29) -```csharp title="Declaration" -Task DownloadFile(string url, string targetFile, Action progress, string? authorization = null, string? accept = null, CancellationToken cancelToken = default) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *url* | The url which will be downloaded. | -| `System.String` | *targetFile* | The local path where the file will be stored -If a file exists at this path, it will be overwritten. | -| `System.Action` | *progress* | A delegate for reporting download progress, with expected values from 0-100. | -| `System.String` | *authorization* | Text to be sent in the 'Authorization' header of the request. | -| `System.String` | *accept* | Text to be sent in the 'Accept' header of the request. | -| `System.Threading.CancellationToken` | *cancelToken* | Optional token to cancel the request. | - -### DownloadBytes(string, string?, string?) -Returns a byte array containing the contents of the file at the specified url -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IFileDownloader.cs#L34) -```csharp title="Declaration" -Task DownloadBytes(string url, string? authorization = null, string? accept = null) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *url* | -| `System.String` | *authorization* | -| `System.String` | *accept* | - -### DownloadString(string, string?, string?) -Returns a string containing the contents of the specified url -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IFileDownloader.cs#L39) -```csharp title="Declaration" -Task DownloadString(string url, string? authorization = null, string? accept = null) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *url* | -| `System.String` | *authorization* | -| `System.String` | *accept* | - diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IUpdateSource.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IUpdateSource.md deleted file mode 100644 index d9e91ba..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IUpdateSource.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Interface IUpdateSource -sidebar_label: IUpdateSource -description: "Abstraction for finding and downloading updates from a package source / repository. -An implementation may copy a file from a local repository, download from a web address, -or even use third party services and parse proprietary data to produce a package feed." ---- -# Interface IUpdateSource -Abstraction for finding and downloading updates from a package source / repository. -An implementation may copy a file from a local repository, download from a web address, -or even use third party services and parse proprietary data to produce a package feed. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IUpdateSource.cs#L13) -```csharp title="Declaration" -public interface IUpdateSource -``` -## Methods -### GetReleaseFeed(ILogger, string, Guid?, VelopackAsset?) -Retrieve the list of available remote releases from the package source. These releases -can subsequently be downloaded with `Velopack.Sources.IUpdateSource.DownloadReleaseEntry(Microsoft.Extensions.Logging.ILogger%2cVelopack.VelopackAsset%2cSystem.String%2cSystem.Action%7bSystem.Int32%7d%2cSystem.Threading.CancellationToken)`. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IUpdateSource.cs#L31) -```csharp title="Declaration" -Task GetReleaseFeed(ILogger logger, string channel, Guid? stagingId = null, VelopackAsset? latestLocalRelease = null) -``` - -##### Returns - -`System.Threading.Tasks.Task`: An array of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) objects that are available for download - and are applicable to this user. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| `System.String` | *channel* | Release channel to filter packages by. Can be null, which is the - default channel for this operating system. | -| `System.Nullable` | *stagingId* | A persistent user-id, used for calculating whether a specific - release should be available to this user or not. (eg, for the purposes of rolling out - an update to only a small portion of users at a time). | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestLocalRelease* | The latest / current local release. If specified, - metadata from this package may be provided to the remote server (such as package id, - or cpu architecture) to ensure that the correct package is downloaded for this user. | - -### DownloadReleaseEntry(ILogger, VelopackAsset, string, Action<int>, CancellationToken) -Download the specified [Velopack.VelopackAsset](../Velopack/VelopackAsset) to the provided local file path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IUpdateSource.cs#L43) -```csharp title="Declaration" -Task DownloadReleaseEntry(ILogger logger, VelopackAsset releaseEntry, string localFile, Action progress, CancellationToken cancelToken = default) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *releaseEntry* | The release to download. | -| `System.String` | *localFile* | The path on the local disk to store the file. If this file exists, - it will be overwritten. | -| `System.Action` | *progress* | This delegate will be executed with values from 0-100 as the - download is being processed. | -| `System.Threading.CancellationToken` | *cancelToken* | A token to use to cancel the request. | - diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleFileSource.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleFileSource.md deleted file mode 100644 index ee07429..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleFileSource.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: Class SimpleFileSource -sidebar_label: SimpleFileSource -description: "Retrieves available updates from a local or network-attached disk. The directory -must contain one or more valid packages, as well as a 'releases.{channel}.json' index file." ---- -# Class SimpleFileSource -Retrieves available updates from a local or network-attached disk. The directory -must contain one or more valid packages, as well as a 'releases.{channel}.json' index file. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleFileSource.cs#L15) -```csharp title="Declaration" -public class SimpleFileSource : IUpdateSource -``` -**Implements:** -[Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) - -## Properties -### BaseDirectory -The local directory containing packages to update to. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleFileSource.cs#L18) -```csharp title="Declaration" -public virtual DirectoryInfo BaseDirectory { get; } -``` -## Methods -### GetReleaseFeed(ILogger, string, Guid?, VelopackAsset?) -Retrieve the list of available remote releases from the package source. These releases -can subsequently be downloaded with `Velopack.Sources.IUpdateSource.DownloadReleaseEntry(Microsoft.Extensions.Logging.ILogger%2cVelopack.VelopackAsset%2cSystem.String%2cSystem.Action%7bSystem.Int32%7d%2cSystem.Threading.CancellationToken)`. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleFileSource.cs#L27) -```csharp title="Declaration" -public Task GetReleaseFeed(ILogger logger, string channel, Guid? stagingId = null, VelopackAsset? latestLocalRelease = null) -``` - -##### Returns - -`System.Threading.Tasks.Task`: An array of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) objects that are available for download - and are applicable to this user. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| `System.String` | *channel* | Release channel to filter packages by. Can be null, which is the - default channel for this operating system. | -| `System.Nullable` | *stagingId* | A persistent user-id, used for calculating whether a specific - release should be available to this user or not. (eg, for the purposes of rolling out - an update to only a small portion of users at a time). | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestLocalRelease* | The latest / current local release. If specified, - metadata from this package may be provided to the remote server (such as package id, - or cpu architecture) to ensure that the correct package is downloaded for this user. | - -### DownloadReleaseEntry(ILogger, VelopackAsset, string, Action<int>, CancellationToken) -Download the specified [Velopack.VelopackAsset](../Velopack/VelopackAsset) to the provided local file path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleFileSource.cs#L67) -```csharp title="Declaration" -public Task DownloadReleaseEntry(ILogger logger, VelopackAsset releaseEntry, string localFile, Action progress, CancellationToken cancelToken) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *releaseEntry* | The release to download. | -| `System.String` | *localFile* | The path on the local disk to store the file. If this file exists, - it will be overwritten. | -| `System.Action` | *progress* | This delegate will be executed with values from 0-100 as the - download is being processed. | -| `System.Threading.CancellationToken` | *cancelToken* | A token to use to cancel the request. | - - -## Implements - -* [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleWebSource.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleWebSource.md deleted file mode 100644 index a68ba7b..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleWebSource.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: Class SimpleWebSource -sidebar_label: SimpleWebSource -description: "Retrieves updates from a static file host or other web server. -Will perform a request for '{baseUri}/RELEASES' to locate the available packages, -and provides query parameters to specify the name of the requested package." ---- -# Class SimpleWebSource -Retrieves updates from a static file host or other web server. -Will perform a request for '{baseUri}/RELEASES' to locate the available packages, -and provides query parameters to specify the name of the requested package. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleWebSource.cs#L14) -```csharp title="Declaration" -public class SimpleWebSource : IUpdateSource -``` -**Implements:** -[Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) - -## Properties -### BaseUri -The URL of the server hosting packages to update to. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleWebSource.cs#L17) -```csharp title="Declaration" -public virtual Uri BaseUri { get; } -``` -### Downloader -The [Velopack.Sources.IFileDownloader](../Velopack.Sources/IFileDownloader) to be used for performing http requests. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleWebSource.cs#L20) -```csharp title="Declaration" -public virtual IFileDownloader Downloader { get; } -``` -## Methods -### GetReleaseFeed(ILogger, string, Guid?, VelopackAsset?) -Retrieve the list of available remote releases from the package source. These releases -can subsequently be downloaded with `Velopack.Sources.IUpdateSource.DownloadReleaseEntry(Microsoft.Extensions.Logging.ILogger%2cVelopack.VelopackAsset%2cSystem.String%2cSystem.Action%7bSystem.Int32%7d%2cSystem.Threading.CancellationToken)`. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleWebSource.cs#L35) -```csharp title="Declaration" -public Task GetReleaseFeed(ILogger logger, string channel, Guid? stagingId = null, VelopackAsset? latestLocalRelease = null) -``` - -##### Returns - -`System.Threading.Tasks.Task`: An array of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) objects that are available for download - and are applicable to this user. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| `System.String` | *channel* | Release channel to filter packages by. Can be null, which is the - default channel for this operating system. | -| `System.Nullable` | *stagingId* | A persistent user-id, used for calculating whether a specific - release should be available to this user or not. (eg, for the purposes of rolling out - an update to only a small portion of users at a time). | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestLocalRelease* | The latest / current local release. If specified, - metadata from this package may be provided to the remote server (such as package id, - or cpu architecture) to ensure that the correct package is downloaded for this user. | - -### DownloadReleaseEntry(ILogger, VelopackAsset, string, Action<int>, CancellationToken) -Download the specified [Velopack.VelopackAsset](../Velopack/VelopackAsset) to the provided local file path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleWebSource.cs#L63) -```csharp title="Declaration" -public Task DownloadReleaseEntry(ILogger logger, VelopackAsset releaseEntry, string localFile, Action progress, CancellationToken cancelToken) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *releaseEntry* | The release to download. | -| `System.String` | *localFile* | The path on the local disk to store the file. If this file exists, - it will be overwritten. | -| `System.Action` | *progress* | This delegate will be executed with values from 0-100 as the - download is being processed. | -| `System.Threading.CancellationToken` | *cancelToken* | A token to use to cancel the request. | - - -## Implements - -* [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/Velopack.Sources.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/Velopack.Sources.md deleted file mode 100644 index 6f5e72c..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/Velopack.Sources.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Namespace Velopack.Sources -sidebar_label: Velopack.Sources ---- -# Namespace Velopack.Sources -## Classes -### [GitBase<T>](../Velopack.Sources/GitBase`T`) -Base class to provide some shared implementation between sources which download releases from a Git repository. -### [GitBase<T>.GitBaseAsset](../Velopack.Sources/GitBase`T`.GitBaseAsset) -Provides a wrapper around [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) which also contains a Git Release. -### [GithubRelease](../Velopack.Sources/GithubRelease) -Describes a GitHub release, including attached assets. -### [GithubReleaseAsset](../Velopack.Sources/GithubReleaseAsset) -Describes a asset (file) uploaded to a GitHub release. -### [GithubSource](../Velopack.Sources/GithubSource) -Retrieves available releases from a GitHub repository. -### [GitlabRelease](../Velopack.Sources/GitlabRelease) -Describes a Gitlab release, plus any assets that are attached. -### [GitlabReleaseAsset](../Velopack.Sources/GitlabReleaseAsset) -Describes a container for the assets attached to a release. -### [GitlabReleaseLink](../Velopack.Sources/GitlabReleaseLink) -Describes a container for the links of assets attached to a release. -### [GitlabSource](../Velopack.Sources/GitlabSource) -Retrieves available releases from a GitLab repository. This class only -downloads assets from the very latest GitLab release. -### [HttpClientFileDownloader](../Velopack.Sources/HttpClientFileDownloader) -A simple abstractable file downloader -### [SimpleFileSource](../Velopack.Sources/SimpleFileSource) -Retrieves available updates from a local or network-attached disk. The directory -must contain one or more valid packages, as well as a 'releases.{channel}.json' index file. -### [SimpleWebSource](../Velopack.Sources/SimpleWebSource) -Retrieves updates from a static file host or other web server. -Will perform a request for '{baseUri}/RELEASES' to locate the available packages, -and provides query parameters to specify the name of the requested package. -### [VelopackFlowUpdateSource](../Velopack.Sources/VelopackFlowUpdateSource) -Retrieves updates from the hosted Velopack service. -## Interfaces -### [IFileDownloader](../Velopack.Sources/IFileDownloader) -A simple abstractable file downloader -### [IUpdateSource](../Velopack.Sources/IUpdateSource) -Abstraction for finding and downloading updates from a package source / repository. -An implementation may copy a file from a local repository, download from a web address, -or even use third party services and parse proprietary data to produce a package feed. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/VelopackFlowUpdateSource.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/VelopackFlowUpdateSource.md deleted file mode 100644 index 9d8896c..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/VelopackFlowUpdateSource.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: Class VelopackFlowUpdateSource -sidebar_label: VelopackFlowUpdateSource -description: "Retrieves updates from the hosted Velopack service." ---- -# Class VelopackFlowUpdateSource -Retrieves updates from the hosted Velopack service. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/VelopackFlowUpdateSource.cs#L14) -```csharp title="Declaration" -public sealed class VelopackFlowUpdateSource : IUpdateSource -``` -**Implements:** -[Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) - -## Properties -### BaseUri -The URL of the server hosting packages to update to. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/VelopackFlowUpdateSource.cs#L26) -```csharp title="Declaration" -public Uri BaseUri { get; } -``` -### Downloader -The [Velopack.Sources.IFileDownloader](../Velopack.Sources/IFileDownloader) to be used for performing http requests. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/VelopackFlowUpdateSource.cs#L29) -```csharp title="Declaration" -public IFileDownloader Downloader { get; } -``` -## Methods -### GetReleaseFeed(ILogger, string, Guid?, VelopackAsset?) -Retrieve the list of available remote releases from the package source. These releases -can subsequently be downloaded with `Velopack.Sources.IUpdateSource.DownloadReleaseEntry(Microsoft.Extensions.Logging.ILogger%2cVelopack.VelopackAsset%2cSystem.String%2cSystem.Action%7bSystem.Int32%7d%2cSystem.Threading.CancellationToken)`. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/VelopackFlowUpdateSource.cs#L32) -```csharp title="Declaration" -public Task GetReleaseFeed(ILogger logger, string channel, Guid? stagingId = null, VelopackAsset? latestLocalRelease = null) -``` - -##### Returns - -`System.Threading.Tasks.Task`: An array of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) objects that are available for download - and are applicable to this user. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| `System.String` | *channel* | Release channel to filter packages by. Can be null, which is the - default channel for this operating system. | -| `System.Nullable` | *stagingId* | A persistent user-id, used for calculating whether a specific - release should be available to this user or not. (eg, for the purposes of rolling out - an update to only a small portion of users at a time). | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestLocalRelease* | The latest / current local release. If specified, - metadata from this package may be provided to the remote server (such as package id, - or cpu architecture) to ensure that the correct package is downloaded for this user. | - -### DownloadReleaseEntry(ILogger, VelopackAsset, string, Action<int>, CancellationToken) -Download the specified [Velopack.VelopackAsset](../Velopack/VelopackAsset) to the provided local file path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/VelopackFlowUpdateSource.cs#L68) -```csharp title="Declaration" -public Task DownloadReleaseEntry(ILogger logger, VelopackAsset releaseEntry, string localFile, Action progress, CancellationToken cancelToken = default) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *releaseEntry* | The release to download. | -| `System.String` | *localFile* | The path on the local disk to store the file. If this file exists, - it will be overwritten. | -| `System.Action` | *progress* | This delegate will be executed with values from 0-100 as the - download is being processed. | -| `System.Threading.CancellationToken` | *cancelToken* | A token to use to cancel the request. | - - -## Implements - -* [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.SHGetFileInfoConstants.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.SHGetFileInfoConstants.md deleted file mode 100644 index c553fbf..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.SHGetFileInfoConstants.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: Enum FileIcon.SHGetFileInfoConstants -sidebar_label: FileIcon.SHGetFileInfoConstants ---- -# Enum FileIcon.SHGetFileInfoConstants - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L996) -```csharp title="Declaration" -[Flags] -public enum FileIcon.SHGetFileInfoConstants -``` -## Fields -### SHGFI_ICON - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L999) -```csharp title="Declaration" -SHGFI_ICON = 256 -``` -### SHGFI_DISPLAYNAME - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1000) -```csharp title="Declaration" -SHGFI_DISPLAYNAME = 512 -``` -### SHGFI_TYPENAME - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1001) -```csharp title="Declaration" -SHGFI_TYPENAME = 1024 -``` -### SHGFI_ATTRIBUTES - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1002) -```csharp title="Declaration" -SHGFI_ATTRIBUTES = 2048 -``` -### SHGFI_ICONLOCATION - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1003) -```csharp title="Declaration" -SHGFI_ICONLOCATION = 4096 -``` -### SHGFI_EXETYPE - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1004) -```csharp title="Declaration" -SHGFI_EXETYPE = 8192 -``` -### SHGFI_SYSICONINDEX - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1005) -```csharp title="Declaration" -SHGFI_SYSICONINDEX = 16384 -``` -### SHGFI_LINKOVERLAY - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1006) -```csharp title="Declaration" -SHGFI_LINKOVERLAY = 32768 -``` -### SHGFI_SELECTED - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1007) -```csharp title="Declaration" -SHGFI_SELECTED = 65536 -``` -### SHGFI_ATTR_SPECIFIED - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1008) -```csharp title="Declaration" -SHGFI_ATTR_SPECIFIED = 131072 -``` -### SHGFI_LARGEICON - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1009) -```csharp title="Declaration" -SHGFI_LARGEICON = 0 -``` -### SHGFI_SMALLICON - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1010) -```csharp title="Declaration" -SHGFI_SMALLICON = 1 -``` -### SHGFI_OPENICON - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1011) -```csharp title="Declaration" -SHGFI_OPENICON = 2 -``` -### SHGFI_SHELLICONSIZE - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1012) -```csharp title="Declaration" -SHGFI_SHELLICONSIZE = 4 -``` -### SHGFI_USEFILEATTRIBUTES - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1014) -```csharp title="Declaration" -SHGFI_USEFILEATTRIBUTES = 16 -``` -### SHGFI_ADDOVERLAYS - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1015) -```csharp title="Declaration" -SHGFI_ADDOVERLAYS = 32 -``` -### SHGFI_OVERLAYINDEX - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1016) -```csharp title="Declaration" -SHGFI_OVERLAYINDEX = 64 -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.md deleted file mode 100644 index abeef0f..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Class FileIcon -sidebar_label: FileIcon -description: "Enables extraction of icons for any file type from -the Shell." ---- -# Class FileIcon -Enables extraction of icons for any file type from -the Shell. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L938) -```csharp title="Declaration" -public class FileIcon -``` -## Properties -### Flags -Gets/sets the flags used to extract the icon -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1022) -```csharp title="Declaration" -public FileIcon.SHGetFileInfoConstants Flags { get; set; } -``` -### FileName -Gets/sets the filename to get the icon for -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1030) -```csharp title="Declaration" -public string FileName { get; set; } -``` -### ShellIcon -Gets the icon for the chosen file -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1038) -```csharp title="Declaration" -public IntPtr ShellIcon { get; } -``` -### DisplayName -Gets the display name for the selected file -if the SHGFI_DISPLAYNAME flag was set. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1046) -```csharp title="Declaration" -public string DisplayName { get; } -``` -### TypeName -Gets the type name for the selected file -if the SHGFI_TYPENAME flag was set. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1054) -```csharp title="Declaration" -public string TypeName { get; } -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetInfo.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetInfo.md deleted file mode 100644 index 0211480..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetInfo.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -title: Class Runtimes.DotnetInfo -sidebar_label: Runtimes.DotnetInfo -description: "Represents a modern DOTNET runtime where versions are deployed independenly of the operating system" ---- -# Class Runtimes.DotnetInfo -Represents a modern DOTNET runtime where versions are deployed independenly of the operating system - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L163) -```csharp title="Declaration" -public class Runtimes.DotnetInfo : Runtimes.RuntimeInfo -``` -**Inheritance:** `System.Object` -> [Velopack.Windows.Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) - -## Properties -### Id -The unique Id of this runtime. Can be used to retrieve a runtime instance with [Velopack.Windows.Runtimes.GetRuntimeByName(string)](../Velopack.Windows/Runtimes#getruntimebynamestring) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L166) -```csharp title="Declaration" -public override string Id { get; } -``` -### DisplayName -The human-friendly name of this runtime - for displaying to users -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L170) -```csharp title="Declaration" -public override string DisplayName { get; } -``` -### MinVersion -The minimum compatible version that must be installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L174) -```csharp title="Declaration" -public NuGetVersion MinVersion { get; } -``` -### CpuArchitecture -The CPU architecture of the runtime. This must match the RID of the app being deployed. - For example, if the app was deployed with 'win-x64', this must be X64 also. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L178) -```csharp title="Declaration" -public RuntimeCpu CpuArchitecture { get; } -``` -### RuntimeType -The type of runtime required, eg. Windows Desktop, AspNetCore, Sdk. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L181) -```csharp title="Declaration" -public Runtimes.DotnetRuntimeType RuntimeType { get; } -``` -## Methods -### CheckIsInstalled() -Check if a runtime compatible with the current instance is installed on this system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L206) -```csharp title="Declaration" -public override Task CheckIsInstalled() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### CheckIsSupported() -Check if this runtime is supported on the current system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L223) -```csharp title="Declaration" -public override Task CheckIsSupported() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### GetDownloadUrl() -Retrieves the web url to the latest compatible runtime installer exe -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L288) -```csharp title="Declaration" -public override Task GetDownloadUrl() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### Parse(string) -Parses a string such as 'net6' or net5.0.14-x86 into a DotnetInfo class capable of checking -the current system for installed status, or downloading / installing. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L309) -```csharp title="Declaration" -public static Runtimes.DotnetInfo Parse(string input) -``` - -##### Returns - -[Velopack.Windows.Runtimes.DotnetInfo](../Velopack.Windows/Runtimes.DotnetInfo) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *input* | - -### TryParse(string, out DotnetInfo) -Parses a string such as 'net6' or net5.0.14-x86 into a DotnetInfo class capable of checking -the current system for installed status, or downloading / installing. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L340) -```csharp title="Declaration" -public static bool TryParse(string input, out Runtimes.DotnetInfo info) -``` - -##### Returns - -`System.Boolean` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *input* | -| [Velopack.Windows.Runtimes.DotnetInfo](../Velopack.Windows/Runtimes.DotnetInfo) | *info* | - -### ParseVersion(string) -Safely converts a version string into a version structure, and provides some validation for invalid/unsupported versions. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L354) -```csharp title="Declaration" -protected static Version ParseVersion(string input) -``` - -##### Returns - -`System.Version` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *input* | - -### TrimVersion(NuGetVersion) -Converts a version structure into the shortest string possible, by trimming trailing zeros. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L375) -```csharp title="Declaration" -protected static string TrimVersion(NuGetVersion ver) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `NuGet.Versioning.NuGetVersion` | *ver* | - -### GetLatestDotNetVersion(DotnetRuntimeType, string, IFileDownloader) -Get latest available version of dotnet. Channel can be 'LTS', 'current', or a two part version -(eg. '6.0') to get the latest minor release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L394) -```csharp title="Declaration" -public static Task GetLatestDotNetVersion(Runtimes.DotnetRuntimeType runtimeType, string channel, IFileDownloader downloader = null) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Windows.Runtimes.DotnetRuntimeType](../Velopack.Windows/Runtimes.DotnetRuntimeType) | *runtimeType* | -| `System.String` | *channel* | -| [Velopack.Sources.IFileDownloader](../Velopack.Sources/IFileDownloader) | *downloader* | - -### GetDotNetDownloadUrl(DotnetRuntimeType, string, string) -Get download url for a specific version of dotnet. Version must be an absolute version, such as one -returned by `Velopack.Windows.Runtimes.DotnetInfo.GetLatestDotNetVersion(Velopack.Windows.Runtimes.DotnetRuntimeType%2cSystem.String%2cVelopack.Sources.IFileDownloader)`. cpuarch should be either -'x86', 'x64', or 'arm64'. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L419) -```csharp title="Declaration" -public static string GetDotNetDownloadUrl(Runtimes.DotnetRuntimeType runtimeType, string version, string cpuarch) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Windows.Runtimes.DotnetRuntimeType](../Velopack.Windows/Runtimes.DotnetRuntimeType) | *runtimeType* | -| `System.String` | *version* | -| `System.String` | *cpuarch* | - diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetRuntimeType.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetRuntimeType.md deleted file mode 100644 index caf2780..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetRuntimeType.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Enum Runtimes.DotnetRuntimeType -sidebar_label: Runtimes.DotnetRuntimeType -description: "Dotnet Runtime SKU" ---- -# Enum Runtimes.DotnetRuntimeType -Dotnet Runtime SKU - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L20) -```csharp title="Declaration" -public enum Runtimes.DotnetRuntimeType -``` -## Fields -### Runtime -The .NET Runtime contains just the components needed to run a console app -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L23) -```csharp title="Declaration" -Runtime = 1 -``` -### AspNetCore -The The ASP.NET Core Runtime enables you to run existing web/server applications -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L25) -```csharp title="Declaration" -AspNetCore = 2 -``` -### WindowsDesktop -The .NET Desktop Runtime enables you to run existing Windows desktop applications -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L27) -```csharp title="Declaration" -WindowsDesktop = 3 -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.FrameworkInfo.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.FrameworkInfo.md deleted file mode 100644 index 277339a..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.FrameworkInfo.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Class Runtimes.FrameworkInfo -sidebar_label: Runtimes.FrameworkInfo -description: "Represents a full .NET Framework runtime, usually included in Windows automatically through Windows Update" ---- -# Class Runtimes.FrameworkInfo -Represents a full .NET Framework runtime, usually included in Windows automatically through Windows Update - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L116) -```csharp title="Declaration" -public class Runtimes.FrameworkInfo : Runtimes.RuntimeInfo -``` -**Inheritance:** `System.Object` -> [Velopack.Windows.Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) - -## Properties -### DownloadUrl -Permalink to the installer for this runtime -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L119) -```csharp title="Declaration" -public string DownloadUrl { get; } -``` -### ReleaseVersion -The minimum compatible release version for this runtime -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L122) -```csharp title="Declaration" -public int ReleaseVersion { get; } -``` -## Methods -### GetDownloadUrl() -Retrieves the web url to the latest compatible runtime installer exe -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L134) -```csharp title="Declaration" -public override Task GetDownloadUrl() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### CheckIsSupported() -Check if this runtime is supported on the current system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L140) -```csharp title="Declaration" -public override Task CheckIsSupported() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### CheckIsInstalled() -Check if a runtime compatible with the current instance is installed on this system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L148) -```csharp title="Declaration" -public override Task CheckIsInstalled() -``` - -##### Returns - -`System.Threading.Tasks.Task` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInfo.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInfo.md deleted file mode 100644 index acc5b8d..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInfo.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: Class Runtimes.RuntimeInfo -sidebar_label: Runtimes.RuntimeInfo -description: "Base type containing information about a runtime in relation to the current operating system" ---- -# Class Runtimes.RuntimeInfo -Base type containing information about a runtime in relation to the current operating system - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L46) -```csharp title="Declaration" -public abstract class Runtimes.RuntimeInfo -``` -**Derived:** -[Velopack.Windows.Runtimes.DotnetInfo](../Velopack.Windows/Runtimes.DotnetInfo), [Velopack.Windows.Runtimes.FrameworkInfo](../Velopack.Windows/Runtimes.FrameworkInfo), [Velopack.Windows.Runtimes.VCRedistInfo](../Velopack.Windows/Runtimes.VCRedistInfo) - -## Properties -### Id -The unique Id of this runtime. Can be used to retrieve a runtime instance with [Velopack.Windows.Runtimes.GetRuntimeByName(string)](../Velopack.Windows/Runtimes#getruntimebynamestring) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L49) -```csharp title="Declaration" -public virtual string Id { get; } -``` -### DisplayName -The human-friendly name of this runtime - for displaying to users -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L52) -```csharp title="Declaration" -public virtual string DisplayName { get; } -``` -## Methods -### GetDownloadUrl() -Retrieves the web url to the latest compatible runtime installer exe -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L65) -```csharp title="Declaration" -public abstract Task GetDownloadUrl() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### CheckIsInstalled() -Check if a runtime compatible with the current instance is installed on this system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L68) -```csharp title="Declaration" -public abstract Task CheckIsInstalled() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### CheckIsSupported() -Check if this runtime is supported on the current system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L72) -```csharp title="Declaration" -public abstract Task CheckIsSupported() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### DownloadToFile(string, Action<int>, IFileDownloader, ILogger) -Download the latest installer for this runtime to the specified file -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L76) -```csharp title="Declaration" -public virtual Task DownloadToFile(string localPath, Action progress = null, IFileDownloader downloader = null, ILogger log = null) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *localPath* | -| `System.Action` | *progress* | -| [Velopack.Sources.IFileDownloader](../Velopack.Sources/IFileDownloader) | *downloader* | -| `Microsoft.Extensions.Logging.ILogger` | *log* | - -### InvokeInstaller(string, bool, ILogger) -Execute a runtime installer at a local file path. Typically used after `Velopack.Windows.Runtimes.RuntimeInfo.DownloadToFile(System.String%2cSystem.Action%7bSystem.Int32%7d%2cVelopack.Sources.IFileDownloader%2cMicrosoft.Extensions.Logging.ILogger)` -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L85) -```csharp title="Declaration" -public virtual Task InvokeInstaller(string pathToInstaller, bool isQuiet, ILogger log = null) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *pathToInstaller* | -| `System.Boolean` | *isQuiet* | -| `Microsoft.Extensions.Logging.ILogger` | *log* | - -### ToString() -The unique string representation of this runtime -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L109) -```csharp title="Declaration" -public override string ToString() -``` - -##### Returns - -`System.String` -### GetHashCode() -The unique hash code of this runtime -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L112) -```csharp title="Declaration" -public override int GetHashCode() -``` - -##### Returns - -`System.Int32` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInstallResult.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInstallResult.md deleted file mode 100644 index 8a73321..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInstallResult.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Enum Runtimes.RuntimeInstallResult -sidebar_label: Runtimes.RuntimeInstallResult -description: "Runtime installation result code" ---- -# Enum Runtimes.RuntimeInstallResult -Runtime installation result code - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L31) -```csharp title="Declaration" -public enum Runtimes.RuntimeInstallResult -``` -## Fields -### InstallSuccess -The install was successful -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L34) -```csharp title="Declaration" -InstallSuccess = 0 -``` -### UserCancelled -The install failed because it was cancelled by the user -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L36) -```csharp title="Declaration" -UserCancelled = 1602 -``` -### AnotherInstallInProgress -The install failed because another install is in progress, try again later -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L38) -```csharp title="Declaration" -AnotherInstallInProgress = 1618 -``` -### RestartRequired -The install failed because a system restart is required before continuing -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L40) -```csharp title="Declaration" -RestartRequired = 3010 -``` -### SystemDoesNotMeetRequirements -The install failed because the current system does not support this runtime (outdated/unsupported) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L42) -```csharp title="Declaration" -SystemDoesNotMeetRequirements = 5100 -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist00.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist00.md deleted file mode 100644 index 7368e78..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist00.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Class Runtimes.VCRedist00 -sidebar_label: Runtimes.VCRedist00 -description: "Represents a VC++ redistributable package which is referenced by a permalink" ---- -# Class Runtimes.VCRedist00 -Represents a VC++ redistributable package which is referenced by a permalink - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L563) -```csharp title="Declaration" -public class Runtimes.VCRedist00 : Runtimes.VCRedistInfo -``` -**Inheritance:** `System.Object` -> [Velopack.Windows.Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) -> [Velopack.Windows.Runtimes.VCRedistInfo](../Velopack.Windows/Runtimes.VCRedistInfo) - -## Properties -### DownloadUrl -Permalink to the installer for this runtime -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L566) -```csharp title="Declaration" -public string DownloadUrl { get; } -``` -## Methods -### GetDownloadUrl() -Retrieves the web url to the latest compatible runtime installer exe -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L576) -```csharp title="Declaration" -public override Task GetDownloadUrl() -``` - -##### Returns - -`System.Threading.Tasks.Task` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist14.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist14.md deleted file mode 100644 index aa4b995..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist14.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Class Runtimes.VCRedist14 -sidebar_label: Runtimes.VCRedist14 -description: "Represents a VC++ 2015-2022 redistributable package." ---- -# Class Runtimes.VCRedist14 -Represents a VC++ 2015-2022 redistributable package. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L539) -```csharp title="Declaration" -public class Runtimes.VCRedist14 : Runtimes.VCRedistInfo -``` -**Inheritance:** `System.Object` -> [Velopack.Windows.Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) -> [Velopack.Windows.Runtimes.VCRedistInfo](../Velopack.Windows/Runtimes.VCRedistInfo) - -## Methods -### GetDownloadUrl() -Retrieves the web url to the latest compatible runtime installer exe -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L548) -```csharp title="Declaration" -public override Task GetDownloadUrl() -``` - -##### Returns - -`System.Threading.Tasks.Task` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedistInfo.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedistInfo.md deleted file mode 100644 index 71fb1c3..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedistInfo.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Class Runtimes.VCRedistInfo -sidebar_label: Runtimes.VCRedistInfo -description: "The base class for a VC++ redistributable package." ---- -# Class Runtimes.VCRedistInfo -The base class for a VC++ redistributable package. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L435) -```csharp title="Declaration" -public abstract class Runtimes.VCRedistInfo : Runtimes.RuntimeInfo -``` -**Inheritance:** `System.Object` -> [Velopack.Windows.Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) - -**Derived:** -[Velopack.Windows.Runtimes.VCRedist00](../Velopack.Windows/Runtimes.VCRedist00), [Velopack.Windows.Runtimes.VCRedist14](../Velopack.Windows/Runtimes.VCRedist14) - -## Properties -### MinVersion -The minimum compatible version that must be installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L438) -```csharp title="Declaration" -public NuGetVersion MinVersion { get; } -``` -### CpuArchitecture -The CPU architecture of the runtime. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L441) -```csharp title="Declaration" -public RuntimeCpu CpuArchitecture { get; } -``` -## Methods -### CheckIsInstalled() -Check if a runtime compatible with the current instance is installed on this system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L451) -```csharp title="Declaration" -public override Task CheckIsInstalled() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### CheckIsSupported() -Check if this runtime is supported on the current system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L461) -```csharp title="Declaration" -public override Task CheckIsSupported() -``` - -##### Returns - -`System.Threading.Tasks.Task` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.md deleted file mode 100644 index 53b9a1c..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.md +++ /dev/null @@ -1,283 +0,0 @@ ---- -title: Class Runtimes -sidebar_label: Runtimes -description: "Contains static properties to access common supported runtimes, and a function to search for a runtime by name" ---- -# Class Runtimes -Contains static properties to access common supported runtimes, and a function to search for a runtime by name - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L10) -```csharp title="Declaration" -[Obsolete("These classes are no longer used by Velopack, and does not represent the current supported runtimes. https://github.com/velopack/velopack/blob/master/docs/bootstrapping.md")] -public static class Runtimes -``` -## Fields -### NETFRAMEWORK45 -Runtime for .NET Framework 4.5 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L15) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK45 -``` -### NETFRAMEWORK451 -Runtime for .NET Framework 4.5.1 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L18) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK451 -``` -### NETFRAMEWORK452 -Runtime for .NET Framework 4.5.2 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L21) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK452 -``` -### NETFRAMEWORK46 -Runtime for .NET Framework 4.6 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L24) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK46 -``` -### NETFRAMEWORK461 -Runtime for .NET Framework 4.6.1 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L27) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK461 -``` -### NETFRAMEWORK462 -Runtime for .NET Framework 4.6.2 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L29) -```csharp title="Declaration" -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK462 -``` -### NETFRAMEWORK47 -Runtime for .NET Framework 4.7 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L31) -```csharp title="Declaration" -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK47 -``` -### NETFRAMEWORK471 -Runtime for .NET Framework 4.7.1 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L33) -```csharp title="Declaration" -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK471 -``` -### NETFRAMEWORK472 -Runtime for .NET Framework 4.7.2 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L35) -```csharp title="Declaration" -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK472 -``` -### NETFRAMEWORK48 -Runtime for .NET Framework 4.8 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L37) -```csharp title="Declaration" -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK48 -``` -### NETFRAMEWORK481 -Runtime for .NET Framework 4.8.1 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L39) -```csharp title="Declaration" -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK481 -``` -### DOTNETCORE31_X86 -Runtime for .NET Core 3.1 Desktop Runtime (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L44) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.DotnetInfo DOTNETCORE31_X86 -``` -### DOTNETCORE31_X64 -Runtime for .NET Core 3.1 Desktop Runtime (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L47) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.DotnetInfo DOTNETCORE31_X64 -``` -### DOTNET5_X86 -Runtime for .NET 5.0 Desktop Runtime (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L50) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.DotnetInfo DOTNET5_X86 -``` -### DOTNET5_X64 -Runtime for .NET 5.0 Desktop Runtime (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L53) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.DotnetInfo DOTNET5_X64 -``` -### DOTNET6_X86 -Runtime for .NET 6.0 Desktop Runtime (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L55) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET6_X86 -``` -### DOTNET6_X64 -Runtime for .NET 6.0 Desktop Runtime (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L57) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET6_X64 -``` -### DOTNET6_ARM64 -Runtime for .NET 6.0 Desktop Runtime (arm64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L59) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET6_ARM64 -``` -### DOTNET7_X86 -Runtime for .NET 7.0 Desktop Runtime (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L61) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET7_X86 -``` -### DOTNET7_X64 -Runtime for .NET 7.0 Desktop Runtime (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L63) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET7_X64 -``` -### DOTNET7_ARM64 -Runtime for .NET 7.0 Desktop Runtime (arm64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L65) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET7_ARM64 -``` -### DOTNET8_X86 -Runtime for .NET 8.0 Desktop Runtime (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L67) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET8_X86 -``` -### DOTNET8_X64 -Runtime for .NET 8.0 Desktop Runtime (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L69) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET8_X64 -``` -### DOTNET8_ARM64 -Runtime for .NET 8.0 Desktop Runtime (arm64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L71) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET8_ARM64 -``` -### VCREDIST100_X86 -Runtime for Visual C++ 2010 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L75) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist00 VCREDIST100_X86 -``` -### VCREDIST100_X64 -Runtime for Visual C++ 2010 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L78) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist00 VCREDIST100_X64 -``` -### VCREDIST110_X86 -Runtime for Visual C++ 2012 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L81) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist00 VCREDIST110_X86 -``` -### VCREDIST110_X64 -Runtime for Visual C++ 2012 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L84) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist00 VCREDIST110_X64 -``` -### VCREDIST120_X86 -Runtime for Visual C++ 2013 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L87) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist00 VCREDIST120_X86 -``` -### VCREDIST120_X64 -Runtime for Visual C++ 2013 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L90) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist00 VCREDIST120_X64 -``` -### VCREDIST140_X86 -Runtime for Visual C++ 2015 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L93) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST140_X86 -``` -### VCREDIST140_X64 -Runtime for Visual C++ 2015 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L95) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST140_X64 -``` -### VCREDIST141_X86 -Runtime for Visual C++ 2017 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L97) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST141_X86 -``` -### VCREDIST141_X64 -Runtime for Visual C++ 2017 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L99) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST141_X64 -``` -### VCREDIST142_X86 -Runtime for Visual C++ 2019 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L101) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST142_X86 -``` -### VCREDIST142_X64 -Runtime for Visual C++ 2019 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L103) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST142_X64 -``` -### VCREDIST143_X86 -Runtime for Visual C++ 2022 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L105) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST143_X86 -``` -### VCREDIST143_X64 -Runtime for Visual C++ 2022 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L107) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST143_X64 -``` -### VCREDIST143_ARM64 -Runtime for Visual C++ 2022 Redistributable (arm64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L109) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST143_ARM64 -``` -### All -An array of all the currently supported runtimes -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L112) -```csharp title="Declaration" -public static readonly Runtimes.RuntimeInfo[] All -``` -## Methods -### GetRuntimeByName(string) -Search for a runtime by name. If a platform architecture is not specified, the default is x64. -Returns null if no match is found. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L127) -```csharp title="Declaration" -public static Runtimes.RuntimeInfo GetRuntimeByName(string name) -``` - -##### Returns - -[Velopack.Windows.Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *name* | - diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.EShellLinkResolveFlags.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.EShellLinkResolveFlags.md deleted file mode 100644 index 96b4f90..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.EShellLinkResolveFlags.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: Enum ShellLink.EShellLinkResolveFlags -sidebar_label: ShellLink.EShellLinkResolveFlags -description: "Flags determining how the links with missing -targets are resolved." ---- -# Enum ShellLink.EShellLinkResolveFlags -Flags determining how the links with missing -targets are resolved. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L410) -```csharp title="Declaration" -[Flags] -public enum ShellLink.EShellLinkResolveFlags : uint -``` -## Fields -### SLR_ANY_MATCH -Allow any match during resolution. Has no effect -on ME/2000 or above, use the other flags instead. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L417) -```csharp title="Declaration" -SLR_ANY_MATCH = 2 -``` -### SLR_INVOKE_MSI -Call the Microsoft Windows Installer. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L422) -```csharp title="Declaration" -SLR_INVOKE_MSI = 128 -``` -### SLR_NOLINKINFO -Disable distributed link tracking. By default, -distributed link tracking tracks removable media -across multiple devices based on the volume name. -It also uses the UNC path to track remote file -systems whose drive letter has changed. Setting -SLR_NOLINKINFO disables both types of tracking. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L432) -```csharp title="Declaration" -SLR_NOLINKINFO = 64 -``` -### SLR_NO_UI -Do not display a dialog box if the link cannot be resolved. -When SLR_NO_UI is set, a time-out value that specifies the -maximum amount of time to be spent resolving the link can -be specified in milliseconds. The function returns if the -link cannot be resolved within the time-out duration. -If the timeout is not set, the time-out duration will be -set to the default value of 3,000 milliseconds (3 seconds). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L443) -```csharp title="Declaration" -SLR_NO_UI = 1 -``` -### SLR_NO_UI_WITH_MSG_PUMP -Not documented in SDK. Assume same as SLR_NO_UI but -intended for applications without a hWnd. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L449) -```csharp title="Declaration" -SLR_NO_UI_WITH_MSG_PUMP = 257 -``` -### SLR_NOUPDATE -Do not update the link information. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L454) -```csharp title="Declaration" -SLR_NOUPDATE = 8 -``` -### SLR_NOSEARCH -Do not execute the search heuristics. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L459) -```csharp title="Declaration" -SLR_NOSEARCH = 16 -``` -### SLR_NOTRACK -Do not use distributed link tracking. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L464) -```csharp title="Declaration" -SLR_NOTRACK = 32 -``` -### SLR_UPDATE -If the link object has changed, update its path and list -of identifiers. If SLR_UPDATE is set, you do not need to -call IPersistFile::IsDirty to determine whether or not -the link object has changed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L472) -```csharp title="Declaration" -SLR_UPDATE = 4 -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.LinkDisplayMode.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.LinkDisplayMode.md deleted file mode 100644 index 3aebf71..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.LinkDisplayMode.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Enum ShellLink.LinkDisplayMode -sidebar_label: ShellLink.LinkDisplayMode ---- -# Enum ShellLink.LinkDisplayMode - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L475) -```csharp title="Declaration" -public enum ShellLink.LinkDisplayMode : uint -``` -## Fields -### edmNormal - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L477) -```csharp title="Declaration" -edmNormal = 1 -``` -### edmMinimized - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L478) -```csharp title="Declaration" -edmMinimized = 7 -``` -### edmMaximized - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L479) -```csharp title="Declaration" -edmMaximized = 3 -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PROPERTYKEY.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PROPERTYKEY.md deleted file mode 100644 index db0d31c..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PROPERTYKEY.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Struct ShellLink.PROPERTYKEY -sidebar_label: ShellLink.PROPERTYKEY ---- -# Struct ShellLink.PROPERTYKEY - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L109) -```csharp title="Declaration" -public struct ShellLink.PROPERTYKEY -``` -## Properties -### PKEY_AppUserModel_ID - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L115) -```csharp title="Declaration" -public static ShellLink.PROPERTYKEY PKEY_AppUserModel_ID { get; } -``` -### PKEY_AppUserModel_ToastActivatorCLSID - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L124) -```csharp title="Declaration" -public static ShellLink.PROPERTYKEY PKEY_AppUserModel_ToastActivatorCLSID { get; } -``` -## Fields -### fmtid - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L112) -```csharp title="Declaration" -public Guid fmtid -``` -### pid - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L113) -```csharp title="Declaration" -public UIntPtr pid -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PropVariant.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PropVariant.md deleted file mode 100644 index d0cd38d..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PropVariant.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: Struct ShellLink.PropVariant -sidebar_label: ShellLink.PropVariant ---- -# Struct ShellLink.PropVariant - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L62) -```csharp title="Declaration" -public struct ShellLink.PropVariant -``` -## Fields -### variantType - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L65) -```csharp title="Declaration" -public short variantType -``` -### Reserved1 - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L66) -```csharp title="Declaration" -public short Reserved1 -``` -### Reserved2 - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L66) -```csharp title="Declaration" -public short Reserved2 -``` -### Reserved3 - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L66) -```csharp title="Declaration" -public short Reserved3 -``` -### pointerValue - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L67) -```csharp title="Declaration" -public IntPtr pointerValue -``` -## Methods -### FromString(string) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L69) -```csharp title="Declaration" -public static ShellLink.PropVariant FromString(string str) -``` - -##### Returns - -[Velopack.Windows.ShellLink.PropVariant](../Velopack.Windows/ShellLink.PropVariant) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *str* | - -### FromGuid(Guid) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L79) -```csharp title="Declaration" -public static ShellLink.PropVariant FromGuid(Guid guid) -``` - -##### Returns - -[Velopack.Windows.ShellLink.PropVariant](../Velopack.Windows/ShellLink.PropVariant) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Guid` | *guid* | - -### Clear() -Called to clear the PropVariant's referenced and local memory. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L103) -```csharp title="Declaration" -public void Clear() -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.md deleted file mode 100644 index 32f1678..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -title: Class ShellLink -sidebar_label: ShellLink -description: "Summary description for ShellLink." ---- -# Class ShellLink -Summary description for ShellLink. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L17) -```csharp title="Declaration" -public class ShellLink : IDisposable -``` -**Implements:** -`System.IDisposable` - -## Properties -### ShortCutFile - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L532) -```csharp title="Declaration" -public string ShortCutFile { get; set; } -``` -### IconPath -Gets the path to the file containing the icon for this shortcut. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L594) -```csharp title="Declaration" -public string IconPath { get; set; } -``` -### IconIndex -Gets the index of this icon within the icon path's resources -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L628) -```csharp title="Declaration" -public int IconIndex { get; set; } -``` -### Target -Gets/sets the fully qualified path to the link's target -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L662) -```csharp title="Declaration" -public string Target { get; set; } -``` -### WorkingDirectory -Gets/sets the Working Directory for the Link -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L688) -```csharp title="Declaration" -public string WorkingDirectory { get; set; } -``` -### Description -Gets/sets the description of the link -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L710) -```csharp title="Declaration" -public string Description { get; set; } -``` -### Arguments -Gets/sets any command line arguments associated with the link -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L732) -```csharp title="Declaration" -public string Arguments { get; set; } -``` -### DisplayMode -Gets/sets the initial display mode when the shortcut is -run -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L755) -```csharp title="Declaration" -public ShellLink.LinkDisplayMode DisplayMode { get; set; } -``` -### HotKey -Gets/sets the HotKey to start the shortcut (if any) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L777) -```csharp title="Declaration" -public short HotKey { get; set; } -``` -## Methods -### ~ShellLink() -Call dispose just in case it hasn't happened yet -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L512) -```csharp title="Declaration" -protected ~ShellLink() -``` -### Dispose() -Dispose the object, releasing the COM ShellLink object -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L520) -```csharp title="Declaration" -public void Dispose() -``` -### GetIcon(bool) -This pointer must be destroyed with DistroyIcon when you are done with it. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L541) -```csharp title="Declaration" -public IntPtr GetIcon(bool large) -``` - -##### Returns - -`System.IntPtr` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.Boolean` | *large* | Whether to return the small or large icon | - -### SetAppUserModelId(string) -Sets the appUserModelId -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L799) -```csharp title="Declaration" -public void SetAppUserModelId(string appId) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *appId* | - -### SetToastActivatorCLSID(string) -Sets the ToastActivatorCLSID -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L810) -```csharp title="Declaration" -public void SetToastActivatorCLSID(string clsid) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *clsid* | - -### SetToastActivatorCLSID(Guid) -Sets the ToastActivatorCLSID -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L819) -```csharp title="Declaration" -public void SetToastActivatorCLSID(Guid clsid) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Guid` | *clsid* | - -### Save() -Saves the shortcut to ShortCutFile. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L840) -```csharp title="Declaration" -public void Save() -``` -### Save(string) -Saves the shortcut to the specified file -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L849) -```csharp title="Declaration" -public void Save(string linkFile) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *linkFile* | The shortcut file (.lnk) | - -### Open(string) -Loads a shortcut from the specified file -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L867) -```csharp title="Declaration" -public void Open(string linkFile) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *linkFile* | The shortcut file (.lnk) to load | - -### Open(string, IntPtr, EShellLinkResolveFlags) -Loads a shortcut from the specified file, and allows flags controlling -the UI behaviour if the shortcut's target isn't found to be set. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L885) -```csharp title="Declaration" -public void Open(string linkFile, IntPtr hWnd, ShellLink.EShellLinkResolveFlags resolveFlags) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *linkFile* | The shortcut file (.lnk) to load | -| `System.IntPtr` | *hWnd* | The window handle of the application's UI, if any | -| [Velopack.Windows.ShellLink.EShellLinkResolveFlags](../Velopack.Windows/ShellLink.EShellLinkResolveFlags) | *resolveFlags* | Flags controlling resolution behaviour | - -### Open(string, IntPtr, EShellLinkResolveFlags, ushort) -Loads a shortcut from the specified file, and allows flags controlling -the UI behaviour if the shortcut's target isn't found to be set. If -no SLR_NO_UI is specified, you can also specify a timeout. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L906) -```csharp title="Declaration" -public void Open(string linkFile, IntPtr hWnd, ShellLink.EShellLinkResolveFlags resolveFlags, ushort timeOut) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *linkFile* | The shortcut file (.lnk) to load | -| `System.IntPtr` | *hWnd* | The window handle of the application's UI, if any | -| [Velopack.Windows.ShellLink.EShellLinkResolveFlags](../Velopack.Windows/ShellLink.EShellLinkResolveFlags) | *resolveFlags* | Flags controlling resolution behaviour | -| `System.UInt16` | *timeOut* | Timeout if SLR_NO_UI is specified, in ms. | - - -## Implements - -* `System.IDisposable` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShortcutLocation.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShortcutLocation.md deleted file mode 100644 index e98bc9f..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShortcutLocation.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Enum ShortcutLocation -sidebar_label: ShortcutLocation -description: "Specifies several common places where shortcuts can be installed on a user's system" ---- -# Enum ShortcutLocation -Specifies several common places where shortcuts can be installed on a user's system - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L18) -```csharp title="Declaration" -[Flags] -public enum ShortcutLocation -``` -## Fields -### StartMenu -A shortcut in ProgramFiles within a publisher sub-directory -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L24) -```csharp title="Declaration" -StartMenu = 1 -``` -### Desktop -A shortcut on the current user desktop -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L29) -```csharp title="Declaration" -Desktop = 2 -``` -### Startup -A shortcut in Startup/Run folder will cause the app to be automatially started on user login. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L34) -```csharp title="Declaration" -Startup = 4 -``` -### AppRoot -A shortcut in the application folder, useful for portable applications. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L39) -```csharp title="Declaration" -AppRoot = 8 -``` -### StartMenuRoot -A shortcut in ProgramFiles root folder (not in a company/publisher sub-directory). This is commonplace as of more recent versions of windows. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L44) -```csharp title="Declaration" -StartMenuRoot = 16 -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Shortcuts.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Shortcuts.md deleted file mode 100644 index 0dbb8a4..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Shortcuts.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -title: Class Shortcuts -sidebar_label: Shortcuts -description: "A helper class to create or delete windows shortcuts." ---- -# Class Shortcuts -A helper class to create or delete windows shortcuts. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L50) -```csharp title="Declaration" -[Obsolete("Desktop and StartMenuRoot shortcuts are now created and removed automatically when your app is installed / uninstalled.")] -public class Shortcuts -``` -## Properties -### Log -Log for diagnostic messages. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L55) -```csharp title="Declaration" -protected ILogger Log { get; } -``` -### Locator -Locator to use for finding important application paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L58) -```csharp title="Declaration" -protected IVelopackLocator Locator { get; } -``` -## Methods -### CreateShortcutForThisExe(ShortcutLocation) -Create a shortcut to the currently running executable at the specified locations. -See `Velopack.Windows.Shortcuts.CreateShortcut(System.String%2cVelopack.Windows.ShortcutLocation%2cSystem.Boolean%2cSystem.String%2cSystem.String)` to create a shortcut to a different program -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L71) -```csharp title="Declaration" -public void CreateShortcutForThisExe(ShortcutLocation location = ShortcutLocation.Desktop | ShortcutLocation.StartMenuRoot) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *location* | - -### RemoveShortcutForThisExe(ShortcutLocation) -Removes a shortcut for the currently running executable at the specified locations -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L84) -```csharp title="Declaration" -public void RemoveShortcutForThisExe(ShortcutLocation location = ShortcutLocation.StartMenu | ShortcutLocation.Desktop | ShortcutLocation.StartMenuRoot) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *location* | - -### FindShortcuts(string, ShortcutLocation) -Searches for existing shortcuts to an executable inside the current package. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L96) -```csharp title="Declaration" -public Dictionary FindShortcuts(string relativeExeName, ShortcutLocation locations) -``` - -##### Returns - -`System.Collections.Generic.Dictionary` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *relativeExeName* | The relative path or filename of the executable (from the current app dir). | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *locations* | The locations to search. | - -### CreateShortcut(string, ShortcutLocation, bool, string, string) -Creates new shortcuts to the specified executable at the specified locations. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L132) -```csharp title="Declaration" -public void CreateShortcut(string relativeExeName, ShortcutLocation locations, bool updateOnly, string programArguments, string icon = null) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *relativeExeName* | The relative path or filename of the executable (from the current app dir). | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *locations* | The locations to create shortcuts. | -| `System.Boolean` | *updateOnly* | If true, shortcuts will be updated instead of created. | -| `System.String` | *programArguments* | The arguments the application should be launched with | -| `System.String` | *icon* | Path to a specific icon to use instead of the exe icon. | - -### DeleteShortcuts(string, ShortcutLocation) -Delete all the shortcuts for the specified executable in the specified locations. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L198) -```csharp title="Declaration" -public void DeleteShortcuts(string relativeExeName, ShortcutLocation locations) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *relativeExeName* | The relative path or filename of the executable (from the current app dir). | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *locations* | The locations to create shortcuts. | - -### LinkPathForVersionInfo(ShortcutLocation, ZipPackage, FileVersionInfo, string) -Given an [Velopack.NuGet.ZipPackage](../Velopack.NuGet/ZipPackage) and `System.Diagnostics.FileVersionInfo` return the target shortcut path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L228) -```csharp title="Declaration" -protected virtual string LinkPathForVersionInfo(ShortcutLocation location, ZipPackage package, FileVersionInfo versionInfo, string rootdir) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *location* | -| [Velopack.NuGet.ZipPackage](../Velopack.NuGet/ZipPackage) | *package* | -| `System.Diagnostics.FileVersionInfo` | *versionInfo* | -| `System.String` | *rootdir* | - -### GetLinkPath(ShortcutLocation, string, string, string, bool) -Given the application info, return the shortcut target path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L251) -```csharp title="Declaration" -protected virtual string GetLinkPath(ShortcutLocation location, string title, string applicationName, string rootdir, bool createDirectoryIfNecessary = true) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *location* | -| `System.String` | *title* | -| `System.String` | *applicationName* | -| `System.String` | *rootdir* | -| `System.Boolean` | *createDirectoryIfNecessary* | - diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Velopack.Windows.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Velopack.Windows.md deleted file mode 100644 index c13b236..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Velopack.Windows.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Namespace Velopack.Windows -sidebar_label: Velopack.Windows ---- -# Namespace Velopack.Windows -## Classes -### [FileIcon](../Velopack.Windows/FileIcon) -Enables extraction of icons for any file type from -the Shell. -### [Runtimes](../Velopack.Windows/Runtimes) -Contains static properties to access common supported runtimes, and a function to search for a runtime by name -### [Runtimes.DotnetInfo](../Velopack.Windows/Runtimes.DotnetInfo) -Represents a modern DOTNET runtime where versions are deployed independenly of the operating system -### [Runtimes.FrameworkInfo](../Velopack.Windows/Runtimes.FrameworkInfo) -Represents a full .NET Framework runtime, usually included in Windows automatically through Windows Update -### [Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) -Base type containing information about a runtime in relation to the current operating system -### [Runtimes.VCRedist00](../Velopack.Windows/Runtimes.VCRedist00) -Represents a VC++ redistributable package which is referenced by a permalink -### [Runtimes.VCRedist14](../Velopack.Windows/Runtimes.VCRedist14) -Represents a VC++ 2015-2022 redistributable package. -### [Runtimes.VCRedistInfo](../Velopack.Windows/Runtimes.VCRedistInfo) -The base class for a VC++ redistributable package. -### [ShellLink](../Velopack.Windows/ShellLink) -Summary description for ShellLink. -### [Shortcuts](../Velopack.Windows/Shortcuts) -A helper class to create or delete windows shortcuts. -## Structs -### [ShellLink.PROPERTYKEY](../Velopack.Windows/ShellLink.PROPERTYKEY) - -### [ShellLink.PropVariant](../Velopack.Windows/ShellLink.PropVariant) - -## Enums -### [FileIcon.SHGetFileInfoConstants](../Velopack.Windows/FileIcon.SHGetFileInfoConstants) - -### [Runtimes.DotnetRuntimeType](../Velopack.Windows/Runtimes.DotnetRuntimeType) -Dotnet Runtime SKU -### [Runtimes.RuntimeInstallResult](../Velopack.Windows/Runtimes.RuntimeInstallResult) -Runtime installation result code -### [ShellLink.EShellLinkResolveFlags](../Velopack.Windows/ShellLink.EShellLinkResolveFlags) -Flags determining how the links with missing -targets are resolved. -### [ShellLink.LinkDisplayMode](../Velopack.Windows/ShellLink.LinkDisplayMode) - -### [ShortcutLocation](../Velopack.Windows/ShortcutLocation) -Specifies several common places where shortcuts can be installed on a user's system diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RID.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RID.md deleted file mode 100644 index 8166a26..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RID.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: Class RID -sidebar_label: RID ---- -# Class RID - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L147) -```csharp title="Declaration" -public class RID : IEquatable -``` -**Implements:** -`System.IEquatable` - -## Properties -### BaseRID - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L153) -```csharp title="Declaration" -public RuntimeOs BaseRID { get; set; } -``` -### Version - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L155) -```csharp title="Declaration" -public RuntimeVersion Version { get; set; } -``` -### Architecture - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L156) -```csharp title="Declaration" -public RuntimeCpu Architecture { get; set; } -``` -### Qualifier - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L157) -```csharp title="Declaration" -public string Qualifier { get; set; } -``` -### HasVersion - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L313) -```csharp title="Declaration" -public bool HasVersion { get; } -``` -### HasArchitecture - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L315) -```csharp title="Declaration" -public bool HasArchitecture { get; } -``` -### HasQualifier - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L317) -```csharp title="Declaration" -public bool HasQualifier { get; } -``` -### IsValid - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L319) -```csharp title="Declaration" -public bool IsValid { get; } -``` -## Methods -### ToString() -Returns a string that represents the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L159) -```csharp title="Declaration" -public override string ToString() -``` - -##### Returns - -`System.String`: A string that represents the current object.### ToDisplay(RidDisplayType) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L161) -```csharp title="Declaration" -public string ToDisplay(RidDisplayType type) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.RidDisplayType](../Velopack/RidDisplayType) | *type* | - -### Parse(string) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L200) -```csharp title="Declaration" -public static RID Parse(string runtimeIdentifier) -``` - -##### Returns - -[Velopack.RID](../Velopack/RID) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *runtimeIdentifier* | - -### Equals(object) -Determines whether the specified object is equal to the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L321) -```csharp title="Declaration" -public override bool Equals(object obj) -``` - -##### Returns - -`System.Boolean`: true if the specified object is equal to the current object; otherwise, false. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.Object` | *obj* | The object to compare with the current object. | - -### Equals(RID) -Indicates whether the current object is equal to another object of the same type. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L326) -```csharp title="Declaration" -public bool Equals(RID obj) -``` - -##### Returns - -`System.Boolean`: true if the current object is equal to the <code class="paramref">other</code> parameter; otherwise, false. -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.RID](../Velopack/RID) | *obj* | - -### GetHashCode() -Serves as the default hash function. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L349) -```csharp title="Declaration" -public override int GetHashCode() -``` - -##### Returns - -`System.Int32`: A hash code for the current object. -## Implements - -* `System.IEquatable` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntry.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntry.md deleted file mode 100644 index 1553fe2..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntry.md +++ /dev/null @@ -1,287 +0,0 @@ ---- -title: Class ReleaseEntry -sidebar_label: ReleaseEntry -description: "Represents a Velopack release, as described in a RELEASES file - usually also with an -accompanying package containing the files needed to apply the release." ---- -# Class ReleaseEntry -Represents a Velopack release, as described in a RELEASES file - usually also with an -accompanying package containing the files needed to apply the release. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L96) -```csharp title="Declaration" -[DataContract] -[Obsolete("This release format has been replaced by VelopackRelease")] -public class ReleaseEntry -``` -## Properties -### Identity -The release identity - including id, version and so forth. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L101) -```csharp title="Declaration" -[IgnoreDataMember] -public ReleaseEntryName Identity { get; protected set; } -``` -### PackageId -The name or Id of the package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L104) -```csharp title="Declaration" -[DataMember] -public string PackageId { get; } -``` -### Version -The version of this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L107) -```csharp title="Declaration" -[DataMember] -public SemanticVersion Version { get; } -``` -### IsDelta -Whether this package represents a full update, or a delta update. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L110) -```csharp title="Declaration" -[DataMember] -public bool IsDelta { get; } -``` -### SHA1 -The SHA1 checksum of the update package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L113) -```csharp title="Declaration" -[DataMember] -public string SHA1 { get; protected set; } -``` -### BaseUrl -If the release corresponds to a remote http location, this will be the base url. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L116) -```csharp title="Declaration" -[DataMember] -public string BaseUrl { get; protected set; } -``` -### Query -The http url query (if applicable). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L119) -```csharp title="Declaration" -[DataMember] -public string Query { get; protected set; } -``` -### Filesize -The size in bytes of the update package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L122) -```csharp title="Declaration" -[DataMember] -public long Filesize { get; protected set; } -``` -### StagingPercentage -The percentage of users this package has been released to. This release -may or may not be applied if the current user is not in the staging group. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L128) -```csharp title="Declaration" -[DataMember] -public float? StagingPercentage { get; protected set; } -``` -### OriginalFilename -The filename of the update package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L131) -```csharp title="Declaration" -[DataMember] -public string OriginalFilename { get; protected set; } -``` -### EntryAsString -The unparsed text used to construct this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L134) -```csharp title="Declaration" -[IgnoreDataMember] -public string EntryAsString { get; } -``` -## Methods -### FromVelopackAsset(VelopackAsset) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L189) -```csharp title="Declaration" -public static ReleaseEntry FromVelopackAsset(VelopackAsset asset) -``` - -##### Returns - -[Velopack.ReleaseEntry](../Velopack/ReleaseEntry) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *asset* | - -### ParseReleaseEntry(string) -Parses an string entry from a RELEASES file and returns a [Velopack.ReleaseEntry](../Velopack/ReleaseEntry). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L197) -```csharp title="Declaration" -public static ReleaseEntry ParseReleaseEntry(string entry) -``` - -##### Returns - -[Velopack.ReleaseEntry](../Velopack/ReleaseEntry) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *entry* | - -### IsStagingMatch(Guid?) -Checks if the current user is eligible for the current staging percentage. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L261) -```csharp title="Declaration" -public bool IsStagingMatch(Guid? userId) -``` - -##### Returns - -`System.Boolean` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Nullable` | *userId* | - -### ParseReleaseFile(string) -Parse the contents of a RELEASES file into a list of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry)'s. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L278) -```csharp title="Declaration" -public static IEnumerable ParseReleaseFile(string fileContents) -``` - -##### Returns - -`System.Collections.Generic.IEnumerable` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *fileContents* | - -### ParseReleaseFileAndApplyStaging(string, Guid?) -Parse the contents of a RELEASES file into a list of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry)'s, -with any staging-ineligible releases removed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L299) -```csharp title="Declaration" -public static IEnumerable ParseReleaseFileAndApplyStaging(string fileContents, Guid? userToken) -``` - -##### Returns - -`System.Collections.Generic.IEnumerable` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *fileContents* | -| `System.Nullable` | *userToken* | - -### WriteReleaseFile(IEnumerable<ReleaseEntry>, Stream) -Write a list of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry)'s to a stream -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L319) -```csharp title="Declaration" -public static void WriteReleaseFile(IEnumerable releaseEntries, Stream stream) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Collections.Generic.IEnumerable` | *releaseEntries* | -| `System.IO.Stream` | *stream* | - -### WriteReleaseFile(IEnumerable<ReleaseEntry>, string) -Write a list of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry)'s to a local file -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L335) -```csharp title="Declaration" -public static void WriteReleaseFile(IEnumerable releaseEntries, string path) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Collections.Generic.IEnumerable` | *releaseEntries* | -| `System.String` | *path* | - -### GenerateFromFile(Stream, string, string) -Generates a [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) from a local update package file (such as a nupkg). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L348) -```csharp title="Declaration" -public static ReleaseEntry GenerateFromFile(Stream file, string filename, string baseUrl = null) -``` - -##### Returns - -[Velopack.ReleaseEntry](../Velopack/ReleaseEntry) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.IO.Stream` | *file* | -| `System.String` | *filename* | -| `System.String` | *baseUrl* | - -### GenerateFromFile(string, string) -Generates a [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) from a local update package file (such as a nupkg). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L360) -```csharp title="Declaration" -public static ReleaseEntry GenerateFromFile(string path, string baseUrl = null) -``` - -##### Returns - -[Velopack.ReleaseEntry](../Velopack/ReleaseEntry) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *path* | -| `System.String` | *baseUrl* | - -### BuildReleasesFile(string, bool) -Generates a list of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry)'s from a local directory containing -package files. Also writes/updates a RELEASES file in the specified directory -to match the packages the are currently present. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L373) -```csharp title="Declaration" -public static List BuildReleasesFile(string releasePackagesDir, bool writeToDisk = true) -``` - -##### Returns - -`System.Collections.Generic.List`: The list of packages in the directory -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *releasePackagesDir* | -| `System.Boolean` | *writeToDisk* | - -### ToString() -Returns a string that represents the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L411) -```csharp title="Declaration" -public override string ToString() -``` - -##### Returns - -`System.String`: A string that represents the current object.### GetHashCode() -Serves as the default hash function. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L414) -```csharp title="Declaration" -public override int GetHashCode() -``` - -##### Returns - -`System.Int32`: A hash code for the current object. \ No newline at end of file diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntryName.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntryName.md deleted file mode 100644 index 97f1aa2..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntryName.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: Class ReleaseEntryName -sidebar_label: ReleaseEntryName -description: "Represents the information that can be parsed from a release entry filename." ---- -# Class ReleaseEntryName -Represents the information that can be parsed from a release entry filename. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L32) -```csharp title="Declaration" -[Obsolete("This release format has been replaced by VelopackRelease")] -public sealed record ReleaseEntryName : IEquatable -``` -**Implements:** -`System.IEquatable` - -## Properties -### PackageId -The package Id. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L36) -```csharp title="Declaration" -public string PackageId { get; } -``` -### Version -The package version. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L39) -```csharp title="Declaration" -public SemanticVersion Version { get; } -``` -### IsDelta -Whether this is a delta (patch) package, or a full update package. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L42) -```csharp title="Declaration" -public bool IsDelta { get; } -``` -## Methods -### FromEntryFileName(string) -Takes a filename such as 'My-Cool3-App-1.0.1-build.23-full.nupkg' and separates it into -it's name and version (eg. 'My-Cool3-App', and '1.0.1-build.23'). Returns null values if -the filename can not be parsed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L62) -```csharp title="Declaration" -public static ReleaseEntryName FromEntryFileName(string fileName) -``` - -##### Returns - -[Velopack.ReleaseEntryName](../Velopack/ReleaseEntryName) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *fileName* | - -### ToFileName() -Generate the file name which would represent this ReleaseEntryName. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L88) -```csharp title="Declaration" -public string ToFileName() -``` - -##### Returns - -`System.String` - -## Implements - -* `System.IEquatable` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseNotesFormat.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseNotesFormat.md deleted file mode 100644 index edef525..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseNotesFormat.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Enum ReleaseNotesFormat -sidebar_label: ReleaseNotesFormat -description: "Describes the requested release notes text format." ---- -# Enum ReleaseNotesFormat -Describes the requested release notes text format. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L20) -```csharp title="Declaration" -[Obsolete("This release format has been replaced by VelopackRelease")] -public enum ReleaseNotesFormat -``` -## Fields -### Markdown -The original markdown release notes. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L24) -```csharp title="Declaration" -Markdown = 0 -``` -### Html -Release notes translated into HTML. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L26) -```csharp title="Declaration" -Html = 1 -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RidDisplayType.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RidDisplayType.md deleted file mode 100644 index aa5c5cb..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RidDisplayType.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Enum RidDisplayType -sidebar_label: RidDisplayType ---- -# Enum RidDisplayType - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L140) -```csharp title="Declaration" -public enum RidDisplayType -``` -## Fields -### NoVersion - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L142) -```csharp title="Declaration" -NoVersion = 0 -``` -### ShortVersion - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L143) -```csharp title="Declaration" -ShortVersion = 1 -``` -### FullVersion - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L144) -```csharp title="Declaration" -FullVersion = 2 -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeCpu.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeCpu.md deleted file mode 100644 index ba47e39..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeCpu.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Enum RuntimeCpu -sidebar_label: RuntimeCpu -description: "The Runtime CPU Architecture" ---- -# Enum RuntimeCpu -The Runtime CPU Architecture - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L44) -```csharp title="Declaration" -public enum RuntimeCpu : ushort -``` -## Fields -### Unknown -Unknown or unsupported -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L47) -```csharp title="Declaration" -Unknown = 0 -``` -### x86 -Intel x86 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L50) -```csharp title="Declaration" -x86 = 332 -``` -### x64 -x64 / Amd64 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L53) -```csharp title="Declaration" -x64 = 34404 -``` -### arm64 -Arm64 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L56) -```csharp title="Declaration" -arm64 = 43620 -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeOs.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeOs.md deleted file mode 100644 index 1e6523f..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeOs.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Enum RuntimeOs -sidebar_label: RuntimeOs -description: "The Runtime OS" ---- -# Enum RuntimeOs -The Runtime OS - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L60) -```csharp title="Declaration" -public enum RuntimeOs -``` -## Fields -### Unknown -Unknown or unsupported -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L63) -```csharp title="Declaration" -Unknown = 0 -``` -### Windows -Windows -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L66) -```csharp title="Declaration" -Windows = 1 -``` -### Linux -Linux -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L69) -```csharp title="Declaration" -Linux = 2 -``` -### OSX -OSX -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L72) -```csharp title="Declaration" -OSX = 3 -``` -## Extension Methods -* [Velopack.VelopackRuntimeInfo.GetOsLongName(Velopack.RuntimeOs)](../Velopack/VelopackRuntimeInfo#getoslongnameruntimeos) -* [Velopack.VelopackRuntimeInfo.GetOsShortName(Velopack.RuntimeOs)](../Velopack/VelopackRuntimeInfo#getosshortnameruntimeos) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeVersion.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeVersion.md deleted file mode 100644 index f886408..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeVersion.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -title: Class RuntimeVersion -sidebar_label: RuntimeVersion -description: "A Version class that also supports a single integer (major only)" ---- -# Class RuntimeVersion -A Version class that also supports a single integer (major only) - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L14) -```csharp title="Declaration" -public sealed class RuntimeVersion : IComparable, IComparable, IEquatable -``` -**Implements:** -`System.IComparable`, `System.IComparable`, `System.IEquatable` - -## Properties -### Major - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L16) -```csharp title="Declaration" -public int Major { get; } -``` -## Methods -### CompareTo(object) -Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L48) -```csharp title="Declaration" -public int CompareTo(object obj) -``` - -##### Returns - -`System.Int32`: A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes <code class="paramref">obj</code> in the sort order. Zero This instance occurs in the same position in the sort order as <code class="paramref">obj</code>. Greater than zero This instance follows <code class="paramref">obj</code> in the sort order. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.Object` | *obj* | An object to compare with this instance. | - - -##### Exceptions - -`System.ArgumentException` -<code class="paramref">obj</code> is not the same type as this instance. -### CompareTo(RuntimeVersion) -Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L61) -```csharp title="Declaration" -public int CompareTo(RuntimeVersion other) -``` - -##### Returns - -`System.Int32`: A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes <code class="paramref">other</code> in the sort order. Zero This instance occurs in the same position in the sort order as <code class="paramref">other</code>. Greater than zero This instance follows <code class="paramref">other</code> in the sort order. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.RuntimeVersion](../Velopack/RuntimeVersion) | *other* | An object to compare with this instance. | - -### Equals(RuntimeVersion) -Indicates whether the current object is equal to another object of the same type. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L84) -```csharp title="Declaration" -public bool Equals(RuntimeVersion other) -``` - -##### Returns - -`System.Boolean`: true if the current object is equal to the <code class="paramref">other</code> parameter; otherwise, false. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.RuntimeVersion](../Velopack/RuntimeVersion) | *other* | An object to compare with this object. | - -### Equals(object) -Determines whether the specified object is equal to the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L91) -```csharp title="Declaration" -public override bool Equals(object obj) -``` - -##### Returns - -`System.Boolean`: true if the specified object is equal to the current object; otherwise, false. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.Object` | *obj* | The object to compare with the current object. | - -### GetHashCode() -Serves as the default hash function. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L96) -```csharp title="Declaration" -public override int GetHashCode() -``` - -##### Returns - -`System.Int32`: A hash code for the current object.### ToString() -Returns a string that represents the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L101) -```csharp title="Declaration" -public override string ToString() -``` - -##### Returns - -`System.String`: A string that represents the current object. -## Implements - -* `System.IComparable` -* `System.IComparable` -* `System.IEquatable` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateExe.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateExe.md deleted file mode 100644 index d585126..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateExe.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Class UpdateExe -sidebar_label: UpdateExe -description: "A static helper class to assist in running Update.exe CLI commands. You probably should not invoke this directly, -instead you should use the relevant methods on [Velopack.UpdateManager](../Velopack/UpdateManager). For example: -[Velopack.UpdateManager.ApplyUpdatesAndExit(Velopack.VelopackAsset?)](../Velopack/UpdateManager#applyupdatesandexitvelopackasset), or `Velopack.UpdateManager.ApplyUpdatesAndRestart(Velopack.VelopackAsset%2cSystem.String%5b%5d)`." ---- -# Class UpdateExe -A static helper class to assist in running Update.exe CLI commands. You probably should not invoke this directly, -instead you should use the relevant methods on [Velopack.UpdateManager](../Velopack/UpdateManager). For example: -[Velopack.UpdateManager.ApplyUpdatesAndExit(Velopack.VelopackAsset?)](../Velopack/UpdateManager#applyupdatesandexitvelopackasset), or `Velopack.UpdateManager.ApplyUpdatesAndRestart(Velopack.VelopackAsset%2cSystem.String%5b%5d)`. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateExe.cs#L18) -```csharp title="Declaration" -public static class UpdateExe -``` -## Methods -### Apply(IVelopackLocator?, VelopackAsset?, bool, bool, string[]?, ILogger?) -Runs Update.exe in the current working directory to apply updates, optionally restarting the application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateExe.cs#L36) -```csharp title="Declaration" -public static void Apply(IVelopackLocator? locator, VelopackAsset? toApply, bool silent, bool restart, string[]? restartArgs = null, ILogger? logger = null) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) | *locator* | The locator to use to find the path to Update.exe and the packages directory. | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *toApply* | The update package you wish to apply, can be left null. | -| `System.Boolean` | *silent* | If true, no dialogs will be shown during the update process. This could result - in an update failing to install, such as when we need to ask the user for permission to install - a new framework dependency. | -| `System.Boolean` | *restart* | If true, restarts the application after updates are applied (or if they failed) | -| `System.String[]` | *restartArgs* | The arguments to pass to the application when it is restarted. | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for diagnostic messages | - - -##### Exceptions - -`System.Exception` -Thrown if Update.exe does not initialize properly. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateInfo.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateInfo.md deleted file mode 100644 index 4b215b4..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateInfo.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Class UpdateInfo -sidebar_label: UpdateInfo -description: "Holds information about the current version and pending updates, such as how many there are, and access to release notes." ---- -# Class UpdateInfo -Holds information about the current version and pending updates, such as how many there are, and access to release notes. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateInfo.cs#L6) -```csharp title="Declaration" -public class UpdateInfo -``` -## Properties -### TargetFullRelease -The available version that we are updating to. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateInfo.cs#L11) -```csharp title="Declaration" -public VelopackAsset TargetFullRelease { get; } -``` -### IsDowngrade -True if the update is a version downgrade or lateral move (such as when switching channels to the same version number). -In this case, only full updates are allowed, and any local packages on disk newer than the downloaded version will be -deleted. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateInfo.cs#L18) -```csharp title="Declaration" -public bool IsDowngrade { get; } -``` -### BaseRelease -The base release that we are to apply delta updates from. If null, we can try doing a delta update from -the currently installed version. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateInfo.cs#L24) -```csharp title="Declaration" -public VelopackAsset? BaseRelease { get; } -``` -### DeltasToTarget -The list of delta versions between the current version and [Velopack.UpdateInfo.TargetFullRelease](../Velopack/UpdateInfo#targetfullrelease). -These will be applied in order. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateInfo.cs#L30) -```csharp title="Declaration" -public VelopackAsset[] DeltasToTarget { get; } -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateManager.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateManager.md deleted file mode 100644 index 2f45db6..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateManager.md +++ /dev/null @@ -1,279 +0,0 @@ ---- -title: Class UpdateManager -sidebar_label: UpdateManager -description: "Provides functionality for checking for updates, downloading updates, and applying updates to the current application." ---- -# Class UpdateManager -Provides functionality for checking for updates, downloading updates, and applying updates to the current application. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.Helpers.cs#L6) -```csharp title="Declaration" -public class UpdateManager -``` -## Properties -### AppId -The currently installed application Id. This would be what you set when you create your release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L22) -```csharp title="Declaration" -public virtual string? AppId { get; } -``` -### IsInstalled -True if this application is currently installed, and is able to download/check for updates. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L25) -```csharp title="Declaration" -public virtual bool IsInstalled { get; } -``` -### IsUpdatePendingRestart -True if there is a local update prepared that requires a call to `Velopack.UpdateManager.ApplyUpdatesAndRestart(Velopack.VelopackAsset%2cSystem.String%5b%5d)` to be applied. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L28) -```csharp title="Declaration" -public virtual bool IsUpdatePendingRestart { get; } -``` -### CurrentVersion -The currently installed app version when you created your release. Null if this is not a currently installed app. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L38) -```csharp title="Declaration" -public virtual SemanticVersion? CurrentVersion { get; } -``` -### Source -The update source to use when checking for/downloading updates. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L41) -```csharp title="Declaration" -protected IUpdateSource Source { get; } -``` -### Log -The logger to use for diagnostic messages. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L44) -```csharp title="Declaration" -protected ILogger Log { get; } -``` -### Locator -The locator to use when searching for local file paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L47) -```csharp title="Declaration" -protected IVelopackLocator Locator { get; } -``` -### Channel -The channel to use when searching for packages. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L50) -```csharp title="Declaration" -protected string Channel { get; } -``` -### DefaultChannel -The default channel to search for packages in, if one was not provided by the user. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L53) -```csharp title="Declaration" -protected string DefaultChannel { get; } -``` -### IsNonDefaultChannel -If true, an explicit channel was provided by the user, and it's different than the default channel. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L56) -```csharp title="Declaration" -protected bool IsNonDefaultChannel { get; } -``` -### ShouldAllowVersionDowngrade -If true, UpdateManager should return the latest asset in the feed, even if that version is lower than the current version. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L59) -```csharp title="Declaration" -protected bool ShouldAllowVersionDowngrade { get; } -``` -## Methods -### CheckForUpdates() -Checks for updates, returning null if there are none available. If there are updates available, this method will return an -UpdateInfo object containing the latest available release, and any delta updates that can be applied if they are available. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L98) -```csharp title="Declaration" -public UpdateInfo? CheckForUpdates() -``` - -##### Returns - -[Velopack.UpdateInfo](../Velopack/UpdateInfo): Null if no updates, otherwise [Velopack.UpdateInfo](../Velopack/UpdateInfo) containing the version of the latest update available.### CheckForUpdatesAsync() -Checks for updates, returning null if there are none available. If there are updates available, this method will return an -UpdateInfo object containing the latest available release, and any delta updates that can be applied if they are available. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L109) -```csharp title="Declaration" -public virtual Task CheckForUpdatesAsync() -``` - -##### Returns - -`System.Threading.Tasks.Task`: Null if no updates, otherwise [Velopack.UpdateInfo](../Velopack/UpdateInfo) containing the version of the latest update available.### CreateDeltaUpdateStrategy(VelopackAsset[], VelopackAsset?, VelopackAsset) -Given a feed of releases, and the latest local full release, and the latest remote full release, this method will return a delta -update strategy to be used by `Velopack.UpdateManager.DownloadUpdatesAsync(Velopack.UpdateInfo%2cSystem.Action%7bSystem.Int32%7d%2cSystem.Boolean%2cSystem.Threading.CancellationToken)`. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L155) -```csharp title="Declaration" -protected virtual UpdateInfo CreateDeltaUpdateStrategy(VelopackAsset[] feed, VelopackAsset? latestLocalFull, VelopackAsset latestRemoteFull) -``` - -##### Returns - -[Velopack.UpdateInfo](../Velopack/UpdateInfo) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `Velopack.VelopackAsset[]` | *feed* | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestLocalFull* | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestRemoteFull* | - -### DownloadUpdates(UpdateInfo, Action<int>?, bool) -Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, -this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta -packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock -so may fail if there is already another update operation in progress. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L183) -```csharp title="Declaration" -public void DownloadUpdates(UpdateInfo updates, Action? progress = null, bool ignoreDeltas = false) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.UpdateInfo](../Velopack/UpdateInfo) | *updates* | The updates to download. Should be retrieved from [Velopack.UpdateManager.CheckForUpdates()](../Velopack/UpdateManager#checkforupdates). | -| `System.Action` | *progress* | The progress callback. Will be called with values from 0-100. | -| `System.Boolean` | *ignoreDeltas* | Whether to attempt downloading delta's or skip to full package download. | - -### DownloadUpdatesAsync(UpdateInfo, Action<int>?, bool, CancellationToken) -Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, -this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta -packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock -so may fail if there is already another update operation in progress. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L199) -```csharp title="Declaration" -public virtual Task DownloadUpdatesAsync(UpdateInfo updates, Action? progress = null, bool ignoreDeltas = false, CancellationToken cancelToken = default) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.UpdateInfo](../Velopack/UpdateInfo) | *updates* | The updates to download. Should be retrieved from [Velopack.UpdateManager.CheckForUpdates()](../Velopack/UpdateManager#checkforupdates). | -| `System.Action` | *progress* | The progress callback. Will be called with values from 0-100. | -| `System.Boolean` | *ignoreDeltas* | Whether to attempt downloading delta's or skip to full package download. | -| `System.Threading.CancellationToken` | *cancelToken* | An optional cancellation token if you wish to stop this operation. | - -### DownloadAndApplyDeltaUpdates(string, UpdateInfo, Action<int>, CancellationToken) -Given a folder containing the extracted base package, and a list of delta updates, downloads and applies the -delta updates to the base package. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L328) -```csharp title="Declaration" -protected virtual Task DownloadAndApplyDeltaUpdates(string extractedBasePackage, UpdateInfo updates, Action progress, CancellationToken cancelToken) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *extractedBasePackage* | A folder containing the application files to apply the delta's to. | -| [Velopack.UpdateInfo](../Velopack/UpdateInfo) | *updates* | An update object containing one or more delta's | -| `System.Action` | *progress* | A callback reporting process of delta application progress (from 0-100). | -| `System.Threading.CancellationToken` | *cancelToken* | A token to use to cancel the request. | - -### CleanPackagesExcept(string?) -Removes any incomplete files (.partial) and packages (.nupkg) from the packages directory that does not match -the provided asset. If assetToKeep is null, all packages will be deleted. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L379) -```csharp title="Declaration" -protected virtual void CleanPackagesExcept(string? assetToKeep) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *assetToKeep* | - -### VerifyPackageChecksum(VelopackAsset, string?) -Check a package checksum against the one in the release entry, and throws if the checksum does not match. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L416) -```csharp title="Declaration" -protected virtual void VerifyPackageChecksum(VelopackAsset release, string? filePathOverride = null) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *release* | The entry to check | -| `System.String` | *filePathOverride* | Optional file path, if not specified the package will be loaded from %pkgdir%/release.OriginalFilename. | - -### EnsureInstalled() -Throws an exception if the current application is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L439) -```csharp title="Declaration" -protected virtual void EnsureInstalled() -``` -### AcquireUpdateLock() -Acquires a globally unique mutex/lock for the current application, to avoid concurrent install/uninstall/update operations. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L448) -```csharp title="Declaration" -protected virtual Mutex AcquireUpdateLock() -``` - -##### Returns - -`System.Threading.Mutex` -### ApplyUpdatesAndRestart(VelopackAsset?, string[]?) -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified -restart arguments. If you need to save state or clean up, you should do that before calling this method. -The user may be prompted during the update, if the update requires additional frameworks to be installed etc. -You can check if there are pending updates by checking [Velopack.UpdateManager.IsUpdatePendingRestart](../Velopack/UpdateManager#isupdatependingrestart). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.Helpers.cs#L22) -```csharp title="Declaration" -public void ApplyUpdatesAndRestart(VelopackAsset? toApply, string[]? restartArgs = null) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *toApply* | The target release to apply. Can be left null to auto-apply the newest downloaded release. | -| `System.String[]` | *restartArgs* | The arguments to pass to the application when it is restarted. | - -### ApplyUpdatesAndExit(VelopackAsset?) -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified -restart arguments. If you need to save state or clean up, you should do that before calling this method. -The user may be prompted during the update, if the update requires additional frameworks to be installed etc. -You can check if there are pending updates by checking [Velopack.UpdateManager.IsUpdatePendingRestart](../Velopack/UpdateManager#isupdatependingrestart). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.Helpers.cs#L41) -```csharp title="Declaration" -public void ApplyUpdatesAndExit(VelopackAsset? toApply) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *toApply* | The target release to apply. Can be left null to auto-apply the newest downloaded release. | - -### WaitExitThenApplyUpdates(VelopackAsset?, bool, bool, string[]?) -This will launch the Velopack updater and tell it to wait for this program to exit gracefully. -You should then clean up any state and exit your app. The updater will apply updates and then -optionally restart your app. The updater will only wait for 60 seconds before giving up. -You can check if there are pending updates by checking [Velopack.UpdateManager.IsUpdatePendingRestart](../Velopack/UpdateManager#isupdatependingrestart). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.Helpers.cs#L57) -```csharp title="Declaration" -public void WaitExitThenApplyUpdates(VelopackAsset? toApply, bool silent = false, bool restart = true, string[]? restartArgs = null) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *toApply* | The target release to apply. Can be left null to auto-apply the newest downloaded release. | -| `System.Boolean` | *silent* | Configure whether Velopack should show a progress window / dialogs during the updates or not. | -| `System.Boolean` | *restart* | Configure whether Velopack should restart the app after the updates have been applied. | -| `System.String[]` | *restartArgs* | The arguments to pass to the application when it is restarted. | - diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateOptions.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateOptions.md deleted file mode 100644 index 543b510..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateOptions.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Class UpdateOptions -sidebar_label: UpdateOptions -description: "Options to customise the behaviour of [Velopack.UpdateManager](../Velopack/UpdateManager)." ---- -# Class UpdateOptions -Options to customise the behaviour of [Velopack.UpdateManager](../Velopack/UpdateManager). - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateOptions.cs#L6) -```csharp title="Declaration" -public class UpdateOptions -``` -## Properties -### AllowVersionDowngrade -Allows UpdateManager to update to a version that's lower than the current version (i.e. downgrading). -This could happen if a release has bugs and was retracted from the release feed, or if you're using -[Velopack.UpdateOptions.ExplicitChannel](../Velopack/UpdateOptions#explicitchannel) to switch channels to another channel where the latest version on that -channel is lower than the current version. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateOptions.cs#L14) -```csharp title="Declaration" -public bool AllowVersionDowngrade { get; set; } -``` -### ExplicitChannel -<b>This option should usually be left null</b>. Overrides the default channel used to fetch updates. -The default channel will be whatever channel was specified on the command line when building this release. -For example, if the current release was packaged with '--channel beta', then the default channel will be 'beta'. -This allows users to automatically receive updates from the same channel they installed from. This options -allows you to explicitly switch channels, for example if the user wished to switch back to the 'stable' channel -without having to reinstall the application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateOptions.cs#L24) -```csharp title="Declaration" -public string? ExplicitChannel { get; set; } -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/Velopack.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/Velopack.md deleted file mode 100644 index 01742fc..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/Velopack.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Namespace Velopack -sidebar_label: Velopack ---- -# Namespace Velopack -## Classes -### [ReleaseEntry](../Velopack/ReleaseEntry) -Represents a Velopack release, as described in a RELEASES file - usually also with an -accompanying package containing the files needed to apply the release. -### [ReleaseEntryName](../Velopack/ReleaseEntryName) -Represents the information that can be parsed from a release entry filename. -### [RID](../Velopack/RID) - -### [RuntimeVersion](../Velopack/RuntimeVersion) -A Version class that also supports a single integer (major only) -### [UpdateExe](../Velopack/UpdateExe) -A static helper class to assist in running Update.exe CLI commands. You probably should not invoke this directly, -instead you should use the relevant methods on [Velopack.UpdateManager](../Velopack/UpdateManager). For example: -[Velopack.UpdateManager.ApplyUpdatesAndExit(Velopack.VelopackAsset?)](../Velopack/UpdateManager#applyupdatesandexitvelopackasset), or `Velopack.UpdateManager.ApplyUpdatesAndRestart(Velopack.VelopackAsset%2cSystem.String%5b%5d)`. -### [UpdateInfo](../Velopack/UpdateInfo) -Holds information about the current version and pending updates, such as how many there are, and access to release notes. -### [UpdateManager](../Velopack/UpdateManager) -Provides functionality for checking for updates, downloading updates, and applying updates to the current application. -### [UpdateOptions](../Velopack/UpdateOptions) -Options to customise the behaviour of [Velopack.UpdateManager](../Velopack/UpdateManager). -### [VelopackApp](../Velopack/VelopackApp) -VelopackApp helps you to handle app activation events correctly. -This should be used as early as possible in your application startup code. -(eg. the beginning of Main() in Program.cs) -### [VelopackAsset](../Velopack/VelopackAsset) -An individual Velopack asset, could refer to an asset on-disk or in a remote package feed. -### [VelopackAssetFeed](../Velopack/VelopackAssetFeed) -A feed of Velopack assets, usually returned from an [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource). -### [VelopackRuntimeInfo](../Velopack/VelopackRuntimeInfo) -Convenience class which provides runtime information about the current executing process, -in a way that is safe in older and newer versions of the framework. -## Enums -### [ReleaseNotesFormat](../Velopack/ReleaseNotesFormat) -Describes the requested release notes text format. -### [RidDisplayType](../Velopack/RidDisplayType) - -### [RuntimeCpu](../Velopack/RuntimeCpu) -The Runtime CPU Architecture -### [RuntimeOs](../Velopack/RuntimeOs) -The Runtime OS -### [VelopackAssetType](../Velopack/VelopackAssetType) -Represents a Velopack Asset Type. -## Delegates -### [VelopackHook](../Velopack/VelopackHook) -A delegate type for handling Velopack startup events diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackApp.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackApp.md deleted file mode 100644 index b0df302..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackApp.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -title: Class VelopackApp -sidebar_label: VelopackApp -description: "VelopackApp helps you to handle app activation events correctly. -This should be used as early as possible in your application startup code. -(eg. the beginning of Main() in Program.cs)" ---- -# Class VelopackApp -VelopackApp helps you to handle app activation events correctly. -This should be used as early as possible in your application startup code. -(eg. the beginning of Main() in Program.cs) - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L23) -```csharp title="Declaration" -public sealed class VelopackApp -``` -## Methods -### Build() -Creates and returns a new Velopack application builder. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L45) -```csharp title="Declaration" -public static VelopackApp Build() -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) -### SetArgs(string[]) -Override the command line arguments used to determine the Velopack hook to run. -If this is not set, the command line arguments passed to the application will be used. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L51) -```csharp title="Declaration" -public VelopackApp SetArgs(string[] args) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String[]` | *args* | - -### SetAutoApplyOnStartup(bool) -Set whether to automatically apply downloaded updates on startup. This is ON by default. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L60) -```csharp title="Declaration" -public VelopackApp SetAutoApplyOnStartup(bool autoApply) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Boolean` | *autoApply* | - -### SetLocator(IVelopackLocator) -Override the default [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) used to search for application paths. -This will be cached and potentially re-used throughout the lifetime of the application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L70) -```csharp title="Declaration" -public VelopackApp SetLocator(IVelopackLocator locator) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) | *locator* | - -### WithFirstRun(VelopackHook) -This hook is triggered when the application is started for the first time after installation. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L79) -```csharp title="Declaration" -public VelopackApp WithFirstRun(VelopackHook hook) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackHook](../Velopack/VelopackHook) | *hook* | - -### WithRestarted(VelopackHook) -This hook is triggered when the application is restarted by Velopack after installing updates. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L88) -```csharp title="Declaration" -public VelopackApp WithRestarted(VelopackHook hook) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackHook](../Velopack/VelopackHook) | *hook* | - -### WithAfterInstallFastCallback(VelopackHook) -WARNING: FastCallback hooks are run during critical stages of Velopack operations. -Your code will be run and then `System.Environment.Exit(System.Int32)` will be called. -If your code has not completed within 30 seconds, it will be terminated. -Only supported on windows; On other operating systems, this will never be called. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L100) -```csharp title="Declaration" -public VelopackApp WithAfterInstallFastCallback(VelopackHook hook) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackHook](../Velopack/VelopackHook) | *hook* | - -### WithAfterUpdateFastCallback(VelopackHook) -WARNING: FastCallback hooks are run during critical stages of Velopack operations. -Your code will be run and then `System.Environment.Exit(System.Int32)` will be called. -If your code has not completed within 15 seconds, it will be terminated. -Only supported on windows; On other operating systems, this will never be called. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L113) -```csharp title="Declaration" -public VelopackApp WithAfterUpdateFastCallback(VelopackHook hook) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackHook](../Velopack/VelopackHook) | *hook* | - -### WithBeforeUpdateFastCallback(VelopackHook) -WARNING: FastCallback hooks are run during critical stages of Velopack operations. -Your code will be run and then `System.Environment.Exit(System.Int32)` will be called. -If your code has not completed within 15 seconds, it will be terminated. -Only supported on windows; On other operating systems, this will never be called. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L126) -```csharp title="Declaration" -public VelopackApp WithBeforeUpdateFastCallback(VelopackHook hook) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackHook](../Velopack/VelopackHook) | *hook* | - -### WithBeforeUninstallFastCallback(VelopackHook) -WARNING: FastCallback hooks are run during critical stages of Velopack operations. -Your code will be run and then `System.Environment.Exit(System.Int32)` will be called. -If your code has not completed within 30 seconds, it will be terminated. -Only supported on windows; On other operating systems, this will never be called. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L139) -```csharp title="Declaration" -public VelopackApp WithBeforeUninstallFastCallback(VelopackHook hook) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackHook](../Velopack/VelopackHook) | *hook* | - -### Run(ILogger?) -Runs the Velopack application startup code and triggers any configured hooks. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L151) -```csharp title="Declaration" -public void Run(ILogger? logger = null) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | A logging interface for diagnostic messages. This will be - cached and potentially re-used throughout the lifetime of the application. | - diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAsset.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAsset.md deleted file mode 100644 index cd7e855..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAsset.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: Class VelopackAsset -sidebar_label: VelopackAsset -description: "An individual Velopack asset, could refer to an asset on-disk or in a remote package feed." ---- -# Class VelopackAsset -An individual Velopack asset, could refer to an asset on-disk or in a remote package feed. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L43) -```csharp title="Declaration" -public record VelopackAsset : IEquatable -``` -**Derived:** -[Velopack.Sources.GitBase<T>.GitBaseAsset](../Velopack.Sources/GitBase`T`.GitBaseAsset) - -**Implements:** -`System.IEquatable` - -## Properties -### PackageId -The name or Id of the package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L46) -```csharp title="Declaration" -public string PackageId { get; init; } -``` -### Version -The version of this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L49) -```csharp title="Declaration" -public SemanticVersion Version { get; init; } -``` -### Type -The type of asset (eg. full or delta). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L52) -```csharp title="Declaration" -public VelopackAssetType Type { get; init; } -``` -### FileName -The filename of the update package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L55) -```csharp title="Declaration" -public string FileName { get; init; } -``` -### SHA1 -The SHA1 checksum of the update package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L58) -```csharp title="Declaration" -public string SHA1 { get; init; } -``` -### Size -The size in bytes of the update package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L61) -```csharp title="Declaration" -public long Size { get; init; } -``` -### NotesMarkdown -The release notes in markdown format, as passed to Velopack when packaging the release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L64) -```csharp title="Declaration" -public string NotesMarkdown { get; init; } -``` -### NotesHTML -The release notes in HTML format, transformed from Markdown when packaging the release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L67) -```csharp title="Declaration" -public string NotesHTML { get; init; } -``` -## Methods -### FromZipPackage(ZipPackage) -Convert a [Velopack.NuGet.ZipPackage](../Velopack.NuGet/ZipPackage) to a [Velopack.VelopackAsset](../Velopack/VelopackAsset). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L72) -```csharp title="Declaration" -public static VelopackAsset FromZipPackage(ZipPackage zip) -``` - -##### Returns - -[Velopack.VelopackAsset](../Velopack/VelopackAsset) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.NuGet.ZipPackage](../Velopack.NuGet/ZipPackage) | *zip* | - -### FromNupkg(string) -Load a [Velopack.VelopackAsset](../Velopack/VelopackAsset) from a .nupkg file on disk. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L90) -```csharp title="Declaration" -public static VelopackAsset FromNupkg(string filePath) -``` - -##### Returns - -[Velopack.VelopackAsset](../Velopack/VelopackAsset) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *filePath* | - - -## Implements - -* `System.IEquatable` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetFeed.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetFeed.md deleted file mode 100644 index 50df326..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetFeed.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Class VelopackAssetFeed -sidebar_label: VelopackAssetFeed -description: "A feed of Velopack assets, usually returned from an [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource)." ---- -# Class VelopackAssetFeed -A feed of Velopack assets, usually returned from an [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource). - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L24) -```csharp title="Declaration" -public record VelopackAssetFeed : IEquatable -``` -**Implements:** -`System.IEquatable` - -## Properties -### Assets -A list of assets available in this feed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L29) -```csharp title="Declaration" -public VelopackAsset[] Assets { get; init; } -``` -## Methods -### FromJson(string) -Parse a json string into a [Velopack.VelopackAssetFeed](../Velopack/VelopackAssetFeed). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L34) -```csharp title="Declaration" -public static VelopackAssetFeed FromJson(string json) -``` - -##### Returns - -[Velopack.VelopackAssetFeed](../Velopack/VelopackAssetFeed) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *json* | - - -## Implements - -* `System.IEquatable` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetType.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetType.md deleted file mode 100644 index 95b81ac..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetType.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Enum VelopackAssetType -sidebar_label: VelopackAssetType -description: "Represents a Velopack Asset Type." ---- -# Enum VelopackAssetType -Represents a Velopack Asset Type. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L13) -```csharp title="Declaration" -public enum VelopackAssetType -``` -## Fields -### Full -A full update package. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L16) -```csharp title="Declaration" -Full = 1 -``` -### Delta -A delta update package. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L18) -```csharp title="Declaration" -Delta = 2 -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackHook.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackHook.md deleted file mode 100644 index 35668b9..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackHook.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Delegate VelopackHook -sidebar_label: VelopackHook -description: "A delegate type for handling Velopack startup events" ---- -# Delegate VelopackHook -A delegate type for handling Velopack startup events - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L16) -```csharp title="Declaration" -public delegate void VelopackHook(SemanticVersion version) -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackRuntimeInfo.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackRuntimeInfo.md deleted file mode 100644 index 6378364..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackRuntimeInfo.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: Class VelopackRuntimeInfo -sidebar_label: VelopackRuntimeInfo -description: "Convenience class which provides runtime information about the current executing process, -in a way that is safe in older and newer versions of the framework." ---- -# Class VelopackRuntimeInfo -Convenience class which provides runtime information about the current executing process, -in a way that is safe in older and newer versions of the framework. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L79) -```csharp title="Declaration" -public static class VelopackRuntimeInfo -``` -## Properties -### VelopackDisplayVersion -The current compiled Velopack display version. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L82) -```csharp title="Declaration" -public static string VelopackDisplayVersion { get; } -``` -### VelopackNugetVersion -The current compiled Velopack NuGetVersion. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L85) -```csharp title="Declaration" -public static NuGetVersion VelopackNugetVersion { get; } -``` -### VelopackProductVersion -The current compiled Velopack ProductVersion. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L88) -```csharp title="Declaration" -public static NuGetVersion VelopackProductVersion { get; } -``` -### EntryExePath -The path on disk of the entry assembly. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L91) -```csharp title="Declaration" -public static string EntryExePath { get; } -``` -### SystemArch -The current machine architecture, ignoring the current process / pe architecture. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L94) -```csharp title="Declaration" -public static RuntimeCpu SystemArch { get; } -``` -### SystemOs -The name of the current OS - eg. 'windows', 'linux', or 'osx'. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L97) -```csharp title="Declaration" -public static RuntimeOs SystemOs { get; } -``` -### SystemRid -The current system RID. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L100) -```csharp title="Declaration" -public static string SystemRid { get; } -``` -### IsWindows -True if executing on a Windows platform. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L103) -```csharp title="Declaration" -public static bool IsWindows { get; } -``` -### IsLinux -True if executing on a Linux platform. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L107) -```csharp title="Declaration" -public static bool IsLinux { get; } -``` -### IsOSX -True if executing on a MacOS / OSX platform. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L111) -```csharp title="Declaration" -public static bool IsOSX { get; } -``` -## Methods -### GetOsShortName(RuntimeOs) -Returns the shortened OS name as a string, suitable for creating an RID. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L185) -```csharp title="Declaration" -public static string GetOsShortName(this RuntimeOs os) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.RuntimeOs](../Velopack/RuntimeOs) | *os* | - -### GetOsLongName(RuntimeOs) -Returns the long OS name, suitable for showing to a human. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L198) -```csharp title="Declaration" -public static string GetOsLongName(this RuntimeOs os) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.RuntimeOs](../Velopack/RuntimeOs) | *os* | - diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/index.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/reference/index.mdx deleted file mode 100644 index 0f574b7..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ -import DocCardList from '@theme/DocCardList'; - -# Library Reference -The documentation in this library reference is auto-generated from inline comments in the library code. - -If there are inaccuracies here, please submit a PR to the code comments on the library repository itself -rather than to the docs repository. - - \ No newline at end of file diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/JsonNode.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/JsonNode.md deleted file mode 100644 index 821fbd4..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/JsonNode.md +++ /dev/null @@ -1,301 +0,0 @@ -# Class: JsonNode - -## Constructors - -### constructor - -• **new JsonNode**(): [`JsonNode`](JsonNode.md) - -#### Returns - -[`JsonNode`](JsonNode.md) - -## Properties - -### #private - -• `Private` **#private**: `any` - -#### Defined in - -[Velopack.d.ts:10](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L10) - -## Methods - -### addArrayChild - -▸ **addArrayChild**(`child`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `child` | [`JsonNode`](JsonNode.md) | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:49](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L49) - -___ - -### addObjectChild - -▸ **addObjectChild**(`key`, `child`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `child` | [`JsonNode`](JsonNode.md) | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:51](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L51) - -___ - -### asArray - -▸ **asArray**(): readonly [`JsonNode`](JsonNode.md)[] - -Reinterpret a JSON value as an array. Throws exception if the value type was not an array. - -#### Returns - -readonly [`JsonNode`](JsonNode.md)[] - -#### Defined in - -[Velopack.d.ts:33](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L33) - -___ - -### asBool - -▸ **asBool**(): `boolean` - -Reinterpret a JSON value as a boolean. Throws exception if the value type was not a boolean. - -#### Returns - -`boolean` - -#### Defined in - -[Velopack.d.ts:41](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L41) - -___ - -### asNumber - -▸ **asNumber**(): `number` - -Reinterpret a JSON value as a number. Throws exception if the value type was not a double. - -#### Returns - -`number` - -#### Defined in - -[Velopack.d.ts:37](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L37) - -___ - -### asObject - -▸ **asObject**(): `Readonly`\<`Record`\<`string`, [`JsonNode`](JsonNode.md)\>\> - -Reinterpret a JSON value as an object. Throws exception if the value type was not an object. - -#### Returns - -`Readonly`\<`Record`\<`string`, [`JsonNode`](JsonNode.md)\>\> - -#### Defined in - -[Velopack.d.ts:29](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L29) - -___ - -### asString - -▸ **asString**(): `string` - -Reinterpret a JSON value as a string. Throws exception if the value type was not a string. - -#### Returns - -`string` - -#### Defined in - -[Velopack.d.ts:45](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L45) - -___ - -### getKind - -▸ **getKind**(): [`JsonNodeType`](../enums/JsonNodeType.md) - -Get the type of this node, such as string, object, array, etc. -You should use this function and then call the corresponding -AsObject, AsArray, AsString, etc. functions to get the actual -parsed json information. - -#### Returns - -[`JsonNodeType`](../enums/JsonNodeType.md) - -#### Defined in - -[Velopack.d.ts:17](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L17) - -___ - -### initArray - -▸ **initArray**(): `void` - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:48](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L48) - -___ - -### initBool - -▸ **initBool**(`value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:47](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L47) - -___ - -### initNumber - -▸ **initNumber**(`value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:52](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L52) - -___ - -### initObject - -▸ **initObject**(): `void` - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:50](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L50) - -___ - -### initString - -▸ **initString**(`value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:53](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L53) - -___ - -### isEmpty - -▸ **isEmpty**(): `boolean` - -Check if the JSON value is empty - eg. an empty string, array, or object. - -#### Returns - -`boolean` - -#### Defined in - -[Velopack.d.ts:25](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L25) - -___ - -### isNull - -▸ **isNull**(): `boolean` - -Check if the JSON value is null. - -#### Returns - -`boolean` - -#### Defined in - -[Velopack.d.ts:21](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L21) - -___ - -### parse - -▸ **parse**(`text`): [`JsonNode`](JsonNode.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `text` | `string` | - -#### Returns - -[`JsonNode`](JsonNode.md) - -#### Defined in - -[Velopack.d.ts:46](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L46) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateInfo.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateInfo.md deleted file mode 100644 index b0c5cab..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateInfo.md +++ /dev/null @@ -1,61 +0,0 @@ -# Class: UpdateInfo - -Holds information about the current version and pending updates, such as how many there are, and access to release notes. - -## Constructors - -### constructor - -• **new UpdateInfo**(): [`UpdateInfo`](UpdateInfo.md) - -#### Returns - -[`UpdateInfo`](UpdateInfo.md) - -## Properties - -### isDowngrade - -• **isDowngrade**: `boolean` - -True if the update is a version downgrade or lateral move (such as when switching channels to the same version number). -In this case, only full updates are allowed, and any local packages on disk newer than the downloaded version will be -deleted. - -#### Defined in - -[Velopack.d.ts:118](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L118) - -___ - -### targetFullRelease - -• **targetFullRelease**: [`VelopackAsset`](VelopackAsset.md) - -The available version that we are updating to. - -#### Defined in - -[Velopack.d.ts:112](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L112) - -## Methods - -### fromJson - -▸ **fromJson**(`json`): [`UpdateInfo`](UpdateInfo.md) - -Parses a JSON string into an UpdateInfo object. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `json` | `string` | - -#### Returns - -[`UpdateInfo`](UpdateInfo.md) - -#### Defined in - -[Velopack.d.ts:122](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L122) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManager.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManager.md deleted file mode 100644 index 4b131d3..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManager.md +++ /dev/null @@ -1,482 +0,0 @@ -# Class: UpdateManager - -This class is used to check for updates, download updates, and apply updates. -It provides the asynchronous functions of the UpdateManager class. - -## Hierarchy - -- [`UpdateManagerSync`](UpdateManagerSync.md) - - ↳ **`UpdateManager`** - -## Constructors - -### constructor - -• **new UpdateManager**(): [`UpdateManager`](UpdateManager.md) - -#### Returns - -[`UpdateManager`](UpdateManager.md) - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[constructor](UpdateManagerSync.md#constructor) - -## Properties - -### #private - -• `Private` **#private**: `any` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[#private](UpdateManagerSync.md##private) - -#### Defined in - -[Velopack.d.ts:130](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L130) - -## Methods - -### applyUpdatesAndExit - -▸ **applyUpdatesAndExit**(`toApply`): `void` - -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified -restart arguments. If you need to save state or clean up, you should do that before calling this method. -The user may be prompted during the update, if the update requires additional frameworks to be installed etc. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[applyUpdatesAndExit](UpdateManagerSync.md#applyupdatesandexit) - -#### Defined in - -[Velopack.d.ts:199](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L199) - -___ - -### applyUpdatesAndRestart - -▸ **applyUpdatesAndRestart**(`toApply`, `restartArgs?`): `void` - -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified -restart arguments. If you need to save state or clean up, you should do that before calling this method. -The user may be prompted during the update, if the update requires additional frameworks to be installed etc. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | -| `restartArgs?` | readonly `string`[] | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[applyUpdatesAndRestart](UpdateManagerSync.md#applyupdatesandrestart) - -#### Defined in - -[Velopack.d.ts:205](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L205) - -___ - -### checkForUpdates - -▸ **checkForUpdates**(): [`UpdateInfo`](UpdateInfo.md) - -This function will check for updates, and return information about the latest -available release. This function runs synchronously and may take some time to -complete, depending on the network speed and the number of updates available. - -#### Returns - -[`UpdateInfo`](UpdateInfo.md) - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[checkForUpdates](UpdateManagerSync.md#checkforupdates) - -#### Defined in - -[Velopack.d.ts:186](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L186) - -___ - -### checkForUpdatesAsync - -▸ **checkForUpdatesAsync**(): `Promise`\<[`UpdateInfo`](UpdateInfo.md)\> - -This function will check for updates, and return information about the latest -available release. This function runs synchronously and may take some time to -complete, depending on the network speed and the number of updates available. - -#### Returns - -`Promise`\<[`UpdateInfo`](UpdateInfo.md)\> - -#### Defined in - -[Velopack.d.ts:243](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L243) - -___ - -### downloadUpdates - -▸ **downloadUpdates**(`toDownload`): `void` - -Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, -this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta -packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock -so may fail if there is already another update operation in progress. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toDownload` | [`VelopackAsset`](VelopackAsset.md) | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[downloadUpdates](UpdateManagerSync.md#downloadupdates) - -#### Defined in - -[Velopack.d.ts:193](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L193) - -___ - -### downloadUpdatesAsync - -▸ **downloadUpdatesAsync**(`toDownload`, `progress`): `Promise`\<`void`\> - -Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, -this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta -packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock -so may fail if there is already another update operation in progress. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toDownload` | [`VelopackAsset`](VelopackAsset.md) | -| `progress` | (`arg`: `number`) => `void` | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[Velopack.d.ts:250](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L250) - -___ - -### getCheckForUpdatesCommand - -▸ **getCheckForUpdatesCommand**(): `string`[] - -Returns the command line arguments to check for updates. - -#### Returns - -`string`[] - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[getCheckForUpdatesCommand](UpdateManagerSync.md#getcheckforupdatescommand) - -#### Defined in - -[Velopack.d.ts:158](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L158) - -___ - -### getCurrentVersion - -▸ **getCurrentVersion**(): `string` - -Get the currently installed version of the application. -If the application is not installed, this function will throw an exception. - -#### Returns - -`string` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[getCurrentVersion](UpdateManagerSync.md#getcurrentversion) - -#### Defined in - -[Velopack.d.ts:180](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L180) - -___ - -### getCurrentVersionAsync - -▸ **getCurrentVersionAsync**(): `Promise`\<`string`\> - -Checks for updates, returning null if there are none available. If there are updates available, this method will return an -UpdateInfo object containing the latest available release, and any delta updates that can be applied if they are available. - -#### Returns - -`Promise`\<`string`\> - -#### Defined in - -[Velopack.d.ts:237](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L237) - -___ - -### getCurrentVersionCommand - -▸ **getCurrentVersionCommand**(): `string`[] - -Returns the command line arguments to get the current version of the application. - -#### Returns - -`string`[] - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[getCurrentVersionCommand](UpdateManagerSync.md#getcurrentversioncommand) - -#### Defined in - -[Velopack.d.ts:154](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L154) - -___ - -### getDownloadUpdatesCommand - -▸ **getDownloadUpdatesCommand**(`toDownload`): `string`[] - -Returns the command line arguments to download the specified update. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toDownload` | [`VelopackAsset`](VelopackAsset.md) | - -#### Returns - -`string`[] - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[getDownloadUpdatesCommand](UpdateManagerSync.md#getdownloadupdatescommand) - -#### Defined in - -[Velopack.d.ts:162](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L162) - -___ - -### getPackagesDir - -▸ **getPackagesDir**(): `string` - -Returns the path to the app's packages directory. This is where updates are downloaded to. - -#### Returns - -`string` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[getPackagesDir](UpdateManagerSync.md#getpackagesdir) - -#### Defined in - -[Velopack.d.ts:170](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L170) - -___ - -### getUpdateApplyCommand - -▸ **getUpdateApplyCommand**(`toApply`, `silent`, `restart`, `wait`, `restartArgs?`): `string`[] - -Returns the command line arguments to apply the specified update. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | -| `silent` | `boolean` | -| `restart` | `boolean` | -| `wait` | `boolean` | -| `restartArgs?` | readonly `string`[] | - -#### Returns - -`string`[] - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[getUpdateApplyCommand](UpdateManagerSync.md#getupdateapplycommand) - -#### Defined in - -[Velopack.d.ts:166](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L166) - -___ - -### isInstalled - -▸ **isInstalled**(): `boolean` - -Returns true if the current app is installed, false otherwise. If the app is not installed, other functions in -UpdateManager may throw exceptions, so you may want to check this before calling other functions. - -#### Returns - -`boolean` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[isInstalled](UpdateManagerSync.md#isinstalled) - -#### Defined in - -[Velopack.d.ts:175](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L175) - -___ - -### setAllowDowngrade - -▸ **setAllowDowngrade**(`allowDowngrade`): `void` - -Allows UpdateManager to update to a version that's lower than the current version (i.e. downgrading). -This could happen if a release has bugs and was retracted from the release feed, or if you're using -ExplicitChannel to switch channels to another channel where the latest version on that -channel is lower than the current version. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `allowDowngrade` | `boolean` | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[setAllowDowngrade](UpdateManagerSync.md#setallowdowngrade) - -#### Defined in - -[Velopack.d.ts:141](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L141) - -___ - -### setExplicitChannel - -▸ **setExplicitChannel**(`explicitChannel`): `void` - -This option should usually be left null. Overrides the default channel used to fetch updates. -The default channel will be whatever channel was specified on the command line when building this release. -For example, if the current release was packaged with '--channel beta', then the default channel will be 'beta'. -This allows users to automatically receive updates from the same channel they installed from. This options -allows you to explicitly switch channels, for example if the user wished to switch back to the 'stable' channel -without having to reinstall the application. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `explicitChannel` | `string` | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[setExplicitChannel](UpdateManagerSync.md#setexplicitchannel) - -#### Defined in - -[Velopack.d.ts:150](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L150) - -___ - -### setUrlOrPath - -▸ **setUrlOrPath**(`urlOrPath`): `void` - -Set the URL or local file path to the update server. This is required before calling CheckForUpdates or DownloadUpdates. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `urlOrPath` | `string` | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[setUrlOrPath](UpdateManagerSync.md#seturlorpath) - -#### Defined in - -[Velopack.d.ts:134](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L134) - -___ - -### waitExitThenApplyUpdates - -▸ **waitExitThenApplyUpdates**(`toApply`, `silent`, `restart`, `restartArgs?`): `void` - -This will launch the Velopack updater and tell it to wait for this program to exit gracefully. -You should then clean up any state and exit your app. The updater will apply updates and then -optionally restart your app. The updater will only wait for 60 seconds before giving up. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | -| `silent` | `boolean` | -| `restart` | `boolean` | -| `restartArgs?` | readonly `string`[] | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[waitExitThenApplyUpdates](UpdateManagerSync.md#waitexitthenapplyupdates) - -#### Defined in - -[Velopack.d.ts:211](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L211) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManagerSync.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManagerSync.md deleted file mode 100644 index 7ceadd5..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManagerSync.md +++ /dev/null @@ -1,354 +0,0 @@ -# Class: UpdateManagerSync - -This class is used to check for updates, download updates, and apply updates. It is a synchronous version of the UpdateManager class. -This class is not recommended for use in GUI applications, as it will block the main thread, so you may want to use the async -UpdateManager class instead, if it is supported for your programming language. - -## Hierarchy - -- **`UpdateManagerSync`** - - ↳ [`UpdateManager`](UpdateManager.md) - -## Constructors - -### constructor - -• **new UpdateManagerSync**(): [`UpdateManagerSync`](UpdateManagerSync.md) - -#### Returns - -[`UpdateManagerSync`](UpdateManagerSync.md) - -## Properties - -### #private - -• `Private` **#private**: `any` - -#### Defined in - -[Velopack.d.ts:130](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L130) - -## Methods - -### applyUpdatesAndExit - -▸ **applyUpdatesAndExit**(`toApply`): `void` - -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified -restart arguments. If you need to save state or clean up, you should do that before calling this method. -The user may be prompted during the update, if the update requires additional frameworks to be installed etc. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:199](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L199) - -___ - -### applyUpdatesAndRestart - -▸ **applyUpdatesAndRestart**(`toApply`, `restartArgs?`): `void` - -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified -restart arguments. If you need to save state or clean up, you should do that before calling this method. -The user may be prompted during the update, if the update requires additional frameworks to be installed etc. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | -| `restartArgs?` | readonly `string`[] | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:205](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L205) - -___ - -### checkForUpdates - -▸ **checkForUpdates**(): [`UpdateInfo`](UpdateInfo.md) - -This function will check for updates, and return information about the latest -available release. This function runs synchronously and may take some time to -complete, depending on the network speed and the number of updates available. - -#### Returns - -[`UpdateInfo`](UpdateInfo.md) - -#### Defined in - -[Velopack.d.ts:186](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L186) - -___ - -### downloadUpdates - -▸ **downloadUpdates**(`toDownload`): `void` - -Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, -this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta -packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock -so may fail if there is already another update operation in progress. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toDownload` | [`VelopackAsset`](VelopackAsset.md) | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:193](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L193) - -___ - -### getCheckForUpdatesCommand - -▸ **getCheckForUpdatesCommand**(): `string`[] - -Returns the command line arguments to check for updates. - -#### Returns - -`string`[] - -#### Defined in - -[Velopack.d.ts:158](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L158) - -___ - -### getCurrentVersion - -▸ **getCurrentVersion**(): `string` - -Get the currently installed version of the application. -If the application is not installed, this function will throw an exception. - -#### Returns - -`string` - -#### Defined in - -[Velopack.d.ts:180](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L180) - -___ - -### getCurrentVersionCommand - -▸ **getCurrentVersionCommand**(): `string`[] - -Returns the command line arguments to get the current version of the application. - -#### Returns - -`string`[] - -#### Defined in - -[Velopack.d.ts:154](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L154) - -___ - -### getDownloadUpdatesCommand - -▸ **getDownloadUpdatesCommand**(`toDownload`): `string`[] - -Returns the command line arguments to download the specified update. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toDownload` | [`VelopackAsset`](VelopackAsset.md) | - -#### Returns - -`string`[] - -#### Defined in - -[Velopack.d.ts:162](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L162) - -___ - -### getPackagesDir - -▸ **getPackagesDir**(): `string` - -Returns the path to the app's packages directory. This is where updates are downloaded to. - -#### Returns - -`string` - -#### Defined in - -[Velopack.d.ts:170](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L170) - -___ - -### getUpdateApplyCommand - -▸ **getUpdateApplyCommand**(`toApply`, `silent`, `restart`, `wait`, `restartArgs?`): `string`[] - -Returns the command line arguments to apply the specified update. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | -| `silent` | `boolean` | -| `restart` | `boolean` | -| `wait` | `boolean` | -| `restartArgs?` | readonly `string`[] | - -#### Returns - -`string`[] - -#### Defined in - -[Velopack.d.ts:166](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L166) - -___ - -### isInstalled - -▸ **isInstalled**(): `boolean` - -Returns true if the current app is installed, false otherwise. If the app is not installed, other functions in -UpdateManager may throw exceptions, so you may want to check this before calling other functions. - -#### Returns - -`boolean` - -#### Defined in - -[Velopack.d.ts:175](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L175) - -___ - -### setAllowDowngrade - -▸ **setAllowDowngrade**(`allowDowngrade`): `void` - -Allows UpdateManager to update to a version that's lower than the current version (i.e. downgrading). -This could happen if a release has bugs and was retracted from the release feed, or if you're using -ExplicitChannel to switch channels to another channel where the latest version on that -channel is lower than the current version. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `allowDowngrade` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:141](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L141) - -___ - -### setExplicitChannel - -▸ **setExplicitChannel**(`explicitChannel`): `void` - -This option should usually be left null. Overrides the default channel used to fetch updates. -The default channel will be whatever channel was specified on the command line when building this release. -For example, if the current release was packaged with '--channel beta', then the default channel will be 'beta'. -This allows users to automatically receive updates from the same channel they installed from. This options -allows you to explicitly switch channels, for example if the user wished to switch back to the 'stable' channel -without having to reinstall the application. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `explicitChannel` | `string` | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:150](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L150) - -___ - -### setUrlOrPath - -▸ **setUrlOrPath**(`urlOrPath`): `void` - -Set the URL or local file path to the update server. This is required before calling CheckForUpdates or DownloadUpdates. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `urlOrPath` | `string` | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:134](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L134) - -___ - -### waitExitThenApplyUpdates - -▸ **waitExitThenApplyUpdates**(`toApply`, `silent`, `restart`, `restartArgs?`): `void` - -This will launch the Velopack updater and tell it to wait for this program to exit gracefully. -You should then clean up any state and exit your app. The updater will apply updates and then -optionally restart your app. The updater will only wait for 60 seconds before giving up. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | -| `silent` | `boolean` | -| `restart` | `boolean` | -| `restartArgs?` | readonly `string`[] | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:211](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L211) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackApp.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackApp.md deleted file mode 100644 index 8543d24..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackApp.md +++ /dev/null @@ -1,46 +0,0 @@ -# Class: VelopackApp - -The main VelopackApp struct. This is the main entry point for your app. - -## Constructors - -### constructor - -• **new VelopackApp**(): [`VelopackApp`](VelopackApp.md) - -#### Returns - -[`VelopackApp`](VelopackApp.md) - -## Methods - -### run - -▸ **run**(): `void` - -Runs the Velopack startup logic. This should be the first thing to run in your app. -In some circumstances it may terminate/restart the process to perform tasks. - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:225](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L225) - -___ - -### build - -▸ **build**(): [`VelopackApp`](VelopackApp.md) - -Create a new VelopackApp instance. - -#### Returns - -[`VelopackApp`](VelopackApp.md) - -#### Defined in - -[Velopack.d.ts:220](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L220) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackAsset.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackAsset.md deleted file mode 100644 index 5a46db5..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackAsset.md +++ /dev/null @@ -1,153 +0,0 @@ -# Class: VelopackAsset - -An individual Velopack asset, could refer to an asset on-disk or in a remote package feed. - -## Constructors - -### constructor - -• **new VelopackAsset**(): [`VelopackAsset`](VelopackAsset.md) - -#### Returns - -[`VelopackAsset`](VelopackAsset.md) - -## Properties - -### fileName - -• **fileName**: `string` - -The filename of the update package containing this release. - -#### Defined in - -[Velopack.d.ts:79](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L79) - -___ - -### notesHTML - -• **notesHTML**: `string` - -The release notes in HTML format, transformed from Markdown when packaging the release. - -#### Defined in - -[Velopack.d.ts:95](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L95) - -___ - -### notesMarkdown - -• **notesMarkdown**: `string` - -The release notes in markdown format, as passed to Velopack when packaging the release. - -#### Defined in - -[Velopack.d.ts:91](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L91) - -___ - -### packageId - -• **packageId**: `string` - -The name or Id of the package containing this release. - -#### Defined in - -[Velopack.d.ts:67](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L67) - -___ - -### sha1 - -• **sha1**: `string` - -The SHA1 checksum of the update package containing this release. - -#### Defined in - -[Velopack.d.ts:83](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L83) - -___ - -### size - -• **size**: `bigint` - -The size in bytes of the update package containing this release. - -#### Defined in - -[Velopack.d.ts:87](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L87) - -___ - -### type - -• **type**: [`VelopackAssetType`](../enums/VelopackAssetType.md) - -The type of asset (eg. full or delta). - -#### Defined in - -[Velopack.d.ts:75](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L75) - -___ - -### version - -• **version**: `string` - -The version of this release. - -#### Defined in - -[Velopack.d.ts:71](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L71) - -## Methods - -### fromJson - -▸ **fromJson**(`json`): [`VelopackAsset`](VelopackAsset.md) - -Parses a JSON string into a VelopackAsset object. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `json` | `string` | - -#### Returns - -[`VelopackAsset`](VelopackAsset.md) - -#### Defined in - -[Velopack.d.ts:99](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L99) - -___ - -### fromNode - -▸ **fromNode**(`node`): [`VelopackAsset`](VelopackAsset.md) - -Parses a JSON node into a VelopackAsset object. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `node` | [`JsonNode`](JsonNode.md) | - -#### Returns - -[`VelopackAsset`](VelopackAsset.md) - -#### Defined in - -[Velopack.d.ts:103](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L103) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/enums/JsonNodeType.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/enums/JsonNodeType.md deleted file mode 100644 index 470409c..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/enums/JsonNodeType.md +++ /dev/null @@ -1,61 +0,0 @@ -# Enumeration: JsonNodeType - -## Enumeration Members - -### ARRAY - -• **ARRAY** = ``2`` - -#### Defined in - -[Velopack.d.ts:4](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L4) - -___ - -### BOOL - -• **BOOL** = ``1`` - -#### Defined in - -[Velopack.d.ts:3](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L3) - -___ - -### NULL - -• **NULL** = ``0`` - -#### Defined in - -[Velopack.d.ts:2](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L2) - -___ - -### NUMBER - -• **NUMBER** = ``4`` - -#### Defined in - -[Velopack.d.ts:6](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L6) - -___ - -### OBJECT - -• **OBJECT** = ``3`` - -#### Defined in - -[Velopack.d.ts:5](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L5) - -___ - -### STRING - -• **STRING** = ``5`` - -#### Defined in - -[Velopack.d.ts:7](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L7) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/enums/VelopackAssetType.md b/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/enums/VelopackAssetType.md deleted file mode 100644 index 73a29ca..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/reference/js/enums/VelopackAssetType.md +++ /dev/null @@ -1,31 +0,0 @@ -# Enumeration: VelopackAssetType - -## Enumeration Members - -### DELTA - -• **DELTA** = ``2`` - -#### Defined in - -[Velopack.d.ts:58](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L58) - -___ - -### FULL - -• **FULL** = ``1`` - -#### Defined in - -[Velopack.d.ts:57](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L57) - -___ - -### UNKNOWN - -• **UNKNOWN** = ``0`` - -#### Defined in - -[Velopack.d.ts:56](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L56) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/troubleshooting/cli.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/troubleshooting/cli.mdx deleted file mode 100644 index ed511dc..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/troubleshooting/cli.mdx +++ /dev/null @@ -1,89 +0,0 @@ -# Справочник по интерфейсу командной строки - - -Обзор двоичных параметров командной строки Velopack. - -## впк - -```txt -Описание: - Velopack CLI 0.0.61-g2e7ffeb (предварительная версия) для создания и распространения релизов. - -Использование: - vpk [команда] [опции] - -Опции: - -?, -h, --help Показать справку и информацию об использовании - --version Показать информацию о версии - --verbose Распечатать диагностические сообщения. - -Команды: - package Создает релиз из папки, содержащей файлы приложения. - скачать Загрузите последнюю версию из удаленного источника обновлений. - upload Загрузите локальные пакеты в удаленный источник обновлений. - delta Утилиты для создания или применения дельта-пакетов. -``` - -## Update.exe и UpdateMac - -```txt -Velopack Updater (0.0.66) manages packages and installs updates. -https://github.com/velopack/velopack - -Usage: update [OPTIONS] - update apply [OPTIONS] [-- [EXE_ARGS]...] - update patch [OPTIONS] --old --patch --output - update start [OPTIONS] [EXE_NAME] [-- [EXE_ARGS]...] - update uninstall [OPTIONS] - -Options: - --verbose Print debug messages to console / log - -s, --silent Don't show any prompts / dialogs - -l, --log Override the default log file location - -h, --help Print help - -V, --version Print version - -update apply: -Applies a staged / prepared update, installing prerequisite runtimes if necessary - -r, --restart Restart the application after the update - -w, --wait Wait for the parent process to terminate before applying the update - -p, --package Update package to apply - --noelevate If the application does not have sufficient privileges, do not elevate to admin - -h, --help Print help - [EXE_ARGS]... Arguments to pass to the started executable. Must be preceeded by '--'. - -update patch: -Applies a Zstd patch file - --old Base / old file to apply the patch to - --patch The Zstd patch to apply to the old file - --output The file to create with the patch applied - -h, --help Print help - -update start: -Starts the currently installed version of the application - -w, --wait Wait for the parent process to terminate before starting the application - -h, --help Print help - [EXE_ARGS]... Arguments to pass to the started executable. Must be preceeded by '--'. - [EXE_NAME] The optional name of the binary to execute - -update uninstall: -Remove all app shortcuts, files, and registry entries. - -h, --help Print help -``` - -## Настройка.exe - -```txt -Velopack Setup (0.0.66) устанавливает приложения. -https://github.com/velopack/velopack - -Использование: настройка [ОПЦИИ] - -Параметры: - -s, --silent Скрывает все диалоги и ответы «да» на все запросы - -v, --verbose Выводить отладочные сообщения на консоль - -l, --log Включить ведение журнала файлов и указать местоположение - - t, --installto Каталог установки для установки приложения - -d, --debug Режим отладки, установка из файла nupkg - -h, -- помощь Распечатать справку -``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/troubleshooting/debugging.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/troubleshooting/debugging.mdx deleted file mode 100644 index 17362d7..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/troubleshooting/debugging.mdx +++ /dev/null @@ -1,48 +0,0 @@ -# Отладка и журналирование - - -Найдите или настройте журналы приложений для обнаружения проблем во время выполнения. - -## Ведение журнала - -Во все части Velopack встроено ведение журнала, помогающее устранять неполадки, и вы должны предоставить эти журналы при открытии проблемы GitHub о потенциальной ошибке. - -### UpdateManager / В вашем приложении - -Вам следует предоставить экземпляр Microsoft.Extensions.Logging.ILogger для VelopackApp.Run(ILogger) и UpdateManager для регистрации потенциальных проблем. Если вы еще не используете Microsoft Hosting или Logging, очень просто реализовать этот интерфейс самостоятельно и выполнить вход в файл или интегрировать его с другой платформой журналирования. - -Например: - -```cs -использование Microsoft.Extensions.Logging; - -// ... - -класс ConsoleLogger : ILogger -{ - public IDisposable BeginScope(состояние TState), где TState : notnull => null; - public bool IsEnabled(LogLevel logLevel) => true; - public void Log(LogLevel logLevel, EventId eventId, состояние TState, исключение исключения, Func форматировщик) - => Console.WriteLine(formatter(state,Exception) )); -} - -// ... - -new UpdateManager("https://path.to/your-updates", logger: new ConsoleLogger()); -``` - -### Окна - -При запуске Update.exe большая часть вывода будет записываться в его базовый каталог как Velopack.log. По умолчанию файл Setup.exe не регистрируется в файле. Однако вы можете переопределить местоположение журнала для обоих двоичных файлов с помощью параметра `--log {path}`. Вы также можете использовать флаг `--verbose` для записи вывода отладки/трассировки в журнал. К сожалению, в Windows, чтобы избежать отображения в виде окна консоли, эти двоичные файлы компилируются как WinExe, и по умолчанию вывод на консоль не осуществляется. Полный список поддерживаемых аргументов см. в [справке по командной строке](cli.mdx). - -### МакОС/Линукс - -Все журналы будут отправлены в `/tmp/velopack.log`. - -## Расширенная отладка - -Отладочные сборки двоичных файлов Velopack имеют дополнительные возможности ведения журнала/отладки и производят вывод на консоль. В некоторых случаях может оказаться полезным [скомпилировать Velopack](../contributing/compiling.mdx) для вашей платформы и заменить двоичные файлы выпусков Setup.exe и Update.exe отладочными версиями. - -Если ваша проблема связана со сборкой пакета, после сборки двоичных файлов Rust в режиме отладки также может быть полезно запустить проект Velopack.Vpk из Visual Studio с нужными аргументами командной строки, а не запускать инструмент `vpk` напрямую. - -Если это не помогло, возможно, вам придется отладить и пройти через двоичные файлы Rust, для чего я рекомендую расширение CodeLLDB VSCode. diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/troubleshooting/faq.mdx b/i18n/ru/docusaurus-plugin-content-docs/current/troubleshooting/faq.mdx deleted file mode 100644 index 0098eb9..0000000 --- a/i18n/ru/docusaurus-plugin-content-docs/current/troubleshooting/faq.mdx +++ /dev/null @@ -1,16 +0,0 @@ -# Часто задаваемые вопросы - - -Часто задаваемые вопросы о Велопаке. - -- **Мое приложение было обнаружено как вирус?**
- Velopack не может с этим помочь, но вы можете [code-sign](packaging/signing.mdx) свое приложение и проверить [ другие предложения здесь] \(https://github.com/clowd/Clowd.Squirrel/issues/28#issuecomment-1016241760). -- **Что случилось с SquirrelAwareApp? / Ярлыки**
- Эта концепция больше не существует в Velopack. Вы можете создавать перехватчики при установке/обновлении аналогичным образом, используя компоновщик VelopackApp. Однако обратите внимание, что самостоятельное чтение ярлыков или записей реестра во время перехватов больше не требуется. -- **Может ли Velopack загружать новые среды выполнения во время обновлений?**
- Да, это полностью поддерживается. Перед установкой обновлений Velopack предложит пользователю установить недостающие обновления. -- **Как мне установить инструмент `vpk`? / Я установил инструмент, но он не работает** - На данный момент вам нужно установить среду выполнения `dotnet` 6.0 или 8.0 для вашей платформы, а затем запустить `dotnet Tool update -g vpk`. - Если вы получаете сообщение о том, что оно было успешно установлено, но его запуск на вашем терминале приводит к сообщению «двоичный файл/команда не найдена», возможно, это связано с тем, что ваш PATH настроен неправильно. Для Windows `%USERPROFILE%\.dotnet\tools` должен находиться в PATH. Для MacOS [см. эту проблему] \(https://github.com/dotnet/sdk/issues/9415). В общем, dotnet должен настроить для вас эти пути, но именно это вам следует проверить, если что-то не работает. -- **Могу ли я использовать версию из 4 частей (1.0.0.0) вместо SemVer2?** - Velopack поддерживает только версию из 3 частей с тегами и метаданными (1.0.0-build.23+метаданные) после SemVer2 стандарт. Некоторые люди выбирают версию с датой, например 2024.01.12. Также возможно получить автоматическое управление версиями на основе коммитов git [используя что-то вроде nbgv] \(https://github.com/dotnet/Nerdbank.GitVersioning). Причина, по которой Velopack поддерживает SemVer2, а не традиционные версии из 4 частей, заключается в том, что в версиях SemVer2 можно предоставить гораздо больше информации, и для нас невозможно поддерживать оба формата во всей платформе. diff --git a/i18n/ru/docusaurus-theme-classic/navbar.json b/i18n/ru/docusaurus-theme-classic/navbar.json deleted file mode 100644 index 53937ac..0000000 --- a/i18n/ru/docusaurus-theme-classic/navbar.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "logo.alt": { - "message": "Логотип Велопак", - "description": "The alt text of navbar logo" - }, - "item.label.Guides": { - "message": "Путеводители", - "description": "Navbar item with label Guides" - }, - "item.label.Reference": { - "message": "Ссылка", - "description": "Navbar item with label Reference" - }, - "item.label.Blog": { - "message": "Блог", - "description": "Navbar item with label Blog" - } -} diff --git a/i18n/zh-CN/code.json b/i18n/zh-CN/code.json deleted file mode 100644 index 227b1a4..0000000 --- a/i18n/zh-CN/code.json +++ /dev/null @@ -1,324 +0,0 @@ -{ - "theme.ErrorPageContent.title": { - "message": "页面已崩溃。", - "description": "The title of the fallback page when the page crashed" - }, - "theme.BackToTopButton.buttonAriaLabel": { - "message": "回到顶部", - "description": "The ARIA label for the back to top button" - }, - "theme.blog.archive.title": { - "message": "历史博文", - "description": "The page & hero title of the blog archive page" - }, - "theme.blog.archive.description": { - "message": "历史博文", - "description": "The page & hero description of the blog archive page" - }, - "theme.blog.paginator.navAriaLabel": { - "message": "博文列表分页导航", - "description": "The ARIA label for the blog pagination" - }, - "theme.blog.paginator.newerEntries": { - "message": "较新的博文", - "description": "The label used to navigate to the newer blog posts page (previous page)" - }, - "theme.blog.paginator.olderEntries": { - "message": "较旧的博文", - "description": "The label used to navigate to the older blog posts page (next page)" - }, - "theme.blog.post.paginator.navAriaLabel": { - "message": "博文分页导航", - "description": "The ARIA label for the blog posts pagination" - }, - "theme.blog.post.paginator.newerPost": { - "message": "较新一篇", - "description": "The blog post button label to navigate to the newer/previous post" - }, - "theme.blog.post.paginator.olderPost": { - "message": "较旧一篇", - "description": "The blog post button label to navigate to the older/next post" - }, - "theme.blog.post.plurals": { - "message": "{count} 篇博文", - "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.blog.tagTitle": { - "message": "{nPosts} 含有标签「{tagName}」", - "description": "The title of the page for a blog tag" - }, - "theme.tags.tagsPageLink": { - "message": "查看所有标签", - "description": "The label of the link targeting the tag list page" - }, - "theme.colorToggle.ariaLabel": { - "message": "切换浅色/暗黑模式（当前为{mode}）", - "description": "The ARIA label for the navbar color mode toggle" - }, - "theme.colorToggle.ariaLabel.mode.dark": { - "message": "暗黑模式", - "description": "The name for the dark color mode" - }, - "theme.colorToggle.ariaLabel.mode.light": { - "message": "浅色模式", - "description": "The name for the light color mode" - }, - "theme.docs.breadcrumbs.navAriaLabel": { - "message": "页面路径", - "description": "The ARIA label for the breadcrumbs" - }, - "theme.docs.DocCard.categoryDescription": { - "message": "{count} 个项目", - "description": "The default description for a category card in the generated index about how many items this category includes" - }, - "theme.docs.paginator.navAriaLabel": { - "message": "文件选项卡", - "description": "The ARIA label for the docs pagination" - }, - "theme.docs.paginator.previous": { - "message": "上一页", - "description": "The label used to navigate to the previous doc" - }, - "theme.docs.paginator.next": { - "message": "下一页", - "description": "The label used to navigate to the next doc" - }, - "theme.docs.tagDocListPageTitle.nDocsTagged": { - "message": "{count} 篇文档带有标签", - "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.tagDocListPageTitle": { - "message": "{nDocsTagged}「{tagName}」", - "description": "The title of the page for a docs tag" - }, - "theme.docs.versionBadge.label": { - "message": "版本：{versionLabel}" - }, - "theme.docs.versions.unreleasedVersionLabel": { - "message": "此为 {siteTitle} {versionLabel} 版尚未发行的文档。", - "description": "The label used to tell the user that he's browsing an unreleased doc version" - }, - "theme.docs.versions.unmaintainedVersionLabel": { - "message": "此为 {siteTitle} {versionLabel} 版的文档，现已不再积极维护。", - "description": "The label used to tell the user that he's browsing an unmaintained doc version" - }, - "theme.docs.versions.latestVersionSuggestionLabel": { - "message": "最新的文档请参阅 {latestVersionLink} ({versionLabel})。", - "description": "The label used to tell the user to check the latest version" - }, - "theme.docs.versions.latestVersionLinkLabel": { - "message": "最新版本", - "description": "The label used for the latest version suggestion link label" - }, - "theme.common.editThisPage": { - "message": "编辑此页", - "description": "The link label to edit the current page" - }, - "theme.common.headingLinkTitle": { - "message": "{heading}的直接链接", - "description": "Title for link to heading" - }, - "theme.lastUpdated.atDate": { - "message": "于 {date} ", - "description": "The words used to describe on which date a page has been last updated" - }, - "theme.lastUpdated.byUser": { - "message": "由 {user} ", - "description": "The words used to describe by who the page has been last updated" - }, - "theme.lastUpdated.lastUpdatedAtBy": { - "message": "最后{byUser}{atDate}更新", - "description": "The sentence used to display when a page has been last updated, and by who" - }, - "theme.NotFound.title": { - "message": "找不到页面", - "description": "The title of the 404 page" - }, - "theme.navbar.mobileVersionsDropdown.label": { - "message": "选择版本", - "description": "The label for the navbar versions dropdown on mobile view" - }, - "theme.tags.tagsListLabel": { - "message": "标签：", - "description": "The label alongside a tag list" - }, - "theme.admonition.caution": { - "message": "警告", - "description": "The default label used for the Caution admonition (:::caution)" - }, - "theme.admonition.danger": { - "message": "危险", - "description": "The default label used for the Danger admonition (:::danger)" - }, - "theme.admonition.info": { - "message": "信息", - "description": "The default label used for the Info admonition (:::info)" - }, - "theme.admonition.note": { - "message": "备注", - "description": "The default label used for the Note admonition (:::note)" - }, - "theme.admonition.tip": { - "message": "提示", - "description": "The default label used for the Tip admonition (:::tip)" - }, - "theme.admonition.warning": { - "message": "注意", - "description": "The default label used for the Warning admonition (:::warning)" - }, - "theme.AnnouncementBar.closeButtonAriaLabel": { - "message": "关闭", - "description": "The ARIA label for close button of announcement bar" - }, - "theme.blog.sidebar.navAriaLabel": { - "message": "最近博文导航", - "description": "The ARIA label for recent posts in the blog sidebar" - }, - "theme.CodeBlock.copied": { - "message": "复制成功", - "description": "The copied button label on code blocks" - }, - "theme.CodeBlock.copyButtonAriaLabel": { - "message": "复制代码到剪贴板", - "description": "The ARIA label for copy code blocks button" - }, - "theme.CodeBlock.copy": { - "message": "复制", - "description": "The copy button label on code blocks" - }, - "theme.CodeBlock.wordWrapToggle": { - "message": "切换自动换行", - "description": "The title attribute for toggle word wrapping button of code block lines" - }, - "theme.DocSidebarItem.expandCategoryAriaLabel": { - "message": "展开侧边栏分类 '{label}'", - "description": "The ARIA label to expand the sidebar category" - }, - "theme.DocSidebarItem.collapseCategoryAriaLabel": { - "message": "折叠侧边栏分类 '{label}'", - "description": "The ARIA label to collapse the sidebar category" - }, - "theme.NavBar.navAriaLabel": { - "message": "主导航", - "description": "The ARIA label for the main navigation" - }, - "theme.NotFound.p1": { - "message": "我们找不到您要找的页面。", - "description": "The first paragraph of the 404 page" - }, - "theme.NotFound.p2": { - "message": "请联系原始链接来源网站的所有者，并告知他们链接已损坏。", - "description": "The 2nd paragraph of the 404 page" - }, - "theme.navbar.mobileLanguageDropdown.label": { - "message": "选择语言", - "description": "The label for the mobile language switcher dropdown" - }, - "theme.TOCCollapsible.toggleButtonLabel": { - "message": "本页总览", - "description": "The label used by the button on the collapsible TOC component" - }, - "theme.blog.post.readMore": { - "message": "阅读更多", - "description": "The label used in blog post item excerpts to link to full blog posts" - }, - "theme.blog.post.readMoreLabel": { - "message": "阅读 {title} 的全文", - "description": "The ARIA label for the link to full blog posts from excerpts" - }, - "theme.blog.post.readingTime.plurals": { - "message": "阅读需 {readingTime} 分钟", - "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.docs.breadcrumbs.home": { - "message": "主页面", - "description": "The ARIA label for the home page in the breadcrumbs" - }, - "theme.docs.sidebar.collapseButtonTitle": { - "message": "收起侧边栏", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.collapseButtonAriaLabel": { - "message": "收起侧边栏", - "description": "The title attribute for collapse button of doc sidebar" - }, - "theme.docs.sidebar.navAriaLabel": { - "message": "文档侧边栏", - "description": "The ARIA label for the sidebar navigation" - }, - "theme.docs.sidebar.closeSidebarButtonAriaLabel": { - "message": "关闭导航栏", - "description": "The ARIA label for close button of mobile sidebar" - }, - "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { - "message": "← 回到主菜单", - "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" - }, - "theme.docs.sidebar.toggleSidebarButtonAriaLabel": { - "message": "切换导航栏", - "description": "The ARIA label for hamburger menu button of mobile navigation" - }, - "theme.docs.sidebar.expandButtonTitle": { - "message": "展开侧边栏", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.docs.sidebar.expandButtonAriaLabel": { - "message": "展开侧边栏", - "description": "The ARIA label and title attribute for expand button of doc sidebar" - }, - "theme.SearchBar.noResultsText": { - "message": "没有找到任何文档" - }, - "theme.SearchBar.seeAllOutsideContext": { - "message": "See results outside {context}" - }, - "theme.SearchBar.searchInContext": { - "message": "See all results in {context}" - }, - "theme.SearchBar.seeAll": { - "message": "查看全部结果" - }, - "theme.SearchBar.label": { - "message": "搜索", - "description": "The ARIA label and placeholder for search button" - }, - "theme.SearchPage.existingResultsTitle": { - "message": "“{query}” 的搜索结果", - "description": "The search page title for non-empty query" - }, - "theme.SearchPage.emptyResultsTitle": { - "message": "搜索文档", - "description": "The search page title for empty query" - }, - "theme.SearchPage.searchContext.everywhere": { - "message": "everywhere" - }, - "theme.SearchPage.documentsFound.plurals": { - "message": "共找到 {count} 篇文档", - "description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" - }, - "theme.SearchPage.noResultsText": { - "message": "没有找到任何文档", - "description": "The paragraph for empty search result" - }, - "theme.ErrorPageContent.tryAgain": { - "message": "重试", - "description": "The label of the button to try again rendering when the React error boundary captures an error" - }, - "theme.common.skipToMainContent": { - "message": "跳到主要内容", - "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" - }, - "theme.tags.tagsPageTitle": { - "message": "标签", - "description": "The title of the tag list page" - }, - "theme.unlistedContent.title": { - "message": "未列出页", - "description": "The unlisted content banner title" - }, - "theme.unlistedContent.message": { - "message": "此页面未列出。搜索引擎不会对其索引，只有拥有直接链接的用户才能访问。", - "description": "The unlisted content banner message" - } -} diff --git a/i18n/zh-CN/docusaurus-plugin-content-blog/options.json b/i18n/zh-CN/docusaurus-plugin-content-blog/options.json deleted file mode 100644 index 9239ff7..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-blog/options.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "title": { - "message": "Blog", - "description": "The title for the blog used in SEO" - }, - "description": { - "message": "Blog", - "description": "The description for the blog used in SEO" - }, - "sidebar.title": { - "message": "Recent posts", - "description": "The label for the left sidebar" - } -} diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current.json b/i18n/zh-CN/docusaurus-plugin-content-docs/current.json deleted file mode 100644 index 171e544..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current.json +++ /dev/null @@ -1,130 +0,0 @@ -{ - "version.label": { - "message": "Next", - "description": "The label for version current" - }, - "sidebar.mainSidebar.category.Quick Start": { - "message": "Quick Start", - "description": "The label for category Quick Start in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Sample Apps": { - "message": "Sample Apps", - "description": "The label for category Sample Apps in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Integrating": { - "message": "Integrating", - "description": "The label for category Integrating in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Packaging": { - "message": "Packaging", - "description": "The label for category Packaging in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Operating Systems": { - "message": "Operating Systems", - "description": "The label for category Operating Systems in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Operating Systems.link.generated-index.title": { - "message": "Operating Systems Overview", - "description": "The generated-index page title for category Operating Systems in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Distributing": { - "message": "Distributing", - "description": "The label for category Distributing in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Troubleshooting": { - "message": "Troubleshooting", - "description": "The label for category Troubleshooting in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Contributing": { - "message": "Contributing", - "description": "The label for category Contributing in sidebar mainSidebar" - }, - "sidebar.mainSidebar.category.Migrating": { - "message": "Migrating", - "description": "The label for category Migrating in sidebar mainSidebar" - }, - "sidebar.mainSidebar.link.C# / AvaloniaUI": { - "message": "C# / AvaloniaUI", - "description": "The label for link C# / AvaloniaUI in sidebar mainSidebar, linking to https://github.com/velopack/velopack/tree/master/samples/AvaloniaCrossPlat" - }, - "sidebar.mainSidebar.link.C# / WPF": { - "message": "C# / WPF", - "description": "The label for link C# / WPF in sidebar mainSidebar, linking to https://github.com/velopack/velopack/tree/master/samples/VeloWpfSample" - }, - "sidebar.mainSidebar.link.C++ / Win32": { - "message": "C++ / Win32", - "description": "The label for link C++ / Win32 in sidebar mainSidebar, linking to https://github.com/velopack/velopack.fusion/tree/master/for-cpp/samples/win32" - }, - "sidebar.mainSidebar.link.JS / Electron": { - "message": "JS / Electron", - "description": "The label for link JS / Electron in sidebar mainSidebar, linking to https://github.com/velopack/velopack.fusion/tree/master/for-js/samples/electron-forge" - }, - "sidebar.mainSidebar.link.Rust / Iced": { - "message": "Rust / Iced", - "description": "The label for link Rust / Iced in sidebar mainSidebar, linking to https://github.com/velopack/velopack.fusion/tree/master/for-rust/samples/iced" - }, - "sidebar.mainSidebar.doc.C# .NET": { - "message": "C# .NET", - "description": "The label for the doc item C# .NET in sidebar mainSidebar, linking to the doc getting-started/csharp" - }, - "sidebar.mainSidebar.doc.C++": { - "message": "C++", - "description": "The label for the doc item C++ in sidebar mainSidebar, linking to the doc getting-started/cpp" - }, - "sidebar.mainSidebar.doc.JS / Electron": { - "message": "JS / Electron", - "description": "The label for the doc item JS / Electron in sidebar mainSidebar, linking to the doc getting-started/electron" - }, - "sidebar.mainSidebar.doc.Rust": { - "message": "Rust", - "description": "The label for the doc item Rust in sidebar mainSidebar, linking to the doc getting-started/rust" - }, - "sidebar.mainSidebar.doc.Fusion CLI": { - "message": "Fusion CLI", - "description": "The label for the doc item Fusion CLI in sidebar mainSidebar, linking to the doc getting-started/fusion-cli" - }, - "sidebar.referenceSidebar.category.Library Reference": { - "message": "Library Reference", - "description": "The label for category Library Reference in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.C#": { - "message": "C#", - "description": "The label for category C# in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack": { - "message": "Velopack", - "description": "The label for category Velopack in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.Compression": { - "message": "Velopack.Compression", - "description": "The label for category Velopack.Compression in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.Locators": { - "message": "Velopack.Locators", - "description": "The label for category Velopack.Locators in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.NuGet": { - "message": "Velopack.NuGet", - "description": "The label for category Velopack.NuGet in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.Sources": { - "message": "Velopack.Sources", - "description": "The label for category Velopack.Sources in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.Velopack.Windows": { - "message": "Velopack.Windows", - "description": "The label for category Velopack.Windows in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.category.JS": { - "message": "JS", - "description": "The label for category JS in sidebar referenceSidebar" - }, - "sidebar.referenceSidebar.link.Rust": { - "message": "Rust", - "description": "The label for link Rust in sidebar referenceSidebar, linking to https://docs.rs/velopack" - }, - "sidebar.referenceSidebar.doc.C++": { - "message": "C++", - "description": "The label for the doc item C++ in sidebar referenceSidebar, linking to the doc reference/cpp/api" - } -} diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/contributing/compiling.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/contributing/compiling.mdx deleted file mode 100644 index b66a6eb..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/contributing/compiling.mdx +++ /dev/null @@ -1,71 +0,0 @@ -# Build Velopack SDK - - -The Velopack SDK is responsible for compiling releases and installers. - -It is made up of: - -- Rust binaries which are re-distributed with installed apps, -- .NET NuGet package (`Velopack`), -- .NET command line tool (`vpk`). - -In order to test the project, you need to build the Rust binaries before compiling dotnet. - -### Prerequisites - -- [.NET 6 SDK](https://dotnet.microsoft.com/download/dotnet/6.0) -- [.NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0) -- [Rust / Cargo](https://www.rust-lang.org/tools/install) -- `dotnet tool install -g dotnet-coverage` -- `dotnet tool install -g nbgv` - -### Debug / Test - -On windows, you need to build the Rust binaries using the `windows` feature before running tests. On OSX, you should run `cargo build` instead. - -```shell -git clone https://github.com/velopack/velopack.git -cd velopack/src/Rust -cargo build --features windows -cd ../../ -dotnet build -dotnet test --no-build -``` - -### Release / Build - -This is slightly complicated, because you will need to compile Rust on x64 OSX and x64 Windows before creating the final packages. - -On OSX: - -```shell -git clone https://github.com/velopack/velopack.git -cd velopack/src/Rust -cargo build --release -``` - -On Windows: - -```shell -git clone https://github.com/velopack/velopack.git -cd velopack/src/Rust -cargo build --release --features windows -copy {path_to_osx_update} target/release/updatemac -dotnet build -c Release /p:PackRustAssets=true -``` - -### Compiling on Linux - -If you are on Linux (tested on Ubuntu), there are additional package pre-requisites: - -```sh -sudo apt install libssl-dev pkg-config -``` - -You need to verify that `nbgv` is working on the command line, you may be missing a `DOTNET_ROOT` variable in your bash profile, which might need to point at `/usr/share/dotnet` or `$HOME/.dotnet`. - -If you are missing localisation packages, you can search for them or add the following to your bash profile: - -```bash -export DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/distributing/deploy-cli.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/distributing/deploy-cli.mdx deleted file mode 100644 index fcfd41c..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/distributing/deploy-cli.mdx +++ /dev/null @@ -1,43 +0,0 @@ -# Deployment CLI - - -The general process for deploying a Velopack release (`download -> pack -> upload`) can be greatly simplified by using the `download` and `upload` commands which are built into the `vpk` command line tool. - -## Packing your new release with delta's - -In order for delta's to be generated during the `pack` command, you need to first download the current latest release. This should be done with the download command: - -```cmd -vpk download http --url https://the.place/you-host/updates -vpk pack -u YourAppId -v 1.0.1 -p {buildOutput} -``` - -There are providers for various sources, such GitHub, S3, HTTP, etc. - -## Deploying releases - -In the previous example, we used the `http` source, while that is very generic it does not provide any information about how to upload the releases, so in the following deployment example we will use [AWS S3](https://aws.amazon.com/s3/). - -:::tip -Most cloud storage providers today have an S3-compatible API ([GCP](https://cloud.google.com/storage/docs/interoperability), [BackBlaze B2](https://www.backblaze.com/docs/cloud-storage-s3-compatible-api), [DigitalOcean](https://docs.digitalocean.com/products/spaces/how-to/use-aws-sdks/), [Linode](https://www.linode.com/docs/products/storage/object-storage/), [IBM Cloud](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-compatibility-api), and so forth) and can be used with this command - it is not limited to AWS. -::: - -Using AWS, you can [authenticate using the `aws` command line tool](https://docs.aws.amazon.com/sdk-for-net/v3/developer-guide/creds-idc.html) or you can provide access keys as below. - -If you are using AWS SSO, you should check the [AWS CLI SSO](https://aws.amazon.com/blogs/security/aws-single-sign-on-now-enables-command-line-interface-access-for-aws-accounts-using-corporate-credentials/) doc and [AWS session authentication](https://docs.aws.amazon.com/STS/latest/APIReference/API_GetSessionToken.html). - -```cmd -vpk download s3 --bucket MyApp --region us-west-1 --keyId {accessKeyId} --secret {accessKeySecret} -vpk pack -u YourAppId -v 1.0.1 -p {buildOutput} -vpk upload s3 --bucket MyApp --region us-west-1 --keyId {accessKeyId} --secret {accessKeySecret} -``` - -Note that you can specify most of these argumentsas environment variables too. You can review the [AWS SDK environment variables here](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html) and every `vpk` option can be provided as an environment variable too, to list these in the help text use `vpk -H` instead of `vpk -h`. - -When using a non-AWS S3-compatible API (eg. BackBlaze B2), you need to specify an endpoint instead of a region: - -```cmd -vpk download s3 --bucket MyApp --endpoint https://s3.eu-central-003.backblazeb2.com --keyId {accessKeyId} --secret {accessKeySecret} -vpk pack -u YourAppId -v 1.0.1 -p {buildOutput} -vpk upload s3 --bucket MyApp --endpoint https://s3.eu-central-003.backblazeb2.com --keyId {accessKeyId} --secret {accessKeySecret} -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/distributing/github-actions.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/distributing/github-actions.mdx deleted file mode 100644 index 16b0269..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/distributing/github-actions.mdx +++ /dev/null @@ -1,109 +0,0 @@ -# GitHub Actions - - - -This section assumes you have a basic knowledge of GitHub Actions. You can learn more about -creating workflows [here](https://docs.github.com/en/actions/deployment/about-deployments/deploying-with-github-actions). - -### Creating the Workflow - -The following example assumes you are building for Windows, but you can adapt the workflow for other platforms as well. - -First create a workflow in your repository at `.github/workflows` with the `.yml` extension, for example -`.github/workflows/main.yml`. This example workflow will run when code is pushed to the `main` branch. Refer to -documentation linked above if you would prefer a different trigger. - -```yml -name: Deploy to GitHub Releases - -on: - push: - branches: - - main -``` - -Create the job that will run when the trigger is activated. This example will run on a `windows-latest` machine as we're -packaging for Windows. - -```yml -jobs: - deploy-to-github-releases: - runs-on: windows-latest - steps: -``` - -### Compiling the Application - -First, add a step to checkout your repository to get all the files needed to compile your application. - -```yml - - name: Checkout Repository - uses: actions/checkout@v4 -``` - -You will need the version number of your release for packing with Velopack. There are many ways to handle this. -If you are using GitHub Action variables to handle this, you can skip this step. This example will extract the -version number from the `` tag in the `.csproj` of the application. The `bash` shell is defined here -as this command will fail when running on Windows otherwise. The command works by using a regular expression -with `grep` to extract the value between `` and `` in the csproj file, and store it in a -variable called `version` in the current run of the workflow. - -```yml - - name: Get Version from Project File - id: get-version - shell: bash - run: echo "version=$(grep -oE '[^<]+' MyApplication/MyApplication.csproj | sed 's///')" >> $GITHUB_OUTPUT -``` - -Next, add a step to install .NET so the application can be compiled. Set the `dotnet-version` to the version needed by -your application. - -```yml - - name: Install .NET - uses: actions/setup-dotnet@v4 - with: - dotnet-version: 8.0.x -``` - -Compile your application. This example will do so by publishing the application to a folder in a self-contained manner. -You can publish without the self-contained flag if using Velopack to install such dependencies -(see [Bootstrapping](../packaging/bootstrapping.mdx) for details). This command uses the `-c` flag to set the build -configuration to `Release` mode, `-o` to set the output directory to `publish`, `-r` to set the runtime -to `win-x64` for distributing on 64-bit Windows, and `--self-contained` to publish the .NET runtime with the -application. Adapt this command to your needs. You can learn more about -`dotnet publish` in the [Microsoft Documentation](https://learn.microsoft.com/dotnet/core/tools/dotnet-publish). - -```yml - - name: Publish Application - run: dotnet publish MyProject/MyProject.csproj -c Release -o publish -r win-x64 --self-contained true -``` - -### Deploying the Release - -Finally, use Velopack to package your application and deploy your release. Create a step that runs several commands -on the commandline. - -Let's break down what each line does. - -1. Installs the Velopack CLI. -2. Downloads the latest release of your repository. This is needed so that Velopack can create the delta package - between the current release and the new one, as well as populating the releases files. -3. Invokes the Velopack CLI to package your application. The `-v` argument calls upon - the `version` variable assigned earlier, which is accessed using the `id` of the step that assigned it (`get-version`). - `-p` is pointed at the `publish` directory that was used in the previous step. For more information on the Velopack CLI - and which flags are available for the `pack` command, [see here](../packaging/overview.mdx). -4. Creates a new release in your repository and uploads the necessary files to it automatically. - -:::tip -If your repository is private, you will need to provide Velopack with an OAuth token when using the `vpk download` -and `vpk upload` commands. Simply append the following to both commands: `--token ${{ secrets.GITHUB_TOKEN }}`. -::: - -```yml - - name: Create Velopack Release - run: | - dotnet tool install -g vpk - vpk download github --repoUrl https://github.com/Myname/Myrepo - vpk pack -u MyUniqueIdentifier -v ${{ steps.get-version.outputs.version }} -p publish - vpk upload github --repoUrl https://github.com/Myname/Myrepo --publish --releaseName "MyProject ${{ steps.get-version.outputs.version }}" --tag v${{ steps.get-version.outputs.version }} -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/distributing/overview.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/distributing/overview.mdx deleted file mode 100644 index 2f2d684..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/distributing/overview.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -sidebar_label: Overview -sidebar_position: 0 ---- - -# Distributing Overview - - -Distributing with Velopack is extremely easy, it's usually just as simple as uploading your files somewhere that can be downloaded with HTTP. This means you could host them on an IIS or nodejs site, on shared file hosting such as AWS S3, Azure Storage, BackBlaze B2, or even for free on GitHub/GitLab releases if your project is open source. - -The general steps for creating and deploying a Velopack release are: - -1. Download the latest published release (eg. 1.0.0). -2. Run `vpk pack` to create your new release (eg. 1.0.1). -3. Upload your newly created 1.0.1 assets. -4. Update the remote `releases.{channel}.json` to reflect the newly uploaded assets. - -See also: [Deployment commands](deploy-cli.mdx) can make this process much easier. - -## List of assets produced - -After packing a release with Velopack, you should have something like the following in your output directory: - -``` -Releases -├── YourAppId-1.0.1-full.nupkg -├── YourAppId-1.0.1-delta.nupkg -├── YourAppId-Setup.exe -├── YourAppId-Portable.zip -├── releases.{channel}.json -├── assets.{channel}.json -└── RELEASES -``` - -### Full and delta nupkg's - -These are the update packages that installed applications use to find/install the latest version. Full packages contain an entire replication of your input files, plus some files Velopack adds. A delta package is a diff from the previously created full package. You need to have the previous version (eg. 1.0.0 in the above example) downloaded and in the output directory for a delta to be created (in this case, `1.0.0->1.0.0`). There are helpful [deployment commands](deploy-cli.mdx) which can download the latest version for you, so that deltas will be generated automatically. - -You must distribute these packages in the same folder as the `releases.{channel}.json` file for updates to work. - -### Setup and portable - -This is what your user should download and run to install your app. On MacOS, you'll get a `.pkg` instead of a `-Setup.exe`. On Linux, there is no setup produced - only a portable `.AppImage`. The reason for this is that `.AppImage`'s are completely portable to any relatively recent distro of linux. - -### Release feed (`releases.{channel}.json`) - -This file should be distributed in the same folder as the `nupkg` files are deployed. It contains a list of all available releases. - -When you provide a HTTP url to `UpdateManager`, it will search for this file. For example, if you `new UpdateManager("https://the.place/you-host/updates")`, then UpdateManager will request for `https://the.place/you-host/updates/releases.{channel}.json`. The channel UpdateManager uses in the request is automatic, you can [read more here about channels](../packaging/channels.mdx). - -For example, if you packed `1.0.0` and then `1.0.1` immediately after, the contents of this file might look like: - -```json title="releases.win.json" -{ - "Assets": [ - { - "PackageId": "YourAppId", - "Version": "1.0.1", - "Type": "Full", - "FileName": "YourAppId-1.0.1-full.nupkg", - "SHA1": "537EC0F4E1C4263A230353FAB4150216E5AF3724", - "Size": 1588612 - }, - { - "PackageId": "YourAppId", - "Version": "1.0.1", - "Type": "Delta", - "FileName": "YourAppId-1.0.1-delta.nupkg", - "SHA1": "9615D266DDBCADF3B9CD82BABF9DA571A0EE2B83", - "Size": 3606 - }, - { - "PackageId": "YourAppId", - "Version": "1.0.0", - "Type": "Full", - "FileName": "YourAppId-1.0.0-full.nupkg", - "SHA1": "69122BABCEEEF9F653BFE59D87DDAEF363F9476F", - "Size": 1588613 - } - ] -} -``` - -The releases file should always mirror what files are _actually available_ in the remote folder that contains the releases file. So if you delete a nupkg release from the remote server, you should delete it from your remote release file too. If you are deploying newly created local files to a remote server which already contains some releases, then you should copy the assets from your local file to the remote releases file. - -:::warning -This file is the only way that UpdateManager can discover releases, if you do not update it properly it may result in your users not getting updates. -::: - -It is tedious to update this file manually, so Velopack CLI provides deployment commands which can deploy assets and update this file automatically for you, as well as apply rentention policies around the number of releases to keep. [\[Read more\]](deploy-cli.mdx) - -### Legacy release feed (`RELEASES`) - -This releases format was used by Clowd.Squirrel and Squirrel.Windows, and is still produced by Velopack to allow you to migrate an application using one of those frameworks to Velopack. If you do not have any legacy users which need to migrate to Velopack, you can safely ignore this file. - -### Assets file - -This file contains a list of assets produced by the latest `pack` command. It is used by the [Velopack deployment commands](deploy-cli.mdx) to know which files should be uploaded. It can be ignored / deleted if you do not intend to use these commands to deploy releases and automatically update your release feed. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/cpp.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/cpp.mdx deleted file mode 100644 index d236db3..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/cpp.mdx +++ /dev/null @@ -1,85 +0,0 @@ -# Getting Started: C++ - - -Get started with our cross-platform C++ header library. - -1. Copy [Velopack.hpp](https://github.com/velopack/velopack.fusion/blob/master/for-cpp/Velopack.hpp) and [Velopack.cpp](https://github.com/velopack/velopack.fusion/blob/master/for-cpp/Velopack.cpp) into your project. - -2. Configure Unicode Support: - #### Windows - On Windows, to enable unicode support for this library you **_must_** - [configure the UTF-8 code page](https://learn.microsoft.com/en-us/windows/apps/design/globalizing/use-utf8-code-page) via your application - manifest. Failure to do so will potentially result in your application **_failing to update_** if there are any unicode characters in your user's - file paths, username, etc. - ```xml - - - - - UTF-8 - - - - ``` - #### Linux & MacOS - - If you are using Qt and `QString` is available, there's nothing further you need to do. - - If you are not using Qt, you'll need to [install ICU4C](https://icu.unicode.org/). Like many other C libraries, - installing the development package with your package manager (`apt`, `brew` etc) _should_ be sufficient to make it available to compilers. - -3. Add the `Velopack::startup()` to your entry point (eg. `main()` or `wmain()`) as early as possible, ideally the first statement to run: - - ```cpp - #include "Velopack.hpp" - - wmain(int argc**, wchar_t *argv[ ], wchar_t *envp[ ]) - { - // Velopack may exit / restart your app at this statement - Velopack::startup(argv, argc); - - // ... your other startup code here - } - ``` - -4. Add auto-updates somewhere to your app: - - ```cpp - #include "Velopack.hpp" - #include - - static void update_app() - { - Velopack::UpdateManagerSync manager{}; - manager.setUrlOrPath("https://the.place/you-host/updates"); - - auto updInfo = manager.checkForUpdates(); - if (updInfo == nullptr) { - return; // no updates available - } - - manager.downloadUpdates(updInfo->targetFullRelease.get()); - manager.applyUpdatesAndRestart(updInfo->targetFullRelease.get()); - } - ``` - -5. Install the `vpk` command line tool: - ```sh - dotnet tool update -g vpk - ``` - :::tip - **_You must have the .NET Core SDK 6 installed to use and update `vpk`_** - ::: - -6. Compile your app to a program using your usual compiler (eg. msvc, cmake, gcc, etc) - -7. Copy `Vfusion.exe`, `VfusionMac` or `VfusionNix` to your build output folder. This is a manual step for now, but may be automated in the future. You can compile this yourself, download a [recent build artifact](https://github.com/velopack/velopack.fusion/actions), or grab the latest [npm release](https://www.npmjs.com/package/velopack?activeTab=code) which also bundles the binaries. - :::warning - Until this is automated, failing to copy the fusion binary to your update directory will result in your app being unable to update. - ::: - -8. Package your Velopack release / installers: - ```sh - vpk pack -u MyAppUniqueId -v 1.0.0 -p /myBuildDir -e myexename.exe - ``` - -✅ You're Done! Your app now has auto-updates and an installer. -You can upload your release to your website, or use the `vpk upload` command to publish it to the destination of your choice. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/csharp.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/csharp.mdx deleted file mode 100644 index ce13114..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/csharp.mdx +++ /dev/null @@ -1,48 +0,0 @@ -# Getting Started: .NET - - -Get started with .NET 5+ (cross-platform) or .Net Framework. - -1. Install the [Velopack NuGet Package](https://www.nuget.org/packages/velopack) in your main project: - ```cmd - dotnet add package Velopack - ``` -2. Configure your Velopack app at the beginning of `Program.Main`: - ```cs - static void Main(string[] args) - { - VelopackApp.Build().Run(); - // ... your other startup code below - } - ``` -3. Add automatic updating to your app: - - ```cs - private static async Task UpdateMyApp() - { - var mgr = new UpdateManager("https://the.place/you-host/updates"); - - // check for new version - var newVersion = await mgr.CheckForUpdatesAsync(); - if (newVersion == null) - return; // no update available - - // download new version - await mgr.DownloadUpdatesAsync(newVersion); - - // install new version and restart app - mgr.ApplyUpdatesAndRestart(newVersion); - } - ``` -4. Install the command line tool `vpk`: - ```cmd - dotnet tool update -g vpk - ``` -5. Publish dotnet and build your first Velopack release! 🎉 - ```batch - dotnet publish -c Release --self-contained -r win-x64 -o .\publish - vpk pack -u YourAppId -v 1.0.0 -p .\publish -e yourMainApp.exe - ``` - -✅ You're Done! Your app now has auto-updates and an installer. -You can upload your release to your website, or use the `vpk upload` command to publish it to the destination of your choice. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/electron.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/electron.mdx deleted file mode 100644 index 9e4513b..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/electron.mdx +++ /dev/null @@ -1,79 +0,0 @@ -# Getting Started: JS / Electron - - -Get started with our NPM package for JS & Electron. - -If you are using pure nodejs and bundling your app using [pkg](https://github.com/vercel/pkg) or similar you can ignore Electron-specific steps. - -1. Add Velopack to your `package.json`: - ```txt - npm install velopack - ``` - -2. Add the following code to your entry point (eg. `index.js`) as early as possible (before any electron startup code etc.): - - ```js - const { VelopackApp } = require('velopack'); - - // Velopack builder needs to be the first thing to run in the main process. - // In some cases, it might quit/restart the process to perform tasks. - VelopackApp.build().run(); - - // ... your other app startup code here - ``` - -3. Add auto-updates somewhere to your app: - - ```js - const { UpdateManager } = require('velopack'); - - async function updateApp() - { - const um = new UpdateManager(); - um.setUrlOrPath("https://the.place/you-host/updates"); - - const updateInfo = await um.checkForUpdatesAsync(); - if (!updateInfo) { - return; // no update available - } - - await um.downloadUpdatesAsync(updateInfo.targetFullRelease, p => { - console.log(`progress: ${p}%`); - }); - - um.applyUpdatesAndRestart(updateInfo.targetFullRelease); - } - ``` - -4. If you are using electron/forge, you will need to add an asar unpack rule: - ```js - module.exports = { - packagerConfig: { - asar: { - // velopack contains native binaries which must remain unpacked - unpack: '**/node_modules/velopack/**', - }, - }, - } - ``` - -5. Compile your app to a binary (eg. `.exe` on Windows). Example using electron forge: - ```sh - npx electron-forge package - ``` - -6. Install the `vpk` command line tool: - ```sh - dotnet tool update -g vpk - ``` - :::tip - **_You must have the .NET Core SDK 6 installed to use and update `vpk`_** - ::: - -7. Package your Velopack release / installers: - ```sh - vpk pack -u MyAppUniqueId -v 1.0.0 -p /myBuildDir -e myexename.exe - ``` - -✅ You're Done! Your app now has auto-updates and an installer. -You can upload your release to your website, or use the `vpk upload` command to publish it to the destination of your choice. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/fusion-cli.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/fusion-cli.mdx deleted file mode 100644 index a5c1879..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/fusion-cli.mdx +++ /dev/null @@ -1,128 +0,0 @@ -# Fusion CLI - - -Integrate directly using the command line interface. - -If there isn't a native library, or command line bindings for your language yet, you can directly integrate Velopack using the command line. - -**_There are two binaries needed._** - -## Fusion - -`Vfusion.exe` / `VfusionMac` / `VFusionNix`
-Provides support for getting current version, checking for updates, downloading updates etc. - -:::warning -At this time, the fusion binary is not automatically distributed, and you need to copy this into your compiler output directory. -You can download a [recent build artifact](https://github.com/velopack/velopack.fusion/actions) and make sure it's copied to your output dir during builds. -::: - -### Example - -``` -> Vfusion.exe check --url https://the.place/you-host/updates -``` - -These are the possible outputs: - -- **No updates are available:** empty stdout and `exitCode == 0`. -- **Unrecoverable error:** empty stdout and `exitCode != 0`. A [log file](#logging) will be created. -- **Update is availble:** stdout contains json object and `exitCode == 0`. - -When an update is available, you'll receive an [UpdateInfo](../reference/cs/Velopack/UpdateInfo.md) object via stdout: - -```json -{ - "isDowngrade": false, - "targetFullRelease": { - "packageId": "YourPackageId", - "version": "2.0.1", - "type": "Full", - "fileName": "YourPackageId-2.0.1-full.nupkg", - "sha1": "331a4f44a6a875b2ce139ae0c9ce5bb5e1ec0d97", - "size": 90654, - "notesMarkdown": "# Release v2.0.1 \n Your message here", - "notesHtml": "

Release v2.0.1


Your message here" - } -} -``` - -The next step is to download an update to disk, using the `fileName` property from the previous command: - -``` -> Vfusion.exe download \ - --url https://the.place/you-host/updates \ - --name YourPackageId-2.0.1-full.nupkg -``` - -During this command, fusion will output the current download progress to stdout. For example: - -``` -10 -20 -30 -40 -... -``` - -You can parse each line of stdout (split by `\n`) and show progress to your users. - -If `exitCode == 0` the command was successful. - -To get the final path to the downloaded asset, you can combine the result of `Vfusion.exe get-packages` and `fileName`. - -To install the update, please see the next section. - -:::tip -There are other commands (eg. `get-version`) which may be useful, explore them with `Vfusion.exe -h` -::: - -## Updater - -`Update.exe` / `UpdateMac` / `UpdateNix`
-Provides support for installing downloaded updates, prompting for elevation (if required), bootstrapping [dependencies](../packaging/bootstrapping.mdx), and so forth. - -:::info -This binary is automatically copied into your package when building `vpk`, you just need to locate it relative to your main executable. -::: - -You will use the `update apply` command to install a downloaded update. - -### Example - -``` -> Update.exe apply --restart -``` - -Running the above command will immediately close your program, install the update, and restart your app on the new version. - -:::tip -If called with no arguments, Update will apply the newest downloaded release, as long as it's newer than the currently installed release. -If you would like to install an older release, you need to specify the `--package` parameter. -::: - -All of the available apply options are below: - -``` -update apply: -Applies a staged / prepared update, installing prerequisite runtimes if necessary - -r, --restart Restart the application after the update - -w, --wait Wait for the parent process to terminate before applying the update - --waitPid Wait for the specified process to terminate before applying the update - -p, --package Update package to apply - -h, --help Print help - [EXE_ARGS]... Arguments to pass to the restarted executable. Must be preceeded by '--'. -``` - -## Logging - -Since errors are not printed on stdout, it is important to know where to locate log files to diagnose errors. - -### Windows - -Updater will log to it's own directory, and Fusion will log to the folder one above itself. -In a typical installation, this will result in both the Fusion logs and Updater log being merged into one log file. - -### Linux and MacOS - -On UNIX-like operating systems, the logs for these binaries always go to `/tmp/velopack.log`. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/rust.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/rust.mdx deleted file mode 100644 index 1f1780e..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/getting-started/rust.mdx +++ /dev/null @@ -1,72 +0,0 @@ -# Getting Started: Rust - - -Get started with our official cross-platform Rust Crate. - -1. Add Velopack to your `Cargo.toml`: - ```toml - [dependencies] - velopack = { version = "0.0", features = ["async"] } - # Replace above with actual version and desired features - ``` - -2. Add the following code to your `main()` function: - ```rust - use velopack::*; - fn main() { - // VelopackApp should be the first thing to run. - // In some circumstances it may terminate/restart - // the process during update/install. - VelopackApp::build().run(); - - // ... your other app startup code here - } - ``` - -3. Add auto-updates somewhere to your app: - - ```rust - use velopack::*; - use anyhow::Result; - - fn update_my_app() -> Result<()> { - let um = UpdateManager::new("https://the.place/you-host/updates", None)?; - - // check for updates - let updates: Option = um.check_for_updates()?; - if updates.is_none() { - return Ok(()); // no updates available - } - - // download updates - let updates = updates.unwrap(); - um.download_updates(&updates, |progress| { - println!("Download progress: {}%", progress); - })?; - - // apply updates - um.apply_updates_and_restart(&updates, RestartArgs::None)?; - Ok(()) - } - ``` - -4. Build your app with cargo: - ```sh - cargo build --release - ``` - -5. Install the `vpk` command line tool: - ```sh - dotnet tool update -g vpk - ``` - :::tip - **_You must have the .NET Core SDK 6 installed to use and update `vpk`_** - ::: - -6. Package your Velopack release / installers: - ```sh - vpk pack -u MyAppUniqueId -v 1.0.0 -p /target/release -e myexename.exe - ``` - -✅ You're Done! Your app now has auto-updates and an installer. -You can upload your release to your website, or use the `vpk upload` command to publish it to the destination of your choice. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/index.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/index.mdx deleted file mode 100644 index 81b7e42..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/index.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -disable_comments: true ---- - -# Introduction - -Velopack is an installation and auto-update framework for cross-platform desktop applications. It's opinionated, extremely easy to use with zero config needed. With just one command you can be up and running with an installable application, and it's lightning fast for your users, too. - -Be sure to check us out on [GitHub](https://github.com/velopack/velopack) and [join our Discord](https://discord.gg/CjrCrNzd3F) for any questions/support! - -## Overview - -To enable your application to make full use of Velopack, you need to do 3 things: - - -### Integrate the SDK & check for updates -We have client libraries for some [languages below](#language-support), or if we don't support your language yet you can use [our CLI](./getting-started/fusion-cli.mdx).
-[Read more →](integrating/overview.mdx) - - - -### Build a Velopack release -Our command-line tool `vpk` can help you build update packages and installers in just one command.
-[Read more →](packaging/overview.mdx) - - - -### Upload your releases somewhere -You can host updates anywhere static files can be served, eg. cloud file storage, GitHub Releases, and more.
-[Read more →](distributing/overview.mdx) - - -## Language Support - -There are libraries planned or supported for the languages below. - -| Lang | Status | Runtime Deps | Async | Links | | -| :----: | ------- | -------------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | -| C# | ✅ Ready | ✅ None | ✅ Yes | [quick start](./getting-started/csharp.mdx), [docs](./reference/cs/Velopack/), [samples](https://github.com/velopack/velopack/tree/master/samples), [nuget.org](https://nuget.org/packages/velopack) | | -| JS | ✅ Ready | ✅ None | ✅ Yes | [quick start](./getting-started/electron.mdx), [docs](./reference/js/classes/UpdateManager.md), [samples](https://github.com/velopack/velopack.fusion/tree/master/for-js/samples), [npmjs.com](https://www.npmjs.com/package/velopack) | | -| Rust | ✅ Ready | ✅ None | ✅ Yes | [quick start](./getting-started/rust.mdx), [docs](https://docs.rs/velopack), [samples](https://github.com/velopack/velopack.fusion/tree/master/for-rust/samples), [crates.io](https://crates.io/crates/velopack) | | -| C++ | ✅ Ready | 🔶 vfusion.exe | ❌ No | [quick start](./getting-started/cpp.mdx), [docs](./reference/cpp/api.md), [samples](https://github.com/velopack/velopack.fusion/tree/master/for-cpp/samples), [velopack.hpp](https://github.com/velopack/velopack.fusion/tree/master/for-cpp) | | -| Java | Planned | - | - | - | - | -| Python | Planned | - | - | - | - | -| Swift | Planned | - | - | - | - | -| Go | Planned | - | - | - | - | - -:::info -If your language is not listed, you can [**open an issue to request it**](https://github.com/velopack/velopack.fusion/issues), -or if your language supports running a process you can [**integrate directly with the Fusion CLI**](./getting-started/fusion-cli.mdx). -::: - - diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/hooks.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/hooks.mdx deleted file mode 100644 index f300775..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/hooks.mdx +++ /dev/null @@ -1,31 +0,0 @@ -# App Hooks - - - -Hooks allow your application to run logic at various stages of the install/update/uninstall process. - -In general, I don't recommend trying to handle hooks manually - and instead refer to the available [VelopackApp](../reference/cs/Velopack/VelopackApp.md) options. - -If you wish to handle these yourself, an SDK doesn't exist for your language, or you just want to learn more about it, read on. - -## Command line hooks - -At various stages of the install/update/uninstall process, Velopack will execute your main executable (the one specified when packaging with `--mainExe {exeName}`) with certain cli arguments and expect your app to exit as quickly as possible. - -- `--veloapp-install {version}` Occurs after the program has been extracted, but before the install has finished. App must handle and exit within 30 seconds. -- `--veloapp-obsolete {version}` Runs on the old version of the app, before an update is applied. App must handle and exit within 15 seconds. -- `--veloapp-updated {version}` Runs on the new version of the app, after an update is applied. App must handle and exit within 15 seconds. -- `--veloapp-uninstall {version}` Runs before an uninstall takes place. App must handle and exit within 30 seconds. - -At this time, there is no way to provide feedback during the hooks that you would like to cancel the install/uninstall/update etc, and you may not show any UI to the user. - -:::warning -If your application receives one of these arguments and does not exit within the alloted time, it will be killed. -::: - -## Environment variable hooks - -There are also two environment variables that get set, if these are detected your app does not need to exit. - -- `VELOPACK_FIRSTRUN` is true if this is the first run after the app was installed. -- `VELOPACK_RESTART` is true if the application was restarted by Velopack (usually because an update was applied.) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/overview.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/overview.mdx deleted file mode 100644 index 1b56f44..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/overview.mdx +++ /dev/null @@ -1,132 +0,0 @@ ---- -sidebar_label: Overview -sidebar_position: 0 ---- - -# Integrating Overview - - - -To integrate Velopack into your application, you _must_ initialise the Velopack as early as possible in app startup, and you _should_ add update checking code somewhere. - -For .NET applications, you should first install the [Velopack Nuget Package](https://nuget.org/packages/velopack). - -## Application Startup - -Velopack requires you add some code to your application startup to handle hooks. This is because Velopack will run your main binary at certain stages of the install/update process with special arguments, to allow you to customise behavior. It expects your app to respond to these arguments in the right way and then exit as soon as possible. - -The simplest/minimal way to handle this properly is to add the SDK startup code to your `Main()` method. This should be in the "main" binary (the one specified when packaging with `--mainExe {exeName}`). - -```cs -static void Main(string[] args) -{ - VelopackApp.Build().Run(); - // ... your other startup code below -} -``` - -There are a variety of options / callbacks you can specify here to customise Velopack, for example: - -```cs -static void Main(string[] args) -{ - ILogger log = CreateLogger(); - VelopackApp.Build() - .WithBeforeUninstallFastCallback((v) => { - // delete / clean up some files before uninstallation - }) - .WithFirstRun((v) => { - MessageBox.Show("Thanks for installing my application!"); - }) - .Run(log); -} -``` - -The full list of options [for VelopackApp is available here](../reference/cs//Velopack/VelopackApp.md). You can also read more about [how hooks work](./hooks.mdx). - -:::warning -A "FastCallback" requires that your application show no UI and exit quickly. When the callback returns, your application will exit. If you do not exit this callback quickly enough your process will be killed. -::: - -## Configuring Updates - -Updates can be accomplished by adding [UpdateManager](../reference/cs/Velopack/UpdateManager.md) to your app: - -```cs -private static async Task UpdateMyApp() -{ - var mgr = new UpdateManager("https://the.place/you-host/updates"); - - // check for new version - var newVersion = await mgr.CheckForUpdatesAsync(); - if (newVersion == null) - return; // no update available - - // download new version - await mgr.DownloadUpdatesAsync(newVersion); - - // install new version and restart app - mgr.ApplyUpdatesAndRestart(newVersion); -} -``` - -:::tip -Updates can be done silently in the background, or integrated into your application UI. It's always up to you. -::: - -You can host your update packages basically anywhere, here are a few examples: - -- Local directory:
`new UpdateManager("C:\Updates")` -- HTTP server, or S3, Azure Storage, etc:
`new UpdateManager("https://the.place/you-host/updates")` -- GitHub Releases:
`new UpdateManager(new GitHubSource("https://github.com/yourName/yourRepo")` - -There are a variety of built-in sources (eg. [GithubSource](../reference/cs/Velopack.Sources/GithubSource.md), [SimpleWebSource](../reference/cs/Velopack.Sources/SimpleWebSource.md)) you can use when checking for updates, but you can also build your own by [deriving from IUpdateSource](../reference/cs/Velopack.Sources/IUpdateSource.md). - -### Check for updates - -`CheckForUpdatesAsync` will read the provided update source for a `releases.{channel}.json` file to retrieve available updates ([Read about channels](../packaging/channels.mdx)). If there is an update available, a non-null [UpdateInfo](../reference/cs/Velopack/UpdateInfo.md) will be returned with some details about the update. You can also [retrieve any release notes](release-notes.mdx) which were provided when the update was packaged. - -There are [also some options](../reference/cs/Velopack/UpdateOptions.md) which can be passed in to [UpdateManager](../reference/cs/Velopack/UpdateManager.md) to customise how updates are handled, eg. to allow things like [switching channels](switching-channels.mdx). - -### Download updates - -`DownloadUpdatesAsync` will attempt to download deltas (if available) and re-construct the latest full release. If there are no deltas available, or the delta reconstruction fails, the latest full release package will be downloaded instead. Note that if an option like `AllowVersionDowngrade` is specified, the downloaded version might be older than the currently executing version. - -### Apply updates - -Once the update has downloaded, you have a few options available. Calling `ApplyUpdatesAndRestart` or `ApplyUpdatesAndExit` will exit your app, install any [bootstrap prerequisites](../packaging/bootstrapping.mdx), install the update, and then optionally restart your app right away. - -If you do not want to exit your app immediately, you can call `WaitExitThenApplyUpdates` instead, which will launch Update.exe and wait for 60 seconds before proceeding. If your app has not exited within 60 seconds it will be killed. - -Lastly, if you do not call any of these "Apply" methods, when you re-launch your app, by default, Velopack will detect that there is a pending update and install it then. If you wish to disable this, you should call `VelopackApp.Build().SetAutoApplyOnStartup(false)`. - -:::tip -It is recommended that you use one of the functions which explicitly applies a package (eg. `ApplyUpdatesAndRestart`), and do not rely on the AutoApply behavior as a rule of thumb. The auto behavior will only apply a downloaded version if it is > the currently installed version, so will not work if trying to downgrade or switch channels, and if more than one instance of your process is running it could result in the update failing or those other processes being terminated. -::: - -## How updates work - -### On Windows - -In a typical Windows install the application structure will look like this: - -``` -%LocalAppData% -└── {packId} - ├── current - │ ├── YourFile.dll - │ ├── sq.version - │ └── YourApp.exe - └── Update.exe -``` - -`sq.version` is a special file created by Velopack which contains some metadata about your currently installed application. During install/uninstall, the entire `{packId}` folder is replaced or removed. During updates, only the `current` folder is replaced. If you store settings in the same folder as your main binary, they will be erased during updates. - -:::warning -Since `current` is replaced with the new version during updates, it's not safe to store settings, logs, etc in the `current` dir where your app lives. See **_[Preserving Files](./preserved-files.mdx)_** for more info. -::: - -### On Linux & Mac - -On these platforms, the app is stored as a single (typically read-only) bundle like `.app` or `.AppImage`. The bundle is replaced during updates in a single atomic operation. -If you have any files you wish to persist (settings, logs, etc) you must find a directory elsewhere on the filesystem to store these files. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/preserved-files.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/preserved-files.mdx deleted file mode 100644 index f8bf052..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/preserved-files.mdx +++ /dev/null @@ -1,22 +0,0 @@ -# Preserving Files & Settings - - -Your application binary files get completely replaced during updates, so you should not store important files in the same directory as your application binary files. - -## Application Settings - -If you want to create settings that persist through updates, but are erased when the app is uninstalled, on Windows you should store them one level up (`..\`) outside of the `current` dir. - -If you want to create files which persist even if the app is uninstalled (eg. important user settings) then you should store them in `%AppData%\{packId}` (that's the **_roaming app data_**, not local app data where the app lives). - -## Sentry / Crashpad / Error Reporting - -Many error crash handling utilities will store error/crash reports to the application directory by default, and will upload them as a report the next time the application starts. - -You need to ensure any of these libraries can be configured with a database / storage directory outside of the current application directory somewhere. -On Windows, you just need to be outside the `%LocalAppData\{packId}\current` directory. So you could use `..\` (this is the same as `%LocalAppData\{packId}`). - -## Non-Windows - -For other non-Windows operating systems, you should search online to find best practices about where to store settings/log files for installed apps. -The recommended location is OS / distro specific, and might be in `/var` or somewhere in user home `~` (eg. `~/Library/Application Support` on MacOS). diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/release-notes.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/release-notes.mdx deleted file mode 100644 index ca495b8..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/release-notes.mdx +++ /dev/null @@ -1,23 +0,0 @@ -# Release Notes - - -It is possible to store release notes (Markdown) in update packages and access it while Updating. This could be useful, for example, to show a user a list of changes before downloading a update. - -- Write your release notes to a file (eg. releasenotes.mdx). -- While packing your release, provide these to Velopack with `--releaseNotes {path/to/releasenotes.md}` - -The Velopack builder will render this to HTML for your convenience, and store both the HTML and the markdown into your update package. - -Now, release notes will be available while checking for updates, for example: - -```cs -private static async Task UpdateMyApp() -{ - var mgr = new UpdateManager("https://the.place/you-host/updates"); - - var newVersion = await mgr.CheckForUpdatesAsync(); - if (newVersion != null) { - new ReleaseNotesHtmlWindow(newVersion.TargetFullRelease.ReleaseNotesHtml).Show(); - } -} -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/shortcuts.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/shortcuts.mdx deleted file mode 100644 index b654642..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/shortcuts.mdx +++ /dev/null @@ -1,19 +0,0 @@ -# Windows Shortcuts - - -By default, during installation Velopack will create a shortcut on the Desktop and in the StartMenuRoot. It will automatically delete any shortcuts it finds when uninstalling the application. - -The name of the shortcuts will be determined by the `--packTitle` vpk argument. For example, if you pass `--packTitle "My Fancy App"`, then the shortcuts created will be created as `"My Fancy App.lnk"`. - -If you need to create shortcuts in any extra locations, the `Velopack.Windows.Shortcuts` and `Velopack.Windows.ShellLink` classes are provided. These classes are provided for legacy reasons, and in general the stability of such functions is not guarenteed. - -For example, if you wished to create a shortcut during the install of your app, you might do the following: - -```cs -using Velopack; -using Velopack.Windows; - -VelopackApp.Build() - .WithAfterInstallFastCallback((v) => new Shortcuts().CreateShortcutForThisExe(ShortcutLocation.Desktop)) - .Run() -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/switching-channels.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/switching-channels.mdx deleted file mode 100644 index d70d44c..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/integrating/switching-channels.mdx +++ /dev/null @@ -1,30 +0,0 @@ -# Switching Channels - - -By default, `UpdateManager` will try and search for releases in the same channel that it was built for. You can [read more about packaging channels here](../packaging/channels.mdx). So normally, you should not provide a channel at all to the `UpdateManager` constructor. - -However, from time to time, it may be useful to allow a user to switch channels without re-installing the application. For example, a user opts into getting "beta" features via your application settings. In that case, you can provide the channel explicitly: - -```cs -new UpdateManager("https://the.place/you-host/updates", new UpdateOptions { - ExplicitChannel = "beta" -}); -``` - -Also by default, the UpdateManager will only update to versions which are newer than the current version, leading to suboptimal behavior because often you may be switching to a version which is lower than the current version. Imagine the following scenario: - -- You publish 2.0.0 to the `stable` channel. -- You publish 2.0.1 through 2.0.5 to the `beta` channel. -- Your user installs 2.0.0 `stable`, and then opts-in to `beta` via settings. -- Your user can update from 2.0.0 -> 2.0.5 fine, because 2.0.5 is a newer version. -- Your user encounters a bug and turns off `beta` via settings. -- By default, UpdateManager will not install stable 2.0.0 because it is a lower version than 2.0.5. - -It's for this reason I recommend always using the `ExplicitChannel` option with the `AllowVersionDowngrade` option. For example: - -```cs -new UpdateManager("https://the.place/you-host/updates", new UpdateOptions { - ExplicitChannel = "beta", - AllowVersionDowngrade = true, -}); -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/migrating/squirrel.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/migrating/squirrel.mdx deleted file mode 100644 index 4623fcb..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/migrating/squirrel.mdx +++ /dev/null @@ -1,70 +0,0 @@ -# From Squirrel - - -Migrate `Squirrel.Windows` or `Clowd.Squirrel` to Velopack. - -Here are the general steps needed: - -1. Replace the `Squirrel.Windows` or `Clowd.Squirrel` nuget package with the latest [Velopack NuGet Package](https://www.nuget.org/packages/velopack). - -2. Install the `vpk` command line tool, as this is what you'll use to build Velopack releases. - ```cmd - dotnet tool install -g vpk - ``` - -3. You will need to replace `SquirrelAwareApp` at the beginning of your app to `VelopackApp.Build().Run()`. Shortcuts [\[Read more\]](integrating/shortcuts.mdx) and registry entries are managed automatically for you in Velopack, so if you are currently doing this in `SquirrelAwareApp` hooks they should be removed. For example, if your hooks were this before: - - ```cs - public static void Main(string[] args) - { - SquirrelAwareApp.HandleEvents( - onInitialInstall: OnAppInstall, - onAppUninstall: OnAppUninstall, - onEveryRun: OnAppRun); - } - - private static void OnAppInstall(SemanticVersion version, IAppTools tools) - { - tools.CreateShortcutForThisExe(ShortcutLocation.StartMenu | ShortcutLocation.Desktop); - } - - private static void OnAppUninstall(SemanticVersion version, IAppTools tools) - { - tools.RemoveShortcutForThisExe(ShortcutLocation.StartMenu | ShortcutLocation.Desktop); - } - - private static void OnAppRun(SemanticVersion version, IAppTools tools, bool firstRun) - { - if (firstRun) MessageBox.Show("Thanks for installing my application!"); - } - ``` - - Then you would migrate to the following code, removing the shortcut hooks: - - ```cs - public static void Main(string[] args) - { - // Thank the user for installing the app on first run. - // Note that the MessageBox class below comes from WinForms or WPF. - VelopackApp.Build() - .WithFirstRun(v => MessageBox.Show("Thanks for installing my application!")) - .Run(); - } - ``` - -4. The concept of `SquirrelAwareApp` no longer exists, so if you've added any attributes, assembly manifest entries, or other files to indicate that your binary is now aware, you can remove that. Every Velopack package has exactly one "VelopackApp" binary, which must implement the above interface at the top of `Main`. By default, Velopack will search for a binary in `{packDir}\{packId}.exe`. If your main VelopackApp exe is named differently, you should provide the name with the `--mainExe yourApp.exe` argument. - -5. The "RELEASES" file is no longer a format that Velopack uses, but it will produce one when building packages on windows with the default channel (eg. no channel argument provided). Instead, Velopack will produce `releases.{channel}.json` files, which should be treated in the same way. If you are wishing for a legacy windows app to migrate to Velopack, you should upload both the `RELEASES` file and the `releases.win.json` file which is produced by Velopack to your update feed. - -6. In general, the command line supports all of the same features, but argument names or commands may have changed. Velopack no longer supports taking a `.nupkg` which was created by dotnet or nuget.exe. You should publish your app, and use `vpk pack` instead. A very simple example might look like this - - ```cmd - dotnet publish --self-contined -r win-x64 -o publish - vpk pack -u YourAppId -v 1.0.0 -p publish -e yourMainBinary.exe - ``` - - Please review the vpk command line help for more details: - - ```cmd - vpk -h - ``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/bootstrapping.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/bootstrapping.mdx deleted file mode 100644 index 7f3fb31..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/bootstrapping.mdx +++ /dev/null @@ -1,86 +0,0 @@ -# Bootstrapping - - -Install .NET, vcredist, webview2, and more while installing Velopack applications on Windows using the `--framework` / `-f` argument. - -It is possibly to specify more than one requirement, using a comma delimited list. For example: - -```cmd -vpk pack ... --framework net6.0-x64-desktop,vcredist142-x64 -``` - -These dependencies will be downloaded and installed before your application will be installed. - -:::warning -If you are building a dotnet application with `--self-contained`, you should **NOT** provide a `--framework` argument specifying that your app requires dotnet installed, because your application already has the runtime bundled in. If you are publishing your application with `--no-self-contained`, then you should provide the `--framework` argument. -::: - -## Adding dependencies during updates - -Velopack will check that all required dependencies are installed before applying new updates. This means if a new version of your app adds a new dependency, the user will be prompted to install it before your new version is applied. - -## List of supported frameworks - -Any of the following can be passed via the `--framework` argument. - -### Edge WebView2 - -- `webview2` - -### vcredist - -- `vcredist100-x86` (VC++ 10.0 / VS 2010) -- `vcredist100-x64` (VC++ 10.0 / VS 2010) -- `vcredist110-x86` (VC++ 11.0 / VS 2012) -- `vcredist110-x64` (VC++ 11.0 / VS 2012) -- `vcredist120-x86` (VC++ 12.0 / VS 2013) -- `vcredist120-x64` (VC++ 12.0 / VS 2013) -- `vcredist140-x86` (VC++ 14.0 / VS 2015) -- `vcredist140-x64` (VC++ 14.0 / VS 2015) -- `vcredist141-x86` (VC++ 14.1 / VS 2017) -- `vcredist141-x64` (VC++ 14.1 / VS 2017) -- `vcredist142-x86` (VC++ 14.2 / VS 2019) -- `vcredist142-x64` (VC++ 14.2 / VS 2019) -- `vcredist143-x86` (VC++ 14.3 / VS 2022) -- `vcredist143-x64` (VC++ 14.3 / VS 2022) -- `vcredist143-arm64` (VC++ 14.3 / VS 2022) - -### .Net Framework - -- `net45` -- `net451` -- `net452` -- `net46` -- `net461` -- `net462` -- `net47` -- `net471` -- `net472` -- `net48` -- `net481` - -### dotnet - -Every version of dotnet is supported >= 5.0. The framework argument should be supplied in the format `$"net{major.minor}-{arch}-{type}"`. - -The valid `{arch}` values are - -- x86 -- x64 -- arm64 - -The valid `{type}` values are - -- runtime -- aspnetcore -- desktop - -Here are some examples: - -- .NET 6.0 Desktop Runtime (x64) `--framework net6.0-x64-desktop` -- .NET 8.0 Runtime (arm64) `--framework net8.0-arm64-runtime` -- .NET 5.0 AspNetCore (x86) `--framework net5.0-x86-aspnetcore` - -By default, Velopack will accept any installed release, but always install the latest. That is to say, if your dependency is specified as `net6.0-x64-desktop` and version `6.0.2` is installed, it will be accepted. If it's not installed, Velopack will download the latest available version (at the time of writing, that's `6.0.26`). - -If you need a specific version of dotnet, (eg. `6.0.11`) - you can specify a third version part in your dependency string: `--framework net6.0.11-x64-desktop`. In this case, if the installed version is `< 6.0.11`, then it will be upgraded to the latest available. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/channels.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/channels.mdx deleted file mode 100644 index b20b7a3..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/channels.mdx +++ /dev/null @@ -1,41 +0,0 @@ -# Release Channels - - -Channels is a fundemental part of how Velopack understands and builds releases. Every release must belong to a channel. If you do not specify a channel when building a release (via the `--channel`) argument, the default channel will be the name of the target Operating System (eg. `win`, `osx`, or `linux`). - -When building releases, Velopack will create a `releases.{channel}.json` file, that should be uploaded with your other assets (eg. `.nupkg`). This is how `UpdateManager` knows what releases are available. - -In general, you should not provide a channel to the `UpdateManager` constructor (leave it null). In this case, it will only search for update packages in the same channel that the current release was built for. For example, if you provided the `--channel stable` argument to `vpk`, and installed your app, then `UpdateManager` will automatically be searching for the file `releases.stable.json` when checking for updates. - -:::tip -For legacy purposes, Velopack will also generate a `RELEASES` file (for the `win` channel), or a `RELEASES-{channel}` file (for any other channel). By deploying these files as well as the `releases.{channel}.json` will allow legacy apps to upgrade to Velopack. If you do not have any users on legacy versions of your software, you can ignore these files. -::: - -## Switching channels in installed apps - -It is often desirable to allow users to switch channels easily. For example, if your users downloaded an installer for a "stable" version of your app, they will only receive updates for the "stable" channel. Later on, they decide they wish to switch to the "beta" channel to try some experimental features in your app. - -This can be done by supplying a non-null channel argument to the UpdateManager constructor. So you would instantiate as `new UpdateManager("https://the.place/you-store/updates", "beta")` and then perform an update process as usual. - -## Deploying cross-platform apps - -It's important when deploying cross platform (or cross-architecture) apps that every unique os/rid has it's own channel. It wouldn't be good if your Windows app tried to install an OSX package etc! - -The default channels are, `win`, `osx`, or `linux`, so if you are only distributing one release per platform, you do not need to specify a channel argument, everything should work automatically. If you are distributing feature channels (eg. 'stable', 'beta') or need to distribute multiple versions of your app per os (eg. `win-x64`, `win-arm64`) then you will need to define a channel strategy that does not collide. - -For example, if I was distributing an app on windows and osx which needed to support x64, and arm64, and also needed to support "stable" and "beta", then I would need the following 8 channels: - -- win-x64-stable -- win-x64-beta -- win-arm64-stable -- win-arm64-beta -- osx-x64-stable -- osx-x64-beta -- osx-arm64-stable -- osx-arm64-beta - -## Renaming a channel - -You can't rename a channel per-say, but you can supercede it (ie. force all your users to switch to the new channel). Imagine you have been publishing an app that only supports x64 windows to the channel `stable` until now, but you now would like to release an arm64 version of your app. So you want to migrate all the users on `stable` to `win-x64`, while also creating a new channel named `win-arm64`. - -You should publish your next update (say v2.0.0) using `--channel win-x64`, which will create a new `releases.win-x64.json` file. You can now copy this file and rename it to `releases.stable.json` and deploy both files along with your v2.0.0 `.nupkg` to your update server. Any users on the "stable" channel will find the `releases.stable.json` file and update to your v2.0.0 win-x64 release, and once done will search for future updates at `releases.win-x64.json`. You only need to do this once, you will not need to update the `releases.stable.json` file again, however you may not want to delete it so users who have not opened your app in some time can still find the new updates. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/deltas.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/deltas.mdx deleted file mode 100644 index 59b5111..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/deltas.mdx +++ /dev/null @@ -1,47 +0,0 @@ -# Delta Updates - - -Delta updates provide speedy updates for even the biggest of applications. - -By default, as long as there is a previous release in your `--outputDir` / `-o` directory, Velopack will automatically generate a delta when creating a new release. - -:::tip -If you don't have the latest local release, eg. you're running in CI, you can use the `vpk download` command to automatically fetch it so delta's can be created. -::: - -Delta packages use [Zstandard](https://github.com/facebook/zstd) to create binary patches of individual files in your package. Due to limitations of Zstandard, no single file can be bigger than 2 GB. - -## Optimising for size - -The default parameters picked for patch generation are to provide a good balance of size and speed. -If you would like to optimize for size, you can do this with the `--delta BestSize` argument. -YMMV, for some appliations this may give you big size savings, for others it may not. Either way it will be a lot slower, about on-par with the `bsdiff` algorithm. - -## How delta's work - -During updates, Velopack will look for possibly more than one delta to download. Imagine you have published the following releases: - -- `1.0.0` -- `1.0.1` -- `1.0.2` -- `1.0.3` - -If a user has not opened your app in a while, and has `1.0.0` installed, the next time they open the app, -3 delta's will be downloaded: `1.0.1-delta`, `1.0.2-delta`, and `1.0.3-delta`. - -The previously downloaded/installed package is stored in `%LocalAppData\{packId}\packages`, so Velopack will then apply those 3 delta's sequentially -on top of the local package that exists in that directory. - -Once the delta's have been applied, and the `1.0.3` release has been reconstructed, it will be ready for applying. - -There is a heuristic in Velopack which will attempt to decide whether it is better to download N delta's or download the latest full release instead. -This is based on a number of factors (eg. size of the full release, sum size of the delta's, total number of delta's between the current & target version). - -## GitHub Releases - -There is special support for GitHub Releases in `UpdateManager` which will search through a number of previous GitHub Releases for available delta's. -This means any one GitHub release must only have 1 full package and 1 delta update to facilitate proper updating. - -## Disabling delta's - -If for some reason you don't want to deploy delta's, you can disable them with the `--delta none` argument. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/installer.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/installer.mdx deleted file mode 100644 index 6c74d51..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/installer.mdx +++ /dev/null @@ -1,52 +0,0 @@ -# Installers - - -Velopack takes a relatively light-touch when it comes to installers, so there is not a lot of customisation available like you would find in other installation frameworks. This is the tradeoff Velopack makes to ensure that the developer/user experience is as fast and easy as possible. - -In both operating systems, if [code signing is configured](signing.mdx) the installer will also be signed. (This is _required_ on MacOS) - -## Windows Overview - -The Windows installer is currently a "one-click" installer, meaning when the `Setup.exe` binary is run, Velopack will not show any questions / wizards to the user, it will simply attempt to install the app as fast as possible and then launch it. - -The setup will install a shortcut to `StartMenuRoot` and `Desktop` by default. [\[Read more\]](../integrating/shortcuts.mdx) - -The key options which will customize the installer are as follows: - -- `--packTitle {app name}` customizes shortcut names, the Apps & Features name, and the portable entry exe name. -- `--icon {path}` sets the .ico on Update.exe and Setup.exe (and also the icon of any dialogs shown) -- `--splashImage {path}` sets the (possibly animated) splash image to be shown while installing. - -The splash image can be a `jpeg`, `png`, or `gif`. In the latter case, it will be animated. - -You can also [bootstrap required frameworks](bootstrapping.mdx) before installing your app. - -The Windows installer will extract the application to `%LocalAppData%\{packId}`, and the directory structure will look like: - -``` -{packId} -├── current -│ ├── YourFile.dll -│ ├── sq.version -│ └── YourApp.exe -└── Update.exe -``` - -The `current` directory will be fully replaced [while doing updates](../integrating/overview.mdx). The other two files added by Velopack (`Update.exe` and `sq.version`) are crucial and are required files for Velopack to be able to properly update your application. - -## MacOS Overview - -The MacOS installer will be a standard `.pkg` - which is just a bundle where the UI is provided by the operating system, allowing the user to pick the install location. The app will be launched automatically after the install (mirroring the behavior on Windows) because of a `postinstall` script added by Velopack. - -The key options which will customize the installer are as follows: - -- `--packTitle {app name}` customizes the name of the `.app` bundle and the app name shown in the `.pkg` -- `--pkgWelcome {path}` adds a Welcome page -- `--pkgReadme {path}` adds a Readme page -- `--pkgLicense {path}` adds a License Acceptance page -- `--pkgConclusion {path}` adds a Conclusion page -- `--noPkg` disable generating a `.pkg` installer entirely - -The pkgPage arguments can be a `.rtf` or a `.html` file. - -The `.app` package can be extracted to `/Applications` or `~/Applications`, this is selected by the user while installing. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/operating-systems/linux.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/operating-systems/linux.mdx deleted file mode 100644 index 41b3412..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/operating-systems/linux.mdx +++ /dev/null @@ -1,48 +0,0 @@ -# Linux Overview - - -Linux specific notes about creating and using Velopack packages. - -On Linux, Velopack does not create an installer, it simply creates an `.AppImage` file. - -The user will: - -- Download the `.AppImage` file -- Set permission with `chmod +x YourFile.AppImage` -- Run with `./YourFile.AppImage` - -## Packaging - -An icon is required to build an AppImage, and it ideally should be in PNG format. This can be provided with the `--icon` argument. - -It is possible for `vpk` to fully create the AppImage/AppDir structure for you automatically, given your build directory as usual. -Optionally, you can pre-build your AppImage/AppDir structure to the [following specification](https://github.com/AppImage/AppImageKit/wiki/AppDir). -If you have staged your AppDir, use the `--appDir` argument _instead of_ the `--packDir / -p` argument. -Also, it's expected that the icon and `.desktop` file will already exist, so you should no longer provide the `--icon` argument with `--appDir`. - -## Updating - -During updates, packages are downloaded to a temporary location (`/var/tmp`) and then the `.AppImage` is replaced. -If the `.AppImage` is in a privileged folder, the updater will automatically prompt for sudo using `pkexec`. -The app can technically be updated while it's running, although Velopack will make an effort to close/restart it to clear out any old versions curently running. - -## What is an AppImage? - -AppImage does not install software in the traditional sense (i.e., it do not put files all over the place in the system). - -It use one file per application. Each one is self-contained: it includes all libraries the application depends on and that are not part of the base system. -In this regard, it is similar to "application virtualization". -One can use a AppImage file even if they are not a superuser, or they are using a live CD. -AppImage files are often simpler than compiling and installing an application, as no installation actually took place. -The AppImage file is a compressed image which is temporarily mounted to allow access to the program, but not having to extract the program or modify the underlying system. - -## Why AppImage, and not deb, snap, etc? - -- AppImage is a format for binary software distribution. Software packaged as AppImage is intended to be as binary-compatible as possible with as many systems as possible. -- An AppImage should run on pretty much all base operating systems (distributions). For example, you could target Ubuntu 9.10, openSUSE 11.2, and Fedora 13 (and later versions) at the same time, without having to create and maintain separate packages for each target system. -- AppImages are relocatable and portable, and do not modify the operating system in any way. This means it can be directly run on a Live CD, USB stick, etc. - -## Can an AppImage be "installed"? - -Yes, it can - but this exercise is generally left up to the user. There are frameworks which will install an AppImage on first run, by moving it to a pre-determined location, adding a dock/launcher/desktop shortcut etc. -One such framework is [AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher), but there are also others. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/operating-systems/macos.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/operating-systems/macos.mdx deleted file mode 100644 index d10cd7f..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/operating-systems/macos.mdx +++ /dev/null @@ -1,37 +0,0 @@ -# MacOS Overview - - -MacOS specific notes about creating and using Velopack packages. - -For Mac, applications are distributed as `.app` bundles. These are special folders that appear in Finder like a single file. - -## Packaging - -If you are creating a custom bundle, you can provide a folder ending in `.app` to the `--packDir` / `-p` argument, Velopack will copy and use this directly. -If you do not wish to create the `.app` bundle manually, Velopack can do this for you, so just supply any other folder (which does not end in `.app`) to the `--packDir` argument. - -If you wish for Velopack to automatically create a bundle, the only additional argument you need to provide is `--icon`, and this must be a valid `.icns` file. - -:::warning -[Code signing and notarization](../signing.mdx) is required by Apple before shipping your releases to users, or your app won't run. -::: - -## Updating - -During updates, packages are downloaded to `/tmp`, and during apply step the `.app` bundle will be extracted and replaced. - -If the `.app` is installed to `/Applications` (and not `~/Applications` for example), elevation may be required. -In this case, the updater will use AppleScrpt to request elevation and complete the update. -The `.app` bundle created by Velopack does not need to be in `/Applications` to support updates, it is a portable / self contained bundle -and if it is moved by the user it is still capable of applying updates. - -The app can technically be updated while it's running, although Velopack will make an effort to close/restart it to clear out any old versions curently running. - -## Installing - -Velopack will automatically generate and sign a `.pkg` installer for you, which allows you to show a readme, conclusion, license page, etc. -See the command line help for a complete list of options. -It also allows the user to choose whether to install to `/Applications` or `~/Applications`, and will launch the app automatically after it's been installed. - -If you do not wish to ship a pkg, Velopack also creates a portable `.zip` which will be automatically extracted if clicked by the user in Finder. -If you wish to ship a DMG instead, you can unzip this portable package and create a DMG that way. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/operating-systems/windows.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/operating-systems/windows.mdx deleted file mode 100644 index 219255b..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/operating-systems/windows.mdx +++ /dev/null @@ -1,61 +0,0 @@ -# Windows Overview - - -Windows specific notes about creating and using Velopack packages. - -For Windows, Velopack creates and installs a folder structure which looks like the following: - -``` -%LocalAppData% -└── {packId} - ├── current - │ ├── YourFile.dll - │ ├── sq.version - │ └── YourApp.exe - └── Update.exe -``` - -## Packaging - -There are no special requirements to package a program for Windows, although you may wish to customise the installer -using `--packTitle`, `--splashImage`, `--icon` etc. See the command line help for a complete list of options. - -It's also very recommended (but not required) that you [code sign](../signing.mdx) before shipping to your users. If you do not do this, -your app may be flagged as a virus. - -## Updating - -During updates, the entire `current` directory will be replaced, so if you need to store settings, logs, crash reports, and so on, -please see [Preserving Files](../../integrating/preserved-files.mdx). - -On Windows, if any of the files inside `current` are in-use, the folder can not be moved/renamed/deleted, etc. -There lots of things that could lock this folder. For example: - -- A process running inside `current` -- A process running outside of `current`, which has opened a file inside `current` for reading. -- Anti-virus / Windows Defender, etc -- A process with it's CWD (current working dir) inside that folder (for example, a `cmd.exe` process). - -If the folder can not be renamed during the update process, Velopack's updater will attempt to automatically kill any processes running inside `current`. -If the folder is still locked and can not be renamed, the updater will search for other processes on the system which may be locking the folder - -and if any are found, it will open a dialog to the user offering to kill them or abort the update. If the locking process could not be identified, -(for example, if the locking process is running as Administrator) then an error message will be shown to the user, and the old version of the -application will be launched. - -:::info -Currently, neither the updater nor the installer support privileged directories such as `C:\Program Files`, but support for this is planned in the future. -::: - -## Installing - -The setup produced by Velopack is a one-click installer, which will show the splash image of your choice (PNG, JPG, or animated GIF), -or if you do not provide an image it will be a simple progress bar. - -By default the installer will install to `%LocalAppData%\{packId}` but this can be overridden at runtime with the `Setup.exe --installto {dir}` argument. - -Before starting installation, the installer will check that the [App RID](../rid.mdx) is compatible with the current operating system, -and also check for any missing [boostrapping dependencies](../bootstrapping.mdx). - -Also, during installation the installer will run [App Hooks](../../integrating/hooks.mdx), as well as launch the application for the first time -once installation has completed. If you would like to prevent the application from being launched after install has completed, -you can do this with the `Setup.exe --silent` argument. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/overview.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/overview.mdx deleted file mode 100644 index e170fe5..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/overview.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -sidebar_label: Overview -sidebar_position: 0 ---- - -# Packaging Overview - - - -Packaging a release is accomplished with the `pack` command in Velopack. Regardless of your operating system, the common required arguments are roughly the same. - -## Creating your first release - -You first should compile your application with whatever toolchain you would normally use (eg. `dotnet publish`, `msbuild.exe`, so forth). -Henceforth this will be called `{build_dir}`. - -### Required arguments - -- `--packId {id}` The unique ID of your application. This should be unique enough to avoid other application authors from colliding with your app. -- `--packVersion {version}` The current version you are releasing - in [semver2 format](https://semver.org/) (eg. `1.0.0-build.23+metadata`). -- `--packDir {build_dir}` The folder containing your compiled application. -- `--mainExe {exeName}` The main executable to be started after install, and the binary that will [handle Velopack Hooks](../integrating/overview.mdx). -- `--icon {path}` The icon used to bundle your app. Only required on MacOS and Linux. - -:::tip -Velopack does not support 4 part versions (eg. `1.0.0.0`), as it would not be practical to support both formats simultaneously and semver2 offers a lot more flexibility. -::: - -A complete example: - -```cmd -dotnet publish -c Release -r win-x64 -o publish -vpk pack --packId MyAppId -packVersion 1.0.0 --packDir publish --mainExe MyApp.exe -``` - -### Optional recommended arguments - -There are many optional arguments, the best way to see what features are available for your operating system is to check `vpk pack -h`. To mention a couple: - -- `--packTitle {name}` The friendly name for your app, shown to users in dialogs, shortcuts, etc. -- `--outputDir {path}` The location Velopack should create the final releases (defaults to `.\Releases`) - -### Release output - -When building a release has completed, you should have the following assets in your `--outputDir`: - -- `MyAppId-1.0.0-full.nupkg` - Full Release: contains your entire update package. -- `MyAppId-1.0.0-delta.nupkg` - Delta Release: only if there was a previous release to build a delta from. These are optional to build/deploy, but speeds up the updating process for sers because they only need to download what's changed between versions instead of the full package. -- `MyAppId-Portable.zip` - Portable Release: Can deploy this optionally to allow users to run and update your app without installing. -- `MyAppId-Setup.exe` - Installer: Used by most users to install the app to the local filesystem. -- `releases.{channel}.json` - Releases Index: a list of every available release. Used by `UpdateManager` to locate the latest applicable release. -- `RELEASES` - Legacy Releases File: only used for clients [migrating to Velopack](../migrating/squirrel.mdx) from Squirrel. -- `assets.{channel}.json` - Build Assets: A list of assets created in the most recent build. Used by [Velopack deployment commands](../distributing/overview.mdx). - -You do not need to deploy all of these files to allow users to update, so you should review the [deployment guide](../distributing/overview.mdx) for more information on which files to distribute. - -:::tip -There is no setup/installer package for Linux. The program is distributed as a self-updating `.AppImage`. The reason is that `.AppImage` will run on pretty much every modern distro with no extra dependencies needed. Just download the `.AppImage`, run `chmod +x`, and click it to start. It is possible to install an `.AppImage`, but this is left up to the user to install something like [appimaged](https://github.com/probonopd/go-appimage/blob/master/src/appimaged/README.mdx) or [AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher). -::: - -## Code signing - -While this is not required for local builds / testing, you should always code-sign your application before distributing your application to users. - -:::tip -If you do not code-sign, your application may fail to run. [\[Read more\]](signing.mdx) -::: - -## Customising the installer - -On platforms which ship installers, you can customise the behavior. [\[Read more\]](installer.mdx) - -## Other recommended arguments - -- If your application is operating-system or CPU architecture specific you should consider adding an `--rid`. [\[Read more\]](rid.mdx) -- If you plan on distributing release channels for different architectures or features, consider adding a `--channel` [\[Read more\]](channels.mdx) -- If your app requires additional frameworks (eg. vcredist) consider `--framework` [\[Read more\]](bootstrapping.mdx) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/rid.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/rid.mdx deleted file mode 100644 index 8762851..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/rid.mdx +++ /dev/null @@ -1,26 +0,0 @@ -# RID (Runtime Identifier) - - - -Similar to how you provide a RID to dotnet to designate your target operating system and architecture, you can do the same for Velopack to tell it what your application supports. - -An RID is composed of three parts (`{os}{version?}-{arch}`) - -- os: operating system (`win`, `osx`, or `linux`) -- version: optionally, specify minimum supported version (eg. `win7`, `win8.1`, `win10.0.18362`) -- arch: optionaly, specify supported CPU architecture (eg.`win-x86`, `win-x64`, `win-arm64`) - -If you were to provide the RID `--rid win10-arm64`, any users trying to install your app on Windows 7, 8, or 8.1 will receive a message saying their operating system is not supported. Similarly, if a Windows 11 user with an x64 cpu were trying to install - it would also fail with a helpful message. - -If trying to target Windows 11, they did not increment the major build number from 10 to 11. Anything >= build 22000 is classified as Windows 11. For example: - -- `win11 == win10.0.22000` -- `win11.0.22621 == win10.0.22621` - -On MacOS, the RID (min version and arch) is just stored as metadata in the `.pkg` which will be handled natively by the operating system. - -#### Also read - -- [Windows 10 version history](https://en.wikipedia.org/wiki/Windows_10_version_history) -- [Windows 11 version history](https://en.wikipedia.org/wiki/Windows_11_version_history) -- [.NET RID Catalog](https://learn.microsoft.com/dotnet/core/rid-catalog) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/signing.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/signing.mdx deleted file mode 100644 index 02bff96..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/packaging/signing.mdx +++ /dev/null @@ -1,194 +0,0 @@ -# Code Signing - - - -Code signing is an essential part of application distribution. On Windows, applications without code signatures are likely to be flagged as viruses. On OSX, codesigning and Notarization is required before your application can be run by users. - -On both platforms, signing needs to be performed by Velopack itself, this is because the Velopack binaries (such as Update and Setup) need to be signed at different points in the package build process. - -## Signing on Windows - -Here is the general rule of thumb for Windows Defender/Smart Screen warnings: - -- You don't sign your code. You release MyApp-v1.exe. People get smart screen warnings for a while until the reputation on that file increases. You release MyApp-v2.exe. People get warnings again until MyApp-v2.exe builds up enough reputation. -- You sign your code with an OV certificate. You release MyApp-v1.exe. People get smart screen warnings for a while until the reputation on that certificate increases. You release MyApp-v2.exe. People don't get warnings because the certificate already has a good reputation. Eventually your certificate expires and it comes time to release MyApp-v47.exe. You renew your certificate, and people get warnings again until the new certificate builds up reputation. -- You sign your code with an EV certificate. People never get warnings. - -### Acquiring a code signing certificate - -First, you need to acquire a code-signing certificate from a reputable brand. Microsoft lists the following trusted issuers [in their documentation](https://learn.microsoft.com/windows-hardware/drivers/dashboard/code-signing-cert-manage): - -- [Certum](https://shop.certum.eu/data-safety/code-signing-certificates/certum-ev-code-sigining.html) -- [SSL.com](https://www.ssl.com/certificates/ev-code-signing/) -- [DigiCert](https://www.digicert.com/signing/code-signing-certificates) -- [Entrust](https://www.entrustdatacard.com/products/digital-signing-certificates/code-signing-certificates) -- [GlobalSign](https://go.microsoft.com/fwlink/p/?LinkId=620888) -- [IdenTrust](https://www.identrust.com/digital-certificates/trustid-ev-code-signing) -- [Sectigo (formerly Comodo)](https://sectigo.com/ssl-certificates-tls/code-signing) - -:::tip -Note that since June 1, 2023 there [has been a policy change](https://knowledge.digicert.com/general-information/new-private-key-storage-requirement-for-standard-code-signing-certificates-november-2022), meaning it is no longer possible to directly download your code signing certificate private key as a file from issuers. This means most signing options available today will require you to participate in Cloud Code Signing, or install your certificate to a HSM (usb / hardware module). Some issurs may allow you to install your cert to a pre-owned/generic HSM, and some may force you to purchase and ship their own brand of HSM. CI/CD may not be possible with some issuers unless they provide tools specifically designed to do that. -::: - -It may be possible to get official certificates from an authorised reseller at a cheaper price: - -- [SignMyCode](https://signmycode.com/) -- [GoGetSSL](https://www.gogetssl.com/code-signing-ssl/) - -If looking for a cheap option, at the time of writing Certum does an [Open Source Cloud Signing Certificate](https://certum.store/data-safety/code-signing-certificates.html?as_dane_w_certyfikacie=5720) for $58. Note that it is not possible to automate Certum certificates with CI/CD because they require you to install virtual signing drivers (SimpleSign Desktop) and sign in to it with their 2FA SimplySign app. - -:::warning -This document is by no means a recommendation or advice to purchase from any particular code-signing certificate issuer. This is just general guidance for the process one might follow to purchase a certificate, and you must validate for yourself that the issuer you choose is fit for your use-case. -::: - -### Signing via `signtool.exe` - -Usually signing is accomplished via `signtool.exe`. If you already use this tool to sign your application, you can just pass your sign parameters straight to Velopack (minus the 'sign' command). - -For example, if your signing command before was: - -```cmd -signtool.exe sign /td sha256 /fd sha256 /f yourCert.pfx /tr http://timestamp.comodoca.com -``` - -Then now with `--signParams` it would be: - -```cmd -vpk pack ... --signParams "/td sha256 /fd sha256 /f yourCert.pfx /tr http://timestamp.comodoca.com" -``` - -If you are new to using `signtool.exe`, you can check the [command line reference here](https://learn.microsoft.com/dotnet/framework/tools/signtool-exe). I recommend getting signing working on a single binary first, using `signtool.exe`, before trying to get things working with the Velopack CLI. - -If you are using a USB / HSM and have the following signing error `Error: SignerSign() failed." (-2147023673/0x800704c7)`, this means that you are missing a password / unlock token. This can be added to your signing command with the `/csp /k` parameters. [\[Read more\]](https://stackoverflow.com/questions/17927895/automate-extended-validation-ev-code-signing-with-safenet-etoken/54439759#54439759) - -:::warning -Take care when providing parameters with spaces. You must wrap anything containing spaces with quotes and escape with a backslash. For example, `--signParams "/n \"My Cert Name\""`. If you are using an MSBuild `` task or similar, you will need to use `"` instead. -::: - -By default, Velopack will sign 10 files per call to `signtool.exe`, to speed up signing and reduce the number of times you need to interact with the console if you are using some kind of interactive signing method. This can be disabled with the `--signParallel 1` argument. - -### Custom signing commands and tools - -If you have more advanced signing requirements, such as a custom signing tool (eg. `AzureSignTool.exe`), then you can provide a command template instead, where `{{file}}` is the binary that Velopack will substitute and sign: - -```cmd -vpk pack ... --signTemplate "AzureSignTool.exe sign ... {{file}}" -``` - -## Signing & Notarizing on OSX - -Codesigning and Notarization is required before your application can be run by users, therefore it is a required step before deploying your application. - -### Creating code signing certificates - -1. First, you will need to create an account at https://developer.apple.com, pay the annual developer fee, and accept any license agreements. -2. Navigate to your certificates: https://developer.apple.com/account/resources/certificates -3. Click the (+) icon to create new certificates. You need to create both a `Developer ID Installer` and a `Developer ID Application` certificate for distribution of Velopack apps outside the Mac App Store. - ![apple certificate list](/images/apple_certificate_list.png) -4. Open both certificates by clicking on them, press Download, and then double click the ".cer" file to install it to your local keychain. - -### Setting up a NotaryTool profile - -1. Create an app-specific password: https://support.apple.com/en-us/102654. You will only be shown this password once, so save or write it down somewhere. -2. Find your apple team ID: https://developer.apple.com/account#MembershipDetailsCard -3. Store your Apple account credentials to a new NotaryTool profile: - ```sh - xcrun notarytool store-credentials \ - --apple-id "yourapple@account.com" \ - --team-id "your-located-team-id" \ - --password "your-generated-app-specific-password" \ - "your-local-profile-name-here" - ``` - -### Putting it all together - -Now that you have your NotaryTool profile and code signing certificates installed, you can add the following parameters to your `pack` command: - -```sh -vpk pack \ - ... - --signAppIdentity "Developer ID Application: Your Name" \ - --signInstallIdentity "Developer ID Installer: Your Name" \ - --notaryProfile "your-local-profile-name-here" \ -``` - -When these parameters are specified and valid, Velopack will automatically code sign and notarize your application and installer packages. - -### Automate signing in CI/CD (Github Actions) - -It is also posible to store your certificates and notary credentials as Action Secrets and sign your code during CI builds. - -1. Launch Keychain Access and open the "My Certificates" pane. - -2. Select both certificates, right click and select "Export". Save as a p12 file and make note of the password. You can use the same password for both certificates. - -3. Copy the contents of the certificate to clipboard as base64, example: - ```sh - base64 -i CERT.p12 | pbcopy - ``` - -4. Create 7 [Github Secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) for your Actions workflows - - `BUILD_CERTIFICATE_BASE64` (b64 of your app cert) - - `INSTALLER_CERTIFICATE_BASE64` (b64 of your installer cert) - - `P12_PASSWORD` (password for the certificates) - - `APPLE_ID` (your apple username) - - `APPLE_PASSWORD` (your app-specific password from earlier) - - `APPLE_TEAM` (your team id from earlier) - - `KEYCHAIN_PASSWORD` (can be any random string, will be used to create a new keychain) - -5. Add a step to your workflow which installs the certificates and keychain profile. Here is an example: - - ```yml - name: App build & sign - on: push - jobs: - build_with_signing: - runs-on: macos-latest - steps: - - name: Checkout repository - uses: actions/checkout@v4 - - - name: Install Apple certificates and notary profile - env: - BUILD_CERTIFICATE_BASE64: ${{ secrets.BUILD_CERTIFICATE_BASE64 }} - INSTALLER_CERTIFICATE_BASE64: ${{ secrets.INSTALLER_CERTIFICATE_BASE64 }} - P12_PASSWORD: ${{ secrets.P12_PASSWORD }} - APPLE_ID: ${{ secrets.APPLE_ID }} - APPLE_PASSWORD: ${{ secrets.APPLE_PASSWORD }} - APPLE_TEAM: ${{ secrets.APPLE_TEAM }} - KEYCHAIN_PASSWORD: ${{ secrets.KEYCHAIN_PASSWORD }} - run: | - # create variables for file paths - CERT_BUILD_PATH=$RUNNER_TEMP/build_certificate.p12 - CERT_INSTALLER_PATH=$RUNNER_TEMP/installer_certificate.p12 - KEYCHAIN_PATH=$RUNNER_TEMP/app-signing.keychain-db - - # import certificates from secrets - echo -n "$BUILD_CERTIFICATE_BASE64" | base64 --decode -o $CERT_BUILD_PATH - echo -n "$INSTALLER_CERTIFICATE_BASE64" | base64 --decode -o $CERT_INSTALLER_PATH - - # create temporary keychain - security create-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH - security set-keychain-settings -lut 21600 $KEYCHAIN_PATH - security unlock-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH - - # import certificates to keychain - security import $CERT_BUILD_PATH -P "$P12_PASSWORD" -A -t cert -f pkcs12 -k $KEYCHAIN_PATH - security import $CERT_INSTALLER_PATH -P "$P12_PASSWORD" -A -t cert -f pkcs12 -k $KEYCHAIN_PATH - security list-keychain -d user -s $KEYCHAIN_PATH - - # create notarytool profile - xcrun notarytool store-credentials --apple-id "$APPLE_ID" --team-id "$APPLE_TEAM" --password "$APPLE_PASSWORD" velopack-profile - - - name: Build app - ... - - - name: Create Velopack Release - run: | - dotnet tool install -g vpk - vpk ... --signAppIdentity "Developer ID Application: Your Name" --signInstallIdentity "Developer ID Installer: Your Name" --notaryProfile "velopack-profile" - - - name: Clean up keychain - if: ${{ always() }} - run: security delete-keychain $RUNNER_TEMP/app-signing.keychain-db - ``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cpp/api.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cpp/api.md deleted file mode 100644 index 7c75513..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cpp/api.md +++ /dev/null @@ -1,428 +0,0 @@ -# Velopack C++ Reference - - Members | Descriptions ---------------------------------|--------------------------------------------- -`namespace `[`Velopack`](#namespace_velopack) | -`struct `[`subprocess_s`](#structsubprocess__s) | - -## namespace `Velopack` {#namespace_velopack} - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`enum `[`JsonNodeType`](#_velopack_8hpp_1a7dfd07faa4d65bbd8e7f1d0d0b5c5a04) | -`enum `[`JsonToken`](#_velopack_8hpp_1acaf7690482eab17e0269860d1860c9e2) | -`enum `[`VelopackAssetType`](#_velopack_8hpp_1aa83ef9d579b9fc2e42294528577ee904) | -`public void `[`startup`](#_velopack_8cpp_1a1a2c6842876e9c322e26c977f7bce384)`(char ** args,size_t c_args)` | -`class `[`Velopack::JsonNode`](#class_velopack_1_1_json_node) | -`class `[`Velopack::JsonParser`](#class_velopack_1_1_json_parser) | -`class `[`Velopack::Platform`](#class_velopack_1_1_platform) | -`class `[`Velopack::StringStream`](#class_velopack_1_1_string_stream) | -`class `[`Velopack::UpdateInfo`](#class_velopack_1_1_update_info) | Holds information about the current version and pending updates, such as how many there are, and access to release notes. -`class `[`Velopack::UpdateManagerSync`](#class_velopack_1_1_update_manager_sync) | This class is used to check for updates, download updates, and apply updates. It is a synchronous version of the UpdateManager class. This class is not recommended for use in GUI applications, as it will block the main thread, so you may want to use the async UpdateManager class instead, if it is supported for your programming language. -`class `[`Velopack::VelopackAsset`](#class_velopack_1_1_velopack_asset) | An individual Velopack asset, could refer to an asset on-disk or in a remote package feed. - -#### Members - -#### `enum `[`JsonNodeType`](#_velopack_8hpp_1a7dfd07faa4d65bbd8e7f1d0d0b5c5a04) {#_velopack_8hpp_1a7dfd07faa4d65bbd8e7f1d0d0b5c5a04} - - Values | Descriptions ---------------------------------|--------------------------------------------- -null | -bool_ | -array | -object | -number | -string | - -#### `enum `[`JsonToken`](#_velopack_8hpp_1acaf7690482eab17e0269860d1860c9e2) {#_velopack_8hpp_1acaf7690482eab17e0269860d1860c9e2} - - Values | Descriptions ---------------------------------|--------------------------------------------- -none | -curlyOpen | -curlyClose | -squareOpen | -squareClose | -colon | -comma | -string | -number | -bool_ | -null | - -#### `enum `[`VelopackAssetType`](#_velopack_8hpp_1aa83ef9d579b9fc2e42294528577ee904) {#_velopack_8hpp_1aa83ef9d579b9fc2e42294528577ee904} - - Values | Descriptions ---------------------------------|--------------------------------------------- -unknown | -full | -delta | - -#### `public void `[`startup`](#_velopack_8cpp_1a1a2c6842876e9c322e26c977f7bce384)`(char ** args,size_t c_args)` {#_velopack_8cpp_1a1a2c6842876e9c322e26c977f7bce384} - -## class `Velopack::JsonNode` {#class_velopack_1_1_json_node} - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public `[`JsonNode`](#class_velopack_1_1_json_node_1a1bf6d106ebbd1776709cf085fe333d76)`() = default` | -`public JsonNodeType `[`getKind`](#class_velopack_1_1_json_node_1a923b2b13759e54b9072645a022c2f272)`() const` | Get the type of this node, such as string, object, array, etc. You should use this function and then call the corresponding AsObject, AsArray, AsString, etc. functions to get the actual parsed json information. -`public bool `[`isNull`](#class_velopack_1_1_json_node_1afb83035b3d626688d24493c86001d1d7)`() const` | Check if the JSON value is null. -`public bool `[`isEmpty`](#class_velopack_1_1_json_node_1ab56188938000f8fa88bc6a5a1c652ef5)`() const` | Check if the JSON value is empty - eg. an empty string, array, or object. -`public const std::unordered_map< std::string, std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > > * `[`asObject`](#class_velopack_1_1_json_node_1a87d696801e278b663c10289276cb1ca2)`() const` | Reinterpret a JSON value as an object. Throws exception if the value type was not an object. -`public const std::vector< std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > > * `[`asArray`](#class_velopack_1_1_json_node_1a76dbd4e67e4a58dafaeb80ebccd5b31b)`() const` | Reinterpret a JSON value as an array. Throws exception if the value type was not an array. -`public double `[`asNumber`](#class_velopack_1_1_json_node_1ae8b23482fd05ad4aaf67a842a55865f8)`() const` | Reinterpret a JSON value as a number. Throws exception if the value type was not a double. -`public bool `[`asBool`](#class_velopack_1_1_json_node_1a90b0d98c2b9ae42d7c83d00dbc64077b)`() const` | Reinterpret a JSON value as a boolean. Throws exception if the value type was not a boolean. -`public std::string_view `[`asString`](#class_velopack_1_1_json_node_1a7463c87e96a2dc5cf6cabf3ad7f0a577)`() const` | Reinterpret a JSON value as a string. Throws exception if the value type was not a string. -`public void `[`initBool`](#class_velopack_1_1_json_node_1a18a1848f9b1bd6ac76a884bbf3a2da92)`(bool value)` | -`public void `[`initArray`](#class_velopack_1_1_json_node_1ac3d67c1ddb1b68382489368aa9c45314)`()` | -`public void `[`addArrayChild`](#class_velopack_1_1_json_node_1abbacfa7b09b2f0df9c8c711025081eee)`(std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > child)` | -`public void `[`initObject`](#class_velopack_1_1_json_node_1a1092f357911d35eaeb2364ad0567f0af)`()` | -`public void `[`addObjectChild`](#class_velopack_1_1_json_node_1a59c8ef42ce80b470f71e38bb6f6c0aaf)`(std::string_view key,std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > child)` | -`public void `[`initNumber`](#class_velopack_1_1_json_node_1aa0e4f7f297bc29dd23904de4b18910ed)`(double value)` | -`public void `[`initString`](#class_velopack_1_1_json_node_1aa1f5ca52183d31e0c832d7530227b35d)`(std::string_view value)` | - -#### Members - -#### `public `[`JsonNode`](#class_velopack_1_1_json_node_1a1bf6d106ebbd1776709cf085fe333d76)`() = default` {#class_velopack_1_1_json_node_1a1bf6d106ebbd1776709cf085fe333d76} - -#### `public JsonNodeType `[`getKind`](#class_velopack_1_1_json_node_1a923b2b13759e54b9072645a022c2f272)`() const` {#class_velopack_1_1_json_node_1a923b2b13759e54b9072645a022c2f272} - -Get the type of this node, such as string, object, array, etc. You should use this function and then call the corresponding AsObject, AsArray, AsString, etc. functions to get the actual parsed json information. - -#### `public bool `[`isNull`](#class_velopack_1_1_json_node_1afb83035b3d626688d24493c86001d1d7)`() const` {#class_velopack_1_1_json_node_1afb83035b3d626688d24493c86001d1d7} - -Check if the JSON value is null. - -#### `public bool `[`isEmpty`](#class_velopack_1_1_json_node_1ab56188938000f8fa88bc6a5a1c652ef5)`() const` {#class_velopack_1_1_json_node_1ab56188938000f8fa88bc6a5a1c652ef5} - -Check if the JSON value is empty - eg. an empty string, array, or object. - -#### `public const std::unordered_map< std::string, std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > > * `[`asObject`](#class_velopack_1_1_json_node_1a87d696801e278b663c10289276cb1ca2)`() const` {#class_velopack_1_1_json_node_1a87d696801e278b663c10289276cb1ca2} - -Reinterpret a JSON value as an object. Throws exception if the value type was not an object. - -#### `public const std::vector< std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > > * `[`asArray`](#class_velopack_1_1_json_node_1a76dbd4e67e4a58dafaeb80ebccd5b31b)`() const` {#class_velopack_1_1_json_node_1a76dbd4e67e4a58dafaeb80ebccd5b31b} - -Reinterpret a JSON value as an array. Throws exception if the value type was not an array. - -#### `public double `[`asNumber`](#class_velopack_1_1_json_node_1ae8b23482fd05ad4aaf67a842a55865f8)`() const` {#class_velopack_1_1_json_node_1ae8b23482fd05ad4aaf67a842a55865f8} - -Reinterpret a JSON value as a number. Throws exception if the value type was not a double. - -#### `public bool `[`asBool`](#class_velopack_1_1_json_node_1a90b0d98c2b9ae42d7c83d00dbc64077b)`() const` {#class_velopack_1_1_json_node_1a90b0d98c2b9ae42d7c83d00dbc64077b} - -Reinterpret a JSON value as a boolean. Throws exception if the value type was not a boolean. - -#### `public std::string_view `[`asString`](#class_velopack_1_1_json_node_1a7463c87e96a2dc5cf6cabf3ad7f0a577)`() const` {#class_velopack_1_1_json_node_1a7463c87e96a2dc5cf6cabf3ad7f0a577} - -Reinterpret a JSON value as a string. Throws exception if the value type was not a string. - -#### `public void `[`initBool`](#class_velopack_1_1_json_node_1a18a1848f9b1bd6ac76a884bbf3a2da92)`(bool value)` {#class_velopack_1_1_json_node_1a18a1848f9b1bd6ac76a884bbf3a2da92} - -#### `public void `[`initArray`](#class_velopack_1_1_json_node_1ac3d67c1ddb1b68382489368aa9c45314)`()` {#class_velopack_1_1_json_node_1ac3d67c1ddb1b68382489368aa9c45314} - -#### `public void `[`addArrayChild`](#class_velopack_1_1_json_node_1abbacfa7b09b2f0df9c8c711025081eee)`(std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > child)` {#class_velopack_1_1_json_node_1abbacfa7b09b2f0df9c8c711025081eee} - -#### `public void `[`initObject`](#class_velopack_1_1_json_node_1a1092f357911d35eaeb2364ad0567f0af)`()` {#class_velopack_1_1_json_node_1a1092f357911d35eaeb2364ad0567f0af} - -#### `public void `[`addObjectChild`](#class_velopack_1_1_json_node_1a59c8ef42ce80b470f71e38bb6f6c0aaf)`(std::string_view key,std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > child)` {#class_velopack_1_1_json_node_1a59c8ef42ce80b470f71e38bb6f6c0aaf} - -#### `public void `[`initNumber`](#class_velopack_1_1_json_node_1aa0e4f7f297bc29dd23904de4b18910ed)`(double value)` {#class_velopack_1_1_json_node_1aa0e4f7f297bc29dd23904de4b18910ed} - -#### `public void `[`initString`](#class_velopack_1_1_json_node_1aa1f5ca52183d31e0c832d7530227b35d)`(std::string_view value)` {#class_velopack_1_1_json_node_1aa1f5ca52183d31e0c832d7530227b35d} - -## class `Velopack::JsonParser` {#class_velopack_1_1_json_parser} - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public `[`JsonParser`](#class_velopack_1_1_json_parser_1a8ba6193b9910a65ea83b1805c4de2ae9)`() = default` | -`public void `[`load`](#class_velopack_1_1_json_parser_1ad3616e263c683611394a9ffa069af1a3)`(std::string_view text)` | -`public bool `[`endReached`](#class_velopack_1_1_json_parser_1a896ce20ecbe184cfe6474548e0b1628d)`() const` | -`public std::string `[`readN`](#class_velopack_1_1_json_parser_1ad7c785bd0b73de6ee0bf14917e664955)`(int n)` | -`public int `[`read`](#class_velopack_1_1_json_parser_1a4ca8b941e10641ba731f5e33f2015175)`()` | -`public int `[`peek`](#class_velopack_1_1_json_parser_1ab3ea02be7bacf7eb9647d1cb71092861)`() const` | -`public bool `[`peekWhitespace`](#class_velopack_1_1_json_parser_1a27372ad0097723fbc942c4a353ec88ab)`() const` | -`public bool `[`peekWordbreak`](#class_velopack_1_1_json_parser_1a87791f81b34bcb3db86f5854a1e822b3)`() const` | -`public void `[`eatWhitespace`](#class_velopack_1_1_json_parser_1a5fc6e6a6440ef530ff909b7e87d8d15c)`()` | -`public std::string `[`readWord`](#class_velopack_1_1_json_parser_1a7ed0c81806d36f272d31a8ed5ccc30fa)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseNull`](#class_velopack_1_1_json_parser_1a05611896186a61087f0bf12dc25b6d1a)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseBool`](#class_velopack_1_1_json_parser_1a2bb75c78af5d495ed258940b2585e1a9)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseNumber`](#class_velopack_1_1_json_parser_1a73e75b51dd5922e0440e176c406dce58)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseString`](#class_velopack_1_1_json_parser_1a2eb42a0ea6db17db808548c3cb474fb5)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseObject`](#class_velopack_1_1_json_parser_1ac91bfabf5959f71ff5f068c9af912910)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseArray`](#class_velopack_1_1_json_parser_1a7659a483c15b4c3f94f8ceb7a951a4c9)`()` | -`public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseValue`](#class_velopack_1_1_json_parser_1a585c0e240fb52c3634c0df767fba8a74)`()` | - -#### Members - -#### `public `[`JsonParser`](#class_velopack_1_1_json_parser_1a8ba6193b9910a65ea83b1805c4de2ae9)`() = default` {#class_velopack_1_1_json_parser_1a8ba6193b9910a65ea83b1805c4de2ae9} - -#### `public void `[`load`](#class_velopack_1_1_json_parser_1ad3616e263c683611394a9ffa069af1a3)`(std::string_view text)` {#class_velopack_1_1_json_parser_1ad3616e263c683611394a9ffa069af1a3} - -#### `public bool `[`endReached`](#class_velopack_1_1_json_parser_1a896ce20ecbe184cfe6474548e0b1628d)`() const` {#class_velopack_1_1_json_parser_1a896ce20ecbe184cfe6474548e0b1628d} - -#### `public std::string `[`readN`](#class_velopack_1_1_json_parser_1ad7c785bd0b73de6ee0bf14917e664955)`(int n)` {#class_velopack_1_1_json_parser_1ad7c785bd0b73de6ee0bf14917e664955} - -#### `public int `[`read`](#class_velopack_1_1_json_parser_1a4ca8b941e10641ba731f5e33f2015175)`()` {#class_velopack_1_1_json_parser_1a4ca8b941e10641ba731f5e33f2015175} - -#### `public int `[`peek`](#class_velopack_1_1_json_parser_1ab3ea02be7bacf7eb9647d1cb71092861)`() const` {#class_velopack_1_1_json_parser_1ab3ea02be7bacf7eb9647d1cb71092861} - -#### `public bool `[`peekWhitespace`](#class_velopack_1_1_json_parser_1a27372ad0097723fbc942c4a353ec88ab)`() const` {#class_velopack_1_1_json_parser_1a27372ad0097723fbc942c4a353ec88ab} - -#### `public bool `[`peekWordbreak`](#class_velopack_1_1_json_parser_1a87791f81b34bcb3db86f5854a1e822b3)`() const` {#class_velopack_1_1_json_parser_1a87791f81b34bcb3db86f5854a1e822b3} - -#### `public void `[`eatWhitespace`](#class_velopack_1_1_json_parser_1a5fc6e6a6440ef530ff909b7e87d8d15c)`()` {#class_velopack_1_1_json_parser_1a5fc6e6a6440ef530ff909b7e87d8d15c} - -#### `public std::string `[`readWord`](#class_velopack_1_1_json_parser_1a7ed0c81806d36f272d31a8ed5ccc30fa)`()` {#class_velopack_1_1_json_parser_1a7ed0c81806d36f272d31a8ed5ccc30fa} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseNull`](#class_velopack_1_1_json_parser_1a05611896186a61087f0bf12dc25b6d1a)`()` {#class_velopack_1_1_json_parser_1a05611896186a61087f0bf12dc25b6d1a} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseBool`](#class_velopack_1_1_json_parser_1a2bb75c78af5d495ed258940b2585e1a9)`()` {#class_velopack_1_1_json_parser_1a2bb75c78af5d495ed258940b2585e1a9} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseNumber`](#class_velopack_1_1_json_parser_1a73e75b51dd5922e0440e176c406dce58)`()` {#class_velopack_1_1_json_parser_1a73e75b51dd5922e0440e176c406dce58} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseString`](#class_velopack_1_1_json_parser_1a2eb42a0ea6db17db808548c3cb474fb5)`()` {#class_velopack_1_1_json_parser_1a2eb42a0ea6db17db808548c3cb474fb5} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseObject`](#class_velopack_1_1_json_parser_1ac91bfabf5959f71ff5f068c9af912910)`()` {#class_velopack_1_1_json_parser_1ac91bfabf5959f71ff5f068c9af912910} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseArray`](#class_velopack_1_1_json_parser_1a7659a483c15b4c3f94f8ceb7a951a4c9)`()` {#class_velopack_1_1_json_parser_1a7659a483c15b4c3f94f8ceb7a951a4c9} - -#### `public std::shared_ptr< `[`JsonNode`](#class_velopack_1_1_json_node)` > `[`parseValue`](#class_velopack_1_1_json_parser_1a585c0e240fb52c3634c0df767fba8a74)`()` {#class_velopack_1_1_json_parser_1a585c0e240fb52c3634c0df767fba8a74} - -## class `Velopack::Platform` {#class_velopack_1_1_platform} - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- - -#### Members - -## class `Velopack::StringStream` {#class_velopack_1_1_string_stream} - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public `[`StringStream`](#class_velopack_1_1_string_stream_1a7881ca72f76249dc905e83208adba0ba)`() = default` | -`public void `[`clear`](#class_velopack_1_1_string_stream_1a25286df2ff42d828f4b7273bfcaa1ac1)`()` | -`public void `[`write`](#class_velopack_1_1_string_stream_1a74de3a26bf75823586ac4e0ce9e57f12)`(std::string s)` | -`public void `[`writeLine`](#class_velopack_1_1_string_stream_1afd73beeb474374ad0d9d5feca92d3dba)`(std::string s)` | -`public void `[`writeChar`](#class_velopack_1_1_string_stream_1ad025e53ac91373dbe983128c7cb62519)`(int c)` | -`public std::string `[`toString`](#class_velopack_1_1_string_stream_1ac9e5b82f2a193256d9e1ae94198d7f09)`() const` | - -#### Members - -#### `public `[`StringStream`](#class_velopack_1_1_string_stream_1a7881ca72f76249dc905e83208adba0ba)`() = default` {#class_velopack_1_1_string_stream_1a7881ca72f76249dc905e83208adba0ba} - -#### `public void `[`clear`](#class_velopack_1_1_string_stream_1a25286df2ff42d828f4b7273bfcaa1ac1)`()` {#class_velopack_1_1_string_stream_1a25286df2ff42d828f4b7273bfcaa1ac1} - -#### `public void `[`write`](#class_velopack_1_1_string_stream_1a74de3a26bf75823586ac4e0ce9e57f12)`(std::string s)` {#class_velopack_1_1_string_stream_1a74de3a26bf75823586ac4e0ce9e57f12} - -#### `public void `[`writeLine`](#class_velopack_1_1_string_stream_1afd73beeb474374ad0d9d5feca92d3dba)`(std::string s)` {#class_velopack_1_1_string_stream_1afd73beeb474374ad0d9d5feca92d3dba} - -#### `public void `[`writeChar`](#class_velopack_1_1_string_stream_1ad025e53ac91373dbe983128c7cb62519)`(int c)` {#class_velopack_1_1_string_stream_1ad025e53ac91373dbe983128c7cb62519} - -#### `public std::string `[`toString`](#class_velopack_1_1_string_stream_1ac9e5b82f2a193256d9e1ae94198d7f09)`() const` {#class_velopack_1_1_string_stream_1ac9e5b82f2a193256d9e1ae94198d7f09} - -## class `Velopack::UpdateInfo` {#class_velopack_1_1_update_info} - -Holds information about the current version and pending updates, such as how many there are, and access to release notes. - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public std::shared_ptr< `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` > `[`targetFullRelease`](#class_velopack_1_1_update_info_1ae48ce8dce0fbb3e509e4767e42bead66) | The available version that we are updating to. -`public bool `[`isDowngrade`](#class_velopack_1_1_update_info_1a593247b70ac2ec4cc12870a7fa544f21) | True if the update is a version downgrade or lateral move (such as when switching channels to the same version number). In this case, only full updates are allowed, and any local packages on disk newer than the downloaded version will be deleted. -`public `[`UpdateInfo`](#class_velopack_1_1_update_info_1ac124c42db882a61ca65f43a061fef338)`() = default` | - -#### Members - -#### `public std::shared_ptr< `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` > `[`targetFullRelease`](#class_velopack_1_1_update_info_1ae48ce8dce0fbb3e509e4767e42bead66) {#class_velopack_1_1_update_info_1ae48ce8dce0fbb3e509e4767e42bead66} - -The available version that we are updating to. - -#### `public bool `[`isDowngrade`](#class_velopack_1_1_update_info_1a593247b70ac2ec4cc12870a7fa544f21) {#class_velopack_1_1_update_info_1a593247b70ac2ec4cc12870a7fa544f21} - -True if the update is a version downgrade or lateral move (such as when switching channels to the same version number). In this case, only full updates are allowed, and any local packages on disk newer than the downloaded version will be deleted. - -#### `public `[`UpdateInfo`](#class_velopack_1_1_update_info_1ac124c42db882a61ca65f43a061fef338)`() = default` {#class_velopack_1_1_update_info_1ac124c42db882a61ca65f43a061fef338} - -## class `Velopack::UpdateManagerSync` {#class_velopack_1_1_update_manager_sync} - -This class is used to check for updates, download updates, and apply updates. It is a synchronous version of the UpdateManager class. This class is not recommended for use in GUI applications, as it will block the main thread, so you may want to use the async UpdateManager class instead, if it is supported for your programming language. - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public `[`UpdateManagerSync`](#class_velopack_1_1_update_manager_sync_1a0725c325f7dfd276d8f4320b7e6524ff)`() = default` | -`public void `[`setUrlOrPath`](#class_velopack_1_1_update_manager_sync_1ae56a277bbd4898786d73b61993640ecb)`(std::string urlOrPath)` | Set the URL or local file path to the update server. This is required before calling CheckForUpdates or DownloadUpdates. -`public void `[`setAllowDowngrade`](#class_velopack_1_1_update_manager_sync_1a85fc4369fadd9046d074feb2c86cfa4a)`(bool allowDowngrade)` | Allows UpdateManager to update to a version that's lower than the current version (i.e. downgrading). This could happen if a release has bugs and was retracted from the release feed, or if you're using ExplicitChannel to switch channels to another channel where the latest version on that channel is lower than the current version. -`public void `[`setExplicitChannel`](#class_velopack_1_1_update_manager_sync_1a0734f2d9c7aaf25c103fd5c5b469a212)`(std::string explicitChannel)` | This option should usually be left null. Overrides the default channel used to fetch updates. The default channel will be whatever channel was specified on the command line when building this release. For example, if the current release was packaged with 'channel beta', then the default channel will be 'beta'. This allows users to automatically receive updates from the same channel they installed from. This options allows you to explicitly switch channels, for example if the user wished to switch back to the 'stable' channel without having to reinstall the application. -`public bool `[`isInstalled`](#class_velopack_1_1_update_manager_sync_1a1c00744efbf661f9cbda40207fd8d670)`() const` | Returns true if the current app is installed, false otherwise. If the app is not installed, other functions in UpdateManager may throw exceptions, so you may want to check this before calling other functions. -`public std::string `[`getCurrentVersion`](#class_velopack_1_1_update_manager_sync_1a9b46af25127ae7267726cb8f48dc7c37)`() const` | Get the currently installed version of the application. If the application is not installed, this function will throw an exception. -`public std::shared_ptr< `[`UpdateInfo`](#class_velopack_1_1_update_info)` > `[`checkForUpdates`](#class_velopack_1_1_update_manager_sync_1a71e4aad5ba207741c10866e844341325)`() const` | This function will check for updates, and return information about the latest available release. This function runs synchronously and may take some time to complete, depending on the network speed and the number of updates available. -`public void `[`downloadUpdates`](#class_velopack_1_1_update_manager_sync_1abdbd2cf84cf64eed79f550e3277cdb6a)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toDownload) const` | Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock so may fail if there is already another update operation in progress. -`public void `[`applyUpdatesAndExit`](#class_velopack_1_1_update_manager_sync_1a5e1009cf9e2d7b852732e876f1c2188f)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply) const` | This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified restart arguments. If you need to save state or clean up, you should do that before calling this method. The user may be prompted during the update, if the update requires additional frameworks to be installed etc. -`public void `[`applyUpdatesAndRestart`](#class_velopack_1_1_update_manager_sync_1a69a296e31573c3173c418758d333dc51)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply,const std::vector< std::string > * restartArgs) const` | This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified restart arguments. If you need to save state or clean up, you should do that before calling this method. The user may be prompted during the update, if the update requires additional frameworks to be installed etc. -`public void `[`waitExitThenApplyUpdates`](#class_velopack_1_1_update_manager_sync_1aa6b15d1cf21d21aee749b38a224570c3)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply,bool silent,bool restart,const std::vector< std::string > * restartArgs) const` | This will launch the Velopack updater and tell it to wait for this program to exit gracefully. You should then clean up any state and exit your app. The updater will apply updates and then optionally restart your app. The updater will only wait for 60 seconds before giving up. -`protected std::vector< std::string > `[`getCurrentVersionCommand`](#class_velopack_1_1_update_manager_sync_1adb80fec8671f6ad9b4e3cf9fa5dbe458)`() const` | Returns the command line arguments to get the current version of the application. -`protected std::vector< std::string > `[`getCheckForUpdatesCommand`](#class_velopack_1_1_update_manager_sync_1a4d66d76a07cddda53ce3fd3a3306e6a9)`() const` | Returns the command line arguments to check for updates. -`protected std::vector< std::string > `[`getDownloadUpdatesCommand`](#class_velopack_1_1_update_manager_sync_1aa28503793c51523b98d5384ad3f6a28f)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toDownload) const` | Returns the command line arguments to download the specified update. -`protected std::vector< std::string > `[`getUpdateApplyCommand`](#class_velopack_1_1_update_manager_sync_1a47232672aab9d74f593a2bfe29f5eb3d)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply,bool silent,bool restart,bool wait,const std::vector< std::string > * restartArgs) const` | Returns the command line arguments to apply the specified update. -`protected std::string `[`getPackagesDir`](#class_velopack_1_1_update_manager_sync_1a8b0d484bcc50fc316ef662ecd5e09093)`() const` | Returns the path to the app's packages directory. This is where updates are downloaded to. - -#### Members - -#### `public `[`UpdateManagerSync`](#class_velopack_1_1_update_manager_sync_1a0725c325f7dfd276d8f4320b7e6524ff)`() = default` {#class_velopack_1_1_update_manager_sync_1a0725c325f7dfd276d8f4320b7e6524ff} - -#### `public void `[`setUrlOrPath`](#class_velopack_1_1_update_manager_sync_1ae56a277bbd4898786d73b61993640ecb)`(std::string urlOrPath)` {#class_velopack_1_1_update_manager_sync_1ae56a277bbd4898786d73b61993640ecb} - -Set the URL or local file path to the update server. This is required before calling CheckForUpdates or DownloadUpdates. - -#### `public void `[`setAllowDowngrade`](#class_velopack_1_1_update_manager_sync_1a85fc4369fadd9046d074feb2c86cfa4a)`(bool allowDowngrade)` {#class_velopack_1_1_update_manager_sync_1a85fc4369fadd9046d074feb2c86cfa4a} - -Allows UpdateManager to update to a version that's lower than the current version (i.e. downgrading). This could happen if a release has bugs and was retracted from the release feed, or if you're using ExplicitChannel to switch channels to another channel where the latest version on that channel is lower than the current version. - -#### `public void `[`setExplicitChannel`](#class_velopack_1_1_update_manager_sync_1a0734f2d9c7aaf25c103fd5c5b469a212)`(std::string explicitChannel)` {#class_velopack_1_1_update_manager_sync_1a0734f2d9c7aaf25c103fd5c5b469a212} - -This option should usually be left null. Overrides the default channel used to fetch updates. The default channel will be whatever channel was specified on the command line when building this release. For example, if the current release was packaged with 'channel beta', then the default channel will be 'beta'. This allows users to automatically receive updates from the same channel they installed from. This options allows you to explicitly switch channels, for example if the user wished to switch back to the 'stable' channel without having to reinstall the application. - -#### `public bool `[`isInstalled`](#class_velopack_1_1_update_manager_sync_1a1c00744efbf661f9cbda40207fd8d670)`() const` {#class_velopack_1_1_update_manager_sync_1a1c00744efbf661f9cbda40207fd8d670} - -Returns true if the current app is installed, false otherwise. If the app is not installed, other functions in UpdateManager may throw exceptions, so you may want to check this before calling other functions. - -#### `public std::string `[`getCurrentVersion`](#class_velopack_1_1_update_manager_sync_1a9b46af25127ae7267726cb8f48dc7c37)`() const` {#class_velopack_1_1_update_manager_sync_1a9b46af25127ae7267726cb8f48dc7c37} - -Get the currently installed version of the application. If the application is not installed, this function will throw an exception. - -#### `public std::shared_ptr< `[`UpdateInfo`](#class_velopack_1_1_update_info)` > `[`checkForUpdates`](#class_velopack_1_1_update_manager_sync_1a71e4aad5ba207741c10866e844341325)`() const` {#class_velopack_1_1_update_manager_sync_1a71e4aad5ba207741c10866e844341325} - -This function will check for updates, and return information about the latest available release. This function runs synchronously and may take some time to complete, depending on the network speed and the number of updates available. - -#### `public void `[`downloadUpdates`](#class_velopack_1_1_update_manager_sync_1abdbd2cf84cf64eed79f550e3277cdb6a)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toDownload) const` {#class_velopack_1_1_update_manager_sync_1abdbd2cf84cf64eed79f550e3277cdb6a} - -Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock so may fail if there is already another update operation in progress. - -#### `public void `[`applyUpdatesAndExit`](#class_velopack_1_1_update_manager_sync_1a5e1009cf9e2d7b852732e876f1c2188f)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply) const` {#class_velopack_1_1_update_manager_sync_1a5e1009cf9e2d7b852732e876f1c2188f} - -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified restart arguments. If you need to save state or clean up, you should do that before calling this method. The user may be prompted during the update, if the update requires additional frameworks to be installed etc. - -#### `public void `[`applyUpdatesAndRestart`](#class_velopack_1_1_update_manager_sync_1a69a296e31573c3173c418758d333dc51)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply,const std::vector< std::string > * restartArgs) const` {#class_velopack_1_1_update_manager_sync_1a69a296e31573c3173c418758d333dc51} - -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified restart arguments. If you need to save state or clean up, you should do that before calling this method. The user may be prompted during the update, if the update requires additional frameworks to be installed etc. - -#### `public void `[`waitExitThenApplyUpdates`](#class_velopack_1_1_update_manager_sync_1aa6b15d1cf21d21aee749b38a224570c3)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply,bool silent,bool restart,const std::vector< std::string > * restartArgs) const` {#class_velopack_1_1_update_manager_sync_1aa6b15d1cf21d21aee749b38a224570c3} - -This will launch the Velopack updater and tell it to wait for this program to exit gracefully. You should then clean up any state and exit your app. The updater will apply updates and then optionally restart your app. The updater will only wait for 60 seconds before giving up. - -#### `protected std::vector< std::string > `[`getCurrentVersionCommand`](#class_velopack_1_1_update_manager_sync_1adb80fec8671f6ad9b4e3cf9fa5dbe458)`() const` {#class_velopack_1_1_update_manager_sync_1adb80fec8671f6ad9b4e3cf9fa5dbe458} - -Returns the command line arguments to get the current version of the application. - -#### `protected std::vector< std::string > `[`getCheckForUpdatesCommand`](#class_velopack_1_1_update_manager_sync_1a4d66d76a07cddda53ce3fd3a3306e6a9)`() const` {#class_velopack_1_1_update_manager_sync_1a4d66d76a07cddda53ce3fd3a3306e6a9} - -Returns the command line arguments to check for updates. - -#### `protected std::vector< std::string > `[`getDownloadUpdatesCommand`](#class_velopack_1_1_update_manager_sync_1aa28503793c51523b98d5384ad3f6a28f)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toDownload) const` {#class_velopack_1_1_update_manager_sync_1aa28503793c51523b98d5384ad3f6a28f} - -Returns the command line arguments to download the specified update. - -#### `protected std::vector< std::string > `[`getUpdateApplyCommand`](#class_velopack_1_1_update_manager_sync_1a47232672aab9d74f593a2bfe29f5eb3d)`(const `[`VelopackAsset`](#class_velopack_1_1_velopack_asset)` * toApply,bool silent,bool restart,bool wait,const std::vector< std::string > * restartArgs) const` {#class_velopack_1_1_update_manager_sync_1a47232672aab9d74f593a2bfe29f5eb3d} - -Returns the command line arguments to apply the specified update. - -#### `protected std::string `[`getPackagesDir`](#class_velopack_1_1_update_manager_sync_1a8b0d484bcc50fc316ef662ecd5e09093)`() const` {#class_velopack_1_1_update_manager_sync_1a8b0d484bcc50fc316ef662ecd5e09093} - -Returns the path to the app's packages directory. This is where updates are downloaded to. - -## class `Velopack::VelopackAsset` {#class_velopack_1_1_velopack_asset} - -An individual Velopack asset, could refer to an asset on-disk or in a remote package feed. - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public std::string `[`packageId`](#class_velopack_1_1_velopack_asset_1a644d04e0fcd56f7639db2d912a575d72) | The name or Id of the package containing this release. -`public std::string `[`version`](#class_velopack_1_1_velopack_asset_1a7afd3e784db4b8141e1abe936d91ed11) | The version of this release. -`public VelopackAssetType `[`type`](#class_velopack_1_1_velopack_asset_1a3bbb06f6e4d755e2a84e1df058e0aadd) | The type of asset (eg. full or delta). -`public std::string `[`fileName`](#class_velopack_1_1_velopack_asset_1ae1d567970986a7d24cfea97fe6834f1a) | The filename of the update package containing this release. -`public std::string `[`sha1`](#class_velopack_1_1_velopack_asset_1afe7b08c38ffad131e0d1edbc12847373) | The SHA1 checksum of the update package containing this release. -`public int64_t `[`size`](#class_velopack_1_1_velopack_asset_1a6ca5d1466adf5159e95f9656c62bc92a) | The size in bytes of the update package containing this release. -`public std::string `[`notesMarkdown`](#class_velopack_1_1_velopack_asset_1a3b904d81dda60c6953fedc54d058da9e) | The release notes in markdown format, as passed to Velopack when packaging the release. -`public std::string `[`notesHTML`](#class_velopack_1_1_velopack_asset_1aa8d00f3e2a6d7735a37663e7531791a1) | The release notes in HTML format, transformed from Markdown when packaging the release. -`public `[`VelopackAsset`](#class_velopack_1_1_velopack_asset_1a8185777fc17f66b0258e949c3e421231)`() = default` | - -#### Members - -#### `public std::string `[`packageId`](#class_velopack_1_1_velopack_asset_1a644d04e0fcd56f7639db2d912a575d72) {#class_velopack_1_1_velopack_asset_1a644d04e0fcd56f7639db2d912a575d72} - -The name or Id of the package containing this release. - -#### `public std::string `[`version`](#class_velopack_1_1_velopack_asset_1a7afd3e784db4b8141e1abe936d91ed11) {#class_velopack_1_1_velopack_asset_1a7afd3e784db4b8141e1abe936d91ed11} - -The version of this release. - -#### `public VelopackAssetType `[`type`](#class_velopack_1_1_velopack_asset_1a3bbb06f6e4d755e2a84e1df058e0aadd) {#class_velopack_1_1_velopack_asset_1a3bbb06f6e4d755e2a84e1df058e0aadd} - -The type of asset (eg. full or delta). - -#### `public std::string `[`fileName`](#class_velopack_1_1_velopack_asset_1ae1d567970986a7d24cfea97fe6834f1a) {#class_velopack_1_1_velopack_asset_1ae1d567970986a7d24cfea97fe6834f1a} - -The filename of the update package containing this release. - -#### `public std::string `[`sha1`](#class_velopack_1_1_velopack_asset_1afe7b08c38ffad131e0d1edbc12847373) {#class_velopack_1_1_velopack_asset_1afe7b08c38ffad131e0d1edbc12847373} - -The SHA1 checksum of the update package containing this release. - -#### `public int64_t `[`size`](#class_velopack_1_1_velopack_asset_1a6ca5d1466adf5159e95f9656c62bc92a) {#class_velopack_1_1_velopack_asset_1a6ca5d1466adf5159e95f9656c62bc92a} - -The size in bytes of the update package containing this release. - -#### `public std::string `[`notesMarkdown`](#class_velopack_1_1_velopack_asset_1a3b904d81dda60c6953fedc54d058da9e) {#class_velopack_1_1_velopack_asset_1a3b904d81dda60c6953fedc54d058da9e} - -The release notes in markdown format, as passed to Velopack when packaging the release. - -#### `public std::string `[`notesHTML`](#class_velopack_1_1_velopack_asset_1aa8d00f3e2a6d7735a37663e7531791a1) {#class_velopack_1_1_velopack_asset_1aa8d00f3e2a6d7735a37663e7531791a1} - -The release notes in HTML format, transformed from Markdown when packaging the release. - -#### `public `[`VelopackAsset`](#class_velopack_1_1_velopack_asset_1a8185777fc17f66b0258e949c3e421231)`() = default` {#class_velopack_1_1_velopack_asset_1a8185777fc17f66b0258e949c3e421231} - -## struct `subprocess_s` {#structsubprocess__s} - -#### Summary - - Members | Descriptions ---------------------------------|--------------------------------------------- -`public FILE * `[`stdin_file`](#structsubprocess__s_1ada32f1e1e07a418e4a4d7d57677e44f0) | -`public FILE * `[`stdout_file`](#structsubprocess__s_1a49ea739e96d4555a1de30358de62034c) | -`public FILE * `[`stderr_file`](#structsubprocess__s_1ac44a1727285472c541281bada32db7ea) | -`public pid_t `[`child`](#structsubprocess__s_1a30b0a7616f06a6374de9c52268e6c9e3) | -`public int `[`return_status`](#structsubprocess__s_1a4a6027dbf0c75e5adee516ddf0c99860) | -`public subprocess_size_t `[`alive`](#structsubprocess__s_1ae931c423d39d981ab8b10cbdd49ae5ad) | - -#### Members - -#### `public FILE * `[`stdin_file`](#structsubprocess__s_1ada32f1e1e07a418e4a4d7d57677e44f0) {#structsubprocess__s_1ada32f1e1e07a418e4a4d7d57677e44f0} - -#### `public FILE * `[`stdout_file`](#structsubprocess__s_1a49ea739e96d4555a1de30358de62034c) {#structsubprocess__s_1a49ea739e96d4555a1de30358de62034c} - -#### `public FILE * `[`stderr_file`](#structsubprocess__s_1ac44a1727285472c541281bada32db7ea) {#structsubprocess__s_1ac44a1727285472c541281bada32db7ea} - -#### `public pid_t `[`child`](#structsubprocess__s_1a30b0a7616f06a6374de9c52268e6c9e3) {#structsubprocess__s_1a30b0a7616f06a6374de9c52268e6c9e3} - -#### `public int `[`return_status`](#structsubprocess__s_1a4a6027dbf0c75e5adee516ddf0c99860) {#structsubprocess__s_1a4a6027dbf0c75e5adee516ddf0c99860} - -#### `public subprocess_size_t `[`alive`](#structsubprocess__s_1ae931c423d39d981ab8b10cbdd49ae5ad) {#structsubprocess__s_1ae931c423d39d981ab8b10cbdd49ae5ad} - -Generated by [Moxygen](https://sourcey.com/moxygen) \ No newline at end of file diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/ChecksumFailedException.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/ChecksumFailedException.md deleted file mode 100644 index 590eee3..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/ChecksumFailedException.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Class ChecksumFailedException -sidebar_label: ChecksumFailedException -description: "Represents an error that occurs when a package does not match it's expected SHA checksum" ---- -# Class ChecksumFailedException -Represents an error that occurs when a package does not match it's expected SHA checksum - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Compression/ChecksumFailedException.cs#L9) -```csharp title="Declaration" -public class ChecksumFailedException : Exception, ISerializable, _Exception -``` -**Inheritance:** `System.Object` -> `System.Exception` - -**Implements:** -`System.Runtime.Serialization.ISerializable`, `System.Runtime.InteropServices._Exception` - -## Properties -### FilePath -The filename of the package which failed validation -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Compression/ChecksumFailedException.cs#L15) -```csharp title="Declaration" -public string FilePath { get; } -``` - -## Implements - -* `System.Runtime.Serialization.ISerializable` -* `System.Runtime.InteropServices._Exception` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/Velopack.Compression.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/Velopack.Compression.md deleted file mode 100644 index 70d33ef..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Compression/Velopack.Compression.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Namespace Velopack.Compression -sidebar_label: Velopack.Compression ---- -# Namespace Velopack.Compression -## Classes -### [ChecksumFailedException](../Velopack.Compression/ChecksumFailedException) -Represents an error that occurs when a package does not match it's expected SHA checksum diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/IVelopackLocator.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/IVelopackLocator.md deleted file mode 100644 index 4bb7bf6..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/IVelopackLocator.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: Interface IVelopackLocator -sidebar_label: IVelopackLocator -description: "An interface describing where Velopack can find key folders and files." ---- -# Interface IVelopackLocator -An interface describing where Velopack can find key folders and files. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L10) -```csharp title="Declaration" -public interface IVelopackLocator -``` -## Properties -### AppId -The unique application Id. This is used in various app paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L13) -```csharp title="Declaration" -string? AppId { get; } -``` -### RootAppDir -The root directory of the application. On Windows, this folder contains all -the application files, but that may not be the case on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L19) -```csharp title="Declaration" -string? RootAppDir { get; } -``` -### PackagesDir -The directory in which nupkg files are stored for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L22) -```csharp title="Declaration" -string? PackagesDir { get; } -``` -### AppContentDir -The directory in which versioned application files are stored. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L25) -```csharp title="Declaration" -string? AppContentDir { get; } -``` -### AppTempDir -The temporary directory for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L28) -```csharp title="Declaration" -string? AppTempDir { get; } -``` -### UpdateExePath -The path to the current Update.exe or similar on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L31) -```csharp title="Declaration" -string? UpdateExePath { get; } -``` -### CurrentlyInstalledVersion -The currently installed version of the application, or null if the app is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L34) -```csharp title="Declaration" -SemanticVersion? CurrentlyInstalledVersion { get; } -``` -### ThisExeRelativePath -The path from [Velopack.Locators.IVelopackLocator.AppContentDir](../Velopack.Locators/IVelopackLocator#appcontentdir) to this executable. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L37) -```csharp title="Declaration" -string? ThisExeRelativePath { get; } -``` -### Channel -The release channel this package was built for. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L40) -```csharp title="Declaration" -string? Channel { get; } -``` -## Methods -### GetLocalPackages() -Finds .nupkg files in the PackagesDir and returns a list of ReleaseEntryName objects. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L45) -```csharp title="Declaration" -List GetLocalPackages() -``` - -##### Returns - -`System.Collections.Generic.List` -### GetLatestLocalFullPackage() -Finds latest .nupkg file in the PackagesDir or null if not found. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L50) -```csharp title="Declaration" -VelopackAsset? GetLatestLocalFullPackage() -``` - -##### Returns - -[Velopack.VelopackAsset](../Velopack/VelopackAsset) -### GetOrCreateStagedUserId() -Unique identifier for this user which is used to calculate whether this user is eligible for -staged roll outs. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/IVelopackLocator.cs#L56) -```csharp title="Declaration" -Guid? GetOrCreateStagedUserId() -``` - -##### Returns - -`System.Nullable` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/LinuxVelopackLocator.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/LinuxVelopackLocator.md deleted file mode 100644 index c7c3511..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/LinuxVelopackLocator.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Class LinuxVelopackLocator -sidebar_label: LinuxVelopackLocator -description: "The default for OSX. All application files will remain in the '.app'. -All additional files (log, etc) will be placed in a temporary directory." ---- -# Class LinuxVelopackLocator -The default for OSX. All application files will remain in the '.app'. -All additional files (log, etc) will be placed in a temporary directory. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L14) -```csharp title="Declaration" -public class LinuxVelopackLocator : VelopackLocator, IVelopackLocator -``` -**Inheritance:** `System.Object` -> [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator) - -**Implements:** -[Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) - -## Properties -### AppId -The unique application Id. This is used in various app paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L18) -```csharp title="Declaration" -public override string? AppId { get; } -``` -### RootAppDir -The root directory of the application. On Windows, this folder contains all -the application files, but that may not be the case on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L21) -```csharp title="Declaration" -public override string? RootAppDir { get; } -``` -### UpdateExePath -The path to the current Update.exe or similar on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L24) -```csharp title="Declaration" -public override string? UpdateExePath { get; } -``` -### CurrentlyInstalledVersion -The currently installed version of the application, or null if the app is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L27) -```csharp title="Declaration" -public override SemanticVersion? CurrentlyInstalledVersion { get; } -``` -### AppContentDir -The directory in which versioned application files are stored. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L30) -```csharp title="Declaration" -public override string? AppContentDir { get; } -``` -### Channel -The release channel this package was built for. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L33) -```csharp title="Declaration" -public override string? Channel { get; } -``` -### AppTempDir -The temporary directory for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L36) -```csharp title="Declaration" -public override string? AppTempDir { get; } -``` -### PackagesDir -The directory in which nupkg files are stored for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L39) -```csharp title="Declaration" -public override string? PackagesDir { get; } -``` -### PersistentTempDir -/var/tmp/{velopack}/{appid}, for storing app specific files which need to be preserved. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L42) -```csharp title="Declaration" -public string? PersistentTempDir { get; } -``` -### PersistentVelopackDir -A pointer to /var/tmp/{velopack}, a location on linux which is semi-persistent. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L45) -```csharp title="Declaration" -public string? PersistentVelopackDir { get; } -``` -### AppImagePath -File path of the .AppImage which mounted and ran this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/LinuxVelopackLocator.cs#L48) -```csharp title="Declaration" -public string? AppImagePath { get; } -``` - -## Implements - -* [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/OsxVelopackLocator.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/OsxVelopackLocator.md deleted file mode 100644 index 6cb13de..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/OsxVelopackLocator.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: Class OsxVelopackLocator -sidebar_label: OsxVelopackLocator -description: "The default for OSX. All application files will remain in the '.app'. -All additional files (log, etc) will be placed in a temporary directory." ---- -# Class OsxVelopackLocator -The default for OSX. All application files will remain in the '.app'. -All additional files (log, etc) will be placed in a temporary directory. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L14) -```csharp title="Declaration" -public class OsxVelopackLocator : VelopackLocator, IVelopackLocator -``` -**Inheritance:** `System.Object` -> [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator) - -**Implements:** -[Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) - -## Properties -### AppId -The unique application Id. This is used in various app paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L18) -```csharp title="Declaration" -public override string? AppId { get; } -``` -### RootAppDir -The root directory of the application. On Windows, this folder contains all -the application files, but that may not be the case on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L21) -```csharp title="Declaration" -public override string? RootAppDir { get; } -``` -### UpdateExePath -The path to the current Update.exe or similar on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L24) -```csharp title="Declaration" -public override string? UpdateExePath { get; } -``` -### CurrentlyInstalledVersion -The currently installed version of the application, or null if the app is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L27) -```csharp title="Declaration" -public override SemanticVersion? CurrentlyInstalledVersion { get; } -``` -### AppContentDir -The directory in which versioned application files are stored. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L30) -```csharp title="Declaration" -public override string? AppContentDir { get; } -``` -### AppTempDir -The temporary directory for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L33) -```csharp title="Declaration" -public override string? AppTempDir { get; } -``` -### PackagesDir -The directory in which nupkg files are stored for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L36) -```csharp title="Declaration" -public override string? PackagesDir { get; } -``` -### Channel -The release channel this package was built for. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/OsxVelopackLocator.cs#L39) -```csharp title="Declaration" -public override string? Channel { get; } -``` - -## Implements - -* [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/TestVelopackLocator.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/TestVelopackLocator.md deleted file mode 100644 index 28055a7..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/TestVelopackLocator.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: Class TestVelopackLocator -sidebar_label: TestVelopackLocator -description: "Provides a mock / test implementation of [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator). This can be used to verify that -your application is able to find and prepare updates from your chosen update source without actually -having an installed application. This could be used in a CI/CD pipeline, or unit tests etc." ---- -# Class TestVelopackLocator -Provides a mock / test implementation of [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator). This can be used to verify that -your application is able to find and prepare updates from your chosen update source without actually -having an installed application. This could be used in a CI/CD pipeline, or unit tests etc. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L13) -```csharp title="Declaration" -public class TestVelopackLocator : VelopackLocator, IVelopackLocator -``` -**Inheritance:** `System.Object` -> [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator) - -**Implements:** -[Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) - -## Properties -### AppId -The unique application Id. This is used in various app paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L17) -```csharp title="Declaration" -public override string? AppId { get; } -``` -### RootAppDir -The root directory of the application. On Windows, this folder contains all -the application files, but that may not be the case on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L27) -```csharp title="Declaration" -public override string? RootAppDir { get; } -``` -### PackagesDir -The directory in which nupkg files are stored for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L37) -```csharp title="Declaration" -public override string? PackagesDir { get; } -``` -### UpdateExePath -The path to the current Update.exe or similar on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L47) -```csharp title="Declaration" -public override string? UpdateExePath { get; } -``` -### CurrentlyInstalledVersion -The currently installed version of the application, or null if the app is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L57) -```csharp title="Declaration" -public override SemanticVersion? CurrentlyInstalledVersion { get; } -``` -### AppContentDir -The directory in which versioned application files are stored. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L67) -```csharp title="Declaration" -public override string? AppContentDir { get; } -``` -### Channel -The release channel this package was built for. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L77) -```csharp title="Declaration" -public override string? Channel { get; } -``` -## Methods -### GetLatestLocalFullPackage() -Finds latest .nupkg file in the PackagesDir or null if not found. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/TestVelopackLocator.cs#L84) -```csharp title="Declaration" -public override VelopackAsset? GetLatestLocalFullPackage() -``` - -##### Returns - -[Velopack.VelopackAsset](../Velopack/VelopackAsset) - -## Implements - -* [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/Velopack.Locators.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/Velopack.Locators.md deleted file mode 100644 index 71cef3e..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/Velopack.Locators.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Namespace Velopack.Locators -sidebar_label: Velopack.Locators ---- -# Namespace Velopack.Locators -## Classes -### [LinuxVelopackLocator](../Velopack.Locators/LinuxVelopackLocator) -The default for OSX. All application files will remain in the '.app'. -All additional files (log, etc) will be placed in a temporary directory. -### [OsxVelopackLocator](../Velopack.Locators/OsxVelopackLocator) -The default for OSX. All application files will remain in the '.app'. -All additional files (log, etc) will be placed in a temporary directory. -### [TestVelopackLocator](../Velopack.Locators/TestVelopackLocator) -Provides a mock / test implementation of [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator). This can be used to verify that -your application is able to find and prepare updates from your chosen update source without actually -having an installed application. This could be used in a CI/CD pipeline, or unit tests etc. -### [VelopackLocator](../Velopack.Locators/VelopackLocator) -A base class describing where Velopack can find key folders and files. -### [WindowsVelopackLocator](../Velopack.Locators/WindowsVelopackLocator) -An implementation for Windows which uses the default paths. -## Interfaces -### [IVelopackLocator](../Velopack.Locators/IVelopackLocator) -An interface describing where Velopack can find key folders and files. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/VelopackLocator.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/VelopackLocator.md deleted file mode 100644 index 3770641..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/VelopackLocator.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: Class VelopackLocator -sidebar_label: VelopackLocator -description: "A base class describing where Velopack can find key folders and files." ---- -# Class VelopackLocator -A base class describing where Velopack can find key folders and files. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L15) -```csharp title="Declaration" -public abstract class VelopackLocator : IVelopackLocator -``` -**Derived:** -[Velopack.Locators.LinuxVelopackLocator](../Velopack.Locators/LinuxVelopackLocator), [Velopack.Locators.OsxVelopackLocator](../Velopack.Locators/OsxVelopackLocator), [Velopack.Locators.TestVelopackLocator](../Velopack.Locators/TestVelopackLocator), [Velopack.Locators.WindowsVelopackLocator](../Velopack.Locators/WindowsVelopackLocator) - -**Implements:** -[Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) - -## Properties -### AppId -The unique application Id. This is used in various app paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L42) -```csharp title="Declaration" -public abstract string? AppId { get; } -``` -### RootAppDir -The root directory of the application. On Windows, this folder contains all -the application files, but that may not be the case on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L45) -```csharp title="Declaration" -public abstract string? RootAppDir { get; } -``` -### PackagesDir -The directory in which nupkg files are stored for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L48) -```csharp title="Declaration" -public abstract string? PackagesDir { get; } -``` -### AppTempDir -The temporary directory for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L51) -```csharp title="Declaration" -public virtual string? AppTempDir { get; } -``` -### UpdateExePath -The path to the current Update.exe or similar on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L54) -```csharp title="Declaration" -public abstract string? UpdateExePath { get; } -``` -### AppContentDir -The directory in which versioned application files are stored. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L57) -```csharp title="Declaration" -public abstract string? AppContentDir { get; } -``` -### Channel -The release channel this package was built for. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L60) -```csharp title="Declaration" -public abstract string? Channel { get; } -``` -### ThisExeRelativePath -The path from [Velopack.Locators.IVelopackLocator.AppContentDir](../Velopack.Locators/IVelopackLocator#appcontentdir) to this executable. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L63) -```csharp title="Declaration" -public virtual string? ThisExeRelativePath { get; } -``` -### CurrentlyInstalledVersion -The currently installed version of the application, or null if the app is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L76) -```csharp title="Declaration" -public abstract SemanticVersion? CurrentlyInstalledVersion { get; } -``` -### Log -The log interface to use for diagnostic messages. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L79) -```csharp title="Declaration" -protected ILogger Log { get; } -``` -## Methods -### GetDefault(ILogger?) -Auto-detect the platform from the current operating system. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L22) -```csharp title="Declaration" -public static VelopackLocator GetDefault(ILogger? logger) -``` - -##### Returns - -[Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | - -### GetLocalPackages() -Finds .nupkg files in the PackagesDir and returns a list of ReleaseEntryName objects. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L88) -```csharp title="Declaration" -public virtual List GetLocalPackages() -``` - -##### Returns - -`System.Collections.Generic.List` -### GetLatestLocalFullPackage() -Finds latest .nupkg file in the PackagesDir or null if not found. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L115) -```csharp title="Declaration" -public virtual VelopackAsset? GetLatestLocalFullPackage() -``` - -##### Returns - -[Velopack.VelopackAsset](../Velopack/VelopackAsset) -### CreateSubDirIfDoesNotExist(string?, string?) -Given a base dir and a directory name, will create a new sub directory of that name. -Will return null if baseDir is null, or if baseDir does not exist. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L127) -```csharp title="Declaration" -protected static string? CreateSubDirIfDoesNotExist(string? baseDir, string? newDir) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *baseDir* | -| `System.String` | *newDir* | - -### GetOrCreateStagedUserId() -Unique identifier for this user which is used to calculate whether this user is eligible for -staged roll outs. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/VelopackLocator.cs#L138) -```csharp title="Declaration" -public Guid? GetOrCreateStagedUserId() -``` - -##### Returns - -`System.Nullable` - -## Implements - -* [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/WindowsVelopackLocator.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/WindowsVelopackLocator.md deleted file mode 100644 index 447e77f..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Locators/WindowsVelopackLocator.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: Class WindowsVelopackLocator -sidebar_label: WindowsVelopackLocator -description: "An implementation for Windows which uses the default paths." ---- -# Class WindowsVelopackLocator -An implementation for Windows which uses the default paths. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L13) -```csharp title="Declaration" -public class WindowsVelopackLocator : VelopackLocator, IVelopackLocator -``` -**Inheritance:** `System.Object` -> [Velopack.Locators.VelopackLocator](../Velopack.Locators/VelopackLocator) - -**Implements:** -[Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) - -## Properties -### AppId -The unique application Id. This is used in various app paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L17) -```csharp title="Declaration" -public override string? AppId { get; } -``` -### RootAppDir -The root directory of the application. On Windows, this folder contains all -the application files, but that may not be the case on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L20) -```csharp title="Declaration" -public override string? RootAppDir { get; } -``` -### UpdateExePath -The path to the current Update.exe or similar on other operating systems. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L23) -```csharp title="Declaration" -public override string? UpdateExePath { get; } -``` -### AppContentDir -The directory in which versioned application files are stored. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L26) -```csharp title="Declaration" -public override string? AppContentDir { get; } -``` -### CurrentlyInstalledVersion -The currently installed version of the application, or null if the app is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L29) -```csharp title="Declaration" -public override SemanticVersion? CurrentlyInstalledVersion { get; } -``` -### PackagesDir -The directory in which nupkg files are stored for this application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L32) -```csharp title="Declaration" -public override string? PackagesDir { get; } -``` -### Channel -The release channel this package was built for. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Locators/WindowsVelopackLocator.cs#L35) -```csharp title="Declaration" -public override string? Channel { get; } -``` - -## Implements - -* [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/PackageManifest.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/PackageManifest.md deleted file mode 100644 index fb6bf8d..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/PackageManifest.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: Class PackageManifest -sidebar_label: PackageManifest ---- -# Class PackageManifest - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L11) -```csharp title="Declaration" -public class PackageManifest -``` -**Derived:** -[Velopack.NuGet.ZipPackage](../Velopack.NuGet/ZipPackage) - -## Properties -### ProductName - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L13) -```csharp title="Declaration" -public string? ProductName { get; } -``` -### ProductDescription - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L14) -```csharp title="Declaration" -public string? ProductDescription { get; } -``` -### ProductCompany - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L15) -```csharp title="Declaration" -public string? ProductCompany { get; } -``` -### ProductCopyright - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L16) -```csharp title="Declaration" -public string? ProductCopyright { get; } -``` -### Id - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L17) -```csharp title="Declaration" -public string? Id { get; } -``` -### Version - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L18) -```csharp title="Declaration" -public SemanticVersion? Version { get; } -``` -### ProjectUrl - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L19) -```csharp title="Declaration" -public Uri? ProjectUrl { get; } -``` -### ReleaseNotes - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L20) -```csharp title="Declaration" -public string? ReleaseNotes { get; } -``` -### ReleaseNotesHtml - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L21) -```csharp title="Declaration" -public string? ReleaseNotesHtml { get; } -``` -### IconUrl - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L22) -```csharp title="Declaration" -public Uri? IconUrl { get; } -``` -### Language - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L23) -```csharp title="Declaration" -public string? Language { get; } -``` -### Channel - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L24) -```csharp title="Declaration" -public string? Channel { get; } -``` -### Description - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L25) -```csharp title="Declaration" -public string? Description { get; } -``` -### Owners - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L26) -```csharp title="Declaration" -public string? Owners { get; } -``` -### Title - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L27) -```csharp title="Declaration" -public string? Title { get; } -``` -### Summary - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L28) -```csharp title="Declaration" -public string? Summary { get; } -``` -### Copyright - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L29) -```csharp title="Declaration" -public string? Copyright { get; } -``` -### Authors - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L30) -```csharp title="Declaration" -public IEnumerable Authors { get; } -``` -### RuntimeDependencies - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L31) -```csharp title="Declaration" -public IEnumerable RuntimeDependencies { get; } -``` -## Methods -### ParseFromFile(string) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L37) -```csharp title="Declaration" -public static PackageManifest ParseFromFile(string filePath) -``` - -##### Returns - -[Velopack.NuGet.PackageManifest](../Velopack.NuGet/PackageManifest) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *filePath* | - -### TryParseFromFile(string, out PackageManifest) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L46) -```csharp title="Declaration" -public static bool TryParseFromFile(string filePath, out PackageManifest manifest) -``` - -##### Returns - -`System.Boolean` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *filePath* | -| [Velopack.NuGet.PackageManifest](../Velopack.NuGet/PackageManifest) | *manifest* | - -### ReadManifest(Stream) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L57) -```csharp title="Declaration" -protected void ReadManifest(Stream manifestStream) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.IO.Stream` | *manifestStream* | - -### IsPackageFile(string) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/PackageManifest.cs#L143) -```csharp title="Declaration" -protected bool IsPackageFile(string partPath) -``` - -##### Returns - -`System.Boolean` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *partPath* | - diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/Velopack.NuGet.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/Velopack.NuGet.md deleted file mode 100644 index 306de1c..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/Velopack.NuGet.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Namespace Velopack.NuGet -sidebar_label: Velopack.NuGet ---- -# Namespace Velopack.NuGet -## Classes -### [PackageManifest](../Velopack.NuGet/PackageManifest) - -### [ZipPackage](../Velopack.NuGet/ZipPackage) - -### [ZipPackageFile](../Velopack.NuGet/ZipPackageFile) - diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackage.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackage.md deleted file mode 100644 index 92c79b2..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackage.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Class ZipPackage -sidebar_label: ZipPackage ---- -# Class ZipPackage - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackage.cs#L10) -```csharp title="Declaration" -public class ZipPackage : PackageManifest -``` -**Inheritance:** `System.Object` -> [Velopack.NuGet.PackageManifest](../Velopack.NuGet/PackageManifest) - -## Properties -### Files - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackage.cs#L12) -```csharp title="Declaration" -public IEnumerable Files { get; } -``` -### UpdateExeBytes - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackage.cs#L14) -```csharp title="Declaration" -public byte[]? UpdateExeBytes { get; } -``` -### LoadedFromPath - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackage.cs#L16) -```csharp title="Declaration" -public string LoadedFromPath { get; } -``` -## Methods -### ReadFile(ZipArchive, Func<ZipArchiveEntry, bool>) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackage.cs#L33) -```csharp title="Declaration" -protected byte[]? ReadFile(ZipArchive archive, Func predicate) -``` - -##### Returns - -`System.Byte[]` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.IO.Compression.ZipArchive` | *archive* | -| `System.Func` | *predicate* | - diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackageFile.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackageFile.md deleted file mode 100644 index 55b3735..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.NuGet/ZipPackageFile.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -title: Class ZipPackageFile -sidebar_label: ZipPackageFile ---- -# Class ZipPackageFile - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L6) -```csharp title="Declaration" -public class ZipPackageFile : IEquatable -``` -**Implements:** -`System.IEquatable` - -## Properties -### Key - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L8) -```csharp title="Declaration" -public Uri Key { get; } -``` -### EffectivePath - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L9) -```csharp title="Declaration" -public string EffectivePath { get; } -``` -### TargetFramework - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L10) -```csharp title="Declaration" -public string TargetFramework { get; } -``` -### Path - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L11) -```csharp title="Declaration" -public string Path { get; } -``` -## Methods -### IsLibFile() - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L21) -```csharp title="Declaration" -public bool IsLibFile() -``` - -##### Returns - -`System.Boolean` -### IsContentFile() - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L22) -```csharp title="Declaration" -public bool IsContentFile() -``` - -##### Returns - -`System.Boolean` -### IsFileInTopDirectory(string) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L24) -```csharp title="Declaration" -public bool IsFileInTopDirectory(string directory) -``` - -##### Returns - -`System.Boolean` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *directory* | - -### ToString() -Returns a string that represents the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L30) -```csharp title="Declaration" -public override string ToString() -``` - -##### Returns - -`System.String`: A string that represents the current object.### GetHashCode() -Serves as the default hash function. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L32) -```csharp title="Declaration" -public override int GetHashCode() -``` - -##### Returns - -`System.Int32`: A hash code for the current object.### Equals(object?) -Determines whether the specified object is equal to the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L34) -```csharp title="Declaration" -public override bool Equals(object? obj) -``` - -##### Returns - -`System.Boolean`: true if the specified object is equal to the current object; otherwise, false. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.Object` | *obj* | The object to compare with the current object. | - -### Equals(ZipPackageFile?) -Indicates whether the current object is equal to another object of the same type. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/NuGet/ZipPackageFile.cs#L41) -```csharp title="Declaration" -public bool Equals(ZipPackageFile? other) -``` - -##### Returns - -`System.Boolean`: true if the current object is equal to the <code class="paramref">other</code> parameter; otherwise, false. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.NuGet.ZipPackageFile](../Velopack.NuGet/ZipPackageFile) | *other* | An object to compare with this object. | - - -## Implements - -* `System.IEquatable` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.GitBaseAsset.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.GitBaseAsset.md deleted file mode 100644 index a9cbc6c..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.GitBaseAsset.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Class GitBase.GitBaseAsset -sidebar_label: GitBase.GitBaseAsset -description: "Provides a wrapper around [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) which also contains a Git Release." ---- -# Class GitBase<T>.GitBaseAsset -Provides a wrapper around [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) which also contains a Git Release. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L114) -```csharp title="Declaration" -protected record GitBase.GitBaseAsset : VelopackAsset, IEquatable, IEquatable.GitBaseAsset> -``` -**Inheritance:** `System.Object` -> [Velopack.VelopackAsset](../Velopack/VelopackAsset) - -**Implements:** -`System.IEquatable`, `System.IEquatable` - -## Properties -### Release -The Github release which contains this release package. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L117) -```csharp title="Declaration" -public T Release { get; init; } -``` - -## Implements - -* `System.IEquatable` -* `System.IEquatable` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.md deleted file mode 100644 index b1d70c5..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitBase`T`.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -title: Class GitBase -sidebar_label: GitBase -description: "Base class to provide some shared implementation between sources which download releases from a Git repository." ---- -# Class GitBase<T> -Base class to provide some shared implementation between sources which download releases from a Git repository. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L13) -```csharp title="Declaration" -public abstract class GitBase : IUpdateSource -``` -**Derived:** -[Velopack.Sources.GithubSource](../Velopack.Sources/GithubSource), [Velopack.Sources.GitlabSource](../Velopack.Sources/GitlabSource) - -**Implements:** -[Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) - -## Properties -### RepoUri -The URL of the repository to download releases from. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L18) -```csharp title="Declaration" -public virtual Uri RepoUri { get; } -``` -### Prerelease -If true, the latest upcoming/prerelease release will be downloaded. If false, the latest -stable release will be downloaded. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L24) -```csharp title="Declaration" -public virtual bool Prerelease { get; } -``` -### Downloader -The file downloader used to perform HTTP requests. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L29) -```csharp title="Declaration" -public virtual IFileDownloader Downloader { get; } -``` -### AccessToken -The GitLab access token to use with the request to download releases. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L34) -```csharp title="Declaration" -protected virtual string? AccessToken { get; } -``` -### Authorization -The Bearer token used in the request. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L39) -```csharp title="Declaration" -protected virtual string? Authorization { get; } -``` -## Methods -### DownloadReleaseEntry(ILogger, VelopackAsset, string, Action<int>, CancellationToken) -Download the specified [Velopack.VelopackAsset](../Velopack/VelopackAsset) to the provided local file path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L51) -```csharp title="Declaration" -public virtual Task DownloadReleaseEntry(ILogger logger, VelopackAsset releaseEntry, string localFile, Action progress, CancellationToken cancelToken) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *releaseEntry* | The release to download. | -| `System.String` | *localFile* | The path on the local disk to store the file. If this file exists, - it will be overwritten. | -| `System.Action` | *progress* | This delegate will be executed with values from 0-100 as the - download is being processed. | -| `System.Threading.CancellationToken` | *cancelToken* | A token to use to cancel the request. | - -### GetReleaseFeed(ILogger, string, Guid?, VelopackAsset?) -Retrieve the list of available remote releases from the package source. These releases -can subsequently be downloaded with `Velopack.Sources.IUpdateSource.DownloadReleaseEntry(Microsoft.Extensions.Logging.ILogger%2cVelopack.VelopackAsset%2cSystem.String%2cSystem.Action%7bSystem.Int32%7d%2cSystem.Threading.CancellationToken)`. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L64) -```csharp title="Declaration" -public virtual Task GetReleaseFeed(ILogger logger, string channel, Guid? stagingId = null, VelopackAsset? latestLocalRelease = null) -``` - -##### Returns - -`System.Threading.Tasks.Task`: An array of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) objects that are available for download - and are applicable to this user. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| `System.String` | *channel* | Release channel to filter packages by. Can be null, which is the - default channel for this operating system. | -| `System.Nullable` | *stagingId* | A persistent user-id, used for calculating whether a specific - release should be available to this user or not. (eg, for the purposes of rolling out - an update to only a small portion of users at a time). | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestLocalRelease* | The latest / current local release. If specified, - metadata from this package may be provided to the remote server (such as package id, - or cpu architecture) to ensure that the correct package is downloaded for this user. | - -### GetReleases(bool) -Retrieves a list of [Velopack.Sources.GithubRelease](../Velopack.Sources/GithubRelease) from the current repository. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L101) -```csharp title="Declaration" -protected abstract Task GetReleases(bool includePrereleases) -``` - -##### Returns - -`System.Threading.Tasks.Task<[]>` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Boolean` | *includePrereleases* | - -### GetAssetUrlFromName(T, string) -Given a [Velopack.Sources.GithubRelease](../Velopack.Sources/GithubRelease) and an asset filename (eg. 'RELEASES') this -function will return either [Velopack.Sources.GithubReleaseAsset.BrowserDownloadUrl](../Velopack.Sources/GithubReleaseAsset#browserdownloadurl) or -[Velopack.Sources.GithubReleaseAsset.Url](../Velopack.Sources/GithubReleaseAsset#url), depending whether an access token is available -or not. Throws if the specified release has no matching assets. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitBase.cs#L109) -```csharp title="Declaration" -protected abstract string GetAssetUrlFromName(T release, string assetName) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `` | *release* | -| `System.String` | *assetName* | - - -## Implements - -* [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubRelease.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubRelease.md deleted file mode 100644 index 8a809ce..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubRelease.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Class GithubRelease -sidebar_label: GithubRelease -description: "Describes a GitHub release, including attached assets." ---- -# Class GithubRelease -Describes a GitHub release, including attached assets. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L11) -```csharp title="Declaration" -public class GithubRelease -``` -## Properties -### Name -The name of this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L14) -```csharp title="Declaration" -public string? Name { get; set; } -``` -### Prerelease -True if this release is a prerelease. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L18) -```csharp title="Declaration" -public bool Prerelease { get; set; } -``` -### PublishedAt -The date which this release was published publicly. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L22) -```csharp title="Declaration" -public DateTime? PublishedAt { get; set; } -``` -### Assets -A list of assets (files) uploaded to this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L26) -```csharp title="Declaration" -public GithubReleaseAsset[] Assets { get; set; } -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubReleaseAsset.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubReleaseAsset.md deleted file mode 100644 index df17efd..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubReleaseAsset.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Class GithubReleaseAsset -sidebar_label: GithubReleaseAsset -description: "Describes a asset (file) uploaded to a GitHub release." ---- -# Class GithubReleaseAsset -Describes a asset (file) uploaded to a GitHub release. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L31) -```csharp title="Declaration" -public class GithubReleaseAsset -``` -## Properties -### Url -The asset URL for this release asset. Requests to this URL will use API -quota and return JSON unless the 'Accept' header is "application/octet-stream". -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L37) -```csharp title="Declaration" -public string? Url { get; set; } -``` -### BrowserDownloadUrl -The browser URL for this release asset. This does not use API quota, -however this URL only works for public repositories. If downloading -assets from a private repository, the [Velopack.Sources.GithubReleaseAsset.Url](../Velopack.Sources/GithubReleaseAsset#url) property must -be used with an appropriate access token. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L46) -```csharp title="Declaration" -public string? BrowserDownloadUrl { get; set; } -``` -### Name -The name of this release asset. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L50) -```csharp title="Declaration" -public string? Name { get; set; } -``` -### ContentType -The mime type of this release asset (as detected by GitHub). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L54) -```csharp title="Declaration" -public string? ContentType { get; set; } -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubSource.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubSource.md deleted file mode 100644 index cc1caa1..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GithubSource.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: Class GithubSource -sidebar_label: GithubSource -description: "Retrieves available releases from a GitHub repository." ---- -# Class GithubSource -Retrieves available releases from a GitHub repository. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L61) -```csharp title="Declaration" -public class GithubSource : GitBase, IUpdateSource -``` -**Inheritance:** `System.Object` -> [Velopack.Sources.GitBase<T>](../Velopack.Sources/GitBase`T`) - -**Implements:** -[Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) - -## Methods -### GetReleases(bool) -Retrieves a list of [Velopack.Sources.GithubRelease](../Velopack.Sources/GithubRelease) from the current repository. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L86) -```csharp title="Declaration" -protected override Task GetReleases(bool includePrereleases) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Boolean` | *includePrereleases* | - -### GetAssetUrlFromName(GithubRelease, string) -Given a [Velopack.Sources.GithubRelease](../Velopack.Sources/GithubRelease) and an asset filename (eg. 'RELEASES') this -function will return either [Velopack.Sources.GithubReleaseAsset.BrowserDownloadUrl](../Velopack.Sources/GithubReleaseAsset#browserdownloadurl) or -[Velopack.Sources.GithubReleaseAsset.Url](../Velopack.Sources/GithubReleaseAsset#url), depending whether an access token is available -or not. Throws if the specified release has no matching assets. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L101) -```csharp title="Declaration" -protected override string GetAssetUrlFromName(GithubRelease release, string assetName) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Sources.GithubRelease](../Velopack.Sources/GithubRelease) | *release* | -| `System.String` | *assetName* | - -### GetApiBaseUrl(Uri) -Given a repository URL (e.g. https://github.com/myuser/myrepo) this function -returns the API base for performing requests. (eg. "https://api.github.com/" -or http://internal.github.server.local/api/v3) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GithubSource.cs#L135) -```csharp title="Declaration" -protected virtual Uri GetApiBaseUrl(Uri repoUrl) -``` - -##### Returns - -`System.Uri` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Uri` | *repoUrl* | - - -## Implements - -* [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabRelease.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabRelease.md deleted file mode 100644 index 8c99ff2..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabRelease.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Class GitlabRelease -sidebar_label: GitlabRelease -description: "Describes a Gitlab release, plus any assets that are attached." ---- -# Class GitlabRelease -Describes a Gitlab release, plus any assets that are attached. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L13) -```csharp title="Declaration" -public class GitlabRelease -``` -## Properties -### Name -The name of the release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L18) -```csharp title="Declaration" -public string? Name { get; set; } -``` -### UpcomingRelease -True if this is intended for an upcoming release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L24) -```csharp title="Declaration" -public bool UpcomingRelease { get; set; } -``` -### ReleasedAt -The date which this release was published publicly. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L30) -```csharp title="Declaration" -public DateTime? ReleasedAt { get; set; } -``` -### Assets -A container for the assets (files) uploaded to this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L36) -```csharp title="Declaration" -public GitlabReleaseAsset? Assets { get; set; } -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseAsset.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseAsset.md deleted file mode 100644 index baf160e..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseAsset.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Class GitlabReleaseAsset -sidebar_label: GitlabReleaseAsset -description: "Describes a container for the assets attached to a release." ---- -# Class GitlabReleaseAsset -Describes a container for the assets attached to a release. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L43) -```csharp title="Declaration" -public class GitlabReleaseAsset -``` -## Properties -### Count -The amount of assets linked to the release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L48) -```csharp title="Declaration" -public int Count { get; set; } -``` -### Links -A list of asset (file) links. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L54) -```csharp title="Declaration" -public GitlabReleaseLink[] Links { get; set; } -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseLink.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseLink.md deleted file mode 100644 index b070c2c..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabReleaseLink.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Class GitlabReleaseLink -sidebar_label: GitlabReleaseLink -description: "Describes a container for the links of assets attached to a release." ---- -# Class GitlabReleaseLink -Describes a container for the links of assets attached to a release. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L61) -```csharp title="Declaration" -public class GitlabReleaseLink -``` -## Properties -### Name -Name of the asset (file) linked. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L66) -```csharp title="Declaration" -public string? Name { get; set; } -``` -### Url -The url for the asset. This make use of the Gitlab API. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L72) -```csharp title="Declaration" -public string? Url { get; set; } -``` -### DirectAssetUrl -A direct url to the asset, via a traditional URl. -As a posed to using the API. -This links directly to the raw asset (file). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L80) -```csharp title="Declaration" -public string? DirectAssetUrl { get; set; } -``` -### Type -The category type that the asset is listed under. -Options: 'Package', 'Image', 'Runbook', 'Other' -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L87) -```csharp title="Declaration" -public string? Type { get; set; } -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabSource.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabSource.md deleted file mode 100644 index 1f80b20..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/GitlabSource.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Class GitlabSource -sidebar_label: GitlabSource -description: "Retrieves available releases from a GitLab repository. This class only -downloads assets from the very latest GitLab release." ---- -# Class GitlabSource -Retrieves available releases from a GitLab repository. This class only -downloads assets from the very latest GitLab release. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L95) -```csharp title="Declaration" -public class GitlabSource : GitBase, IUpdateSource -``` -**Inheritance:** `System.Object` -> [Velopack.Sources.GitBase<T>](../Velopack.Sources/GitBase`T`) - -**Implements:** -[Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) - -## Methods -### GetAssetUrlFromName(GitlabRelease, string) -Given a [Velopack.Sources.GitlabRelease](../Velopack.Sources/GitlabRelease) and an asset filename (eg. 'RELEASES') this -function will return either [Velopack.Sources.GitlabReleaseLink.DirectAssetUrl](../Velopack.Sources/GitlabReleaseLink#directasseturl) or -[Velopack.Sources.GitlabReleaseLink.Url](../Velopack.Sources/GitlabReleaseLink#url), depending whether an access token is available -or not. Throws if the specified release has no matching assets. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L123) -```csharp title="Declaration" -protected override string GetAssetUrlFromName(GitlabRelease release, string assetName) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Sources.GitlabRelease](../Velopack.Sources/GitlabRelease) | *release* | -| `System.String` | *assetName* | - -### GetReleases(bool) -Retrieves a list of [Velopack.Sources.GitlabRelease](../Velopack.Sources/GitlabRelease) from the current repository. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/GitlabSource.cs#L147) -```csharp title="Declaration" -protected override Task GetReleases(bool includePrereleases) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Boolean` | *includePrereleases* | - - -## Implements - -* [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/HttpClientFileDownloader.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/HttpClientFileDownloader.md deleted file mode 100644 index c9303dd..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/HttpClientFileDownloader.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: Class HttpClientFileDownloader -sidebar_label: HttpClientFileDownloader -description: "A simple abstractable file downloader" ---- -# Class HttpClientFileDownloader -A simple abstractable file downloader - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L13) -```csharp title="Declaration" -public class HttpClientFileDownloader : IFileDownloader -``` -**Implements:** -[Velopack.Sources.IFileDownloader](../Velopack.Sources/IFileDownloader) - -## Properties -### UserAgent -The User-Agent sent with requests -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L18) -```csharp title="Declaration" -public static ProductInfoHeaderValue UserAgent { get; } -``` -## Methods -### DownloadFile(string, string, Action<int>, string?, string?, CancellationToken) -Downloads a remote file to the specified local path -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L21) -```csharp title="Declaration" -public virtual Task DownloadFile(string url, string targetFile, Action progress, string? authorization, string? accept, CancellationToken cancelToken = default) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *url* | The url which will be downloaded. | -| `System.String` | *targetFile* | The local path where the file will be stored -If a file exists at this path, it will be overwritten. | -| `System.Action` | *progress* | A delegate for reporting download progress, with expected values from 0-100. | -| `System.String` | *authorization* | Text to be sent in the 'Authorization' header of the request. | -| `System.String` | *accept* | Text to be sent in the 'Accept' header of the request. | -| `System.Threading.CancellationToken` | *cancelToken* | Optional token to cancel the request. | - -### DownloadBytes(string, string?, string?) -Returns a byte array containing the contents of the file at the specified url -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L38) -```csharp title="Declaration" -public virtual Task DownloadBytes(string url, string? authorization, string? accept) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *url* | -| `System.String` | *authorization* | -| `System.String` | *accept* | - -### DownloadString(string, string?, string?) -Returns a string containing the contents of the specified url -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L51) -```csharp title="Declaration" -public virtual Task DownloadString(string url, string? authorization, string? accept) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *url* | -| `System.String` | *authorization* | -| `System.String` | *accept* | - -### DownloadToStreamInternal(HttpClient, string, Stream, Action<int>?, CancellationToken) -Asynchronously downloads a remote url to the specified destination stream while -providing progress updates. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L67) -```csharp title="Declaration" -protected virtual Task DownloadToStreamInternal(HttpClient client, string requestUri, Stream destination, Action? progress = null, CancellationToken cancelToken = default) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Net.Http.HttpClient` | *client* | -| `System.String` | *requestUri* | -| `System.IO.Stream` | *destination* | -| `System.Action` | *progress* | -| `System.Threading.CancellationToken` | *cancelToken* | - -### CreateHttpClientHandler() -Creates a new `System.Net.Http.HttpClientHandler` with default settings, used for -new `System.Net.Http.HttpClient`'s. Override this function to add client certificates, -proxy configurations, cookies, or change other http behaviors. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L111) -```csharp title="Declaration" -protected virtual HttpClientHandler CreateHttpClientHandler() -``` - -##### Returns - -`System.Net.Http.HttpClientHandler` -### CreateHttpClient(string?, string?) -Creates a new `System.Net.Http.HttpClient` for every request. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/HttpClientFileDownloader.cs#L123) -```csharp title="Declaration" -protected virtual HttpClient CreateHttpClient(string? authorization, string? accept) -``` - -##### Returns - -`System.Net.Http.HttpClient` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *authorization* | -| `System.String` | *accept* | - - -## Implements - -* [Velopack.Sources.IFileDownloader](../Velopack.Sources/IFileDownloader) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IFileDownloader.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IFileDownloader.md deleted file mode 100644 index 8c57f1a..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IFileDownloader.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: Interface IFileDownloader -sidebar_label: IFileDownloader -description: "A simple abstractable file downloader" ---- -# Interface IFileDownloader -A simple abstractable file downloader - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IFileDownloader.cs#L10) -```csharp title="Declaration" -public interface IFileDownloader -``` -## Methods -### DownloadFile(string, string, Action<int>, string?, string?, CancellationToken) -Downloads a remote file to the specified local path -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IFileDownloader.cs#L29) -```csharp title="Declaration" -Task DownloadFile(string url, string targetFile, Action progress, string? authorization = null, string? accept = null, CancellationToken cancelToken = default) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *url* | The url which will be downloaded. | -| `System.String` | *targetFile* | The local path where the file will be stored -If a file exists at this path, it will be overwritten. | -| `System.Action` | *progress* | A delegate for reporting download progress, with expected values from 0-100. | -| `System.String` | *authorization* | Text to be sent in the 'Authorization' header of the request. | -| `System.String` | *accept* | Text to be sent in the 'Accept' header of the request. | -| `System.Threading.CancellationToken` | *cancelToken* | Optional token to cancel the request. | - -### DownloadBytes(string, string?, string?) -Returns a byte array containing the contents of the file at the specified url -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IFileDownloader.cs#L34) -```csharp title="Declaration" -Task DownloadBytes(string url, string? authorization = null, string? accept = null) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *url* | -| `System.String` | *authorization* | -| `System.String` | *accept* | - -### DownloadString(string, string?, string?) -Returns a string containing the contents of the specified url -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IFileDownloader.cs#L39) -```csharp title="Declaration" -Task DownloadString(string url, string? authorization = null, string? accept = null) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *url* | -| `System.String` | *authorization* | -| `System.String` | *accept* | - diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IUpdateSource.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IUpdateSource.md deleted file mode 100644 index d9e91ba..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/IUpdateSource.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Interface IUpdateSource -sidebar_label: IUpdateSource -description: "Abstraction for finding and downloading updates from a package source / repository. -An implementation may copy a file from a local repository, download from a web address, -or even use third party services and parse proprietary data to produce a package feed." ---- -# Interface IUpdateSource -Abstraction for finding and downloading updates from a package source / repository. -An implementation may copy a file from a local repository, download from a web address, -or even use third party services and parse proprietary data to produce a package feed. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IUpdateSource.cs#L13) -```csharp title="Declaration" -public interface IUpdateSource -``` -## Methods -### GetReleaseFeed(ILogger, string, Guid?, VelopackAsset?) -Retrieve the list of available remote releases from the package source. These releases -can subsequently be downloaded with `Velopack.Sources.IUpdateSource.DownloadReleaseEntry(Microsoft.Extensions.Logging.ILogger%2cVelopack.VelopackAsset%2cSystem.String%2cSystem.Action%7bSystem.Int32%7d%2cSystem.Threading.CancellationToken)`. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IUpdateSource.cs#L31) -```csharp title="Declaration" -Task GetReleaseFeed(ILogger logger, string channel, Guid? stagingId = null, VelopackAsset? latestLocalRelease = null) -``` - -##### Returns - -`System.Threading.Tasks.Task`: An array of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) objects that are available for download - and are applicable to this user. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| `System.String` | *channel* | Release channel to filter packages by. Can be null, which is the - default channel for this operating system. | -| `System.Nullable` | *stagingId* | A persistent user-id, used for calculating whether a specific - release should be available to this user or not. (eg, for the purposes of rolling out - an update to only a small portion of users at a time). | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestLocalRelease* | The latest / current local release. If specified, - metadata from this package may be provided to the remote server (such as package id, - or cpu architecture) to ensure that the correct package is downloaded for this user. | - -### DownloadReleaseEntry(ILogger, VelopackAsset, string, Action<int>, CancellationToken) -Download the specified [Velopack.VelopackAsset](../Velopack/VelopackAsset) to the provided local file path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/IUpdateSource.cs#L43) -```csharp title="Declaration" -Task DownloadReleaseEntry(ILogger logger, VelopackAsset releaseEntry, string localFile, Action progress, CancellationToken cancelToken = default) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *releaseEntry* | The release to download. | -| `System.String` | *localFile* | The path on the local disk to store the file. If this file exists, - it will be overwritten. | -| `System.Action` | *progress* | This delegate will be executed with values from 0-100 as the - download is being processed. | -| `System.Threading.CancellationToken` | *cancelToken* | A token to use to cancel the request. | - diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleFileSource.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleFileSource.md deleted file mode 100644 index ee07429..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleFileSource.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: Class SimpleFileSource -sidebar_label: SimpleFileSource -description: "Retrieves available updates from a local or network-attached disk. The directory -must contain one or more valid packages, as well as a 'releases.{channel}.json' index file." ---- -# Class SimpleFileSource -Retrieves available updates from a local or network-attached disk. The directory -must contain one or more valid packages, as well as a 'releases.{channel}.json' index file. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleFileSource.cs#L15) -```csharp title="Declaration" -public class SimpleFileSource : IUpdateSource -``` -**Implements:** -[Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) - -## Properties -### BaseDirectory -The local directory containing packages to update to. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleFileSource.cs#L18) -```csharp title="Declaration" -public virtual DirectoryInfo BaseDirectory { get; } -``` -## Methods -### GetReleaseFeed(ILogger, string, Guid?, VelopackAsset?) -Retrieve the list of available remote releases from the package source. These releases -can subsequently be downloaded with `Velopack.Sources.IUpdateSource.DownloadReleaseEntry(Microsoft.Extensions.Logging.ILogger%2cVelopack.VelopackAsset%2cSystem.String%2cSystem.Action%7bSystem.Int32%7d%2cSystem.Threading.CancellationToken)`. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleFileSource.cs#L27) -```csharp title="Declaration" -public Task GetReleaseFeed(ILogger logger, string channel, Guid? stagingId = null, VelopackAsset? latestLocalRelease = null) -``` - -##### Returns - -`System.Threading.Tasks.Task`: An array of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) objects that are available for download - and are applicable to this user. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| `System.String` | *channel* | Release channel to filter packages by. Can be null, which is the - default channel for this operating system. | -| `System.Nullable` | *stagingId* | A persistent user-id, used for calculating whether a specific - release should be available to this user or not. (eg, for the purposes of rolling out - an update to only a small portion of users at a time). | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestLocalRelease* | The latest / current local release. If specified, - metadata from this package may be provided to the remote server (such as package id, - or cpu architecture) to ensure that the correct package is downloaded for this user. | - -### DownloadReleaseEntry(ILogger, VelopackAsset, string, Action<int>, CancellationToken) -Download the specified [Velopack.VelopackAsset](../Velopack/VelopackAsset) to the provided local file path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleFileSource.cs#L67) -```csharp title="Declaration" -public Task DownloadReleaseEntry(ILogger logger, VelopackAsset releaseEntry, string localFile, Action progress, CancellationToken cancelToken) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *releaseEntry* | The release to download. | -| `System.String` | *localFile* | The path on the local disk to store the file. If this file exists, - it will be overwritten. | -| `System.Action` | *progress* | This delegate will be executed with values from 0-100 as the - download is being processed. | -| `System.Threading.CancellationToken` | *cancelToken* | A token to use to cancel the request. | - - -## Implements - -* [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleWebSource.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleWebSource.md deleted file mode 100644 index a68ba7b..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/SimpleWebSource.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: Class SimpleWebSource -sidebar_label: SimpleWebSource -description: "Retrieves updates from a static file host or other web server. -Will perform a request for '{baseUri}/RELEASES' to locate the available packages, -and provides query parameters to specify the name of the requested package." ---- -# Class SimpleWebSource -Retrieves updates from a static file host or other web server. -Will perform a request for '{baseUri}/RELEASES' to locate the available packages, -and provides query parameters to specify the name of the requested package. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleWebSource.cs#L14) -```csharp title="Declaration" -public class SimpleWebSource : IUpdateSource -``` -**Implements:** -[Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) - -## Properties -### BaseUri -The URL of the server hosting packages to update to. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleWebSource.cs#L17) -```csharp title="Declaration" -public virtual Uri BaseUri { get; } -``` -### Downloader -The [Velopack.Sources.IFileDownloader](../Velopack.Sources/IFileDownloader) to be used for performing http requests. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleWebSource.cs#L20) -```csharp title="Declaration" -public virtual IFileDownloader Downloader { get; } -``` -## Methods -### GetReleaseFeed(ILogger, string, Guid?, VelopackAsset?) -Retrieve the list of available remote releases from the package source. These releases -can subsequently be downloaded with `Velopack.Sources.IUpdateSource.DownloadReleaseEntry(Microsoft.Extensions.Logging.ILogger%2cVelopack.VelopackAsset%2cSystem.String%2cSystem.Action%7bSystem.Int32%7d%2cSystem.Threading.CancellationToken)`. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleWebSource.cs#L35) -```csharp title="Declaration" -public Task GetReleaseFeed(ILogger logger, string channel, Guid? stagingId = null, VelopackAsset? latestLocalRelease = null) -``` - -##### Returns - -`System.Threading.Tasks.Task`: An array of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) objects that are available for download - and are applicable to this user. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| `System.String` | *channel* | Release channel to filter packages by. Can be null, which is the - default channel for this operating system. | -| `System.Nullable` | *stagingId* | A persistent user-id, used for calculating whether a specific - release should be available to this user or not. (eg, for the purposes of rolling out - an update to only a small portion of users at a time). | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestLocalRelease* | The latest / current local release. If specified, - metadata from this package may be provided to the remote server (such as package id, - or cpu architecture) to ensure that the correct package is downloaded for this user. | - -### DownloadReleaseEntry(ILogger, VelopackAsset, string, Action<int>, CancellationToken) -Download the specified [Velopack.VelopackAsset](../Velopack/VelopackAsset) to the provided local file path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/SimpleWebSource.cs#L63) -```csharp title="Declaration" -public Task DownloadReleaseEntry(ILogger logger, VelopackAsset releaseEntry, string localFile, Action progress, CancellationToken cancelToken) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *releaseEntry* | The release to download. | -| `System.String` | *localFile* | The path on the local disk to store the file. If this file exists, - it will be overwritten. | -| `System.Action` | *progress* | This delegate will be executed with values from 0-100 as the - download is being processed. | -| `System.Threading.CancellationToken` | *cancelToken* | A token to use to cancel the request. | - - -## Implements - -* [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/Velopack.Sources.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/Velopack.Sources.md deleted file mode 100644 index 6f5e72c..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/Velopack.Sources.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Namespace Velopack.Sources -sidebar_label: Velopack.Sources ---- -# Namespace Velopack.Sources -## Classes -### [GitBase<T>](../Velopack.Sources/GitBase`T`) -Base class to provide some shared implementation between sources which download releases from a Git repository. -### [GitBase<T>.GitBaseAsset](../Velopack.Sources/GitBase`T`.GitBaseAsset) -Provides a wrapper around [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) which also contains a Git Release. -### [GithubRelease](../Velopack.Sources/GithubRelease) -Describes a GitHub release, including attached assets. -### [GithubReleaseAsset](../Velopack.Sources/GithubReleaseAsset) -Describes a asset (file) uploaded to a GitHub release. -### [GithubSource](../Velopack.Sources/GithubSource) -Retrieves available releases from a GitHub repository. -### [GitlabRelease](../Velopack.Sources/GitlabRelease) -Describes a Gitlab release, plus any assets that are attached. -### [GitlabReleaseAsset](../Velopack.Sources/GitlabReleaseAsset) -Describes a container for the assets attached to a release. -### [GitlabReleaseLink](../Velopack.Sources/GitlabReleaseLink) -Describes a container for the links of assets attached to a release. -### [GitlabSource](../Velopack.Sources/GitlabSource) -Retrieves available releases from a GitLab repository. This class only -downloads assets from the very latest GitLab release. -### [HttpClientFileDownloader](../Velopack.Sources/HttpClientFileDownloader) -A simple abstractable file downloader -### [SimpleFileSource](../Velopack.Sources/SimpleFileSource) -Retrieves available updates from a local or network-attached disk. The directory -must contain one or more valid packages, as well as a 'releases.{channel}.json' index file. -### [SimpleWebSource](../Velopack.Sources/SimpleWebSource) -Retrieves updates from a static file host or other web server. -Will perform a request for '{baseUri}/RELEASES' to locate the available packages, -and provides query parameters to specify the name of the requested package. -### [VelopackFlowUpdateSource](../Velopack.Sources/VelopackFlowUpdateSource) -Retrieves updates from the hosted Velopack service. -## Interfaces -### [IFileDownloader](../Velopack.Sources/IFileDownloader) -A simple abstractable file downloader -### [IUpdateSource](../Velopack.Sources/IUpdateSource) -Abstraction for finding and downloading updates from a package source / repository. -An implementation may copy a file from a local repository, download from a web address, -or even use third party services and parse proprietary data to produce a package feed. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/VelopackFlowUpdateSource.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/VelopackFlowUpdateSource.md deleted file mode 100644 index 9d8896c..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Sources/VelopackFlowUpdateSource.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: Class VelopackFlowUpdateSource -sidebar_label: VelopackFlowUpdateSource -description: "Retrieves updates from the hosted Velopack service." ---- -# Class VelopackFlowUpdateSource -Retrieves updates from the hosted Velopack service. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/VelopackFlowUpdateSource.cs#L14) -```csharp title="Declaration" -public sealed class VelopackFlowUpdateSource : IUpdateSource -``` -**Implements:** -[Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) - -## Properties -### BaseUri -The URL of the server hosting packages to update to. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/VelopackFlowUpdateSource.cs#L26) -```csharp title="Declaration" -public Uri BaseUri { get; } -``` -### Downloader -The [Velopack.Sources.IFileDownloader](../Velopack.Sources/IFileDownloader) to be used for performing http requests. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/VelopackFlowUpdateSource.cs#L29) -```csharp title="Declaration" -public IFileDownloader Downloader { get; } -``` -## Methods -### GetReleaseFeed(ILogger, string, Guid?, VelopackAsset?) -Retrieve the list of available remote releases from the package source. These releases -can subsequently be downloaded with `Velopack.Sources.IUpdateSource.DownloadReleaseEntry(Microsoft.Extensions.Logging.ILogger%2cVelopack.VelopackAsset%2cSystem.String%2cSystem.Action%7bSystem.Int32%7d%2cSystem.Threading.CancellationToken)`. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/VelopackFlowUpdateSource.cs#L32) -```csharp title="Declaration" -public Task GetReleaseFeed(ILogger logger, string channel, Guid? stagingId = null, VelopackAsset? latestLocalRelease = null) -``` - -##### Returns - -`System.Threading.Tasks.Task`: An array of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) objects that are available for download - and are applicable to this user. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| `System.String` | *channel* | Release channel to filter packages by. Can be null, which is the - default channel for this operating system. | -| `System.Nullable` | *stagingId* | A persistent user-id, used for calculating whether a specific - release should be available to this user or not. (eg, for the purposes of rolling out - an update to only a small portion of users at a time). | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestLocalRelease* | The latest / current local release. If specified, - metadata from this package may be provided to the remote server (such as package id, - or cpu architecture) to ensure that the correct package is downloaded for this user. | - -### DownloadReleaseEntry(ILogger, VelopackAsset, string, Action<int>, CancellationToken) -Download the specified [Velopack.VelopackAsset](../Velopack/VelopackAsset) to the provided local file path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Sources/VelopackFlowUpdateSource.cs#L68) -```csharp title="Declaration" -public Task DownloadReleaseEntry(ILogger logger, VelopackAsset releaseEntry, string localFile, Action progress, CancellationToken cancelToken = default) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for any diagnostic messages. | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *releaseEntry* | The release to download. | -| `System.String` | *localFile* | The path on the local disk to store the file. If this file exists, - it will be overwritten. | -| `System.Action` | *progress* | This delegate will be executed with values from 0-100 as the - download is being processed. | -| `System.Threading.CancellationToken` | *cancelToken* | A token to use to cancel the request. | - - -## Implements - -* [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.SHGetFileInfoConstants.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.SHGetFileInfoConstants.md deleted file mode 100644 index c553fbf..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.SHGetFileInfoConstants.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: Enum FileIcon.SHGetFileInfoConstants -sidebar_label: FileIcon.SHGetFileInfoConstants ---- -# Enum FileIcon.SHGetFileInfoConstants - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L996) -```csharp title="Declaration" -[Flags] -public enum FileIcon.SHGetFileInfoConstants -``` -## Fields -### SHGFI_ICON - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L999) -```csharp title="Declaration" -SHGFI_ICON = 256 -``` -### SHGFI_DISPLAYNAME - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1000) -```csharp title="Declaration" -SHGFI_DISPLAYNAME = 512 -``` -### SHGFI_TYPENAME - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1001) -```csharp title="Declaration" -SHGFI_TYPENAME = 1024 -``` -### SHGFI_ATTRIBUTES - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1002) -```csharp title="Declaration" -SHGFI_ATTRIBUTES = 2048 -``` -### SHGFI_ICONLOCATION - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1003) -```csharp title="Declaration" -SHGFI_ICONLOCATION = 4096 -``` -### SHGFI_EXETYPE - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1004) -```csharp title="Declaration" -SHGFI_EXETYPE = 8192 -``` -### SHGFI_SYSICONINDEX - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1005) -```csharp title="Declaration" -SHGFI_SYSICONINDEX = 16384 -``` -### SHGFI_LINKOVERLAY - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1006) -```csharp title="Declaration" -SHGFI_LINKOVERLAY = 32768 -``` -### SHGFI_SELECTED - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1007) -```csharp title="Declaration" -SHGFI_SELECTED = 65536 -``` -### SHGFI_ATTR_SPECIFIED - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1008) -```csharp title="Declaration" -SHGFI_ATTR_SPECIFIED = 131072 -``` -### SHGFI_LARGEICON - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1009) -```csharp title="Declaration" -SHGFI_LARGEICON = 0 -``` -### SHGFI_SMALLICON - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1010) -```csharp title="Declaration" -SHGFI_SMALLICON = 1 -``` -### SHGFI_OPENICON - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1011) -```csharp title="Declaration" -SHGFI_OPENICON = 2 -``` -### SHGFI_SHELLICONSIZE - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1012) -```csharp title="Declaration" -SHGFI_SHELLICONSIZE = 4 -``` -### SHGFI_USEFILEATTRIBUTES - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1014) -```csharp title="Declaration" -SHGFI_USEFILEATTRIBUTES = 16 -``` -### SHGFI_ADDOVERLAYS - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1015) -```csharp title="Declaration" -SHGFI_ADDOVERLAYS = 32 -``` -### SHGFI_OVERLAYINDEX - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1016) -```csharp title="Declaration" -SHGFI_OVERLAYINDEX = 64 -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.md deleted file mode 100644 index abeef0f..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/FileIcon.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Class FileIcon -sidebar_label: FileIcon -description: "Enables extraction of icons for any file type from -the Shell." ---- -# Class FileIcon -Enables extraction of icons for any file type from -the Shell. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L938) -```csharp title="Declaration" -public class FileIcon -``` -## Properties -### Flags -Gets/sets the flags used to extract the icon -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1022) -```csharp title="Declaration" -public FileIcon.SHGetFileInfoConstants Flags { get; set; } -``` -### FileName -Gets/sets the filename to get the icon for -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1030) -```csharp title="Declaration" -public string FileName { get; set; } -``` -### ShellIcon -Gets the icon for the chosen file -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1038) -```csharp title="Declaration" -public IntPtr ShellIcon { get; } -``` -### DisplayName -Gets the display name for the selected file -if the SHGFI_DISPLAYNAME flag was set. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1046) -```csharp title="Declaration" -public string DisplayName { get; } -``` -### TypeName -Gets the type name for the selected file -if the SHGFI_TYPENAME flag was set. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L1054) -```csharp title="Declaration" -public string TypeName { get; } -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetInfo.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetInfo.md deleted file mode 100644 index 0211480..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetInfo.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -title: Class Runtimes.DotnetInfo -sidebar_label: Runtimes.DotnetInfo -description: "Represents a modern DOTNET runtime where versions are deployed independenly of the operating system" ---- -# Class Runtimes.DotnetInfo -Represents a modern DOTNET runtime where versions are deployed independenly of the operating system - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L163) -```csharp title="Declaration" -public class Runtimes.DotnetInfo : Runtimes.RuntimeInfo -``` -**Inheritance:** `System.Object` -> [Velopack.Windows.Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) - -## Properties -### Id -The unique Id of this runtime. Can be used to retrieve a runtime instance with [Velopack.Windows.Runtimes.GetRuntimeByName(string)](../Velopack.Windows/Runtimes#getruntimebynamestring) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L166) -```csharp title="Declaration" -public override string Id { get; } -``` -### DisplayName -The human-friendly name of this runtime - for displaying to users -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L170) -```csharp title="Declaration" -public override string DisplayName { get; } -``` -### MinVersion -The minimum compatible version that must be installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L174) -```csharp title="Declaration" -public NuGetVersion MinVersion { get; } -``` -### CpuArchitecture -The CPU architecture of the runtime. This must match the RID of the app being deployed. - For example, if the app was deployed with 'win-x64', this must be X64 also. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L178) -```csharp title="Declaration" -public RuntimeCpu CpuArchitecture { get; } -``` -### RuntimeType -The type of runtime required, eg. Windows Desktop, AspNetCore, Sdk. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L181) -```csharp title="Declaration" -public Runtimes.DotnetRuntimeType RuntimeType { get; } -``` -## Methods -### CheckIsInstalled() -Check if a runtime compatible with the current instance is installed on this system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L206) -```csharp title="Declaration" -public override Task CheckIsInstalled() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### CheckIsSupported() -Check if this runtime is supported on the current system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L223) -```csharp title="Declaration" -public override Task CheckIsSupported() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### GetDownloadUrl() -Retrieves the web url to the latest compatible runtime installer exe -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L288) -```csharp title="Declaration" -public override Task GetDownloadUrl() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### Parse(string) -Parses a string such as 'net6' or net5.0.14-x86 into a DotnetInfo class capable of checking -the current system for installed status, or downloading / installing. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L309) -```csharp title="Declaration" -public static Runtimes.DotnetInfo Parse(string input) -``` - -##### Returns - -[Velopack.Windows.Runtimes.DotnetInfo](../Velopack.Windows/Runtimes.DotnetInfo) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *input* | - -### TryParse(string, out DotnetInfo) -Parses a string such as 'net6' or net5.0.14-x86 into a DotnetInfo class capable of checking -the current system for installed status, or downloading / installing. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L340) -```csharp title="Declaration" -public static bool TryParse(string input, out Runtimes.DotnetInfo info) -``` - -##### Returns - -`System.Boolean` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *input* | -| [Velopack.Windows.Runtimes.DotnetInfo](../Velopack.Windows/Runtimes.DotnetInfo) | *info* | - -### ParseVersion(string) -Safely converts a version string into a version structure, and provides some validation for invalid/unsupported versions. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L354) -```csharp title="Declaration" -protected static Version ParseVersion(string input) -``` - -##### Returns - -`System.Version` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *input* | - -### TrimVersion(NuGetVersion) -Converts a version structure into the shortest string possible, by trimming trailing zeros. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L375) -```csharp title="Declaration" -protected static string TrimVersion(NuGetVersion ver) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `NuGet.Versioning.NuGetVersion` | *ver* | - -### GetLatestDotNetVersion(DotnetRuntimeType, string, IFileDownloader) -Get latest available version of dotnet. Channel can be 'LTS', 'current', or a two part version -(eg. '6.0') to get the latest minor release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L394) -```csharp title="Declaration" -public static Task GetLatestDotNetVersion(Runtimes.DotnetRuntimeType runtimeType, string channel, IFileDownloader downloader = null) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Windows.Runtimes.DotnetRuntimeType](../Velopack.Windows/Runtimes.DotnetRuntimeType) | *runtimeType* | -| `System.String` | *channel* | -| [Velopack.Sources.IFileDownloader](../Velopack.Sources/IFileDownloader) | *downloader* | - -### GetDotNetDownloadUrl(DotnetRuntimeType, string, string) -Get download url for a specific version of dotnet. Version must be an absolute version, such as one -returned by `Velopack.Windows.Runtimes.DotnetInfo.GetLatestDotNetVersion(Velopack.Windows.Runtimes.DotnetRuntimeType%2cSystem.String%2cVelopack.Sources.IFileDownloader)`. cpuarch should be either -'x86', 'x64', or 'arm64'. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L419) -```csharp title="Declaration" -public static string GetDotNetDownloadUrl(Runtimes.DotnetRuntimeType runtimeType, string version, string cpuarch) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Windows.Runtimes.DotnetRuntimeType](../Velopack.Windows/Runtimes.DotnetRuntimeType) | *runtimeType* | -| `System.String` | *version* | -| `System.String` | *cpuarch* | - diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetRuntimeType.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetRuntimeType.md deleted file mode 100644 index caf2780..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.DotnetRuntimeType.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Enum Runtimes.DotnetRuntimeType -sidebar_label: Runtimes.DotnetRuntimeType -description: "Dotnet Runtime SKU" ---- -# Enum Runtimes.DotnetRuntimeType -Dotnet Runtime SKU - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L20) -```csharp title="Declaration" -public enum Runtimes.DotnetRuntimeType -``` -## Fields -### Runtime -The .NET Runtime contains just the components needed to run a console app -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L23) -```csharp title="Declaration" -Runtime = 1 -``` -### AspNetCore -The The ASP.NET Core Runtime enables you to run existing web/server applications -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L25) -```csharp title="Declaration" -AspNetCore = 2 -``` -### WindowsDesktop -The .NET Desktop Runtime enables you to run existing Windows desktop applications -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L27) -```csharp title="Declaration" -WindowsDesktop = 3 -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.FrameworkInfo.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.FrameworkInfo.md deleted file mode 100644 index 277339a..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.FrameworkInfo.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Class Runtimes.FrameworkInfo -sidebar_label: Runtimes.FrameworkInfo -description: "Represents a full .NET Framework runtime, usually included in Windows automatically through Windows Update" ---- -# Class Runtimes.FrameworkInfo -Represents a full .NET Framework runtime, usually included in Windows automatically through Windows Update - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L116) -```csharp title="Declaration" -public class Runtimes.FrameworkInfo : Runtimes.RuntimeInfo -``` -**Inheritance:** `System.Object` -> [Velopack.Windows.Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) - -## Properties -### DownloadUrl -Permalink to the installer for this runtime -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L119) -```csharp title="Declaration" -public string DownloadUrl { get; } -``` -### ReleaseVersion -The minimum compatible release version for this runtime -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L122) -```csharp title="Declaration" -public int ReleaseVersion { get; } -``` -## Methods -### GetDownloadUrl() -Retrieves the web url to the latest compatible runtime installer exe -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L134) -```csharp title="Declaration" -public override Task GetDownloadUrl() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### CheckIsSupported() -Check if this runtime is supported on the current system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L140) -```csharp title="Declaration" -public override Task CheckIsSupported() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### CheckIsInstalled() -Check if a runtime compatible with the current instance is installed on this system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L148) -```csharp title="Declaration" -public override Task CheckIsInstalled() -``` - -##### Returns - -`System.Threading.Tasks.Task` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInfo.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInfo.md deleted file mode 100644 index acc5b8d..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInfo.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: Class Runtimes.RuntimeInfo -sidebar_label: Runtimes.RuntimeInfo -description: "Base type containing information about a runtime in relation to the current operating system" ---- -# Class Runtimes.RuntimeInfo -Base type containing information about a runtime in relation to the current operating system - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L46) -```csharp title="Declaration" -public abstract class Runtimes.RuntimeInfo -``` -**Derived:** -[Velopack.Windows.Runtimes.DotnetInfo](../Velopack.Windows/Runtimes.DotnetInfo), [Velopack.Windows.Runtimes.FrameworkInfo](../Velopack.Windows/Runtimes.FrameworkInfo), [Velopack.Windows.Runtimes.VCRedistInfo](../Velopack.Windows/Runtimes.VCRedistInfo) - -## Properties -### Id -The unique Id of this runtime. Can be used to retrieve a runtime instance with [Velopack.Windows.Runtimes.GetRuntimeByName(string)](../Velopack.Windows/Runtimes#getruntimebynamestring) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L49) -```csharp title="Declaration" -public virtual string Id { get; } -``` -### DisplayName -The human-friendly name of this runtime - for displaying to users -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L52) -```csharp title="Declaration" -public virtual string DisplayName { get; } -``` -## Methods -### GetDownloadUrl() -Retrieves the web url to the latest compatible runtime installer exe -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L65) -```csharp title="Declaration" -public abstract Task GetDownloadUrl() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### CheckIsInstalled() -Check if a runtime compatible with the current instance is installed on this system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L68) -```csharp title="Declaration" -public abstract Task CheckIsInstalled() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### CheckIsSupported() -Check if this runtime is supported on the current system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L72) -```csharp title="Declaration" -public abstract Task CheckIsSupported() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### DownloadToFile(string, Action<int>, IFileDownloader, ILogger) -Download the latest installer for this runtime to the specified file -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L76) -```csharp title="Declaration" -public virtual Task DownloadToFile(string localPath, Action progress = null, IFileDownloader downloader = null, ILogger log = null) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *localPath* | -| `System.Action` | *progress* | -| [Velopack.Sources.IFileDownloader](../Velopack.Sources/IFileDownloader) | *downloader* | -| `Microsoft.Extensions.Logging.ILogger` | *log* | - -### InvokeInstaller(string, bool, ILogger) -Execute a runtime installer at a local file path. Typically used after `Velopack.Windows.Runtimes.RuntimeInfo.DownloadToFile(System.String%2cSystem.Action%7bSystem.Int32%7d%2cVelopack.Sources.IFileDownloader%2cMicrosoft.Extensions.Logging.ILogger)` -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L85) -```csharp title="Declaration" -public virtual Task InvokeInstaller(string pathToInstaller, bool isQuiet, ILogger log = null) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *pathToInstaller* | -| `System.Boolean` | *isQuiet* | -| `Microsoft.Extensions.Logging.ILogger` | *log* | - -### ToString() -The unique string representation of this runtime -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L109) -```csharp title="Declaration" -public override string ToString() -``` - -##### Returns - -`System.String` -### GetHashCode() -The unique hash code of this runtime -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L112) -```csharp title="Declaration" -public override int GetHashCode() -``` - -##### Returns - -`System.Int32` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInstallResult.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInstallResult.md deleted file mode 100644 index 8a73321..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.RuntimeInstallResult.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Enum Runtimes.RuntimeInstallResult -sidebar_label: Runtimes.RuntimeInstallResult -description: "Runtime installation result code" ---- -# Enum Runtimes.RuntimeInstallResult -Runtime installation result code - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L31) -```csharp title="Declaration" -public enum Runtimes.RuntimeInstallResult -``` -## Fields -### InstallSuccess -The install was successful -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L34) -```csharp title="Declaration" -InstallSuccess = 0 -``` -### UserCancelled -The install failed because it was cancelled by the user -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L36) -```csharp title="Declaration" -UserCancelled = 1602 -``` -### AnotherInstallInProgress -The install failed because another install is in progress, try again later -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L38) -```csharp title="Declaration" -AnotherInstallInProgress = 1618 -``` -### RestartRequired -The install failed because a system restart is required before continuing -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L40) -```csharp title="Declaration" -RestartRequired = 3010 -``` -### SystemDoesNotMeetRequirements -The install failed because the current system does not support this runtime (outdated/unsupported) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L42) -```csharp title="Declaration" -SystemDoesNotMeetRequirements = 5100 -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist00.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist00.md deleted file mode 100644 index 7368e78..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist00.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Class Runtimes.VCRedist00 -sidebar_label: Runtimes.VCRedist00 -description: "Represents a VC++ redistributable package which is referenced by a permalink" ---- -# Class Runtimes.VCRedist00 -Represents a VC++ redistributable package which is referenced by a permalink - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L563) -```csharp title="Declaration" -public class Runtimes.VCRedist00 : Runtimes.VCRedistInfo -``` -**Inheritance:** `System.Object` -> [Velopack.Windows.Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) -> [Velopack.Windows.Runtimes.VCRedistInfo](../Velopack.Windows/Runtimes.VCRedistInfo) - -## Properties -### DownloadUrl -Permalink to the installer for this runtime -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L566) -```csharp title="Declaration" -public string DownloadUrl { get; } -``` -## Methods -### GetDownloadUrl() -Retrieves the web url to the latest compatible runtime installer exe -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L576) -```csharp title="Declaration" -public override Task GetDownloadUrl() -``` - -##### Returns - -`System.Threading.Tasks.Task` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist14.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist14.md deleted file mode 100644 index aa4b995..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedist14.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Class Runtimes.VCRedist14 -sidebar_label: Runtimes.VCRedist14 -description: "Represents a VC++ 2015-2022 redistributable package." ---- -# Class Runtimes.VCRedist14 -Represents a VC++ 2015-2022 redistributable package. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L539) -```csharp title="Declaration" -public class Runtimes.VCRedist14 : Runtimes.VCRedistInfo -``` -**Inheritance:** `System.Object` -> [Velopack.Windows.Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) -> [Velopack.Windows.Runtimes.VCRedistInfo](../Velopack.Windows/Runtimes.VCRedistInfo) - -## Methods -### GetDownloadUrl() -Retrieves the web url to the latest compatible runtime installer exe -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L548) -```csharp title="Declaration" -public override Task GetDownloadUrl() -``` - -##### Returns - -`System.Threading.Tasks.Task` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedistInfo.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedistInfo.md deleted file mode 100644 index 71fb1c3..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.VCRedistInfo.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Class Runtimes.VCRedistInfo -sidebar_label: Runtimes.VCRedistInfo -description: "The base class for a VC++ redistributable package." ---- -# Class Runtimes.VCRedistInfo -The base class for a VC++ redistributable package. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L435) -```csharp title="Declaration" -public abstract class Runtimes.VCRedistInfo : Runtimes.RuntimeInfo -``` -**Inheritance:** `System.Object` -> [Velopack.Windows.Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) - -**Derived:** -[Velopack.Windows.Runtimes.VCRedist00](../Velopack.Windows/Runtimes.VCRedist00), [Velopack.Windows.Runtimes.VCRedist14](../Velopack.Windows/Runtimes.VCRedist14) - -## Properties -### MinVersion -The minimum compatible version that must be installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L438) -```csharp title="Declaration" -public NuGetVersion MinVersion { get; } -``` -### CpuArchitecture -The CPU architecture of the runtime. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L441) -```csharp title="Declaration" -public RuntimeCpu CpuArchitecture { get; } -``` -## Methods -### CheckIsInstalled() -Check if a runtime compatible with the current instance is installed on this system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L451) -```csharp title="Declaration" -public override Task CheckIsInstalled() -``` - -##### Returns - -`System.Threading.Tasks.Task` -### CheckIsSupported() -Check if this runtime is supported on the current system -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/RuntimeInfo.cs#L461) -```csharp title="Declaration" -public override Task CheckIsSupported() -``` - -##### Returns - -`System.Threading.Tasks.Task` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.md deleted file mode 100644 index 53b9a1c..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Runtimes.md +++ /dev/null @@ -1,283 +0,0 @@ ---- -title: Class Runtimes -sidebar_label: Runtimes -description: "Contains static properties to access common supported runtimes, and a function to search for a runtime by name" ---- -# Class Runtimes -Contains static properties to access common supported runtimes, and a function to search for a runtime by name - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L10) -```csharp title="Declaration" -[Obsolete("These classes are no longer used by Velopack, and does not represent the current supported runtimes. https://github.com/velopack/velopack/blob/master/docs/bootstrapping.md")] -public static class Runtimes -``` -## Fields -### NETFRAMEWORK45 -Runtime for .NET Framework 4.5 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L15) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK45 -``` -### NETFRAMEWORK451 -Runtime for .NET Framework 4.5.1 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L18) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK451 -``` -### NETFRAMEWORK452 -Runtime for .NET Framework 4.5.2 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L21) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK452 -``` -### NETFRAMEWORK46 -Runtime for .NET Framework 4.6 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L24) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK46 -``` -### NETFRAMEWORK461 -Runtime for .NET Framework 4.6.1 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L27) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK461 -``` -### NETFRAMEWORK462 -Runtime for .NET Framework 4.6.2 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L29) -```csharp title="Declaration" -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK462 -``` -### NETFRAMEWORK47 -Runtime for .NET Framework 4.7 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L31) -```csharp title="Declaration" -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK47 -``` -### NETFRAMEWORK471 -Runtime for .NET Framework 4.7.1 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L33) -```csharp title="Declaration" -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK471 -``` -### NETFRAMEWORK472 -Runtime for .NET Framework 4.7.2 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L35) -```csharp title="Declaration" -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK472 -``` -### NETFRAMEWORK48 -Runtime for .NET Framework 4.8 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L37) -```csharp title="Declaration" -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK48 -``` -### NETFRAMEWORK481 -Runtime for .NET Framework 4.8.1 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L39) -```csharp title="Declaration" -public static readonly Runtimes.FrameworkInfo NETFRAMEWORK481 -``` -### DOTNETCORE31_X86 -Runtime for .NET Core 3.1 Desktop Runtime (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L44) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.DotnetInfo DOTNETCORE31_X86 -``` -### DOTNETCORE31_X64 -Runtime for .NET Core 3.1 Desktop Runtime (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L47) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.DotnetInfo DOTNETCORE31_X64 -``` -### DOTNET5_X86 -Runtime for .NET 5.0 Desktop Runtime (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L50) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.DotnetInfo DOTNET5_X86 -``` -### DOTNET5_X64 -Runtime for .NET 5.0 Desktop Runtime (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L53) -```csharp title="Declaration" -[Obsolete("EOL")] -public static readonly Runtimes.DotnetInfo DOTNET5_X64 -``` -### DOTNET6_X86 -Runtime for .NET 6.0 Desktop Runtime (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L55) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET6_X86 -``` -### DOTNET6_X64 -Runtime for .NET 6.0 Desktop Runtime (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L57) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET6_X64 -``` -### DOTNET6_ARM64 -Runtime for .NET 6.0 Desktop Runtime (arm64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L59) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET6_ARM64 -``` -### DOTNET7_X86 -Runtime for .NET 7.0 Desktop Runtime (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L61) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET7_X86 -``` -### DOTNET7_X64 -Runtime for .NET 7.0 Desktop Runtime (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L63) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET7_X64 -``` -### DOTNET7_ARM64 -Runtime for .NET 7.0 Desktop Runtime (arm64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L65) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET7_ARM64 -``` -### DOTNET8_X86 -Runtime for .NET 8.0 Desktop Runtime (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L67) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET8_X86 -``` -### DOTNET8_X64 -Runtime for .NET 8.0 Desktop Runtime (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L69) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET8_X64 -``` -### DOTNET8_ARM64 -Runtime for .NET 8.0 Desktop Runtime (arm64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L71) -```csharp title="Declaration" -public static readonly Runtimes.DotnetInfo DOTNET8_ARM64 -``` -### VCREDIST100_X86 -Runtime for Visual C++ 2010 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L75) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist00 VCREDIST100_X86 -``` -### VCREDIST100_X64 -Runtime for Visual C++ 2010 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L78) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist00 VCREDIST100_X64 -``` -### VCREDIST110_X86 -Runtime for Visual C++ 2012 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L81) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist00 VCREDIST110_X86 -``` -### VCREDIST110_X64 -Runtime for Visual C++ 2012 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L84) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist00 VCREDIST110_X64 -``` -### VCREDIST120_X86 -Runtime for Visual C++ 2013 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L87) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist00 VCREDIST120_X86 -``` -### VCREDIST120_X64 -Runtime for Visual C++ 2013 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L90) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist00 VCREDIST120_X64 -``` -### VCREDIST140_X86 -Runtime for Visual C++ 2015 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L93) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST140_X86 -``` -### VCREDIST140_X64 -Runtime for Visual C++ 2015 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L95) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST140_X64 -``` -### VCREDIST141_X86 -Runtime for Visual C++ 2017 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L97) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST141_X86 -``` -### VCREDIST141_X64 -Runtime for Visual C++ 2017 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L99) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST141_X64 -``` -### VCREDIST142_X86 -Runtime for Visual C++ 2019 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L101) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST142_X86 -``` -### VCREDIST142_X64 -Runtime for Visual C++ 2019 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L103) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST142_X64 -``` -### VCREDIST143_X86 -Runtime for Visual C++ 2022 Redistributable (x86) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L105) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST143_X86 -``` -### VCREDIST143_X64 -Runtime for Visual C++ 2022 Redistributable (x64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L107) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST143_X64 -``` -### VCREDIST143_ARM64 -Runtime for Visual C++ 2022 Redistributable (arm64) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L109) -```csharp title="Declaration" -public static readonly Runtimes.VCRedist14 VCREDIST143_ARM64 -``` -### All -An array of all the currently supported runtimes -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L112) -```csharp title="Declaration" -public static readonly Runtimes.RuntimeInfo[] All -``` -## Methods -### GetRuntimeByName(string) -Search for a runtime by name. If a platform architecture is not specified, the default is x64. -Returns null if no match is found. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Runtimes.cs#L127) -```csharp title="Declaration" -public static Runtimes.RuntimeInfo GetRuntimeByName(string name) -``` - -##### Returns - -[Velopack.Windows.Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *name* | - diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.EShellLinkResolveFlags.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.EShellLinkResolveFlags.md deleted file mode 100644 index 96b4f90..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.EShellLinkResolveFlags.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: Enum ShellLink.EShellLinkResolveFlags -sidebar_label: ShellLink.EShellLinkResolveFlags -description: "Flags determining how the links with missing -targets are resolved." ---- -# Enum ShellLink.EShellLinkResolveFlags -Flags determining how the links with missing -targets are resolved. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L410) -```csharp title="Declaration" -[Flags] -public enum ShellLink.EShellLinkResolveFlags : uint -``` -## Fields -### SLR_ANY_MATCH -Allow any match during resolution. Has no effect -on ME/2000 or above, use the other flags instead. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L417) -```csharp title="Declaration" -SLR_ANY_MATCH = 2 -``` -### SLR_INVOKE_MSI -Call the Microsoft Windows Installer. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L422) -```csharp title="Declaration" -SLR_INVOKE_MSI = 128 -``` -### SLR_NOLINKINFO -Disable distributed link tracking. By default, -distributed link tracking tracks removable media -across multiple devices based on the volume name. -It also uses the UNC path to track remote file -systems whose drive letter has changed. Setting -SLR_NOLINKINFO disables both types of tracking. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L432) -```csharp title="Declaration" -SLR_NOLINKINFO = 64 -``` -### SLR_NO_UI -Do not display a dialog box if the link cannot be resolved. -When SLR_NO_UI is set, a time-out value that specifies the -maximum amount of time to be spent resolving the link can -be specified in milliseconds. The function returns if the -link cannot be resolved within the time-out duration. -If the timeout is not set, the time-out duration will be -set to the default value of 3,000 milliseconds (3 seconds). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L443) -```csharp title="Declaration" -SLR_NO_UI = 1 -``` -### SLR_NO_UI_WITH_MSG_PUMP -Not documented in SDK. Assume same as SLR_NO_UI but -intended for applications without a hWnd. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L449) -```csharp title="Declaration" -SLR_NO_UI_WITH_MSG_PUMP = 257 -``` -### SLR_NOUPDATE -Do not update the link information. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L454) -```csharp title="Declaration" -SLR_NOUPDATE = 8 -``` -### SLR_NOSEARCH -Do not execute the search heuristics. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L459) -```csharp title="Declaration" -SLR_NOSEARCH = 16 -``` -### SLR_NOTRACK -Do not use distributed link tracking. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L464) -```csharp title="Declaration" -SLR_NOTRACK = 32 -``` -### SLR_UPDATE -If the link object has changed, update its path and list -of identifiers. If SLR_UPDATE is set, you do not need to -call IPersistFile::IsDirty to determine whether or not -the link object has changed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L472) -```csharp title="Declaration" -SLR_UPDATE = 4 -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.LinkDisplayMode.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.LinkDisplayMode.md deleted file mode 100644 index 3aebf71..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.LinkDisplayMode.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Enum ShellLink.LinkDisplayMode -sidebar_label: ShellLink.LinkDisplayMode ---- -# Enum ShellLink.LinkDisplayMode - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L475) -```csharp title="Declaration" -public enum ShellLink.LinkDisplayMode : uint -``` -## Fields -### edmNormal - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L477) -```csharp title="Declaration" -edmNormal = 1 -``` -### edmMinimized - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L478) -```csharp title="Declaration" -edmMinimized = 7 -``` -### edmMaximized - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L479) -```csharp title="Declaration" -edmMaximized = 3 -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PROPERTYKEY.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PROPERTYKEY.md deleted file mode 100644 index db0d31c..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PROPERTYKEY.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Struct ShellLink.PROPERTYKEY -sidebar_label: ShellLink.PROPERTYKEY ---- -# Struct ShellLink.PROPERTYKEY - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L109) -```csharp title="Declaration" -public struct ShellLink.PROPERTYKEY -``` -## Properties -### PKEY_AppUserModel_ID - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L115) -```csharp title="Declaration" -public static ShellLink.PROPERTYKEY PKEY_AppUserModel_ID { get; } -``` -### PKEY_AppUserModel_ToastActivatorCLSID - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L124) -```csharp title="Declaration" -public static ShellLink.PROPERTYKEY PKEY_AppUserModel_ToastActivatorCLSID { get; } -``` -## Fields -### fmtid - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L112) -```csharp title="Declaration" -public Guid fmtid -``` -### pid - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L113) -```csharp title="Declaration" -public UIntPtr pid -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PropVariant.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PropVariant.md deleted file mode 100644 index d0cd38d..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.PropVariant.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: Struct ShellLink.PropVariant -sidebar_label: ShellLink.PropVariant ---- -# Struct ShellLink.PropVariant - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L62) -```csharp title="Declaration" -public struct ShellLink.PropVariant -``` -## Fields -### variantType - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L65) -```csharp title="Declaration" -public short variantType -``` -### Reserved1 - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L66) -```csharp title="Declaration" -public short Reserved1 -``` -### Reserved2 - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L66) -```csharp title="Declaration" -public short Reserved2 -``` -### Reserved3 - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L66) -```csharp title="Declaration" -public short Reserved3 -``` -### pointerValue - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L67) -```csharp title="Declaration" -public IntPtr pointerValue -``` -## Methods -### FromString(string) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L69) -```csharp title="Declaration" -public static ShellLink.PropVariant FromString(string str) -``` - -##### Returns - -[Velopack.Windows.ShellLink.PropVariant](../Velopack.Windows/ShellLink.PropVariant) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *str* | - -### FromGuid(Guid) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L79) -```csharp title="Declaration" -public static ShellLink.PropVariant FromGuid(Guid guid) -``` - -##### Returns - -[Velopack.Windows.ShellLink.PropVariant](../Velopack.Windows/ShellLink.PropVariant) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Guid` | *guid* | - -### Clear() -Called to clear the PropVariant's referenced and local memory. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L103) -```csharp title="Declaration" -public void Clear() -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.md deleted file mode 100644 index 32f1678..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShellLink.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -title: Class ShellLink -sidebar_label: ShellLink -description: "Summary description for ShellLink." ---- -# Class ShellLink -Summary description for ShellLink. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L17) -```csharp title="Declaration" -public class ShellLink : IDisposable -``` -**Implements:** -`System.IDisposable` - -## Properties -### ShortCutFile - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L532) -```csharp title="Declaration" -public string ShortCutFile { get; set; } -``` -### IconPath -Gets the path to the file containing the icon for this shortcut. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L594) -```csharp title="Declaration" -public string IconPath { get; set; } -``` -### IconIndex -Gets the index of this icon within the icon path's resources -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L628) -```csharp title="Declaration" -public int IconIndex { get; set; } -``` -### Target -Gets/sets the fully qualified path to the link's target -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L662) -```csharp title="Declaration" -public string Target { get; set; } -``` -### WorkingDirectory -Gets/sets the Working Directory for the Link -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L688) -```csharp title="Declaration" -public string WorkingDirectory { get; set; } -``` -### Description -Gets/sets the description of the link -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L710) -```csharp title="Declaration" -public string Description { get; set; } -``` -### Arguments -Gets/sets any command line arguments associated with the link -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L732) -```csharp title="Declaration" -public string Arguments { get; set; } -``` -### DisplayMode -Gets/sets the initial display mode when the shortcut is -run -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L755) -```csharp title="Declaration" -public ShellLink.LinkDisplayMode DisplayMode { get; set; } -``` -### HotKey -Gets/sets the HotKey to start the shortcut (if any) -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L777) -```csharp title="Declaration" -public short HotKey { get; set; } -``` -## Methods -### ~ShellLink() -Call dispose just in case it hasn't happened yet -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L512) -```csharp title="Declaration" -protected ~ShellLink() -``` -### Dispose() -Dispose the object, releasing the COM ShellLink object -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L520) -```csharp title="Declaration" -public void Dispose() -``` -### GetIcon(bool) -This pointer must be destroyed with DistroyIcon when you are done with it. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L541) -```csharp title="Declaration" -public IntPtr GetIcon(bool large) -``` - -##### Returns - -`System.IntPtr` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.Boolean` | *large* | Whether to return the small or large icon | - -### SetAppUserModelId(string) -Sets the appUserModelId -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L799) -```csharp title="Declaration" -public void SetAppUserModelId(string appId) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *appId* | - -### SetToastActivatorCLSID(string) -Sets the ToastActivatorCLSID -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L810) -```csharp title="Declaration" -public void SetToastActivatorCLSID(string clsid) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *clsid* | - -### SetToastActivatorCLSID(Guid) -Sets the ToastActivatorCLSID -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L819) -```csharp title="Declaration" -public void SetToastActivatorCLSID(Guid clsid) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Guid` | *clsid* | - -### Save() -Saves the shortcut to ShortCutFile. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L840) -```csharp title="Declaration" -public void Save() -``` -### Save(string) -Saves the shortcut to the specified file -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L849) -```csharp title="Declaration" -public void Save(string linkFile) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *linkFile* | The shortcut file (.lnk) | - -### Open(string) -Loads a shortcut from the specified file -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L867) -```csharp title="Declaration" -public void Open(string linkFile) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *linkFile* | The shortcut file (.lnk) to load | - -### Open(string, IntPtr, EShellLinkResolveFlags) -Loads a shortcut from the specified file, and allows flags controlling -the UI behaviour if the shortcut's target isn't found to be set. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L885) -```csharp title="Declaration" -public void Open(string linkFile, IntPtr hWnd, ShellLink.EShellLinkResolveFlags resolveFlags) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *linkFile* | The shortcut file (.lnk) to load | -| `System.IntPtr` | *hWnd* | The window handle of the application's UI, if any | -| [Velopack.Windows.ShellLink.EShellLinkResolveFlags](../Velopack.Windows/ShellLink.EShellLinkResolveFlags) | *resolveFlags* | Flags controlling resolution behaviour | - -### Open(string, IntPtr, EShellLinkResolveFlags, ushort) -Loads a shortcut from the specified file, and allows flags controlling -the UI behaviour if the shortcut's target isn't found to be set. If -no SLR_NO_UI is specified, you can also specify a timeout. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/ShellLink.cs#L906) -```csharp title="Declaration" -public void Open(string linkFile, IntPtr hWnd, ShellLink.EShellLinkResolveFlags resolveFlags, ushort timeOut) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *linkFile* | The shortcut file (.lnk) to load | -| `System.IntPtr` | *hWnd* | The window handle of the application's UI, if any | -| [Velopack.Windows.ShellLink.EShellLinkResolveFlags](../Velopack.Windows/ShellLink.EShellLinkResolveFlags) | *resolveFlags* | Flags controlling resolution behaviour | -| `System.UInt16` | *timeOut* | Timeout if SLR_NO_UI is specified, in ms. | - - -## Implements - -* `System.IDisposable` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShortcutLocation.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShortcutLocation.md deleted file mode 100644 index e98bc9f..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/ShortcutLocation.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Enum ShortcutLocation -sidebar_label: ShortcutLocation -description: "Specifies several common places where shortcuts can be installed on a user's system" ---- -# Enum ShortcutLocation -Specifies several common places where shortcuts can be installed on a user's system - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L18) -```csharp title="Declaration" -[Flags] -public enum ShortcutLocation -``` -## Fields -### StartMenu -A shortcut in ProgramFiles within a publisher sub-directory -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L24) -```csharp title="Declaration" -StartMenu = 1 -``` -### Desktop -A shortcut on the current user desktop -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L29) -```csharp title="Declaration" -Desktop = 2 -``` -### Startup -A shortcut in Startup/Run folder will cause the app to be automatially started on user login. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L34) -```csharp title="Declaration" -Startup = 4 -``` -### AppRoot -A shortcut in the application folder, useful for portable applications. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L39) -```csharp title="Declaration" -AppRoot = 8 -``` -### StartMenuRoot -A shortcut in ProgramFiles root folder (not in a company/publisher sub-directory). This is commonplace as of more recent versions of windows. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L44) -```csharp title="Declaration" -StartMenuRoot = 16 -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Shortcuts.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Shortcuts.md deleted file mode 100644 index 0dbb8a4..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Shortcuts.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -title: Class Shortcuts -sidebar_label: Shortcuts -description: "A helper class to create or delete windows shortcuts." ---- -# Class Shortcuts -A helper class to create or delete windows shortcuts. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L50) -```csharp title="Declaration" -[Obsolete("Desktop and StartMenuRoot shortcuts are now created and removed automatically when your app is installed / uninstalled.")] -public class Shortcuts -``` -## Properties -### Log -Log for diagnostic messages. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L55) -```csharp title="Declaration" -protected ILogger Log { get; } -``` -### Locator -Locator to use for finding important application paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L58) -```csharp title="Declaration" -protected IVelopackLocator Locator { get; } -``` -## Methods -### CreateShortcutForThisExe(ShortcutLocation) -Create a shortcut to the currently running executable at the specified locations. -See `Velopack.Windows.Shortcuts.CreateShortcut(System.String%2cVelopack.Windows.ShortcutLocation%2cSystem.Boolean%2cSystem.String%2cSystem.String)` to create a shortcut to a different program -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L71) -```csharp title="Declaration" -public void CreateShortcutForThisExe(ShortcutLocation location = ShortcutLocation.Desktop | ShortcutLocation.StartMenuRoot) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *location* | - -### RemoveShortcutForThisExe(ShortcutLocation) -Removes a shortcut for the currently running executable at the specified locations -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L84) -```csharp title="Declaration" -public void RemoveShortcutForThisExe(ShortcutLocation location = ShortcutLocation.StartMenu | ShortcutLocation.Desktop | ShortcutLocation.StartMenuRoot) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *location* | - -### FindShortcuts(string, ShortcutLocation) -Searches for existing shortcuts to an executable inside the current package. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L96) -```csharp title="Declaration" -public Dictionary FindShortcuts(string relativeExeName, ShortcutLocation locations) -``` - -##### Returns - -`System.Collections.Generic.Dictionary` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *relativeExeName* | The relative path or filename of the executable (from the current app dir). | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *locations* | The locations to search. | - -### CreateShortcut(string, ShortcutLocation, bool, string, string) -Creates new shortcuts to the specified executable at the specified locations. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L132) -```csharp title="Declaration" -public void CreateShortcut(string relativeExeName, ShortcutLocation locations, bool updateOnly, string programArguments, string icon = null) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *relativeExeName* | The relative path or filename of the executable (from the current app dir). | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *locations* | The locations to create shortcuts. | -| `System.Boolean` | *updateOnly* | If true, shortcuts will be updated instead of created. | -| `System.String` | *programArguments* | The arguments the application should be launched with | -| `System.String` | *icon* | Path to a specific icon to use instead of the exe icon. | - -### DeleteShortcuts(string, ShortcutLocation) -Delete all the shortcuts for the specified executable in the specified locations. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L198) -```csharp title="Declaration" -public void DeleteShortcuts(string relativeExeName, ShortcutLocation locations) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *relativeExeName* | The relative path or filename of the executable (from the current app dir). | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *locations* | The locations to create shortcuts. | - -### LinkPathForVersionInfo(ShortcutLocation, ZipPackage, FileVersionInfo, string) -Given an [Velopack.NuGet.ZipPackage](../Velopack.NuGet/ZipPackage) and `System.Diagnostics.FileVersionInfo` return the target shortcut path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L228) -```csharp title="Declaration" -protected virtual string LinkPathForVersionInfo(ShortcutLocation location, ZipPackage package, FileVersionInfo versionInfo, string rootdir) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *location* | -| [Velopack.NuGet.ZipPackage](../Velopack.NuGet/ZipPackage) | *package* | -| `System.Diagnostics.FileVersionInfo` | *versionInfo* | -| `System.String` | *rootdir* | - -### GetLinkPath(ShortcutLocation, string, string, string, bool) -Given the application info, return the shortcut target path. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/Windows/Shortcuts.cs#L251) -```csharp title="Declaration" -protected virtual string GetLinkPath(ShortcutLocation location, string title, string applicationName, string rootdir, bool createDirectoryIfNecessary = true) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Windows.ShortcutLocation](../Velopack.Windows/ShortcutLocation) | *location* | -| `System.String` | *title* | -| `System.String` | *applicationName* | -| `System.String` | *rootdir* | -| `System.Boolean` | *createDirectoryIfNecessary* | - diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Velopack.Windows.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Velopack.Windows.md deleted file mode 100644 index c13b236..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack.Windows/Velopack.Windows.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Namespace Velopack.Windows -sidebar_label: Velopack.Windows ---- -# Namespace Velopack.Windows -## Classes -### [FileIcon](../Velopack.Windows/FileIcon) -Enables extraction of icons for any file type from -the Shell. -### [Runtimes](../Velopack.Windows/Runtimes) -Contains static properties to access common supported runtimes, and a function to search for a runtime by name -### [Runtimes.DotnetInfo](../Velopack.Windows/Runtimes.DotnetInfo) -Represents a modern DOTNET runtime where versions are deployed independenly of the operating system -### [Runtimes.FrameworkInfo](../Velopack.Windows/Runtimes.FrameworkInfo) -Represents a full .NET Framework runtime, usually included in Windows automatically through Windows Update -### [Runtimes.RuntimeInfo](../Velopack.Windows/Runtimes.RuntimeInfo) -Base type containing information about a runtime in relation to the current operating system -### [Runtimes.VCRedist00](../Velopack.Windows/Runtimes.VCRedist00) -Represents a VC++ redistributable package which is referenced by a permalink -### [Runtimes.VCRedist14](../Velopack.Windows/Runtimes.VCRedist14) -Represents a VC++ 2015-2022 redistributable package. -### [Runtimes.VCRedistInfo](../Velopack.Windows/Runtimes.VCRedistInfo) -The base class for a VC++ redistributable package. -### [ShellLink](../Velopack.Windows/ShellLink) -Summary description for ShellLink. -### [Shortcuts](../Velopack.Windows/Shortcuts) -A helper class to create or delete windows shortcuts. -## Structs -### [ShellLink.PROPERTYKEY](../Velopack.Windows/ShellLink.PROPERTYKEY) - -### [ShellLink.PropVariant](../Velopack.Windows/ShellLink.PropVariant) - -## Enums -### [FileIcon.SHGetFileInfoConstants](../Velopack.Windows/FileIcon.SHGetFileInfoConstants) - -### [Runtimes.DotnetRuntimeType](../Velopack.Windows/Runtimes.DotnetRuntimeType) -Dotnet Runtime SKU -### [Runtimes.RuntimeInstallResult](../Velopack.Windows/Runtimes.RuntimeInstallResult) -Runtime installation result code -### [ShellLink.EShellLinkResolveFlags](../Velopack.Windows/ShellLink.EShellLinkResolveFlags) -Flags determining how the links with missing -targets are resolved. -### [ShellLink.LinkDisplayMode](../Velopack.Windows/ShellLink.LinkDisplayMode) - -### [ShortcutLocation](../Velopack.Windows/ShortcutLocation) -Specifies several common places where shortcuts can be installed on a user's system diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RID.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RID.md deleted file mode 100644 index 8166a26..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RID.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: Class RID -sidebar_label: RID ---- -# Class RID - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L147) -```csharp title="Declaration" -public class RID : IEquatable -``` -**Implements:** -`System.IEquatable` - -## Properties -### BaseRID - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L153) -```csharp title="Declaration" -public RuntimeOs BaseRID { get; set; } -``` -### Version - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L155) -```csharp title="Declaration" -public RuntimeVersion Version { get; set; } -``` -### Architecture - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L156) -```csharp title="Declaration" -public RuntimeCpu Architecture { get; set; } -``` -### Qualifier - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L157) -```csharp title="Declaration" -public string Qualifier { get; set; } -``` -### HasVersion - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L313) -```csharp title="Declaration" -public bool HasVersion { get; } -``` -### HasArchitecture - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L315) -```csharp title="Declaration" -public bool HasArchitecture { get; } -``` -### HasQualifier - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L317) -```csharp title="Declaration" -public bool HasQualifier { get; } -``` -### IsValid - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L319) -```csharp title="Declaration" -public bool IsValid { get; } -``` -## Methods -### ToString() -Returns a string that represents the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L159) -```csharp title="Declaration" -public override string ToString() -``` - -##### Returns - -`System.String`: A string that represents the current object.### ToDisplay(RidDisplayType) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L161) -```csharp title="Declaration" -public string ToDisplay(RidDisplayType type) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.RidDisplayType](../Velopack/RidDisplayType) | *type* | - -### Parse(string) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L200) -```csharp title="Declaration" -public static RID Parse(string runtimeIdentifier) -``` - -##### Returns - -[Velopack.RID](../Velopack/RID) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *runtimeIdentifier* | - -### Equals(object) -Determines whether the specified object is equal to the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L321) -```csharp title="Declaration" -public override bool Equals(object obj) -``` - -##### Returns - -`System.Boolean`: true if the specified object is equal to the current object; otherwise, false. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.Object` | *obj* | The object to compare with the current object. | - -### Equals(RID) -Indicates whether the current object is equal to another object of the same type. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L326) -```csharp title="Declaration" -public bool Equals(RID obj) -``` - -##### Returns - -`System.Boolean`: true if the current object is equal to the <code class="paramref">other</code> parameter; otherwise, false. -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.RID](../Velopack/RID) | *obj* | - -### GetHashCode() -Serves as the default hash function. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L349) -```csharp title="Declaration" -public override int GetHashCode() -``` - -##### Returns - -`System.Int32`: A hash code for the current object. -## Implements - -* `System.IEquatable` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntry.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntry.md deleted file mode 100644 index 1553fe2..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntry.md +++ /dev/null @@ -1,287 +0,0 @@ ---- -title: Class ReleaseEntry -sidebar_label: ReleaseEntry -description: "Represents a Velopack release, as described in a RELEASES file - usually also with an -accompanying package containing the files needed to apply the release." ---- -# Class ReleaseEntry -Represents a Velopack release, as described in a RELEASES file - usually also with an -accompanying package containing the files needed to apply the release. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L96) -```csharp title="Declaration" -[DataContract] -[Obsolete("This release format has been replaced by VelopackRelease")] -public class ReleaseEntry -``` -## Properties -### Identity -The release identity - including id, version and so forth. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L101) -```csharp title="Declaration" -[IgnoreDataMember] -public ReleaseEntryName Identity { get; protected set; } -``` -### PackageId -The name or Id of the package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L104) -```csharp title="Declaration" -[DataMember] -public string PackageId { get; } -``` -### Version -The version of this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L107) -```csharp title="Declaration" -[DataMember] -public SemanticVersion Version { get; } -``` -### IsDelta -Whether this package represents a full update, or a delta update. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L110) -```csharp title="Declaration" -[DataMember] -public bool IsDelta { get; } -``` -### SHA1 -The SHA1 checksum of the update package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L113) -```csharp title="Declaration" -[DataMember] -public string SHA1 { get; protected set; } -``` -### BaseUrl -If the release corresponds to a remote http location, this will be the base url. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L116) -```csharp title="Declaration" -[DataMember] -public string BaseUrl { get; protected set; } -``` -### Query -The http url query (if applicable). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L119) -```csharp title="Declaration" -[DataMember] -public string Query { get; protected set; } -``` -### Filesize -The size in bytes of the update package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L122) -```csharp title="Declaration" -[DataMember] -public long Filesize { get; protected set; } -``` -### StagingPercentage -The percentage of users this package has been released to. This release -may or may not be applied if the current user is not in the staging group. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L128) -```csharp title="Declaration" -[DataMember] -public float? StagingPercentage { get; protected set; } -``` -### OriginalFilename -The filename of the update package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L131) -```csharp title="Declaration" -[DataMember] -public string OriginalFilename { get; protected set; } -``` -### EntryAsString -The unparsed text used to construct this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L134) -```csharp title="Declaration" -[IgnoreDataMember] -public string EntryAsString { get; } -``` -## Methods -### FromVelopackAsset(VelopackAsset) - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L189) -```csharp title="Declaration" -public static ReleaseEntry FromVelopackAsset(VelopackAsset asset) -``` - -##### Returns - -[Velopack.ReleaseEntry](../Velopack/ReleaseEntry) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *asset* | - -### ParseReleaseEntry(string) -Parses an string entry from a RELEASES file and returns a [Velopack.ReleaseEntry](../Velopack/ReleaseEntry). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L197) -```csharp title="Declaration" -public static ReleaseEntry ParseReleaseEntry(string entry) -``` - -##### Returns - -[Velopack.ReleaseEntry](../Velopack/ReleaseEntry) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *entry* | - -### IsStagingMatch(Guid?) -Checks if the current user is eligible for the current staging percentage. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L261) -```csharp title="Declaration" -public bool IsStagingMatch(Guid? userId) -``` - -##### Returns - -`System.Boolean` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Nullable` | *userId* | - -### ParseReleaseFile(string) -Parse the contents of a RELEASES file into a list of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry)'s. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L278) -```csharp title="Declaration" -public static IEnumerable ParseReleaseFile(string fileContents) -``` - -##### Returns - -`System.Collections.Generic.IEnumerable` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *fileContents* | - -### ParseReleaseFileAndApplyStaging(string, Guid?) -Parse the contents of a RELEASES file into a list of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry)'s, -with any staging-ineligible releases removed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L299) -```csharp title="Declaration" -public static IEnumerable ParseReleaseFileAndApplyStaging(string fileContents, Guid? userToken) -``` - -##### Returns - -`System.Collections.Generic.IEnumerable` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *fileContents* | -| `System.Nullable` | *userToken* | - -### WriteReleaseFile(IEnumerable<ReleaseEntry>, Stream) -Write a list of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry)'s to a stream -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L319) -```csharp title="Declaration" -public static void WriteReleaseFile(IEnumerable releaseEntries, Stream stream) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Collections.Generic.IEnumerable` | *releaseEntries* | -| `System.IO.Stream` | *stream* | - -### WriteReleaseFile(IEnumerable<ReleaseEntry>, string) -Write a list of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry)'s to a local file -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L335) -```csharp title="Declaration" -public static void WriteReleaseFile(IEnumerable releaseEntries, string path) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Collections.Generic.IEnumerable` | *releaseEntries* | -| `System.String` | *path* | - -### GenerateFromFile(Stream, string, string) -Generates a [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) from a local update package file (such as a nupkg). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L348) -```csharp title="Declaration" -public static ReleaseEntry GenerateFromFile(Stream file, string filename, string baseUrl = null) -``` - -##### Returns - -[Velopack.ReleaseEntry](../Velopack/ReleaseEntry) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.IO.Stream` | *file* | -| `System.String` | *filename* | -| `System.String` | *baseUrl* | - -### GenerateFromFile(string, string) -Generates a [Velopack.ReleaseEntry](../Velopack/ReleaseEntry) from a local update package file (such as a nupkg). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L360) -```csharp title="Declaration" -public static ReleaseEntry GenerateFromFile(string path, string baseUrl = null) -``` - -##### Returns - -[Velopack.ReleaseEntry](../Velopack/ReleaseEntry) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *path* | -| `System.String` | *baseUrl* | - -### BuildReleasesFile(string, bool) -Generates a list of [Velopack.ReleaseEntry](../Velopack/ReleaseEntry)'s from a local directory containing -package files. Also writes/updates a RELEASES file in the specified directory -to match the packages the are currently present. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L373) -```csharp title="Declaration" -public static List BuildReleasesFile(string releasePackagesDir, bool writeToDisk = true) -``` - -##### Returns - -`System.Collections.Generic.List`: The list of packages in the directory -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *releasePackagesDir* | -| `System.Boolean` | *writeToDisk* | - -### ToString() -Returns a string that represents the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L411) -```csharp title="Declaration" -public override string ToString() -``` - -##### Returns - -`System.String`: A string that represents the current object.### GetHashCode() -Serves as the default hash function. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L414) -```csharp title="Declaration" -public override int GetHashCode() -``` - -##### Returns - -`System.Int32`: A hash code for the current object. \ No newline at end of file diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntryName.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntryName.md deleted file mode 100644 index 97f1aa2..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseEntryName.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: Class ReleaseEntryName -sidebar_label: ReleaseEntryName -description: "Represents the information that can be parsed from a release entry filename." ---- -# Class ReleaseEntryName -Represents the information that can be parsed from a release entry filename. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L32) -```csharp title="Declaration" -[Obsolete("This release format has been replaced by VelopackRelease")] -public sealed record ReleaseEntryName : IEquatable -``` -**Implements:** -`System.IEquatable` - -## Properties -### PackageId -The package Id. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L36) -```csharp title="Declaration" -public string PackageId { get; } -``` -### Version -The package version. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L39) -```csharp title="Declaration" -public SemanticVersion Version { get; } -``` -### IsDelta -Whether this is a delta (patch) package, or a full update package. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L42) -```csharp title="Declaration" -public bool IsDelta { get; } -``` -## Methods -### FromEntryFileName(string) -Takes a filename such as 'My-Cool3-App-1.0.1-build.23-full.nupkg' and separates it into -it's name and version (eg. 'My-Cool3-App', and '1.0.1-build.23'). Returns null values if -the filename can not be parsed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L62) -```csharp title="Declaration" -public static ReleaseEntryName FromEntryFileName(string fileName) -``` - -##### Returns - -[Velopack.ReleaseEntryName](../Velopack/ReleaseEntryName) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *fileName* | - -### ToFileName() -Generate the file name which would represent this ReleaseEntryName. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L88) -```csharp title="Declaration" -public string ToFileName() -``` - -##### Returns - -`System.String` - -## Implements - -* `System.IEquatable` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseNotesFormat.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseNotesFormat.md deleted file mode 100644 index edef525..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/ReleaseNotesFormat.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Enum ReleaseNotesFormat -sidebar_label: ReleaseNotesFormat -description: "Describes the requested release notes text format." ---- -# Enum ReleaseNotesFormat -Describes the requested release notes text format. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L20) -```csharp title="Declaration" -[Obsolete("This release format has been replaced by VelopackRelease")] -public enum ReleaseNotesFormat -``` -## Fields -### Markdown -The original markdown release notes. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L24) -```csharp title="Declaration" -Markdown = 0 -``` -### Html -Release notes translated into HTML. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/ReleaseEntry.cs#L26) -```csharp title="Declaration" -Html = 1 -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RidDisplayType.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RidDisplayType.md deleted file mode 100644 index aa5c5cb..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RidDisplayType.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Enum RidDisplayType -sidebar_label: RidDisplayType ---- -# Enum RidDisplayType - - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L140) -```csharp title="Declaration" -public enum RidDisplayType -``` -## Fields -### NoVersion - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L142) -```csharp title="Declaration" -NoVersion = 0 -``` -### ShortVersion - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L143) -```csharp title="Declaration" -ShortVersion = 1 -``` -### FullVersion - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L144) -```csharp title="Declaration" -FullVersion = 2 -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeCpu.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeCpu.md deleted file mode 100644 index ba47e39..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeCpu.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Enum RuntimeCpu -sidebar_label: RuntimeCpu -description: "The Runtime CPU Architecture" ---- -# Enum RuntimeCpu -The Runtime CPU Architecture - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L44) -```csharp title="Declaration" -public enum RuntimeCpu : ushort -``` -## Fields -### Unknown -Unknown or unsupported -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L47) -```csharp title="Declaration" -Unknown = 0 -``` -### x86 -Intel x86 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L50) -```csharp title="Declaration" -x86 = 332 -``` -### x64 -x64 / Amd64 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L53) -```csharp title="Declaration" -x64 = 34404 -``` -### arm64 -Arm64 -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L56) -```csharp title="Declaration" -arm64 = 43620 -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeOs.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeOs.md deleted file mode 100644 index 1e6523f..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeOs.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Enum RuntimeOs -sidebar_label: RuntimeOs -description: "The Runtime OS" ---- -# Enum RuntimeOs -The Runtime OS - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L60) -```csharp title="Declaration" -public enum RuntimeOs -``` -## Fields -### Unknown -Unknown or unsupported -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L63) -```csharp title="Declaration" -Unknown = 0 -``` -### Windows -Windows -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L66) -```csharp title="Declaration" -Windows = 1 -``` -### Linux -Linux -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L69) -```csharp title="Declaration" -Linux = 2 -``` -### OSX -OSX -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L72) -```csharp title="Declaration" -OSX = 3 -``` -## Extension Methods -* [Velopack.VelopackRuntimeInfo.GetOsLongName(Velopack.RuntimeOs)](../Velopack/VelopackRuntimeInfo#getoslongnameruntimeos) -* [Velopack.VelopackRuntimeInfo.GetOsShortName(Velopack.RuntimeOs)](../Velopack/VelopackRuntimeInfo#getosshortnameruntimeos) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeVersion.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeVersion.md deleted file mode 100644 index f886408..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/RuntimeVersion.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -title: Class RuntimeVersion -sidebar_label: RuntimeVersion -description: "A Version class that also supports a single integer (major only)" ---- -# Class RuntimeVersion -A Version class that also supports a single integer (major only) - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L14) -```csharp title="Declaration" -public sealed class RuntimeVersion : IComparable, IComparable, IEquatable -``` -**Implements:** -`System.IComparable`, `System.IComparable`, `System.IEquatable` - -## Properties -### Major - -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L16) -```csharp title="Declaration" -public int Major { get; } -``` -## Methods -### CompareTo(object) -Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L48) -```csharp title="Declaration" -public int CompareTo(object obj) -``` - -##### Returns - -`System.Int32`: A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes <code class="paramref">obj</code> in the sort order. Zero This instance occurs in the same position in the sort order as <code class="paramref">obj</code>. Greater than zero This instance follows <code class="paramref">obj</code> in the sort order. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.Object` | *obj* | An object to compare with this instance. | - - -##### Exceptions - -`System.ArgumentException` -<code class="paramref">obj</code> is not the same type as this instance. -### CompareTo(RuntimeVersion) -Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L61) -```csharp title="Declaration" -public int CompareTo(RuntimeVersion other) -``` - -##### Returns - -`System.Int32`: A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes <code class="paramref">other</code> in the sort order. Zero This instance occurs in the same position in the sort order as <code class="paramref">other</code>. Greater than zero This instance follows <code class="paramref">other</code> in the sort order. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.RuntimeVersion](../Velopack/RuntimeVersion) | *other* | An object to compare with this instance. | - -### Equals(RuntimeVersion) -Indicates whether the current object is equal to another object of the same type. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L84) -```csharp title="Declaration" -public bool Equals(RuntimeVersion other) -``` - -##### Returns - -`System.Boolean`: true if the current object is equal to the <code class="paramref">other</code> parameter; otherwise, false. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.RuntimeVersion](../Velopack/RuntimeVersion) | *other* | An object to compare with this object. | - -### Equals(object) -Determines whether the specified object is equal to the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L91) -```csharp title="Declaration" -public override bool Equals(object obj) -``` - -##### Returns - -`System.Boolean`: true if the specified object is equal to the current object; otherwise, false. -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.Object` | *obj* | The object to compare with the current object. | - -### GetHashCode() -Serves as the default hash function. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L96) -```csharp title="Declaration" -public override int GetHashCode() -``` - -##### Returns - -`System.Int32`: A hash code for the current object.### ToString() -Returns a string that represents the current object. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/RID.cs#L101) -```csharp title="Declaration" -public override string ToString() -``` - -##### Returns - -`System.String`: A string that represents the current object. -## Implements - -* `System.IComparable` -* `System.IComparable` -* `System.IEquatable` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateExe.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateExe.md deleted file mode 100644 index d585126..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateExe.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Class UpdateExe -sidebar_label: UpdateExe -description: "A static helper class to assist in running Update.exe CLI commands. You probably should not invoke this directly, -instead you should use the relevant methods on [Velopack.UpdateManager](../Velopack/UpdateManager). For example: -[Velopack.UpdateManager.ApplyUpdatesAndExit(Velopack.VelopackAsset?)](../Velopack/UpdateManager#applyupdatesandexitvelopackasset), or `Velopack.UpdateManager.ApplyUpdatesAndRestart(Velopack.VelopackAsset%2cSystem.String%5b%5d)`." ---- -# Class UpdateExe -A static helper class to assist in running Update.exe CLI commands. You probably should not invoke this directly, -instead you should use the relevant methods on [Velopack.UpdateManager](../Velopack/UpdateManager). For example: -[Velopack.UpdateManager.ApplyUpdatesAndExit(Velopack.VelopackAsset?)](../Velopack/UpdateManager#applyupdatesandexitvelopackasset), or `Velopack.UpdateManager.ApplyUpdatesAndRestart(Velopack.VelopackAsset%2cSystem.String%5b%5d)`. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateExe.cs#L18) -```csharp title="Declaration" -public static class UpdateExe -``` -## Methods -### Apply(IVelopackLocator?, VelopackAsset?, bool, bool, string[]?, ILogger?) -Runs Update.exe in the current working directory to apply updates, optionally restarting the application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateExe.cs#L36) -```csharp title="Declaration" -public static void Apply(IVelopackLocator? locator, VelopackAsset? toApply, bool silent, bool restart, string[]? restartArgs = null, ILogger? logger = null) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) | *locator* | The locator to use to find the path to Update.exe and the packages directory. | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *toApply* | The update package you wish to apply, can be left null. | -| `System.Boolean` | *silent* | If true, no dialogs will be shown during the update process. This could result - in an update failing to install, such as when we need to ask the user for permission to install - a new framework dependency. | -| `System.Boolean` | *restart* | If true, restarts the application after updates are applied (or if they failed) | -| `System.String[]` | *restartArgs* | The arguments to pass to the application when it is restarted. | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | The logger to use for diagnostic messages | - - -##### Exceptions - -`System.Exception` -Thrown if Update.exe does not initialize properly. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateInfo.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateInfo.md deleted file mode 100644 index 4b215b4..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateInfo.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Class UpdateInfo -sidebar_label: UpdateInfo -description: "Holds information about the current version and pending updates, such as how many there are, and access to release notes." ---- -# Class UpdateInfo -Holds information about the current version and pending updates, such as how many there are, and access to release notes. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateInfo.cs#L6) -```csharp title="Declaration" -public class UpdateInfo -``` -## Properties -### TargetFullRelease -The available version that we are updating to. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateInfo.cs#L11) -```csharp title="Declaration" -public VelopackAsset TargetFullRelease { get; } -``` -### IsDowngrade -True if the update is a version downgrade or lateral move (such as when switching channels to the same version number). -In this case, only full updates are allowed, and any local packages on disk newer than the downloaded version will be -deleted. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateInfo.cs#L18) -```csharp title="Declaration" -public bool IsDowngrade { get; } -``` -### BaseRelease -The base release that we are to apply delta updates from. If null, we can try doing a delta update from -the currently installed version. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateInfo.cs#L24) -```csharp title="Declaration" -public VelopackAsset? BaseRelease { get; } -``` -### DeltasToTarget -The list of delta versions between the current version and [Velopack.UpdateInfo.TargetFullRelease](../Velopack/UpdateInfo#targetfullrelease). -These will be applied in order. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateInfo.cs#L30) -```csharp title="Declaration" -public VelopackAsset[] DeltasToTarget { get; } -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateManager.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateManager.md deleted file mode 100644 index 2f45db6..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateManager.md +++ /dev/null @@ -1,279 +0,0 @@ ---- -title: Class UpdateManager -sidebar_label: UpdateManager -description: "Provides functionality for checking for updates, downloading updates, and applying updates to the current application." ---- -# Class UpdateManager -Provides functionality for checking for updates, downloading updates, and applying updates to the current application. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.Helpers.cs#L6) -```csharp title="Declaration" -public class UpdateManager -``` -## Properties -### AppId -The currently installed application Id. This would be what you set when you create your release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L22) -```csharp title="Declaration" -public virtual string? AppId { get; } -``` -### IsInstalled -True if this application is currently installed, and is able to download/check for updates. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L25) -```csharp title="Declaration" -public virtual bool IsInstalled { get; } -``` -### IsUpdatePendingRestart -True if there is a local update prepared that requires a call to `Velopack.UpdateManager.ApplyUpdatesAndRestart(Velopack.VelopackAsset%2cSystem.String%5b%5d)` to be applied. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L28) -```csharp title="Declaration" -public virtual bool IsUpdatePendingRestart { get; } -``` -### CurrentVersion -The currently installed app version when you created your release. Null if this is not a currently installed app. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L38) -```csharp title="Declaration" -public virtual SemanticVersion? CurrentVersion { get; } -``` -### Source -The update source to use when checking for/downloading updates. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L41) -```csharp title="Declaration" -protected IUpdateSource Source { get; } -``` -### Log -The logger to use for diagnostic messages. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L44) -```csharp title="Declaration" -protected ILogger Log { get; } -``` -### Locator -The locator to use when searching for local file paths. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L47) -```csharp title="Declaration" -protected IVelopackLocator Locator { get; } -``` -### Channel -The channel to use when searching for packages. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L50) -```csharp title="Declaration" -protected string Channel { get; } -``` -### DefaultChannel -The default channel to search for packages in, if one was not provided by the user. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L53) -```csharp title="Declaration" -protected string DefaultChannel { get; } -``` -### IsNonDefaultChannel -If true, an explicit channel was provided by the user, and it's different than the default channel. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L56) -```csharp title="Declaration" -protected bool IsNonDefaultChannel { get; } -``` -### ShouldAllowVersionDowngrade -If true, UpdateManager should return the latest asset in the feed, even if that version is lower than the current version. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L59) -```csharp title="Declaration" -protected bool ShouldAllowVersionDowngrade { get; } -``` -## Methods -### CheckForUpdates() -Checks for updates, returning null if there are none available. If there are updates available, this method will return an -UpdateInfo object containing the latest available release, and any delta updates that can be applied if they are available. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L98) -```csharp title="Declaration" -public UpdateInfo? CheckForUpdates() -``` - -##### Returns - -[Velopack.UpdateInfo](../Velopack/UpdateInfo): Null if no updates, otherwise [Velopack.UpdateInfo](../Velopack/UpdateInfo) containing the version of the latest update available.### CheckForUpdatesAsync() -Checks for updates, returning null if there are none available. If there are updates available, this method will return an -UpdateInfo object containing the latest available release, and any delta updates that can be applied if they are available. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L109) -```csharp title="Declaration" -public virtual Task CheckForUpdatesAsync() -``` - -##### Returns - -`System.Threading.Tasks.Task`: Null if no updates, otherwise [Velopack.UpdateInfo](../Velopack/UpdateInfo) containing the version of the latest update available.### CreateDeltaUpdateStrategy(VelopackAsset[], VelopackAsset?, VelopackAsset) -Given a feed of releases, and the latest local full release, and the latest remote full release, this method will return a delta -update strategy to be used by `Velopack.UpdateManager.DownloadUpdatesAsync(Velopack.UpdateInfo%2cSystem.Action%7bSystem.Int32%7d%2cSystem.Boolean%2cSystem.Threading.CancellationToken)`. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L155) -```csharp title="Declaration" -protected virtual UpdateInfo CreateDeltaUpdateStrategy(VelopackAsset[] feed, VelopackAsset? latestLocalFull, VelopackAsset latestRemoteFull) -``` - -##### Returns - -[Velopack.UpdateInfo](../Velopack/UpdateInfo) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `Velopack.VelopackAsset[]` | *feed* | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestLocalFull* | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *latestRemoteFull* | - -### DownloadUpdates(UpdateInfo, Action<int>?, bool) -Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, -this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta -packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock -so may fail if there is already another update operation in progress. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L183) -```csharp title="Declaration" -public void DownloadUpdates(UpdateInfo updates, Action? progress = null, bool ignoreDeltas = false) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.UpdateInfo](../Velopack/UpdateInfo) | *updates* | The updates to download. Should be retrieved from [Velopack.UpdateManager.CheckForUpdates()](../Velopack/UpdateManager#checkforupdates). | -| `System.Action` | *progress* | The progress callback. Will be called with values from 0-100. | -| `System.Boolean` | *ignoreDeltas* | Whether to attempt downloading delta's or skip to full package download. | - -### DownloadUpdatesAsync(UpdateInfo, Action<int>?, bool, CancellationToken) -Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, -this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta -packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock -so may fail if there is already another update operation in progress. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L199) -```csharp title="Declaration" -public virtual Task DownloadUpdatesAsync(UpdateInfo updates, Action? progress = null, bool ignoreDeltas = false, CancellationToken cancelToken = default) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.UpdateInfo](../Velopack/UpdateInfo) | *updates* | The updates to download. Should be retrieved from [Velopack.UpdateManager.CheckForUpdates()](../Velopack/UpdateManager#checkforupdates). | -| `System.Action` | *progress* | The progress callback. Will be called with values from 0-100. | -| `System.Boolean` | *ignoreDeltas* | Whether to attempt downloading delta's or skip to full package download. | -| `System.Threading.CancellationToken` | *cancelToken* | An optional cancellation token if you wish to stop this operation. | - -### DownloadAndApplyDeltaUpdates(string, UpdateInfo, Action<int>, CancellationToken) -Given a folder containing the extracted base package, and a list of delta updates, downloads and applies the -delta updates to the base package. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L328) -```csharp title="Declaration" -protected virtual Task DownloadAndApplyDeltaUpdates(string extractedBasePackage, UpdateInfo updates, Action progress, CancellationToken cancelToken) -``` - -##### Returns - -`System.Threading.Tasks.Task` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `System.String` | *extractedBasePackage* | A folder containing the application files to apply the delta's to. | -| [Velopack.UpdateInfo](../Velopack/UpdateInfo) | *updates* | An update object containing one or more delta's | -| `System.Action` | *progress* | A callback reporting process of delta application progress (from 0-100). | -| `System.Threading.CancellationToken` | *cancelToken* | A token to use to cancel the request. | - -### CleanPackagesExcept(string?) -Removes any incomplete files (.partial) and packages (.nupkg) from the packages directory that does not match -the provided asset. If assetToKeep is null, all packages will be deleted. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L379) -```csharp title="Declaration" -protected virtual void CleanPackagesExcept(string? assetToKeep) -``` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *assetToKeep* | - -### VerifyPackageChecksum(VelopackAsset, string?) -Check a package checksum against the one in the release entry, and throws if the checksum does not match. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L416) -```csharp title="Declaration" -protected virtual void VerifyPackageChecksum(VelopackAsset release, string? filePathOverride = null) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *release* | The entry to check | -| `System.String` | *filePathOverride* | Optional file path, if not specified the package will be loaded from %pkgdir%/release.OriginalFilename. | - -### EnsureInstalled() -Throws an exception if the current application is not installed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L439) -```csharp title="Declaration" -protected virtual void EnsureInstalled() -``` -### AcquireUpdateLock() -Acquires a globally unique mutex/lock for the current application, to avoid concurrent install/uninstall/update operations. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.cs#L448) -```csharp title="Declaration" -protected virtual Mutex AcquireUpdateLock() -``` - -##### Returns - -`System.Threading.Mutex` -### ApplyUpdatesAndRestart(VelopackAsset?, string[]?) -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified -restart arguments. If you need to save state or clean up, you should do that before calling this method. -The user may be prompted during the update, if the update requires additional frameworks to be installed etc. -You can check if there are pending updates by checking [Velopack.UpdateManager.IsUpdatePendingRestart](../Velopack/UpdateManager#isupdatependingrestart). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.Helpers.cs#L22) -```csharp title="Declaration" -public void ApplyUpdatesAndRestart(VelopackAsset? toApply, string[]? restartArgs = null) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *toApply* | The target release to apply. Can be left null to auto-apply the newest downloaded release. | -| `System.String[]` | *restartArgs* | The arguments to pass to the application when it is restarted. | - -### ApplyUpdatesAndExit(VelopackAsset?) -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified -restart arguments. If you need to save state or clean up, you should do that before calling this method. -The user may be prompted during the update, if the update requires additional frameworks to be installed etc. -You can check if there are pending updates by checking [Velopack.UpdateManager.IsUpdatePendingRestart](../Velopack/UpdateManager#isupdatependingrestart). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.Helpers.cs#L41) -```csharp title="Declaration" -public void ApplyUpdatesAndExit(VelopackAsset? toApply) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *toApply* | The target release to apply. Can be left null to auto-apply the newest downloaded release. | - -### WaitExitThenApplyUpdates(VelopackAsset?, bool, bool, string[]?) -This will launch the Velopack updater and tell it to wait for this program to exit gracefully. -You should then clean up any state and exit your app. The updater will apply updates and then -optionally restart your app. The updater will only wait for 60 seconds before giving up. -You can check if there are pending updates by checking [Velopack.UpdateManager.IsUpdatePendingRestart](../Velopack/UpdateManager#isupdatependingrestart). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateManager.Helpers.cs#L57) -```csharp title="Declaration" -public void WaitExitThenApplyUpdates(VelopackAsset? toApply, bool silent = false, bool restart = true, string[]? restartArgs = null) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| [Velopack.VelopackAsset](../Velopack/VelopackAsset) | *toApply* | The target release to apply. Can be left null to auto-apply the newest downloaded release. | -| `System.Boolean` | *silent* | Configure whether Velopack should show a progress window / dialogs during the updates or not. | -| `System.Boolean` | *restart* | Configure whether Velopack should restart the app after the updates have been applied. | -| `System.String[]` | *restartArgs* | The arguments to pass to the application when it is restarted. | - diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateOptions.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateOptions.md deleted file mode 100644 index 543b510..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/UpdateOptions.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Class UpdateOptions -sidebar_label: UpdateOptions -description: "Options to customise the behaviour of [Velopack.UpdateManager](../Velopack/UpdateManager)." ---- -# Class UpdateOptions -Options to customise the behaviour of [Velopack.UpdateManager](../Velopack/UpdateManager). - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateOptions.cs#L6) -```csharp title="Declaration" -public class UpdateOptions -``` -## Properties -### AllowVersionDowngrade -Allows UpdateManager to update to a version that's lower than the current version (i.e. downgrading). -This could happen if a release has bugs and was retracted from the release feed, or if you're using -[Velopack.UpdateOptions.ExplicitChannel](../Velopack/UpdateOptions#explicitchannel) to switch channels to another channel where the latest version on that -channel is lower than the current version. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateOptions.cs#L14) -```csharp title="Declaration" -public bool AllowVersionDowngrade { get; set; } -``` -### ExplicitChannel -<b>This option should usually be left null</b>. Overrides the default channel used to fetch updates. -The default channel will be whatever channel was specified on the command line when building this release. -For example, if the current release was packaged with '--channel beta', then the default channel will be 'beta'. -This allows users to automatically receive updates from the same channel they installed from. This options -allows you to explicitly switch channels, for example if the user wished to switch back to the 'stable' channel -without having to reinstall the application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/UpdateOptions.cs#L24) -```csharp title="Declaration" -public string? ExplicitChannel { get; set; } -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/Velopack.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/Velopack.md deleted file mode 100644 index 01742fc..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/Velopack.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Namespace Velopack -sidebar_label: Velopack ---- -# Namespace Velopack -## Classes -### [ReleaseEntry](../Velopack/ReleaseEntry) -Represents a Velopack release, as described in a RELEASES file - usually also with an -accompanying package containing the files needed to apply the release. -### [ReleaseEntryName](../Velopack/ReleaseEntryName) -Represents the information that can be parsed from a release entry filename. -### [RID](../Velopack/RID) - -### [RuntimeVersion](../Velopack/RuntimeVersion) -A Version class that also supports a single integer (major only) -### [UpdateExe](../Velopack/UpdateExe) -A static helper class to assist in running Update.exe CLI commands. You probably should not invoke this directly, -instead you should use the relevant methods on [Velopack.UpdateManager](../Velopack/UpdateManager). For example: -[Velopack.UpdateManager.ApplyUpdatesAndExit(Velopack.VelopackAsset?)](../Velopack/UpdateManager#applyupdatesandexitvelopackasset), or `Velopack.UpdateManager.ApplyUpdatesAndRestart(Velopack.VelopackAsset%2cSystem.String%5b%5d)`. -### [UpdateInfo](../Velopack/UpdateInfo) -Holds information about the current version and pending updates, such as how many there are, and access to release notes. -### [UpdateManager](../Velopack/UpdateManager) -Provides functionality for checking for updates, downloading updates, and applying updates to the current application. -### [UpdateOptions](../Velopack/UpdateOptions) -Options to customise the behaviour of [Velopack.UpdateManager](../Velopack/UpdateManager). -### [VelopackApp](../Velopack/VelopackApp) -VelopackApp helps you to handle app activation events correctly. -This should be used as early as possible in your application startup code. -(eg. the beginning of Main() in Program.cs) -### [VelopackAsset](../Velopack/VelopackAsset) -An individual Velopack asset, could refer to an asset on-disk or in a remote package feed. -### [VelopackAssetFeed](../Velopack/VelopackAssetFeed) -A feed of Velopack assets, usually returned from an [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource). -### [VelopackRuntimeInfo](../Velopack/VelopackRuntimeInfo) -Convenience class which provides runtime information about the current executing process, -in a way that is safe in older and newer versions of the framework. -## Enums -### [ReleaseNotesFormat](../Velopack/ReleaseNotesFormat) -Describes the requested release notes text format. -### [RidDisplayType](../Velopack/RidDisplayType) - -### [RuntimeCpu](../Velopack/RuntimeCpu) -The Runtime CPU Architecture -### [RuntimeOs](../Velopack/RuntimeOs) -The Runtime OS -### [VelopackAssetType](../Velopack/VelopackAssetType) -Represents a Velopack Asset Type. -## Delegates -### [VelopackHook](../Velopack/VelopackHook) -A delegate type for handling Velopack startup events diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackApp.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackApp.md deleted file mode 100644 index b0df302..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackApp.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -title: Class VelopackApp -sidebar_label: VelopackApp -description: "VelopackApp helps you to handle app activation events correctly. -This should be used as early as possible in your application startup code. -(eg. the beginning of Main() in Program.cs)" ---- -# Class VelopackApp -VelopackApp helps you to handle app activation events correctly. -This should be used as early as possible in your application startup code. -(eg. the beginning of Main() in Program.cs) - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L23) -```csharp title="Declaration" -public sealed class VelopackApp -``` -## Methods -### Build() -Creates and returns a new Velopack application builder. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L45) -```csharp title="Declaration" -public static VelopackApp Build() -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) -### SetArgs(string[]) -Override the command line arguments used to determine the Velopack hook to run. -If this is not set, the command line arguments passed to the application will be used. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L51) -```csharp title="Declaration" -public VelopackApp SetArgs(string[] args) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String[]` | *args* | - -### SetAutoApplyOnStartup(bool) -Set whether to automatically apply downloaded updates on startup. This is ON by default. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L60) -```csharp title="Declaration" -public VelopackApp SetAutoApplyOnStartup(bool autoApply) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.Boolean` | *autoApply* | - -### SetLocator(IVelopackLocator) -Override the default [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) used to search for application paths. -This will be cached and potentially re-used throughout the lifetime of the application. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L70) -```csharp title="Declaration" -public VelopackApp SetLocator(IVelopackLocator locator) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.Locators.IVelopackLocator](../Velopack.Locators/IVelopackLocator) | *locator* | - -### WithFirstRun(VelopackHook) -This hook is triggered when the application is started for the first time after installation. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L79) -```csharp title="Declaration" -public VelopackApp WithFirstRun(VelopackHook hook) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackHook](../Velopack/VelopackHook) | *hook* | - -### WithRestarted(VelopackHook) -This hook is triggered when the application is restarted by Velopack after installing updates. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L88) -```csharp title="Declaration" -public VelopackApp WithRestarted(VelopackHook hook) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackHook](../Velopack/VelopackHook) | *hook* | - -### WithAfterInstallFastCallback(VelopackHook) -WARNING: FastCallback hooks are run during critical stages of Velopack operations. -Your code will be run and then `System.Environment.Exit(System.Int32)` will be called. -If your code has not completed within 30 seconds, it will be terminated. -Only supported on windows; On other operating systems, this will never be called. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L100) -```csharp title="Declaration" -public VelopackApp WithAfterInstallFastCallback(VelopackHook hook) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackHook](../Velopack/VelopackHook) | *hook* | - -### WithAfterUpdateFastCallback(VelopackHook) -WARNING: FastCallback hooks are run during critical stages of Velopack operations. -Your code will be run and then `System.Environment.Exit(System.Int32)` will be called. -If your code has not completed within 15 seconds, it will be terminated. -Only supported on windows; On other operating systems, this will never be called. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L113) -```csharp title="Declaration" -public VelopackApp WithAfterUpdateFastCallback(VelopackHook hook) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackHook](../Velopack/VelopackHook) | *hook* | - -### WithBeforeUpdateFastCallback(VelopackHook) -WARNING: FastCallback hooks are run during critical stages of Velopack operations. -Your code will be run and then `System.Environment.Exit(System.Int32)` will be called. -If your code has not completed within 15 seconds, it will be terminated. -Only supported on windows; On other operating systems, this will never be called. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L126) -```csharp title="Declaration" -public VelopackApp WithBeforeUpdateFastCallback(VelopackHook hook) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackHook](../Velopack/VelopackHook) | *hook* | - -### WithBeforeUninstallFastCallback(VelopackHook) -WARNING: FastCallback hooks are run during critical stages of Velopack operations. -Your code will be run and then `System.Environment.Exit(System.Int32)` will be called. -If your code has not completed within 30 seconds, it will be terminated. -Only supported on windows; On other operating systems, this will never be called. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L139) -```csharp title="Declaration" -public VelopackApp WithBeforeUninstallFastCallback(VelopackHook hook) -``` - -##### Returns - -[Velopack.VelopackApp](../Velopack/VelopackApp) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.VelopackHook](../Velopack/VelopackHook) | *hook* | - -### Run(ILogger?) -Runs the Velopack application startup code and triggers any configured hooks. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L151) -```csharp title="Declaration" -public void Run(ILogger? logger = null) -``` - -##### Parameters - -| Type | Name | Description | -|:--- |:--- |:--- | -| `Microsoft.Extensions.Logging.ILogger` | *logger* | A logging interface for diagnostic messages. This will be - cached and potentially re-used throughout the lifetime of the application. | - diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAsset.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAsset.md deleted file mode 100644 index cd7e855..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAsset.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: Class VelopackAsset -sidebar_label: VelopackAsset -description: "An individual Velopack asset, could refer to an asset on-disk or in a remote package feed." ---- -# Class VelopackAsset -An individual Velopack asset, could refer to an asset on-disk or in a remote package feed. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L43) -```csharp title="Declaration" -public record VelopackAsset : IEquatable -``` -**Derived:** -[Velopack.Sources.GitBase<T>.GitBaseAsset](../Velopack.Sources/GitBase`T`.GitBaseAsset) - -**Implements:** -`System.IEquatable` - -## Properties -### PackageId -The name or Id of the package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L46) -```csharp title="Declaration" -public string PackageId { get; init; } -``` -### Version -The version of this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L49) -```csharp title="Declaration" -public SemanticVersion Version { get; init; } -``` -### Type -The type of asset (eg. full or delta). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L52) -```csharp title="Declaration" -public VelopackAssetType Type { get; init; } -``` -### FileName -The filename of the update package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L55) -```csharp title="Declaration" -public string FileName { get; init; } -``` -### SHA1 -The SHA1 checksum of the update package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L58) -```csharp title="Declaration" -public string SHA1 { get; init; } -``` -### Size -The size in bytes of the update package containing this release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L61) -```csharp title="Declaration" -public long Size { get; init; } -``` -### NotesMarkdown -The release notes in markdown format, as passed to Velopack when packaging the release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L64) -```csharp title="Declaration" -public string NotesMarkdown { get; init; } -``` -### NotesHTML -The release notes in HTML format, transformed from Markdown when packaging the release. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L67) -```csharp title="Declaration" -public string NotesHTML { get; init; } -``` -## Methods -### FromZipPackage(ZipPackage) -Convert a [Velopack.NuGet.ZipPackage](../Velopack.NuGet/ZipPackage) to a [Velopack.VelopackAsset](../Velopack/VelopackAsset). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L72) -```csharp title="Declaration" -public static VelopackAsset FromZipPackage(ZipPackage zip) -``` - -##### Returns - -[Velopack.VelopackAsset](../Velopack/VelopackAsset) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.NuGet.ZipPackage](../Velopack.NuGet/ZipPackage) | *zip* | - -### FromNupkg(string) -Load a [Velopack.VelopackAsset](../Velopack/VelopackAsset) from a .nupkg file on disk. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L90) -```csharp title="Declaration" -public static VelopackAsset FromNupkg(string filePath) -``` - -##### Returns - -[Velopack.VelopackAsset](../Velopack/VelopackAsset) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *filePath* | - - -## Implements - -* `System.IEquatable` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetFeed.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetFeed.md deleted file mode 100644 index 50df326..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetFeed.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: Class VelopackAssetFeed -sidebar_label: VelopackAssetFeed -description: "A feed of Velopack assets, usually returned from an [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource)." ---- -# Class VelopackAssetFeed -A feed of Velopack assets, usually returned from an [Velopack.Sources.IUpdateSource](../Velopack.Sources/IUpdateSource). - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L24) -```csharp title="Declaration" -public record VelopackAssetFeed : IEquatable -``` -**Implements:** -`System.IEquatable` - -## Properties -### Assets -A list of assets available in this feed. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L29) -```csharp title="Declaration" -public VelopackAsset[] Assets { get; init; } -``` -## Methods -### FromJson(string) -Parse a json string into a [Velopack.VelopackAssetFeed](../Velopack/VelopackAssetFeed). -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L34) -```csharp title="Declaration" -public static VelopackAssetFeed FromJson(string json) -``` - -##### Returns - -[Velopack.VelopackAssetFeed](../Velopack/VelopackAssetFeed) - -##### Parameters - -| Type | Name | -|:--- |:--- | -| `System.String` | *json* | - - -## Implements - -* `System.IEquatable` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetType.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetType.md deleted file mode 100644 index 95b81ac..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackAssetType.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Enum VelopackAssetType -sidebar_label: VelopackAssetType -description: "Represents a Velopack Asset Type." ---- -# Enum VelopackAssetType -Represents a Velopack Asset Type. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L13) -```csharp title="Declaration" -public enum VelopackAssetType -``` -## Fields -### Full -A full update package. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L16) -```csharp title="Declaration" -Full = 1 -``` -### Delta -A delta update package. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackAsset.cs#L18) -```csharp title="Declaration" -Delta = 2 -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackHook.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackHook.md deleted file mode 100644 index 35668b9..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackHook.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Delegate VelopackHook -sidebar_label: VelopackHook -description: "A delegate type for handling Velopack startup events" ---- -# Delegate VelopackHook -A delegate type for handling Velopack startup events - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackApp.cs#L16) -```csharp title="Declaration" -public delegate void VelopackHook(SemanticVersion version) -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackRuntimeInfo.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackRuntimeInfo.md deleted file mode 100644 index 6378364..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/cs/Velopack/VelopackRuntimeInfo.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: Class VelopackRuntimeInfo -sidebar_label: VelopackRuntimeInfo -description: "Convenience class which provides runtime information about the current executing process, -in a way that is safe in older and newer versions of the framework." ---- -# Class VelopackRuntimeInfo -Convenience class which provides runtime information about the current executing process, -in a way that is safe in older and newer versions of the framework. - -###### **Assembly**: Velopack.dll -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L79) -```csharp title="Declaration" -public static class VelopackRuntimeInfo -``` -## Properties -### VelopackDisplayVersion -The current compiled Velopack display version. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L82) -```csharp title="Declaration" -public static string VelopackDisplayVersion { get; } -``` -### VelopackNugetVersion -The current compiled Velopack NuGetVersion. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L85) -```csharp title="Declaration" -public static NuGetVersion VelopackNugetVersion { get; } -``` -### VelopackProductVersion -The current compiled Velopack ProductVersion. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L88) -```csharp title="Declaration" -public static NuGetVersion VelopackProductVersion { get; } -``` -### EntryExePath -The path on disk of the entry assembly. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L91) -```csharp title="Declaration" -public static string EntryExePath { get; } -``` -### SystemArch -The current machine architecture, ignoring the current process / pe architecture. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L94) -```csharp title="Declaration" -public static RuntimeCpu SystemArch { get; } -``` -### SystemOs -The name of the current OS - eg. 'windows', 'linux', or 'osx'. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L97) -```csharp title="Declaration" -public static RuntimeOs SystemOs { get; } -``` -### SystemRid -The current system RID. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L100) -```csharp title="Declaration" -public static string SystemRid { get; } -``` -### IsWindows -True if executing on a Windows platform. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L103) -```csharp title="Declaration" -public static bool IsWindows { get; } -``` -### IsLinux -True if executing on a Linux platform. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L107) -```csharp title="Declaration" -public static bool IsLinux { get; } -``` -### IsOSX -True if executing on a MacOS / OSX platform. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L111) -```csharp title="Declaration" -public static bool IsOSX { get; } -``` -## Methods -### GetOsShortName(RuntimeOs) -Returns the shortened OS name as a string, suitable for creating an RID. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L185) -```csharp title="Declaration" -public static string GetOsShortName(this RuntimeOs os) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.RuntimeOs](../Velopack/RuntimeOs) | *os* | - -### GetOsLongName(RuntimeOs) -Returns the long OS name, suitable for showing to a human. -###### [View Source](https://github.com/velopack/velopack.git/blob/master/src/Velopack/VelopackRuntimeInfo.cs#L198) -```csharp title="Declaration" -public static string GetOsLongName(this RuntimeOs os) -``` - -##### Returns - -`System.String` - -##### Parameters - -| Type | Name | -|:--- |:--- | -| [Velopack.RuntimeOs](../Velopack/RuntimeOs) | *os* | - diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/index.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/index.mdx deleted file mode 100644 index 0f574b7..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ -import DocCardList from '@theme/DocCardList'; - -# Library Reference -The documentation in this library reference is auto-generated from inline comments in the library code. - -If there are inaccuracies here, please submit a PR to the code comments on the library repository itself -rather than to the docs repository. - - \ No newline at end of file diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/JsonNode.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/JsonNode.md deleted file mode 100644 index 821fbd4..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/JsonNode.md +++ /dev/null @@ -1,301 +0,0 @@ -# Class: JsonNode - -## Constructors - -### constructor - -• **new JsonNode**(): [`JsonNode`](JsonNode.md) - -#### Returns - -[`JsonNode`](JsonNode.md) - -## Properties - -### #private - -• `Private` **#private**: `any` - -#### Defined in - -[Velopack.d.ts:10](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L10) - -## Methods - -### addArrayChild - -▸ **addArrayChild**(`child`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `child` | [`JsonNode`](JsonNode.md) | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:49](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L49) - -___ - -### addObjectChild - -▸ **addObjectChild**(`key`, `child`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `child` | [`JsonNode`](JsonNode.md) | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:51](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L51) - -___ - -### asArray - -▸ **asArray**(): readonly [`JsonNode`](JsonNode.md)[] - -Reinterpret a JSON value as an array. Throws exception if the value type was not an array. - -#### Returns - -readonly [`JsonNode`](JsonNode.md)[] - -#### Defined in - -[Velopack.d.ts:33](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L33) - -___ - -### asBool - -▸ **asBool**(): `boolean` - -Reinterpret a JSON value as a boolean. Throws exception if the value type was not a boolean. - -#### Returns - -`boolean` - -#### Defined in - -[Velopack.d.ts:41](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L41) - -___ - -### asNumber - -▸ **asNumber**(): `number` - -Reinterpret a JSON value as a number. Throws exception if the value type was not a double. - -#### Returns - -`number` - -#### Defined in - -[Velopack.d.ts:37](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L37) - -___ - -### asObject - -▸ **asObject**(): `Readonly`\<`Record`\<`string`, [`JsonNode`](JsonNode.md)\>\> - -Reinterpret a JSON value as an object. Throws exception if the value type was not an object. - -#### Returns - -`Readonly`\<`Record`\<`string`, [`JsonNode`](JsonNode.md)\>\> - -#### Defined in - -[Velopack.d.ts:29](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L29) - -___ - -### asString - -▸ **asString**(): `string` - -Reinterpret a JSON value as a string. Throws exception if the value type was not a string. - -#### Returns - -`string` - -#### Defined in - -[Velopack.d.ts:45](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L45) - -___ - -### getKind - -▸ **getKind**(): [`JsonNodeType`](../enums/JsonNodeType.md) - -Get the type of this node, such as string, object, array, etc. -You should use this function and then call the corresponding -AsObject, AsArray, AsString, etc. functions to get the actual -parsed json information. - -#### Returns - -[`JsonNodeType`](../enums/JsonNodeType.md) - -#### Defined in - -[Velopack.d.ts:17](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L17) - -___ - -### initArray - -▸ **initArray**(): `void` - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:48](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L48) - -___ - -### initBool - -▸ **initBool**(`value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:47](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L47) - -___ - -### initNumber - -▸ **initNumber**(`value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `number` | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:52](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L52) - -___ - -### initObject - -▸ **initObject**(): `void` - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:50](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L50) - -___ - -### initString - -▸ **initString**(`value`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `string` | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:53](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L53) - -___ - -### isEmpty - -▸ **isEmpty**(): `boolean` - -Check if the JSON value is empty - eg. an empty string, array, or object. - -#### Returns - -`boolean` - -#### Defined in - -[Velopack.d.ts:25](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L25) - -___ - -### isNull - -▸ **isNull**(): `boolean` - -Check if the JSON value is null. - -#### Returns - -`boolean` - -#### Defined in - -[Velopack.d.ts:21](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L21) - -___ - -### parse - -▸ **parse**(`text`): [`JsonNode`](JsonNode.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `text` | `string` | - -#### Returns - -[`JsonNode`](JsonNode.md) - -#### Defined in - -[Velopack.d.ts:46](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L46) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateInfo.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateInfo.md deleted file mode 100644 index b0c5cab..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateInfo.md +++ /dev/null @@ -1,61 +0,0 @@ -# Class: UpdateInfo - -Holds information about the current version and pending updates, such as how many there are, and access to release notes. - -## Constructors - -### constructor - -• **new UpdateInfo**(): [`UpdateInfo`](UpdateInfo.md) - -#### Returns - -[`UpdateInfo`](UpdateInfo.md) - -## Properties - -### isDowngrade - -• **isDowngrade**: `boolean` - -True if the update is a version downgrade or lateral move (such as when switching channels to the same version number). -In this case, only full updates are allowed, and any local packages on disk newer than the downloaded version will be -deleted. - -#### Defined in - -[Velopack.d.ts:118](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L118) - -___ - -### targetFullRelease - -• **targetFullRelease**: [`VelopackAsset`](VelopackAsset.md) - -The available version that we are updating to. - -#### Defined in - -[Velopack.d.ts:112](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L112) - -## Methods - -### fromJson - -▸ **fromJson**(`json`): [`UpdateInfo`](UpdateInfo.md) - -Parses a JSON string into an UpdateInfo object. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `json` | `string` | - -#### Returns - -[`UpdateInfo`](UpdateInfo.md) - -#### Defined in - -[Velopack.d.ts:122](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L122) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManager.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManager.md deleted file mode 100644 index 4b131d3..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManager.md +++ /dev/null @@ -1,482 +0,0 @@ -# Class: UpdateManager - -This class is used to check for updates, download updates, and apply updates. -It provides the asynchronous functions of the UpdateManager class. - -## Hierarchy - -- [`UpdateManagerSync`](UpdateManagerSync.md) - - ↳ **`UpdateManager`** - -## Constructors - -### constructor - -• **new UpdateManager**(): [`UpdateManager`](UpdateManager.md) - -#### Returns - -[`UpdateManager`](UpdateManager.md) - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[constructor](UpdateManagerSync.md#constructor) - -## Properties - -### #private - -• `Private` **#private**: `any` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[#private](UpdateManagerSync.md##private) - -#### Defined in - -[Velopack.d.ts:130](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L130) - -## Methods - -### applyUpdatesAndExit - -▸ **applyUpdatesAndExit**(`toApply`): `void` - -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified -restart arguments. If you need to save state or clean up, you should do that before calling this method. -The user may be prompted during the update, if the update requires additional frameworks to be installed etc. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[applyUpdatesAndExit](UpdateManagerSync.md#applyupdatesandexit) - -#### Defined in - -[Velopack.d.ts:199](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L199) - -___ - -### applyUpdatesAndRestart - -▸ **applyUpdatesAndRestart**(`toApply`, `restartArgs?`): `void` - -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified -restart arguments. If you need to save state or clean up, you should do that before calling this method. -The user may be prompted during the update, if the update requires additional frameworks to be installed etc. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | -| `restartArgs?` | readonly `string`[] | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[applyUpdatesAndRestart](UpdateManagerSync.md#applyupdatesandrestart) - -#### Defined in - -[Velopack.d.ts:205](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L205) - -___ - -### checkForUpdates - -▸ **checkForUpdates**(): [`UpdateInfo`](UpdateInfo.md) - -This function will check for updates, and return information about the latest -available release. This function runs synchronously and may take some time to -complete, depending on the network speed and the number of updates available. - -#### Returns - -[`UpdateInfo`](UpdateInfo.md) - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[checkForUpdates](UpdateManagerSync.md#checkforupdates) - -#### Defined in - -[Velopack.d.ts:186](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L186) - -___ - -### checkForUpdatesAsync - -▸ **checkForUpdatesAsync**(): `Promise`\<[`UpdateInfo`](UpdateInfo.md)\> - -This function will check for updates, and return information about the latest -available release. This function runs synchronously and may take some time to -complete, depending on the network speed and the number of updates available. - -#### Returns - -`Promise`\<[`UpdateInfo`](UpdateInfo.md)\> - -#### Defined in - -[Velopack.d.ts:243](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L243) - -___ - -### downloadUpdates - -▸ **downloadUpdates**(`toDownload`): `void` - -Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, -this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta -packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock -so may fail if there is already another update operation in progress. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toDownload` | [`VelopackAsset`](VelopackAsset.md) | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[downloadUpdates](UpdateManagerSync.md#downloadupdates) - -#### Defined in - -[Velopack.d.ts:193](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L193) - -___ - -### downloadUpdatesAsync - -▸ **downloadUpdatesAsync**(`toDownload`, `progress`): `Promise`\<`void`\> - -Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, -this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta -packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock -so may fail if there is already another update operation in progress. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toDownload` | [`VelopackAsset`](VelopackAsset.md) | -| `progress` | (`arg`: `number`) => `void` | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[Velopack.d.ts:250](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L250) - -___ - -### getCheckForUpdatesCommand - -▸ **getCheckForUpdatesCommand**(): `string`[] - -Returns the command line arguments to check for updates. - -#### Returns - -`string`[] - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[getCheckForUpdatesCommand](UpdateManagerSync.md#getcheckforupdatescommand) - -#### Defined in - -[Velopack.d.ts:158](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L158) - -___ - -### getCurrentVersion - -▸ **getCurrentVersion**(): `string` - -Get the currently installed version of the application. -If the application is not installed, this function will throw an exception. - -#### Returns - -`string` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[getCurrentVersion](UpdateManagerSync.md#getcurrentversion) - -#### Defined in - -[Velopack.d.ts:180](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L180) - -___ - -### getCurrentVersionAsync - -▸ **getCurrentVersionAsync**(): `Promise`\<`string`\> - -Checks for updates, returning null if there are none available. If there are updates available, this method will return an -UpdateInfo object containing the latest available release, and any delta updates that can be applied if they are available. - -#### Returns - -`Promise`\<`string`\> - -#### Defined in - -[Velopack.d.ts:237](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L237) - -___ - -### getCurrentVersionCommand - -▸ **getCurrentVersionCommand**(): `string`[] - -Returns the command line arguments to get the current version of the application. - -#### Returns - -`string`[] - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[getCurrentVersionCommand](UpdateManagerSync.md#getcurrentversioncommand) - -#### Defined in - -[Velopack.d.ts:154](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L154) - -___ - -### getDownloadUpdatesCommand - -▸ **getDownloadUpdatesCommand**(`toDownload`): `string`[] - -Returns the command line arguments to download the specified update. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toDownload` | [`VelopackAsset`](VelopackAsset.md) | - -#### Returns - -`string`[] - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[getDownloadUpdatesCommand](UpdateManagerSync.md#getdownloadupdatescommand) - -#### Defined in - -[Velopack.d.ts:162](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L162) - -___ - -### getPackagesDir - -▸ **getPackagesDir**(): `string` - -Returns the path to the app's packages directory. This is where updates are downloaded to. - -#### Returns - -`string` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[getPackagesDir](UpdateManagerSync.md#getpackagesdir) - -#### Defined in - -[Velopack.d.ts:170](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L170) - -___ - -### getUpdateApplyCommand - -▸ **getUpdateApplyCommand**(`toApply`, `silent`, `restart`, `wait`, `restartArgs?`): `string`[] - -Returns the command line arguments to apply the specified update. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | -| `silent` | `boolean` | -| `restart` | `boolean` | -| `wait` | `boolean` | -| `restartArgs?` | readonly `string`[] | - -#### Returns - -`string`[] - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[getUpdateApplyCommand](UpdateManagerSync.md#getupdateapplycommand) - -#### Defined in - -[Velopack.d.ts:166](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L166) - -___ - -### isInstalled - -▸ **isInstalled**(): `boolean` - -Returns true if the current app is installed, false otherwise. If the app is not installed, other functions in -UpdateManager may throw exceptions, so you may want to check this before calling other functions. - -#### Returns - -`boolean` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[isInstalled](UpdateManagerSync.md#isinstalled) - -#### Defined in - -[Velopack.d.ts:175](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L175) - -___ - -### setAllowDowngrade - -▸ **setAllowDowngrade**(`allowDowngrade`): `void` - -Allows UpdateManager to update to a version that's lower than the current version (i.e. downgrading). -This could happen if a release has bugs and was retracted from the release feed, or if you're using -ExplicitChannel to switch channels to another channel where the latest version on that -channel is lower than the current version. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `allowDowngrade` | `boolean` | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[setAllowDowngrade](UpdateManagerSync.md#setallowdowngrade) - -#### Defined in - -[Velopack.d.ts:141](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L141) - -___ - -### setExplicitChannel - -▸ **setExplicitChannel**(`explicitChannel`): `void` - -This option should usually be left null. Overrides the default channel used to fetch updates. -The default channel will be whatever channel was specified on the command line when building this release. -For example, if the current release was packaged with '--channel beta', then the default channel will be 'beta'. -This allows users to automatically receive updates from the same channel they installed from. This options -allows you to explicitly switch channels, for example if the user wished to switch back to the 'stable' channel -without having to reinstall the application. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `explicitChannel` | `string` | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[setExplicitChannel](UpdateManagerSync.md#setexplicitchannel) - -#### Defined in - -[Velopack.d.ts:150](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L150) - -___ - -### setUrlOrPath - -▸ **setUrlOrPath**(`urlOrPath`): `void` - -Set the URL or local file path to the update server. This is required before calling CheckForUpdates or DownloadUpdates. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `urlOrPath` | `string` | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[setUrlOrPath](UpdateManagerSync.md#seturlorpath) - -#### Defined in - -[Velopack.d.ts:134](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L134) - -___ - -### waitExitThenApplyUpdates - -▸ **waitExitThenApplyUpdates**(`toApply`, `silent`, `restart`, `restartArgs?`): `void` - -This will launch the Velopack updater and tell it to wait for this program to exit gracefully. -You should then clean up any state and exit your app. The updater will apply updates and then -optionally restart your app. The updater will only wait for 60 seconds before giving up. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | -| `silent` | `boolean` | -| `restart` | `boolean` | -| `restartArgs?` | readonly `string`[] | - -#### Returns - -`void` - -#### Inherited from - -[UpdateManagerSync](UpdateManagerSync.md).[waitExitThenApplyUpdates](UpdateManagerSync.md#waitexitthenapplyupdates) - -#### Defined in - -[Velopack.d.ts:211](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L211) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManagerSync.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManagerSync.md deleted file mode 100644 index 7ceadd5..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/UpdateManagerSync.md +++ /dev/null @@ -1,354 +0,0 @@ -# Class: UpdateManagerSync - -This class is used to check for updates, download updates, and apply updates. It is a synchronous version of the UpdateManager class. -This class is not recommended for use in GUI applications, as it will block the main thread, so you may want to use the async -UpdateManager class instead, if it is supported for your programming language. - -## Hierarchy - -- **`UpdateManagerSync`** - - ↳ [`UpdateManager`](UpdateManager.md) - -## Constructors - -### constructor - -• **new UpdateManagerSync**(): [`UpdateManagerSync`](UpdateManagerSync.md) - -#### Returns - -[`UpdateManagerSync`](UpdateManagerSync.md) - -## Properties - -### #private - -• `Private` **#private**: `any` - -#### Defined in - -[Velopack.d.ts:130](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L130) - -## Methods - -### applyUpdatesAndExit - -▸ **applyUpdatesAndExit**(`toApply`): `void` - -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified -restart arguments. If you need to save state or clean up, you should do that before calling this method. -The user may be prompted during the update, if the update requires additional frameworks to be installed etc. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:199](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L199) - -___ - -### applyUpdatesAndRestart - -▸ **applyUpdatesAndRestart**(`toApply`, `restartArgs?`): `void` - -This will exit your app immediately, apply updates, and then optionally relaunch the app using the specified -restart arguments. If you need to save state or clean up, you should do that before calling this method. -The user may be prompted during the update, if the update requires additional frameworks to be installed etc. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | -| `restartArgs?` | readonly `string`[] | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:205](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L205) - -___ - -### checkForUpdates - -▸ **checkForUpdates**(): [`UpdateInfo`](UpdateInfo.md) - -This function will check for updates, and return information about the latest -available release. This function runs synchronously and may take some time to -complete, depending on the network speed and the number of updates available. - -#### Returns - -[`UpdateInfo`](UpdateInfo.md) - -#### Defined in - -[Velopack.d.ts:186](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L186) - -___ - -### downloadUpdates - -▸ **downloadUpdates**(`toDownload`): `void` - -Downloads the specified updates to the local app packages directory. If the update contains delta packages and ignoreDeltas=false, -this method will attempt to unpack and prepare them. If there is no delta update available, or there is an error preparing delta -packages, this method will fall back to downloading the full version of the update. This function will acquire a global update lock -so may fail if there is already another update operation in progress. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toDownload` | [`VelopackAsset`](VelopackAsset.md) | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:193](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L193) - -___ - -### getCheckForUpdatesCommand - -▸ **getCheckForUpdatesCommand**(): `string`[] - -Returns the command line arguments to check for updates. - -#### Returns - -`string`[] - -#### Defined in - -[Velopack.d.ts:158](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L158) - -___ - -### getCurrentVersion - -▸ **getCurrentVersion**(): `string` - -Get the currently installed version of the application. -If the application is not installed, this function will throw an exception. - -#### Returns - -`string` - -#### Defined in - -[Velopack.d.ts:180](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L180) - -___ - -### getCurrentVersionCommand - -▸ **getCurrentVersionCommand**(): `string`[] - -Returns the command line arguments to get the current version of the application. - -#### Returns - -`string`[] - -#### Defined in - -[Velopack.d.ts:154](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L154) - -___ - -### getDownloadUpdatesCommand - -▸ **getDownloadUpdatesCommand**(`toDownload`): `string`[] - -Returns the command line arguments to download the specified update. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toDownload` | [`VelopackAsset`](VelopackAsset.md) | - -#### Returns - -`string`[] - -#### Defined in - -[Velopack.d.ts:162](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L162) - -___ - -### getPackagesDir - -▸ **getPackagesDir**(): `string` - -Returns the path to the app's packages directory. This is where updates are downloaded to. - -#### Returns - -`string` - -#### Defined in - -[Velopack.d.ts:170](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L170) - -___ - -### getUpdateApplyCommand - -▸ **getUpdateApplyCommand**(`toApply`, `silent`, `restart`, `wait`, `restartArgs?`): `string`[] - -Returns the command line arguments to apply the specified update. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | -| `silent` | `boolean` | -| `restart` | `boolean` | -| `wait` | `boolean` | -| `restartArgs?` | readonly `string`[] | - -#### Returns - -`string`[] - -#### Defined in - -[Velopack.d.ts:166](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L166) - -___ - -### isInstalled - -▸ **isInstalled**(): `boolean` - -Returns true if the current app is installed, false otherwise. If the app is not installed, other functions in -UpdateManager may throw exceptions, so you may want to check this before calling other functions. - -#### Returns - -`boolean` - -#### Defined in - -[Velopack.d.ts:175](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L175) - -___ - -### setAllowDowngrade - -▸ **setAllowDowngrade**(`allowDowngrade`): `void` - -Allows UpdateManager to update to a version that's lower than the current version (i.e. downgrading). -This could happen if a release has bugs and was retracted from the release feed, or if you're using -ExplicitChannel to switch channels to another channel where the latest version on that -channel is lower than the current version. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `allowDowngrade` | `boolean` | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:141](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L141) - -___ - -### setExplicitChannel - -▸ **setExplicitChannel**(`explicitChannel`): `void` - -This option should usually be left null. Overrides the default channel used to fetch updates. -The default channel will be whatever channel was specified on the command line when building this release. -For example, if the current release was packaged with '--channel beta', then the default channel will be 'beta'. -This allows users to automatically receive updates from the same channel they installed from. This options -allows you to explicitly switch channels, for example if the user wished to switch back to the 'stable' channel -without having to reinstall the application. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `explicitChannel` | `string` | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:150](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L150) - -___ - -### setUrlOrPath - -▸ **setUrlOrPath**(`urlOrPath`): `void` - -Set the URL or local file path to the update server. This is required before calling CheckForUpdates or DownloadUpdates. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `urlOrPath` | `string` | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:134](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L134) - -___ - -### waitExitThenApplyUpdates - -▸ **waitExitThenApplyUpdates**(`toApply`, `silent`, `restart`, `restartArgs?`): `void` - -This will launch the Velopack updater and tell it to wait for this program to exit gracefully. -You should then clean up any state and exit your app. The updater will apply updates and then -optionally restart your app. The updater will only wait for 60 seconds before giving up. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `toApply` | [`VelopackAsset`](VelopackAsset.md) | -| `silent` | `boolean` | -| `restart` | `boolean` | -| `restartArgs?` | readonly `string`[] | - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:211](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L211) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackApp.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackApp.md deleted file mode 100644 index 8543d24..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackApp.md +++ /dev/null @@ -1,46 +0,0 @@ -# Class: VelopackApp - -The main VelopackApp struct. This is the main entry point for your app. - -## Constructors - -### constructor - -• **new VelopackApp**(): [`VelopackApp`](VelopackApp.md) - -#### Returns - -[`VelopackApp`](VelopackApp.md) - -## Methods - -### run - -▸ **run**(): `void` - -Runs the Velopack startup logic. This should be the first thing to run in your app. -In some circumstances it may terminate/restart the process to perform tasks. - -#### Returns - -`void` - -#### Defined in - -[Velopack.d.ts:225](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L225) - -___ - -### build - -▸ **build**(): [`VelopackApp`](VelopackApp.md) - -Create a new VelopackApp instance. - -#### Returns - -[`VelopackApp`](VelopackApp.md) - -#### Defined in - -[Velopack.d.ts:220](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L220) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackAsset.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackAsset.md deleted file mode 100644 index 5a46db5..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/classes/VelopackAsset.md +++ /dev/null @@ -1,153 +0,0 @@ -# Class: VelopackAsset - -An individual Velopack asset, could refer to an asset on-disk or in a remote package feed. - -## Constructors - -### constructor - -• **new VelopackAsset**(): [`VelopackAsset`](VelopackAsset.md) - -#### Returns - -[`VelopackAsset`](VelopackAsset.md) - -## Properties - -### fileName - -• **fileName**: `string` - -The filename of the update package containing this release. - -#### Defined in - -[Velopack.d.ts:79](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L79) - -___ - -### notesHTML - -• **notesHTML**: `string` - -The release notes in HTML format, transformed from Markdown when packaging the release. - -#### Defined in - -[Velopack.d.ts:95](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L95) - -___ - -### notesMarkdown - -• **notesMarkdown**: `string` - -The release notes in markdown format, as passed to Velopack when packaging the release. - -#### Defined in - -[Velopack.d.ts:91](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L91) - -___ - -### packageId - -• **packageId**: `string` - -The name or Id of the package containing this release. - -#### Defined in - -[Velopack.d.ts:67](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L67) - -___ - -### sha1 - -• **sha1**: `string` - -The SHA1 checksum of the update package containing this release. - -#### Defined in - -[Velopack.d.ts:83](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L83) - -___ - -### size - -• **size**: `bigint` - -The size in bytes of the update package containing this release. - -#### Defined in - -[Velopack.d.ts:87](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L87) - -___ - -### type - -• **type**: [`VelopackAssetType`](../enums/VelopackAssetType.md) - -The type of asset (eg. full or delta). - -#### Defined in - -[Velopack.d.ts:75](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L75) - -___ - -### version - -• **version**: `string` - -The version of this release. - -#### Defined in - -[Velopack.d.ts:71](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L71) - -## Methods - -### fromJson - -▸ **fromJson**(`json`): [`VelopackAsset`](VelopackAsset.md) - -Parses a JSON string into a VelopackAsset object. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `json` | `string` | - -#### Returns - -[`VelopackAsset`](VelopackAsset.md) - -#### Defined in - -[Velopack.d.ts:99](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L99) - -___ - -### fromNode - -▸ **fromNode**(`node`): [`VelopackAsset`](VelopackAsset.md) - -Parses a JSON node into a VelopackAsset object. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `node` | [`JsonNode`](JsonNode.md) | - -#### Returns - -[`VelopackAsset`](VelopackAsset.md) - -#### Defined in - -[Velopack.d.ts:103](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L103) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/enums/JsonNodeType.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/enums/JsonNodeType.md deleted file mode 100644 index 470409c..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/enums/JsonNodeType.md +++ /dev/null @@ -1,61 +0,0 @@ -# Enumeration: JsonNodeType - -## Enumeration Members - -### ARRAY - -• **ARRAY** = ``2`` - -#### Defined in - -[Velopack.d.ts:4](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L4) - -___ - -### BOOL - -• **BOOL** = ``1`` - -#### Defined in - -[Velopack.d.ts:3](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L3) - -___ - -### NULL - -• **NULL** = ``0`` - -#### Defined in - -[Velopack.d.ts:2](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L2) - -___ - -### NUMBER - -• **NUMBER** = ``4`` - -#### Defined in - -[Velopack.d.ts:6](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L6) - -___ - -### OBJECT - -• **OBJECT** = ``3`` - -#### Defined in - -[Velopack.d.ts:5](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L5) - -___ - -### STRING - -• **STRING** = ``5`` - -#### Defined in - -[Velopack.d.ts:7](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L7) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/enums/VelopackAssetType.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/enums/VelopackAssetType.md deleted file mode 100644 index 73a29ca..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/js/enums/VelopackAssetType.md +++ /dev/null @@ -1,31 +0,0 @@ -# Enumeration: VelopackAssetType - -## Enumeration Members - -### DELTA - -• **DELTA** = ``2`` - -#### Defined in - -[Velopack.d.ts:58](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L58) - -___ - -### FULL - -• **FULL** = ``1`` - -#### Defined in - -[Velopack.d.ts:57](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L57) - -___ - -### UNKNOWN - -• **UNKNOWN** = ``0`` - -#### Defined in - -[Velopack.d.ts:56](https://github.com/velopack/velopack.fusion/blob/4afc04c/for-js/Velopack.d.ts#L56) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/troubleshooting/cli.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/troubleshooting/cli.mdx deleted file mode 100644 index 80c5d05..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/troubleshooting/cli.mdx +++ /dev/null @@ -1,89 +0,0 @@ -# CLI Reference - - -Overview of Velopack binary command line options. - -## vpk - -```txt -Description: - Velopack CLI 0.0.61-g2e7ffeb (prerelease) for creating and distributing releases. - -Usage: - vpk [command] [options] - -Options: - -?, -h, --help Show help and usage information - --version Show version information - --verbose Print diagnostic messages. - -Commands: - pack Creates a release from a folder containing application files. - download Download's the latest release from a remote update source. - upload Upload local package(s) to a remote update source. - delta Utilities for creating or applying delta packages. -``` - -## Update.exe & UpdateMac - -```txt -Velopack Updater (0.0.66) manages packages and installs updates. -https://github.com/velopack/velopack - -Usage: update [OPTIONS] - update apply [OPTIONS] [-- [EXE_ARGS]...] - update patch [OPTIONS] --old --patch --output - update start [OPTIONS] [EXE_NAME] [-- [EXE_ARGS]...] - update uninstall [OPTIONS] - -Options: - --verbose Print debug messages to console / log - -s, --silent Don't show any prompts / dialogs - -l, --log Override the default log file location - -h, --help Print help - -V, --version Print version - -update apply: -Applies a staged / prepared update, installing prerequisite runtimes if necessary - -r, --restart Restart the application after the update - -w, --wait Wait for the parent process to terminate before applying the update - -p, --package Update package to apply - --noelevate If the application does not have sufficient privileges, do not elevate to admin - -h, --help Print help - [EXE_ARGS]... Arguments to pass to the started executable. Must be preceeded by '--'. - -update patch: -Applies a Zstd patch file - --old Base / old file to apply the patch to - --patch The Zstd patch to apply to the old file - --output The file to create with the patch applied - -h, --help Print help - -update start: -Starts the currently installed version of the application - -w, --wait Wait for the parent process to terminate before starting the application - -h, --help Print help - [EXE_ARGS]... Arguments to pass to the started executable. Must be preceeded by '--'. - [EXE_NAME] The optional name of the binary to execute - -update uninstall: -Remove all app shortcuts, files, and registry entries. - -h, --help Print help -``` - -## Setup.exe - -```txt -Velopack Setup (0.0.66) installs applications. -https://github.com/velopack/velopack - -Usage: setup [OPTIONS] - -Options: - -s, --silent Hides all dialogs and answers 'yes' to all prompts - -v, --verbose Print debug messages to console - -l, --log Enable file logging and set location - -t, --installto Installation directory to install the application - -d, --debug Debug mode, install from a nupkg file - -h, --help Print help -``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/troubleshooting/debugging.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/troubleshooting/debugging.mdx deleted file mode 100644 index a690be8..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/troubleshooting/debugging.mdx +++ /dev/null @@ -1,48 +0,0 @@ -# Debugging & Logging - - -Find or configure application logs to find runtime issues. - -## Logging - -All parts of Velopack have logging built in to help troubleshoot issues, and you should provide these logs when opening a GitHub issue about a potential bug. - -### UpdateManager / In your application - -You should provide an instance of `Microsoft.Extensions.Logging.ILogger` to `VelopackApp.Run(ILogger)` and to `UpdateManager` to record potential issues. If you are not using Microsoft Hosting or Logging already, it is very simple to implement this interface yourself and log to a file, or integrate with another logging framework. - -For example: - -```cs -using Microsoft.Extensions.Logging; - -// ... - -class ConsoleLogger : ILogger -{ - public IDisposable BeginScope(TState state) where TState : notnull => null; - public bool IsEnabled(LogLevel logLevel) => true; - public void Log(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func formatter) - => Console.WriteLine(formatter(state, exception)); -} - -// ... - -new UpdateManager("https://path.to/your-updates", logger: new ConsoleLogger()); -``` - -### Windows - -Running Update.exe will log most output to it's base directory as `Velopack.log`. Setup.exe will not log to file by default. However, you can override the log location for both binaries with the `--log {path}` parameter. You can also use the `--verbose` flag to capture debug/trace output to log. Unfortunately, on Windows, to avoid showing up as a console window, these binaries are compiled as a WinExe and there will be no console output by default. Please see the [command line reference](cli.mdx) for a comprehensive list of arguments supported. - -### MacOS / Linux - -All logs will be sent to `/tmp/velopack.log`. - -## Advanced Debugging - -The debug builds of Velopack binaries have additional logging/debugging capabilities, and will produce console output. In some instances, it may be useful to [compile Velopack](../contributing/compiling.mdx) for your platform, and replace the release binaries of Setup.exe and Update.exe with debug versions. - -If your issue is with package building, after building the rust binaries in Debug mode, it can also be useful to run the Velopack.Vpk project from Visual Studio with your intended command line arguments rather than running the `vpk` tool directly. - -If doing this has not helped, you may need to debug and step through the rust binaries - for which I recommend the CodeLLDB VSCode extension. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/troubleshooting/faq.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/troubleshooting/faq.mdx deleted file mode 100644 index 76537a6..0000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/troubleshooting/faq.mdx +++ /dev/null @@ -1,16 +0,0 @@ -# FAQ - - -Commonly asked questions about Velopack. - -- **My application was detected as a virus?**
- Velopack can't help with this, but you can [code-sign](packaging/signing.mdx) your app and check [other suggestions here](https://github.com/clowd/Clowd.Squirrel/issues/28#issuecomment-1016241760). -- **What happened to SquirrelAwareApp? / Shortcuts**
- This concept no longer exists in Velopack. You can create hooks on install/update in a similar way using the `VelopackApp` builder. Although note that reating shortcuts or registry entries yourself during hooks is no longer required. -- **Can Velopack bootstrap new runtimes during updates?**
- Yes, this is fully supported. Before installing updates, Velopack will prompt the user to install any missing updates. -- **How do I install the `vpk` tool? / I've installed the tool but it doesn't work** - For now, you need to install `dotnet` runtime 6.0 or 8.0 for your platform, and then run `dotnet tool update -g vpk`. - If you get a message that it was installed successfully, but running it in your terminal results in a "binary/command not found" message, it's probably because your PATH is not set-up properly. For windows, `%USERPROFILE%\.dotnet\tools` should be on the PATH. For macos, [see this issue](https://github.com/dotnet/sdk/issues/9415). In general, dotnet should set these paths up for you, but that is what you should check if things are not working. -- **Can I use a 4 part version (1.0.0.0) instead of SemVer2?** - Velopack only supports a 3 part version with tags and metadata (1.0.0-build.23+metadata) following the SemVer2 standard. Some people choose to version with the date, 2024.01.12 for example. It's also possible to get automated git commit based versioning [using something like nbgv](https://github.com/dotnet/Nerdbank.GitVersioning). The reason Velopack supports SemVer2 and not traditional 4 part versions is that it's possible to provide a lot more information in SemVer2 versions, and it is not feasible for us to support both formats throughout the framework. diff --git a/i18n/zh-CN/docusaurus-theme-classic/navbar.json b/i18n/zh-CN/docusaurus-theme-classic/navbar.json deleted file mode 100644 index bedfd41..0000000 --- a/i18n/zh-CN/docusaurus-theme-classic/navbar.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "logo.alt": { - "message": "Velopack Logo", - "description": "The alt text of navbar logo" - }, - "item.label.Guides": { - "message": "Guides", - "description": "Navbar item with label Guides" - }, - "item.label.Reference": { - "message": "Reference", - "description": "Navbar item with label Reference" - }, - "item.label.Blog": { - "message": "Blog", - "description": "Navbar item with label Blog" - } -} diff --git a/package.json b/package.json index 38d2e1b..e42fce9 100644 --- a/package.json +++ b/package.json @@ -13,10 +13,7 @@ "write-translations": "docusaurus write-translations", "write-heading-ids": "docusaurus write-heading-ids", "typecheck": "tsc", - "generate": "node ./generate.mjs", - "crowdin-download": "crowdin download", - "crowdin-upload": "crowdin upload", - "daily-tasks": "node ./daily-tasks.mjs" + "generate": "node ./generate.mjs" }, "dependencies": { "@docusaurus/core": "3.1.1",