realtime-kt/io.github.jan.supabase.realtime/BroadcastJoinConfig

BroadcastJoinConfig

@Serializable

data class BroadcastJoinConfig(var acknowledgeBroadcasts: Boolean, var receiveOwnBroadcasts: Boolean, var replicationReady: Boolean)(source)

Parameters

acknowledgeBroadcasts

Whether the server should send an acknowledgment message for each broadcast message

receiveOwnBroadcasts

Whether you should receive your own broadcasts

replicationReady

replication_ready option instructs the server to emit a system event once the Postgres replication connection backing this channel is established and ready to stream changes. Listen for it with channel.on('system', {}, (payload) => ...); TODO: fix docs the payload's status is 'ok' (message: 'Replication connection established') on success or 'error' if the connection is not ready in time.

Constructors

BroadcastJoinConfig

constructor(acknowledgeBroadcasts: Boolean, receiveOwnBroadcasts: Boolean, replicationReady: Boolean)

Properties

acknowledgeBroadcasts

@SerialName(value = "ack")

var acknowledgeBroadcasts: Boolean

receiveOwnBroadcasts

@SerialName(value = "self")

var receiveOwnBroadcasts: Boolean

replicationReady

@SerialName(value = "replication_ready")

var replicationReady: Boolean