Platforms to show: All Mac Windows Linux Cross-Platform

Back to WinSparkleMBS class.

WinSparkleMBS.CanShutdown as Boolean   New in 26.3

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS Win Plugin 26.3 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Whether your app can shutdown now.

This call may come on a non GUI thread!

Return true to allow shutdown of the application.
Return false when you have something like an open edited document.

If you implemented the event, the property is not used.

See also:

WinSparkleMBS.DidFindUpdate

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Called when an update was found.

Some examples using this event:

WinSparkleMBS.DidNotFindUpdate

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Called when an update was not found.

Some examples using this event:

WinSparkleMBS.Error

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Called when an update failed due to an error.

WinSparkleMBS.ShutdownRequest

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The event to ask the host to shut down immediately after launching the installer.

Its implementation should gracefully terminate the application.

Some examples using this event:

WinSparkleMBS.UpdateCancelled

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS Win Plugin 17.0 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The update was cancelled.

Some examples using this event:

WinSparkleMBS.UpdateDismissed

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS Win Plugin 25.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The event to be called when the user dismisses (closes) update dialog, including when there were no updates or an error occured.

See UpdateCancelled for a subtly different event that may be more appropriate.

This is useful in combination with CheckUpdateWithUI or similar as it allows you to perform some action when the update dialog is closed.

WinSparkleMBS.UpdatePostponed

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS Win Plugin 25.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The update was postponed.

Set event to be called when the user postpones an update by pressing 'remind me later' button.

This is useful in combination with CheckUpdateWithUI or similar as it allows you to perform some action when the download is postponed.

WinSparkleMBS.UpdateSkipped

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Sparkle MBS Win Plugin 25.2 ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The update was skipped.

The event to be called when the user skips an update.

This is useful in combination with CheckUpdateWithUI or similar as it allows you to perform some action when the update is skipped.

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


The biggest plugin in space...