Platforms to show: All Mac Windows Linux Cross-Platform

Back to SUUpdaterMBS class.

SUUpdaterMBS.checkForUpdateInformation

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Sparkle MBS MacExtras Plugin 8.6 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Checks for new update information.

This begins a "probing" check for updates which will not actually offer to update to that version. The events, though, (up to didFindValidUpdate and updaterDidNotFindUpdate), are called, so you can use that information in your UI.

SUUpdaterMBS.checkForUpdates

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Sparkle MBS MacExtras Plugin 8.6 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Performs a check for updates.

Call this method from a menu item where the user can check for updates manually. Sparkle will check for updates and report back its findings verbosely.

Some examples using this method:

SUUpdaterMBS.checkForUpdatesInBackground

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Sparkle MBS MacExtras Plugin 8.6 ✅ Yes ❌ No ❌ No ❌ No Desktop only
This kicks off an update meant to be programmatically initiated.

That is, it will display no UI unless it actually finds an update, in which case it proceeds as usual. If the fully automated updating is turned on, however, this will invoke that behavior, and if an update is found, it will be downloaded and prepped for installation.

Some examples using this method:

SUUpdaterMBS.Constructor

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Sparkle MBS MacExtras Plugin 8.6 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The constructor for the updater.

Please create only one instance of the SUUpdaterMBS class in your application using this constructor.

See also:

SUUpdaterMBS.Constructor(Bundle as folderitem)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Sparkle MBS MacExtras Plugin 8.6 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The constructor for the updater.

Targets for the update the bundle you specify. This can be used to update a preference panel for example.

Please create only one instance of the SUUpdaterMBS class in your application using this constructor.

See also:

SUUpdaterMBS.installUpdatesIfAvailable

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Sparkle MBS MacExtras Plugin 16.1 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Checks for updates and, if available, immediately downloads and installs them.

A progress dialog is shown but the user will never be prompted to read the release notes.

You may want to respond to the userDidCancelDownload event in case the user clicks the "Cancel" button while the update is downloading.

Only available in newer Sparkle version for 64-bit.

Not available in newer Sparkle versions.

SUUpdaterMBS.InvokeImmediateInstallation

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Sparkle MBS MacExtras Plugin 14.4 ✅ Yes ❌ No ❌ No ❌ No Desktop only
If installation was moved to quit of app, you can call this method to update now.

New in version 1.6 of Sparkle.

SUUpdaterMBS.InvokeUpdate

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Sparkle MBS MacExtras Plugin 14.0 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Invokes a postponed updated.

Call this after you returned true in shouldPostponeRelaunchForUpdate event and have time to restart.

SUUpdaterMBS.resetUpdateCycle

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Sparkle MBS MacExtras Plugin 8.6 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Resets the update cycle.

Call this to appropriately schedule or cancel the update checking timer according to the preferences for time interval and automatic checks. This call does not change the date of the next check, but only the internal timer.

SUUpdaterMBS.validateMenuItem(menuItem as NSMenuItemMBS) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Sparkle MBS MacExtras Plugin 20.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
he menu item validation used for the checkForUpdates action

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


The biggest plugin in space...