action.skip

FlotiqPluginInfo

class FlotiqPluginInfo

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 required both during development and in plugin-manifest.json
name string Plugin display name. This information is required both during development and in plugin-manifest.json
version string Plugin version. This information is required in plugin-manifest.json.
It can be omitted when registering plugin with FlotiqPlugins.add during development.
url string Plugin URL. This information is required 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)
PluginPermission[] List of permissions that plugin requires

class PluginPermission

Permission type. Can be either 'CO' or 'CTD'

Properties

Name Type Description
type "CO"|"CTD" Permission type. Can be either 'CO' or 'CTD'
ctdName string Name of content type permission applies to. '*' means all content types
canRead boolean Whether plugin can read content of given type
canCreate boolean Whether plugin can write content of given type
canUpdate boolean Whether plugin can update content of given type
canDelete boolean Whether plugin can delete content of given type