|
16 | 16 | <header> |
17 | 17 | <div class="content-wrapper"> |
18 | 18 | <p> |
19 | | - <a href="../index.html">Sparkle 2.7.1 Docs</a> |
| 19 | + <a href="../index.html">Sparkle 2.8.0 Docs</a> |
20 | 20 | <span class="no-mobile"> (59% documented)</span> |
21 | 21 | </p> |
22 | 22 |
|
@@ -73,6 +73,8 @@ <h1>SPUUpdater</h1> |
73 | 73 |
|
74 | 74 | <p>Please view the documentation on each of these properties for more detail if you are to configure them dynamically.</p> |
75 | 75 |
|
| 76 | +<p>This class must be used on the main thread.</p> |
| 77 | + |
76 | 78 | </section> |
77 | 79 | <section class="section task-group-section"> |
78 | 80 | <div class="task-group"> |
@@ -294,11 +296,13 @@ <h4>Return Value</h4> |
294 | 296 |
|
295 | 297 | <p>If an update hasn’t started, the user may be shown that a new check for updates is occurring. |
296 | 298 | If an update has already been downloaded or begun installing from a previous session, the user may be presented to install that update. |
297 | | -If the user is already being presented with an update, that update will be shown to the user in active focus.</p> |
| 299 | +If the user is already being presented with an update or update permission prompt, that notice may be shown to the user in active focus |
| 300 | +(as long as the user driver is the standard <code><a href="../Classes/SPUStandardUserDriver.html">SPUStandardUserDriver</a></code> or if it implements <code><a href="../Protocols/SPUUserDriver.html#/c:objc(pl)SPUUserDriver(im)showUpdateInFocus">-[SPUUserDriver showUpdateInFocus]</a></code>).</p> |
298 | 301 |
|
299 | | -<p>This will find updates that the user has previously opted into skipping.</p> |
| 302 | +<p>This will find updates that the user has previously opted into skipping. |
| 303 | +See <code><a href="../Classes/SPUUpdater.html#/c:objc(cs)SPUUpdater(py)canCheckForUpdates">canCheckForUpdates</a></code> property which can determine when this method may be invoked.</p> |
300 | 304 |
|
301 | | -<p>See <code><a href="../Classes/SPUUpdater.html#/c:objc(cs)SPUUpdater(py)canCheckForUpdates">canCheckForUpdates</a></code> property which can determine when this method may be invoked.</p> |
| 305 | +<p>This must be called on the main thread.</p> |
302 | 306 |
|
303 | 307 | </div> |
304 | 308 | <div class="declaration"> |
@@ -352,6 +356,8 @@ <h4>Declaration</h4> |
352 | 356 |
|
353 | 357 | <p>This method does not do anything if there is a <code><a href="../Classes/SPUUpdater.html#/c:objc(cs)SPUUpdater(py)sessionInProgress">sessionInProgress</a></code>.</p> |
354 | 358 |
|
| 359 | +<p>This must be called on the main thread.</p> |
| 360 | + |
355 | 361 | </div> |
356 | 362 | <div class="declaration"> |
357 | 363 | <h4>Declaration</h4> |
@@ -397,6 +403,8 @@ <h4>Declaration</h4> |
397 | 403 |
|
398 | 404 | <p>This method does not do anything if there is a <code><a href="../Classes/SPUUpdater.html#/c:objc(cs)SPUUpdater(py)sessionInProgress">sessionInProgress</a></code>.</p> |
399 | 405 |
|
| 406 | +<p>This must be called on the main thread.</p> |
| 407 | + |
400 | 408 | </div> |
401 | 409 | <div class="declaration"> |
402 | 410 | <h4>Declaration</h4> |
@@ -429,8 +437,11 @@ <h4>Declaration</h4> |
429 | 437 | <div class="abstract"> |
430 | 438 | <p>A property indicating whether or not updates can be checked by the user.</p> |
431 | 439 |
|
432 | | -<p>An update check can be made by the user when an update session isn’t in progress, or when an update or its progress is being shown to the user. |
433 | | -A user cannot check for updates when data (such as the feed or an update) is still being downloaded automatically in the background.</p> |
| 440 | +<p>An update check can be made by the user when an update session isn’t in progress. |
| 441 | +An update check can also be made when an update or its progress is being shown to the user |
| 442 | +(as long as the user driver is the standard <code><a href="../Classes/SPUStandardUserDriver.html">SPUStandardUserDriver</a></code> or if it implements <code><a href="../Protocols/SPUUserDriver.html#/c:objc(pl)SPUUserDriver(im)showUpdateInFocus">-[SPUUserDriver showUpdateInFocus]</a></code>).</p> |
| 443 | + |
| 444 | +<p>A user cannot check for updates when data (such as the feed or an update) is still being downloaded automatically in the background.</p> |
434 | 445 |
|
435 | 446 | <p>This property is suitable to use for menu item validation for seeing if <code><a href="../Classes/SPUUpdater.html#/c:objc(cs)SPUUpdater(im)checkForUpdates">-checkForUpdates</a></code> can be invoked.</p> |
436 | 447 |
|
@@ -530,7 +541,9 @@ <h4>Declaration</h4> |
530 | 541 | to your app’s command line arguments instead of setting this property.</p> |
531 | 542 |
|
532 | 543 | <p>The update schedule cycle will be reset in a short delay after the property’s new value is set. |
533 | | -This is to allow reverting this property without kicking off a schedule change immediately</p> |
| 544 | +This is to allow reverting this property without kicking off a schedule change immediately.</p> |
| 545 | + |
| 546 | +<p>This property is KVO compliant. This property must be called on the main thread.</p> |
534 | 547 |
|
535 | 548 | </div> |
536 | 549 | <div class="declaration"> |
@@ -572,7 +585,9 @@ <h4>Declaration</h4> |
572 | 585 | Do not always set it on launch unless you want to ignore the user’s preference.</p> |
573 | 586 |
|
574 | 587 | <p>The update schedule cycle will be reset in a short delay after the property’s new value is set. |
575 | | -This is to allow reverting this property without kicking off a schedule change immediately</p> |
| 588 | +This is to allow reverting this property without kicking off a schedule change immediately.</p> |
| 589 | + |
| 590 | +<p>This property is KVO compliant. This property must be called on the main thread.</p> |
576 | 591 |
|
577 | 592 | </div> |
578 | 593 | <div class="declaration"> |
@@ -622,6 +637,8 @@ <h4>Declaration</h4> |
622 | 637 | Only set this property if the user wants to change the default via a user settings option. |
623 | 638 | Do not always set it on launch unless you want to ignore the user’s preference.</p> |
624 | 639 |
|
| 640 | +<p>This property is KVO compliant. This property must be called on the main thread.</p> |
| 641 | + |
625 | 642 | </div> |
626 | 643 | <div class="declaration"> |
627 | 644 | <h4>Declaration</h4> |
@@ -856,6 +873,8 @@ <h4>Declaration</h4> |
856 | 873 |
|
857 | 874 | <p>Setting this property will persist in the host bundle’s user defaults.</p> |
858 | 875 |
|
| 876 | +<p>This property is KVO compliant. This property must be called on the main thread.</p> |
| 877 | + |
859 | 878 | </div> |
860 | 879 | <div class="declaration"> |
861 | 880 | <h4>Declaration</h4> |
@@ -892,6 +911,8 @@ <h4>Declaration</h4> |
892 | 911 | For example, <code>defaults delete my-bundle-id SULastCheckTime</code> can be invoked to clear the last update check time and test |
893 | 912 | if update checks are automatically scheduled.</p> |
894 | 913 |
|
| 914 | +<p>This property must be called on the main thread.</p> |
| 915 | + |
895 | 916 | </div> |
896 | 917 | <div class="declaration"> |
897 | 918 | <h4>Declaration</h4> |
@@ -930,6 +951,8 @@ <h4>Declaration</h4> |
930 | 951 |
|
931 | 952 | <p>See also <code><a href="../Classes/SPUUpdater.html#/c:objc(cs)SPUUpdater(im)resetUpdateCycleAfterShortDelay">-resetUpdateCycleAfterShortDelay</a></code> which gives the user a short delay before triggering a cycle reset.</p> |
932 | 953 |
|
| 954 | +<p>This must be called on the main thread.</p> |
| 955 | + |
933 | 956 | </div> |
934 | 957 | <div class="declaration"> |
935 | 958 | <h4>Declaration</h4> |
@@ -970,6 +993,8 @@ <h4>Declaration</h4> |
970 | 993 |
|
971 | 994 | <p>If the <code><a href="../Classes/SPUUpdater.html#/c:objc(cs)SPUUpdater(py)updateCheckInterval">updateCheckInterval</a></code> or <code><a href="../Classes/SPUUpdater.html#/c:objc(cs)SPUUpdater(py)automaticallyChecksForUpdates">automaticallyChecksForUpdates</a></code> properties are changed, this method is automatically invoked. In these cases, manually resetting the update cycle is not necessary.</p> |
972 | 995 |
|
| 996 | +<p>This must be called on the main thread.</p> |
| 997 | + |
973 | 998 | </div> |
974 | 999 | <div class="declaration"> |
975 | 1000 | <h4>Declaration</h4> |
@@ -1185,7 +1210,7 @@ <h4>Declaration</h4> |
1185 | 1210 | </div> |
1186 | 1211 | <div class="footer-wrapper"> |
1187 | 1212 | <section id="footer"> |
1188 | | - <p>© 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-06-16)</p> |
| 1213 | + <p>© 2025 <a class="link" href="https://sparkle-project.org" target="_blank" rel="external noopener">Sparkle Project</a>. All rights reserved. (Last updated: 2025-09-16)</p> |
1189 | 1214 | <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> |
1190 | 1215 | </section> |
1191 | 1216 | </div> |
|
0 commit comments