Document that web servers can customize the feed (#104)

This commit is contained in:
Zorg
2021-11-06 02:19:07 -07:00
committed by GitHub
parent 881a7abcae
commit 7b96fb8b8a
+1 -1
View File
@@ -280,7 +280,7 @@ func feedURLString(for updater: SPUUpdater) -> String? {
Sparkle also has `-setFeedURL:` or `feedURL` property on the updater which we do not recommend using due to race conditions and user defaults permanence. If you wish to migrate away from this API, you should set the feed URL to nil using this API to clear out any custom feed you have previously set in the bundle's user defaults, so Sparkle doesn't automatically read it.
Web servers can also potentially customize the feed sent back to the client on a per request basis. The [userAgentString](/documentation/api-reference/Classes/SPUUpdater.html#/c:objc(cs)SPUUpdater(py)userAgentString) and [httpHeaders](/documentation/api-reference/Classes/SPUUpdater.html#/c:objc(cs)SPUUpdater(py)httpHeaders) properties from the client may be useful for this.
Web servers can also potentially customize the feed sent back to the client on a per request basis. The [userAgentString](/documentation/api-reference/Classes/SPUUpdater.html#/c:objc(cs)SPUUpdater(py)userAgentString), [httpHeaders](/documentation/api-reference/Classes/SPUUpdater.html#/c:objc(cs)SPUUpdater(py)httpHeaders), and [-[SPUUpdaterDelegate feedParametersForUpdater:sendingSystemProfile:]](/documentation/api-reference/Protocols/SPUUpdaterDelegate.html#/c:objc(pl)SPUUpdaterDelegate(im)feedParametersForUpdater:sendingSystemProfile:) methods from the client may be useful for this.
## Upgrading to newer features