Skip to main content
Version: 10 - TBD

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

NameTypeDescription
allow_deletedbool
allow_normalbool
bystr
clstyping.Union[ type, NoneType ]
colortyping.Union[ flow_api.system.NotSet, str, NoneType ]The color of of the button of the plugin_action.
debugboolif set, the content of the data being written will be logged.
descriptiontyping.Union[ flow_api.system.NotSet, str, NoneType ]The description of the plugin_action.
flow_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]The id of the flow that is started by the plugin_action.
icontyping.Union[ flow_api.system.NotSet, str, NoneType ]The icon of the button of the plugin_action.
inittyping.Union[ dict, NoneType ]
is_enabledtyping.Union[ flow_api.system.NotSet, bool, NoneType ]A flag to control if the plugin_action is enabled.
nametyping.Union[ flow_api.system.NotSet, str, NoneType ]The name of the plugin_action.
parent_plugin_action_idtyping.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_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]Reference to the plugin this plugin_action belongs to.
record_filtertyping.Union[ flow_api.system.NotSet, dict ]A filter to limit the records for which the action is displayed.
record_typetyping.Union[ flow_api.system.NotSet, str, NoneType ]Which record types the plugin_action is available for.
selecttyping.Union[ str, NoneType ]
typetyping.Union[ flow_api.system.NotSet, str, NoneType ]Controls whether this plugin_action is available for single records or for a list of records.

Constants

RESOURCE = plugin_action

Methods

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