Platforms to show: All Mac Windows Linux Cross-Platform

Back to SUUpdaterMBS class.

SUUpdaterMBS.updaterDidNotFindUpdate

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 8.6 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The event called when a valid update is not found.

Plugin version 8.7 makes sure this method is executed on the main thread.

Some examples using this event:

SUUpdaterMBS.updaterDidRelaunchApplication

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 20.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called immediately after relaunching. SUUpdater delegate must be set before applicationDidFinishLaunching: to catch this event.

SUUpdaterMBS.updaterDidShowModalAlert

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 14.4 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called after an updater shows a modal alert window, to give the host the opportunity to hide attached windows etc. that may get in the way.

New in version 1.6 of Sparkle.

SUUpdaterMBS.updaterMayCheckForUpdates as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 14.4 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Use this to keep Sparkle from popping up e.g. while your setup assistant is showing.

New in version 1.6 of Sparkle.

SUUpdaterMBS.updaterShouldPromptForPermissionToCheckForUpdates as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 8.6 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The event to decide whether the updater should prompt for permission to check for updates.

Use this to override the default behavior for Sparkle prompting the user about automatic update checks.

If you leave this event empty the default handler will be called. If you add code here, the default handle will not be called!

SUUpdaterMBS.updaterShouldRelaunchApplication as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 14.4 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Whether app should be relaunched.

Some apps *can not* be relaunched in certain circumstances. They can use this method to prevent a relaunch "hard".
New in version 1.6 of Sparkle.

SUUpdaterMBS.updaterShouldShowUpdateAlertForScheduledUpdate(item as SUAppcastItemMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 20.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called just before the scheduled update driver prompts the user to install an update.

Yes to allow the update prompt to be shown (the default behavior), or no to suppress it.

SUUpdaterMBS.updaterWillRelaunchApplication

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 8.6 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The event called immediately before relaunching.

Plugin version 8.7 makes sure this method is executed on the main thread.

The current Sparkle implementation seems to force quit the application so this method is the last chance for your application to clean up.

SUUpdaterMBS.updaterWillShowModalAlert

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 14.4 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called before an updater shows a modal alert window, to give the host the opportunity to hide attached windows etc. that may get in the way.

New in version 1.6 of Sparkle.

SUUpdaterMBS.userDidCancelDownload

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 16.1 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called when the user clicks the cancel button while and update is being downloaded.

This is a newer event which is only called in 64-bit version.

SUUpdaterMBS.userDidSkipThisVersion(item as SUAppcastItemMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 20.3 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called when the user clicks the Skip This Version button.

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


The biggest plugin in space...