firebase-auth/com.google.firebase.auth/PhoneAuthOptions/Builder

Builder

actual class Builder(firebaseAuth: FirebaseAuth)(source)

expect class Builder(firebaseAuth: FirebaseAuth)(source)

actual class Builder(firebaseAuth: FirebaseAuth)(source)

Constructors

Builder

actual constructor(firebaseAuth: FirebaseAuth)

expect constructor(firebaseAuth: FirebaseAuth)

actual constructor(firebaseAuth: FirebaseAuth)

Functions

build

actual fun build(): PhoneAuthOptions

expect fun build(): PhoneAuthOptions

actual fun build(): PhoneAuthOptions

requireSmsValidation

actual fun requireSmsValidation(requireSmsValidation: Boolean): PhoneAuthOptions.Builder

Whether the user must enter the code even when the SDK could verify the number itself.

expect fun requireSmsValidation(requireSmsValidation: Boolean): PhoneAuthOptions.Builder

Whether the user must enter the code even when the SDK could verify the number itself.

actual fun requireSmsValidation(requireSmsValidation: Boolean): PhoneAuthOptions.Builder

Whether the user must enter the code even when the SDK could verify the number itself.

setActivity

fun setActivity(activity: Activity): PhoneAuthOptions.Builder

Android only: the activity the verification (and its reCAPTCHA fallback) is attached to; required.

setApplicationVerifier

fun PhoneAuthOptions.Builder.setApplicationVerifier(verifier: ApplicationVerifier): PhoneAuthOptions.Builder

Sets the reCAPTCHA (or other ApplicationVerifier) of the verification; the JS SDK requires one in browsers.

fun PhoneAuthOptions.Builder.setApplicationVerifier(verifier: ApplicationVerifier): PhoneAuthOptions.Builder

Sets the reCAPTCHA (or other ApplicationVerifier) of the verification; the JS SDK requires one in browsers.

setCallbacks

actual fun setCallbacks(callbacks: PhoneAuthProvider.OnVerificationStateChangedCallbacks): PhoneAuthOptions.Builder

expect fun setCallbacks(callbacks: PhoneAuthProvider.OnVerificationStateChangedCallbacks): PhoneAuthOptions.Builder

actual fun setCallbacks(callbacks: PhoneAuthProvider.OnVerificationStateChangedCallbacks): PhoneAuthOptions.Builder

setForceResendingToken

actual fun setForceResendingToken(token: PhoneAuthProvider.ForceResendingToken): PhoneAuthOptions.Builder

Resends the code of an earlier verification.

expect fun setForceResendingToken(token: PhoneAuthProvider.ForceResendingToken): PhoneAuthOptions.Builder

Resends the code of an earlier verification.

actual fun setForceResendingToken(token: PhoneAuthProvider.ForceResendingToken): PhoneAuthOptions.Builder

Resends the code of an earlier verification.

setMultiFactorHint

actual fun setMultiFactorHint(hint: PhoneMultiFactorInfo): PhoneAuthOptions.Builder

For multi-factor sign-in: the enrolled phone factor to verify, from MultiFactorResolver.hints.

expect fun setMultiFactorHint(hint: PhoneMultiFactorInfo): PhoneAuthOptions.Builder

For multi-factor sign-in: the enrolled phone factor to verify, from MultiFactorResolver.hints.

actual fun setMultiFactorHint(hint: PhoneMultiFactorInfo): PhoneAuthOptions.Builder

For multi-factor sign-in: the enrolled phone factor to verify, from MultiFactorResolver.hints.

setMultiFactorSession

actual fun setMultiFactorSession(session: MultiFactorSession): PhoneAuthOptions.Builder

For multi-factor enrollment or sign-in: the session from MultiFactor.getSession or MultiFactorResolver.session.

expect fun setMultiFactorSession(session: MultiFactorSession): PhoneAuthOptions.Builder

For multi-factor enrollment or sign-in: the session from MultiFactor.getSession or MultiFactorResolver.session.

actual fun setMultiFactorSession(session: MultiFactorSession): PhoneAuthOptions.Builder

For multi-factor enrollment or sign-in: the session from MultiFactor.getSession or MultiFactorResolver.session.

setPhoneNumber

actual fun setPhoneNumber(phoneNumber: String): PhoneAuthOptions.Builder

The number to verify, in E.164 format.

expect fun setPhoneNumber(phoneNumber: String): PhoneAuthOptions.Builder

The number to verify, in E.164 format.

actual fun setPhoneNumber(phoneNumber: String): PhoneAuthOptions.Builder

The number to verify, in E.164 format.

setTimeout

fun setTimeout(timeout: Long?, unit: TimeUnit): PhoneAuthOptions.Builder

Android only: how long to wait for SMS auto-retrieval before PhoneAuthProvider.OnVerificationStateChangedCallbacks.onCodeAutoRetrievalTimeOut.

setUIDelegate

fun PhoneAuthOptions.Builder.setUIDelegate(delegate: FIRAuthUIDelegateProtocol?): PhoneAuthOptions.Builder

Sets the delegate that presents the reCAPTCHA of the verification when the SDK needs one; the default presents it over the key window.