Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,14 @@ channel.subscribe(const Duration(seconds: 10));
All channel streams complete when the channel closes, so `await for` loops and `onDone` handlers
end on their own once the channel is gone.

### `Binding` and `BindingCallback` are internal

`Binding` and `BindingCallback` were the raw registration primitives underneath the channel
listeners, exported by accident: their only consumers, `RealtimeChannel.onEvents` and
`RealtimeChannel.off`, have always been internal. They are no longer exported. Use the typed
channel streams (`onPostgresChanges`, `onBroadcast`, `onPresenceSync`, `onPresenceJoin`,
`onPresenceLeave`, `onSystemEvents`) instead.

### `RealtimePresence` is internal

`RealtimePresence` and its helper types (`PresenceOptions`, `PresenceEvents`, `PresenceChooser`,
Expand Down
3 changes: 2 additions & 1 deletion packages/realtime_client/lib/realtime_client.dart
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ export 'src/realtime_channel.dart';
export 'src/realtime_client.dart';
export 'src/realtime_presence.dart' show Presence;
export 'src/transformers.dart' show PostgresColumn, PostgresType;
export 'src/types.dart' hide ChannelFilter, RealtimeListenType;
export 'src/types.dart'
hide Binding, BindingCallback, ChannelFilter, RealtimeListenType;
4 changes: 2 additions & 2 deletions packages/realtime_client/lib/src/message.dart
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import 'package:realtime_client/realtime_client.dart';
import 'package:realtime_client/src/constants.dart';
import 'package:meta/meta.dart';
import 'package:realtime_client/src/constants.dart';
import 'package:realtime_client/src/types.dart';

@internal
class Message {
Expand Down
2 changes: 2 additions & 0 deletions packages/realtime_client/lib/src/types.dart
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@ import 'package:collection/collection.dart';
import 'package:meta/meta.dart';
import 'package:realtime_client/realtime_client.dart';

@internal
typedef BindingCallback = void Function(dynamic payload, [dynamic ref]);

@internal
class Binding {
String type;
Map<String, dynamic> filter;
Expand Down
8 changes: 0 additions & 8 deletions sdk-compliance.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2102,14 +2102,6 @@ supporting_symbols:
- AuthWeakPasswordException.AuthWeakPasswordException
- AuthWeakPasswordException.reasons
- AuthWeakPasswordException.toString
- Binding
- Binding.Binding
- Binding.callback
- Binding.copyWith
- Binding.filter
- Binding.id
- Binding.type
- BindingCallback
- BroadcastChannel
- Bucket
- Bucket.Bucket
Expand Down
Loading