PhoneAuthOptions.Builder

public Builder(@NonNull FirebaseAuth auth)

Creates a new Builder

public @NonNull PhoneAuthOptions build()

Returns the PhoneAuthOptions that this Builder has constructed.

public @NonNull PhoneAuthOptions.Builder requireSmsValidation(boolean requireSmsValidation)

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.

public @NonNull PhoneAuthOptions.Builder setActivity(@NonNull Activity activity)

Sets the Activity 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, a FirebaseAuthMissingActivityForRecaptchaException error is thrown, which can be handled in the onVerificationFailed callback.

public @NonNull PhoneAuthOptions.Builder setCallbacks(
    @NonNull PhoneAuthProvider.OnVerificationStateChangedCallbacks callbacks
)

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 via setAutoRetrievedSmsCodeForPhoneNumber and in the Firebase console, onCodeAutoRetrievalTimeOut will never be triggered.

public @NonNull PhoneAuthOptions.Builder setForceResendingToken(
    @NonNull PhoneAuthProvider.ForceResendingToken forceResendingToken
)

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

public @NonNull PhoneAuthOptions.Builder setMultiFactorHint(@NonNull PhoneMultiFactorInfo phoneMultiFactorInfo)

Sets the PhoneMultiFactorInfo to use for second factor sign-in.

public @NonNull PhoneAuthOptions.Builder setMultiFactorSession(@NonNull MultiFactorSession multiFactorSession)

Sets the MultiFactorSession 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.

public @NonNull PhoneAuthOptions.Builder setPhoneNumber(@NonNull String phoneNumber)

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

public @NonNull PhoneAuthOptions.Builder setTimeout(@NonNull Long timeout, @NonNull TimeUnit unit)

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 cause onCodeAutoRetrievalTimeOut to be called immediately.