Interface IRealtimeBroadcast

Namespace

Supabase.Realtime.Interfaces

Assembly

Supabase.Realtime.dll

A contract representing a realtime broadcast

public interface IRealtimeBroadcast

Methods

AddBroadcastEventHandler(BroadcastEventHandler)

Adds a broadcast event handler

void AddBroadcastEventHandler(IRealtimeBroadcast.BroadcastEventHandler broadcastEventHandler)

Parameters

broadcastEventHandler IRealtimeBroadcast.BroadcastEventHandler

ClearBroadcastEventHandlers()

Clears all broadcast event handlers

void ClearBroadcastEventHandlers()

RemoveBroadcastEventHandler(BroadcastEventHandler)

Removes a broadcast event handler

void RemoveBroadcastEventHandler(IRealtimeBroadcast.BroadcastEventHandler broadcastEventHandler)

Parameters

broadcastEventHandler IRealtimeBroadcast.BroadcastEventHandler

Send(string?, object, int)

Sends a broadcast to a given event name with an arbitrary, serializable payload.

Task<bool> Send(string? broadcastEventName, object payload, int timeoutMs = 10000)

Parameters

broadcastEventName string

payload object

timeoutMs int

Returns

Task<bool>