CockpitCommandResult class final

Constructors

CockpitCommandResult({required bool success, required String commandId, required CockpitCommandType commandType, CockpitLocatorResolution? locatorResolution, required int durationMs, List<CockpitArtifactRef> artifacts = const <CockpitArtifactRef>[], Map<String, Object?>? snapshot, CockpitCaptureProfile? requestedCaptureProfile, CockpitCaptureKind? resolvedCaptureKind, bool usedCaptureFallback = false, String? degradationReason, Map<String, Object?>? surface, Map<String, Object?>? appState, Map<String, Object?>? actionResult, bool? changed, CockpitCommandError? error})

Creates a CockpitCommandResult.

CockpitCommandResult.fromJson(Map<String, Object?> json, {String path = r'$'})

Decodes a CockpitCommandResult from a JSON object.

factory

Properties

actionResult → Map<String, Object?>?

Value returned by the app-registered handler of an appAction command. Null when the handler returns nothing; the payload is bounded and redacted before it leaves the app process.

final

appState → Map<String, Object?>?

App-authored state returned by describeApp commands. The application decides what to expose; the payload is bounded and redacted before it leaves the app process.

final

artifacts → List<CockpitArtifactRef>

final

changed → bool?

final

commandId → String

final

commandType → CockpitCommandType

final

degradationReason → String?

final

durationMs → int

final

error → CockpitCommandError?

final

hashCode → int

The hash code for this object.

no setter, override

locatorResolution → CockpitLocatorResolution?

final

requestedCaptureProfile → CockpitCaptureProfile?

final

resolvedCaptureKind → CockpitCaptureKind?

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

snapshot → Map<String, Object?>?

final

success → bool

final

surface → Map<String, Object?>?

final

usedCaptureFallback → bool

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, Object?>

Encodes this CockpitCommandResult as a JSON object.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

override