Platforms to show: All Mac Windows Linux Cross-Platform
Back to SUAppcastItemMBS class.
SUAppcastItemMBS.channel as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 22.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
An update item may specify a custom channel name (such as beta) that can only be found by updaters that filter for that channel.
If no channel is provided, the update item is assumed to be on the default channel.
This is extracted from the <sparkle:channel> element.
Old applications must be using Sparkle 2 or later to interpret the channel element and to ignore unmatched channels.
(Read only property)
SUAppcastItemMBS.ContentLength as Int64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 20.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read only property)
SUAppcastItemMBS.CriticalUpdate as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 16.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read only property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 8.6 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop, Console & Web |
(Read only property)
SUAppcastItemMBS.DateString as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 20.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read only property)
SUAppcastItemMBS.DateTime as DateTime
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 20.5 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read only property)
SUAppcastItemMBS.DeltaUpdate as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 16.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read only property)
SUAppcastItemMBS.DeltaUpdates as Dictionary
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 14.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read only property)
SUAppcastItemMBS.displayVersionString as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 8.6 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Maybe "1.1de"
(Read only property)
Some examples using this property:
SUAppcastItemMBS.fileURL as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 8.6 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read only property)
SUAppcastItemMBS.fullReleaseNotesURL as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 22.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The link should point to the product's full changelog.
Sparkle's standard user interface offers to show these full release notes when a user checks for a new update and no new update is available.
This is extracted from the <sparkle:fullReleaseNotesLink> element.
(Read only property)
SUAppcastItemMBS.Handle as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 8.6 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read and Write property)
SUAppcastItemMBS.ignoreSkippedUpgradesBelowVersion as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 22.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
This can only be applied if the update is a `majorUpgrade`.
This version string corresponds to the application's CFBundleVersion
This is extracted from the <sparkle:ignoreSkippedUpgradesBelowVersion> element.
Old applications must be using Sparkle 2.1 or later, otherwise this property will be ignored.
(Read only property)
SUAppcastItemMBS.InformationOnlyUpdate as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 16.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Only available in newer Sparkle in 64-bit.
For older version this is always false.
(Read only property)
SUAppcastItemMBS.InfoURL as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 14.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read only property)
SUAppcastItemMBS.installationType as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 22.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
This may be:
- application - indicates this is a regular application update.
- package - indicates this is a guided package installer update.
- interactive-package - indicates this is an interactive package installer update (deprecated; use "package" instead)
This is extracted from the sparkle:installationType attribute in the <enclosure> element.
If no installation type is provided in the enclosure, the installation type is inferred from the `fileURL` file extension instead.
If the file extension is pkg or mpkg, the installation type is package otherwise it is application
Hence, the installation type in the enclosure element only needs to be specified for package based updates distributed inside of a zip or other archive format.
Old applications must be using Sparkle 1.26 or later to support downloading bare package updates (`pkg` or `mpkg`) that are not additionally archived inside of a zip or other archive format.
(Read only property)
SUAppcastItemMBS.itemDescription as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 8.6 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read only property)
SUAppcastItemMBS.MacOsUpdate as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 20.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read only property)
SUAppcastItemMBS.majorUpgrade as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 22.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
An update is a major upgrade if the application's bundle version doesn't meet the `minimumAutoupdateVersion` requirement.
(Read only property)
SUAppcastItemMBS.maximumOperatingSystemVersionIsOK as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 22.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read only property)
SUAppcastItemMBS.MaximumSystemVersion as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 14.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The update will not be offered to users with newer system versions.
(Read only property)
SUAppcastItemMBS.minimumAutoupdateVersion as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 22.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
If an application's bundle version meets this version requirement, it can install the new update item in the background automatically.
Otherwise if the requirement is not met, the user is always prompted to install the update. In this case, the update is assumed to be a `majorUpgrade`.
If the update is a `majorUpgrade` and the update is skipped by the user, other future update alerts with the same `minimumAutoupdateVersion` will also be skipped automatically unless an update specifies `ignoreSkippedUpgradesBelowVersion`.
This version string corresponds to the application's CFBundleVersion
This is extracted from the <sparkle:minimumAutoupdateVersion> element.
(Read only property)
SUAppcastItemMBS.minimumOperatingSystemVersionIsOK as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 22.2 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read only property)
SUAppcastItemMBS.minimumSystemVersion as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 8.6 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
The update will not be offered to users with older system versions.
(Read only property)
SUAppcastItemMBS.OSString as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 20.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read only property)
SUAppcastItemMBS.phasedRolloutInterval as Variant
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 20.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
May be nil.
(Read only property)
SUAppcastItemMBS.propertiesDictionary as dictionary
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read only property)
SUAppcastItemMBS.releaseNotesURL as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 8.6 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read only property)
SUAppcastItemMBS.title as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 8.6 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read only property)
SUAppcastItemMBS.versionString as string
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Sparkle | MBS MacExtras Plugin | 8.6 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read only property)
The items on this page are in the following plugins: MBS MacExtras Plugin.
