MonobjcMonobjc Documented Class Library
Monobjc.Sparkle Namespace
NamespacesMonobjc.Sparkle
Wrapper of the Sparkle framework.
Declaration Syntax
C#Visual BasicVisual C++
namespace Monobjc.Sparkle
Namespace Monobjc.Sparkle
namespace Monobjc.Sparkle
Types
All TypesClassesInterfacesDelegates
IconTypeDescription
SUAppcast..::..AppcastDidFinishLoadingEventHandler

Original signature is '- (void)appcastDidFinishLoading:(SUAppcast *)appcast'

Available in Sparkle 1.5b6 and later.


SUAppcast..::..AppcastFailedToLoadWithErrorEventHandler

Original signature is '- (void)appcast:(SUAppcast *)appcast failedToLoadWithError:(NSError *)error'

Available in Sparkle 1.5b6 and later.


SUUpdater..::..BestValidUpdateInAppcastForUpdaterEventHandler

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.

Original signature is '- (SUAppcastItem *)bestValidUpdateInAppcast:(SUAppcast *)appcast forUpdater:(SUUpdater *)bundle'

Available in Sparkle 1.5b6 and later.


SUUpdater..::..FeedParametersForUpdaterSendingSystemProfileEventHandler

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.

Original signature is '- (NSArray *)feedParametersForUpdater:(SUUpdater *)updater sendingSystemProfile:(BOOL)sendingProfile'

Available in Sparkle 1.5b6 and later.


ISUAppcastDelegate
ISUUpdaterDelegate
ISUVersionComparison
SUUpdater..::..PathToRelaunchForUpdaterEventHandler

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

Original signature is '- (NSString *)pathToRelaunchForUpdater:(SUUpdater *)updater'

Available in Sparkle 1.5b6 and later.


SUAppcast
SUAppcast..::..SUAppcastDelegateEventDispatcher
SUAppcastItem
SUUpdater
SUUpdater..::..SUUpdaterDelegateEventDispatcher
SUUpdater..::..UpdaterDidFindValidUpdateEventHandler

Sent when a valid update is found by the update driver.

Original signature is '- (void)updater:(SUUpdater *)updater didFindValidUpdate:(SUAppcastItem *)update'

Available in Sparkle 1.5b6 and later.


SUUpdater..::..UpdaterDidFinishLoadingAppcastEventHandler

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

Original signature is '- (void)updater:(SUUpdater *)updater didFinishLoadingAppcast:(SUAppcast *)appcast'

Available in Sparkle 1.5b6 and later.


SUUpdater..::..UpdaterDidNotFindUpdateEventHandler

Sent when a valid update is not found.

Original signature is '- (void)updaterDidNotFindUpdate:(SUUpdater *)update'

Available in Sparkle 1.5b6 and later.


SUUpdater..::..UpdaterShouldPostponeRelaunchForUpdateUntilInvokingEventHandler

Return YES to delay the relaunch until you do some processing; invoke the given NSInvocation to continue.

Original signature is '- (BOOL)updater:(SUUpdater *)updater shouldPostponeRelaunchForUpdate:(SUAppcastItem *)update untilInvoking:(NSInvocation *)invocation'

Available in Sparkle 1.5b6 and later.


SUUpdater..::..UpdaterShouldPromptForPermissionToCheckForUpdatesEventHandler

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

Original signature is '- (BOOL)updaterShouldPromptForPermissionToCheckForUpdates:(SUUpdater *)bundle'

Available in Sparkle 1.5b6 and later.


SUUpdater..::..UpdaterWillInstallUpdateEventHandler

Sent immediately before installing the specified update.

Original signature is '- (void)updater:(SUUpdater *)updater willInstallUpdate:(SUAppcastItem *)update'

Available in Sparkle 1.5b6 and later.


SUUpdater..::..UpdaterWillRelaunchApplicationEventHandler

Called immediately before relaunching.

Original signature is '- (void)updaterWillRelaunchApplication:(SUUpdater *)updater'

Available in Sparkle 1.5b6 and later.


SUUpdater..::..VersionComparatorForUpdaterEventHandler

This method allows you to provide a custom version comparator.

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

Original signature is '- (id <SUVersionComparison>)versionComparatorForUpdater:(SUUpdater *)updater'

Available in Sparkle 1.5b6 and later.