CarpenterCommand<I> class abstract interface

Typed application command contract shared by buttons, shortcuts, and policy.

Implementations own business execution and observable availability. Carpenter surfaces only project this contract and do not own domain state.

Implementers
Available extensions

Properties

androidShortcuts → List<ShortcutActivator>?
Android-specific shortcut override, or null to use shortcuts.
no setter
description → String?
Optional longer description of the command's intent.
no setter
effects → List<CarpenterCommandEffect>
Semantic application effects declared independently of concrete execution results.
no setter
fuchsiaShortcuts → List<ShortcutActivator>?
Fuchsia-specific shortcut override, or null to use shortcuts.
no setter
group → String
Logical command group used by command discovery and organization.
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → String
Stable semantic identifier used for lookup and execution events.
no setter
iOSShortcuts → List<ShortcutActivator>?
iOS-specific shortcut override, or null to fall back to Apple/default shortcuts.
no setter
linuxShortcuts → List<ShortcutActivator>?
Linux-specific shortcut override, or null to use shortcuts.
no setter
macOSShortcuts → List<ShortcutActivator>?
macOS-specific shortcut override, or null to use shortcuts.
no setter
presentation → CarpenterCommandPresentation
Semantic prominence requested when this command is rendered as an action.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shortcuts → List<ShortcutActivator>
Default shortcut activators used when no platform-specific override exists.
no setter
state → ValueListenable<CarpenterCommandState>
Observable command availability, execution phase, and latest failure.
no setter
title → String
Human-readable action title used by default presentation surfaces.
no setter
windowsShortcuts → List<ShortcutActivator>?
Windows-specific shortcut override, or null to use shortcuts.
no setter

Methods

execute(I input) → Future<CarpenterCommandResult>
Executes the command for input, returning a semantic success result or propagating the original failure.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
shortcutsFor(TargetPlatform platform) → List<ShortcutActivator>

Available on CarpenterCommand, provided by the CarpenterCommandPlatformShortcuts extension

Selects the most specific shortcut list for platform; Apple platforms additionally normalize control modifiers to command/meta semantics.
toAction(I input, {String? label, String? semanticLabel, CarpenterIconSource? icon, ActionColorRole? colorRole, ShortcutActivator? shortcut, CarpenterCommandExecutor? executor}) → CarpenterActionDescriptor

Available on CarpenterCommand<I>, provided by the CarpenterCommandActionProjection extension

Creates a presentation-only action snapshot for input from the command's current visibility, availability, execution state, shortcuts, and semantic prominence.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited