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

Config

class Config : MainConfig, CustomSerializationConfig, AuthDependentPluginConfig(source)

Constructors

constructor()

Properties

var accessToken: suspend SupabaseClient.() -> String?

A custom access token provider. If this is set, the SupabaseClient will not be used to resolve the access token.

connectOnSubscribe

var connectOnSubscribe: Boolean

Whether to connect to the websocket when subscribing to a channel. Defaults to true

var customUrl: String?

disconnectOnEmptyChannelsAfter

var disconnectOnEmptyChannelsAfter: Duration?

Delay before disconnecting from the realtime socket after the last channel was removed. If null, it defaults to 2*heartbeatInterval

disconnectOnNoSubscriptions

var disconnectOnNoSubscriptions: Boolean

Whether to disconnect from the websocket when there are no more subscriptions. Defaults to true

disconnectOnSessionLoss

var disconnectOnSessionLoss: Boolean

Whether to disconnect from the websocket when the session is lost. Defaults to true

heartbeatInterval

var heartbeatInterval: Duration

The interval between heartbeat messages. Defaults to 15 seconds

var jwtToken: String?

var loggingFactory: SupabaseLoggingProcessorFactory?

var logLevel: LogLevel?

var maxAttempts: Int

The maximum number of times a channel will try to rejoin after an error before giving up. Defaults to 5

var reconnectDelay: Duration

The delay between reconnect attempts. Defaults to 7 seconds

var rejoinDelay: Duration

The interval between channel rejoin attempts

requireValidSession

open override var requireValidSession: Boolean

var secure: Boolean?

Whether to use wss or ws. Defaults to SupabaseClient.useHTTPS when null

open override var serializer: SupabaseSerializer?

A serializer used for serializing/deserializing objects e.g. in PresenceAction.decodeJoinsAs or RealtimeChannel.broadcast. Defaults to KotlinXSerializer

var vsn: RealtimeProtocolVersion

The realtime protocol version. RealtimeProtocolVersion.V2 supports binary payloads and is more efficient.

websocketConfig

var websocketConfig: WebSockets.Config.() -> Unit

Custom configuration for the Ktor Websocket Client. This only applies if Realtime.Config.websocketFactory is null.

websocketFactory

var websocketFactory: RealtimeWebsocketFactory?

A custom websocket factory. If this is set, the websocketConfig will be ignored