Platforms to show: All Mac Windows Linux Cross-Platform

Back to SUUpdaterMBS class.

SUUpdaterMBS.bestValidUpdateInAppcast(appcast as SUAppcastMBS) as SUAppcastItemMBS

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 to decide which appcast item is the best to use.

If you're using special logic or extensions in your appcast, implement this to use your own logic for finding a valid update, if any, in the given appcast.

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.didAbortWithError(error as NSErrorMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 16.1 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called after an update is aborted due to an error.

error: The error that caused the abort

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

Some examples using this event:

SUUpdaterMBS.didCancelInstallUpdateOnQuit(update as SUAppcastItemMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 14.4 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called when an update is scheduled to be silently installed on quit and cancelled.

New in version 1.6 of Sparkle.

SUUpdaterMBS.didDismissUpdateAlertPermanently(permanently as boolean, 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 after the user dismisses the update alert.

permanently: true if the alert will not appear again for this update; false if it may reappear.

SUUpdaterMBS.didDownloadUpdate(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 immediately after succesfull download of the specified update.

item: The appcast item corresponding to the update that has been downloaded.

Some examples using this event:

SUUpdaterMBS.didExtractUpdate(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 immediately after extracting the specified downloaded update.

item: The appcast item corresponding to the update that has been extracted.

Some examples using this event:

SUUpdaterMBS.didFindValidUpdate(update as SUAppcastItemMBS)

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

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

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

Some examples using this event:

SUUpdaterMBS.didFinishLoadingAppcast(update as SUAppcastMBS)

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 the appcast has been loaded.

Implement this if you want to do some special handling with the appcast once it finishes loading.

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

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

Some examples using this event:

SUUpdaterMBS.failedToDownloadUpdate(item as SUAppcastItemMBS, error as NSErrorMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 16.1 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called after the specified update failed to download.

item: The appcast item corresponding to the update that failed to download.
error: The error generated by the failed download.

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

Some examples using this event:

SUUpdaterMBS.feedParametersForUpdater(sendingProfile as boolean) as dictionary()

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 14.0 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Provide additional parameters for updater.

This method allows you to add extra parameters to the appcast URL, potentially based on whether or not Sparkle will also be sending along the system profile. This method should return an array of dictionaries with keys: "key", "value", "displayKey", "displayValue", the latter two being specifically for display to the user.

SUUpdaterMBS.feedURLStringForUpdater as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 14.4 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Override this to dynamically specify the entire feed URL.

New in version 1.6 of Sparkle.

SUUpdaterMBS.pathToRelaunchForUpdater as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 8.6 ✅ Yes ❌ No ❌ No ❌ No Desktop only
This event is called so you can customize the installation destination of the update.

This event returns the path which is used to relaunch the client after the update is installed. By default, the path of the host bundle.

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.shouldPostponeRelaunchForUpdate(sendingProfile as SUAppcastItemMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 14.0 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Return true to delay the relaunch until you do some processing.

Invoke the update later by calling InvokeUpdate method.
This is not called if the user didn't relaunch on the previous update, in that case it will immediately restart.

SUUpdaterMBS.versionComparatorForUpdater as SUVersionComparisonMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 8.6 ✅ Yes ❌ No ❌ No ❌ No Desktop only
This event allows you to provide a custom version comparator.

If you don't implement this event or return nil, the standard version comparator will be used.

Please makes ure that the SUVersionComparisonMBS object lives longer, so it can be used later. e.g. keep a reference in an app property.

SUUpdaterMBS.willDownloadUpdate(item as SUAppcastItemMBS, request as Variant)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 16.1 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called immediately before downloading the specified update.

item: The appcast item corresponding to the update that is proposed to be downloaded.
request: The mutable URL request that will be used to download the update. (NSMutableURLRequestMBS object)

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

Some examples using this event:

SUUpdaterMBS.willExtractUpdate(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 immediately before extracting the specified downloaded update.

item: The appcast item corresponding to the update that is proposed to be extracted.

Some examples using this event:

SUUpdaterMBS.willInstallUpdate(update as SUAppcastItemMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 8.6 ✅ Yes ❌ No ❌ No ❌ No Desktop only
This event is called immediately before installing the specified update.

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

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

Some examples using this event:

SUUpdaterMBS.willInstallUpdateOnQuit(update as SUAppcastItemMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS MacExtras Plugin 14.4 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Called when an update is scheduled to be silently installed on quit.

New in version 1.6 of Sparkle.
If you like to install now instead, you can call InvokeImmediateInstallation method.

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


The biggest plugin in space...