auth-kt/io.github.jan.supabase.auth/AuthConfigDefaults

AuthConfigDefaults

open class AuthConfigDefaults : MainConfig(source)

The default values for the AuthConfig

Inheritors

AuthConfig

Constructors

AuthConfigDefaults

constructor()

Properties

alwaysAutoRefresh

var alwaysAutoRefresh: Boolean

Whether to always automatically refresh the session, when it expires

autoLoadFromStorage

var autoLoadFromStorage: Boolean

Whether to automatically load the session from sessionManager, when Auth is initialized

autoSaveToStorage

var autoSaveToStorage: Boolean

Whether to automatically save the session to sessionManager, when the session changes

codeVerifierCache

var codeVerifierCache: CodeVerifierCache?

The cache used to store/load the code verifier for the FlowType.PKCE flow. When null, the default SettingsCodeVerifierCache will be used

coroutineDispatcher

var coroutineDispatcher: CoroutineDispatcher

The dispatcher used for all auth related network requests

customUrl

var customUrl: String?

defaultRedirectUrl

var defaultRedirectUrl: String?

The default redirect url used for authentication. When null, a platform specific default redirect url will be used.

enableLifecycleCallbacks

var enableLifecycleCallbacks: Boolean

Whether to stop auto-refresh on focus loss, and resume it on focus again.

flowType

var flowType: FlowType

The type of login flow to use. Defaults to FlowType.IMPLICIT

host

var host: String?

The deeplink host used for the implicit and PKCE flow. When null, deeplinks won't be used as redirect urls

jwtToken

var jwtToken: String?

retryDelay

var retryDelay: Duration

The duration after which Auth should retry refreshing a session, when it failed due to network issues

scheme

var scheme: String?

The deeplink scheme used for the implicit and PKCE flow. When null, deeplinks won't be used as redirect urls

serializer

var serializer: SupabaseSerializer?

A serializer used for serializing/deserializing objects e.g. in Auth.signInWith. Defaults to SupabaseClientBuilder.defaultSerializer, when null.

sessionManager

var sessionManager: SessionManager?

The session manager used to store/load the session. When null, the default SettingsSessionManager will be used

Functions

minimalSettings

fun AuthConfigDefaults.minimalSettings(alwaysAutoRefresh: Boolean = false, autoLoadFromStorage: Boolean = false, autoSaveToStorage: Boolean = false, sessionManager: SessionManager? = MemorySessionManager(), codeVerifierCache: CodeVerifierCache? = MemoryCodeVerifierCache(), enableLifecycleCallbacks: Boolean = false)

Applies minimal settings to the AuthConfig. This is useful for server side applications, where you don't need to store the session or code verifier.