auth package

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

फ़ंक्शन

फ़ंक्शन ब्यौरा
फ़ंक्शन(ऐप्लिकेशन, ...)
getAuth(ऐप्लिकेशन) दिए गए FirebaseApp से जुड़ा ऑथराइज़ेशन इंस्टेंस दिखाता है. अगर कोई इंस्टेंस मौजूद नहीं है, तो प्लैटफ़ॉर्म के हिसाब से डिफ़ॉल्ट डिपेंडेंसी के साथ पुष्टि इंस्टेंस शुरू करता है.
initializeAuth(ऐप्लिकेशन, Deps) यह डिपेंडेंसी पर बारीकी से कंट्रोल करने के साथ, किसी ऑथर इंस्टेंस को शुरू करता है.
फ़ंक्शन(स्टोरेज, ...)
getReactNativePersistence(स्टोरेज) यह फ़ंक्शन एक पर्सेंटेंस ऑब्जेक्ट दिखाता है, जो react-native या @react-native-community/async-storage से इंपोर्ट किए गए AsyncStorage को रैप करता है. साथ ही, इसका इस्तेमाल initializeAuth() में परसिस्टेंस डिपेंडेंसी फ़ील्ड में किया जा सकता है.
फ़ंक्शन(auth, ...)
applyActionCode(auth, oobCode) पुष्टि करने के लिए वह कोड लागू किया जाता है जो उपयोगकर्ता को ईमेल या अन्य आउट-ऑफ़-बैंड तरीके से भेजा जाता है.
beforeAuthStateChanged(auth, कॉलबैक, on दिमाग) ब्लॉक करने वाला कॉलबैक जोड़ता है, जो पुष्टि की स्थिति में बदलाव होने से पहले नया उपयोगकर्ता सेट करता है.
checkActionCode(auth, oobCode) पुष्टि करने के लिए, उपयोगकर्ता को ईमेल या अन्य आउट-ऑफ़-बैंड तरीके से भेजे गए कोड की जांच करता है.
confirmPasswordReset(auth, oobCode, newPassword) पुष्टि करने वाला कोड और नया पासवर्ड दिए जाने पर, पासवर्ड रीसेट करने की प्रोसेस पूरी हो जाती है.
connectAuthEmulator(पुष्टि करने का लिंक, यूआरएल, विकल्प) यह विकल्प, प्रोडक्शन Firebase पुष्टि सेवाओं के बजाय, Firebase के पुष्टि करने वाले टूल से संपर्क करने के लिए, Auth इंस्टेंस को बदलता है.
createUserWithEmailAndPassword(पुष्टि करने की सुविधा, ईमेल, पासवर्ड) तय किए गए ईमेल पते और पासवर्ड से जुड़ा एक नया उपयोगकर्ता खाता बनाता है.
फ़ेचSignInMethodsForEmail(auth, ईमेल) दिए गए ईमेल पते के लिए, साइन इन करने के संभावित तरीकों की सूची दिखाता है. ईमेल की गिनती से जुड़ी सुरक्षा चालू होने पर, यह तरीका खाली सूची दिखाता है. भले ही, दिए गए ईमेल के लिए पुष्टि करने के कितने भी तरीके उपलब्ध हों.
getMultiFactor Chromecastr(auth, गड़बड़ी) यह एक मल्टीफ़ैक्टर रिज़ॉल्वर उपलब्ध कराता है, जो मल्टी-फ़ैक्टर फ़्लो को पूरा करने के लिए सही होता है.
getredirectresults(auth, रिज़ॉल्वर) रीडायरेक्ट पर आधारित साइन-इन फ़्लो से UserCredential दिखाता है.
beginizeReCapConfig(auth) यह reCAPTCHA कॉन्फ़िगरेशन को Auth इंस्टेंस में लोड करता है.
isSignInWithEmailLink(auth, emailLink) यह जांच करता है कि क्या कोई इनकमिंग लिंक signInWithEmailLink() के लिए सही ईमेल लिंक से साइन-इन कर रहा है या नहीं.
onAuthStateChanged(auth, NextOrObserver, गड़बड़ी, पूरा हुआ) उपयोगकर्ता की साइन-इन स्थिति में बदलाव के लिए, एक ऑब्ज़र्वर जोड़ता है.
onIdTokenChanged(auth, NextOrObserver, गड़बड़ी, पूरा हुआ) साइन-इन किए हुए उपयोगकर्ता के आईडी टोकन में बदलाव के लिए, एक ऑब्ज़र्वर जोड़ता है.
RevokeAccessToken(पुष्टि, टोकन) दिए गए ऐक्सेस टोकन को रद्द करता है. फ़िलहाल, सिर्फ़ Apple OAuth ऐक्सेस टोकन इस्तेमाल किए जा सकते हैं.
sendPasswordResetEmail(auth, ईमेल, actionCodeSettings) दिए गए ईमेल पते पर पासवर्ड रीसेट ईमेल भेजता है. अगर दिए गए ईमेल पते वाला कोई उपयोगकर्ता खाता नहीं होता है और ईमेल इन्यूमरेशन सुरक्षा चालू होती है, तो यह तरीका गड़बड़ी की सूचना नहीं देता.
sendSignInLinkToEmail(auth, ईमेल, actionCodeSettings) तय किए गए ईमेल के साथ, उपयोगकर्ता को साइन इन करने के लिए लिंक भेजता है.
setPersistence(पुष्टि, परसिस्टेंस) मौजूदा सेव किए गए Auth सेशन के लिए, ऑथर इंस्टेंस पर परसिस्टेंस का टाइप बदलता है. साथ ही, आने वाले समय में साइन-इन करने के अनुरोधों के लिए, इस तरह की परसिस्टेंस को लागू करता है. इसमें रीडायरेक्ट के अनुरोधों के साथ साइन-इन करना भी शामिल है.
signInAnonymously(auth) एसिंक्रोनस तरीके से पहचान छिपाने वाले उपयोगकर्ता के तौर पर साइन इन करता है.
signInWithCredential(auth, क्रेडेंशियल) दिए गए क्रेडेंशियल के साथ एसिंक्रोनस तरीके से साइन इन करता है.
signInWithCustomToken(auth, customToken) कस्टम टोकन का इस्तेमाल करके, एसिंक्रोनस तरीके से साइन इन करता है.
signInWithEmailAndPassword(auth, ईमेल, पासवर्ड) ईमेल और पासवर्ड का इस्तेमाल करके एसिंक्रोनस तरीके से साइन इन किया जाता है.
signInWithEmailLink(auth, ईमेल, emailLink) ईमेल और साइन-इन ईमेल लिंक का इस्तेमाल करके, एसिंक्रोनस तरीके से साइन इन किया जाता है.
signInWithPhoneNumber(auth, फ़ोनNumber, appVerifier) फ़ोन नंबर का इस्तेमाल करके एसिंक्रोनस तरीके से साइन इन करता है.
signInWithPopup(auth, प्रोवाइडर, रिज़ॉल्वर) पॉप-अप पर आधारित OAuth की पुष्टि करने के फ़्लो का इस्तेमाल करके, Firebase क्लाइंट की पुष्टि करता है.
signInWith रीडायरेक्ट(auth, प्रोवाइडर, रिज़ॉल्वर) पूरे पेज के रीडायरेक्ट फ़्लो का इस्तेमाल करके, Firebase क्लाइंट की पुष्टि करता है.
signOut(auth) इससे मौजूदा उपयोगकर्ता को साइन आउट कर दिया जाता है.
updateCurrentUser(पुष्टि करने का अनुरोध, उपयोगकर्ता) दिए गए उपयोगकर्ता को Auth इंस्टेंस पर एसिंक्रोनस तरीके से, Auth.currentUser के तौर पर सेट करता है.
useDeviceLanguage(auth) इससे मौजूदा भाषा, डिवाइस या ब्राउज़र की डिफ़ॉल्ट भाषा पर सेट हो जाती है.
VerifyPassword(auth, पासवर्ड) प्रोजेक्ट या टेनेंट के लिए कॉन्फ़िगर की गई पासवर्ड नीति से पासवर्ड की पुष्टि करता है.
verifyPasswordResetCode(auth, code) यह पासवर्ड रीसेट करने के उस कोड की जांच करता है जो उपयोगकर्ता को ईमेल या अन्य आउट-ऑफ़-बैंड तरीके से भेजा जाता है.
फ़ंक्शन(लिंक, ...)
parseActionCodeURL(लिंक) यह विकल्प, ईमेल से की जाने वाली कार्रवाई के लिंक की स्ट्रिंग को पार्स करता है. साथ ही, अगर लिंक मान्य है, तो ActionCodeURL की वैल्यू दिखाता है. ऐसा न होने पर, कोई वैल्यू नहीं दिखती है.
फ़ंक्शन(उपयोगकर्ता, ...)
deleteUser(उपयोगकर्ता) उपयोगकर्ता को मिटाता है और साइन आउट कर देता है.
getIdToken(user, forceRefresh) यह विकल्प JSON वेब टोकन (JWT) को दिखाता है, ताकि उपयोगकर्ता को Firebase सेवा का इस्तेमाल करने की पहचान करने के लिए इस्तेमाल किया जा सके.
getIdTokenresults(user, forceRefresh) यह डीसीरियलाइज़्ड JSON वेब टोकन (JWT) दिखाता है, ताकि उपयोगकर्ता को Firebase सेवा पर पहचानने में मदद मिल सके.
linkWithCredential(उपयोगकर्ता, क्रेडेंशियल) दिए गए क्रेडेंशियल के साथ उपयोगकर्ता खाते को लिंक करता है.
linkWithPhoneNumber(उपयोगकर्ता, फ़ोननंबर, appVerifier) उपयोगकर्ता के खाते को दिए गए फ़ोन नंबर से लिंक करता है.
linkWithPopup(उपयोगकर्ता, सेवा देने वाला, रिज़ॉल्वर) पुष्टि की गई सेवा देने वाली कंपनी को, पॉप-अप पर आधारित OAuth फ़्लो का इस्तेमाल करके, उपयोगकर्ता खाते से लिंक करता है.
linkWithredirect(उपयोगकर्ता, सेवा देने वाली कंपनी, रिज़ॉल्वर) पूरे पेज के रीडायरेक्ट फ़्लो का इस्तेमाल करके, OAuthProvider को उपयोगकर्ता खाते से लिंक करता है.
कई फ़ैक्टर(उपयोगकर्ता) उपयोगकर्ता से जुड़ा MultiFactorUser.
reauthentlateWithCredential(उपयोगकर्ता, क्रेडेंशियल) नए क्रेडेंशियल का इस्तेमाल करके, उपयोगकर्ता की फिर से पुष्टि करता है.
reauthentlateWithPhoneNumber(उपयोगकर्ता, फ़ोननंबर, appVerifier) नए फ़ोन क्रेडेंशियल का इस्तेमाल करके, उपयोगकर्ता की फिर से पुष्टि की जाती है.
reauthentlateWithPopup(उपयोगकर्ता, सेवा देने वाला, रिज़ॉल्वर) पॉप-अप आधारित OAuth फ़्लो का इस्तेमाल करके, तय किए गए OAuthProvider की मदद से, मौजूदा उपयोगकर्ता की फिर से पुष्टि करता है.
reauthentlateWithredirect(उपयोगकर्ता, प्रोवाइडर, रिज़ॉल्वर) पूरे पेज के रीडायरेक्ट फ़्लो का इस्तेमाल करके, तय किए गए OAuthProvider की मदद से, मौजूदा उपयोगकर्ता की फिर से पुष्टि करता है.
फिर से लोड करें(उपयोगकर्ता) अगर उपयोगकर्ता ने साइन इन किया है, तो खाते का डेटा फिर से लोड करता है.
sendEmailverification(उपयोगकर्ता, ActionCodeSettings) उपयोगकर्ता को पुष्टि करने के लिए एक ईमेल भेजता है.
अनलिंक करना(user, providerId) सेवा देने वाली कंपनी को उपयोगकर्ता खाते से अनलिंक करता है.
updateEmail(उपयोगकर्ता, नया ईमेल) उपयोगकर्ता का ईमेल पता अपडेट करता है.
updatePassword(user, newPassword) उपयोगकर्ता के पासवर्ड को अपडेट करता है.
updatePhoneNumber(उपयोगकर्ता, क्रेडेंशियल) उपयोगकर्ता का फ़ोन नंबर अपडेट करता है.
updateProfile(user, { displayName, photoURL: photoUrl }) यह किसी उपयोगकर्ता की प्रोफ़ाइल के डेटा को अपडेट करता है.
VerifybeforeUpdateEmail(उपयोगकर्ता, newEmail, actionCodeSettings) नए ईमेल पते पर पुष्टि करने के लिए लिंक भेजता है.
फ़ंक्शन(userCredential, ...)
getadditionalUserInfo(userCredential) दिए गए क्रेडेंशियल के लिए, सेवा देने वाली कंपनी के additionalUserInfo की जानकारी एक्सट्रैक्ट करता है.

क्लास

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

इंटरफ़ेस

इंटरफ़ेस ब्यौरा
ActionCodeInfo checkActionCode() से मिला जवाब.
ActionCodeSettings ऐसा इंटरफ़ेस जो ज़रूरी जारी/स्टेट यूआरएल के बारे में जानकारी देता है. इसमें Android और iOS बंडल के वैकल्पिक आइडेंटिफ़ायर शामिल होते हैं.
अतिरिक्त उपयोगकर्ता की जानकारी ऐसा स्ट्रक्चर जिसमें फ़ेडरेटेड आइडेंटिटी प्रोवाइडर से मिली अतिरिक्त उपयोगकर्ता जानकारी शामिल होती है.
ApplicationVerifier डोमेन की पुष्टि करने और गलत इस्तेमाल को रोकने के लिए पुष्टि करने वाला टूल.
आधिकारिक Firebase पुष्टि करने वाली सेवा दिखाने वाला इंटरफ़ेस.
AuthError Auth गड़बड़ी के लिए इंटरफ़ेस.
AuthErrormap गड़बड़ी के मैसेज में गड़बड़ी के कोड को मैप करना.
AuthProvider ऐसा इंटरफ़ेस जो पुष्टि करने वाली कंपनी के बारे में बताता है. इसका इस्तेमाल AuthCredential बनाने में किया जाता है.
AuthSettings Auth इंस्टेंस की सेटिंग दिखाने वाला इंटरफ़ेस.
कॉन्फ़िगरेशन Auth कॉन्फ़िगरेशन दिखाने वाला इंटरफ़ेस.
पुष्टि करने का नतीजा किसी फ़ोन नंबर पर साइन इन करने, लिंक करने या कॉल की फिर से पुष्टि करने का नतीजा.
डिपेंडेंसी वे डिपेंडेंसी जिनका इस्तेमाल किसी Auth इंस्टेंस को शुरू करने के लिए किया जा सकता है.
EmulatorConfig Firebase ऑथेंटिकेशन एम्युलेटर का कॉन्फ़िगरेशन.
IdTokenनतीजे User.getIdTokenresults() से मिले आईडी टोकन के नतीजे को दिखाने वाला इंटरफ़ेस.
कई तरीकों से पुष्टि दूसरे फ़ैक्टर के मालिकाना हक का दावा करने के लिए बेस क्लास.
मल्टीफ़ैक्टर एरर यह गड़बड़ी तब होती है, जब उपयोगकर्ता को साइन इन करने के लिए दूसरा चरण पूरा करने की ज़रूरत होती है.
कई तरीकों से जानकारी ऐसी संरचना जिसमें दूसरे कारक की इकाई की जानकारी होती है.
मल्टीफ़ैक्टर रिज़ॉल्वर वह क्लास जिसका इस्तेमाल MultiFactorError से गड़बड़ी को ठीक करने के लिए किया जाता है, जब किसी उपयोगकर्ता को साइन इन करने के लिए दूसरा चरण देने की ज़रूरत होती है.
मल्टीफ़ैक्टर सेशन मल्टी-फ़ैक्टर सेशन ऑब्जेक्ट के बारे में बताने वाला इंटरफ़ेस. इसका इस्तेमाल, किसी उपयोगकर्ता पर दूसरा फ़ैक्टर रजिस्टर करने या दूसरे फ़ैक्टर से रजिस्टर किए गए उपयोगकर्ता को साइन इन करने में मदद करने के लिए किया जाता है.
मल्टीफ़ैक्टर यूज़र ऐसा इंटरफ़ेस जो किसी उपयोगकर्ता से जुड़ी कई तरीकों से जुड़ी प्रॉपर्टी और कार्रवाइयों के बारे में जानकारी देता है.
OAuthCredentialOptions OAuthCredential को शुरू करने के विकल्पों के बारे में बताता है.
ParsedToken पार्स किया गया आईडी टोकन दिखाने वाला इंटरफ़ेस.
पासवर्ड नीति पासवर्ड नीति की ज़रूरी शर्तों को बताने वाला स्ट्रक्चर.
पासवर्ड की पुष्टि की स्थिति ऐसा स्ट्रक्चर जो बताता है कि पासवर्ड की किन ज़रूरी शर्तों को पूरा किया गया है या किन शर्तों का उल्लंघन किया गया है और क्या ज़रूरी हैं.
परसिस्टेंस एक ऐसा इंटरफ़ेस जिसमें अलग-अलग तरह के परसिस्टेंस देने के तरीके बताए गए हैं.
फ़ोन मल्टीफ़ैक्टर Assertion फ़ोन के दूसरे कारक के मालिकाना हक का दावा करने वाली श्रेणी. PhoneMultiFactorGenerator.acertion() ने उपलब्ध कराया.
PhoneMultiFactorEnrollInfoOptions दूसरे चरण को रजिस्टर करने के लिए इस्तेमाल किए जाने वाले विकल्प.
फ़ोन मल्टीफ़ैक्टर की जानकारी फ़ोन नंबर के दूसरे फ़ैक्टर के लिए MultiFactorInfo इंटरफ़ेस की सब-क्लास. इस दूसरे फ़ैक्टर का factorId FactorId.PHONE है.
PhoneMultiFactorSignInInfoOptions दूसरे चरण से साइन इन करने के लिए इस्तेमाल किए जाने वाले विकल्प.
फ़ोन के सिंगल-फ़ैक्टर की जानकारी के विकल्प एक तरीके से साइन-इन करने के लिए इस्तेमाल किए जाने वाले विकल्प.
पॉपअप रीडायरेक्ट रिज़ॉल्वर एक रिज़ॉल्वर, जिसका इस्तेमाल signInWithPopup() या signInWithredirect() जैसी डीओएम से जुड़ी खास कार्रवाइयों को मैनेज करने के लिए किया जाता है.
ReactNativeAsyncStorage दिए गए AsyncStorage के लिए इंटरफ़ेस.
ReCapपैरामीटर reCAPTCHA पैरामीटर को दिखाने वाला इंटरफ़ेस.स्वीकार किए गए पैरामीटर की सूची के लिए, re कैप्चा दस्तावेज़ देखें. sitekey को छोड़कर सभी पैरामीटर स्वीकार किए जाते हैं: Firebase पुष्टि हर प्रोजेक्ट के लिए एक reCAPTCHA का प्रावधान करता है और रेंडर करने के दौरान साइट कुंजी को कॉन्फ़िगर करेगा.नहीं दिखने वाले reCAPTCHA के लिए, size कुंजी को invisible पर सेट करें.
TotpMultiFactorAssertion टीओटीपी के दूसरे फ़ैक्टर के मालिकाना हक के बारे में दावा करने वाली क्लास. यह जानकारी, TotpMultiFactorGenerator.asrtionForEnrollment() और TotpMultiFactorGenerator.easertionForSignIn() से मिलती है.
TotpMultiFactorInfo TOTP के दूसरे फ़ैक्टर के लिए MultiFactorInfo इंटरफ़ेस की सब-क्लास. इस दूसरे फ़ैक्टर का factorId FactorId.TOTP है.
उपयोगकर्ता उपयोगकर्ता खाता.
UserCredential एक स्ट्रक्चर, जिसमें User, OperationType, और सेवा देने वाली कंपनी का आईडी शामिल है.
उपयोगकर्ता की जानकारी उपयोगकर्ता की प्रोफ़ाइल की जानकारी, सिर्फ़ Firebase प्रोजेक्ट में मौजूद ऐप्लिकेशन को दिखती है.
उपयोगकर्ता का मेटाडेटा उपयोगकर्ता के मेटाडेटा को दिखाने वाला इंटरफ़ेस.

वैरिएबल

वैरिएबल ब्यौरा
ActionCode Operations संभावित ईमेल कार्रवाई के टाइप की सूची.
AuthErrorCodes Auth गड़बड़ी के संभावित कोड का मैप, ताकि SDK टूल की ओर से बताई गई गड़बड़ियों के साथ आसानी से तुलना की जा सके.
browserLocalPersistence मौजूदा स्टोरेज के लिए localStorage का इस्तेमाल करके, LOCAL टाइप की परसिस्टेंस लागू करने की प्रोसेस.
ब्राउज़रपॉपअप रीडायरेक्ट रिज़ॉल्वर ब्राउज़र पर आधारित ऐप्लिकेशन के लिए सही PopupTransfer युवाr को लागू करना.
ब्राउज़र सेशन परसिस्टेंस मौजूदा स्टोरेज के लिए, sessionStorage का इस्तेमाल करके SESSION की परसिस्टेंस लागू करना.
कोर्डोवापॉपअप रीडायरेक्ट रिज़ॉल्वर Cordava पर आधारित ऐप्लिकेशन के लिए सही popupredirect युवा को लागू करना.
डीबगगड़बड़ी मैप ज़्यादा जानकारी वाला गड़बड़ी वाला मैप, जिसमें ज़्यादातर गड़बड़ी कोड के बारे में पूरी जानकारी दी गई है.AuthErrorMap पर चर्चा देखें
फ़ैक्टर आईडी उन फ़ैक्टर की सूची जिनका इस्तेमाल मल्टीफ़ैक्टर पुष्टि के लिए किया जा सकता है.
indexedDBLocalPersistence मौजूदा स्टोरेज के लिए indexedDB का इस्तेमाल करके, LOCAL टाइप की परसिस्टेंस लागू करने की प्रोसेस.
मेमोरी परसिस्टेंस 'NONE' टाइप के परसिस्टेंस को लागू करना.
ऑपरेशन टाइप काम करने वाले अलग-अलग तरह के ऑपरेशन की जानकारी.
प्रोडक्शनगड़बड़ी मैप कम से कम गड़बड़ी वाला मैप, जिसमें ज़्यादा शब्दों वाली गड़बड़ी के मैसेज हटा दिए गए हैं.AuthErrorMap पर चर्चा देखें
प्रोवाइडर आईडी काम करने वाली कंपनियों की गिनती.
SignInMethod साइन-इन करने के लिए इस्तेमाल किए जा सकने वाले तरीकों की गिनती.

उपनामों का प्रकार

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

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

आधिकारिक

इनिशलाइज़ऑथर(ऐप्लिकेशन, deps)

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

यह फ़ंक्शन 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;

पैरामीटर

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

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

आधिकारिक

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

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 इंस्टेंस.
oobCode स्ट्रिंग उपयोगकर्ता को पुष्टि करने के लिए कोड भेजा गया.

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

प्रॉमिस<void>

beforeAuthStateChanged(auth, कॉलबैक, onतय)

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

हस्ताक्षर:

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

पैरामीटर

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

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

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

CheckActionCode(auth, oobCode)

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<ActionCodeInfo>

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

पक्का करें कि पासवर्ड रीसेट करें(auth, oobCode, newPassword)

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<void>

ConnectAuthEmulator(auth, यूआरएल, विकल्प)

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

अमान्य

उदाहरण

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

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

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

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<UserCredential>

फ़ेचSignInMethodsForEmail(पुष्टि, ईमेल)

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

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर टाइप ब्यौरा
प्रमाणीकरण आधिकारिक Auth इंस्टेंस.
ईमेल स्ट्रिंग उपयोगकर्ता का ईमेल पता.अब काम नहीं करता. सुरक्षा के सबसे सही तरीके के तौर पर, इस तरीके को माइग्रेट करने की सलाह दी जाती है. ज़्यादा जानकारी के लिए, ईमेल इन्यूमरेशन प्रोटेक्शन के लिए, Identity प्लैटफ़ॉर्म के दस्तावेज़ पढ़ें.

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

Promise&lt;string[]&gt;

getमल्टीफ़ैक्टर रिज़ॉल्वर(पुष्टि, गड़बड़ी)

यह एक मल्टीफ़ैक्टर रिज़ॉल्वर उपलब्ध कराता है, जो मल्टी-फ़ैक्टर फ़्लो को पूरा करने के लिए सही होता है.

हस्ताक्षर:

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

पैरामीटर

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

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

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

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

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

Promise<UserCredential | शून्य>

उदाहरण

// 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;

इनिशिएलाइज़रे कैप्चा कॉन्फ़िगरेशन(ऑथराइज़ेशन)

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

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

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

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

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर टाइप ब्यौरा
प्रमाणीकरण आधिकारिक Auth इंस्टेंस.

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

प्रॉमिस<void>

उदाहरण

initializeRecaptchaConfig(auth);

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर टाइप ब्यौरा
प्रमाणीकरण आधिकारिक Auth इंस्टेंस.
ईमेललिंक स्ट्रिंग यह लिंक, उपयोगकर्ता के ईमेल पते पर भेजा गया था.

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

बूलियन

onAuthStateChanged(auth, nextOrObserver, गड़बड़ी, पूरा हुआ)

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

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

onIdTokenChanged(auth, nextOrObserver, गड़बड़ी, पूरा हुआ)

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

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

वापस ऐक्सेस-टोकन(अनुमति, टोकन)

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<void>

भेजेंपासवर्ड रीसेट ईमेल(auth, ईमेल, 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 protected]',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendPasswordResetEmail(auth, '[email protected]', actionCodeSettings);
// Obtain code from user.
await confirmPasswordReset('[email protected]', code);

sendSignInLinkToEmail(auth, ईमेल, 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 protected]',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendSignInLinkToEmail(auth, '[email protected]', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
  await signInWithEmailLink(auth, '[email protected]', emailLink);
}

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

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

इससे साइन इन करने वाले उपयोगकर्ता के लिए, यह तय करना आसान हो जाता है कि उसके सेशन को याद रखा जाना चाहिए या नहीं. इससे, अन्य उपयोगकर्ताओं के साथ शेयर किए गए या संवेदनशील जानकारी वाले ऐप्लिकेशन के लिए, Auth की स्थिति को कभी भी बनाए रखने की सुविधा मिलती है.

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<void>

पर्सिस्टेंस में किए गए बदलाव के पूरा होने के बाद, Promise ठीक हो जाएगा

उदाहरण

setPersistence(auth, browserSessionPersistence);

गुमनाम रूप से साइन इन करें(पुष्टि)

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

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

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर टाइप ब्यौरा
प्रमाणीकरण आधिकारिक Auth इंस्टेंस.

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

प्रॉमिस<UserCredential>

SignInWithCredential(अनुमति, क्रेडेंशियल)

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<UserCredential>

signInWithCustomToken(auth, customToken)

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

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<UserCredential>

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

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<UserCredential>

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

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

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

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर टाइप ब्यौरा
प्रमाणीकरण आधिकारिक Auth इंस्टेंस.
ईमेल स्ट्रिंग उपयोगकर्ता का ईमेल पता.
ईमेललिंक स्ट्रिंग यह लिंक, उपयोगकर्ता के ईमेल पते पर भेजा गया था.

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

प्रॉमिस<UserCredential>

उदाहरण

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

signInWithPhoneNumber(auth, फ़ोनNumber, appVerifier)

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

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

गलत इस्तेमाल को रोकने के लिए, इस तरीके को इस्तेमाल करने के लिए ApplicationVerifier की भी ज़रूरत होती है. इस SDK टूल में reCAPTCHA पर आधारित, Re कैप्चाVerifier लागू किया गया है. यह फ़ंक्शन उन प्लैटफ़ॉर्म पर काम कर सकता है जो Re कैप्चाVerifier के साथ काम नहीं करते (जैसे- React Native), लेकिन आपको तीसरे पक्ष के ApplicationVerifier को लागू करने की ज़रूरत होगी.

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर टाइप ब्यौरा
प्रमाणीकरण आधिकारिक Auth इंस्टेंस.
फ़ोन नंबर स्ट्रिंग उपयोगकर्ता का फ़ोन नंबर, E.164 फ़ॉर्मैट में हो (उदाहरण, +16505550101).
ऐपवैरिफ़ायर ApplicationVerifier ApplicationVerifier.

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

प्रॉमिस<Confirmationresults>

उदाहरण

// '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 की मदद से बनाए गए Auth इंस्टेंस के साथ काम नहीं करता है.

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<UserCredential>

उदाहरण

// 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;

signInWithredirect(पुष्टि करने वाला, सेवा देने वाली कंपनी, रिज़ॉल्वर)

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

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

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर टाइप ब्यौरा
प्रमाणीकरण आधिकारिक Auth इंस्टेंस.
कंपनी AuthProvider पुष्टि करने के लिए, सेवा देने वाली कंपनी. सेवा देने वाली कंपनी को एक OAuthProvider होना चाहिए. EmailAuthProvider जैसे बिना OAuth की सेवा देने वाली कंपनियों को गड़बड़ी का मैसेज मिलेगा.
रिज़ॉल्वर पॉपअप रीडायरेक्ट रिज़ॉल्वर Popupredirect युवा के में इसलिए शामिल है, अगर इसे पहले ही initializeAuth() को दिया गया है या 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;

साइनआउट(auth)

इससे मौजूदा उपयोगकर्ता को साइन आउट कर दिया जाता है.

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर टाइप ब्यौरा
प्रमाणीकरण आधिकारिक Auth इंस्टेंस.

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

प्रॉमिस<void>

updatedCurrentUser(पुष्टि करने की सुविधा, उपयोगकर्ता)

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

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

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<void>

DeviceLanguage(अनुमति) का इस्तेमाल करें

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर टाइप ब्यौरा
प्रमाणीकरण आधिकारिक Auth इंस्टेंस.

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

अमान्य

VerifyPassword(auth, पासवर्ड)

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<PasswordValidationStatus>

उदाहरण

validatePassword(auth, 'some-password');

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<string>

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

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

ParsActionCodeURL(लिंक)

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

हस्ताक्षर:

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

पैरामीटर

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

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

ActionCodeURL | शून्य

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<void>

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<string>

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<IdTokenresults>

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<UserCredential>

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<Confirmationresults>

linkWithPopup(उपयोगकर्ता, सेवा देने वाला, रिज़ॉल्वर)

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<UserCredential>

उदाहरण

// 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 को उपयोगकर्ता खाते से लिंक करता है.

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

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर टाइप ब्यौरा
user उपयोगकर्ता उपयोगकर्ता.
कंपनी AuthProvider पुष्टि करने के लिए, सेवा देने वाली कंपनी. सेवा देने वाली कंपनी को एक OAuthProvider होना चाहिए. EmailAuthProvider जैसे बिना OAuth की सेवा देने वाली कंपनियों को गड़बड़ी का मैसेज मिलेगा.
रिज़ॉल्वर पॉपअप रीडायरेक्ट रिज़ॉल्वर Popupredirect युवा के में इसलिए शामिल है, अगर इसे पहले ही initializeAuth() को दिया गया है या 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 की मदद से बनाए गए Auth इंस्टेंस से साइन इन करने वाले किसी भी उपयोगकर्ता के लिए काम नहीं करता.

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<UserCredential>

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

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<Confirmationresults>

reauthentlateWithPopup(उपयोगकर्ता, सेवा देने वाला, रिज़ॉल्वर)

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<UserCredential>

उदाहरण

// 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 की मदद से, मौजूदा उपयोगकर्ता की फिर से पुष्टि करता है.

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

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर टाइप ब्यौरा
user उपयोगकर्ता उपयोगकर्ता.
कंपनी AuthProvider पुष्टि करने के लिए, सेवा देने वाली कंपनी. सेवा देने वाली कंपनी को एक OAuthProvider होना चाहिए. EmailAuthProvider जैसे बिना OAuth की सेवा देने वाली कंपनियों को गड़बड़ी का मैसेज मिलेगा.
रिज़ॉल्वर पॉपअप रीडायरेक्ट रिज़ॉल्वर Popupredirect युवा के में इसलिए शामिल है, अगर इसे पहले ही initializeAuth() को दिया गया है या 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>

भेजें ईमेल पुष्टि(उपयोगकर्ता, 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 protected]',
  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);

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<उपयोगकर्ता>

अपडेट ईमेल(उपयोगकर्ता, नया ईमेल)

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

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

यह तरीका, FirebaseServerApp की मदद से बनाए गए Auth इंस्टेंस से साइन इन करने वाले किसी भी उपयोगकर्ता के लिए काम नहीं करता.

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<void>

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<void>

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<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);

updatedProfile(user, { 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?: स्ट्रिंग | null; 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 protected]',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await verifyBeforeUpdateEmail(user, '[email protected]', actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);

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

अतिरिक्त उपयोगकर्ता जानकारी(उपयोगकर्ता क्रेडेंशियल) पाएं

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

हस्ताक्षर:

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

पैरामीटर

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

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

additionalUserInfo | शून्य

ActionCodeऑपरेशन

संभावित ईमेल कार्रवाई के टाइप की सूची.

हस्ताक्षर:

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

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

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

हस्ताक्षर:

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";
}

ब्राउज़रस्थानीयपरसिस्टेंस

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

हस्ताक्षर:

browserLocalPersistence: Persistence

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

ब्राउज़र पर आधारित ऐप्लिकेशन के लिए सही PopupTransfer युवाr को लागू करना.

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

हस्ताक्षर:

browserPopupRedirectResolver: PopupRedirectResolver

ब्राउज़र सेशन परसिस्टेंस

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

हस्ताक्षर:

browserSessionPersistence: Persistence

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

Cordava पर आधारित ऐप्लिकेशन के लिए सही popupredirect युवा को लागू करना.

हस्ताक्षर:

cordovaPopupRedirectResolver: PopupRedirectResolver

डीबगगड़बड़ीमैप

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

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

हस्ताक्षर:

debugErrorMap: AuthErrorMap

फ़ैक्टरआईडी

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

हस्ताक्षर:

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

इंडेक्स किया गया DBLocalPersistence

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

हस्ताक्षर:

indexedDBLocalPersistence: Persistence

मेमोरी परसिस्टेंस

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

हस्ताक्षर:

inMemoryPersistence: Persistence

OperationType

काम करने वाले अलग-अलग तरह के ऑपरेशन की जानकारी.

हस्ताक्षर:

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

प्रोडक्शन एररमैप

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

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>;

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

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

ज़रूरी जानकारी इस बात पर निर्भर करती है कि साइन-इन किया जा रहा है या नहीं, एक से ज़्यादा तरीकों से साइन-इन किया जा रहा है या फिर एक से ज़्यादा तरीकों से साइन-इन किया जा रहा है.

हस्ताक्षर:

export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;

UserProfile

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

हस्ताक्षर:

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