PatchbayClient class abstract interface

One open connection to a running App, whatever transport reached it.

Every method answers with the decoded Patchbay response document; nothing here classifies a response into a verdict — that belongs to the caller, and to the CLI's exit codes.

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

catalog() Future<Map<String, Object?>>
close() Future<void>
focusTree() Future<Map<String, Object?>>
identity() Future<Map<String, Object?>>
invoke({required String command, required Map<String, Object?> arguments, String? requestId, Duration? deadline}) Future<Map<String, Object?>>
deadline is how long the caller intends to wait for a long-poll command. Transports that cannot be torn down by one slow request may ignore it.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
renderTree() Future<Map<String, Object?>>
snapshot({PatchbaySnapshotRequest? request}) Future<Map<String, Object?>>
request selects one field and may ask the App to wait for a condition on it. Passing none reads the whole snapshot, as it always did.
toString() String
A string representation of this object.
inherited
widgetTree() Future<Map<String, Object?>>

Operators

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