SocketIOClient class
Class for functionality of SocketIO operations
- Inheritance
-
- Object
- RenovationController
- SocketIOClient
Constructors
- SocketIOClient(RenovationConfig config)
Properties
- config → RenovationConfig
-
finalinherited
- getSocket → Socket?
-
Gets the reference of the socket in the class
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- isConnected → bool
-
Returns whether the socket is connected.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
clearCache(
) → void -
Clears the cache. Currently empty method
override
-
connect(
{String? url, String? path, bool requiresAuthorization = true}) → void - Connect to the socket endpoint in the server.
-
disconnect(
) → void -
Disconnects (if any) the socket and set
_socketto the instance itself. -
emit(
String event, {dynamic data}) → bool -
Emits the event with payload
dataoptionally. -
getCore(
) → Renovation -
Gets the reference to the Renovation instance
inherited
-
getHostUrl(
) → String -
Returns the configured host URL towards the backend
inherited
-
handleError(
String errorId, ErrorDetail error) → ErrorDetail -
Returns the
ErrorDetailafter manipulating an existing one. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
off(
String event, {SocketIOHandler? handler}) → void - Unsubscribe from the event if the socket isConnected.
-
on(
String event, SocketIOHandler handler) → void -
Subscribe to an
eventif the socket isConnected. -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited