auth package

Firebase से पुष्टि करना

फ़ंक्शन

फ़ंक्शन	ब्यौरा
फ़ंक्शन(ऐप्लिकेशन, ...)
getAuth(ऐप्लिकेशन)	दिए गए FirebaseApp से जुड़े पुष्टि के इंस्टेंस की जानकारी देता है. अगर कोई इंस्टेंस मौजूद नहीं है, तो प्लैटफ़ॉर्म के हिसाब से डिफ़ॉल्ट डिपेंडेंसी के साथ पुष्टि करने वाले इंस्टेंस को शुरू करता है.
पिक अप करें	डिपेंडेंसी पर बारीकी से कंट्रोल करने के साथ, Auth इंस्टेंस को शुरू करता है.
फ़ंक्शन(स्टोरेज, ...)
getReactNativePersistence(स्टोरेज)	यह फ़ंक्शन react-native या @react-native-community/async-storage से इंपोर्ट किए गए AsyncStorage को रैप करने वाला एक परसिस्टेंस ऑब्जेक्ट दिखाता है. साथ ही, इसे OpenizeAuth() के परसिस्टेंस डिपेंडेंसी फ़ील्ड में इस्तेमाल किया जा सकता है.
फ़ंक्शन(auth, ...)
applyActionCode(auth, oobCode)	इसमें, उपयोगकर्ता को ईमेल से या किसी दूसरे आउट-ऑफ़-बैंड तरीके से भेजा गया, पुष्टि करने के लिए भेजा गया कोड लागू होता है.
beforeAuthStateChanged(auth, कॉलबैक, onAbort)	पुष्टि करने की स्थिति बदलने से पहले चलने वाला ब्लॉक करने वाला कॉलबैक जोड़ता है, जो नए उपयोगकर्ता को सेट करता है.
checkActionCode(auth, oobCode)	उपयोगकर्ता को ईमेल या अन्य आउट-ऑफ़-बैंड तरीके से भेजा गया पुष्टि करने के कोड की जांच करता है.
पुष्टि करेंPasswordReset(auth, oobCode, newPassword)	पुष्टि करने वाले कोड और नए पासवर्ड के आधार पर, पासवर्ड रीसेट करने की प्रोसेस को पूरा करता है.
connectAuthEmulator(auth, यूआरएल, विकल्प)	यह विकल्प, Firebase में पुष्टि करने वाली सेवाओं के बजाय, Firebase OAuth एम्युलेटर से संपर्क करने के लिए, Auth इंस्टेंस को बदलता है.
createUserWithEmailAndPassword(पुष्टि, ईमेल, पासवर्ड)	दिए गए ईमेल पते और पासवर्ड से जुड़ा एक नया उपयोगकर्ता खाता बनाता है.
fetchSignInMethodsForEmail(auth, ईमेल)	इस ईमेल में, साइन इन करने के उन तरीकों की सूची दी जाती है जिनके ज़रिए इस ईमेल पते पर साइन इन किया जा सकता है. ईमेल इन्यूमरेशन सुरक्षा के चालू होने पर, यह तरीका एक खाली सूची दिखाता है. भले ही, दिए गए ईमेल के लिए पुष्टि करने के कितने भी तरीके उपलब्ध हों.
getMultiFactor डेवलपर(पुष्टि, गड़बड़ी)	मल्टी-फ़ैक्टर फ़्लो को पूरा करने के लिए, ऐसा MultiFactor मॉडरेटर देता है जो मल्टी-फ़ैक्टर फ़्लो को पूरा करने के लिए सही है.
getredirectनतीजे(auth, रिज़ॉल्वर)	रीडायरेक्ट आधारित साइन-इन फ़्लो से Userक्रेडेंशियल दिखाता है.
इनीशियलाइज़ रेकैप्चाConfig(auth)	यह reCAPTCHA कॉन्फ़िगरेशन को Auth इंस्टेंस में लोड करता है.
isSignInWithEmailLink(auth, emailLink)	यह जांचता है कि इनकमिंग लिंक, signInWithEmailLink() के लिए सही ईमेल लिंक से साइन-इन है या नहीं.
onAuthStateChanged(auth, NextOr पैसों, गड़बड़ी, पूरा हुआ)	उपयोगकर्ता की साइन-इन स्थिति में बदलावों के लिए, एक ऑब्ज़र्वर जोड़ता है.
onIdTokenChanged(auth, NextOrदर्शक, गड़बड़ी, पूरा हुआ)	साइन इन किए हुए उपयोगकर्ता के आईडी टोकन में हुए बदलावों के लिए, ऑब्ज़र्वर जोड़ता है.
RevokeAccessToken(पुष्टि, टोकन)	दिए गए ऐक्सेस टोकन को रद्द करता है. फ़िलहाल, यह सिर्फ़ Apple OAuth ऐक्सेस टोकन के साथ काम करता है.
sendPasswordResetEmail(auth, email, actionCodeSettings)	दिए गए ईमेल पते पर पासवर्ड फिर सेट करने के लिए ईमेल भेजता है. अगर दिए गए ईमेल पते वाला कोई उपयोगकर्ता खाता मौजूद न हो और ईमेल गिनती की सुरक्षा चालू हो, तो यह तरीका गड़बड़ी का मैसेज नहीं दिखाता है.
sendSignInLinkToEmail(auth, email, actionCodeSettings)	बताए गए ईमेल से उपयोगकर्ता को साइन-इन ईमेल का लिंक भेजता है.
setPersistence(auth, परसिस्टेंस)	यह बदलाव, मौजूदा समय में सेव किए गए Auth सेशन के लिए, Auth इंस्टेंस पर एक जैसा बना रहता है. साथ ही, यह बदलाव आने वाले समय में साइन-इन के अनुरोधों के लिए भी लागू हो जाता है. इसमें रीडायरेक्ट अनुरोधों के साथ साइन-इन भी शामिल है.
signInanonymizely(auth)	पहचान छिपाने वाले उपयोगकर्ता के तौर पर, एसिंक्रोनस तरीके से साइन इन करता है.
signInWithAttribute(auth, क्रेडेंशियल)	दिए गए क्रेडेंशियल से एसिंक्रोनस रूप से साइन इन करता है.
signInWithCustomToken(auth, customToken)	कस्टम टोकन का इस्तेमाल करके, एसिंक्रोनस साइन इन करता है.
signInWithEmailAndPassword(पुष्टि, ईमेल, पासवर्ड)	ईमेल और पासवर्ड का इस्तेमाल करके, एसिंक्रोनस तरीके से साइन इन किया जाता है.
signInWithEmailLink(auth, email, emailLink)	ईमेल और साइन-इन ईमेल लिंक का इस्तेमाल करके एसिंक्रोनस तरीके से साइन इन किया जाता है.
signInWithPhoneNumber(auth, phoneNumber, appVerifier)	फ़ोन नंबर का इस्तेमाल करके एसिंक्रोनस साइन इन करता है.
signInWithPopup(auth, प्रोवाइडर, रिज़ॉल्वर)	पॉप-अप आधारित OAuth पुष्टि फ़्लो का इस्तेमाल करके, Firebase क्लाइंट की पुष्टि करता है.
signInWithredirect(auth, provider, रिज़ॉल्वर)	पूरे पेज के रीडायरेक्ट फ़्लो का इस्तेमाल करके, Firebase क्लाइंट की पुष्टि करता है.
signOut(auth)	वर्तमान उपयोगकर्ता को साइन आउट करता है.
updateCurrentUser(auth, उपयोगकर्ता)	एसिंक्रोनस तरीके से, दिए गए उपयोगकर्ता को Auth इंस्टेंस पर Auth.currentUser के रूप में सेट करता है.
useDeviceLanguage(auth)	मौजूदा भाषा को डिफ़ॉल्ट डिवाइस/ब्राउज़र की प्राथमिकता पर सेट करता है.
VerifiedPassword(auth, पासवर्ड)	प्रोजेक्ट या किरायेदार के लिए कॉन्फ़िगर की गई पासवर्ड नीति के आधार पर पासवर्ड की पुष्टि करता है.
verifyPasswordResetCode(auth, code)	ईमेल या किसी दूसरे आउट-ऑफ़-बैंड तरीके से उपयोगकर्ता को भेजे गए पासवर्ड रीसेट कोड की जांच करता है.
फ़ंक्शन(लिंक, ...)
parseActionCodeURL(लिंक)	यह ईमेल, कार्रवाई के लिंक की स्ट्रिंग को पार्स करता है. साथ ही, मान्य होने पर ActionCodeURL दिखाता है. ऐसा न होने पर, वैल्यू शून्य दिखती है.
फ़ंक्शन(उपयोगकर्ता, ...)
deleteUser(user)	उपयोगकर्ता को मिटाता है और साइन आउट करता है.
getIdToken(user, forceRefresh) है.	यह फ़ंक्शन, Firebase सेवा में उपयोगकर्ता की पहचान करने के लिए इस्तेमाल किया जाने वाला JSON Web Token (JWT) दिखाता है.
getIdTokenresults(user, forceRefresh) है	यह फ़ंक्शन, Firebase सेवा में उपयोगकर्ता की पहचान करने के लिए इस्तेमाल किए जाने वाले, डीसीरियलाइज़्ड JSON वेब टोकन (JWT) दिखाता है.
linkWithAttribute(उपयोगकर्ता, क्रेडेंशियल)	दिए गए क्रेडेंशियल से उपयोगकर्ता खाते को लिंक करता है.
linkWithPhoneNumber(उपयोगकर्ता, फ़ोन नंबर, appVerifier)	दिए गए फ़ोन नंबर से उपयोगकर्ता खाते को लिंक करता है.
linkWithPopup(उपयोगकर्ता, प्रोवाइडर, रिज़ॉल्वर)	पॉप-अप पर आधारित OAuth फ़्लो का इस्तेमाल करके, सेवा देने वाली उस कंपनी को उपयोगकर्ता खाते से लिंक करता है जिसकी पुष्टि की गई है.
linkWithredirect(उपयोगकर्ता, प्रोवाइडर, रिज़ॉल्वर)	पूरे पेज पर रीडायरेक्ट फ़्लो का इस्तेमाल करके, OAuthProvider को उपयोगकर्ता खाते से लिंक करता है.
मल्टीफ़ैक्टर(उपयोगकर्ता)	उपयोगकर्ता से जुड़ा MultiFactorUser.
फिर से पुष्टि करने के लिए क्रेडेंशियल(उपयोगकर्ता, क्रेडेंशियल)	नए क्रेडेंशियल का इस्तेमाल करके, उपयोगकर्ता की फिर से पुष्टि करता है.
फिर से पुष्टि करेंWithPhoneNumber(उपयोगकर्ता, फ़ोन नंबर, appVerifier)	नए फ़ोन क्रेडेंशियल का इस्तेमाल करके, उपयोगकर्ता की फिर से पुष्टि करता है.
reAuthenticWithPopup(उपयोगकर्ता, प्रोवाइडर, रिज़ॉल्वर)	पॉप-अप पर आधारित OAuth फ़्लो का इस्तेमाल करके, तय किए गए OAuthProvider की मदद से मौजूदा उपयोगकर्ता की फिर से पुष्टि करता है.
reAuthenticWithredirect(उपयोगकर्ता, प्रोवाइडर, रिज़ॉल्वर)	पूरे पेज पर रीडायरेक्ट फ़्लो का इस्तेमाल करके, तय किए गए OAuthProvider की मदद से मौजूदा उपयोगकर्ता की फिर से पुष्टि करता है.
reload(उपयोगकर्ता)	साइन इन होने पर, उपयोगकर्ता खाते का डेटा फिर से लोड करता है.
sendEmailValidation(user, actionCodeSettings)	उपयोगकर्ता को पुष्टि करने के लिए ईमेल भेजता है.
अनलिंक(user, providerId)	उपयोगकर्ता खाते से, सेवा देने वाली कंपनी को अनलिंक करता है.
updateEmail(उपयोगकर्ता, newEmail)	उपयोगकर्ता का ईमेल पता अपडेट करता है.
updatePassword(user, newPassword)	उपयोगकर्ता का पासवर्ड अपडेट करता है.
updatePhoneNumber(उपयोगकर्ता, क्रेडेंशियल)	उपयोगकर्ता का फ़ोन नंबर अपडेट करता है.
updateProfile(उपयोगकर्ता, {displayName, photoURL: photoUrl })	उपयोगकर्ता की प्रोफ़ाइल का डेटा अपडेट करता है.
verifybeforeUpdateEmail(user, newEmail, actionCodeSettings)	नए ईमेल पते पर पुष्टि करने के लिए ईमेल भेजता है.
फ़ंक्शन(userक्रेडेंशियल, ...)
getadditionalUserInfo(user क्रेडेंशियल)	दिए गए क्रेडेंशियल के लिए, सेवा देने वाली कंपनी के खास additionalUserInfo को एक्सट्रैक्ट करता है.

क्लास

क्लास	ब्यौरा
ActionCodeURL	ईमेल कार्रवाई यूआरएल, जैसे कि पासवर्ड रीसेट, ईमेल पुष्टि, ईमेल लिंक साइन इन वगैरह को पार्स करने के लिए एक उपयोगिता क्लास.
आधिकारिक क्रेडेंशियल	ऐसा इंटरफ़ेस जो AuthProvider से मिले क्रेडेंशियल दिखाता है.
EmailAuth क्रेडेंशियल	ऐसा इंटरफ़ेस जो ProviderId के लिए EmailAuthProvider से मिले क्रेडेंशियल दिखाता है.
EmailAuthProvider	EmailAuth क्रेडेंशियल जनरेट करने के लिए सेवा देने वाली कंपनी.
FacebookAuthProvider	सेवा देने वाली कंपनी, ProviderId.FACEBOOK के लिए, OAuthReporting जनरेट कर सकती है.
GithubAuthProvider	ProviderId.GITHUB के लिए, OAuthक्रेडेंशियल जनरेट करने की सेवा देने वाली कंपनी.
GoogleAuthProvider	ProviderId के लिए, OAuthReporting जनरेट करने की सेवा देने वाली कंपनी.
OAuth क्रेडेंशियल	यह OAuthProvider से मिले OAuth क्रेडेंशियल के बारे में बताता है.
OAuthProvider	सामान्य OAuthक्रेडेंशियल जनरेट करने की सेवा देने वाली कंपनी.
फ़ोन ऑथराइज़ेशन क्रेडेंशियल	यह PhoneAuthProvider से मिले क्रेडेंशियल के बारे में बताता है.
PhoneAuthProvider	PhoneAuthक्रेडेंशियल जनरेट करने की सेवा देने वाली कंपनी.
फ़ोनमल्टीफ़ैक्टर जनरेटर	सेवा देने वाली कंपनी, PhoneMultiFactorAssertion को जनरेट करती है.
RecaptchaVerifier	re कैप्चा पर आधारित ऐप्लिकेशन की पुष्टि करने वाली सुविधा.
SAMLAuthProvider	एसएएमएल के लिए AuthProvider.
TotpMultiFactorGenerator	सेवा देने वाली कंपनी, TotpMultiFactorAssertion को जनरेट करती है.
TotpSecret	TotpMultiFactorAssertion को जनरेट करता है.समय के हिसाब से ओटीपी जनरेट करने के लिए, शेयर की गई सीक्रेट कुंजी और अन्य पैरामीटर सेव करता है. शेयर की गई सीक्रेट कुंजी को वापस पाने और क्यूआर कोड का यूआरएल जनरेट करने के तरीके लागू करता है.
TwitterAuthProvider	सेवा देने वाली कंपनी, ProviderId.TWITTER के लिए, OAuth माता-पिता जनरेट करने की सुविधा देती है.

इंटरफ़ेस

इंटरफ़ेस	ब्यौरा
कार्रवाई कोड की जानकारी	checkActionCode() से मिला जवाब.
ActionCodeSettings	ऐसा इंटरफ़ेस जो वैकल्पिक Android और iOS बंडल आइडेंटिफ़ायर के साथ ज़रूरी जारी रखें/स्टेट यूआरएल के बारे में बताता है.
अन्य उपयोगकर्ता की जानकारी	यह ऐसा स्ट्रक्चर है जिसमें फ़ेडरेटेड आइडेंटिटी प्रोवाइडर से मिली अतिरिक्त उपयोगकर्ता जानकारी शामिल है.
ApplicationVerifier	डोमेन की पुष्टि और इसके गलत इस्तेमाल को रोकने के लिए, पुष्टि करने वाला टूल.
पुष्टि करना	Firebase में पुष्टि करने की सेवा को दिखाने वाला इंटरफ़ेस.
पुष्टि करने में गड़बड़ी	Auth की गड़बड़ी के लिए इंटरफ़ेस.
AuthErrorMap	गड़बड़ी के मैसेज से गड़बड़ी के कोड को मैप करना.
AuthProvider	ऐसा इंटरफ़ेस जो पुष्टि करने वाली कंपनी के बारे में बताता है. इसका इस्तेमाल Authक्रेडेंशियल बनाने के लिए किया जाता है.
Authसेटिंग	आधिकारिक इंस्टेंस की सेटिंग दिखाने वाला इंटरफ़ेस.
कॉन्फ़िगरेशन	Auth कॉन्फ़िगरेशन को दिखाने वाला इंटरफ़ेस.
पुष्टि का नतीजा	यह किसी फ़ोन नंबर पर साइन इन करने, लिंक करने या फिर से पुष्टि करने वाले कॉल का नतीजा है.
डिपेंडेंसी	Auth इंस्टेंस शुरू करने के लिए इस्तेमाल की जा सकने वाली डिपेंडेंसी.
EmulatorConfig	Firebase की पुष्टि करने वाले एम्युलेटर का कॉन्फ़िगरेशन.
IdTokenresults	User.getIdToken Results() से मिले आईडी टोकन नतीजे को दिखाने वाला इंटरफ़ेस.
मल्टीफ़ैक्टर असर	दूसरे फ़ैक्टर के मालिकाना हक का दावा करने के लिए बेस क्लास.
मल्टीफ़ैक्टर एरर	यह गड़बड़ी तब दिखती है, जब उपयोगकर्ता को साइन इन करने के लिए, दूसरा तरीका देने की ज़रूरत होती है.
मल्टीफ़ैक्टर जानकारी	यह वह स्ट्रक्चर है जिसमें सेकंड फ़ैक्टर इकाई की जानकारी होती है.
मल्टीफ़ैक्टर रिज़ॉल्वर	जब उपयोगकर्ता को साइन इन करने के लिए दूसरा फ़ैक्टर देने की ज़रूरत होती है, तब MultiFactorError से डेटा वापस पाने के लिए इस्तेमाल की जाने वाली क्लास.
MultiFactorSession	मल्टी-फ़ैक्टर सेशन ऑब्जेक्ट की जानकारी देने वाला इंटरफ़ेस. इसका इस्तेमाल, किसी उपयोगकर्ता के लिए सेकंड फ़ैक्टर को रजिस्टर करने या दूसरे फ़ैक्टर से रजिस्टर किए गए उपयोगकर्ता के साइन इन करने में मदद करने के लिए किया जाता है.
मल्टीफ़ैक्टर यूज़र	ऐसा इंटरफ़ेस जो किसी उपयोगकर्ता से जुड़ी बहु-स्तरीय प्रॉपर्टी और उससे जुड़ी कार्रवाइयों के बारे में बताता है.
OAuthक्रेडेंशियल विकल्प	OAuthक्रेडेंशियल शुरू करने के विकल्पों के बारे में बताता है.
ParsedToken	पार्स किया गया आईडी टोकन दिखाने वाला इंटरफ़ेस.
पासवर्ड नीति	पासवर्ड नीति की ज़रूरी शर्तों के बारे में बताने वाली संरचना.
पासवर्ड की पुष्टि करने की स्थिति	वह स्ट्रक्चर जिससे पता चलता है कि पासवर्ड से जुड़ी कौनसी नीति की ज़रूरी शर्तें पूरी की गई थीं या किन शर्तों का उल्लंघन किया गया था. साथ ही, इससे जुड़ी ज़रूरी शर्तें क्या हैं.
परसिस्टेंस	एक इंटरफ़ेस, जिसमें कई तरह के परसिस्टेंस मैकेनिज़्म को कवर किया जा सकता है.
फ़ोनमल्टीफ़ैक्टरअसरशन	फ़ोन के सेकंड फ़ैक्टर के मालिकाना हक का दावा करने की क्लास. PhoneMultiFactorGenerator.assertion() ने उपलब्ध कराया है.
PhoneMultiFactorenrollInfoOptions	दो तरीकों से रजिस्टर करने के लिए इस्तेमाल किए गए विकल्प.
फ़ोन का मल्टीफ़ैक्टर जानकारी	फ़ोन नंबर दूसरे फ़ैक्टर के लिए MultiFactorInfo इंटरफ़ेस की सब-क्लास. इस दूसरे फ़ैक्टर का factorId FactorId.PHONE है.
फ़ोन का मल्टीफ़ैक्टरसाइनइनजानकारी विकल्प	दूसरे चरण से साइन इन करने के लिए इस्तेमाल किए गए विकल्प.
PhoneSingleFactorInfoOptions	सिंगल-फ़ैक्टर साइन-इन के लिए इस्तेमाल किए जाने वाले विकल्प.
पॉप-रीडायरेक्ट रिज़ॉल्वर	डीओएम से जुड़ी खास कार्रवाइयों को मैनेज करने के लिए इस्तेमाल किया जाने वाला रिज़ॉल्वर, जैसे कि signInWithPopup() या signInWithredirect().
ReactNativeAsyncStorage	दिए गए AsyncStorage के लिए इंटरफ़ेस.
रीकैप्चा पैरामीटर	reCAPTCHA पैरामीटर को दिखाने वाला इंटरफ़ेस.स्वीकार किए गए पैरामीटर की सूची देखने के लिए, re कैप्चा के दस्तावेज़ देखें. sitekey को छोड़कर सभी पैरामीटर स्वीकार किए जाते हैं: Firebase पुष्टि करने की प्रक्रिया हर प्रोजेक्ट के लिए reCAPTCHA की सुविधा देती है और रेंडर होने पर साइट कुंजी को कॉन्फ़िगर करती है.न दिखने वाले reCAPTCHA के लिए, size कुंजी को invisible पर सेट करें.
TotpMultiFactorAssertion	TOTP के दूसरे फ़ैक्टर के मालिकाना हक का दावा करने के लिए क्लास. इसे TotpMultiFactorGenerator.assertionForEnrollment() और TotpMultiFactorGenerator.assertionForSignIn() ने उपलब्ध कराया है.
TotpMultiFactorजानकारी	टीओटीपी के दूसरे फ़ैक्टर के लिए, MultiFactorInfo इंटरफ़ेस की सब-क्लास. इस दूसरे फ़ैक्टर का factorId, FactorId.TOTP है.
उपयोगकर्ता	उपयोगकर्ता खाता.
उपयोगकर्ता क्रेडेंशियल	वह स्ट्रक्चर जिसमें User, OperationType, और प्रोवाइडर का आईडी शामिल होता है.
उपयोगकर्ता की जानकारी	उपयोगकर्ता की प्रोफ़ाइल की जानकारी, जो सिर्फ़ Firebase प्रोजेक्ट में मौजूद ऐप्लिकेशन को दिखती है.
UserMetadata	उपयोगकर्ता का मेटाडेटा दिखाने वाला इंटरफ़ेस.

वैरिएबल

वैरिएबल	ब्यौरा
ActionCodeOperation	ईमेल से जुड़ी संभावित कार्रवाइयों की सूची.
AuthErrorCodes	SDK टूल से अपलोड की गई गड़बड़ियों के साथ आसानी से तुलना करने के लिए, संभावित Auth गड़बड़ी कोड का मैप.
ब्राउज़रLocalPersistence	डिवाइस के स्टोरेज के लिए localStorage का इस्तेमाल करके, LOCAL टाइप के परसिस्टेंस को लागू करना.
ब्राउज़रपॉपअप रीडायरेक्टरिज़ॉल्वर	ब्राउज़र पर आधारित ऐप्लिकेशन के लिए सही पॉपअप रीडायरेक्ट कंसोल को लागू किया गया हो.
BrowserSessionPersistence	डिवाइस के स्टोरेज के लिए sessionStorage का इस्तेमाल करके, SESSION के परसिस्टेंस को लागू करना.
cordavaPopup हैंडलरिज़ॉल्वर	कोर्डोवा पर आधारित ऐप्लिकेशन के लिए सही पॉपअप रीडायरेक्टरिज़ॉल्वर को लागू किया गया है.
debugErrorMap	ज़्यादातर गड़बड़ी कोड के लिए विस्तार से जानकारी के साथ एक वर्बोस गड़बड़ी मैप.AuthErrorMap पर चर्चा देखें
फ़ैक्टर आईडी	यह उन फ़ैक्टर की सूची है जिनका इस्तेमाल बहु-स्तरीय पुष्टि (MFA) के लिए किया जा सकता है.
indexedDBLocalPersistence	डिवाइस के स्टोरेज के लिए indexedDB का इस्तेमाल करके, LOCAL टाइप के परसिस्टेंस को लागू करना.
inMemoryPersistence	'NONE' टाइप के परसिस्टेंस को लागू करना.
ऑपरेशन टाइप	इस्तेमाल की जा सकने वाली कार्रवाइयों की सूची.
prodErrorMap	कम से कम गड़बड़ी वाला मैप, जिसमें बहुत ज़्यादा शब्दों में गड़बड़ी के मैसेज हटा दिए गए हैं.AuthErrorMap पर चर्चा देखें
सेवा देने वाली कंपनी का आईडी	सेवा देने वाली कंपनियों की गिनती.
SignIn का तरीका	साइन-इन करने के इस्तेमाल किए जा सकने वाले तरीकों की गिनती.

उपनाम टाइप

उपनाम लिखें	ब्यौरा
कस्टम पैरामीटर	OAuth कस्टम पैरामीटर का मैप.
NextOrobr	इवेंट कॉलबैक के लिए परिभाषा टाइप करें.
फ़ोनजानकारी के विकल्प	किसी फ़ोन नंबर के मालिकाना हक की पुष्टि करने के लिए ज़रूरी जानकारी.
उपयोगकर्ता की प्रोफ़ाइल	additionalUserInfo में इस्तेमाल की गई उपयोगकर्ता प्रोफ़ाइल.

फ़ंक्शन(ऐप्लिकेशन, ...)

getAuth(ऐप्लिकेशन)

दिए गए FirebaseApp से जुड़े पुष्टि के इंस्टेंस की जानकारी देता है. अगर कोई इंस्टेंस मौजूद नहीं है, तो प्लैटफ़ॉर्म के हिसाब से डिफ़ॉल्ट डिपेंडेंसी के साथ पुष्टि करने वाले इंस्टेंस को शुरू करता है.

हस्ताक्षर:

export declare function getAuth(app?: FirebaseApp): Auth;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ऐप्लिकेशन	Firebaseऐप्लिकेशन	Firebase ऐप्लिकेशन.

लौटाए जाने वाले प्रॉडक्ट:

पुष्टि करना

startizeAuth(app, deps)

डिपेंडेंसी पर बारीकी से कंट्रोल करने के साथ, Auth इंस्टेंस को शुरू करता है.

यह फ़ंक्शन getAuth() के मुकाबले Auth इंस्टेंस पर ज़्यादा कंट्रोल की अनुमति देता है. डिपेंडेंसी देने के लिए, getAuth प्लैटफ़ॉर्म के हिसाब से डिफ़ॉल्ट डिफ़ॉल्ट का इस्तेमाल करता है. आम तौर पर, getAuth, पुष्टि शुरू करने का सबसे आसान तरीका है और ज़्यादातर इस्तेमाल के मामलों में काम करता है. अगर आपको कंट्रोल की ज़रूरत है कि कौनसी परसिस्टेंस लेयर इस्तेमाल की जाए, तो initializeAuth का इस्तेमाल करें. इसके अलावा, अगर signInWithPopup या signInWithRedirect का इस्तेमाल नहीं किया जा रहा है, तो बंडल का साइज़ छोटा करने के लिए.

उदाहरण के लिए, अगर आपका ऐप्लिकेशन सिर्फ़ पहचान छिपाने वाले खातों का इस्तेमाल करता है और आपको सिर्फ़ मौजूदा सेशन के लिए खाते सेव करने हैं, तो Auth को इसके साथ शुरू करें:

const auth = initializeAuth(app, {
  persistence: browserSessionPersistence,
  popupRedirectResolver: undefined,
});

हस्ताक्षर:

export declare function initializeAuth(app: FirebaseApp, deps?: Dependencies): Auth;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
ऐप्लिकेशन	Firebaseऐप्लिकेशन
डिप	डिपेंडेंसी

लौटाए जाने वाले प्रॉडक्ट:

पुष्टि करना

फ़ंक्शन(स्टोरेज, ...)

getReactNativePersistence(स्टोरेज)

यह फ़ंक्शन react-native या @react-native-community/async-storage से इंपोर्ट किए गए AsyncStorage को रैप करता है. साथ ही, इसका इस्तेमाल InitializeAuth() के परसिस्टेंस डिपेंडेंसी फ़ील्ड में किया जा सकता है.

हस्ताक्षर:

export declare function getReactNativePersistence(storage: ReactNativeAsyncStorage): Persistence;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
स्टोर करने की जगह	ReactNativeAsyncStorage

लौटाए जाने वाले प्रॉडक्ट:

परसिस्टेंस

फ़ंक्शन(auth, ...)

लागूActionCode(auth, oobCode)

इसमें, उपयोगकर्ता को ईमेल से या किसी दूसरे आउट-ऑफ़-बैंड तरीके से भेजा गया, पुष्टि करने के लिए भेजा गया कोड लागू होता है.

हस्ताक्षर:

export declare function applyActionCode(auth: Auth, oobCode: string): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
oobकोड	स्ट्रिंग	पुष्टि करने के लिए उपयोगकर्ता को कोड भेजा गया है.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

beforeAuthStateChanged(auth, कॉलबैक, onAbort)

पुष्टि करने की स्थिति बदलने से पहले चलने वाला ब्लॉक करने वाला कॉलबैक जोड़ता है, जो नए उपयोगकर्ता को सेट करता है.

हस्ताक्षर:

export declare function beforeAuthStateChanged(auth: Auth, callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
कॉलबैक	(उपयोगकर्ता: उपयोगकर्ता | शून्य) => अमान्य | वादा<void>	नई उपयोगकर्ता वैल्यू सेट होने से पहले कॉलबैक ट्रिगर किया गया. अगर ऐसा होता है, तो उपयोगकर्ता को सेट होने से रोकता है.
onAbort	() => अमान्य	अगर बाद में beforeAuthStateChanged() कॉलबैक होता है, तो कॉलबैक ट्रिगर हो जाता है. इससे खराब असर को पहले जैसा किया जा सकता है.

लौटाए जाने वाले प्रॉडक्ट:

सदस्यता छोड़ें

CheckActionCode(auth, oobCode)

उपयोगकर्ता को ईमेल या अन्य आउट-ऑफ़-बैंड तरीके से भेजा गया पुष्टि करने के कोड की जांच करता है.

हस्ताक्षर:

export declare function checkActionCode(auth: Auth, oobCode: string): Promise<ActionCodeInfo>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
oobकोड	स्ट्रिंग	पुष्टि करने के लिए उपयोगकर्ता को कोड भेजा गया है.

लौटाए जाने वाले प्रॉडक्ट:

वादा करें<ActionCodeInfo>

कोड के बारे में मेटाडेटा.

पुष्टिपासवर्ड रीसेट करें(auth, oobCode, नया पासवर्ड)

पुष्टि करने वाले कोड और नए पासवर्ड के आधार पर, पासवर्ड रीसेट करने की प्रोसेस को पूरा करता है.

हस्ताक्षर:

export declare function confirmPasswordReset(auth: Auth, oobCode: string, newPassword: string): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
oobकोड	स्ट्रिंग	उपयोगकर्ता को पुष्टि करने वाला कोड भेजा गया.
नया पासवर्ड	स्ट्रिंग	नया पासवर्ड.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

ConnectAuthEmulator(पुष्टि, यूआरएल, विकल्प)

यह विकल्प, Firebase में पुष्टि करने वाली सेवाओं के बजाय, Firebase OAuth एम्युलेटर से संपर्क करने के लिए, Auth इंस्टेंस को बदलता है.

इनीशियलाइज़Auth() को पहली कॉल करने के तुरंत बाद इसे सिंक्रोनस रूप से कॉल किया जाना चाहिए. प्रोडक्शन क्रेडेंशियल के साथ इसका इस्तेमाल न करें, क्योंकि एम्युलेटर ट्रैफ़िक को एन्क्रिप्ट (सुरक्षित) नहीं किया गया है.

हस्ताक्षर:

export declare function connectAuthEmulator(auth: Auth, url: string, options?: {
    disableWarnings: boolean;
}): void;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
url	स्ट्रिंग	वह यूआरएल जिस पर एम्युलेटर चल रहा है (उदाहरण के लिए, 'http://localhost:9099').
विकल्प	{disableWARNINGs: बूलियन; }	ज़रूरी नहीं. options.disableWarnings की डिफ़ॉल्ट वैल्यू false होती है. डीओएम से अटैच किए गए चेतावनी बैनर को बंद करने के लिए, इसे true पर सेट करें.

लौटाए जाने वाले प्रॉडक्ट:

अमान्य

उदाहरण

connectAuthEmulator(auth, 'http://127.0.0.1:9099', { disableWarnings: true });

createUserWithEmailAndPassword(auth, ईमेल, पासवर्ड)

दिए गए ईमेल पते और पासवर्ड से जुड़ा एक नया उपयोगकर्ता खाता बनाता है.

उपयोगकर्ता खाता बन जाने के बाद, यह उपयोगकर्ता आपके ऐप्लिकेशन में भी साइन इन हो जाएगा.

अगर खाता पहले से मौजूद है या पासवर्ड अमान्य है, तो उपयोगकर्ता खाता नहीं बनाया जा सकता.

यह तरीका FirebaseServerApp की मदद से बनाए गए आधिकारिक इंस्टेंस पर काम नहीं करता.

हस्ताक्षर:

export declare function createUserWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
ईमेल	स्ट्रिंग	उपयोगकर्ता का ईमेल पता.
पासवर्ड	स्ट्रिंग	उपयोगकर्ता का चुना गया पासवर्ड.

लौटाए जाने वाले प्रॉडक्ट:

वादा<Userक्रेडेंशियल>

फ़ेचSignInMethodsForEmail(auth, ईमेल)

इस ईमेल में, साइन इन करने के उन तरीकों की सूची दी जाती है जिनके ज़रिए इस ईमेल पते पर साइन इन किया जा सकता है. ईमेल इन्यूमरेशन सुरक्षा के चालू होने पर, यह तरीका एक खाली सूची दिखाता है. भले ही, दिए गए ईमेल के लिए पुष्टि करने के कितने भी तरीके उपलब्ध हों.

यह सेवा, एक ही कंपनी के साइन इन करने के तरीकों में अंतर करने के लिए फ़ायदेमंद होती है. उदाहरण के लिए, EmailAuthProvider जिसमें साइन इन करने के दो तरीके हैं, SignInMethod.EMAIL_पासवर्ड और SignInMethod.EMAIL_LINK.

हस्ताक्षर:

export declare function fetchSignInMethodsForEmail(auth: Auth, email: string): Promise<string[]>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
ईमेल	स्ट्रिंग	उपयोगकर्ता का ईमेल पता.अब काम नहीं करता. सुरक्षा के सबसे सही तरीके के तौर पर, इस तरीके का इस्तेमाल बंद करने का सुझाव दिया जाता है. इस बारे में ज़्यादा जानने के लिए, ईमेल की गिनती की सुरक्षा के लिए, Identity Platform के दस्तावेज़ देखें.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<string[]>

getMultiFactor resolver(पुष्टि, गड़बड़ी)

मल्टी-फ़ैक्टर फ़्लो को पूरा करने के लिए, ऐसा MultiFactor मॉडरेटर देता है जो मल्टी-फ़ैक्टर फ़्लो को पूरा करने के लिए सही है.

हस्ताक्षर:

export declare function getMultiFactorResolver(auth: Auth, error: MultiFactorError): MultiFactorResolver;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
गड़बड़ी	मल्टीफ़ैक्टर एरर	साइन इन या फिर से पुष्टि करने की कार्रवाई के दौरान, MultiFactorError से जुड़ा डेटा.

लौटाए जाने वाले प्रॉडक्ट:

मल्टीफ़ैक्टर रिज़ॉल्वर

getredirectनतीजे(auth, रिज़ॉल्वर)

रीडायरेक्ट आधारित साइन-इन फ़्लो से Userक्रेडेंशियल दिखाता है.

अगर साइन-इन सफल हो गया है, तो साइन इन किया हुआ उपयोगकर्ता लौटाता है. अगर साइन इन नहीं किया जा सका, तो गड़बड़ी की वजह से यह नहीं हो पाएगा. अगर किसी दूसरे वेबलिंक पर भेजने की कार्रवाई नहीं की गई थी, तो वैल्यू null होगी.

यह तरीका Node.js एनवायरमेंट में या FirebaseServerApp की मदद से बनाए गए आधिकारिक इंस्टेंस के साथ काम नहीं करता.

हस्ताक्षर:

export declare function getRedirectResult(auth: Auth, resolver?: PopupRedirectResolver): Promise<UserCredential | null>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
रिज़ॉल्वर	पॉप-रीडायरेक्ट रिज़ॉल्वर	अगर पहले से ही enableizeAuth() पर उपलब्ध कराया गया है या getAuth() की मदद से उपलब्ध कराया गया है, तो पॉपअप-रीडायरेक्ट रिज़ॉल्वर का एक इंस्टेंस ज़रूरी नहीं होगा.

लौटाए जाने वाले प्रॉडक्ट:

वादा करें<Userक्रेडेंशियल | null>

उदाहरण

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
// You can add additional scopes to the provider:
provider.addScope('user_birthday');
// Start a sign in process for an unauthenticated user.
await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
if (result) {
  // This is the signed-in user
  const user = result.user;
  // This gives you a Facebook Access Token.
  const credential = provider.credentialFromResult(auth, result);
  const token = credential.accessToken;
}
// As this API can be used for sign-in, linking and reauthentication,
// check the operationType to determine what triggered this redirect
// operation.
const operationType = result.operationType;

EarlyizeRecaptchaConfig(auth) के लिए

यह reCAPTCHA कॉन्फ़िगरेशन को Auth इंस्टेंस में लोड करता है.

इससे reCAPTCHA कॉन्फ़िगरेशन लोड होगा, जिससे यह पता चलेगा कि पुष्टि करने की सेवा देने वाली हर कंपनी के लिए, पुष्टि करने वाले मौजूदा सेशन में reCAPTCHA के पुष्टि फ़्लो को ट्रिगर किया जाना चाहिए या नहीं.

अगर startizeRecaptchaConfig() को शुरू नहीं किया गया है, तो पुष्टि करने की प्रक्रिया हमेशा reCAPTCHA की पुष्टि के बिना शुरू होगी. अगर डेवलपर को reCAPTCHA से पुष्टि कराने के लिए कॉन्फ़िगर किया गया है, तो SDK टूल, reCAPTCHA कॉन्फ़िगरेशन को पारदर्शी तरीके से लोड करेगा. साथ ही, पुष्टि करने की प्रोसेस को फिर से शुरू करेगा.

इसलिए, इस वैकल्पिक तरीके को कॉल करने से, आने वाले समय में पुष्टि करने की प्रक्रिया में लगने वाला समय कम हो जाएगा. reCAPTCHA कॉन्फ़िगरेशन को जल्दी लोड करने से, reCAPTCHA से इकट्ठा किया गया सिग्नल भी बेहतर हो जाता है.

यह तरीका Node.js के साथ काम नहीं करता.

हस्ताक्षर:

export declare function initializeRecaptchaConfig(auth: Auth): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

उदाहरण

initializeRecaptchaConfig(auth);

isSignInWithEmailLink(auth, emailLink)

यह जांचता है कि इनकमिंग लिंक, signInWithEmailLink() के लिए सही ईमेल लिंक से साइन-इन है या नहीं.

हस्ताक्षर:

export declare function isSignInWithEmailLink(auth: Auth, emailLink: string): boolean;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
ईमेल लिंक	स्ट्रिंग	उपयोगकर्ता के ईमेल पते पर भेजा गया लिंक.

लौटाए जाने वाले प्रॉडक्ट:

बूलियन

onAuthStateChanged(auth, NextOr पैसों, गड़बड़ी, पूरा हुआ)

उपयोगकर्ता की साइन-इन स्थिति में बदलावों के लिए, एक ऑब्ज़र्वर जोड़ता है.

पुरानी कार्रवाई को बनाए रखने के लिए, onIdTokenChanged() देखें.

हस्ताक्षर:

export declare function onAuthStateChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
अगला-ऑब्ज़र्वर	NextOrobr<उपयोगकर्ता>	बदलाव होने पर कॉलबैक ट्रिगर हुआ.
गड़बड़ी	ErrorFn	समर्थन नहीं होना या रुकना. यह कॉलबैक कभी ट्रिगर नहीं किया जाता. साइन इन/आउट करने पर होने वाली गड़बड़ियों को, साइन इन/साइन आउट फ़ंक्शन से लौटाए गए वादों में पकड़ा जा सकता है.
पूर्ण	CompleteFn	समर्थन नहीं होना या रुकना. यह कॉलबैक कभी ट्रिगर नहीं किया जाता.

लौटाए जाने वाले प्रॉडक्ट:

सदस्यता छोड़ें

onIdTokenChanged(auth, NextOr पैसों, गड़बड़ी, पूरा हुआ)

साइन इन किए हुए उपयोगकर्ता के आईडी टोकन में हुए बदलावों के लिए, ऑब्ज़र्वर जोड़ता है.

इसमें साइन इन, साइन आउट, और टोकन रीफ़्रेश करने से जुड़े इवेंट शामिल हैं. आईडी टोकन की समयसीमा खत्म होने पर, यह अपने-आप ट्रिगर नहीं होगा. आईडी टोकन को रीफ़्रेश करने के लिए, User.getIdToken() का इस्तेमाल करें.

हस्ताक्षर:

export declare function onIdTokenChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
अगला-ऑब्ज़र्वर	NextOrobr<उपयोगकर्ता>	बदलाव होने पर कॉलबैक ट्रिगर हुआ.
गड़बड़ी	ErrorFn	समर्थन नहीं होना या रुकना. यह कॉलबैक कभी ट्रिगर नहीं किया जाता. साइन इन/आउट करने पर होने वाली गड़बड़ियों को, साइन इन/साइन आउट फ़ंक्शन से लौटाए गए वादों में पकड़ा जा सकता है.
पूर्ण	CompleteFn	समर्थन नहीं होना या रुकना. यह कॉलबैक कभी ट्रिगर नहीं किया जाता.

लौटाए जाने वाले प्रॉडक्ट:

सदस्यता छोड़ें

RemoteAccessToken(auth, टोकन)

दिए गए ऐक्सेस टोकन को रद्द करता है. फ़िलहाल, यह सिर्फ़ Apple OAuth ऐक्सेस टोकन के साथ काम करता है.

हस्ताक्षर:

export declare function revokeAccessToken(auth: Auth, token: string): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
टोकन	स्ट्रिंग	Apple OAuth ऐक्सेस टोकन.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

sendPasswordResetEmail(auth, email, actionCodeSettings)

दिए गए ईमेल पते पर पासवर्ड फिर सेट करने के लिए ईमेल भेजता है. अगर दिए गए ईमेल पते वाला कोई उपयोगकर्ता खाता मौजूद न हो और ईमेल गिनती की सुरक्षा चालू हो, तो यह तरीका गड़बड़ी का मैसेज नहीं दिखाता है.

पासवर्ड रीसेट करने की प्रोसेस को पूरा करने के लिए, उपयोगकर्ता के भेजे गए नए पासवर्ड के साथ उपयोगकर्ता को भेजे गए ईमेल में दिए गए कोड के साथ confirmPasswordReset() को कॉल करें.

हस्ताक्षर:

export declare function sendPasswordResetEmail(auth: Auth, email: string, actionCodeSettings?: ActionCodeSettings): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
ईमेल	स्ट्रिंग	उपयोगकर्ता का ईमेल पता.
ActionCodeSettings	ActionCodeSettings	ActionCodeSettings.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

उदाहरण

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendPasswordResetEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain code from user.
await confirmPasswordReset('user@example.com', code);

sendSignInLinkToEmail(auth, email, actionCodeSettings)

बताए गए ईमेल से उपयोगकर्ता को साइन-इन ईमेल का लिंक भेजता है.

अन्य बैंड की ईमेल कार्रवाइयों (पासवर्ड रीसेट और ईमेल की पुष्टि) के उलट, ऐप्लिकेशन में हमेशा साइन इन की कार्रवाई पूरी होनी चाहिए. ऐसा इसलिए होता है, क्योंकि फ़्लो के आखिर में, उपयोगकर्ता के साइन इन होने की उम्मीद की जाती है. साथ ही, ऐप्लिकेशन में अनुमति की स्थिति बनी रहती है.

ईमेल लिंक की मदद से साइन इन करने के लिए, ईमेल पते और उपयोगकर्ता को भेजे गए ईमेल में दिए गए ईमेल लिंक के साथ signInWithEmailLink() को कॉल करें.

हस्ताक्षर:

export declare function sendSignInLinkToEmail(auth: Auth, email: string, actionCodeSettings: ActionCodeSettings): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना
ईमेल	स्ट्रिंग	उपयोगकर्ता का ईमेल पता.
ActionCodeSettings	ActionCodeSettings	ActionCodeSettings.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

उदाहरण

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendSignInLinkToEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
  await signInWithEmailLink(auth, 'user@example.com', emailLink);
}

setPersistence(auth, परसिस्टेंस)

यह बदलाव, मौजूदा समय में सेव किए गए Auth सेशन के लिए, Auth इंस्टेंस पर एक जैसा बना रहता है. साथ ही, यह बदलाव आने वाले समय में साइन-इन के अनुरोधों के लिए भी लागू हो जाता है. इसमें रीडायरेक्ट अनुरोधों के साथ साइन-इन भी शामिल है.

इससे साइन इन करने वाले उपयोगकर्ता के लिए, यह तय करना आसान हो जाता है कि उसके सेशन को याद रखना है या नहीं. इसकी मदद से, ऐसे ऐप्लिकेशन के लिए Auth को कभी सेट नहीं किया जा सकता जिन्हें दूसरे उपयोगकर्ता शेयर करते हैं या जिनमें संवेदनशील जानकारी होती है.

यह तरीका Node.js एनवायरमेंट में या FirebaseServerApp की मदद से बनाए गए आधिकारिक इंस्टेंस के साथ काम नहीं करता.

हस्ताक्षर:

export declare function setPersistence(auth: Auth, persistence: Persistence): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
परसिस्टेंस	परसिस्टेंस	इस्तेमाल करने के लिए परसिस्टेंस.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

एक Promise, जो परसिस्टेंस में बदलाव होने के बाद रिज़ॉल्व हो जाता है

उदाहरण

setPersistence(auth, browserSessionPersistence);

पहचान छिपाने वाली(auth)

पहचान छिपाने वाले उपयोगकर्ता के तौर पर, एसिंक्रोनस तरीके से साइन इन करता है.

अगर पहले से ही किसी अनजान उपयोगकर्ता ने साइन इन किया हुआ है, तो वह उपयोगकर्ता वापस आ जाएगा. ऐसा न होने पर, पहचान छिपाकर उपयोगकर्ता की नई पहचान बनाई जाएगी और वापस की जाएगी.

यह तरीका FirebaseServerApp की मदद से बनाए गए पुष्टि करने के इंस्टेंस के साथ काम नहीं करता.

हस्ताक्षर:

export declare function signInAnonymously(auth: Auth): Promise<UserCredential>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.

लौटाए जाने वाले प्रॉडक्ट:

वादा<Userक्रेडेंशियल>

क्रेडेंशियल सेसाइन इन क्रेडेंशियल(पुष्टि करना, क्रेडेंशियल)

दिए गए क्रेडेंशियल से एसिंक्रोनस रूप से साइन इन करता है.

क्रेडेंशियल जनरेट करने के लिए, AuthProvider का इस्तेमाल किया जा सकता है.

यह तरीका FirebaseServerApp की मदद से बनाए गए पुष्टि करने के इंस्टेंस के साथ काम नहीं करता.

हस्ताक्षर:

export declare function signInWithCredential(auth: Auth, credential: AuthCredential): Promise<UserCredential>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
क्रेडेंशियल	आधिकारिक क्रेडेंशियल	पुष्टि करने का क्रेडेंशियल.

लौटाए जाने वाले प्रॉडक्ट:

वादा<Userक्रेडेंशियल>

signInWithCustomToken(auth, customToken)

कस्टम टोकन का इस्तेमाल करके, एसिंक्रोनस साइन इन करता है.

कस्टम टोकन का इस्तेमाल, Firebase पुष्टि को मौजूदा पुष्टि करने वाले सिस्टम से इंटिग्रेट करने के लिए किया जाता है. यह ज़रूरी है कि यह टोकन, एडमिन SDK टूल में createCustomToken वाले तरीके का इस्तेमाल करके, पुष्टि करने वाले बैकएंड से जनरेट किया जाए.

अगर टोकन अमान्य है, उसकी समयसीमा खत्म हो गई है या उसे Firebase से पुष्टि करने वाली सेवा ने स्वीकार नहीं किया, तो यह गड़बड़ी के साथ फ़ेल होता है.

यह तरीका FirebaseServerApp की मदद से बनाए गए पुष्टि करने के इंस्टेंस के साथ काम नहीं करता.

हस्ताक्षर:

export declare function signInWithCustomToken(auth: Auth, customToken: string): Promise<UserCredential>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
कस्टम टोकन	स्ट्रिंग	साइन इन करने के लिए कस्टम टोकन.

लौटाए जाने वाले प्रॉडक्ट:

वादा<Userक्रेडेंशियल>

SignInWithEmailAndPassword(पुष्टि, ईमेल, पासवर्ड)

ईमेल और पासवर्ड का इस्तेमाल करके, एसिंक्रोनस तरीके से साइन इन किया जाता है.

ईमेल पते और पासवर्ड के मेल न खाने पर, ऐसा नहीं होता. जब ईमेल इन्युमेशन सुरक्षा चालू होती है, तो अमान्य ईमेल/पासवर्ड होने पर, यह तरीका "auth/अमान्य-क्रेडेंशियल" के साथ काम नहीं करता.

यह तरीका FirebaseServerApp की मदद से बनाए गए आधिकारिक इंस्टेंस पर काम नहीं करता.

हस्ताक्षर:

export declare function signInWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
ईमेल	स्ट्रिंग	उपयोगकर्ता का ईमेल पता.
पासवर्ड	स्ट्रिंग	उपयोगकर्ताओं का पासवर्ड.

लौटाए जाने वाले प्रॉडक्ट:

वादा<Userक्रेडेंशियल>

SignInWithEmailLink(पुष्टि, ईमेल, ईमेल लिंक)

ईमेल और साइन-इन ईमेल लिंक का इस्तेमाल करके एसिंक्रोनस तरीके से साइन इन किया जाता है.

अगर कोई लिंक पास नहीं किया जाता, तो उस लिंक का अनुमान मौजूदा यूआरएल से लगाया जाता है.

ईमेल पता अमान्य होने या ईमेल लिंक में ओटीपी की समयसीमा खत्म होने पर, इसे गड़बड़ी के तौर पर मार्क किया जा सकता है.

यह तरीका FirebaseServerApp की मदद से बनाए गए पुष्टि करने के इंस्टेंस के साथ काम नहीं करता.

हस्ताक्षर:

export declare function signInWithEmailLink(auth: Auth, email: string, emailLink?: string): Promise<UserCredential>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
ईमेल	स्ट्रिंग	उपयोगकर्ता का ईमेल पता.
ईमेल लिंक	स्ट्रिंग	उपयोगकर्ता के ईमेल पते पर भेजा गया लिंक.

लौटाए जाने वाले प्रॉडक्ट:

वादा<Userक्रेडेंशियल>

उदाहरण

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendSignInLinkToEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
  await signInWithEmailLink(auth, 'user@example.com', emailLink);
}

SignInWithPhoneNumber(auth, phoneNumber, appVerifier)

फ़ोन नंबर का इस्तेमाल करके एसिंक्रोनस साइन इन करता है.

इस तरीके से, दिए गए फ़ोन नंबर पर एसएमएस के ज़रिए कोड भेजा जाता है और पुष्टि का नतीजा दिखाया जाता है. जब उपयोगकर्ता अपने फ़ोन पर कोड भेज देता है, तब उपयोगकर्ता को साइन इन कराने के लिए, कोड के साथ confirmation result.confirm() को कॉल करें.

गलत इस्तेमाल की रोकथाम के लिए, इस तरीके के लिए ApplicationVerifier की भी ज़रूरत होती है. इस SDK टूल में, reCAPTCHA पर आधारित सुविधा RecaptchaVerifier शामिल है. यह फ़ंक्शन ऐसे दूसरे प्लैटफ़ॉर्म पर काम कर सकता है जिन पर ReactVerifier की तरह-तरह के काम नहीं करते. हालांकि, इसके लिए आपको तीसरे पक्ष के ApplicationVerifier का इस्तेमाल करना होगा.

यह तरीका Node.js एनवायरमेंट में या FirebaseServerApp की मदद से बनाए गए आधिकारिक इंस्टेंस के साथ काम नहीं करता.

हस्ताक्षर:

export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
फ़ोन नंबर	स्ट्रिंग	E.164 फ़ॉर्मैट में उपयोगकर्ता का फ़ोन नंबर. उदाहरण के लिए, +16505550101.
AppVerifier	ApplicationVerifier	ApplicationVerifier.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<पुष्टि करने का नतीजा>

उदाहरण

// 'recaptcha-container' is the ID of an element in the DOM.
const applicationVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container');
const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier);
// Obtain a verificationCode from the user.
const credential = await confirmationResult.confirm(verificationCode);

SignInWithPopup(auth, प्रोवाइडर, रिज़ॉल्वर)

पॉप-अप आधारित OAuth पुष्टि फ़्लो का इस्तेमाल करके, Firebase क्लाइंट की पुष्टि करता है.

अगर ऐसा हो जाता है, तो साइन इन किए हुए उपयोगकर्ता को सेवा देने वाले के क्रेडेंशियल के साथ दिखाता है. अगर साइन इन नहीं हो सका, तो यह गड़बड़ी का ऑब्जेक्ट दिखाता है. इस ऑब्जेक्ट में गड़बड़ी के बारे में ज़्यादा जानकारी होती है.

यह तरीका Node.js एनवायरमेंट में या FirebaseServerApp की मदद से बनाए गए आधिकारिक इंस्टेंस के साथ काम नहीं करता.

हस्ताक्षर:

export declare function signInWithPopup(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
कंपनी	AuthProvider	पुष्टि करने के लिए सेवा देने वाली कंपनी. सेवा देने वाली कंपनी को OAuthProvider होना चाहिए. OAuth प्रोवाइडर, जैसे कि EmailAuthProvider की सेवा देने वाली कंपनियां, गड़बड़ी का मैसेज दिखाएंगी.
रिज़ॉल्वर	पॉप-रीडायरेक्ट रिज़ॉल्वर	अगर पहले से ही enableizeAuth() पर उपलब्ध कराया गया है या getAuth() की मदद से उपलब्ध कराया गया है, तो पॉपअप-रीडायरेक्ट रिज़ॉल्वर का एक इंस्टेंस ज़रूरी नहीं होगा.

लौटाए जाने वाले प्रॉडक्ट:

वादा<Userक्रेडेंशियल>

उदाहरण

// Sign in using a popup.
const provider = new FacebookAuthProvider();
const result = await signInWithPopup(auth, provider);

// The signed-in user info.
const user = result.user;
// This gives you a Facebook Access Token.
const credential = provider.credentialFromResult(auth, result);
const token = credential.accessToken;

signInWithDirect(auth, provider, रिज़ॉल्वर)

पूरे पेज के रीडायरेक्ट फ़्लो का इस्तेमाल करके, Firebase क्लाइंट की पुष्टि करता है.

इस कार्रवाई के नतीजों और गड़बड़ियों को मैनेज करने के लिए, getRedirect प्रज़ेंटेशन() देखें. signInWithDirect() का इस्तेमाल करते समय, सबसे सही तरीके अपनाएं.

यह तरीका Node.js एनवायरमेंट में या FirebaseServerApp की मदद से बनाए गए आधिकारिक इंस्टेंस के साथ काम नहीं करता.

हस्ताक्षर:

export declare function signInWithRedirect(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
कंपनी	AuthProvider	पुष्टि करने के लिए सेवा देने वाली कंपनी. सेवा देने वाली कंपनी को OAuthProvider होना चाहिए. OAuth प्रोवाइडर, जैसे कि EmailAuthProvider की सेवा देने वाली कंपनियां, गड़बड़ी का मैसेज दिखाएंगी.
रिज़ॉल्वर	पॉप-रीडायरेक्ट रिज़ॉल्वर	अगर पहले से ही enableizeAuth() पर उपलब्ध कराया गया है या getAuth() की मदद से उपलब्ध कराया गया है, तो पॉपअप-रीडायरेक्ट रिज़ॉल्वर का एक इंस्टेंस ज़रूरी नहीं होगा.

लौटाए जाने वाले प्रॉडक्ट:

वादा<कभी नहीं>

उदाहरण

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
// You can add additional scopes to the provider:
provider.addScope('user_birthday');
// Start a sign in process for an unauthenticated user.
await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
if (result) {
  // This is the signed-in user
  const user = result.user;
  // This gives you a Facebook Access Token.
  const credential = provider.credentialFromResult(auth, result);
  const token = credential.accessToken;
}
// As this API can be used for sign-in, linking and reauthentication,
// check the operationType to determine what triggered this redirect
// operation.
const operationType = result.operationType;

साइन आउट(पुष्टि)

वर्तमान उपयोगकर्ता को साइन आउट करता है.

यह तरीका FirebaseServerApp की मदद से बनाए गए पुष्टि करने के इंस्टेंस के साथ काम नहीं करता.

हस्ताक्षर:

export declare function signOut(auth: Auth): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

updatedCurrentUser(auth, उपयोगकर्ता)

एसिंक्रोनस तरीके से, दिए गए उपयोगकर्ता को Auth इंस्टेंस पर Auth.currentUser के रूप में सेट करता है.

दिए गए उपयोगकर्ता की एक नई इंस्टेंस कॉपी बनाई जाएगी और उसे मौजूदा उपयोगकर्ता के तौर पर सेट कर दिया जाएगा.

इससे, साइन इन करने के दूसरे तरीकों की तरह, onAuthStateChanged() और onIdTokenChanged() लिसनर को ट्रिगर किया जाएगा.

अगर उपयोगकर्ता को अपडेट किया जाना है, तो वह किसी दूसरे Firebase प्रोजेक्ट से जुड़ा है. हालांकि, गड़बड़ी की वजह से यह कार्रवाई नहीं हो पाएगी.

यह तरीका FirebaseServerApp की मदद से बनाए गए पुष्टि करने के इंस्टेंस के साथ काम नहीं करता.

हस्ताक्षर:

export declare function updateCurrentUser(auth: Auth, user: User | null): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
user	उपयोगकर्ता | शून्य	नया उपयोगकर्ता.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

userdeviceLanguage(auth)

मौजूदा भाषा को डिफ़ॉल्ट डिवाइस/ब्राउज़र की प्राथमिकता पर सेट करता है.

हस्ताक्षर:

export declare function useDeviceLanguage(auth: Auth): void;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.

लौटाए जाने वाले प्रॉडक्ट:

अमान्य

पुष्टि पासवर्ड(पुष्टि, पासवर्ड)

प्रोजेक्ट या किरायेदार के लिए कॉन्फ़िगर की गई पासवर्ड नीति के आधार पर पासवर्ड की पुष्टि करता है.

अगर Auth इंस्टेंस पर कोई टेनेंट आईडी सेट नहीं है, तो यह तरीका प्रोजेक्ट के लिए कॉन्फ़िगर की गई पासवर्ड नीति का इस्तेमाल करेगा. ऐसा न करने पर, यह तरीका किरायेदार के लिए कॉन्फ़िगर की गई नीति का इस्तेमाल करेगा. अगर पासवर्ड नीति कॉन्फ़िगर नहीं की गई है, तो सभी प्रोजेक्ट के लिए कॉन्फ़िगर की गई डिफ़ॉल्ट नीति इस्तेमाल की जाएगी.

अगर सबमिट किया गया पासवर्ड इसलिए काम नहीं करता है, क्योंकि सबमिट किया गया पासवर्ड, पासवर्ड की नीति से जुड़ी ज़रूरी शर्तों को पूरा नहीं करता है और इस तरीके को पहले ही कॉल किया जा चुका है, तो इस तरीके में फिर से कॉल करने पर उपलब्ध सबसे हाल की नीति का इस्तेमाल किया जाएगा.

हस्ताक्षर:

export declare function validatePassword(auth: Auth, password: string): Promise<PasswordValidationStatus>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
पासवर्ड	स्ट्रिंग	पुष्टि करने के लिए पासवर्ड.

लौटाए जाने वाले प्रॉडक्ट:

वादा<PasswordValidationStatus>

उदाहरण

validatePassword(auth, 'some-password');

पुष्टि करेंPasswordResetCode(auth, code)

ईमेल या किसी दूसरे आउट-ऑफ़-बैंड तरीके से उपयोगकर्ता को भेजे गए पासवर्ड रीसेट कोड की जांच करता है.

हस्ताक्षर:

export declare function verifyPasswordResetCode(auth: Auth, code: string): Promise<string>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
पुष्टि	पुष्टि करना	Auth इंस्टेंस.
कोड	स्ट्रिंग	पुष्टि करने के लिए उपयोगकर्ता को कोड भेजा गया है.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<string>

अगर मान्य हो, तो उपयोगकर्ता का ईमेल पता डालें.

फ़ंक्शन(लिंक, ...)

parseActionCodeURL(लिंक)

यह ईमेल, कार्रवाई के लिंक की स्ट्रिंग को पार्स करता है. साथ ही, मान्य होने पर ActionCodeURL दिखाता है. ऐसा न होने पर, वैल्यू शून्य दिखती है.

हस्ताक्षर:

export declare function parseActionCodeURL(link: string): ActionCodeURL | null;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
लिंक	स्ट्रिंग

लौटाए जाने वाले प्रॉडक्ट:

ActionCodeURL | शून्य

फ़ंक्शन(उपयोगकर्ता, ...)

deleteUser(उपयोगकर्ता)

उपयोगकर्ता को मिटाता है और साइन आउट करता है.

हस्ताक्षर:

export declare function deleteUser(user: User): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

getIdToken(उपयोगकर्ता, forceRefresh)

यह फ़ंक्शन, Firebase सेवा में उपयोगकर्ता की पहचान करने के लिए इस्तेमाल किया जाने वाला JSON Web Token (JWT) दिखाता है.

अगर मौजूदा टोकन की समयसीमा खत्म नहीं हुई है या उसकी समयसीमा अगले पांच मिनट में खत्म नहीं होगी, तो उसे दिखाता है. ऐसा न करने पर, यह टोकन रीफ़्रेश हो जाएगा और नया टोकन दिखाएगा.

हस्ताक्षर:

export declare function getIdToken(user: User, forceRefresh?: boolean): Promise<string>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.
ज़बरदस्ती रीफ़्रेश करें	बूलियन	टोकन की समयसीमा खत्म होने पर भी इसे हर हाल में रीफ़्रेश करें.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<string>

getIdTokenresults(उपयोगकर्ता, forceRefresh)

यह फ़ंक्शन, Firebase सेवा में उपयोगकर्ता की पहचान करने के लिए इस्तेमाल किए जाने वाले, डीसीरियलाइज़्ड JSON वेब टोकन (JWT) दिखाता है.

अगर मौजूदा टोकन की समयसीमा खत्म नहीं हुई है या उसकी समयसीमा अगले पांच मिनट में खत्म नहीं होगी, तो उसे दिखाता है. ऐसा न करने पर, यह टोकन रीफ़्रेश हो जाएगा और नया टोकन दिखाएगा.

हस्ताक्षर:

export declare function getIdTokenResult(user: User, forceRefresh?: boolean): Promise<IdTokenResult>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.
ज़बरदस्ती रीफ़्रेश करें	बूलियन	टोकन की समयसीमा खत्म होने पर भी इसे हर हाल में रीफ़्रेश करें.

लौटाए जाने वाले प्रॉडक्ट:

Promise<IdTokenresults>

linkWithक्रेडेंशियल(उपयोगकर्ता, क्रेडेंशियल)

दिए गए क्रेडेंशियल से उपयोगकर्ता खाते को लिंक करता है.

क्रेडेंशियल जनरेट करने के लिए, AuthProvider का इस्तेमाल किया जा सकता है.

हस्ताक्षर:

export declare function linkWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.
क्रेडेंशियल	आधिकारिक क्रेडेंशियल	पुष्टि करने का क्रेडेंशियल.

लौटाए जाने वाले प्रॉडक्ट:

वादा<Userक्रेडेंशियल>

linkWithPhoneNumber(उपयोगकर्ता, फ़ोन नंबर, appVerifier)

दिए गए फ़ोन नंबर से उपयोगकर्ता खाते को लिंक करता है.

यह तरीका Node.js के साथ काम नहीं करता.

हस्ताक्षर:

export declare function linkWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.
फ़ोन नंबर	स्ट्रिंग	E.164 फ़ॉर्मैट में उपयोगकर्ता का फ़ोन नंबर. उदाहरण के लिए, +16505550101.
AppVerifier	ApplicationVerifier	ApplicationVerifier.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<पुष्टि करने का नतीजा>

linkWithPopup(उपयोगकर्ता, प्रोवाइडर, रिज़ॉल्वर)

पॉप-अप पर आधारित OAuth फ़्लो का इस्तेमाल करके, सेवा देने वाली उस कंपनी को उपयोगकर्ता खाते से लिंक करता है जिसकी पुष्टि की गई है.

अगर लिंक करने की प्रोसेस पूरी हो जाती है, तो लौटाए गए नतीजे में उपयोगकर्ता और सेवा देने वाली कंपनी का क्रेडेंशियल शामिल होगा.

यह तरीका Node.js के साथ काम नहीं करता.

हस्ताक्षर:

export declare function linkWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.
कंपनी	AuthProvider	पुष्टि करने के लिए सेवा देने वाली कंपनी. सेवा देने वाली कंपनी को OAuthProvider होना चाहिए. OAuth प्रोवाइडर, जैसे कि EmailAuthProvider की सेवा देने वाली कंपनियां, गड़बड़ी का मैसेज दिखाएंगी.
रिज़ॉल्वर	पॉप-रीडायरेक्ट रिज़ॉल्वर	अगर पहले से ही enableizeAuth() पर उपलब्ध कराया गया है या getAuth() की मदद से उपलब्ध कराया गया है, तो पॉपअप-रीडायरेक्ट रिज़ॉल्वर का एक इंस्टेंस ज़रूरी नहीं होगा.

लौटाए जाने वाले प्रॉडक्ट:

वादा<Userक्रेडेंशियल>

उदाहरण

// Sign in using some other provider.
const result = await signInWithEmailAndPassword(auth, email, password);
// Link using a popup.
const provider = new FacebookAuthProvider();
await linkWithPopup(result.user, provider);

linkWithredirect(उपयोगकर्ता, प्रोवाइडर, रिज़ॉल्वर)

पूरे पेज पर रीडायरेक्ट फ़्लो का इस्तेमाल करके, OAuthProvider को उपयोगकर्ता खाते से लिंक करता है.

इस कार्रवाई के नतीजों और गड़बड़ियों को मैनेज करने के लिए, getRedirectयानी() देखें. linkWithredirect() का इस्तेमाल करते समय, सबसे सही तरीके अपनाएं.

यह तरीका Node.js एनवायरमेंट में या FirebaseServerApp की मदद से बनाए गए आधिकारिक इंस्टेंस के साथ काम नहीं करता.

हस्ताक्षर:

export declare function linkWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.
कंपनी	AuthProvider	पुष्टि करने के लिए सेवा देने वाली कंपनी. सेवा देने वाली कंपनी को OAuthProvider होना चाहिए. OAuth प्रोवाइडर, जैसे कि EmailAuthProvider की सेवा देने वाली कंपनियां, गड़बड़ी का मैसेज दिखाएंगी.
रिज़ॉल्वर	पॉप-रीडायरेक्ट रिज़ॉल्वर	अगर पहले से ही enableizeAuth() पर उपलब्ध कराया गया है या getAuth() की मदद से उपलब्ध कराया गया है, तो पॉपअप-रीडायरेक्ट रिज़ॉल्वर का एक इंस्टेंस ज़रूरी नहीं होगा.

लौटाए जाने वाले प्रॉडक्ट:

वादा<कभी नहीं>

उदाहरण

// Sign in using some other provider.
const result = await signInWithEmailAndPassword(auth, email, password);
// Link using a redirect.
const provider = new FacebookAuthProvider();
await linkWithRedirect(result.user, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);

मल्टीफ़ैक्टर(उपयोगकर्ता)

उपयोगकर्ता से जुड़ा MultiFactorUser.

इसका इस्तेमाल, उपयोगकर्ता से जुड़ी सभी बहु-स्तरीय प्रॉपर्टी और कार्रवाइयों को ऐक्सेस करने के लिए किया जाता है.

हस्ताक्षर:

export declare function multiFactor(user: User): MultiFactorUser;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.

लौटाए जाने वाले प्रॉडक्ट:

मल्टीफ़ैक्टर यूज़र

क्रेडेंशियल से फिर से पुष्टि करें(उपयोगकर्ता, क्रेडेंशियल)

नए क्रेडेंशियल का इस्तेमाल करके, उपयोगकर्ता की फिर से पुष्टि करता है.

updatePassword() जैसी कार्रवाइयों से पहले इस्तेमाल करें, जिनके लिए हाल ही में साइन-इन करने के लिए टोकन की ज़रूरत होती है. इस तरीके का इस्तेमाल करके, CREDENTIAL_TOO_OLD_LOGIN_AGAIN या TOKEN_EXPIRED गड़बड़ी को ठीक किया जा सकता है.

यह तरीका ऐसे किसी भी उपयोगकर्ता के लिए काम नहीं करता जिसमें FirebaseServerApp की मदद से पुष्टि करने वाले इंस्टेंस से साइन इन किया गया हो.

हस्ताक्षर:

export declare function reauthenticateWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.
क्रेडेंशियल	आधिकारिक क्रेडेंशियल	पुष्टि करने का क्रेडेंशियल.

लौटाए जाने वाले प्रॉडक्ट:

वादा<Userक्रेडेंशियल>

फिर से पुष्टि करेंWithPhoneNumber(उपयोगकर्ता, फ़ोन नंबर, appVerifier)

नए फ़ोन क्रेडेंशियल का इस्तेमाल करके, उपयोगकर्ता की फिर से पुष्टि करता है.

updatePassword() जैसी कार्रवाइयों से पहले इस्तेमाल करें, जिनके लिए हाल ही में साइन-इन करने के लिए टोकन की ज़रूरत होती है.

यह तरीका Node.js एनवायरमेंट में या FirebaseServerApp की मदद से बनाए गए पुष्टि इंस्टेंस से साइन इन किए हुए किसी भी उपयोगकर्ता पर काम नहीं करता.

हस्ताक्षर:

export declare function reauthenticateWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.
फ़ोन नंबर	स्ट्रिंग	E.164 फ़ॉर्मैट में उपयोगकर्ता का फ़ोन नंबर. उदाहरण के लिए, +16505550101.
AppVerifier	ApplicationVerifier	ApplicationVerifier.

लौटाए जाने वाले प्रॉडक्ट:

प्रॉमिस<पुष्टि करने का नतीजा>

फिर से पुष्टि करेंWithPopup(उपयोगकर्ता, प्रोवाइडर, रिज़ॉल्वर)

पॉप-अप पर आधारित OAuth फ़्लो का इस्तेमाल करके, तय किए गए OAuthProvider की मदद से मौजूदा उपयोगकर्ता की फिर से पुष्टि करता है.

अगर फिर से पुष्टि कर ली जाती है, तो लौटाए गए नतीजे में उपयोगकर्ता और सेवा देने वाली कंपनी का क्रेडेंशियल शामिल होगा.

यह तरीका Node.js एनवायरमेंट में या FirebaseServerApp की मदद से बनाए गए पुष्टि इंस्टेंस से साइन इन किए हुए किसी भी उपयोगकर्ता पर काम नहीं करता.

हस्ताक्षर:

export declare function reauthenticateWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.
कंपनी	AuthProvider	पुष्टि करने के लिए सेवा देने वाली कंपनी. सेवा देने वाली कंपनी को OAuthProvider होना चाहिए. OAuth प्रोवाइडर, जैसे कि EmailAuthProvider की सेवा देने वाली कंपनियां, गड़बड़ी का मैसेज दिखाएंगी.
रिज़ॉल्वर	पॉप-रीडायरेक्ट रिज़ॉल्वर	अगर पहले से ही enableizeAuth() पर उपलब्ध कराया गया है या getAuth() की मदद से उपलब्ध कराया गया है, तो पॉपअप-रीडायरेक्ट रिज़ॉल्वर का एक इंस्टेंस ज़रूरी नहीं होगा.

लौटाए जाने वाले प्रॉडक्ट:

वादा<Userक्रेडेंशियल>

उदाहरण

// Sign in using a popup.
const provider = new FacebookAuthProvider();
const result = await signInWithPopup(auth, provider);
// Reauthenticate using a popup.
await reauthenticateWithPopup(result.user, provider);

फिर से पुष्टि करने के साथ-साथ रीडायरेक्ट करने वाला(उपयोगकर्ता, प्रोवाइडर, रिज़ॉल्वर)

पूरे पेज पर रीडायरेक्ट फ़्लो का इस्तेमाल करके, तय किए गए OAuthProvider की मदद से मौजूदा उपयोगकर्ता की फिर से पुष्टि करता है.

इस कार्रवाई के नतीजों और गड़बड़ियों को मैनेज करने के लिए, getRedirectयानी() देखें. reAuthorizeWithredirect() का इस्तेमाल करते समय, सबसे सही तरीके अपनाएं.

यह तरीका Node.js एनवायरमेंट में या FirebaseServerApp की मदद से बनाए गए आधिकारिक इंस्टेंस के साथ काम नहीं करता.

हस्ताक्षर:

export declare function reauthenticateWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.
कंपनी	AuthProvider	पुष्टि करने के लिए सेवा देने वाली कंपनी. सेवा देने वाली कंपनी को OAuthProvider होना चाहिए. OAuth प्रोवाइडर, जैसे कि EmailAuthProvider की सेवा देने वाली कंपनियां, गड़बड़ी का मैसेज दिखाएंगी.
रिज़ॉल्वर	पॉप-रीडायरेक्ट रिज़ॉल्वर	अगर पहले से ही enableizeAuth() पर उपलब्ध कराया गया है या getAuth() की मदद से उपलब्ध कराया गया है, तो पॉपअप-रीडायरेक्ट रिज़ॉल्वर का एक इंस्टेंस ज़रूरी नहीं होगा.

लौटाए जाने वाले प्रॉडक्ट:

वादा<कभी नहीं>

उदाहरण

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
const result = await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
// Reauthenticate using a redirect.
await reauthenticateWithRedirect(result.user, provider);
// This will again trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);

फिर से लोड करें(उपयोगकर्ता)

साइन इन होने पर, उपयोगकर्ता खाते का डेटा फिर से लोड करता है.

हस्ताक्षर:

export declare function reload(user: User): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

sendEmailverification(user, actionCodeSettings)

उपयोगकर्ता को पुष्टि करने के लिए ईमेल भेजता है.

applyActionCode() को कॉल करके पुष्टि की प्रक्रिया पूरी की गई है.

हस्ताक्षर:

export declare function sendEmailVerification(user: User, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.
ActionCodeSettings	ActionCodeSettings | शून्य	ActionCodeSettings.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

उदाहरण

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendEmailVerification(user, actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);

अनलिंक करें(user, providerId)

उपयोगकर्ता खाते से, सेवा देने वाली कंपनी को अनलिंक करता है.

हस्ताक्षर:

export declare function unlink(user: User, providerId: string): Promise<User>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.
कंपनी आईडी	स्ट्रिंग	वह कंपनी जिसे अनलिंक करना है.

लौटाए जाने वाले प्रॉडक्ट:

वादा<उपयोगकर्ता>

updatedEmail(उपयोगकर्ता, newEmail)

उपयोगकर्ता का ईमेल पता अपडेट करता है.

मूल ईमेल पते (अगर इसे सेट किया गया था) पर एक ईमेल भेजा जाएगा जो खाते को हाइजैक होने से बचाने के लिए, ईमेल पते में किए गए बदलाव को वापस लेने की अनुमति देता है.

यह तरीका ऐसे किसी भी उपयोगकर्ता के लिए काम नहीं करता जिसमें FirebaseServerApp की मदद से पुष्टि करने वाले इंस्टेंस से साइन इन किया गया हो.

हस्ताक्षर:

export declare function updateEmail(user: User, newEmail: string): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.
नया ईमेल	स्ट्रिंग	नया ईमेल पता.ईमेल एन्युमरेशन सुरक्षा के चालू होने पर, "auth/operation-not-allow" गड़बड़ी दिखाता है. अब काम नहीं करता - इसके बजाय verifybeforeUpdateEmail() का इस्तेमाल करें.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

अपडेटपासवर्ड(उपयोगकर्ता, नया पासवर्ड)

उपयोगकर्ता का पासवर्ड अपडेट करता है.

हस्ताक्षर:

export declare function updatePassword(user: User, newPassword: string): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.
नया पासवर्ड	स्ट्रिंग	नया पासवर्ड.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

अपडेटPhoneNumber(उपयोगकर्ता, क्रेडेंशियल)

उपयोगकर्ता का फ़ोन नंबर अपडेट करता है.

यह तरीका Node.js एनवायरमेंट में या FirebaseServerApp की मदद से बनाए गए पुष्टि इंस्टेंस से साइन इन किए हुए किसी भी उपयोगकर्ता पर काम नहीं करता.

हस्ताक्षर:

export declare function updatePhoneNumber(user: User, credential: PhoneAuthCredential): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.
क्रेडेंशियल	फ़ोन ऑथराइज़ेशन क्रेडेंशियल	नए फ़ोन नंबर की पुष्टि करने वाला क्रेडेंशियल.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

उदाहरण

// 'recaptcha-container' is the ID of an element in the DOM.
const applicationVerifier = new RecaptchaVerifier('recaptcha-container');
const provider = new PhoneAuthProvider(auth);
const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier);
// Obtain the verificationCode from the user.
const phoneCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
await updatePhoneNumber(user, phoneCredential);

अपडेटProfile(उपयोगकर्ता, {displayName, photoURL: photoUrl })

उपयोगकर्ता की प्रोफ़ाइल का डेटा अपडेट करता है.

हस्ताक्षर:

export declare function updateProfile(user: User, { displayName, photoURL: photoUrl }: {
    displayName?: string | null;
    photoURL?: string | null;
}): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.
{ displayName, photoURL: photoUrl }	{ displayName?: स्ट्रिंग | शून्य; photoURL?: स्ट्रिंग | null; }

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

पुष्टि करने से पहले अपडेट ईमेल(उपयोगकर्ता, नया ईमेल, ActionCodeSettings)

नए ईमेल पते पर पुष्टि करने के लिए ईमेल भेजता है.

पुष्टि होने के बाद, उपयोगकर्ता के ईमेल पते को नए ईमेल में अपडेट कर दिया जाएगा.

अगर आपके पास पसंद के मुताबिक ईमेल ऐक्शन हैंडलर है, तो applyActionCode() को कॉल करके पुष्टि की प्रक्रिया पूरी की जा सकती है.

हस्ताक्षर:

export declare function verifyBeforeUpdateEmail(user: User, newEmail: string, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
user	उपयोगकर्ता	उपयोगकर्ता.
नया ईमेल	स्ट्रिंग	अपडेट करने से पहले, पुष्टि करने के लिए नया ईमेल पता.
ActionCodeSettings	ActionCodeSettings | शून्य	ActionCodeSettings.

लौटाए जाने वाले प्रॉडक्ट:

वादा<void>

उदाहरण

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await verifyBeforeUpdateEmail(user, 'newemail@example.com', actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);

फ़ंक्शन(उपयोगकर्ता क्रेडेंशियल, ...)

getadditionalUserInfo(उपयोगकर्ता क्रेडेंशियल)

दिए गए क्रेडेंशियल के लिए, सेवा देने वाली कंपनी के खास additionalUserInfo को एक्सट्रैक्ट करता है.

हस्ताक्षर:

export declare function getAdditionalUserInfo(userCredential: UserCredential): AdditionalUserInfo | null;

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
उपयोगकर्ता क्रेडेंशियल	उपयोगकर्ता क्रेडेंशियल	उपयोगकर्ता का क्रेडेंशियल.

लौटाए जाने वाले प्रॉडक्ट:

additionalUserInfo | शून्य

कार्रवाई कोडऑपरेशन

ईमेल से जुड़ी संभावित कार्रवाइयों की सूची.

हस्ताक्षर:

ActionCodeOperation: {
    readonly EMAIL_SIGNIN: "EMAIL_SIGNIN";
    readonly PASSWORD_RESET: "PASSWORD_RESET";
    readonly RECOVER_EMAIL: "RECOVER_EMAIL";
    readonly REVERT_SECOND_FACTOR_ADDITION: "REVERT_SECOND_FACTOR_ADDITION";
    readonly VERIFY_AND_CHANGE_EMAIL: "VERIFY_AND_CHANGE_EMAIL";
    readonly VERIFY_EMAIL: "VERIFY_EMAIL";
}

AuthErrorCodes

SDK टूल से अपलोड की गई गड़बड़ियों के साथ आसानी से तुलना करने के लिए, संभावित Auth गड़बड़ी कोड का मैप.

ध्यान दें कि मैप में अलग-अलग बटनों को ट्री-शेक नहीं किया जा सकता, इसलिए मैप का इस्तेमाल करके, बंडल का साइज़ काफ़ी हद तक बढ़ाया जा सकता है.

हस्ताक्षर:

AUTH_ERROR_CODES_MAP_DO_NOT_USE_INTERNALLY: {
    readonly ADMIN_ONLY_OPERATION: "auth/admin-restricted-operation";
    readonly ARGUMENT_ERROR: "auth/argument-error";
    readonly APP_NOT_AUTHORIZED: "auth/app-not-authorized";
    readonly APP_NOT_INSTALLED: "auth/app-not-installed";
    readonly CAPTCHA_CHECK_FAILED: "auth/captcha-check-failed";
    readonly CODE_EXPIRED: "auth/code-expired";
    readonly CORDOVA_NOT_READY: "auth/cordova-not-ready";
    readonly CORS_UNSUPPORTED: "auth/cors-unsupported";
    readonly CREDENTIAL_ALREADY_IN_USE: "auth/credential-already-in-use";
    readonly CREDENTIAL_MISMATCH: "auth/custom-token-mismatch";
    readonly CREDENTIAL_TOO_OLD_LOGIN_AGAIN: "auth/requires-recent-login";
    readonly DEPENDENT_SDK_INIT_BEFORE_AUTH: "auth/dependent-sdk-initialized-before-auth";
    readonly DYNAMIC_LINK_NOT_ACTIVATED: "auth/dynamic-link-not-activated";
    readonly EMAIL_CHANGE_NEEDS_VERIFICATION: "auth/email-change-needs-verification";
    readonly EMAIL_EXISTS: "auth/email-already-in-use";
    readonly EMULATOR_CONFIG_FAILED: "auth/emulator-config-failed";
    readonly EXPIRED_OOB_CODE: "auth/expired-action-code";
    readonly EXPIRED_POPUP_REQUEST: "auth/cancelled-popup-request";
    readonly INTERNAL_ERROR: "auth/internal-error";
    readonly INVALID_API_KEY: "auth/invalid-api-key";
    readonly INVALID_APP_CREDENTIAL: "auth/invalid-app-credential";
    readonly INVALID_APP_ID: "auth/invalid-app-id";
    readonly INVALID_AUTH: "auth/invalid-user-token";
    readonly INVALID_AUTH_EVENT: "auth/invalid-auth-event";
    readonly INVALID_CERT_HASH: "auth/invalid-cert-hash";
    readonly INVALID_CODE: "auth/invalid-verification-code";
    readonly INVALID_CONTINUE_URI: "auth/invalid-continue-uri";
    readonly INVALID_CORDOVA_CONFIGURATION: "auth/invalid-cordova-configuration";
    readonly INVALID_CUSTOM_TOKEN: "auth/invalid-custom-token";
    readonly INVALID_DYNAMIC_LINK_DOMAIN: "auth/invalid-dynamic-link-domain";
    readonly INVALID_EMAIL: "auth/invalid-email";
    readonly INVALID_EMULATOR_SCHEME: "auth/invalid-emulator-scheme";
    readonly INVALID_IDP_RESPONSE: "auth/invalid-credential";
    readonly INVALID_LOGIN_CREDENTIALS: "auth/invalid-credential";
    readonly INVALID_MESSAGE_PAYLOAD: "auth/invalid-message-payload";
    readonly INVALID_MFA_SESSION: "auth/invalid-multi-factor-session";
    readonly INVALID_OAUTH_CLIENT_ID: "auth/invalid-oauth-client-id";
    readonly INVALID_OAUTH_PROVIDER: "auth/invalid-oauth-provider";
    readonly INVALID_OOB_CODE: "auth/invalid-action-code";
    readonly INVALID_ORIGIN: "auth/unauthorized-domain";
    readonly INVALID_PASSWORD: "auth/wrong-password";
    readonly INVALID_PERSISTENCE: "auth/invalid-persistence-type";
    readonly INVALID_PHONE_NUMBER: "auth/invalid-phone-number";
    readonly INVALID_PROVIDER_ID: "auth/invalid-provider-id";
    readonly INVALID_RECIPIENT_EMAIL: "auth/invalid-recipient-email";
    readonly INVALID_SENDER: "auth/invalid-sender";
    readonly INVALID_SESSION_INFO: "auth/invalid-verification-id";
    readonly INVALID_TENANT_ID: "auth/invalid-tenant-id";
    readonly MFA_INFO_NOT_FOUND: "auth/multi-factor-info-not-found";
    readonly MFA_REQUIRED: "auth/multi-factor-auth-required";
    readonly MISSING_ANDROID_PACKAGE_NAME: "auth/missing-android-pkg-name";
    readonly MISSING_APP_CREDENTIAL: "auth/missing-app-credential";
    readonly MISSING_AUTH_DOMAIN: "auth/auth-domain-config-required";
    readonly MISSING_CODE: "auth/missing-verification-code";
    readonly MISSING_CONTINUE_URI: "auth/missing-continue-uri";
    readonly MISSING_IFRAME_START: "auth/missing-iframe-start";
    readonly MISSING_IOS_BUNDLE_ID: "auth/missing-ios-bundle-id";
    readonly MISSING_OR_INVALID_NONCE: "auth/missing-or-invalid-nonce";
    readonly MISSING_MFA_INFO: "auth/missing-multi-factor-info";
    readonly MISSING_MFA_SESSION: "auth/missing-multi-factor-session";
    readonly MISSING_PHONE_NUMBER: "auth/missing-phone-number";
    readonly MISSING_SESSION_INFO: "auth/missing-verification-id";
    readonly MODULE_DESTROYED: "auth/app-deleted";
    readonly NEED_CONFIRMATION: "auth/account-exists-with-different-credential";
    readonly NETWORK_REQUEST_FAILED: "auth/network-request-failed";
    readonly NULL_USER: "auth/null-user";
    readonly NO_AUTH_EVENT: "auth/no-auth-event";
    readonly NO_SUCH_PROVIDER: "auth/no-such-provider";
    readonly OPERATION_NOT_ALLOWED: "auth/operation-not-allowed";
    readonly OPERATION_NOT_SUPPORTED: "auth/operation-not-supported-in-this-environment";
    readonly POPUP_BLOCKED: "auth/popup-blocked";
    readonly POPUP_CLOSED_BY_USER: "auth/popup-closed-by-user";
    readonly PROVIDER_ALREADY_LINKED: "auth/provider-already-linked";
    readonly QUOTA_EXCEEDED: "auth/quota-exceeded";
    readonly REDIRECT_CANCELLED_BY_USER: "auth/redirect-cancelled-by-user";
    readonly REDIRECT_OPERATION_PENDING: "auth/redirect-operation-pending";
    readonly REJECTED_CREDENTIAL: "auth/rejected-credential";
    readonly SECOND_FACTOR_ALREADY_ENROLLED: "auth/second-factor-already-in-use";
    readonly SECOND_FACTOR_LIMIT_EXCEEDED: "auth/maximum-second-factor-count-exceeded";
    readonly TENANT_ID_MISMATCH: "auth/tenant-id-mismatch";
    readonly TIMEOUT: "auth/timeout";
    readonly TOKEN_EXPIRED: "auth/user-token-expired";
    readonly TOO_MANY_ATTEMPTS_TRY_LATER: "auth/too-many-requests";
    readonly UNAUTHORIZED_DOMAIN: "auth/unauthorized-continue-uri";
    readonly UNSUPPORTED_FIRST_FACTOR: "auth/unsupported-first-factor";
    readonly UNSUPPORTED_PERSISTENCE: "auth/unsupported-persistence-type";
    readonly UNSUPPORTED_TENANT_OPERATION: "auth/unsupported-tenant-operation";
    readonly UNVERIFIED_EMAIL: "auth/unverified-email";
    readonly USER_CANCELLED: "auth/user-cancelled";
    readonly USER_DELETED: "auth/user-not-found";
    readonly USER_DISABLED: "auth/user-disabled";
    readonly USER_MISMATCH: "auth/user-mismatch";
    readonly USER_SIGNED_OUT: "auth/user-signed-out";
    readonly WEAK_PASSWORD: "auth/weak-password";
    readonly WEB_STORAGE_UNSUPPORTED: "auth/web-storage-unsupported";
    readonly ALREADY_INITIALIZED: "auth/already-initialized";
    readonly RECAPTCHA_NOT_ENABLED: "auth/recaptcha-not-enabled";
    readonly MISSING_RECAPTCHA_TOKEN: "auth/missing-recaptcha-token";
    readonly INVALID_RECAPTCHA_TOKEN: "auth/invalid-recaptcha-token";
    readonly INVALID_RECAPTCHA_ACTION: "auth/invalid-recaptcha-action";
    readonly MISSING_CLIENT_TYPE: "auth/missing-client-type";
    readonly MISSING_RECAPTCHA_VERSION: "auth/missing-recaptcha-version";
    readonly INVALID_RECAPTCHA_VERSION: "auth/invalid-recaptcha-version";
    readonly INVALID_REQ_TYPE: "auth/invalid-req-type";
}

ब्राउज़रLocalPersistence

डिवाइस के स्टोरेज के लिए localStorage का इस्तेमाल करके, LOCAL टाइप के परसिस्टेंस को लागू करना.

हस्ताक्षर:

browserLocalPersistence: Persistence

ब्राउज़रपॉप-रीडायरेक्ट रिज़ॉल्वर

ब्राउज़र पर आधारित ऐप्लिकेशन के लिए सही पॉपअप रीडायरेक्ट कंसोल को लागू किया गया हो.

यह तरीका Node.js के साथ काम नहीं करता.

हस्ताक्षर:

browserPopupRedirectResolver: PopupRedirectResolver

ब्राउज़रSessionPersistence

डिवाइस के स्टोरेज के लिए sessionStorage का इस्तेमाल करके, SESSION के परसिस्टेंस को लागू करना.

हस्ताक्षर:

browserSessionPersistence: Persistence

कॉर्डोवापॉपअप रीडायरेक्ट रिज़ॉल्वर

कोर्डोवा पर आधारित ऐप्लिकेशन के लिए सही पॉपअप रीडायरेक्टरिज़ॉल्वर को लागू किया गया है.

हस्ताक्षर:

cordovaPopupRedirectResolver: PopupRedirectResolver

डीबग एरर मैप

ज़्यादातर गड़बड़ी कोड के लिए पूरी जानकारी वाला वर्बोस गड़बड़ी मैप.

AuthErrorMap पर चर्चा देखें

हस्ताक्षर:

debugErrorMap: AuthErrorMap

गुणनखंड

यह उन फ़ैक्टर की सूची है जिनका इस्तेमाल बहु-स्तरीय पुष्टि (MFA) के लिए किया जा सकता है.

हस्ताक्षर:

FactorId: {
    readonly PHONE: "phone";
    readonly TOTP: "totp";
}

इंडेक्स DBLocalPersistence

डिवाइस के स्टोरेज के लिए indexedDB का इस्तेमाल करके, LOCAL टाइप के परसिस्टेंस को लागू करना.

हस्ताक्षर:

indexedDBLocalPersistence: Persistence

inMemoryPersistence

'NONE' टाइप के परसिस्टेंस को लागू करना.

हस्ताक्षर:

inMemoryPersistence: Persistence

ऑपरेशन टाइप

इस्तेमाल की जा सकने वाली कार्रवाइयों की सूची.

हस्ताक्षर:

OperationType: {
    readonly LINK: "link";
    readonly REAUTHENTICATE: "reauthenticate";
    readonly SIGN_IN: "signIn";
}

prodErrorMap

कम से कम गड़बड़ी वाला मैप, जिसमें बहुत ज़्यादा शब्दों में गड़बड़ी के मैसेज नहीं हैं.

AuthErrorMap पर चर्चा देखें

हस्ताक्षर:

prodErrorMap: AuthErrorMap

सेवा देने वाली कंपनी का आईडी

सेवा देने वाली कंपनियों की गिनती.

हस्ताक्षर:

ProviderId: {
    readonly FACEBOOK: "facebook.com";
    readonly GITHUB: "github.com";
    readonly GOOGLE: "google.com";
    readonly PASSWORD: "password";
    readonly PHONE: "phone";
    readonly TWITTER: "twitter.com";
}

साइन-इन करने का तरीका

साइन-इन करने के इस्तेमाल किए जा सकने वाले तरीकों की गिनती.

हस्ताक्षर:

SignInMethod: {
    readonly EMAIL_LINK: "emailLink";
    readonly EMAIL_PASSWORD: "password";
    readonly FACEBOOK: "facebook.com";
    readonly GITHUB: "github.com";
    readonly GOOGLE: "google.com";
    readonly PHONE: "phone";
    readonly TWITTER: "twitter.com";
}

कस्टम पैरामीटर

OAuth कस्टम पैरामीटर का मैप.

हस्ताक्षर:

export declare type CustomParameters = Record<string, string>;

NextOrऑब्ज़र्वर

इवेंट कॉलबैक के लिए परिभाषा टाइप करें.

हस्ताक्षर:

export declare type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;

फ़ोनजानकारी के विकल्प

किसी फ़ोन नंबर के मालिकाना हक की पुष्टि करने के लिए ज़रूरी जानकारी.

ज़रूरी जानकारी इस बात पर निर्भर करती है कि आपने सिंगल-फ़ैक्टर साइन-इन, बहु-स्तरीय (MFA) या बहु-स्तरीय पुष्टि (MFA) की सुविधा चालू की है या नहीं.

हस्ताक्षर:

export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;

उपयोगकर्ता प्रोफ़ाइल

additionalUserInfo में इस्तेमाल की गई उपयोगकर्ता प्रोफ़ाइल.

हस्ताक्षर:

export declare type UserProfile = Record<string, unknown>;