A Builder class for PhoneAuthOptions.
Get an instance of this Builder using PhoneAuthOptions.newBuilder()
or
PhoneAuthOptions.newBuilder(FirebaseAuth).
| PhoneAuthOptions |
build()
Returns the
PhoneAuthOptions
that this
PhoneAuthOptions.Builder has constructed.
|
| PhoneAuthOptions.Builder |
requireSmsValidation(boolean requireSmsValidation)
Specifies whether to force an SMS to be sent for second factor validation.
|
| PhoneAuthOptions.Builder |
setActivity(Activity
activity)
Sets the
Activity
to which the callbacks are scoped, and with which app verification will be
completed.
|
| PhoneAuthOptions.Builder |
setCallbacks(PhoneAuthProvider.OnVerificationStateChangedCallbacks
callbacks)
Sets the callbacks to get the status of phone number verification.
|
| PhoneAuthOptions.Builder |
setForceResendingToken(PhoneAuthProvider.ForceResendingToken
forceResendingToken)
Sets the
PhoneAuthProvider.ForceResendingToken to force another verification
SMS to be sent before the auto-retrieval timeout.
|
| PhoneAuthOptions.Builder |
setMultiFactorHint(PhoneMultiFactorInfo
phoneMultiFactorInfo)
Sets the
PhoneMultiFactorInfo
to use for second factor sign-in.
|
| PhoneAuthOptions.Builder |
setMultiFactorSession(MultiFactorSession
multiFactorSession)
Sets the
MultiFactorSession
that holds the necessary data to start an SMS verification for multi-factor
authentication enrollment or sign in.
|
| PhoneAuthOptions.Builder |
setPhoneNumber(String phoneNumber)
Sets the phone number for sign-in, sign-up, or second factor enrollment.
|
| PhoneAuthOptions.Builder |
setTimeout(Long timeout,
TimeUnit
unit)
Sets the maximum amount of time you are willing to wait for SMS auto-retrieval
to be completed by the library.
|
Creates a new Builder
| auth | the FirebaseAuth
with which this Builder is associated. |
|---|
Returns the PhoneAuthOptions
that this PhoneAuthOptions.Builder
has constructed.
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.
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
PhoneAuthProvider.OnVerificationStateChangedCallbacks.onVerificationFailed(FirebaseException)
callback.
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
FirebaseAuthSettings.setAutoRetrievedSmsCodeForPhoneNumber(String, String)
and in the Firebase console,
PhoneAuthProvider.OnVerificationStateChangedCallbacks.onCodeAutoRetrievalTimeOut(String)
will never be triggered.
Sets the
PhoneAuthProvider.ForceResendingToken to force another verification SMS to
be sent before the auto-retrieval timeout.
Sets the PhoneMultiFactorInfo
to use for second factor sign-in.
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.
Sets the phone number for sign-in, sign-up, or second factor enrollment.
| phoneNumber | a phone number that conforms to the E.164 format. |
|---|
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 IllegalArgumentException
being thrown.
Use 0 to disable SMS-auto-retrieval. This will also cause
PhoneAuthProvider.OnVerificationStateChangedCallbacks.onCodeAutoRetrievalTimeOut(String)
to be called immediately.
| timeout | the length of the timeout in the units specified by unit. |
|---|---|
| unit | the TimeUnit
for the timeout. |