SocketService class

Constructors

SocketService()
factory

Properties

currentRole SocketRole?
getter/setter pair
currentSessionId String?
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
isConnected bool
no setter
isControllerConnected bool
getter/setter pair
isViewerConnected bool
getter/setter pair
onActionReceived ↔ dynamic Function(Map<String, dynamic> action)?
Incoming action from remote controller.
getter/setter pair
onControllerConnected ↔ dynamic Function()?
Remote controller joined the session.
getter/setter pair
onControllerDisconnected ↔ dynamic Function()?
Remote controller left / disconnected. Fires on: server event OR presence-timer timeout.
getter/setter pair
onError ↔ dynamic Function(String)?
getter/setter pair
onImageReceived ↔ dynamic Function(Uint8List bytes, String type, Map<String, dynamic>? meta)?
getter/setter pair
onLog ↔ dynamic Function(String)?
getter/setter pair
onPairingRejected ↔ dynamic Function(String)?
getter/setter pair
onPairingSuccess ↔ dynamic Function()?
getter/setter pair
onSessionEnded ↔ dynamic Function()?
getter/setter pair
onViewerConnected ↔ dynamic Function()?
Kiosk (viewer) itself reconnected (after a temp drop).
getter/setter pair
onViewerDisconnected ↔ dynamic Function()?
Kiosk (viewer) temporarily disconnected (server tells the remote).
getter/setter pair
onWarning ↔ dynamic Function(String)?
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
socket → Socket?
no setter

Methods

connect({required String sessionId, required SocketRole role, String? clientId, dynamic onLog(String)?, dynamic onImageReceived(Uint8List, String, Map<String, dynamic>?)?, dynamic onControllerConnected()?, dynamic onControllerDisconnected()?, dynamic onViewerConnected()?, dynamic onViewerDisconnected()?, dynamic onPairingSuccess()?, dynamic onPairingRejected(String)?, dynamic onSessionEnded()?, dynamic onActionReceived(Map<String, dynamic>)?, dynamic onError(String)?, dynamic onWarning(String)?}) → void
disconnect() → void
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
sendAction(String type, {Map<String, dynamic>? payload}) → void
sendImage(Uint8List bytes, String type, {Map<String, dynamic>? meta}) → void
toString() String
A string representation of this object.
inherited

Operators

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