RealtimeIO class

Implemented types

• Realtime

Constructors

RealtimeIO(Client client)

Properties

client ↔ Client

getter/setter pair, inherited

closeCode → int?

no setter, inherited

getFallbackCookie ↔ GetFallbackCookie?

getter/setter pair, inherited

getWebSocket ↔ WebSocketFactory

getter/setter pair, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

disconnect() → Future<void>

Close the WebSocket connection and drop all active subscriptions client-side. Use this instead of calling RealtimeSubscription.unsubscribe on every subscription when you want to tear everything down.

inherited

handleError(RealtimeResponse response) → void

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

subscribe(List<Object> channels, {List<String> queries = const []}) → RealtimeSubscription

Subscribe

subscribeTo(List<Object> channels, [List<String> queries = const []]) → RealtimeSubscription

inherited

toString() → String

A string representation of this object.

inherited

upsertPresence({required String status, required String presenceId, List<String>? permissions, Map<String, dynamic>? metadata}) → void

Create or upsert a presence entry for the current authenticated user over the existing realtime connection.

upsertPresenceTo({required String status, required String presenceId, List<String>? permissions, Map<String, dynamic>? metadata}) → void

Fire-and-forget presence upsert. Records the latest payload in state so that — if the WebSocket isn't open yet, or later reconnects — the most recent presence is automatically (re)sent on the next connected event. When the socket is already open, the frame is sent immediately.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited