Optional
addAddons can be added to other content types by
Optional
content?: { types?: { text?: { regex?: string } }[] }Optional
editor?: { machineNames: string[] }Contains cases in which the library should be added to the editor.
This is an extension to the H5P library metadata structure made by h5p-nodejs-library. That way addons can specify to which editors they should be added in general. The PHP implementation hard-codes this list into the server, which we want to avoid here.
A list of machine names in which the addon should be added.
Optional
player?: { machineNames: string[] }Contains cases in which the library should be added to the player.
This is an extension to the H5P library metadata structure made by h5p-nodejs-library. That way addons can specify to which editors they should be added in general. The PHP implementation hard-codes this list into the server, which we want to avoid here.
A list of machine names in which the addon should be added.
Optional
authorOptional
coreThe core API required to run the library.
Optional
descriptionOptional
dropOptional
dynamicOptional
editorOptional
embedOptional
fullscreenOptional
hOptional
licenseThe name used to identify the library (e.g. H5P.Example)
The major version of the library (e.g. 1)
Optional
metadataThe minor version of the library (e.g. 0)
Optional
preloadedOptional
preloadedOptional
preloadedOptional
requiredIf set to true, the library can only be used be users who have this special privilege.
Optional
stateOptional
wCompares libraries by giving precedence to title, then major version, then minor version
Compares libraries by giving precedence to major version, then minor version, then if present patch version.
a negative value: if this library is older than the other library a positive value: if this library is newer than the other library zero: if both libraries are the same (or if it can't be determined, because the patch version is missing in the other library)
Objects of this interface represent installed libraries that have an id.