3.2.2

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

Realtime

interface Realtime : MainPlugin<Realtime.Config> , CustomSerializationPlugin(source)

Plugin for interacting with the supabase realtime api

To use it you need to install it to the SupabaseClient:

val supabase = createSupabaseClient(supabaseUrl, supabaseKey) {
   install(Realtime)
}

You can then create a channel:

val channel = supabase.realtime.channel("channelId")

Then listen to events on the channel:

val productChangeFlow = channel.postgrestChangeFlow<PostgrestAction.Insert>(schema = "public") {
   table = "products"
}.map { it.decodeRecord<Product>() }

And at last you have to subscribe to the channel:

channel.subscribe()

Types

object Companion : SupabasePluginProvider<Realtime.Config, Realtime>

data class Config(var websocketConfig: WebSockets.Config.() -> Unit = {}, var secure: Boolean? = null, var heartbeatInterval: Duration = 15.seconds, var reconnectDelay: Duration = 7.seconds, var disconnectOnSessionLoss: Boolean = true, var connectOnSubscribe: Boolean = true, var websocketFactory: RealtimeWebsocketFactory? = null, var disconnectOnNoSubscriptions: Boolean = true) : MainConfig, CustomSerializationConfig

enum Status : Enum<Realtime.Status>

The current status of the realtime connection

Properties

abstract val apiVersion: Int

abstract val config: Realtime.Config

abstract val pluginKey: String

abstract val serializer: SupabaseSerializer

abstract val status: StateFlow<Realtime.Status>

The current status of the realtime connection

abstract val subscriptions: Map<String, RealtimeChannel>

A map of all active the subscriptions

abstract val supabaseClient: SupabaseClient

Functions

abstract fun addChannel(channel: RealtimeChannel)

Adds a channel to the subscriptions without subscribing to it.

abstract suspend fun block()

Blocks your current coroutine until the websocket connection is closed

abstract fun channel(channelId: String, builder: RealtimeChannelBuilder): RealtimeChannel

Creates a new RealtimeChannel and adds it to the subscriptions

inline fun Realtime.channel(channelId: String, builder: RealtimeChannelBuilder.() -> Unit = {}): RealtimeChannel

Creates a new RealtimeChannel and adds it to the Realtime.subscriptions

open suspend fun close()

abstract suspend fun connect()

Connects to the realtime websocket. The url will be taken from the custom provided Realtime.Config.customUrl or SupabaseClient

abstract fun disconnect()

Disconnects from the realtime websocket

open fun init()

parseErrorResponse

abstract suspend fun parseErrorResponse(response: HttpResponse): RestException

removeAllChannels

abstract suspend fun removeAllChannels()

Unsubscribes and removes all channels from the subscriptions

abstract suspend fun removeChannel(channel: RealtimeChannel)

Unsubscribes and removes a channel from the subscriptions

open fun resolveUrl(path: String): String

abstract suspend fun send(message: RealtimeMessage)

Sends a message to the realtime websocket

abstract suspend fun setAuth(token: String? = null)

Sets the JWT access token used for channel subscription authorization and Realtime RLS.