Files
sparkle-project.github.io/documentation/api-reference/_s_u_updater_delegate_8h_source.html
T
2021-09-03 19:38:30 -07:00

196 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Sparkle: Sparkle/SUUpdaterDelegate.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="icon_32x32@2x.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Sparkle
&#160;<span id="projectnumber">2.0.0</span>
</div>
<div id="projectbrief">A software update framework for macOS</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_3429d7ca3cc00bc309a2ec9474a0a508.html">Sparkle</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">SUUpdaterDelegate.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// SUUpdaterDelegate.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Sparkle</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// Created by Mayur Pawashe on 3/12/16.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// Copyright © 2016 Sparkle Project. All rights reserved.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#if __has_feature(modules)</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#if __has_warning(&quot;-Watimport-in-framework-header&quot;</span>)</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#pragma clang diagnostic ignored &quot;-Watimport-in-framework-header&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;@<span class="keyword">import</span> Foundation;</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#import &lt;Foundation/Foundation.h&gt;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#import &lt;Sparkle/SUExport.h&gt;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">@protocol </span><a class="code" href="protocol_s_u_version_comparison-p.html">SUVersionComparison</a>, <a class="code" href="protocol_s_u_version_display-p.html">SUVersionDisplay</a>;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">@class</span> SUUpdater, <a class="code" href="interface_s_u_appcast.html">SUAppcast</a>, <a class="code" href="interface_s_u_appcast_item.html">SUAppcastItem</a>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;NS_ASSUME_NONNULL_BEGIN</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">// -----------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment">// SUUpdater Notifications for events that might be interesting to more than just the delegate</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment">// The updater will be the notification object</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">// -----------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;SU_EXPORT <span class="keyword">extern</span> NSString *<span class="keyword">const</span> SUUpdaterDidFinishLoadingAppCastNotification;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;SU_EXPORT <span class="keyword">extern</span> NSString *<span class="keyword">const</span> SUUpdaterDidFindValidUpdateNotification;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;SU_EXPORT <span class="keyword">extern</span> NSString *<span class="keyword">const</span> SUUpdaterDidNotFindUpdateNotification;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;SU_EXPORT <span class="keyword">extern</span> NSString *<span class="keyword">const</span> SUUpdaterWillRestartNotification;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#define SUUpdaterWillRelaunchApplicationNotification SUUpdaterWillRestartNotification;</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#define SUUpdaterWillInstallUpdateNotification SUUpdaterWillRestartNotification;</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment">// Key for the SUAppcastItem object in the SUUpdaterDidFindValidUpdateNotification userInfo</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;SU_EXPORT <span class="keyword">extern</span> NSString *<span class="keyword">const</span> SUUpdaterAppcastItemNotificationKey;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment">// Key for the SUAppcast object in the SUUpdaterDidFinishLoadingAppCastNotification userInfo</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;SU_EXPORT <span class="keyword">extern</span> NSString *<span class="keyword">const</span> SUUpdaterAppcastNotificationKey;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment">// -----------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment">// SUUpdater Delegate:</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment">// -----------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;__deprecated_msg(<span class="stringliteral">&quot;Deprecated in Sparkle 2. See SPUUpdaterDelegate instead&quot;</span>)</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="keyword">@protocol </span>SUUpdaterDelegate &lt;NSObject&gt;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="keyword">@optional</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;- (BOOL)updaterMayCheckForUpdates:(SUUpdater *)updater;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;- (NSArray&lt;NSDictionary&lt;NSString *, NSString *&gt; *&gt; *)feedParametersForUpdater:(SUUpdater *)updater sendingSystemProfile:(BOOL)sendingProfile;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;- (nullable NSString *)feedURLStringForUpdater:(SUUpdater *)updater;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;- (BOOL)updaterShouldPromptForPermissionToCheckForUpdates:(SUUpdater *)updater;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;- (void)updater:(SUUpdater *)updater didFinishLoadingAppcast:(<a class="code" href="interface_s_u_appcast.html">SUAppcast</a> *)appcast;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;- (nullable <a class="code" href="interface_s_u_appcast_item.html">SUAppcastItem</a> *)bestValidUpdateInAppcast:(<a class="code" href="interface_s_u_appcast.html">SUAppcast</a> *)appcast forUpdater:(SUUpdater *)updater;</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;- (void)updater:(SUUpdater *)updater didFindValidUpdate:(<a class="code" href="interface_s_u_appcast_item.html">SUAppcastItem</a> *)item;</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; </div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;- (void)updaterDidNotFindUpdate:(SUUpdater *)updater;</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; </div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;- (void)updater:(SUUpdater *)updater willDownloadUpdate:(<a class="code" href="interface_s_u_appcast_item.html">SUAppcastItem</a> *)item withRequest:(NSMutableURLRequest *)request;</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;- (void)updater:(SUUpdater *)updater didDownloadUpdate:(<a class="code" href="interface_s_u_appcast_item.html">SUAppcastItem</a> *)item;</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; </div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;- (void)updater:(SUUpdater *)updater failedToDownloadUpdate:(<a class="code" href="interface_s_u_appcast_item.html">SUAppcastItem</a> *)item error:(NSError *)error;</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; </div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;- (void)userDidCancelDownload:(SUUpdater *)updater;</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; </div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;- (void)updater:(SUUpdater *)updater willExtractUpdate:(<a class="code" href="interface_s_u_appcast_item.html">SUAppcastItem</a> *)item;</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; </div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;- (void)updater:(SUUpdater *)updater didExtractUpdate:(<a class="code" href="interface_s_u_appcast_item.html">SUAppcastItem</a> *)item;</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; </div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160;- (void)updater:(SUUpdater *)updater willInstallUpdate:(<a class="code" href="interface_s_u_appcast_item.html">SUAppcastItem</a> *)item;</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; </div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160;- (void)updater:(SUUpdater *)updater userDidSkipThisVersion:(<a class="code" href="interface_s_u_appcast_item.html">SUAppcastItem</a> *)item;</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; </div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160;- (BOOL)updater:(SUUpdater *)updater shouldPostponeRelaunchForUpdate:(<a class="code" href="interface_s_u_appcast_item.html">SUAppcastItem</a> *)item untilInvoking:(NSInvocation *)invocation;</div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160; </div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160;- (BOOL)updater:(SUUpdater *)updater shouldPostponeRelaunchForUpdate:(<a class="code" href="interface_s_u_appcast_item.html">SUAppcastItem</a> *)item;</div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; </div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160;- (BOOL)updaterShouldRelaunchApplication:(SUUpdater *)updater;</div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160; </div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160;- (void)updaterWillRelaunchApplication:(SUUpdater *)updater;</div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160; </div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160;- (void)updaterDidRelaunchApplication:(SUUpdater *)updater;</div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160; </div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160;- (nullable id&lt;<a class="code" href="protocol_s_u_version_comparison-p.html">SUVersionComparison</a>&gt;)versionComparatorForUpdater:(SUUpdater *)updater;</div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160; </div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span>&#160;- (nullable <span class="keywordtype">id</span> &lt;<a class="code" href="protocol_s_u_version_display-p.html">SUVersionDisplay</a>&gt;)versionDisplayerForUpdater:(SUUpdater *)updater;</div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160; </div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>&#160;- (nullable NSString *)pathToRelaunchForUpdater:(SUUpdater *)updater;</div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160; </div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160;- (void)updaterWillShowModalAlert:(SUUpdater *)updater;</div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span>&#160; </div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160;- (void)updaterDidShowModalAlert:(SUUpdater *)updater;</div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>&#160; </div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span>&#160;- (void)updater:(SUUpdater *)updater willInstallUpdateOnQuit:(<a class="code" href="interface_s_u_appcast_item.html">SUAppcastItem</a> *)item immediateInstallationInvocation:(NSInvocation *)invocation;</div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span>&#160; </div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span>&#160;- (void)updater:(SUUpdater *)updater willInstallUpdateOnQuit:(<a class="code" href="interface_s_u_appcast_item.html">SUAppcastItem</a> *)item immediateInstallationBlock:(<span class="keywordtype">void</span> (^)(<span class="keywordtype">void</span>))installationBlock;</div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span>&#160; </div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160;- (void)updater:(SUUpdater *)updater didCancelInstallUpdateOnQuit:(<a class="code" href="interface_s_u_appcast_item.html">SUAppcastItem</a> *)item __deprecated;</div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span>&#160; </div>
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span>&#160;- (void)updater:(SUUpdater *)updater didAbortWithError:(NSError *)error;</div>
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span>&#160; </div>
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span>&#160;<span class="keyword">@end</span></div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span>&#160; </div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span>&#160;NS_ASSUME_NONNULL_END</div>
<div class="ttc" id="ainterface_s_u_appcast_html"><div class="ttname"><a href="interface_s_u_appcast.html">SUAppcast</a></div><div class="ttdef"><b>Definition:</b> SUAppcast.h:26</div></div>
<div class="ttc" id="ainterface_s_u_appcast_item_html"><div class="ttname"><a href="interface_s_u_appcast_item.html">SUAppcastItem</a></div><div class="ttdef"><b>Definition:</b> SUAppcastItem.h:36</div></div>
<div class="ttc" id="aprotocol_s_u_version_comparison-p_html"><div class="ttname"><a href="protocol_s_u_version_comparison-p.html">SUVersionComparison-p</a></div><div class="ttdoc">Provides version comparison facilities for Sparkle.</div><div class="ttdef"><b>Definition:</b> SUVersionComparisonProtocol.h:36</div></div>
<div class="ttc" id="aprotocol_s_u_version_display-p_html"><div class="ttname"><a href="protocol_s_u_version_display-p.html">SUVersionDisplay-p</a></div><div class="ttdoc">Applies special display formatting to version numbers.</div><div class="ttdef"><b>Definition:</b> SUVersionDisplayProtocol.h:22</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>