auth-kt/io.github.jan.supabase.auth.providers.builtin/Phone

Phone

data object Phone : DefaultAuthProvider<Phone.Config, UserInfo> (source)

Authentication method with phone numbers and password

Types

@Serializable(with = Phone.Channel.Companion::class)

enum Channel : Enum<Phone.Channel>

Represents the phone number confirmation channel

@Serializable

data class Config(var phone: String = "", var password: String = "", var channel: Phone.Channel = Channel.SMS) : DefaultAuthProvider.Config

The configuration for the phone authentication method

Properties

open override val grantType: String

The grant type of the provider.

Functions

open override fun decodeResult(json: JsonObject): UserInfo

encodeCredentials

open override fun encodeCredentials(credentials: Phone.Config.() -> Unit): JsonObject

open suspend override fun login(supabaseClient: SupabaseClient, onSuccess: suspend (UserSession) -> Unit, redirectUrl: String?, config: Phone.Config.() -> Unit?)

Used to login a user

open suspend override fun signUp(supabaseClient: SupabaseClient, onSuccess: suspend (UserSession) -> Unit, redirectUrl: String?, config: Phone.Config.() -> Unit?): UserInfo?

Used to sign up a user.