onBroadcast method

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

Sets up a listener for realtime broadcast messages.

event is the broadcast event name to which you want to listen.

supabase.channel('my_channel').onBroadcast(
    event: 'position',
    callback: (payload) {
      print(payload);
    }).subscribe();

Implementation

RealtimeChannel onBroadcast({
  required String event,
  required void Function(Map<String, dynamic> payload) callback,
}) {
  return onEvents(
    'broadcast',
    ChannelFilter(event: event),
    (payload, [ref]) => callback(Map<String, dynamic>.from(payload)),
  );
}