Mirrors/velopack
1
0
Fork 0
mirror of https://github.com/velopack/velopack.git synced 2025-10-25 15:19:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #806 from CDAGaming/patch-1

Browse Source 
Fixes Update-Manager.md
This commit is contained in:
Paul Betts
2016-09-06 19:58:24 -07:00
committed by GitHub
parent b85c9d9f65 1da6ecebbe
commit f46d326503
1 changed files with 56 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

112
docs/using/update-manager.md
View File

@@ -1,57 +1,57 @@
| [docs](..) / [using](.) / update-manager.md
|:---|
# Update Manager Reference
## Basic Updating
The "Easy Mode" method that does everything all in one go.
* `UpdateApp` - downloads and updates the app to the latest version.
## Advanced Updating
The following methods are provided to allow you to have more control of the update process (i.e., to interact with app updates and apply them if desired).
* `CheckForUpdate` - checks on the server if there are updates available. Returns an `UpdateInfo` object that contains information about any pending updates.
* `DownloadReleases` - downloads release files (the `nupkg` file deltas) from the server to the local machine
* `ApplyReleases` - installs the downloaded packages, and returns the new `app-[version]` directory path.
### UpdateInfo
The `UpdateInfo` class contains information about available and installed releases.
~~~cs
public class UpdateInfo
{
public ReleaseEntry CurrentlyInstalledVersion;
public ReleaseEntry FutureReleaseEntry;
public List<ReleaseEntry> ReleasesToApply;
}
~~~
### ReleaseEntry
The `ReleaseEntry` class contains the specifics of each release.
~~~cs
public interface ReleaseEntry
{
public string SHA1;
public string Filename;
public long Filesize;
public bool IsDelta;
}
~~~
| [docs](..) / [using](.) / update-manager.md
|:---|
# Update Manager Reference
## Basic Updating
The "Easy Mode" method that does everything all in one go.
* `UpdateApp` - downloads and updates the app to the latest version.
## Advanced Updating
The following methods are provided to allow you to have more control of the update process (i.e., to interact with app updates and apply them if desired).
* `CheckForUpdate` - checks on the server if there are updates available. Returns an `UpdateInfo` object that contains information about any pending updates.
* `DownloadReleases` - downloads release files (the `nupkg` file deltas) from the server to the local machine
* `ApplyReleases` - installs the downloaded packages, and returns the new `app-[version]` directory path.
### UpdateInfo
The `UpdateInfo` class contains information about available and installed releases.
~~~cs
public class UpdateInfo
{
public ReleaseEntry CurrentlyInstalledVersion;
public ReleaseEntry FutureReleaseEntry;
public List<ReleaseEntry> ReleasesToApply;
}
~~~
### ReleaseEntry
The `ReleaseEntry` class contains the specifics of each release.
~~~cs
public interface ReleaseEntry
{
public string SHA1;
public string Filename;
public long Filesize;
public bool IsDelta;
}
~~~
## See Also
* [Update Process](update-process.md) - overview of the steps in the update process.
* [GitHub Update Manager](github.md) - process of using `GitHubUpdateManager`.
---
| Return: [Table of Contents](../readme.md) |
|----|
## See Also
* [Update Process](update-process.md) - overview of the steps in the update process.
* [GitHub Update Manager](update-manager-github.md) - process of using `GitHubUpdateManager`.
---
| Return: [Table of Contents](../readme.md) |
|----|