BrowserWebSocketsService<Id, Data> class Null safety

Inheritance

Constructors

BrowserWebSocketsService(WebSocketChannel? socket, WebSockets app, String uri, {Type? type, AngelDeserializer<Data>? deserializer})

Properties

app BaseWebSocketClient
The BaseWebSocketClient that spawned this service.
final, inherited
deserializer AngelDeserializer<Data>?
Used to deserialize JSON into typed data.
final, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
onAllEvents Stream<WebSocketEvent>
Fired on all events.
read-only, inherited
onCreated Stream<Data?>
Fired on created events.
read-only, inherited
onIndexed Stream<List<Data?>>
Fired on index events.
read-only, inherited
onModified Stream<Data?>
Fired on modified events.
read-only, inherited
onRead Stream<Data?>
Fired on read events.
read-only, inherited
onRemoved Stream<Data?>
Fired on removed events.
read-only, inherited
onUpdated Stream<Data?>
Fired on updated events.
read-only, inherited
path String
The service path to listen to.
final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
socket WebSocketChannel?
The WebSocketChannel to listen to, and send data across.
final, inherited
type Type?
final

Methods

close() Future
inherited
create(Data? data, [Map<String, dynamic>? params]) Future<Data?>
Creates a resource.
inherited
deserialize(dynamic x) → Data?
Deserializes data from a WebSocketEvent.
inherited
index([Map<String, dynamic>? params]) Future<List<Data>?>
Retrieves all resources.
inherited
listen() → void
Starts listening for events.
inherited
map<U>(U encoder(Data?), Data? decoder(U)) Service<Id, U>
Creates a Service that wraps over this one, and maps input and output using two converter functions. [...]
inherited
modify(Id id, Data? data, [Map<String, dynamic>? params]) Future<Data?>
Modifies a resource.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
read(Id id, [Map<String, dynamic>? params]) Future<Data?>
Retrieves the desired resource.
inherited
remove(Id id, [Map<String, dynamic>? params]) Future<Data?>
Removes the given resource.
inherited
send(WebSocketAction action) → void
Sends the given action on the socket.
inherited
serialize(WebSocketAction action) → dynamic
Serializes an action to be sent over a WebSocket.
inherited
toString() String
A string representation of this object. [...]
inherited
transformEvent(WebSocketEvent event) WebSocketEvent<Data>
Deserializes the contents of an event.
inherited
unwrap() Service
No longer necessary.
inherited
update(Id id, Data? data, [Map<String, dynamic>? params]) Future<Data?>
Overwrites a resource.
inherited

Operators

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