RemoteViewerController class

Connects to a shared app through the relay server and exposes its screen, logs and an input channel back to it.

Inheritance

Constructors

RemoteViewerController({int logLimit = 2000, RemoteFontCache? fontCache})
fontCache keeps fonts between sessions; see RemoteFontCache.

Properties

deviceInfo → Map<String, Object?>
What the app reported on joining: protocol, platform and devicePixelRatio.
no setter
error → String?
Why the connection closed or failed, if it did.
no setter
frame → RemoteFrame?
The latest frame, or null before the app's screen arrives.
no setter
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
logLimit → int
Oldest log entries are dropped beyond this many.
final
logRevision → ValueNotifier<int>
Incremented whenever the log list changes, cheap to compare in widgets.
final
logs → List<RemoteLog>
The app's logs and errors, oldest first.
no setter
resources → RemoteResources
Images, styles and fonts sent by the host.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status → RemoteViewerStatus
no setter

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
clearLogs() → void
Empties logs.
connect({required Uri server, required String code}) → Future<void>
Joins the session with code on the relay at server, for example wss://support.example.com.
disconnect() → Future<void>
Leaves the session and forgets its screen.
dispose() → void
Discards any resources used by the object.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
sendKey(int key) → void
Presses one of the RemoteKeys.
sendPointer(int phase, int pointer, Offset position) → void
position is in the app's logical coordinates.
sendScroll(Offset position, Offset delta) → void
Scrolls by delta at position, both in the app's logical pixels.
sendText(String text) → void
Types text into the focused text field of the app.
toString() → String
A string representation of this object.
inherited

Operators

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