SPUUpdaterDelegate

Returns whether to allow Sparkle to check for updates.

For example, this may be used to prevent Sparkle from interrupting a setup assistant. Alternatively, you may want to consider starting the updater after eg: the setup assistant finishes.

Note in Swift, this method returns Void and is marked with the throws keyword. If this method doesn’t throw an error, the updater may perform an update check. Otherwise if an error is thrown (we recommend using an NSError), then the updater may not perform an update check.

Returns the set of Sparkle channels the updater is allowed to find new updates from.

An appcast item can specify a channel the update is posted to. Without specifying a channel, the appcast item is posted to the default channel. For instance:

<item>
   <sparkle:version>2.0 Beta 1</sparkle:version>
   <sparkle:channel>beta</sparkle:channel>
</item>

This example posts an update to the beta channel, so only updaters that are allowed to use the beta channel can find this update.

If the <sparkle:channel> element is not present, the update item is posted to the default channel and can be found by any updater.

You can pick any name you’d like for the channel. The valid characters for channel names are letters, numbers, dashes, underscores, and periods.

Note to use this feature, all app versions that your users may update from in your feed must use a version of Sparkle that supports this feature. This feature was added in Sparkle 2.

Returns a custom appcast URL used for checking for new updates.

Override this to dynamically specify the feed URL.

Returns additional parameters to append to the appcast URL’s query string.

This is potentially based on whether or not Sparkle will also be sending along the system profile.

Returns whether Sparkle should prompt the user about checking for new updates automatically.

Use this to override the default behavior, which is to prompt for permission to check for updates on second app launch (if SUEnableAutomaticChecks is not specified).

This method is not called if SUEnableAutomaticChecks is defined in Info.plist or if the user has responded to a permission prompt before.

Returns an allowed list of system profile keys to be appended to the appcast URL’s query string.

By default all keys will be included. This method allows overriding which keys should only be allowed.

Called after Sparkle has downloaded the appcast from the remote server.

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

Called when a new valid update is found by the update driver.

Called when a valid new update is not found.

There are various reasons a new update is unavailable and can’t be installed.

The userInfo dictionary on the error is populated with three keys:

• SPULatestAppcastItemFoundKey: if available, this may provide the latest SUAppcastItem that was found. This will be nil if it’s unavailable.
• SPUNoUpdateFoundReasonKey: This will provide the SPUNoUpdateFoundReason. For example the reason could be because the latest version in the feed requires a newer OS version or could be because the user is already on the latest version.

• SPUNoUpdateFoundUserInitiatedKey: A boolean that indicates if a new update was not found when the user intitiated an update check manually.

Called when a valid new update is not found.

If more information is needed on why an update was not found, use -[SPUUpdaterDelegate updaterDidNotFindUpdate:error:] instead.

Returns the item in the appcast corresponding to the update that should be installed.

Please consider using or migrating to other supported features before adopting this method. Specifically:

• If you want to filter out certain tagged updates (like beta updates), consider -[SPUUpdaterDelegate allowedChannelsForUpdater:] instead.
• If you want to treat certain updates as informational-only, consider supplying <sparkle:informationalUpdate> with a set of affected versions users are updating from.

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.

Do not base your logic by filtering out items with a minimum or maximum OS version or minimum autoupdate version because Sparkle already has logic for determining whether or not those items should be filtered out.

Also do not return a non-top level item from the appcast such as a delta item. Delta items will be ignored. Sparkle picks the delta item from your selection if the appropriate one is available.

This method will not be invoked with an appcast that has zero items. Pick the best item from the appcast. If an item is available that has the same version as the application or bundle to update, do not pick an item that is worse than that version.

This method may be called multiple times for different selections and filters. This method should be efficient.

Return +[SUAppcastItem emptyAppcastItem] if no appcast item is valid.

Return nil if you don’t want to be delegated this task and want to let Sparkle handle picking the best valid update.

Returns whether or not the updater should proceed with the new chosen update from the appcast.

By default, the updater will always proceed with the best selected update found in an appcast. Override this to override this behavior.

If you return NO and populate the error, the user is not shown this updateItem nor is the update downloaded or installed.

Note in Swift, this method returns Void and is marked with the throws keyword. If this method doesn’t throw an error, the updater will proceed with the update. Otherwise if an error is thrown (we recommend using an NSError), then the will not proceed with the update.

Called when a user makes a choice to install, dismiss, or skip an update.

If the choice is SPUUserUpdateChoiceDismiss and state.stage is SPUUserUpdateStageDownloaded the downloaded update is kept around until the next time Sparkle reminds the user of the update.

If the choice is SPUUserUpdateChoiceDismiss and state.stage is SPUUserUpdateStageInstalling the update is still set to install on application termination.

If the choice is SPUUserUpdateChoiceSkip the user will not be reminded in the future for this update unless they initiate an update check themselves.

If updateItem.isInformationOnlyUpdate is YES the choice cannot be SPUUserUpdateChoiceInstall.

Returns whether the release notes (if available) should be downloaded after an update is found and shown.

This is specifically for the <releaseNotesLink> element in the appcast item.

Called immediately before downloading the specified update.

Called immediately after successful download of the specified update.

Called after the specified update failed to download.

Called when the user cancels an update while it is being downloaded.

Called immediately before extracting the specified downloaded update.

Called immediately after extracting the specified downloaded update.

Called immediately before installing the specified update.

Returns whether the relaunch should be delayed in order to perform other tasks.

This is not called if the user didn’t relaunch on the previous update, in that case it will immediately restart.

This may also not be called if the application is not going to relaunch after it terminates.

Returns whether the application should be relaunched at all.

Some apps cannot be relaunched under certain circumstances. This method can be used to explicitly prevent a relaunch.

Called immediately before relaunching.

Returns an object that compares version numbers to determine their arithmetic relation to each other.

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.

Note that the standard version comparator may be used during installation for preventing a downgrade, even if you provide a custom comparator here.

Called when a background update will be scheduled after a delay.

Automatic update checks need to be enabled for this to trigger.

Called when no update checks will be scheduled in the future.

This may later change if automatic update checks become enabled.

Returns the decryption password (if any) which is used to extract the update archive DMG.

Return nil if no password should be used.

Called when an update is scheduled to be silently installed on quit after downloading the update automatically.

If the updater is given responsibility, it can later remind the user an update is available if they have not terminated the application for a long time.

Also if the updater is given responsibility and the update item is marked critical, the new update will be presented to the user immediately after.

Even if the immediateInstallHandler is not invoked, the installer will attempt to install the update on termination.

Called after the update driver aborts due to an error.

The update driver runs when checking for updates. This delegate method is called an error occurs during this process.

Some special possible values of error.code are:

• SUNoUpdateError: No new update was found.

• SUInstallationCanceledError: The user canceled installing the update when requested for authorization.

Called after the update driver finishes.

The update driver runs when checking for updates. This delegate method is called when that check is finished.

An update may be scheduled to be installed during the update cycle, or no updates may be found, or an available update may be dismissed or skipped (which is the same as no error).

If the error is nil, no error has occurred.

Some special possible values of error.code are:

• SUNoUpdateError: No new update was found.

• SUInstallationCanceledError: The user canceled installing the update when requested for authorization.

Undocumented

Undocumented