PluginAction class
Something a plugin can do, offered identically to a button, fw run, and
an agent.
The callback lives with the plugin's runtime; this is only the description, so it can be listed without running any plugin code.
Constructors
-
PluginAction(String id, String label, {String? description, bool danger = false, bool confirm = false, List<
ActionParameter> parameters = const [], Type? returns}) -
const
Properties
- confirm → bool
-
The GUI asks before running it.
final
- danger → bool
-
Destroys data. Renderers should make it visually distinct.
final
- description → String?
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
Stable within a plugin — what
fwand an agent name to invoke it.final - label → String
-
final
-
parameters
→ List<
ActionParameter> -
What the action needs to be told, if anything.
final
- returns → Type?
-
The PluginResult class this action hands back, when it hands back data.
final
- returnsName → String?
-
returns's name, which is what crosses the wire.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, Object?> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
fromJson(
Map< String, Object?> json) → PluginAction