Class ClientOptions

Namespace

Supabase.Gotrue

Assembly

Supabase.Gotrue.dll

Class representation options available to the 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

Headers

Headers to be sent with subsequent requests.

public Dictionary<string, string> Headers

Field Value

Dictionary<string, string>

Properties

AllowUnconfirmedUserSessions

Very unlikely this flag needs to be changed except in very specific contexts.

Enables tests to be E2E tests to be run without requiring users to have confirmed emails - mirrors the Gotrue server's configuration.

public bool AllowUnconfirmedUserSessions { get; set; }

Property Value

bool

AutoRefreshToken

Should the Client automatically handle refreshing the User's Token?

public bool AutoRefreshToken { get; set; }

Property Value

bool

DebugRefreshToken

Ask the TokenRefresh system to log extra debug info

public bool DebugRefreshToken { get; set; }

Property Value

bool

MaximumRefreshWaitTime

By default, the Client will attempt to refresh the token when roughly 1/5 of the time is left before expiration (assuming AutoRefreshToken is true).

InitRefreshTimer()

The default expiration time for GoTrue servers is 3600 (1 hour), with a maximum of 604,800 seconds (one week).

If you set the expiration to one week, you may want to refresh the token a bit more frequently. This setting allows you to set a custom threshold for when the client should AutoRefreshToken. The default value is 14400 seconds (4 hours).

In this scenario, if you set the server expiration to one week and leave this value set to the default, as long as the user logs in at least once a week they should stay logged in indefinitely.

public int MaximumRefreshWaitTime { get; set; }

Property Value

int

Url

Gotrue Endpoint

public string Url { get; set; }

Property Value

string