mirror of
https://github.com/sparkle-project/sparkle-project.github.io.git
synced 2025-11-01 15:35:08 +00:00
Sparkle-Bot
430 lines
24 KiB
HTML
430 lines
24 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>Enumerations Reference</title>
|
|
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
|
|
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
|
|
<meta charset='utf-8'>
|
|
<meta name="viewport" content="width=device-width, viewport-fit=cover, initial-scale=1.0" />
|
|
<script src="js/jquery.min.js" defer></script>
|
|
<script src="js/jazzy.js" defer></script>
|
|
|
|
</head>
|
|
<body>
|
|
<a name="//apple_ref/objc/Section/Enumerations" class="dashAnchor"></a>
|
|
<a title="Enumerations Reference"></a>
|
|
<header>
|
|
<div class="content-wrapper">
|
|
<p>
|
|
<a href="index.html">Sparkle 2.7.0 Docs</a>
|
|
<span class="no-mobile"> (59% documented)</span>
|
|
</p>
|
|
|
|
|
|
</div>
|
|
</header>
|
|
<div id="breadcrumbs-container">
|
|
<div class="content-wrapper">
|
|
<p id="breadcrumbs">
|
|
<span class="no-mobile">
|
|
<a href="index.html">Sparkle</a>
|
|
<img id="carat" src="img/carat.png" alt=""/>
|
|
Enumerations Reference
|
|
</span>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div class="wrapper">
|
|
<div class="article-wrapper">
|
|
<article class="main-content">
|
|
<section>
|
|
<section class="section">
|
|
<h1>Enumerations</h1>
|
|
<p>The following enumerations are available globally.</p>
|
|
|
|
</section>
|
|
<section class="section task-group-section">
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/c:@E@SPUUpdateCheck"></a>
|
|
<a name="//apple_ref/objc/Enum/SPUUpdateCheck" class="dashAnchor"></a>
|
|
<a class="token" href="#/c:@E@SPUUpdateCheck">SPUUpdateCheck</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Describes the type of update check being performed.</p>
|
|
|
|
<p>Each update check corresponds to an update check method on <code><a href="Classes/SPUUpdater.html">SPUUpdater</a></code>.</p>
|
|
|
|
<a href="Enums/SPUUpdateCheck.html" class="slightly-smaller">See more</a>
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Objective-C</p>
|
|
<pre class="highlight objective_c"><code><span class="k">enum</span> <span class="n">SPUUpdateCheck</span> <span class="o">:</span> <span class="n">NSInteger</span> <span class="p">{}</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/c:@E@SPUUserUpdateChoice"></a>
|
|
<a name="//apple_ref/objc/Enum/SPUUserUpdateChoice" class="dashAnchor"></a>
|
|
<a class="token" href="#/c:@E@SPUUserUpdateChoice">SPUUserUpdateChoice</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>A choice made by the user when prompted with a new update.</p>
|
|
|
|
<a href="Enums/SPUUserUpdateChoice.html" class="slightly-smaller">See more</a>
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Objective-C</p>
|
|
<pre class="highlight objective_c"><code><span class="k">enum</span> <span class="n">SPUUserUpdateChoice</span> <span class="o">:</span> <span class="n">NSInteger</span> <span class="p">{}</span></code></pre>
|
|
|
|
</div>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">SPUUserUpdateChoice</span> <span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="kd">@unchecked</span> <span class="kt">Sendable</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/c:@E@SPUUserUpdateStage"></a>
|
|
<a name="//apple_ref/objc/Enum/SPUUserUpdateStage" class="dashAnchor"></a>
|
|
<a class="token" href="#/c:@E@SPUUserUpdateStage">SPUUserUpdateStage</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Describes the current stage an update is undergoing.</p>
|
|
|
|
<a href="Enums/SPUUserUpdateStage.html" class="slightly-smaller">See more</a>
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Objective-C</p>
|
|
<pre class="highlight objective_c"><code><span class="k">enum</span> <span class="n">SPUUserUpdateStage</span> <span class="o">:</span> <span class="n">NSInteger</span> <span class="p">{}</span></code></pre>
|
|
|
|
</div>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">SPUUserUpdateStage</span> <span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="kd">@unchecked</span> <span class="kt">Sendable</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/c:@E@SUError"></a>
|
|
<a name="//apple_ref/objc/Enum/SUError" class="dashAnchor"></a>
|
|
<a class="token" href="#/c:@E@SUError">SUError</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Undocumented</p>
|
|
|
|
<a href="Enums/SUError.html" class="slightly-smaller">See more</a>
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Objective-C</p>
|
|
<pre class="highlight objective_c"><code><span class="n">NS_ENUM</span><span class="p">(</span><span class="n">OSStatus</span><span class="p">,</span> <span class="n">SUError</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="c1">// Configuration phase errors</span>
|
|
<span class="n">SUNoPublicDSAFoundError</span> <span class="o">=</span> <span class="mo">0001</span><span class="p">,</span>
|
|
<span class="n">SUInsufficientSigningError</span> <span class="o">=</span> <span class="mo">0002</span><span class="p">,</span>
|
|
<span class="n">SUInsecureFeedURLError</span> <span class="o">=</span> <span class="mo">0003</span><span class="p">,</span>
|
|
<span class="n">SUInvalidFeedURLError</span> <span class="o">=</span> <span class="mo">0004</span><span class="p">,</span>
|
|
<span class="n">SUInvalidUpdaterError</span> <span class="o">=</span> <span class="mo">0005</span><span class="p">,</span>
|
|
<span class="n">SUInvalidHostBundleIdentifierError</span> <span class="o">=</span> <span class="mo">0006</span><span class="p">,</span>
|
|
<span class="n">SUInvalidHostVersionError</span> <span class="o">=</span> <span class="mo">0007</span><span class="p">,</span>
|
|
|
|
<span class="c1">// Appcast phase errors.</span>
|
|
<span class="n">SUAppcastParseError</span> <span class="o">=</span> <span class="mi">1000</span><span class="p">,</span>
|
|
<span class="n">SUNoUpdateError</span> <span class="o">=</span> <span class="mi">1001</span><span class="p">,</span>
|
|
<span class="n">SUAppcastError</span> <span class="o">=</span> <span class="mi">1002</span><span class="p">,</span>
|
|
<span class="n">SURunningFromDiskImageError</span> <span class="o">=</span> <span class="mi">1003</span><span class="p">,</span>
|
|
<span class="n">SUResumeAppcastError</span> <span class="o">=</span> <span class="mi">1004</span><span class="p">,</span>
|
|
<span class="n">SURunningTranslocated</span> <span class="o">=</span> <span class="mi">1005</span><span class="p">,</span>
|
|
<span class="n">SUWebKitTerminationError</span> <span class="o">=</span> <span class="mi">1006</span><span class="p">,</span>
|
|
<span class="n">SUReleaseNotesError</span> <span class="o">=</span> <span class="mi">1007</span><span class="p">,</span>
|
|
|
|
<span class="c1">// Download phase errors.</span>
|
|
<span class="n">SUTemporaryDirectoryError</span> <span class="o">=</span> <span class="mi">2000</span><span class="p">,</span>
|
|
<span class="n">SUDownloadError</span> <span class="o">=</span> <span class="mi">2001</span><span class="p">,</span>
|
|
|
|
<span class="c1">// Extraction phase errors.</span>
|
|
<span class="n">SUUnarchivingError</span> <span class="o">=</span> <span class="mi">3000</span><span class="p">,</span>
|
|
<span class="n">SUSignatureError</span> <span class="o">=</span> <span class="mi">3001</span><span class="p">,</span>
|
|
<span class="n">SUValidationError</span> <span class="o">=</span> <span class="mi">3002</span><span class="p">,</span>
|
|
|
|
<span class="c1">// Installation phase errors.</span>
|
|
<span class="n">SUFileCopyFailure</span> <span class="o">=</span> <span class="mi">4000</span><span class="p">,</span>
|
|
<span class="n">SUAuthenticationFailure</span> <span class="o">=</span> <span class="mi">4001</span><span class="p">,</span>
|
|
<span class="n">SUMissingUpdateError</span> <span class="o">=</span> <span class="mi">4002</span><span class="p">,</span>
|
|
<span class="n">SUMissingInstallerToolError</span> <span class="o">=</span> <span class="mi">4003</span><span class="p">,</span>
|
|
<span class="n">SURelaunchError</span> <span class="o">=</span> <span class="mi">4004</span><span class="p">,</span>
|
|
<span class="n">SUInstallationError</span> <span class="o">=</span> <span class="mi">4005</span><span class="p">,</span>
|
|
<span class="n">SUDowngradeError</span> <span class="o">=</span> <span class="mi">4006</span><span class="p">,</span>
|
|
<span class="n">SUInstallationCanceledError</span> <span class="o">=</span> <span class="mi">4007</span><span class="p">,</span>
|
|
<span class="n">SUInstallationAuthorizeLaterError</span> <span class="o">=</span> <span class="mi">4008</span><span class="p">,</span>
|
|
<span class="n">SUNotValidUpdateError</span> <span class="o">=</span> <span class="mi">4009</span><span class="p">,</span>
|
|
<span class="n">SUAgentInvalidationError</span> <span class="o">=</span> <span class="mi">4010</span><span class="p">,</span>
|
|
<span class="n">SUInstallationRootInteractiveError</span> <span class="o">=</span> <span class="mi">4011</span><span class="p">,</span>
|
|
<span class="n">SUInstallationWriteNoPermissionError</span> <span class="o">=</span> <span class="mi">4012</span><span class="p">,</span>
|
|
|
|
<span class="c1">// API misuse errors.</span>
|
|
<span class="n">SUIncorrectAPIUsageError</span> <span class="o">=</span> <span class="mi">5000</span>
|
|
<span class="p">}</span></code></pre>
|
|
|
|
</div>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">SUError</span> <span class="p">:</span> <span class="kt">OSStatus</span><span class="p">,</span> <span class="kd">@unchecked</span> <span class="kt">Sendable</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/c:@E@SPUNoUpdateFoundReason"></a>
|
|
<a name="//apple_ref/objc/Enum/SPUNoUpdateFoundReason" class="dashAnchor"></a>
|
|
<a class="token" href="#/c:@E@SPUNoUpdateFoundReason">SPUNoUpdateFoundReason</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>The reason why a new update is not available.</p>
|
|
|
|
<a href="Enums/SPUNoUpdateFoundReason.html" class="slightly-smaller">See more</a>
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Objective-C</p>
|
|
<pre class="highlight objective_c"><code><span class="k">enum</span> <span class="n">SPUNoUpdateFoundReason</span> <span class="o">:</span> <span class="n">OSStatus</span> <span class="p">{}</span></code></pre>
|
|
|
|
</div>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">SPUNoUpdateFoundReason</span> <span class="p">:</span> <span class="kt">OSStatus</span><span class="p">,</span> <span class="kd">@unchecked</span> <span class="kt">Sendable</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
</article>
|
|
</div>
|
|
<div class="nav-wrapper">
|
|
<nav class="nav-bottom">
|
|
<ul class="nav-groups">
|
|
<li class="nav-group-name">
|
|
<a href="Classes.html">Classes</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a href="Classes/SPUDownloadData.html">SPUDownloadData</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Classes/SPUStandardUpdaterController.html">SPUStandardUpdaterController</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Classes/SPUStandardUserDriver.html">SPUStandardUserDriver</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Classes/SPUUpdatePermissionRequest.html">SPUUpdatePermissionRequest</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Classes/SPUUpdater.html">SPUUpdater</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Classes/SPUUpdaterSettings.html">SPUUpdaterSettings</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Classes/SPUUserUpdateState.html">SPUUserUpdateState</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Classes/SUAppcast.html">SUAppcast</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Classes/SUAppcastItem.html">SUAppcastItem</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Classes/SUStandardVersionComparator.html">SUStandardVersionComparator</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Classes/SUUpdatePermissionResponse.html">SUUpdatePermissionResponse</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Classes/SUUpdater.html">SUUpdater</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-group-name">
|
|
<a href="Constants.html">Constants</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SPULatestAppcastItemFoundKey">SPULatestAppcastItemFoundKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SPUNoUpdateFoundReasonKey">SPUNoUpdateFoundReasonKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SPUNoUpdateFoundUserInitiatedKey">SPUNoUpdateFoundUserInitiatedKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SUSparkleErrorDomain">SUSparkleErrorDomain</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SUSystemProfilerApplicationNameKey">SUSystemProfilerApplicationNameKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SUSystemProfilerApplicationVersionKey">SUSystemProfilerApplicationVersionKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SUSystemProfilerCPU64bitKey">SUSystemProfilerCPU64bitKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SUSystemProfilerCPUCountKey">SUSystemProfilerCPUCountKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SUSystemProfilerCPUFrequencyKey">SUSystemProfilerCPUFrequencyKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SUSystemProfilerCPUSubtypeKey">SUSystemProfilerCPUSubtypeKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SUSystemProfilerCPUTypeKey">SUSystemProfilerCPUTypeKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SUSystemProfilerHardwareModelKey">SUSystemProfilerHardwareModelKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SUSystemProfilerMemoryKey">SUSystemProfilerMemoryKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SUSystemProfilerOperatingSystemVersionKey">SUSystemProfilerOperatingSystemVersionKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SUSystemProfilerPreferredLanguageKey">SUSystemProfilerPreferredLanguageKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SUUpdaterAppcastItemNotificationKey">SUUpdaterAppcastItemNotificationKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SUUpdaterAppcastNotificationKey">SUUpdaterAppcastNotificationKey</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SUUpdaterDidFindValidUpdateNotification">SUUpdaterDidFindValidUpdateNotification</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SUUpdaterDidFinishLoadingAppCastNotification">SUUpdaterDidFinishLoadingAppCastNotification</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SUUpdaterDidNotFindUpdateNotification">SUUpdaterDidNotFindUpdateNotification</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Constants.html#/c:@SUUpdaterWillRestartNotification">SUUpdaterWillRestartNotification</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-group-name">
|
|
<a href="Enums.html">Enumerations</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a href="Enums/SPUNoUpdateFoundReason.html">SPUNoUpdateFoundReason</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Enums/SPUUpdateCheck.html">SPUUpdateCheck</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Enums/SPUUserUpdateChoice.html">SPUUserUpdateChoice</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Enums/SPUUserUpdateStage.html">SPUUserUpdateStage</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Enums/SUError.html">SUError</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-group-name">
|
|
<a href="Protocols.html">Protocols</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a href="Protocols/SPUStandardUserDriverDelegate.html">SPUStandardUserDriverDelegate</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Protocols/SPUUpdaterDelegate.html">SPUUpdaterDelegate</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Protocols/SPUUserDriver.html">SPUUserDriver</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Protocols/SUUpdaterDelegate.html">SUUpdaterDelegate</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Protocols/SUVersionComparison.html">SUVersionComparison</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Protocols/SUVersionDisplay.html">SUVersionDisplay</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
<div class="footer-wrapper">
|
|
<section id="footer">
|
|
<p>© 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-02-23)</p>
|
|
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
|
|
</section>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|