realtime_client library
Classes
- Binding
- PostgresChangeFilter
- Creates a filter for realtime postgres change listener.
- PostgresChangePayload
- Data class that contains the Postgres change event payload.
- PostgresColumn
- Presence
- A single shared state between users with Realtime Presence.
- PresenceEvents
- PresenceOpts
- RealtimeChannel
- RealtimeChannelConfig
- RealtimeClient
- RealtimeCloseEvent
- Event details for when the connection closed.
- RealtimePresence
- RealtimePresenceJoinPayload
- Payload for PresenceEvent.join callback.
- RealtimePresenceLeavePayload
- Payload for PresenceEvent.leave callback.
- RealtimePresencePayload
-
Base class for the payload in
.onPresence()callback functions. - RealtimePresenceSyncPayload
- Payload for PresenceEvent.sync callback.
- SinglePresenceState
- A single client connected through presence.
Enums
- ChannelResponse
- PostgresChangeEvent
- PostgresChangeFilterType
- Specifies the type of filter to be applied on realtime Postgres Change listener.
- PostgresTypes
- PresenceEvent
- RealtimeLogLevel
- RealtimeSubscribeStatus
- SocketStates
Extensions
Functions
-
convertCell(
String type, dynamic value) → dynamic -
If the value of the cell is
null, returns null. Otherwise converts the string value to the correct type. -
convertChangeData(
List< Map< columns, Map<String, dynamic> >String, dynamic> record, {List<String> ? skipTypes}) → Map<String, dynamic> - Takes an array of columns and an object of string values then converts each string value to its mapped type.
-
convertColumn(
String columnName, List< PostgresColumn> columns, Map<String, dynamic> record, List<String> skipTypes) → dynamic - Converts the value of an individual column.
-
httpEndpointURL(
String socketUrl) → String - Converts a WebSocket URL to an HTTP URL.
-
noop(
dynamic value) → dynamic -
toArray(
dynamic value, String type) → dynamic - Converts a Postgres Array into a native Dart array
-
toBoolean(
dynamic value) → bool? -
toDouble(
dynamic value) → double? -
toInt(
dynamic value) → int? -
toJson(
dynamic value) → dynamic -
toTimestampString(
String? value) → String? - Fixes timestamp to be ISO-8601. Swaps the space between the date and time for a 'T' See https://github.com/supabase/supabase/issues/18
Typedefs
- BindingCallback = void Function(dynamic payload, [dynamic ref])
-
PresenceChooser<
T> = T Function(String key, dynamic presence) - PresenceOnJoinCallback = void Function(String? key, dynamic currentPresences, dynamic newPresences)
- PresenceOnLeaveCallback = void Function(String? key, dynamic currentPresences, dynamic newPresences)
- RealtimeConstants = Constants
- RealtimeDecode = void Function(String payload, void callback(dynamic result))
- RealtimeEncode = void Function(dynamic payload, void callback(String result))
-
WebSocketTransport
= WebSocketChannel Function(String url, Map<
String, String> headers)