PhoneAuthOptions.Builder

Builder(auth: FirebaseAuth)

Creates a new Builder

fun build(): PhoneAuthOptions

Returns thePhoneAuthOptions that thisBuilder has constructed.

fun requireSmsValidation(requireSmsValidation: Boolean): PhoneAuthOptions.Builder

Specifies whether to force an SMS to be sent for second factor validation.

In some cases the phone number can be instantly verified without needing to send or enter a verification code. This feature can be disabled here, and it is enabled by default.

This is only applicable to Multi-Factor Authentication.

fun setActivity(activity: Activity): PhoneAuthOptions.Builder

Sets theActivity to which the callbacks are scoped, and with which app verification will be completed. This is an optional parameter of the builder, but is required to perform a reCAPTCHA fallback for client verification. If the activity is not set and a reCAPTCHA verification is attempted, aFirebaseAuthMissingActivityForRecaptchaException error is thrown, which can be handled in theonVerificationFailed callback.

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

Sets the callbacks to get the status of phone number verification. The callbacks will be automatically removed when the specified activity has stopped.

When a test phone number and SMS code pair is set viasetAutoRetrievedSmsCodeForPhoneNumber and in the Firebase console,onCodeAutoRetrievalTimeOut will never be triggered.

fun setForceResendingToken(
    forceResendingToken: PhoneAuthProvider.ForceResendingToken
): PhoneAuthOptions.Builder

Sets theForceResendingToken to force another verification SMS to be sent before the auto-retrieval timeout.

fun setMultiFactorHint(phoneMultiFactorInfo: PhoneMultiFactorInfo): PhoneAuthOptions.Builder

Sets thePhoneMultiFactorInfo to use for second factor sign-in.

fun setMultiFactorSession(multiFactorSession: MultiFactorSession): PhoneAuthOptions.Builder

Sets theMultiFactorSession that holds the necessary data to start an SMS verification for multi-factor authentication enrollment or sign in.

When this is set, the verification will be for validating ownership of a phone SMS second factor, not for phone authentication.

fun setPhoneNumber(phoneNumber: String): PhoneAuthOptions.Builder

Sets the phone number for sign-in, sign-up, or second factor enrollment.

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

Sets the maximum amount of time you are willing to wait for SMS auto-retrieval to be completed by the library.

The minimum timeout is 30 seconds, and the maximum timeout is 2 minutes. If you specified a positive value less than 30 seconds, library will default to 30 seconds. Specifying a negative timeout or a timeout that is greater than 120 seconds will result in an being thrown.

Use 0 to disable SMS-auto-retrieval. This will also causeonCodeAutoRetrievalTimeOut to be called immediately.