NetSparkle is a software update framework for C# that is compatible with .NET Core 3+ and .NET Framework 4.5.2+, has pre-built UIs for .NET Framework (WinForms, WPF) and .NET Core (WinForms, WPF, Avalonia), uses Ed25519 or other signatures, and even allows for custom UIs or no UI at all! You provide, somewhere on the internet, an app cast with update and version information, along with release notes in Markdown or HTML format. This library then helps you check for an update, show the user the release notes, and offer to download/install the new version of the software.
The develop
branch has changed significantly from master
and represents a major 2.0 version update. NetSparkle 2.0, currently in beta, brings the ability to customize most of NetSparkle -- custom UIs are easy, you can have custom app cast downloaders and handlers (e.g. for FTP download or JSON appcasts), and more! No more big changes to the API are planned (but we cannot guarantee it before 2.0 RC), but smaller API changes may occur if bugs are found between now and the official 2.0 release. (Update 7 June 2020: Planning on an API change to Configuration
to more easily use that in combo with IAssemblyAccessor
. Not done yet.)
Built-in supported update download types:
- Windows -- .exe, .msi, .msp
- macOS -- .zip, .pkg, .dmg
- Linux -- .tar.gz, .deb, .rpm
README and other documentation updates for version 2.0 are in progress. If you have specific questions or need help even after looking at the samples, please file an issue or message me on Gitter. You should be able to implement your own handlers and/or UI for most operations, so things like a custom update process, downloading/parsing JSON rather than XML, downloading things from FTP, using your own file signature verification method, etc. are all now possible. Some extra features aren't built-in out of the box yet, such as JSON app cast feeds -- contributions are welcome and benefit the whole community!
Contributions are ALWAYS welcome! If you see a new feature you'd like to add, please open an issue to talk about it first, then open a PR for that implementation. If there's a bug you find, please open a PR with the fix or file an issue! Thank you!! :) You can also join us in our Gitter chat room!
NetSparkle is available via NuGet. To choose a NuGet package to use:
- Reference the core NetSparkle build if you don't care about having a built-in UI and can manage things yourself
- Choose one of the other packages if you want a built-in UI or want to create your UI based on one of the other UIs
Package | Use Case | Release | Preview | Downloads |
---|---|---|---|---|
NetSparkle | Core package; No UI or 100% custom UI | |||
WinForms UI (.NET Framework) | NetSparkle with built-in WinForms UI | |||
WinForms UI (.NET Core) | NetSparkle with built-in WinForms UI | |||
WPF UI (.NET Framework and Core) | NetSparkle with built-in WPF UI | |||
Avalonia UI | NetSparkle with built-in Avalonia UI | |||
Command Line Tools | DSA helper; AppCast generator (incl. Ed25519 helpers) |
All notable changes to this project will be documented in the changelog.
- How Updates Work
- Basic Usage
- Appcast
- Updating from 0.x or 1.x
- SparkleUpdater class
- License
- Requirements
- Other Options
A typical software update path for a stereotypical piece of software might look like this:
- Compile application so it can be run on other computers (e.g.
dotnet publish
) - Programmer puts app in some sort of installer/zip/etc. for distribution (e.g. InnoSetup for Windows)
- Programmer creates app cast file (see the appcast section of this document for more info on how to create this)
- Programmer uploads files for distribution (installer, app cast file, appcast-file.signature file) to their download site.
- Client opens app and is automatically notified of an available update (or the software otherwise detects there is an update)
- Client chooses to update (or update is downloaded if the software downloads it automatically)
- Update is downloaded and sitting on the user's disk
- User is asked to close the software so the update can run. User closes the software.
- Downloaded file/installer is run (or the update is otherwise performed)
Right now, NetSparkle does not help you with 1., 2., or 4. "Why not?", you might ask:
-
- We can't compile your application for you since we don't know (or care) how you are compiling or packaging your application! :)
-
- A cross-platform installer package/system would be difficult and may not feel normal to end users, although a system that uses Avalonia could maybe work I suppose (might take a lot of work though and make downloads large!). We do not provide support for getting your installer/distribution ready. To generate your installer/distribution, we recommend the following:
- Windows: InnoSetup or NSIS or WiX
- macOS: If you have a .app to distribute, use dotnet-bundle with create-dmg. If you want an installer, create a .pkg installer with macos-installer-builder (tutorial here), Packages, or your terminal. Otherwise, plop things in a zip file.
- Linux: Use dotnet-packaging to create an rpm, deb, or tar.gz file for your users.
-
- We don't know where your files will live on the internet, so you need to be responsible for uploading these files and putting them online somewhere.
To create your app cast file, see the appcast section of this document.
We are open to contributions that might make the overall install/update process easier for the user. Please file an issue first with your idea before starting work so we can talk about it.
Please look at the sample projects in this repository for basic, runnable usage samples!! There are samples on using each of the built-in UIs as well as a "do it yourself in your own UI" sample!
_sparkle = new SparkleUpdater(
"http://example.com/appcast.xml", // link to your app cast file
new Ed25519Checker(SecurityMode.Strict, // security mode -- use .Unsafe to ignore all signature checking (NOT recommended or secure!!)
"base_64_public_key") // your base 64 public key -- generate this with the NetSparkleUpdater.Tools AppCastGenerator on any OS
) {
UIFactory = new NetSparkleUpdater.UI.WPF.UIFactory(icon) // or null or choose some other UI factory or build your own!
};
_sparkle.StartLoop(true); // `true` to run an initial check online -- only call StartLoop once for a given SparkleUpdater instance!
On the first Application.Idle event, your App Cast XML file will be downloaded, read, and compared to the currently running version. If it has a software update inside, the user will be notified with a little toast notification (if supported by the UI and enabled) or with an update dialog containing your release notes. The user can then ignore the update, ask to be reminded later, or download/install it now.
If you want to check for an update in the background without the user seeing anything, use
_sparkle.CheckForUpdatesQuietly();
If you want to have a menu item for the user to check for updates so the user can see the UI while NetSparkle looks for updates, use
_sparkle.CheckForUpdatesAtUserRequest();
If you have files that need saving, subscribe to the PreparingToExit event:
_sparkle.PreparingToExit += ((x, cancellable) =>
{
// ask the user to save, whatever else is needed to close down gracefully
});
Note that if you do not use a UIFactory
, you must use the CloseApplication
or CloseApplicationAsync
events to close your application; otherwise, your downloaded update file will never be executed/read! The only exception to this is if you want to handle all aspects of installing the update package yourself.
The file that launches your downloaded update executable only waits for 90 seconds before giving up! Make sure that your software closes within 90 seconds of CloseApplication/CloseApplicationAsync being called if you implement those events! If you need an event that can be canceled, such as when the user needs to be asked if it's OK to close (e.g. to save their work), use AboutToExitForInstallerRun/AboutToExitForInstallerRunAsync.
NetSparkle uses Sparkle-compatible app casts for the most part. NetSparkle uses sparkle:signature
rather than sparkle:dsaSignature
so that you can choose how to sign your files/app cast. NetSparkle is compatible with and uses Ed25519 signatures by default, but the framework can handle a different implementation of the ISignatureVerifier
class to check different kinds of signatures without a major version bump/update.
Note: if your app has DSA signatures, the app cast generator uses Ed25519 signatures by default starting with preview 2.0.0-20200607001. To transition to Ed25519 signatures, create an update where the software has your new Ed25519 public key and a NEW url for a NEW app cast that uses Ed25519 signatures. Upload this update with an app cast that has DSA signatures so your old DSA-enabled app can download the Ed25519-enabled update. Then, future updates and app casts should all use Ed25519.
Here is a sample app cast:
<?xml version="1.0" encoding="UTF-8"?>
<rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle" version="2.0">
<channel>
<title>NetSparkle Test App</title>
<link>https://netsparkleupdater.github.io/NetSparkle/files/sample-app/appcast.xml</link>
<description>Most recent changes with links to updates.</description>
<language>en</language>
<item>
<title>Version 2.0 (2 bugs fixed; 3 new features)</title>
<sparkle:releaseNotesLink>
https://netsparkleupdater.github.io/NetSparkle/files/sample-app/2.0-release-notes.md
</sparkle:releaseNotesLink>
<pubDate>Thu, 27 Oct 2016 10:30:00 +0000</pubDate>
<enclosure url="https://netsparkleupdater.github.io/NetSparkle/files/sample-app/NetSparkleUpdate.exe"
sparkle:version="2.0"
sparkle:os="windows"
length="12288"
type="application/octet-stream"
sparkle:signature="NSG/eKz9BaTJrRDvKSwYEaOumYpPMtMYRq+vjsNlHqRGku/Ual3EoQ==" />
</item>
</channel>
</rss>
NetSparkle reads the <item>
tags to determine whether updates are available.
The important tags in each <item>
are:
<description>
- A description of the update in HTML or Markdown.
- Overrides the
<sparkle:releaseNotesLink>
tag.
<sparkle:releaseNotesLink>
- The URL to an HTML or Markdown document describing the update.
- If the
<description>
tag is present, it will be used instead. - Attributes:
sparkle:signature
, optional: the DSA signature of the document; NetSparkle does not check this DSA signature for you unless you setReleaseNotesGrabber.ChecksReleaseNotesSignature
totrue
, but you may manually verify changelog DSA signatures if you like or setReleaseNotesGrabber.ChecksReleaseNotesSignature = true
in your UI.
<pubDate>
- The date this update was published
<enclosure>
- This tag describes the update file that NetSparkle will download.
- Attributes:
url
: URL of the update filesparkle:version
: machine-readable version number of this updatelength
, optional: (not validated) size of the update file in bytestype
: ignoredsparkle:signature
: DSA signature of the update filesparkle:criticalUpdate
, optional: if equal totrue
or1
, the UI will indicate that this is a critical updatesparkle:os
: Operating system for the app cast item. Defaults to Windows if not supplied. For Windows, use "win" or "windows"; for macOS, use "macos" or "osx"; for Linux, use "linux".
By default, you need 2 (DSA) signatures (SecurityMode.Strict
):
- One in the enclosure tag for the update file (
sparkle:signature="..."
) - Another on your web server to secure the actual app cast file. This file must be located at [AppCastURL].signature. In other words, if the app cast URL is http://example.com/awesome-software.xml, you need a valid (DSA) signature for that file at http://example.com/awesome-software.xml.signature.
You can generate Ed25519 signatures using the AppCastGenerator
tool (from this NuGet package or in the source code here). If you need to generate an Ed25519 keypair, use the tool like this:
generate_appcast.exe --generate-keys
Then you can use the tool like this:
generate_appcast.exe -a directory/for/appcast/ -e ext -b directory/with/binaries/ -o windows
You can use the AppCastGenerator
tool to verify your binaries:
generate_appcast.exe --verify path/to/binary.exe --signature base_64_signature
If you want to make a signature for a binary, you can do so like this:
generate_appcast.exe --generate-signature path/to/binary.exe
By default, your Ed25519 signatures are stored on disk in your local application data folder in a subdirectory called netsparkle
. If you want to export your keys, you can do:
generate_appcast.exe --export
If you want to use keys dynamically, you can set the SPARKLE_PRIVATE_KEY
and SPARKLE_PUBLIC_KEY
environment variables before running generate_appcast
. The tool prioritizes environment keys over keys sitting on disk!
If your keys are sitting on disk somewhere (NetSparkle_Ed25519.priv
and NetSparkle_Ed25519.pub
-- both in base 64 and both on disk in the same folder!), you can pass in the path to these keys like this:
generate_appcast.exe --key-path path/to/keys/
DSA signatures are not recommended for 2.0. They are insecure!
You can generate these signatures using the DSAHelper
tool (from this NuGet package or in the source code here). If you need to generate a DSA public/private key, please use the same tool on Windows like this:
NetSparkle.DSAHelper.exe /genkey_pair
This only works on Windows because .NET Core 3 does not have the proper implementation to generate DSA keys on macOS/Linux.
On any platform, you can use the DSAHelper to get a signature like this:
NetSparkle.DSAHelper.exe /sign_update {YourInstallerPackage.msi} {NetSparkle_PrivateKey_DSA.priv}
- Use the
AppCastGenerator
tool (from this NuGet package or in the source code here) to easily create your app cast file. - Rig up a script that generates the app cast for you in python or some other language (
string.Format
or similar is a wonderful thing). - Or you can just copy/paste the above example app cast into your own file and tweak the signatures/download info yourself, then generate the (DSA) signature for the app cast file manually! :)
This section is still WIP, but major changes include:
- Minimum .NET requirement is now .NET Framework 4.5.2 instead of 4.5.1
- Change of base namespace from
NetSparkle
toNetSparkleUpdater
Sparkle
renamed toSparkleUpdater
for clarity- UIs are now in different namespaces. If you want to use a UI, you must pass in a
UIFactory
that implementsIUIFactory
and handles showing/handling all user interface elementsSparkleUpdater
no longer holds its ownIcon
HideReleaseNotes
,HideRemindMeLaterButton
, andHideSkipButton
are all handled by theUIFactory
objects
- Added built-in UIs for Avalonia and WPF
- Localization capabilities are non-functional and are expected to come back in a later version. See this issue.
- Most
SparkleUpdater
elements are now configurable. For example, you can implementIAppCastHandler
to implement your own app cast parsing and checking.IAppCastDataDownloader
to implement downloading of your app cast fileIAppCastHandler
to implement your own app cast parsingISignatureVerifier
to implement your own download/app cast signature checking. NetSparkle has built-in DSA and Ed25519 signature verifiers.IUIFactory
to implement your own UI
- Samples have been updated and improved
- Sample apps for Avalonia, WinForms, and WPF UIs
- Sample app to demonstrate how to handle events yourself with your own UI
- Many delegates, events, and functions have been renamed, removed, and/or tweaked for clarity and better use
DownloadEvent
now has theAppCastItem
that is being downloaded rather than being just the download pathAboutToExitForInstallerRun
/AboutToExitForInstallerRunAsync
has been renamed toPreparingToExit
/``PreparingToExitAsync`, respectively- The
UserSkippedVersion
event has been removed. UseUserRespondedToUpdate
instead. - The
RemindMeLaterSelected
event has been removed. UseUserRespondedToUpdate
instead. - The
FinishedDownloading
/DownloadedFileReady
events have been removed. UseDownloadFinished
instead.
- By default, the app cast signature file now has a
.signature
extension. The app cast downloader will look for a file with the old.dsa
signature if data is not available or found in aappcast.xml.signature
on your server. sparkle:dsaSignature
is nowsparkle:signature
instead. If nosparkle:signature
is found,sparkle:dsaSignature
will be used (if available).- By default, the app cast generator tool now uses Ed25519 signatures. If you don't want to use files on disk to store your keys, set the
SPARKLE_PRIVATE_KEY
andSPARKLE_PUBLIC_KEY
environment variables before running the app cast generator tool.
Initializes a new instance of the Sparkle class with the given appcast URL and signature verifier.
Name | Description |
---|---|
appcastUrl | System.String the URL of the appcast file |
signatureVerifier | NetSparkle.Interfaces.ISIgnatureVerifier the object that will validate your app cast signatures |
Initializes a new instance of the Sparkle class with the given appcast URL, signature verifier, and the name of the assembly to use when comparing update versions.
Name | Description |
---|---|
appcastUrl | System.String the URL of the appcast file |
signatureVerifier | NetSparkle.Interfaces.ISIgnatureVerifier the object that will validate your app cast signatures |
referenceAssembly | System.String the name of the assembly to use for comparison when checking update versions |
SparkleUpdater(string appcastUr, ISignatureVerifier signatureVerifier, string referenceAssembly, NetSparkle.Interfaces.IUIFactory factory)
Initializes a new instance of the Sparkle class with the given appcast URL, signature verifier, the name of the assembly to use when comparing update versions, and a UI factory to use in place of the default UI.
Name | Description |
---|---|
appcastUrl | System.String the URL of the appcast file |
signatureVerifier | NetSparkle.Interfaces.ISIgnatureVerifier the object that will validate your app cast signatures |
referenceAssembly | System.String the name of the assembly to use for comparison when checking update versions |
factory | NetSparkle.Interfaces.IUIFactory a UI factory to use in place of the default UI |
Cancels an in-progress download and deletes the temporary file.
Check for updates, using interaction appropriate for if the user just said "check for updates".
Check for updates, using interaction appropriate for where the user doesn't know you're doing it, so be polite.
(WinForms only) Schedules an update check to happen on the first Application.Idle event.
Inherited from IDisposable. Stops all background activities.
Creates a System.Uri from a URL string. If the URL is relative, converts it to an absolute URL based on the appcast URL.
Name | Description |
---|---|
url | System.String relative or absolute URL |
Reads the local Sparkle configuration for the given reference assembly.
This method checks if an update is required. During this process the appcast will be downloaded and checked against the reference assembly. Ensure that the calling process has read access to the reference assembly. This method is also called from the background loops.
Name | Description |
---|---|
config | NetSparkle.Configuration the NetSparkle configuration for the reference assembly |
Returns: NetSparkle.SparkleUpdateInfo with information on whether there is an update available or not.
Used by NetSparkle.AppCast to fetch the appcast and DSA signature.
Used by NetSparkle.AppCast to fetch the appcast and DSA signature as a System.IO.Stream.
Shows the update UI with the latest downloaded update information.
Name | Description |
---|---|
isUpdateAlreadyDownloaded | System.Boolean If true, make sure UI text shows that the user is about to install the file instead of download it. |
Shows the update needed UI with the given set of updates.
Name | Description |
---|---|
updates | NetSparkle.AppCastItem[] updates to show UI for |
isUpdateAlreadyDownloaded | System.Boolean If true, make sure UI text shows that the user is about to install the file instead of download it. |
Starts a NetSparkle background loop to check for updates every 24 hours.
You should only call this function when your app is initialized and shows its main window.
Name | Description |
---|---|
doInitialCheck | System.Boolean whether the first check should happen before or after the first interval |
Starts a NetSparkle background loop to check for updates every 24 hours.
You should only call this function when your app is initialized and shows its main window.
Name | Description |
---|---|
doInitialCheck | System.Boolean whether the first check should happen before or after the first interval |
forceInitialCheck | System.Boolean if doInitialCheck is true, whether the first check should happen even if the last check was less than 24 hours ago |
Starts a NetSparkle background loop to check for updates on a given interval.
You should only call this function when your app is initialized and shows its main window.
Name | Description |
---|---|
doInitialCheck | System.Boolean whether the first check should happen before or after the first period |
forceInitialCheck | System.Boolean if doInitialCheck is true, whether the first check should happen even if the last check was within the last checkFrequency interval |
checkFrequency | System.TimeSpan the interval to wait between update checks |
Starts a NetSparkle background loop to check for updates on a given interval.
You should only call this function when your app is initialized and shows its main window.
Name | Description |
---|---|
doInitialCheck | System.Boolean whether the first check should happen before or after the first interval |
checkFrequency | System.TimeSpan the interval to wait between update checks |
Stops the Sparkle background loop. Called automatically by Dispose.
- string AppcastUrl { get; set; }
- NetSparkle.CheckingForUpdatesWindow CheckingForUpdatesWindow { get; set; }
- System.Action ClearOldInstallers { get; set; }
- NetSparkle.Configuration Configuration { get; set; }
- string CustomInstallerArguments { get; set; }
- NetSparkle.DSAChecker DSAChecker { get; set; }
- NetSparkle.LogWriter LogWriter { get; set; }
- string ExtraJsonData { get; set; }
- bool HideReleaseNotes { get; set; }
- bool HideRemindMeLaterButton { get; set; }
- bool HideSkipButton { get; set; }
- bool IsUpdateLoopRunning { get; }
- NetSparkle.AppCastItem[] LatestAppCastItems { get; }
- PrintDiagnosticToConsole { get; set; }
- NetSparkle.Interfaces.IDownloadProgress ProgressWindow { get; set; }
- bool RelaunchAfterUpdate { get; set; }
- bool ShowsUIOnMainThread { get; set; }
- NetSparkle.Sparkle.UserInteractionMode UserInteractionMode { get; set; }
- string TmpDownloadFilePath { get; set; }
- bool TrustEverySSLConnection { get; set; }
- NetSparkle.Interfaces.IUIFactory UIFactory { get; set; }
- bool UpdateMarkedCritical { get; }
- bool UseNotificationToast { get; set; }
- NetSparkle.Interfaces.IUpdateAvailable UserWindow { get; set; }
- NetSparkle.SecurityProtocolType SecurityProtocolType { get; set; }
Gets or sets the appcast URL
The user interface window that shows the 'Checking for Updates...' form. TODO: Make this an interface so user can config their own UI
Function that is called asynchronously to clean up old installers that have been downloaded with UserInteractionMode.DownloadNoInstall or UserInteractionMode.DownloadAndInstall.
The NetSparkle configuration object for the current assembly.
Run the downloaded installer with these arguments
The DSA checker that verifies/validates downloaded files
Logs diagnostic information to Console.WriteLine
or Debug.WriteLine
or wherever else the child class wants to report diagnostic information
If not "", sends extra JSON via POST to server with the web request for update information and for the DSA signature.
Hides the release notes view when an update is found.
Hides the remind me later button when an update is found.
Hides the skip button view when an update is found.
Whether or not the update loop is running
Returns the latest appcast items to the caller. Might be null.
If true, prints diagnostic messages to Console.WriteLine rather than Debug.WriteLine
The user interface window that shows a download progress bar, and then asks to install and relaunch the application
Defines if the application needs to be relaunched after executing the downloaded installer
WinForms only. If true, tries to run UI code on the main thread using System.Threading.SynchronizationContext.
Set the silent mode type for Sparkle to use when there is a valid update for the software
If set, downloads files to this path. If the folder doesn't already exist, creates the folder. Note that this variable is a path, not a full file name.
If true, don't check the validity of SSL certificates
Factory for creating UI forms like progress window, etc.
Loops through all of the most recently grabbed app cast items and checks if any of them are marked as critical
Specifies if you want to use the notification toast
The user interface window that shows the release notes and asks the user to skip, later or update
The security protocol (System.Net.SecurityProtocolType
) used by NetSparkle. Setting this property will also set this property for the current AppDomain of the caller. Needs to be set to SecurityProtocolType.Tls12
for some cases, such as downloading something over HTTPS for a GitHub pages site.
- AboutToExitForInstallerRun
- AboutToExitForInstallerRunAsync
- CloseApplication
- CloseApplicationAsync
- CheckLoopFinished
- CheckLoopStarted
- DownloadCanceled
- DownloadedFileIsCorrupt
- DownloadedFileReady
- DownloadError
- FinishedDownloading
- StartedDownloading
- UpdateCheckFinished
- UpdateCheckStarted
- UpdateDetected
- UserSkippedVersion
- RemindMeLaterSelected
Delegate: void System.ComponentModel.CancelEventHandler(object sender, System.ComponentModel.CancelEventArgs e)
Subscribe to this to get a chance to shut down gracefully before quitting. If AboutToExitForInstallerRunAsync is set, this has no effect.
Delegate: Task CancelEventHandlerAsync(object sender, System.ComponentModel.CancelEventArgs e)
Subscribe to this to get a chance to asynchronously shut down gracefully before quitting. This overrides AboutToExitForInstallerRun.
Delegate: void CloseApplication()
Event for custom shutdown logic. If this is set, it is called instead of Application.Current.Shutdown or Application.Exit. If CloseApplicationAsync is set, this has no effect.
Warning: The batch file that launches your executable only waits for 90 seconds before giving up! Make sure that your software closes within 90 seconds if you implement this event! If you need an event that can be canceled, use AboutToExitForInstallerRun.
Delegate: Task CloseApplicationAsync()
Event for custom shutdown logic. If this is set, it is called instead of Application.Current.Shutdown or Application.Exit. This overrides CloseApplication.
Warning: The batch file that launches your executable only waits for 90 seconds before giving up! Make sure that your software closes within 90 seconds if you implement this event! If you need an event that can be canceled, use AboutToExitForInstallerRunAsync.
Delegate: void NetSparkle.LoopFinishedOperation(object sender, bool updateRequired)
This event will be raised when a check loop is finished
Delegate: void NetSparkle.LoopStartedOperation(object sender)
This event will be raised when a check loop will be started
Delegate: void NetSparkle.DownloadEvent(string path)
Called when the download has been canceled
Delegate: void NetSparkle.DownloadedFileIsCorrupt(NetSparkle.AppCastItem item, string downloadPath)
Called when the downloaded file is downloaded (or at least partially on disk) and the DSA signature doesn't match. When this is called, Sparkle is not taking any further action to try to download the install file during this instance of the software. In order to make Sparkle try again, you must delete the file off disk yourself. Sparkle will try again after the software is restarted.
Delegate: void NetSparkle.DownloadedFileReady(NetSparkle.AppCastItem item, string downloadPath)
Called when the downloaded file is fully downloaded and verified regardless of the value for SilentMode. Note that if you are installing fully silently, this will be called before the install file is executed, so don't manually initiate the file or anything.
Delegate: void NetSparkle.DownloadEvent(string path)
Called when the download has downloaded but has an error other than corruption
Delegate: void NetSparkle.DownloadEvent(string path)
Called when the download has finished successfully
Delegate: void NetSparkle.DownloadEvent(string path)
Called when the download has just started
Delegate: void NetSparkle.UpdateCheckFinished(object sender, NetSparkle.UpdateStatus status)
Called when update check is all done. May or may not have called UpdateDetected in the middle.
Delegate: void NetSparkle.UpdateCheckStarted(object sender)
Called when update check has just started
Delegate: void NetSparkle.UpdateDetected(object sender, NetSparkle.UpdateDetectedEventArgs e)
This event can be used to override the standard user interface process when an update is detected
Delegate: void NetSparkle.UserSkippedVersion(NetSparkle.AppCastItem item, string downloadPath)
Called when the user skips some version of the application.
Delegate: void NetSparkle.RemindMeLaterSelected(AppCastItem item);
Called when the user skips some version of the application by clicking the 'Remind Me Later' button
NetSparkle is available under the MIT License.
- .NET Framework 4.5.1+ OR .NET Core 3+
- The original NetSparkle library, found at dei79/netsparkle
- A function for finding the base directory was taken from MIT-licensed WalletWasabi
- MarkdownSharp is from here
An incomplete list of other projects related to software updating: