Accessoryinfo section
/docs/development/reference-gears/manifest/accessoryinfo/
Accessories must provide this section in a UBOS Manifest. Here is an example:
"accessoryinfo" : {
"appid" : "wordpress",
"accessoryid" : "jetpack",
"accessorytype" : "plugin",
"requires" : [
"other-accessory"
]
}
appid
is the name of the package that contains the :term:App
to which this
Accessory belongs. In this example, the Accessory belongs to the
wordpress
App. This value is required.
accessoryid
and accessorytype
are optional fields. If they are given, they
identify the Accessory in the terminology of the App that the
Accessory belongs to. This often makes it easier for Accessory
activation and the like to perform the correct action, based on the type of Accessory.
For example, Wordpress Accessories can be plugins or themes. Their activation is different depending on their type. If the UBOS Manifest marks the Accessory with this type, as Wordpress understands it, a general-purpose activation script can perform different actions based on that type.
-
accessoryid
is the name of the Accessory as the App refers to it. This may or may not be the same as the Accessory’s Package name. For example, Wordpress may refer to a plugin as “jetpack”, while the UBOS Package for the plugin iswordpress-plugin-jetpack
. The domain of this value depends on the App. -
accessorytype
is the type of Accessory that this is. For example, Wordpress distinguishes between plugins and themes. The domain of this value depends on the App. -
requires
is an optional array of other Accessory names. If it is given, this Accessory can only be used successfully for a given AppConfiguration, if the listed other Accessories have also been deployed at the same AppConfiguration.