RealtimeChannel class - realtime_client library

Constructors

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

Properties

broadcastEndpointURL ↔ String: latefinal
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 setterinherited
isClosed → bool: no setter
isErrored → bool: no setter
isJoined → bool: no setter
isJoining → bool: no setter
isLeaving → bool: no setter
joinedOnce ↔ bool: getter/setter pair
joinPush ↔ Push: getter/setter pair
joinRef → String: no setter
params ↔ Map<String, dynamic>: getter/setter pair
presence ↔ RealtimePresence: getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
socket → RealtimeClient: final
subTopic → String: final
topic → String: final

Methods

isMember(String? topic) → bool
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
off(String type, Map<String, String> filter) → RealtimeChannel
onBroadcast({required String event, required void callback(Map<String, dynamic> payload)}) → RealtimeChannel: Sets up a listener for realtime broadcast messages.
onEvents(String type, ChannelFilter filter, BindingCallback callback) → RealtimeChannel
onMessage(String event, dynamic payload, [String? ref]) → dynamic: Overridable message hook
onPostgresChanges({required PostgresChangeEvent event, String? schema, String? table, PostgresChangeFilter? filter, 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.
presenceState() → List<SinglePresenceState>
push(ChannelEvents event, Map<String, dynamic> payload, [Duration? timeout]) → Push
rejoin([Duration? timeout]) → void
rejoinUntilConnected() → void
replyEventName(String? ref) → String
send({required RealtimeListenTypes type, String? event, required Map<String, dynamic> payload, Map<String, dynamic> opts = const {}}) → Future<ChannelResponse>
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>
updateJoinPayload(Map<String, dynamic> payload) → void

Operators

operator ==(Object other) → bool: The equality operator.
inherited