Skip to content
This repository was archived by the owner on Apr 4, 2023. It is now read-only.

Commit da9ba9b

Browse files
committed
Update readme
1 parent c31c42d commit da9ba9b

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

docs/AUTHENTICATION.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -444,7 +444,11 @@ Note that changing a password may fail if your login for this `email` was too lo
444444
type: firebase.LoginType.PHONE,
445445
phoneOptions: {
446446
phoneNumber: '+12345678900',
447-
verificationPrompt: "The received verification code" // default "Verification code"
447+
verificationPrompt: "The received verification code", // default "Verification code"
448+
// Optional
449+
android: {
450+
timeout: 30 // The maximum amount of time you are willing to wait for SMS auto-retrieval to be completed by the library
451+
}
448452
}
449453
}).then(
450454
function (result) {

src/firebase.d.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,11 @@ export interface FirebasePhoneLoginOptions {
269269
*/
270270
verificationPrompt?: string;
271271
android?: {
272+
/**
273+
* The maximum amount of time you are willing to wait for SMS auto-retrieval to be completed by the library. Maximum allowed value is 2 minutes. Use 0 to disable SMS-auto-retrieval. If you specified a positive value less than 30 seconds, library will default to 30 seconds.
274+
* Default: 60 (seconds)
275+
* See: https://firebase.google.com/docs/reference/android/com/google/firebase/auth/PhoneAuthProvider
276+
*/
272277
timeout: number;
273278
}
274279
}

0 commit comments

Comments
 (0)