Skip to main content
Version: 11 - TBD

PluginAction

class flow_api.plugin_action.PluginAction(select=None, cls=None, init=None, by='name', allow_normal=True, allow_deleted=False, commit=False, color=<class 'flow_api.system.NotSet'>, description=<class 'flow_api.system.NotSet'>, execution_location=<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

NameTypeDescription
allow_deletedbool
allow_normalbool
bystr
clstyping.Union[ type, NoneType ]
colortyping.Union[ flow_api.system.NotSet, str, NoneType ]
commitbool
debugbool
descriptiontyping.Union[ flow_api.system.NotSet, str, NoneType ]
execution_locationtyping.Union[ flow_api.system.NotSet, str, NoneType ]
flow_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]
icontyping.Union[ flow_api.system.NotSet, str, NoneType ]
inittyping.Union[ dict, NoneType ]
is_enabledtyping.Union[ flow_api.system.NotSet, bool, NoneType ]
nametyping.Union[ flow_api.system.NotSet, str, NoneType ]
parent_plugin_action_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]
plugin_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]
record_filtertyping.Union[ flow_api.system.NotSet, typing.Any ]
record_typetyping.Union[ flow_api.system.NotSet, str, NoneType ]
selecttyping.Union[ str, NoneType ]
typetyping.Union[ flow_api.system.NotSet, str, NoneType ]

Constants

RESOURCE = plugin_action

Methods

add_execution

add_plugin_action_parent_plugin_action_id

clone

delete

execution_list

exists

export

flow

get

get_dict

parent_plugin_action_id_plugin_action

plugin

plugin_action_list_parent_plugin_action_id

restore

save