Class AutoUpdater

Namespace

HeBianGu.Systems.Upgrade

Assembly

HeBianGu.Systems.Upgrade.dll

Main class that lets you auto update applications by setting some static fields and executing its Start method.

public static class AutoUpdater

Inheritance

object

AutoUpdater

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

AppCastURL

URL of the xml file that contains information about latest version of the application.

public static string AppCastURL

Field Value

string

AppTitle

Set the Application Title shown in Update dialog. Although AutoUpdater.NET will get it automatically, you can set this property if you like to give custom Title.

public static string AppTitle

Field Value

string

BasicAuthChangeLog

Set Basic Authentication credentials to navigate to the change log URL.

public static IAuthentication BasicAuthChangeLog

Field Value

IAuthentication

BasicAuthDownload

Set Basic Authentication credentials required to download the file.

public static IAuthentication BasicAuthDownload

Field Value

IAuthentication

BasicAuthXML

Set Basic Authentication credentials required to download the XML file.

public static IAuthentication BasicAuthXML

Field Value

IAuthentication

ClearAppDirectory

Set this to true if you want to clear application directory before extracting update.

public static bool ClearAppDirectory

Field Value

bool

DownloadPath

Set it to folder path where you want to download the update file. If not provided then it defaults to Temp folder.

public static string DownloadPath

Field Value

string

FtpCredentials

Login/password/domain for FTP-request

public static NetworkCredential FtpCredentials

Field Value

NetworkCredential

HttpUserAgent

Set the User-Agent string to be used for HTTP web requests.

public static string HttpUserAgent

Field Value

string

InstallationPath

If you are using a zip file as an update file then you can set this value to path where your app is installed. This is only necessary when your installation directory differs from your executable path.

public static string InstallationPath

Field Value

string

InstalledVersion

You can set this field to your current version if you don't want to determine the version from the assembly.

public static Version InstalledVersion

Field Value

Version

LetUserSelectRemindLater

If this is true users see dialog where they can set remind later interval otherwise it will take the interval from RemindLaterAt and RemindLaterTimeSpan fields.

public static bool LetUserSelectRemindLater

Field Value

bool

Mandatory

Set this to true if you want to ignore previously assigned Remind Later and Skip settings. It will also hide Remind Later and Skip buttons.

public static bool Mandatory

Field Value

bool

OpenDownloadPage

Opens the download URL in default browser if true. Very usefull if you have portable application.

public static bool OpenDownloadPage

Field Value

bool

PersistenceProvider

Set this to an instance implementing the IPersistenceProvider interface for using a data storage method different from the default Windows Registry based one.

public static IPersistenceProvider PersistenceProvider

Field Value

IPersistenceProvider

Proxy

Set Proxy server to use for all the web requests in AutoUpdater.NET.

public static IWebProxy Proxy

Field Value

IWebProxy

RemindLaterAt

Remind Later interval after user should be reminded of update.

public static int RemindLaterAt

Field Value

int

RemindLaterTimeSpan

Set if RemindLaterAt interval should be in Minutes, Hours or Days.

public static RemindLaterFormat RemindLaterTimeSpan

Field Value

RemindLaterFormat

ReportErrors

AutoUpdater.NET will report errors if this is true.

public static bool ReportErrors

Field Value

bool

RunUpdateAsAdmin

Set this to false if your application doesn't need administrator privileges to replace the old version.

public static bool RunUpdateAsAdmin

Field Value

bool

ShowRemindLaterButton

If this is true users can see the Remind Later button.

public static bool ShowRemindLaterButton

Field Value

bool

ShowSkipButton

If this is true users can see the skip button.

public static bool ShowSkipButton

Field Value

bool

Synchronous

Set this to true if you want to run update check synchronously.

public static bool Synchronous

Field Value

bool

UpdateFormSize

Set if you want the default update form to have a different size.

public static Size? UpdateFormSize

Field Value

Size?

UpdateMode

Set this to any of the available modes to change behaviour of the Mandatory flag.

public static Mode UpdateMode

Field Value

Mode

Methods

CheckUpdate(Assembly, string)

public static UpdateInfoEventArgs CheckUpdate(Assembly mainAssembly, string url)

Parameters

mainAssembly Assembly

url string

Returns

UpdateInfoEventArgs

DownloadUpdate(UpdateInfoEventArgs)

Opens the Download window that download the update and execute the installer when download completes.

public static bool DownloadUpdate(UpdateInfoEventArgs args)

Parameters

args UpdateInfoEventArgs

Returns

bool

ShowUpdateForm(UpdateInfoEventArgs)

Shows standard update dialog.

public static void ShowUpdateForm(UpdateInfoEventArgs args)

Parameters

args UpdateInfoEventArgs

Start(Assembly)

Start checking for new version of application and display a dialog to the user if update is available.

public static void Start(Assembly myAssembly = null)

Parameters

myAssembly Assembly

Assembly to use for version checking.

Start(string, NetworkCredential, Assembly)

Start checking for new version of application via FTP and display a dialog to the user if update is available.

public static void Start(string appCast, NetworkCredential ftpCredentials, Assembly myAssembly = null)

Parameters

appCast string

FTP URL of the xml file that contains information about latest version of the application.

ftpCredentials NetworkCredential

Credentials required to connect to FTP server.

myAssembly Assembly

Assembly to use for version checking.

Start(string, Assembly)

Start checking for new version of application and display a dialog to the user if update is available.

public static void Start(string appCast, Assembly myAssembly = null)

Parameters

appCast string

URL of the xml file that contains information about latest version of the application.

myAssembly Assembly

Assembly to use for version checking.

Events

ApplicationExitEvent

An event that developers can use to exit the application gracefully.

public static event AutoUpdater.ApplicationExitEventHandler ApplicationExitEvent

Event Type

AutoUpdater.ApplicationExitEventHandler

CheckForUpdateEvent

An event that clients can use to be notified whenever the update is checked.

public static event AutoUpdater.CheckForUpdateEventHandler CheckForUpdateEvent

Event Type

AutoUpdater.CheckForUpdateEventHandler

ParseUpdateInfoEvent

An event that clients can use to be notified whenever the AppCast file needs parsing.

public static event AutoUpdater.ParseUpdateInfoHandler ParseUpdateInfoEvent

Event Type

AutoUpdater.ParseUpdateInfoHandler