Realtime

import 'package:nexus_flutter/nexus.dart';

NexusEventHandlerCopy Anchor Link

typedef NexusEventHandler = void Function(dynamic data)

NexusRealtimeCopy Anchor Link

Realtime messaging over Socket.IO. Authenticates with the API key + the current journey identity, so realtime connections join the same session.

isConnectedCopy Anchor Link

bool get isConnected

isActiveCopy Anchor Link

bool get isActive

Whether a socket exists (connected, or connecting/reconnecting) — i.e. the app wants realtime up, even if the link is momentarily down.

connect()Copy Anchor Link

void connect()

Open the connection (idempotent). Rooms are re-joined after a reconnect.

join()Copy Anchor Link

Future<dynamic> join(String room)

Join a room (first/created on the server). Re-joined automatically on reconnect. Returns the server's acknowledgement ({ ok, room, related }).

Parameters

Returns Future<dynamic>

leave()Copy Anchor Link

Future<dynamic> leave(String room)

Leave a room. Returns the server's acknowledgement ({ ok }).

Parameters

Returns Future<dynamic>

emit()Copy Anchor Link

Future<dynamic> emit(String room, dynamic event, [Object? payload])

Emit one or more named events to a room with a payload. Returns the server's acknowledgement ({ ok, room, recipients, related } or { error }), which is also logged.

Parameters

Returns Future<dynamic>

on()Copy Anchor Link

void on(String event, NexusEventHandler handler)

Listen for a server event. Persisted, so it survives (re)connects and works even if called before the socket is open.

Parameters

off()Copy Anchor Link

void off(String event)

Stop listening for a server event.

Parameters

disconnect()Copy Anchor Link

void disconnect()