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

AuthConfig

expect class AuthConfig : AuthConfigDefaults, CustomSerializationConfig(source)

The configuration for Auth

actual class AuthConfig : AuthConfigDefaults, CustomSerializationConfig(source)

The configuration for Auth

actual class AuthConfig(source)

The configuration for Auth

actual class AuthConfig : AuthConfigDefaults, CustomSerializationConfig(source)

The configuration for Auth

actual class AuthConfig(source)

The configuration for Auth

actual class AuthConfig : AuthConfigDefaults, CustomSerializationConfig(source)

The configuration for Auth

actual class AuthConfig(source)

The configuration for Auth

Constructors

Link copied to clipboard
expect constructor()
constructor()
constructor()
constructor()
constructor()
constructor()
constructor()

Properties

Link copied to clipboard
var alwaysAutoRefresh: Boolean

Whether to always automatically refresh the session, when it expires

var alwaysAutoRefresh: Boolean

Whether to always automatically refresh the session, when it expires

var alwaysAutoRefresh: Boolean

Whether to always automatically refresh the session, when it expires

var alwaysAutoRefresh: Boolean

Whether to always automatically refresh the session, when it expires

Link copied to clipboard
var autoLoadFromStorage: Boolean

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

var autoLoadFromStorage: Boolean

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

var autoLoadFromStorage: Boolean

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

var autoLoadFromStorage: Boolean

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

Link copied to clipboard
var autoSaveToStorage: Boolean

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

var autoSaveToStorage: Boolean

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

var autoSaveToStorage: Boolean

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

var autoSaveToStorage: Boolean

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

Link copied to clipboard
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

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

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

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

Link copied to clipboard
var coroutineDispatcher: CoroutineDispatcher

The dispatcher used for all auth related network requests

var coroutineDispatcher: CoroutineDispatcher

The dispatcher used for all auth related network requests

var coroutineDispatcher: CoroutineDispatcher

The dispatcher used for all auth related network requests

var coroutineDispatcher: CoroutineDispatcher

The dispatcher used for all auth related network requests

Link copied to clipboard
var customUrl: String?
var customUrl: String?
var customUrl: String?
var customUrl: String?
Link copied to clipboard
val AuthConfig.deepLink: String

The deeplink used for the implicit and PKCE flow. Throws an IllegalArgumentException, if either the scheme or host is not set

Link copied to clipboard
val AuthConfig.deepLinkOrNull: String?

The deeplink used for the implicit and PKCE flow. Returns null, if either the scheme or host is not set

Link copied to clipboard
var defaultRedirectUrl: String?

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

var defaultRedirectUrl: String?

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

var defaultRedirectUrl: String?

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

var defaultRedirectUrl: String?

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

Link copied to clipboard
var enableLifecycleCallbacks: Boolean

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

var enableLifecycleCallbacks: Boolean

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

var enableLifecycleCallbacks: Boolean

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

var enableLifecycleCallbacks: Boolean

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

Link copied to clipboard
var flowType: FlowType

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

var flowType: FlowType

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

var flowType: FlowType

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

var flowType: FlowType

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

Link copied to clipboard
var host: String?

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

var host: String?

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

var host: String?

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

var host: String?

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

Link copied to clipboard
var jwtToken: String?
var jwtToken: String?
var jwtToken: String?
var jwtToken: String?
Link copied to clipboard
var retryDelay: Duration

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

var retryDelay: Duration

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

var retryDelay: Duration

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

var retryDelay: Duration

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

Link copied to clipboard
var scheme: String?

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

var scheme: String?

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

var scheme: String?

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

var scheme: String?

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

Link copied to clipboard
abstract var serializer: SupabaseSerializer?
abstract var serializer: SupabaseSerializer?
abstract var serializer: SupabaseSerializer?
abstract var serializer: SupabaseSerializer?
Link copied to clipboard
var sessionManager: SessionManager?

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

var sessionManager: SessionManager?

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

var sessionManager: SessionManager?

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

var sessionManager: SessionManager?

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

Functions

Link copied to clipboard
fun httpCallbackConfig(block: HttpCallbackConfig.() -> Unit)

Configures the http callback for the web server, when logging in with OAuth or SSO.

Link copied to clipboard
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.