ActionParameter class
One argument of a PluginAction.
Constructors
-
ActionParameter(String id, String label, {ActionParameterKind kind = ActionParameterKind.string, bool required = true, String? description, String? defaultValue, List<
ActionOption> options = const [], String? optionsFrom, bool repeatable = false}) -
const
Properties
- defaultValue → String?
-
Used when the caller omits the argument. Always in string form; the
plugin parses it according to kind.
final
- description → String?
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
Stable within the action — the key in the argument map, and the flag name
fwexposes.final - kind → ActionParameterKind
-
final
- label → String
-
final
-
options
→ List<
ActionOption> -
The legal values when kind is ActionParameterKind.choice and the set
is small enough to spell out.
final
- optionsFrom → String?
-
Where the legal values live when there are too many to inline, or they
change as the plugin works — a path into the report, such as
childrenorview.final - repeatable → bool
-
Whether the parameter takes several values, comma-separated — which is
what lets
fwaccept the flag more than once and join them. A flag repeated for any other parameter is refused rather than silently taking the last one, or worse, the join.final - required → bool
-
final
- 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) → ActionParameter