RealtimeChannel class

Constructors

RealtimeChannel(String topic, RealtimeClient socket, {RealtimeChannelConfig params = const RealtimeChannelConfig()})

Properties

canPush → bool

Returns true if the socket is connected and the channel has been joined.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

presence ↔ RealtimePresence

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

httpSend({required String event, required Object payload, Duration? timeout}) → Future<void>

Sends a broadcast message explicitly via REST API.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onBroadcast({required String event, required void callback(Map<String, dynamic> payload)}) → RealtimeChannel

Sets up a listener for realtime broadcast messages.

onPostgresChanges({required PostgresChangeEvent event, String? schema, String? table, PostgresChangeFilter? filter, List<PostgresChangeFilter>? filters, List<String>? select, required void callback(PostgresChangePayload payload)}) → RealtimeChannel

Sets up a listener on your Supabase database.

onPresenceJoin(void callback(RealtimePresenceJoinPayload payload)) → RealtimeChannel

Sets up a listener for realtime presence join event.

onPresenceLeave(void callback(RealtimePresenceLeavePayload payload)) → RealtimeChannel

Sets up a listener for realtime presence leave event.

onPresenceSync(void callback(RealtimePresenceSyncPayload payload)) → RealtimeChannel

Sets up a listener for realtime presence sync event.

onSystemEvents(void callback(dynamic payload)) → RealtimeChannel

Sets up a listener for realtime system events.

presenceState() → List<SinglePresenceState>

sendBroadcastMessage({required String event, required Map<String, dynamic> payload}) → Future<ChannelResponse>

Sends a realtime broadcast message.

subscribe([void callback(RealtimeSubscribeStatus status, Object? error)?, Duration? timeout]) → RealtimeChannel

Subscribes to receive real-time changes

toString() → String

A string representation of this object.

inherited

track(Map<String, dynamic> payload, [Map<String, dynamic> opts = const {}]) → Future<ChannelResponse>

trigger(String type, [dynamic payload, String? ref]) → void

unsubscribe([Duration? timeout]) → Future<String>

Leaves the channel

untrack([Map<String, dynamic> opts = const {}]) → Future<ChannelResponse>

Operators

operator ==(Object other) → bool

The equality operator.

inherited