PluginInfo¶
class PluginInfo¶
A set of information required from plugin to register in Flotiq UI.
It also represents the structure of the plugin-manifest.json file, which is used
to add plugin permanently to the account, or to the Flotiq UI Plugins Registry (coming soon).
Properties
| Name | Type | Description |
|---|---|---|
id |
string |
unique plugin id. This information is requried both during development and in plugin-manifest.json |
name |
string |
plugin display name. This information is requried both during development and in plugin-manifest.json |
version |
string |
plugin version. This information is requried in plugin-manifest.json.It can be omitted when registering plugin with FlotiqPlugins.add during development. |
url |
string |
plugin version. This information is requried in plugin-manifest.json.It can be omitted when registering plugin with FlotiqPlugins.add during development. |
description (optional) |
string |
plugin description |
repository (optional) |
string |
url to source code repository |
permissions (optional) |
Array.<PluginPermission> |
list of permissions that plugin requires |
class PluginPermission¶
Properties
| Name | Type | Description |
|---|---|---|
type |
'CO'|'CTD' |
permission type. Can be either 'CO' or 'CTD' |
canRead |
boolean |
whether plugin can read content of given type |
canWrite |
boolean |
whether plugin can write content of given type |
canCreate |
boolean |
whether plugin can create content of given type |
canDelete |
boolean |
whether plugin can delete content of given type |
ctdName |
string |
Name of content type permission applies to. '*' means all content types |