SPUUpdaterSettings

Objective-C


@interface SPUUpdaterSettings : NSObject

Swift

@MainActor class SPUUpdaterSettings : NSObject

This class can be used for reading and updating updater settings.

It retrieves the settings by first looking into the host’s user defaults. If the setting is not found in there, then the host’s Info.plist file is looked at.

For updating updater settings, changes are made in the host’s user defaults.

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithHostBundle:(NSBundle *)hostBundle;

    Swift

    init(hostBundle: Bundle)

  • Indicates whether or not automatic update checks are enabled.

    This property is KVO compliant. This property must be called on the main thread.

    Declaration

    Objective-C

    @property (nonatomic) BOOL automaticallyChecksForUpdates;

    Swift

    var automaticallyChecksForUpdates: Bool { get set }

  • The regular update check interval.

    This property is KVO compliant. This property must be called on the main thread.

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval updateCheckInterval;

    Swift

    var updateCheckInterval: TimeInterval { get set }

  • Indicates whether or not automatically downloading updates is allowed to be turned on by the user.

    This property is determined by checking automaticallyChecksForUpdates and allowsAutomaticUpdatesOption.

    This property is KVO compliant. This property must be called on the main thread.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL allowsAutomaticUpdates;

    Swift

    var allowsAutomaticUpdates: Bool { get }

  • Indicates whether or not automatically downloading updates is enabled by the user or developer.

    Note this does not indicate whether or not automatic downloading of updates is allowable. See -allowsAutomaticUpdates property for that.

    This property is KVO compliant. This property must be called on the main thread.

    Declaration

    Objective-C

    @property (nonatomic) BOOL automaticallyDownloadsUpdates;

    Swift

    var automaticallyDownloadsUpdates: Bool { get set }

  • Indicates whether or not the developer allows turning on updates being automatically downloaded and installed. If this value is nil, the developer has not explicitly specified this option (which is the default).

    Please prefer to use allowsAutomaticUpdates instead.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *allowsAutomaticUpdatesOption;

    Swift

    var allowsAutomaticUpdatesOption: NSNumber? { get }

  • The impatient update check interval.

    If an update has already been downloaded automatically in the background, Sparkle may not notify users of the update immediately, and tries to install the update siliently on quit without notifying the user.

    Sparkle uses this long impatient update check interval to decide when to notify the user of the update if they haven’t quit the app for a long time. By default this check interval is set to 604800 seconds (which is 1 week). This interval must be bigger than the updateCheckInterval.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSTimeInterval impatientUpdateCheckInterval;

    Swift

    var impatientUpdateCheckInterval: TimeInterval { get }

  • Indicates whether or not anonymous system profile information is sent when checking for updates.

    This property is KVO compliant. This property must be called on the main thread.

    Declaration

    Objective-C

    @property (nonatomic) BOOL sendsSystemProfile;

    Swift

    var sendsSystemProfile: Bool { get set }