ControlCommandView class

Constructors

ControlCommandView({String? command, String? message, Object? payload, int? seq})

Returns a new ControlCommandView instance.

Properties

command ↔ String?

Command is what was asked, from a closed four: pause, resume, stop, message. It is an INTENT — the poller decides what to do about it, and the session's status changes only when the poller reports back that it did.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, override

message ↔ String?

Message is the text that came with the command: what to say into the run for message, and the cancellation reason for stop. Up to 16 KiB. Empty on a bare pause or resume.

getter/setter pair

payload ↔ Object?

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

seq ↔ int?

Seq is this command's position in the session's log — the same monotonic number every other turn is ordered by, so a command sits in the transcript where it was issued. Send the highest one you applied back as after and it is never redelivered.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override

Static Methods

fromJson(dynamic value) → ControlCommandView?

Returns a new ControlCommandView instance and imports its values from value if it's a Map, null otherwise.

listFromJson(dynamic json, {bool growable = false}) → List<ControlCommandView>

mapFromJson(dynamic json) → Map<String, ControlCommandView>

mapListFromJson(dynamic json, {bool growable = false}) → Map<String, List<ControlCommandView>>

Constants

requiredKeys → const Set<String>

The list of required keys that must be present in a JSON.