SparkleProject/sparkle-project.github.io
1
0
Fork 0
mirror of https://github.com/sparkle-project/sparkle-project.github.io.git synced 2025-11-01 15:35:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
367f5210ccd407db5ce2491db8103f5da9ca55a3
sparkle-project.github.io/documentation/api-reference/interface_s_u_appcast_item.html
T
Mayur Pawashe d572ae98bb Integrate API Reference pages (#83)
2021-09-03 19:38:30 -07:00

248 lines
18 KiB
HTML
Raw Blame History

<!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: SUAppcastItem Class Reference</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Instance Methods</a> &#124;
<a href="#pub-static-methods">Class Methods</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="interface_s_u_appcast_item-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SUAppcastItem Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for SUAppcastItem:</div>
<div class="dyncontent">
<div class="center">
<img src="interface_s_u_appcast_item.png" alt=""/>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Instance Methods</h2></td></tr>
<tr class="memitem:ac29ff1aeea5018fc134cb2c111b8a505"><td class="memItemLeft" align="right" valign="top"><a id="ac29ff1aeea5018fc134cb2c111b8a505"></a>
(instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <b>NS_UNAVAILABLE</b></td></tr>
<tr class="separator:ac29ff1aeea5018fc134cb2c111b8a505"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85612a527b05f31eae9297f8f69b561a"><td class="memItemLeft" align="right" valign="top"><a id="a85612a527b05f31eae9297f8f69b561a"></a>
(nullable instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <b>initWithDictionary:</b></td></tr>
<tr class="separator:a85612a527b05f31eae9297f8f69b561a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0781113d7ba479a81dd8bc7f97df06ef"><td class="memItemLeft" align="right" valign="top"><a id="a0781113d7ba479a81dd8bc7f97df06ef"></a>
(nullable instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <b>initWithDictionary:failureReason:</b></td></tr>
<tr class="separator:a0781113d7ba479a81dd8bc7f97df06ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b7505c94b82e302f4a22cf4f71ed2ab"><td class="memItemLeft" align="right" valign="top"><a id="a9b7505c94b82e302f4a22cf4f71ed2ab"></a>
(nullable instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <b>initWithDictionary:relativeToURL:failureReason:</b></td></tr>
<tr class="separator:a9b7505c94b82e302f4a22cf4f71ed2ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0687fe14843337befdfa749e77de60a0"><td class="memItemLeft" align="right" valign="top">(nullable instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_s_u_appcast_item.html#a0687fe14843337befdfa749e77de60a0">initWithDictionary:relativeToURL:stateResolver:failureReason:</a></td></tr>
<tr class="memdesc:a0687fe14843337befdfa749e77de60a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes with data from a dictionary provided by the RSS class and state resolver. <a href="interface_s_u_appcast_item.html#a0687fe14843337befdfa749e77de60a0">More...</a><br /></td></tr>
<tr class="separator:a0687fe14843337befdfa749e77de60a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Class Methods</h2></td></tr>
<tr class="memitem:a9a6214957f4dc478c5c9508c3c1585d3"><td class="memItemLeft" align="right" valign="top"><a id="a9a6214957f4dc478c5c9508c3c1585d3"></a>
(instancetype)&#160;</td><td class="memItemRight" valign="bottom">+ <b>emptyAppcastItem</b></td></tr>
<tr class="separator:a9a6214957f4dc478c5c9508c3c1585d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a57a70db3bf6264c830ea533924d62295"><td class="memItemLeft" align="right" valign="top"><a id="a57a70db3bf6264c830ea533924d62295"></a>
NSString *&#160;</td><td class="memItemRight" valign="bottom"><b>title</b></td></tr>
<tr class="separator:a57a70db3bf6264c830ea533924d62295"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f402680a0c2486aa4c39c480b0ea318"><td class="memItemLeft" align="right" valign="top"><a id="a4f402680a0c2486aa4c39c480b0ea318"></a>
NSString *&#160;</td><td class="memItemRight" valign="bottom"><b>dateString</b></td></tr>
<tr class="separator:a4f402680a0c2486aa4c39c480b0ea318"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1ef64056a5ddad487eeba6d34385a52"><td class="memItemLeft" align="right" valign="top"><a id="af1ef64056a5ddad487eeba6d34385a52"></a>
NSDate *&#160;</td><td class="memItemRight" valign="bottom"><b>date</b></td></tr>
<tr class="separator:af1ef64056a5ddad487eeba6d34385a52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4205e21dbecf179366446291c307faec"><td class="memItemLeft" align="right" valign="top"><a id="a4205e21dbecf179366446291c307faec"></a>
NSString *&#160;</td><td class="memItemRight" valign="bottom"><b>itemDescription</b></td></tr>
<tr class="separator:a4205e21dbecf179366446291c307faec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca46754ee3fb78dbf1c18d8302fc7509"><td class="memItemLeft" align="right" valign="top"><a id="aca46754ee3fb78dbf1c18d8302fc7509"></a>
NSURL *&#160;</td><td class="memItemRight" valign="bottom"><b>releaseNotesURL</b></td></tr>
<tr class="separator:aca46754ee3fb78dbf1c18d8302fc7509"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4a76595fea06f7a7a7fd6c39a1b4a35"><td class="memItemLeft" align="right" valign="top"><a id="ac4a76595fea06f7a7a7fd6c39a1b4a35"></a>
<a class="el" href="interface_s_u_signatures.html">SUSignatures</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>signatures</b></td></tr>
<tr class="separator:ac4a76595fea06f7a7a7fd6c39a1b4a35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a965995874ac0f51baf8f152c6c3e2438"><td class="memItemLeft" align="right" valign="top"><a id="a965995874ac0f51baf8f152c6c3e2438"></a>
NSString *&#160;</td><td class="memItemRight" valign="bottom"><b>minimumSystemVersion</b></td></tr>
<tr class="separator:a965995874ac0f51baf8f152c6c3e2438"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af52151257096b6c18fb0f2374c087f63"><td class="memItemLeft" align="right" valign="top"><a id="af52151257096b6c18fb0f2374c087f63"></a>
NSString *&#160;</td><td class="memItemRight" valign="bottom"><b>maximumSystemVersion</b></td></tr>
<tr class="separator:af52151257096b6c18fb0f2374c087f63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ac8cee97831f1d48dbfdfdd8df2a32e"><td class="memItemLeft" align="right" valign="top"><a id="a8ac8cee97831f1d48dbfdfdd8df2a32e"></a>
NSURL *&#160;</td><td class="memItemRight" valign="bottom"><b>fileURL</b></td></tr>
<tr class="separator:a8ac8cee97831f1d48dbfdfdd8df2a32e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac997b1d2924a05763fcec61ab595f19e"><td class="memItemLeft" align="right" valign="top"><a id="ac997b1d2924a05763fcec61ab595f19e"></a>
uint64_t&#160;</td><td class="memItemRight" valign="bottom"><b>contentLength</b></td></tr>
<tr class="separator:ac997b1d2924a05763fcec61ab595f19e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2c43c327be6e0496448ab04f9eb10f9"><td class="memItemLeft" align="right" valign="top"><a id="af2c43c327be6e0496448ab04f9eb10f9"></a>
NSString *&#160;</td><td class="memItemRight" valign="bottom"><b>versionString</b></td></tr>
<tr class="separator:af2c43c327be6e0496448ab04f9eb10f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a262f74d26b4b31c9c7c276bc96577413"><td class="memItemLeft" align="right" valign="top"><a id="a262f74d26b4b31c9c7c276bc96577413"></a>
NSString *&#160;</td><td class="memItemRight" valign="bottom"><b>osString</b></td></tr>
<tr class="separator:a262f74d26b4b31c9c7c276bc96577413"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5121dd361284c18653a7d526d0a6128c"><td class="memItemLeft" align="right" valign="top"><a id="a5121dd361284c18653a7d526d0a6128c"></a>
NSString *&#160;</td><td class="memItemRight" valign="bottom"><b>displayVersionString</b></td></tr>
<tr class="separator:a5121dd361284c18653a7d526d0a6128c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7664a43c833fb81d12adbf1b56a7f1a7"><td class="memItemLeft" align="right" valign="top"><a id="a7664a43c833fb81d12adbf1b56a7f1a7"></a>
NSDictionary *&#160;</td><td class="memItemRight" valign="bottom"><b>deltaUpdates</b></td></tr>
<tr class="separator:a7664a43c833fb81d12adbf1b56a7f1a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac23524c414cda1fa2b48981ff080a52b"><td class="memItemLeft" align="right" valign="top"><a id="ac23524c414cda1fa2b48981ff080a52b"></a>
NSURL *&#160;</td><td class="memItemRight" valign="bottom"><b>infoURL</b></td></tr>
<tr class="separator:ac23524c414cda1fa2b48981ff080a52b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20b56550820a56278427786a88335d3a"><td class="memItemLeft" align="right" valign="top"><a id="a20b56550820a56278427786a88335d3a"></a>
NSNumber *&#160;</td><td class="memItemRight" valign="bottom"><b>phasedRolloutInterval</b></td></tr>
<tr class="separator:a20b56550820a56278427786a88335d3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08c09007e6d262db9ba991ada22eed86"><td class="memItemLeft" align="right" valign="top"><a id="a08c09007e6d262db9ba991ada22eed86"></a>
NSString *&#160;</td><td class="memItemRight" valign="bottom"><b>installationType</b></td></tr>
<tr class="separator:a08c09007e6d262db9ba991ada22eed86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbca24b3be7a1a055ad9ab589c493c40"><td class="memItemLeft" align="right" valign="top"><a id="acbca24b3be7a1a055ad9ab589c493c40"></a>
NSString *&#160;</td><td class="memItemRight" valign="bottom"><b>minimumAutoupdateVersion</b></td></tr>
<tr class="separator:acbca24b3be7a1a055ad9ab589c493c40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab328058c56a7bd5662af23c2f5ebc11e"><td class="memItemLeft" align="right" valign="top"><a id="ab328058c56a7bd5662af23c2f5ebc11e"></a>
NSString *&#160;</td><td class="memItemRight" valign="bottom"><b>channel</b></td></tr>
<tr class="separator:ab328058c56a7bd5662af23c2f5ebc11e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd12f32aeb8c081bc7206c48d9851b2b"><td class="memItemLeft" align="right" valign="top"><a id="afd12f32aeb8c081bc7206c48d9851b2b"></a>
BOOL&#160;</td><td class="memItemRight" valign="bottom"><b>deltaUpdate</b></td></tr>
<tr class="separator:afd12f32aeb8c081bc7206c48d9851b2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4b3b23d9cd04eae155f26fee966c208"><td class="memItemLeft" align="right" valign="top"><a id="aa4b3b23d9cd04eae155f26fee966c208"></a>
BOOL&#160;</td><td class="memItemRight" valign="bottom"><b>criticalUpdate</b></td></tr>
<tr class="separator:aa4b3b23d9cd04eae155f26fee966c208"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a434037d06f1ab3ed12ec53b4110f641d"><td class="memItemLeft" align="right" valign="top"><a id="a434037d06f1ab3ed12ec53b4110f641d"></a>
BOOL&#160;</td><td class="memItemRight" valign="bottom"><b>majorUpgrade</b></td></tr>
<tr class="separator:a434037d06f1ab3ed12ec53b4110f641d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a132b18a33f57144447d435b8d90de98e"><td class="memItemLeft" align="right" valign="top"><a id="a132b18a33f57144447d435b8d90de98e"></a>
BOOL&#160;</td><td class="memItemRight" valign="bottom"><b>macOsUpdate</b></td></tr>
<tr class="separator:a132b18a33f57144447d435b8d90de98e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca7fa9d4055107bf55c75b0541c1c2ec"><td class="memItemLeft" align="right" valign="top"><a id="aca7fa9d4055107bf55c75b0541c1c2ec"></a>
BOOL&#160;</td><td class="memItemRight" valign="bottom"><b>informationOnlyUpdate</b></td></tr>
<tr class="separator:aca7fa9d4055107bf55c75b0541c1c2ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3bc6d6af0f5d139dbc9f1206b02483e"><td class="memItemLeft" align="right" valign="top"><a id="ae3bc6d6af0f5d139dbc9f1206b02483e"></a>
BOOL&#160;</td><td class="memItemRight" valign="bottom"><b>minimumOperatingSystemVersionIsOK</b></td></tr>
<tr class="separator:ae3bc6d6af0f5d139dbc9f1206b02483e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accc58ad0308b29e38b6d1b529c961f32"><td class="memItemLeft" align="right" valign="top"><a id="accc58ad0308b29e38b6d1b529c961f32"></a>
BOOL&#160;</td><td class="memItemRight" valign="bottom"><b>maximumOperatingSystemVersionIsOK</b></td></tr>
<tr class="separator:accc58ad0308b29e38b6d1b529c961f32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad09140ff8574fabb1ce03ed43fb4c2ce"><td class="memItemLeft" align="right" valign="top"><a id="ad09140ff8574fabb1ce03ed43fb4c2ce"></a>
NSDictionary *&#160;</td><td class="memItemRight" valign="bottom"><b>propertiesDictionary</b></td></tr>
<tr class="separator:ad09140ff8574fabb1ce03ed43fb4c2ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Method Documentation</h2>
<a id="a0687fe14843337befdfa749e77de60a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0687fe14843337befdfa749e77de60a0">&#9670;&nbsp;</a></span>initWithDictionary:relativeToURL:stateResolver:failureReason:</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (nullable instancetype) initWithDictionary: </td>
<td></td>
<td class="paramtype">(NSDictionary *)&#160;</td>
<td class="paramname"><em>dict</em></td>
</tr>
<tr>
<td class="paramkey">relativeToURL:</td>
<td></td>
<td class="paramtype">(NSURL *_Nullable)&#160;</td>
<td class="paramname"><em>appcastURL</em></td>
</tr>
<tr>
<td class="paramkey">stateResolver:</td>
<td></td>
<td class="paramtype">(<a class="el" href="interface_s_p_u_appcast_item_state_resolver.html">SPUAppcastItemStateResolver</a> *)&#160;</td>
<td class="paramname"><em>stateResolver</em></td>
</tr>
<tr>
<td class="paramkey">failureReason:</td>
<td></td>
<td class="paramtype">(NSString *_Nullable __autoreleasing *_Nullable)&#160;</td>
<td class="paramname"><em>error</em>&#160;</td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes with data from a dictionary provided by the RSS class and state resolver. </p>
<p>This initializer method is intended to be marked "private" and discouraged from public usage. This method is available however. Talk to us to describe your use case and if you need to construct appcast items yourself. </p>
<p>Provided by category <a class="el" href="category_s_u_appcast_item_07_private_08.html#a0687fe14843337befdfa749e77de60a0">SUAppcastItem(Private)</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Sparkle/<a class="el" href="_s_u_appcast_item_8h_source.html">SUAppcastItem.h</a></li>
<li>Sparkle/SUAppcastItem.m</li>
</ul>
</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>
Reference in New Issue View Git Blame Copy Permalink