Class ClientOptions

Namespace

Supabase.Realtime

Assembly

Supabase.Realtime.dll

Options used when initializing a Client

public class ClientOptions

Inheritance

object

ClientOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DictionaryExtensions.MergeLeft<T, K, V>(T, params IDictionary<K, V>[])

Fields

DateTimeStyles

Datetime Style for JSON Deserialization of Models

public readonly DateTimeStyles DateTimeStyles

Field Value

DateTimeStyles

Headers

Request headers to be appended to the connection string.

public readonly Dictionary<string, string> Headers

Field Value

Dictionary<string, string>

Parameters

The optional params to pass when connecting

public SocketOptionsParameters Parameters

Field Value

SocketOptionsParameters

Properties

DateTimeFormat

Datetime format for JSON Deserialization of Models (Postgrest style)

public string DateTimeFormat { get; set; }

Property Value

string

Decode

The function to decode incoming messages.

public Action<string, Action<SocketResponse?>>? Decode { get; set; }

Property Value

Action<string, Action<SocketResponse>>

Encode

The function to encode outgoing messages. Defaults to JSON

public Action<object, Action<string>>? Encode { get; set; }

Property Value

Action<object, Action<string>>

EventsPerSecond

@todo Presently unused: Limit the number of events that can be sent per second.

public int EventsPerSecond { get; set; }

Property Value

int

HeartbeatInterval

The interval to send a heartbeat message

public TimeSpan HeartbeatInterval { get; set; }

Property Value

TimeSpan

ReconnectAfterInterval

The interval to reconnect

public Func<int, TimeSpan> ReconnectAfterInterval { get; set; }

Property Value

Func<int, TimeSpan>

Timeout

The default timeout in milliseconds to trigger push timeouts.

public TimeSpan Timeout { get; set; }

Property Value

TimeSpan

Transport

The Websocket Transport, for example WebSocket.

public string Transport { get; set; }

Property Value

string