PluginAction
class flow_api.plugin_action.PluginAction(select=None, cls=None, init=None, by='name', allow_normal=True, allow_deleted=False, color=[class 'flow_api.system.NotSet'], description=[class 'flow_api.system.NotSet'], flow_id=[class 'flow_api.system.NotSet'], icon=[class 'flow_api.system.NotSet'], is_enabled=[class 'flow_api.system.NotSet'], name=[class 'flow_api.system.NotSet'], parent_plugin_action_id=[class 'flow_api.system.NotSet'], plugin_id=[class 'flow_api.system.NotSet'], record_filter=[class 'flow_api.system.NotSet'], record_type=[class 'flow_api.system.NotSet'], type=[class 'flow_api.system.NotSet'], debug=False)
Base class: Row
A PluginAction creates an Execution of a Flow. The id of the Resource where the PluginAction originates from, is passed to the Execution as an input value.
Parameters
| Name | Type | Description |
|---|---|---|
| allow_deleted | bool | |
| allow_normal | bool | |
| by | str | |
| cls | typing.Union[ type, NoneType ] | |
| color | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The color of of the button of the plugin_action. |
| debug | bool | if set, the content of the data being written will be logged. |
| description | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The description of the plugin_action. |
| flow_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The id of the flow that is started by the plugin_action. |
| icon | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The icon of the button of the plugin_action. |
| init | typing.Union[ dict, NoneType ] | |
| is_enabled | typing.Union[ flow_api.system.NotSet, bool, NoneType ] | A flag to control if the plugin_action is enabled. |
| name | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The name of the plugin_action. |
| parent_plugin_action_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | Reference to the parent_plugin_action. The parent_plugin_action must reference the same plugin as the child. |
| plugin_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | Reference to the plugin this plugin_action belongs to. |
| record_filter | typing.Union[ flow_api.system.NotSet, dict ] | A filter to limit the records for which the action is displayed. |
| record_type | typing.Union[ flow_api.system.NotSet, str, NoneType ] | Which record types the plugin_action is available for. |
| select | typing.Union[ str, NoneType ] | |
| type | typing.Union[ flow_api.system.NotSet, str, NoneType ] | Controls whether this plugin_action is available for single records or for a list of records. |