Platforms to show: All Mac Windows Linux Cross-Platform

Back to WinSparkleMBS class.

WinSparkleMBS.AppCastURL as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared property Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Sets URL for the app's appcast.
Example
WinSparkleMBS.AppCastURL = "https://www.monkeybreadsoftware.test/test/test.xml"

Only http and https schemes are supported.

If this function isn't called by the app, the URL is obtained from Windows resource named "FeedURL" of type "APPCAST".

Always use HTTPS feeds, do not use unencrypted HTTP! This is necessary to prevent both leaking user information and preventing various MITM attacks.

See https://github.com/vslavik/winsparkle/wiki/Appcast-Feeds for more information about appcast feeds.
(Read and Write property)

Some examples using this property:

WinSparkleMBS.AppName as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared property Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Application name.
Example
WinSparkleMBS.CompanyName = "Monkeybread Software"
WinSparkleMBS.AppName = "Test App"
WinSparkleMBS.AppVersion = "1.2.3"

This is both shown to the user and used in HTTP User-Agent header.

CompanyName and AppName are used to determine the location of WinSparkle settings in registry. (HKCU\Software\<CompanyName>\<AppName>\WinSparkle is used.)

If not set, this value is read from VERSIONINFO/StringFileInfo resources.
(Read and Write property)

WinSparkleMBS.AppVersion as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared property Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Version of the app, as string (e.g. "1.2" or "1.2rc1").
Example
WinSparkleMBS.CompanyName = "Monkeybread Software"
WinSparkleMBS.AppName = "Test App"
WinSparkleMBS.AppVersion = "1.2.3"

If not set, this value is read from VERSIONINFO/StringFileInfo resources.
(Read and Write property)

WinSparkleMBS.AutomaticCheckForUpdates as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared property Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Whether updates are checked automatically or only through a manual call.
Example
WinSparkleMBS.AutomaticCheckForUpdates = true

If disabled, CheckUpdateWithUI must be used explicitly.

True to have updates checked automatically, false otherwise.
Defaults to false when not yet configured (as happens on first start).
(Read and Write property)

Some examples using this property:

WinSparkleMBS.BuildVersion as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared property Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Sets application build version number.
Example
WinSparkleMBS.BuildVersion = "123"

This is the internal version number that is not normally shown to the user. It can be used for finer granularity that official release versions, e.g. for interim builds.

If this function is called, then the provided *build* number is used for comparing versions; it is compared to the "version" attribute in the appcast and corresponds to OS X Sparkle's CFBundleVersion handling. If used, then the appcast must also contain the "shortVersionString" attribute with human-readable display version string. The version passed to AppVersion property corresponds to this and is used for display.
(Read and Write property)

WinSparkleMBS.CanShutdown as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared property Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Whether your app can shutdown now.
Example
WinSparkleMBS.CanShutdown = false

By default true.
Set to false when you have something like an open edited document.
(Read and Write property)

Some examples using this property:

WinSparkleMBS.CompanyName as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared property Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The name of the vendor.
Example
WinSparkleMBS.CompanyName = "Monkeybread Software"
WinSparkleMBS.AppName = "Test App"
WinSparkleMBS.AppVersion = "1.2.3"

CompanyName and AppName are used to determine the location of WinSparkle settings in registry. (HKCU\Software\<CompanyName>\<AppName>\WinSparkle is used.)

If not set, this value is read from VERSIONINFO/StringFileInfo resources.
(Read and Write property)

Some examples using this property:

WinSparkleMBS.DSAPubPEM as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared property Sparkle MBS Win Plugin 19.3 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The public key in PEM format.

If not set, the framework will look into the app resources.
(Read and Write property)

WinSparkleMBS.Language as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared property Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Sets UI language from its ISO code.
Example
WinSparkleMBS.Language = "en-US"

Language and LanguageID properties set user interface language. One must be set before
Initialize to have any effect. If none of them is called, WinSparkle detects the UI language automatically.

ISO 639 language code with an optional ISO 3116 country code, e.g. "fr", "pt-PT", "pt-BR" or "pt_BR",
(Read and Write property)

WinSparkleMBS.LanguageID as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared property Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Sets UI language from its Win32 LANGID code.

Language and LanguageID properties set user interface language. One must be set before
Initialize to have any effect. If none of them is called, WinSparkle detects the UI language automatically.
(Read and Write property)

WinSparkleMBS.LastCheckTime as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared property Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Gets the time for the last update check.

Default value is -1, indicating that the update check has never run.
(Read only property)

Some examples using this property:

WinSparkleMBS.RegistryPath as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared property Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The registry path where settings will be stored.
Example
WinSparkleMBS.RegistryPath = "Software\My App\Updates"

Normally, these are stored in "HKCU\Software\<company_name>\<app_name>\WinSparkle" but if your application needs to store the data elsewhere for some reason, using this function is an alternative.
Note that path is relative to HKCU/HKLM root and the root is not part of it. For example:
(Read and Write property)

WinSparkleMBS.UpdateCheckInterval as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared property Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The automatic update interval.
Example
WinSparkleMBS.UpdateCheckInterval = 7200

The interval in seconds between checks for updates. The minimum update interval is 3600 seconds (1 hour).
(Read and Write property)

The items on this page are in the following plugins: MBS Win Plugin.


The biggest plugin in space...