Xojo Conferences
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

SUUpdaterMBS.bestValidUpdateInAppcast(appcast as SUAppcastMBS) as SUAppcastItemMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 8.6 Yes No No No No
Function: The event called to decide which appcast item is the best to use.
Notes:
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!

Feedback, Comments & Corrections

SUUpdaterMBS.didAbortWithError(error as NSErrorMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 16.1 Yes No No No No
Function: Called after an update is aborted due to an error.
Notes:
error: The error that caused the abort

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

Feedback, Comments & Corrections

SUUpdaterMBS.didCancelInstallUpdateOnQuit(update as SUAppcastItemMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 14.4 Yes No No No No
Function: Called when an update is scheduled to be silently installed on quit and cancelled.
Notes: New in version 1.6 of Sparkle.

Feedback, Comments & Corrections

SUUpdaterMBS.didFindValidUpdate(update as SUAppcastItemMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 8.6 Yes No No No No
Function: This event is called when a valid update is found by the update driver.
Notes:
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.

Feedback, Comments & Corrections

SUUpdaterMBS.didFinishLoadingAppcast(update as SUAppcastMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 8.6 Yes No No No No
Function: The event called when the appcast has been loaded.
Notes:
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.

Feedback, Comments & Corrections

SUUpdaterMBS.failedToDownloadUpdate(item as SUAppcastItemMBS, error as NSErrorMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 16.1 Yes No No No No
Function: Called after the specified update failed to download.
Notes:
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.

Feedback, Comments & Corrections

SUUpdaterMBS.feedParametersForUpdater(sendingProfile as boolean) as dictionary()
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 14.0 Yes No No No No
Function: Provide additional parameters for updater.
Notes: 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.

Feedback, Comments & Corrections

SUUpdaterMBS.feedURLStringForUpdater as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 14.4 Yes No No No No
Function: Override this to dynamically specify the entire feed URL.
Notes: New in version 1.6 of Sparkle.

Feedback, Comments & Corrections

SUUpdaterMBS.pathToRelaunchForUpdater as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 8.6 Yes No No No No
Function: This event is called so you can customize the installation destination of the update.
Notes:
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!

Feedback, Comments & Corrections

SUUpdaterMBS.shouldPostponeRelaunchForUpdate(sendingProfile as SUAppcastItemMBS) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 14.0 Yes No No No No
Function: Return true to delay the relaunch until you do some processing.
Notes:
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.

Feedback, Comments & Corrections

SUUpdaterMBS.updaterDidNotFindUpdate
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 8.6 Yes No No No No
Function: The event called when a valid update is not found.
Notes: Plugin version 8.7 makes sure this method is executed on the main thread.

Feedback, Comments & Corrections

SUUpdaterMBS.updaterDidShowModalAlert
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 14.4 Yes No No No No
Function: 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.
Notes: New in version 1.6 of Sparkle.

Feedback, Comments & Corrections

SUUpdaterMBS.updaterMayCheckForUpdates as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 14.4 Yes No No No No
Function: Use this to keep Sparkle from popping up e.g. while your setup assistant is showing.
Notes: New in version 1.6 of Sparkle.

Feedback, Comments & Corrections

SUUpdaterMBS.updaterShouldPromptForPermissionToCheckForUpdates as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 8.6 Yes No No No No
Function: The event to decide whether the updater should prompt for permission to check for updates.
Notes:
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!

Feedback, Comments & Corrections

SUUpdaterMBS.updaterShouldRelaunchApplication as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 14.4 Yes No No No No
Function: Whether app should be relaunched.
Notes:
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.

Feedback, Comments & Corrections

SUUpdaterMBS.updaterWillRelaunchApplication
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 8.6 Yes No No No No
Function: The event called immediately before relaunching.
Notes:
Plugin version 8.7 makes sure this method is executed on the main thread.

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

Feedback, Comments & Corrections

SUUpdaterMBS.updaterWillShowModalAlert
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 14.4 Yes No No No No
Function: 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.
Notes: New in version 1.6 of Sparkle.

Feedback, Comments & Corrections

SUUpdaterMBS.userDidCancelDownload
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 16.1 Yes No No No No
Function: Called when the user clicks the cancel button while and update is being downloaded.
Notes: This is a newer event which is only called in 64-bit version.

Feedback, Comments & Corrections

SUUpdaterMBS.versionComparatorForUpdater as SUVersionComparisonMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 8.6 Yes No No No No
Function: This event allows you to provide a custom version comparator.
Notes:
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.

Feedback, Comments & Corrections

SUUpdaterMBS.willDownloadUpdate(item as SUAppcastItemMBS, request as Variant)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 16.1 Yes No No No No
Function: Called immediately before downloading the specified update.
Notes:
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.

Feedback, Comments & Corrections

SUUpdaterMBS.willInstallUpdate(update as SUAppcastItemMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 8.6 Yes No No No No
Function: This event is called immediately before installing the specified update.
Notes:
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.

Feedback, Comments & Corrections

SUUpdaterMBS.willInstallUpdateOnQuit(update as SUAppcastItemMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
event Sparkle MBS MacExtras Plugin 14.4 Yes No No No No
Function: Called when an update is scheduled to be silently installed on quit.
Notes:
New in version 1.6 of Sparkle.
If you like to install now instead, you can call InvokeImmediateInstallation method.

Feedback, Comments & Corrections

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




Links
MBS Xojo PDF Plugins