Daniel's XL Toolbox NG
XLToolbox.Versioning.Updater Class Reference
Inheritance diagram for XLToolbox.Versioning.Updater:
Collaboration diagram for XLToolbox.Versioning.Updater:

Public Member Functions

 Updater (Bovender.Versioning.IReleaseInfo releaseInfo)
 
- Public Member Functions inherited from Bovender.Versioning.Updater
void CheckForUpdate ()
 Downloads the current version information file asynchronously from the project home page. More...
 
void CancelCheckForUpdate ()
 
void DownloadUpdate ()
 Downloads the current release from the internet. More...
 
void CancelDownload ()
 
void InstallUpdate ()
 Verifies the Sha1 checksum of the file on disk again and executes the file if it is valid. Does nothing if no update is available. More...
 
void CheckForUpdate ()
 Downloads the current version information file asynchronously from the project home page. More...
 
void CancelCheckForUpdate ()
 
void DownloadUpdate ()
 Downloads the current release from the internet. More...
 
void CancelDownload ()
 
void InstallUpdate ()
 Verifies the Sha1 checksum of the file on disk again and executes the file if it is valid. Does nothing if no update is available. More...
 

Static Public Member Functions

static Updater CreateDefault (IReleaseInfo releaseInfo)
 

Properties

static Updater Default [get, set]
 
static bool CanCheck [get, set]
 
- Properties inherited from Bovender.Versioning.Updater
string DestinationFolder [get, set]
 
SemanticVersion NewVersion [get, protected set]
 
SemanticVersion CurrentVersion [get]
 
bool IsUpdateAvailable [get, protected set]
 If true, an updated version is available for download. More...
 
bool IsUpdatePending [get, protected set]
 Indicates whether an update has been downloaded and could be installed. More...
 
Uri DownloadUri [get, protected set]
 The URI of the remote file. More...
 
bool IsVerifiedDownload [get, protected set]
 Returns true if the Sha1 of the downloaded file matches the one in the version information file. More...
 
string UpdateChecksum [get, protected set]
 The Sha1 hash of the remote file as reported in the version info file. More...
 
string UpdateSummary [get, protected set]
 Summary of changes as reported in the version info file. More...
 
virtual bool IsAuthorized [get]
 Determines whether the current user is authorized to write to the folder where the addin files are stored. If the user does not have write permissions, he/she cannot update the addin by herself/hisself. More...
 
Exception DownloadException [get, protected set]
 

Events

static EventHandler< EventArgs > CanCheckChanged
 
- Events inherited from Bovender.Versioning.Updater
EventHandler< EventArgs > CheckForUpdateFinished
 Signals that the current version information has been refreshed. More...
 
EventHandler< DownloadProgressChangedEventArgs > DownloadProgressChanged
 Signals a change in the download process of the executable file. This event is chained from WebClient's event with the same name. More...
 
EventHandler< EventArgs > DownloadUpdateFinished
 Signals that an update has been downloaded. Subscribers need to check if the update is actually installable. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Bovender.Versioning.Updater
abstract Uri GetVersionInfoUri ()
 Returns the URI for the file that provides current version information. More...
 
abstract SemanticVersion GetCurrentVersion ()
 Returns the version number of the current program. More...
 
virtual void DoDownload ()
 
virtual void ConfirmDownload ()
 Performs the actual download once the user has confirmed the download destination. More...
 
virtual bool CanDownload ()
 
virtual void OnDownloadUpdateFinished ()
 
virtual void OnCheckForUpdateFinished ()
 
virtual string BuildDestinationFileName ()
 Builds the destination file name from the download URI and the destination folder (which is stored in a public property and could be set by a view that subscribes to this view model). More...
 
virtual void DoInstallUpdate ()
 Executes the update file. This method is called by InstallUpdate() only if the Sha1 checksum of the file meets the expectation. More...
 
virtual string GetInstallerCommand ()
 Returns the command to execute in the shell to install the update. More...
 
virtual string GetInstallerParameters ()
 Returns commandline parameters for the update installer. More...
 
abstract Uri GetVersionInfoUri ()
 Returns the URI for the file that provides current version information. More...
 
abstract SemanticVersion GetCurrentVersion ()
 Returns the version number of the current program. More...
 
virtual void DoDownload ()
 
virtual void ConfirmDownload ()
 Performs the actual download once the user has confirmed the download destination. More...
 
virtual bool CanDownload ()
 
virtual void OnDownloadUpdateFinished ()
 
virtual void OnCheckForUpdateFinished ()
 
virtual string BuildDestinationFileName ()
 Builds the destination file name from the download URI and the destination folder (which is stored in a public property and could be set by a view that subscribes to this view model). More...
 
virtual void DoInstallUpdate ()
 Executes the update file. This method is called by InstallUpdate() only if the Sha1 checksum of the file meets the expectation. More...
 
virtual string GetInstallerCommand ()
 Returns the command to execute in the shell to install the update. More...
 
virtual string GetInstallerParameters ()
 Returns commandline parameters for the update installer. More...
 

Constructor & Destructor Documentation

◆ Updater()

XLToolbox.Versioning.Updater.Updater ( Bovender.Versioning.IReleaseInfo  releaseInfo)
inline

Member Function Documentation

◆ CreateDefault()

static Updater XLToolbox.Versioning.Updater.CreateDefault ( IReleaseInfo  releaseInfo)
inlinestatic

Property Documentation

◆ CanCheck

bool XLToolbox.Versioning.Updater.CanCheck
staticgetset

◆ Default

Updater XLToolbox.Versioning.Updater.Default
staticgetset

Event Documentation

◆ CanCheckChanged

EventHandler<EventArgs> XLToolbox.Versioning.Updater.CanCheckChanged
static

The documentation for this class was generated from the following file: