Specifies how to upgrade a set of existing add-ons to a new set of add-ons. An
object has the following characteristics:
- It has import data, a pre-import script, and a post-import script, and is installed using the same API method (
) as a normal add-on.ObjectStore.InstallAddOn - It identifies the old add-on version(s) (
property) and the new add-on version(s) (FromVersions
property).ToVersions - When an add-on has been successfully upgraded, the older version's
object is replaced with an installation record for the newer version.AddOnInstallationRecord - It can upgrade one or more add-ons of older versions to one or more add-ons of newer versions via a single
object. For example, when anUpgradeAddOn
object with aUpgradeAddOn
value of [A1, A2, A3] and aFromVersions
value of [A4, A5] is installed on an object store, theToVersions
objects for A1, A2, and A3 are removed and replaced withAddOnInstallationRecord
objects for A4 and A5.AddOnInstallationRecord
The following tables list the members exposed by IUpgradeAddOn.
Public Properties
Name | Description | |
---|---|---|
![]() |
FromVersions | Specifies a list of IDs that identify the add-on versions upgraded by an object. The list must contain one or more IDs (and will usually contain only one). |
![]() |
ToVersions | Specifies a list of IDs that identify the add-on versions logically produced as a result of applying this object. The list must contain one or more IDs (and will usually contain only one). |