Frameworks/Sparkle.framework/Versions/A/Headers/SUUpdater.h
author Thijs Alkemade <me@thijsalkema.de>
Sun, 23 Apr 2017 21:05:16 +0200
branchadium-1.5.10.4
changeset 5985 5883c460b8cb
parent 5924 f0f2d246891c
permissions -rw-r--r--
Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
4225
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
     1
//
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
     2
//  SUUpdater.h
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
     3
//  Sparkle
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
     4
//
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
     5
//  Created by Andy Matuschak on 1/4/06.
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
     6
//  Copyright 2006 Andy Matuschak. All rights reserved.
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
     7
//
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
     8
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
     9
#ifndef SUUPDATER_H
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
    10
#define SUUPDATER_H
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
    11
5985
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    12
#if __has_feature(modules)
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    13
@import Cocoa;
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    14
#else
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    15
#import <Cocoa/Cocoa.h>
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    16
#endif
5924
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    17
#import "SUExport.h"
4225
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
    18
#import "SUVersionComparisonProtocol.h"
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
    19
#import "SUVersionDisplayProtocol.h"
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
    20
5985
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    21
@class SUAppcastItem, SUAppcast;
4225
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
    22
5924
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    23
@protocol SUUpdaterDelegate;
4225
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
    24
5924
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    25
/*!
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    26
    The main API in Sparkle for controlling the update mechanism.
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    27
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    28
    This class is used to configure the update paramters as well as manually
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    29
    and automatically schedule and control checks for updates.
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    30
 */
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    31
SU_EXPORT @interface SUUpdater : NSObject
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    32
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    33
@property (unsafe_unretained) IBOutlet id<SUUpdaterDelegate> delegate;
4225
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
    34
5985
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    35
/*!
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    36
 The shared updater for the main bundle.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    37
 
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    38
 This is equivalent to passing [NSBundle mainBundle] to SUUpdater::updaterForBundle:
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    39
 */
4225
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
    40
+ (SUUpdater *)sharedUpdater;
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
    41
5924
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    42
/*!
5985
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    43
 The shared updater for a specified bundle.
5924
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    44
5985
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    45
 If an updater has already been initialized for the provided bundle, that shared instance will be returned.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    46
 */
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    47
+ (SUUpdater *)updaterForBundle:(NSBundle *)bundle;
5924
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    48
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    49
/*!
5985
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    50
 Designated initializer for SUUpdater.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    51
 
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    52
 If an updater has already been initialized for the provided bundle, that shared instance will be returned.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    53
 */
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    54
- (instancetype)initForBundle:(NSBundle *)bundle;
5924
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    55
5985
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    56
/*!
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    57
 Explicitly checks for updates and displays a progress dialog while doing so.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    58
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    59
 This method is meant for a main menu item.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    60
 Connect any menu item to this action in Interface Builder,
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    61
 and Sparkle will check for updates and report back its findings verbosely
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    62
 when it is invoked.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    63
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    64
 This will find updates that the user has opted into skipping.
5924
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    65
 */
4225
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
    66
- (IBAction)checkForUpdates:(id)sender;
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
    67
5924
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    68
/*!
5985
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    69
 The menu item validation used for the -checkForUpdates: action
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    70
 */
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    71
- (BOOL)validateMenuItem:(NSMenuItem *)menuItem;
5924
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    72
5985
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    73
/*!
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    74
 Checks for updates, but does not display any UI unless an update is found.
5924
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    75
5985
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    76
 This is meant for programmatically initating a check for updates. That is,
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    77
 it will display no UI unless it actually finds an update, in which case it
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    78
 proceeds as usual.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    79
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    80
 If automatic downloading of updates it turned on and allowed, however,
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    81
 this will invoke that behavior, and if an update is found, it will be downloaded
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    82
 in the background silently and will be prepped for installation.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    83
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    84
 This will not find updates that the user has opted into skipping.
5924
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    85
 */
4225
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
    86
- (void)checkForUpdatesInBackground;
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
    87
5924
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
    88
/*!
5985
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    89
 A property indicating whether or not to check for updates automatically.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    90
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    91
 Setting this property will persist in the host bundle's user defaults.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    92
 The update schedule cycle will be reset in a short delay after the property's new value is set.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    93
 This is to allow reverting this property without kicking off a schedule change immediately
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    94
 */
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    95
@property BOOL automaticallyChecksForUpdates;
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    96
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    97
/*!
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    98
 A property indicating whether or not updates can be automatically downloaded in the background.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
    99
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   100
 Note that automatic downloading of updates can be disallowed by the developer
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   101
 or by the user's system if silent updates cannot be done (eg: if they require authentication).
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   102
 In this case, -automaticallyDownloadsUpdates will return NO regardless of how this property is set.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   103
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   104
 Setting this property will persist in the host bundle's user defaults.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   105
 */
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   106
@property BOOL automaticallyDownloadsUpdates;
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   107
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   108
/*!
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   109
 A property indicating the current automatic update check interval.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   110
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   111
 Setting this property will persist in the host bundle's user defaults.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   112
 The update schedule cycle will be reset in a short delay after the property's new value is set.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   113
 This is to allow reverting this property without kicking off a schedule change immediately
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   114
 */
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   115
@property NSTimeInterval updateCheckInterval;
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   116
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   117
/*!
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   118
 Begins a "probing" check for updates which will not actually offer to
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   119
 update to that version.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   120
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   121
 However, the delegate methods
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   122
 SUUpdaterDelegate::updater:didFindValidUpdate: and
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   123
 SUUpdaterDelegate::updaterDidNotFindUpdate: will be called,
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   124
 so you can use that information in your UI.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   125
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   126
 Updates that have been skipped by the user will not be found.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   127
 */
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   128
- (void)checkForUpdateInformation;
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   129
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   130
/*!
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   131
 The URL of the appcast used to download update information.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   132
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   133
 Setting this property will persist in the host bundle's user defaults.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   134
 If you don't want persistence, you may want to consider instead implementing
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   135
 SUUpdaterDelegate::feedURLStringForUpdater: or SUUpdaterDelegate::feedParametersForUpdater:sendingSystemProfile:
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   136
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   137
 This property must be called on the main thread.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   138
 */
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   139
@property (copy) NSURL *feedURL;
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   140
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   141
/*!
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   142
 The host bundle that is being updated.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   143
 */
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   144
@property (readonly, strong) NSBundle *hostBundle;
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   145
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   146
/*!
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   147
 The bundle this class (SUUpdater) is loaded into.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   148
 */
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   149
@property (strong, readonly) NSBundle *sparkleBundle;
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   150
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   151
/*!
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   152
 The user agent used when checking for updates.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   153
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   154
 The default implementation can be overrided.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   155
 */
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   156
@property (nonatomic, copy) NSString *userAgentString;
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   157
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   158
/*!
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   159
 The HTTP headers used when checking for updates.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   160
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   161
 The keys of this dictionary are HTTP header fields (NSString) and values are corresponding values (NSString)
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   162
 */
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   163
#if __has_feature(objc_generics)
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   164
@property (copy) NSDictionary<NSString *, NSString *> *httpHeaders;
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   165
#else
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   166
@property (copy) NSDictionary *httpHeaders;
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   167
#endif
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   168
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   169
/*!
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   170
 A property indicating whether or not the user's system profile information is sent when checking for updates.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   171
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   172
 Setting this property will persist in the host bundle's user defaults.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   173
 */
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   174
@property BOOL sendsSystemProfile;
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   175
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   176
/*!
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   177
 A property indicating the decryption password used for extracting updates shipped as Apple Disk Images (dmg)
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   178
 */
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   179
@property (nonatomic, copy) NSString *decryptionPassword;
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   180
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   181
/*!
5924
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   182
    Checks for updates and, if available, immediately downloads and installs them.
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   183
    A progress dialog is shown but the user will never be prompted to read the
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   184
    release notes.
5985
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   185
5924
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   186
    You may want to respond to the userDidCancelDownload delegate method in case
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   187
    the user clicks the "Cancel" button while the update is downloading.
5985
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   188
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   189
    If you are writing a UI-less background application, you probably want to instead use
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   190
    SUUpdaterDelegate::updater:willInstallUpdateOnQuit:immediateInstallationInvocation:
5924
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   191
 */
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   192
- (void)installUpdatesIfAvailable;
4225
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
   193
5924
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   194
/*!
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   195
    Returns the date of last update check.
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   196
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   197
    \returns \c nil if no check has been performed.
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   198
 */
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   199
@property (readonly, copy) NSDate *lastUpdateCheckDate;
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   200
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   201
/*!
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   202
    Appropriately schedules or cancels the update checking timer according to
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   203
    the preferences for time interval and automatic checks.
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   204
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   205
    This call does not change the date of the next check,
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   206
    but only the internal NSTimer.
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   207
 */
4225
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
   208
- (void)resetUpdateCycle;
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
   209
5985
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   210
/*!
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   211
   A property indicating whether or not an update is in progress.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   212
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   213
   Note this property is not indicative of whether or not user initiated updates can be performed.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   214
   Use SUUpdater::validateMenuItem: for that instead.
5883c460b8cb Updated Sparkle to 1.17.0, to fix a problem when copying broken symlinks.
Thijs Alkemade <me@thijsalkema.de>
parents: 5924
diff changeset
   215
 */
5924
f0f2d246891c Updated Sparkle to 1.13.1.
Thijs Alkemade <me@thijsalkema.de>
parents: 4418
diff changeset
   216
@property (readonly) BOOL updateInProgress;
4225
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
   217
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
   218
@end
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
   219
83cf5cf606e5 It seems I was missing a 'couple' of files...
Thijs Alkemade <thijsalkemade@gmail.com>
parents:
diff changeset
   220
#endif