-
Notifications
You must be signed in to change notification settings - Fork 43
Expand file tree
/
Copy pathSPUUpdaterDelegate.html
More file actions
2473 lines (2312 loc) · 154 KB
/
SPUUpdaterDelegate.html
File metadata and controls
2473 lines (2312 loc) · 154 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<title>SPUUpdaterDelegate Protocol 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/Protocol/SPUUpdaterDelegate" class="dashAnchor"></a>
<a title="SPUUpdaterDelegate Protocol 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=""/>
<a href="../Protocols.html">Protocols</a>
<img id="carat" src="../img/carat.png" alt=""/>
SPUUpdaterDelegate Protocol Reference
</span>
</p>
</div>
</div>
<div class="wrapper">
<div class="article-wrapper">
<article class="main-content">
<section>
<section class="section">
<h1>SPUUpdaterDelegate</h1>
<div class="declaration">
<div class="language">
<p class="aside-title">Objective-C</p>
<pre class="highlight objective_c"><code><span class="k">@protocol</span> <span class="nc">SPUUpdaterDelegate</span> <span class="o"><</span><span class="n">NSObject</span><span class="o">></span></code></pre>
</div>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">SPUUpdaterDelegate</span> <span class="p">:</span> <span class="kt">NSObjectProtocol</span></code></pre>
</div>
</div>
<p>Provides delegation methods to control the behavior of an <code><a href="../Classes/SPUUpdater.html">SPUUpdater</a></code> object.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)SPUUpdaterDelegate(im)updater:mayPerformUpdateCheck:error:"></a>
<a name="//apple_ref/objc/Method/-updater:mayPerformUpdateCheck:error:" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)SPUUpdaterDelegate(im)updater:mayPerformUpdateCheck:error:">-updater:<wbr>mayPerformUpdateCheck:<wbr>error:<wbr></a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns whether to allow Sparkle to check for updates.</p>
<p>For example, this may be used to prevent Sparkle from interrupting a setup assistant.
Alternatively, you may want to consider starting the updater after eg: the setup assistant finishes.</p>
<p>Note in Swift, this method returns Void and is marked with the throws keyword. If this method
doesn’t throw an error, the updater may perform an update check. Otherwise if an error is thrown (we recommend using an NSError),
then the updater may not perform an update check.</p>
</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">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">updater</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">updater</span>
<span class="nf">mayPerformUpdateCheck</span><span class="p">:(</span><span class="n"><a href="../Enums/SPUUpdateCheck.html">SPUUpdateCheck</a></span><span class="p">)</span><span class="nv">updateCheck</span>
<span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">error</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">optional</span> <span class="kd">func</span> <span class="nf">updater</span><span class="p">(</span><span class="n">_</span> <span class="nv">updater</span><span class="p">:</span> <span class="kt"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span><span class="p">,</span> <span class="n">mayPerform</span> <span class="nv">updateCheck</span><span class="p">:</span> <span class="kt"><a href="../Enums/SPUUpdateCheck.html">SPUUpdateCheck</a></span><span class="p">)</span> <span class="k">throws</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>updater</em>
</code>
</td>
<td>
<div>
<p>The updater instance.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>updateCheck</em>
</code>
</td>
<td>
<div>
<p>The type of update check that will be performed if the updater is allowed to check for updates.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>error</em>
</code>
</td>
<td>
<div>
<p>The populated error object if the updater may not perform a new update check. The <code>NSLocalizedDescriptionKey</code> user info key should be populated indicating a description of the error.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p><code>YES</code> if the updater is allowed to check for updates, otherwise <code>NO</code></p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)SPUUpdaterDelegate(im)allowedChannelsForUpdater:"></a>
<a name="//apple_ref/objc/Method/-allowedChannelsForUpdater:" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)SPUUpdaterDelegate(im)allowedChannelsForUpdater:">-allowedChannelsForUpdater:<wbr></a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns the set of Sparkle channels the updater is allowed to find new updates from.</p>
<p>An appcast item can specify a channel the update is posted to. Without specifying a channel, the appcast item is posted to the default channel.
For instance:</p>
<pre class="highlight objective_c"><code><span class="o"><</span><span class="n">item</span><span class="o">></span>
<span class="o"><</span><span class="n">sparkle</span><span class="o">:</span><span class="n">version</span><span class="o">></span><span class="mi">2</span><span class="p">.</span><span class="mi">0</span> <span class="n">Beta</span> <span class="mi">1</span><span class="o"></</span><span class="n">sparkle</span><span class="o">:</span><span class="n">version</span><span class="o">></span>
<span class="o"><</span><span class="n">sparkle</span><span class="o">:</span><span class="n">channel</span><span class="o">></span><span class="n">beta</span><span class="o"></</span><span class="n">sparkle</span><span class="o">:</span><span class="n">channel</span><span class="o">></span>
<span class="o"></</span><span class="n">item</span><span class="o">></span>
</code></pre>
<p>This example posts an update to the <code>beta</code> channel, so only updaters that are allowed to use the <code>beta</code> channel can find this update.</p>
<p>If the <code><sparkle:channel></code> element is not present, the update item is posted to the default channel and can be found by any updater.</p>
<p>You can pick any name you’d like for the channel. The valid characters for channel names are letters, numbers, dashes, underscores, and periods.</p>
<p>Note to use this feature, all app versions that your users may update from in your feed must use a version of Sparkle that supports this feature.
This feature was added in Sparkle 2.</p>
</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">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSSet</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">allowedChannelsForUpdater</span><span class="p">:</span>
<span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">updater</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">optional</span> <span class="kd">func</span> <span class="nf">allowedChannels</span><span class="p">(</span><span class="k">for</span> <span class="nv">updater</span><span class="p">:</span> <span class="kt"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Set</span><span class="o"><</span><span class="kt">String</span><span class="o">></span></code></pre>
</div>
</div>
<div>
<h4>Return Value</h4>
<p>The set of channel names the updater is allowed to find new updates in. An empty set is the default behavior,
which means the updater will only look for updates in the default channel. The default channel is always included in the allowed set.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)SPUUpdaterDelegate(im)feedURLStringForUpdater:"></a>
<a name="//apple_ref/objc/Method/-feedURLStringForUpdater:" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)SPUUpdaterDelegate(im)feedURLStringForUpdater:">-feedURLStringForUpdater:<wbr></a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns a custom appcast URL used for checking for new updates.</p>
<p>Override this to dynamically specify the feed URL.</p>
</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">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nf">feedURLStringForUpdater</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">updater</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">optional</span> <span class="kd">func</span> <span class="nf">feedURLString</span><span class="p">(</span><span class="k">for</span> <span class="nv">updater</span><span class="p">:</span> <span class="kt"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>updater</em>
</code>
</td>
<td>
<div>
<p>The updater instance.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>An appcast feed URL to check for new updates in, or <code>nil</code> for the default behavior and if you don’t want to be delegated this task.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)SPUUpdaterDelegate(im)feedParametersForUpdater:sendingSystemProfile:"></a>
<a name="//apple_ref/objc/Method/-feedParametersForUpdater:sendingSystemProfile:" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)SPUUpdaterDelegate(im)feedParametersForUpdater:sendingSystemProfile:">-feedParametersForUpdater:<wbr>sendingSystemProfile:<wbr></a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns additional parameters to append to the appcast URL’s query string.</p>
<p>This is potentially based on whether or not Sparkle will also be sending along the system profile.</p>
</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">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">NSString</span> <span class="o">*></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span>
<span class="nf">feedParametersForUpdater</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">updater</span>
<span class="nf">sendingSystemProfile</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">sendingProfile</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">optional</span> <span class="kd">func</span> <span class="nf">feedParameters</span><span class="p">(</span><span class="k">for</span> <span class="nv">updater</span><span class="p">:</span> <span class="kt"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span><span class="p">,</span> <span class="n">sendingSystemProfile</span> <span class="nv">sendingProfile</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span> <span class="o">-></span> <span class="p">[[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">String</span><span class="p">]]</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>updater</em>
</code>
</td>
<td>
<div>
<p>The updater instance.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>sendingProfile</em>
</code>
</td>
<td>
<div>
<p>Whether the system profile will also be sent.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>An array of dictionaries with keys: <code>key</code>, <code>value</code>, <code>displayKey</code>, <code>displayValue</code>, the latter two being specifically for display to the user.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)SPUUpdaterDelegate(im)updaterShouldPromptForPermissionToCheckForUpdates:"></a>
<a name="//apple_ref/objc/Method/-updaterShouldPromptForPermissionToCheckForUpdates:" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)SPUUpdaterDelegate(im)updaterShouldPromptForPermissionToCheckForUpdates:">-updaterShouldPromptForPermissionToCheckForUpdates:<wbr></a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns whether Sparkle should prompt the user about checking for new updates automatically.</p>
<p>Use this to override the default behavior, which is to prompt for permission to check for updates on second app launch
(if SUEnableAutomaticChecks is not specified).</p>
<p>This method is not called if SUEnableAutomaticChecks is defined in Info.plist or
if the user has responded to a permission prompt before.</p>
</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">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">updaterShouldPromptForPermissionToCheckForUpdates</span><span class="p">:</span>
<span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">updater</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">optional</span> <span class="kd">func</span> <span class="nf">updaterShouldPromptForPermissionToCheck</span><span class="p">(</span><span class="n">forUpdates</span> <span class="nv">updater</span><span class="p">:</span> <span class="kt"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>updater</em>
</code>
</td>
<td>
<div>
<p>The updater instance.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p><code>YES</code> if the updater should prompt for permission to check for new updates automatically, otherwise <code>NO</code></p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)SPUUpdaterDelegate(im)allowedSystemProfileKeysForUpdater:"></a>
<a name="//apple_ref/objc/Method/-allowedSystemProfileKeysForUpdater:" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)SPUUpdaterDelegate(im)allowedSystemProfileKeysForUpdater:">-allowedSystemProfileKeysForUpdater:<wbr></a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns an allowed list of system profile keys to be appended to the appcast URL’s query string.</p>
<p>By default all keys will be included. This method allows overriding which keys should only be allowed.</p>
</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">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">allowedSystemProfileKeysForUpdater</span><span class="p">:</span>
<span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">updater</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">optional</span> <span class="kd">func</span> <span class="nf">allowedSystemProfileKeys</span><span class="p">(</span><span class="k">for</span> <span class="nv">updater</span><span class="p">:</span> <span class="kt"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span><span class="p">)</span> <span class="o">-></span> <span class="p">[</span><span class="kt">String</span><span class="p">]?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>updater</em>
</code>
</td>
<td>
<div>
<p>The updater instance.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>An array of system profile keys to include in the appcast URL’s query string. Elements must be one of the <code>SUSystemProfiler*Key</code> constants. Return <code>nil</code> for the default behavior and if you don’t want to be delegated this task.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)SPUUpdaterDelegate(im)updater:didFinishLoadingAppcast:"></a>
<a name="//apple_ref/objc/Method/-updater:didFinishLoadingAppcast:" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)SPUUpdaterDelegate(im)updater:didFinishLoadingAppcast:">-updater:<wbr>didFinishLoadingAppcast:<wbr></a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Called after Sparkle has downloaded the appcast from the remote server.</p>
<p>Implement this if you want to do some special handling with the appcast once it finishes loading.</p>
</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">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">updater</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">updater</span>
<span class="nf">didFinishLoadingAppcast</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SUAppcast.html">SUAppcast</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">appcast</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">optional</span> <span class="kd">func</span> <span class="nf">updater</span><span class="p">(</span><span class="n">_</span> <span class="nv">updater</span><span class="p">:</span> <span class="kt"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span><span class="p">,</span> <span class="n">didFinishLoading</span> <span class="nv">appcast</span><span class="p">:</span> <span class="kt"><a href="../Classes/SUAppcast.html">SUAppcast</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>updater</em>
</code>
</td>
<td>
<div>
<p>The updater instance.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>appcast</em>
</code>
</td>
<td>
<div>
<p>The appcast that was downloaded from the remote server.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)SPUUpdaterDelegate(im)updater:didFindValidUpdate:"></a>
<a name="//apple_ref/objc/Method/-updater:didFindValidUpdate:" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)SPUUpdaterDelegate(im)updater:didFindValidUpdate:">-updater:<wbr>didFindValidUpdate:<wbr></a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Called when a new valid update is found by the update driver.</p>
</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">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">updater</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">updater</span>
<span class="nf">didFindValidUpdate</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SUAppcastItem.html">SUAppcastItem</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">item</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">optional</span> <span class="kd">func</span> <span class="nf">updater</span><span class="p">(</span><span class="n">_</span> <span class="nv">updater</span><span class="p">:</span> <span class="kt"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span><span class="p">,</span> <span class="n">didFindValidUpdate</span> <span class="nv">item</span><span class="p">:</span> <span class="kt"><a href="../Classes/SUAppcastItem.html">SUAppcastItem</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>updater</em>
</code>
</td>
<td>
<div>
<p>The updater instance.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>item</em>
</code>
</td>
<td>
<div>
<p>The appcast item corresponding to the update that is proposed to be installed.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)SPUUpdaterDelegate(im)updaterDidNotFindUpdate:error:"></a>
<a name="//apple_ref/objc/Method/-updaterDidNotFindUpdate:error:" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)SPUUpdaterDelegate(im)updaterDidNotFindUpdate:error:">-updaterDidNotFindUpdate:<wbr>error:<wbr></a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Called when a valid new update is not found.</p>
<p>There are various reasons a new update is unavailable and can’t be installed.</p>
<p>The userInfo dictionary on the error is populated with three keys:</p>
<ul>
<li><code><a href="../Constants.html#/c:@SPULatestAppcastItemFoundKey">SPULatestAppcastItemFoundKey</a></code>: if available, this may provide the latest <code><a href="../Classes/SUAppcastItem.html">SUAppcastItem</a></code> that was found. This will be <code>nil</code> if it’s unavailable.</li>
<li><code><a href="../Constants.html#/c:@SPUNoUpdateFoundReasonKey">SPUNoUpdateFoundReasonKey</a></code>: This will provide the <code><a href="../Enums/SPUNoUpdateFoundReason.html">SPUNoUpdateFoundReason</a></code>.
For example the reason could be because the latest version in the feed requires a newer OS version or could be because the user is already on the latest version.</li>
<li><p><code><a href="../Constants.html#/c:@SPUNoUpdateFoundUserInitiatedKey">SPUNoUpdateFoundUserInitiatedKey</a></code>: A boolean that indicates if a new update was not found when the user intitiated an update check manually.</p></li>
</ul>
</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">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">updaterDidNotFindUpdate</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">updater</span>
<span class="nf">error</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSError</span> <span class="o">*</span><span class="p">)</span><span class="nv">error</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">optional</span> <span class="kd">func</span> <span class="nf">updaterDidNotFindUpdate</span><span class="p">(</span><span class="n">_</span> <span class="nv">updater</span><span class="p">:</span> <span class="kt"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span><span class="p">,</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">Error</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>updater</em>
</code>
</td>
<td>
<div>
<p>The updater instance.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>error</em>
</code>
</td>
<td>
<div>
<p>An error containing information on why a new valid update was not found</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)SPUUpdaterDelegate(im)updaterDidNotFindUpdate:"></a>
<a name="//apple_ref/objc/Method/-updaterDidNotFindUpdate:" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)SPUUpdaterDelegate(im)updaterDidNotFindUpdate:">-updaterDidNotFindUpdate:<wbr></a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Called when a valid new update is not found.</p>
<p>If more information is needed on why an update was not found, use <code><a href="../Protocols/SPUUpdaterDelegate.html#/c:objc(pl)SPUUpdaterDelegate(im)updaterDidNotFindUpdate:error:">-[SPUUpdaterDelegate updaterDidNotFindUpdate:error:]</a></code> instead.</p>
</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">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">updaterDidNotFindUpdate</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">updater</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">optional</span> <span class="kd">func</span> <span class="nf">updaterDidNotFindUpdate</span><span class="p">(</span><span class="n">_</span> <span class="nv">updater</span><span class="p">:</span> <span class="kt"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>updater</em>
</code>
</td>
<td>
<div>
<p>The updater instance.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)SPUUpdaterDelegate(im)bestValidUpdateInAppcast:forUpdater:"></a>
<a name="//apple_ref/objc/Method/-bestValidUpdateInAppcast:forUpdater:" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)SPUUpdaterDelegate(im)bestValidUpdateInAppcast:forUpdater:">-bestValidUpdateInAppcast:<wbr>forUpdater:<wbr></a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns the item in the appcast corresponding to the update that should be installed.</p>
<p>Please consider using or migrating to other supported features before adopting this method.
Specifically:</p>
<ul>
<li>If you want to filter out certain tagged updates (like beta updates), consider <code><a href="../Protocols/SPUUpdaterDelegate.html#/c:objc(pl)SPUUpdaterDelegate(im)allowedChannelsForUpdater:">-[SPUUpdaterDelegate allowedChannelsForUpdater:]</a></code> instead.</li>
<li>If you want to treat certain updates as informational-only, consider supplying <code><sparkle:informationalUpdate></code> with a set of affected versions users are updating from.</li>
</ul>
<p>If you’re using special logic or extensions in your appcast, implement this to use your own logic for finding a valid update, if any, in the given appcast.</p>
<p>Do not base your logic by filtering out items with a minimum or maximum OS version or minimum autoupdate version
because Sparkle already has logic for determining whether or not those items should be filtered out.</p>
<p>Also do not return a non-top level item from the appcast such as a delta item. Delta items will be ignored.
Sparkle picks the delta item from your selection if the appropriate one is available.</p>
<p>This method will not be invoked with an appcast that has zero items. Pick the best item from the appcast.
If an item is available that has the same version as the application or bundle to update, do not pick an item that is worse than that version.</p>
<p>This method may be called multiple times for different selections and filters. This method should be efficient.</p>
<p>Return <code><a href="../Classes/SUAppcastItem.html#/c:objc(cs)SUAppcastItem(cm)emptyAppcastItem">+[SUAppcastItem emptyAppcastItem]</a></code> if no appcast item is valid.</p>
<p>Return <code>nil</code> if you don’t want to be delegated this task and want to let Sparkle handle picking the best valid update.</p>
</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">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SUAppcastItem.html">SUAppcastItem</a></span> <span class="o">*</span><span class="p">)</span>
<span class="nf">bestValidUpdateInAppcast</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SUAppcast.html">SUAppcast</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">appcast</span>
<span class="nf">forUpdater</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">updater</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">optional</span> <span class="kd">func</span> <span class="nf">bestValidUpdate</span><span class="p">(</span><span class="k">in</span> <span class="nv">appcast</span><span class="p">:</span> <span class="kt"><a href="../Classes/SUAppcast.html">SUAppcast</a></span><span class="p">,</span> <span class="k">for</span> <span class="nv">updater</span><span class="p">:</span> <span class="kt"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Classes/SUAppcastItem.html">SUAppcastItem</a></span><span class="p">?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>appcast</em>
</code>
</td>
<td>
<div>
<p>The appcast that was downloaded from the remote server.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>updater</em>
</code>
</td>
<td>
<div>
<p>The updater instance.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>The best valid appcast item.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)SPUUpdaterDelegate(im)updater:shouldProceedWithUpdate:updateCheck:error:"></a>
<a name="//apple_ref/objc/Method/-updater:shouldProceedWithUpdate:updateCheck:error:" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)SPUUpdaterDelegate(im)updater:shouldProceedWithUpdate:updateCheck:error:">-updater:<wbr>shouldProceedWithUpdate:<wbr>updateCheck:<wbr>error:<wbr></a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns whether or not the updater should proceed with the new chosen update from the appcast.</p>
<p>By default, the updater will always proceed with the best selected update found in an appcast. Override this to override this behavior.</p>
<p>If you return <code>NO</code> and populate the <code>error,</code> the user is not shown this <code>updateItem</code> nor is the update downloaded or installed.</p>
<p>Note in Swift, this method returns Void and is marked with the throws keyword. If this method doesn’t throw an error, the updater will proceed with the update.
Otherwise if an error is thrown (we recommend using an NSError), then the will not proceed with the update.</p>
</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">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">updater</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">updater</span>
<span class="nf">shouldProceedWithUpdate</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SUAppcastItem.html">SUAppcastItem</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">updateItem</span>
<span class="nf">updateCheck</span><span class="p">:(</span><span class="n"><a href="../Enums/SPUUpdateCheck.html">SPUUpdateCheck</a></span><span class="p">)</span><span class="nv">updateCheck</span>
<span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">error</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">optional</span> <span class="kd">func</span> <span class="nf">updater</span><span class="p">(</span><span class="n">_</span> <span class="nv">updater</span><span class="p">:</span> <span class="kt"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span><span class="p">,</span> <span class="n">shouldProceedWithUpdate</span> <span class="nv">updateItem</span><span class="p">:</span> <span class="kt"><a href="../Classes/SUAppcastItem.html">SUAppcastItem</a></span><span class="p">,</span> <span class="nv">updateCheck</span><span class="p">:</span> <span class="kt"><a href="../Enums/SPUUpdateCheck.html">SPUUpdateCheck</a></span><span class="p">)</span> <span class="k">throws</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>updater</em>
</code>
</td>
<td>
<div>
<p>The updater instance.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>updateItem</em>
</code>
</td>
<td>
<div>
<p>The selected update item to proceed with.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>updateCheck</em>
</code>
</td>
<td>
<div>
<p>The type of update check that would be performed if proceeded.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>error</em>
</code>
</td>
<td>
<div>
<p>An error object that must be populated by the delegate if the updater should not proceed with the update. The <code>NSLocalizedDescriptionKey</code> user info key should be populated indicating a description of the error.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p><code>YES</code> if the updater should proceed with <code>updateItem,</code> otherwise <code>NO</code> if the updater should not proceed with the update with an <code>error</code> populated.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(pl)SPUUpdaterDelegate(im)updater:userDidMakeChoice:forUpdate:state:"></a>
<a name="//apple_ref/objc/Method/-updater:userDidMakeChoice:forUpdate:state:" class="dashAnchor"></a>
<a class="token" href="#/c:objc(pl)SPUUpdaterDelegate(im)updater:userDidMakeChoice:forUpdate:state:">-updater:<wbr>userDidMakeChoice:<wbr>forUpdate:<wbr>state:<wbr></a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Called when a user makes a choice to install, dismiss, or skip an update.</p>
<p>If the <code>choice</code> is <code>SPUUserUpdateChoiceDismiss</code> and <code>state.stage</code> is <code>SPUUserUpdateStageDownloaded</code> the downloaded update is kept
around until the next time Sparkle reminds the user of the update.</p>
<p>If the <code>choice</code> is <code>SPUUserUpdateChoiceDismiss</code> and <code>state.stage</code> is <code>SPUUserUpdateStageInstalling</code> the update is still set to install on application termination.</p>
<p>If the <code>choice</code> is <code>SPUUserUpdateChoiceSkip</code> the user will not be reminded in the future for this update unless they initiate an update check themselves.</p>
<p>If <code>updateItem.isInformationOnlyUpdate</code> is <code>YES</code> the <code>choice</code> cannot be <code>SPUUserUpdateChoiceInstall</code>.</p>
</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">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">updater</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">updater</span>
<span class="nf">userDidMakeChoice</span><span class="p">:(</span><span class="n"><a href="../Enums/SPUUserUpdateChoice.html">SPUUserUpdateChoice</a></span><span class="p">)</span><span class="nv">choice</span>
<span class="nf">forUpdate</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SUAppcastItem.html">SUAppcastItem</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">updateItem</span>
<span class="nf">state</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SPUUserUpdateState.html">SPUUserUpdateState</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">state</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">optional</span> <span class="kd">func</span> <span class="nf">updater</span><span class="p">(</span><span class="n">_</span> <span class="nv">updater</span><span class="p">:</span> <span class="kt"><a href="../Classes/SPUUpdater.html">SPUUpdater</a></span><span class="p">,</span> <span class="n">userDidMake</span> <span class="nv">choice</span><span class="p">:</span> <span class="kt"><a href="../Enums/SPUUserUpdateChoice.html">SPUUserUpdateChoice</a></span><span class="p">,</span> <span class="n">forUpdate</span> <span class="nv">updateItem</span><span class="p">:</span> <span class="kt"><a href="../Classes/SUAppcastItem.html">SUAppcastItem</a></span><span class="p">,</span> <span class="nv">state</span><span class="p">:</span> <span class="kt"><a href="../Classes/SPUUserUpdateState.html">SPUUserUpdateState</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>updater</em>
</code>
</td>
<td>
<div>
<p>The updater instance.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>choice</em>
</code>
</td>
<td>
<div>
<p>The choice (install, dismiss, or skip) the user made for this <code>updateItem</code></p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>updateItem</em>
</code>
</td>
<td>
<div>
<p>The appcast item corresponding to the update that the user made a choice on.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>state</em>
</code>
</td>
<td>
<div>
<p>The current state for the update which includes if the update has already been downloaded or already installing.</p>
</div>
</td>
</tr>
</tbody>