auth package

फायरबेस प्रमाणीकरण

कार्य

समारोह विवरण
फ़ंक्शन (ऐप, ...)
getAuth(ऐप) दिए गए FirebaseApp से संबद्ध प्रामाणिक उदाहरण लौटाता है . यदि कोई उदाहरण मौजूद नहीं है, तो प्लेटफ़ॉर्म-विशिष्ट डिफ़ॉल्ट निर्भरता के साथ एक प्रामाणिक उदाहरण प्रारंभ करता है।
इनिशियलाइज़ऑथ(ऐप, डीपीएस) निर्भरता पर सूक्ष्म नियंत्रण के साथ एक प्रामाणिक उदाहरण प्रारंभ करता है .
फ़ंक्शन (भंडारण, ...)
getReactNativePersistence(भंडारण) एक दृढ़ता ऑब्जेक्ट लौटाता है जो react-native या @react-native-community/async-storage से आयातित AsyncStorage लपेटता है, और इसे इनिशियलाइज़ऑथ() में दृढ़ता निर्भरता फ़ील्ड में उपयोग किया जा सकता है .
फ़ंक्शन (प्रामाणिक, ...)
अप्लाईएक्शनकोड(ऑथ, ओओबीकोड) उपयोगकर्ता को ईमेल या अन्य आउट-ऑफ़-बैंड तंत्र द्वारा भेजा गया सत्यापन कोड लागू करता है।
beforeAuthStateChanged(auth, कॉलबैक, onAbort) एक ब्लॉकिंग कॉलबैक जोड़ता है जो ऑथ स्थिति परिवर्तन से पहले चलता है और एक नया उपयोगकर्ता सेट करता है।
चेकएक्शनकोड(ऑथ, ओओबीकोड) उपयोगकर्ता को ईमेल या अन्य आउट-ऑफ़-बैंड तंत्र द्वारा भेजे गए सत्यापन कोड की जाँच करता है।
कन्फर्मपासवर्डरीसेट(ऑथ, ओओबीकोड, न्यूपासवर्ड) एक पुष्टिकरण कोड और नया पासवर्ड देकर, पासवर्ड रीसेट प्रक्रिया पूरी करता है।
कनेक्टऑथएमुलेटर(ऑथ, यूआरएल, विकल्प) फायरबेस ऑथेंटिक सेवाओं के उत्पादन के बजाय, फायरबेस ऑथेंटिक एमुलेटर के साथ संचार करने के लिए ऑथ इंस्टेंस को बदलता है।
createUserWithEmailAndPassword(प्रमाणीकरण, ईमेल, पासवर्ड) निर्दिष्ट ईमेल पते और पासवर्ड से संबद्ध एक नया उपयोगकर्ता खाता बनाता है।
FetchSignInMethodsForEmail(auth, ईमेल) दिए गए ईमेल पते के लिए संभावित साइन इन तरीकों की सूची प्राप्त करता है। [ईमेल गणना सुरक्षा](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) सक्षम होने पर यह विधि एक खाली सूची लौटाती है, भले ही प्रमाणीकरण विधियों की संख्या कितनी भी उपलब्ध हो। ईमेल दिया गया.
getMultiFactorResolver(प्रमाणीकरण, त्रुटि) बहु-कारक प्रवाह को पूरा करने के लिए उपयुक्त मल्टीफ़ैक्टर रिज़ॉल्वर प्रदान करता है।
getRedirectResult(auth, रिज़ॉल्वर) रीडायरेक्ट-आधारित साइन-इन प्रवाह से एक उपयोगकर्ता क्रेडेंशियल लौटाता है।
इनिशियलाइज़RecaptchaConfig(auth) ReCAPTCHA कॉन्फ़िगरेशन को Auth उदाहरण में लोड करता है।
isSignInWithEmailLink(auth, emailLink) जाँचता है कि कोई आने वाला लिंक साइन-इन है या नहीं, साइनइनविथईमेललिंक() के लिए उपयुक्त ईमेल लिंक के साथ .
onAuthStateChanged(auth, NextOrObserver, त्रुटि, पूर्ण) उपयोगकर्ता की साइन-इन स्थिति में परिवर्तन के लिए एक पर्यवेक्षक जोड़ता है।
onIdTokenChanged(auth, NextOrObserver, त्रुटि, पूर्ण) साइन-इन किए गए उपयोगकर्ता के आईडी टोकन में परिवर्तन के लिए एक पर्यवेक्षक जोड़ता है।
रिवोकएक्सेसटोकन(प्रमाणीकरण, टोकन) दिए गए एक्सेस टोकन को रद्द कर देता है। वर्तमान में केवल Apple OAuth एक्सेस टोकन का समर्थन करता है।
सेंडपासवर्डरीसेटईमेल(ऑथ, ईमेल, एक्शनकोडसेटिंग्स) दिए गए ईमेल पते पर पासवर्ड रीसेट ईमेल भेजता है। जब दिए गए ईमेल पते के साथ कोई उपयोगकर्ता खाता नहीं है और [ईमेल गणना सुरक्षा] (https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) सक्षम है तो यह विधि कोई त्रुटि नहीं देती है .
भेजेंSignInLinkToEmail(auth, ईमेल, ActionCodeSettings) निर्दिष्ट ईमेल के साथ उपयोगकर्ता को एक साइन-इन ईमेल लिंक भेजता है।
setPersistence (प्रमाणीकरण, दृढ़ता) वर्तमान में सहेजे गए Auth सत्र के लिए प्रामाणिक उदाहरण पर दृढ़ता के प्रकार को बदलता है और रीडायरेक्ट अनुरोधों के साथ साइन-इन सहित भविष्य के साइन-इन अनुरोधों के लिए इस प्रकार की दृढ़ता को लागू करता है।
साइनइनअनाम रूप से(auth) एक अज्ञात उपयोगकर्ता के रूप में एसिंक्रोनस रूप से साइन इन करें।
साइनइनविथक्रेडेंशियल(प्रमाणीकरण, क्रेडेंशियल) दिए गए क्रेडेंशियल के साथ अतुल्यकालिक रूप से साइन इन करें।
साइनइनविथकस्टमटोकन(प्रमाणीकरण, कस्टमटोकन) एक कस्टम टोकन का उपयोग करके अतुल्यकालिक रूप से साइन इन करें।
साइनइनविथईमेलएंडपासवर्ड(प्रमाणीकरण, ईमेल, पासवर्ड) ईमेल और पासवर्ड का उपयोग करके असिंक्रोनस रूप से साइन इन करें।
साइनइनविथईमेललिंक(प्रमाणीकरण, ईमेल, ईमेललिंक) ईमेल और साइन-इन ईमेल लिंक का उपयोग करके अतुल्यकालिक रूप से साइन इन करें।
साइनइनविथफ़ोननंबर(प्रमाणीकरण, फ़ोननंबर, ऐपसत्यापनकर्ता) फ़ोन नंबर का उपयोग करके अतुल्यकालिक रूप से साइन इन करें।
साइनइनविथपॉपअप(प्रमाणीकरण, प्रदाता, रिज़ॉल्वर) पॉपअप-आधारित OAuth प्रमाणीकरण प्रवाह का उपयोग करके फायरबेस क्लाइंट को प्रमाणित करता है।
साइनइनविथरीडायरेक्ट(प्रमाणीकरण, प्रदाता, रिज़ॉल्वर) पूर्ण-पृष्ठ रीडायरेक्ट प्रवाह का उपयोग करके फ़ायरबेस क्लाइंट को प्रमाणित करता है।
साइनआउट(प्रमाणीकरण) वर्तमान उपयोगकर्ता को साइन आउट करता है.
updateCurrentUser(auth, उपयोगकर्ता) एसिंक्रोनस रूप से प्रदान किए गए उपयोगकर्ता को Auth उदाहरण पर Auth.currentUser के रूप में सेट करता है।
यूज़डिवाइसलैंग्वेज(auth) वर्तमान भाषा को डिफ़ॉल्ट डिवाइस/ब्राउज़र प्राथमिकता पर सेट करता है।
मान्य पासवर्ड (प्रमाणीकरण, पासवर्ड) प्रोजेक्ट या टैनेंट के लिए कॉन्फ़िगर की गई पासवर्ड नीति के विरुद्ध पासवर्ड को मान्य करता है।
VerifyPasswordResetCode(auth, कोड) ईमेल या अन्य आउट-ऑफ़-बैंड तंत्र द्वारा उपयोगकर्ता को भेजे गए पासवर्ड रीसेट कोड की जाँच करता है।
फ़ंक्शन (लिंक, ...)
पार्सएक्शनकोडयूआरएल(लिंक) ईमेल एक्शन लिंक स्ट्रिंग को पार्स करता है और यदि लिंक मान्य है तो ActionCodeURL लौटाता है, अन्यथा शून्य लौटाता है।
फ़ंक्शन (उपयोगकर्ता, ...)
हटाएँउपयोगकर्ता(उपयोगकर्ता) उपयोगकर्ता को हटाता है और साइन आउट करता है.
getIdToken(उपयोगकर्ता, ForceRefresh) उपयोगकर्ता को फायरबेस सेवा में पहचानने के लिए उपयोग किया जाने वाला JSON वेब टोकन (JWT) लौटाता है।
getIdTokenResult(उपयोगकर्ता, ForceRefresh) फ़ायरबेस सेवा में उपयोगकर्ता की पहचान करने के लिए उपयोग किया जाने वाला डिसेरिएलाइज़्ड JSON वेब टोकन (JWT) लौटाता है।
लिंकविथक्रेडेंशियल (उपयोगकर्ता, क्रेडेंशियल) उपयोगकर्ता खाते को दिए गए क्रेडेंशियल्स से लिंक करता है।
लिंकविथफ़ोननंबर(उपयोगकर्ता, फ़ोननंबर, ऐपसत्यापनकर्ता) उपयोगकर्ता खाते को दिए गए फ़ोन नंबर से लिंक करता है।
लिंकविथपॉपअप (उपयोगकर्ता, प्रदाता, रिज़ॉल्वर) पॉप-अप आधारित OAuth प्रवाह का उपयोग करके प्रमाणित प्रदाता को उपयोगकर्ता खाते से लिंक करता है।
linkWithRedirect (उपयोगकर्ता, प्रदाता, रिज़ॉल्वर) पूर्ण-पृष्ठ पुनर्निर्देशन प्रवाह का उपयोग करके OAuthProvider को उपयोगकर्ता खाते से लिंक करता है।
मल्टीफ़ैक्टर (उपयोगकर्ता) उपयोगकर्ता के अनुरूप MultiFactorUser .
क्रेडेंशियल के साथ पुन: प्रमाणित करें (उपयोगकर्ता, क्रेडेंशियल) ताज़ा क्रेडेंशियल का उपयोग करके उपयोगकर्ता को पुनः प्रमाणित करता है।
फ़ोननंबर के साथ पुन: प्रमाणित करें(उपयोगकर्ता, फ़ोननंबर, ऐपसत्यापनकर्ता) ताज़ा फ़ोन क्रेडेंशियल का उपयोग करके उपयोगकर्ता को पुनः प्रमाणित करता है।
ReauthenticateWithPopup(उपयोगकर्ता, प्रदाता, रिज़ॉल्वर) पॉप-अप आधारित OAuth प्रवाह का उपयोग करके वर्तमान उपयोगकर्ता को निर्दिष्ट OAuthProvider के साथ पुनः प्रमाणित करता है।
reauthenticateWithRedirect (उपयोगकर्ता, प्रदाता, रिज़ॉल्वर) पूर्ण-पृष्ठ रीडायरेक्ट प्रवाह का उपयोग करके निर्दिष्ट OAuthProvider के साथ वर्तमान उपयोगकर्ता को पुनः प्रमाणित करता है।
पुनः लोड करें (उपयोगकर्ता) यदि साइन इन है तो उपयोगकर्ता खाता डेटा पुनः लोड करता है।
ईमेलसत्यापन भेजें(उपयोगकर्ता, एक्शनकोडसेटिंग्स) किसी उपयोगकर्ता को सत्यापन ईमेल भेजता है.
अनलिंक (उपयोगकर्ता, प्रदाता आईडी) किसी प्रदाता को उपयोगकर्ता खाते से अनलिंक करता है।
अद्यतनईमेल(उपयोगकर्ता, नयाईमेल) उपयोगकर्ता का ईमेल पता अपडेट करता है.
अद्यतन पासवर्ड (उपयोगकर्ता, नया पासवर्ड) उपयोगकर्ता का पासवर्ड अपडेट करता है.
अपडेटफोननंबर(उपयोगकर्ता, क्रेडेंशियल) उपयोगकर्ता का फ़ोन नंबर अपडेट करता है.
अपडेटप्रोफाइल (उपयोगकर्ता, {डिस्प्लेनाम, फोटोयूआरएल: फोटोयूआरएल }) उपयोगकर्ता का प्रोफ़ाइल डेटा अपडेट करता है.
VerifyBeforeUpdateEmail(उपयोगकर्ता, newEmail, ActionCodeSettings) एक नए ईमेल पते पर सत्यापन ईमेल भेजता है।
फ़ंक्शन (उपयोगकर्ता क्रेडेंशियल, ...)
getAdditionalUserInfo(userCredential) दिए गए क्रेडेंशियल के लिए प्रदाता विशिष्ट ExtraUserInfo निकालता है।

कक्षाओं

कक्षा विवरण
एक्शनकोडयूआरएल पासवर्ड रीसेट, ईमेल सत्यापन, ईमेल लिंक साइन इन आदि जैसे ईमेल कार्रवाई यूआरएल को पार्स करने के लिए एक उपयोगिता वर्ग।
प्रामाणिक क्रेडेंशियल इंटरफ़ेस जो AuthProvider द्वारा लौटाए गए क्रेडेंशियल्स का प्रतिनिधित्व करता है .
ईमेलऑथक्रेडेंशियल इंटरफ़ेस जो प्रदाताआईडी के लिए ईमेलऑथप्रोवाइडर द्वारा लौटाए गए क्रेडेंशियल्स का प्रतिनिधित्व करता है ।पासवर्ड
ईमेल प्रमाणीकरण प्रदाता ईमेलऑथक्रेडेंशियल उत्पन्न करने के लिए प्रदाता .
FacebookAuthProvider प्रदाता आईडी के लिए OAuthCredential उत्पन्न करने के लिए प्रदाता ।फेसबुक।
GithubAuthप्रदाता प्रदाता आईडी के लिए OAuthCredential उत्पन्न करने के लिए प्रदाता .गीथूब।
GoogleAuthProvider प्रदाता आईडी के लिए OAuthCredential उत्पन्न करने के लिए प्रदाता ।गूगल।
OAuthक्रेडेंशियल OAuthProvider द्वारा लौटाए गए OAuth क्रेडेंशियल का प्रतिनिधित्व करता है .
OAuthप्रदाता सामान्य OAuthCredential उत्पन्न करने के लिए प्रदाता .
फ़ोनप्रामाणिकक्रेडेंशियल PhoneAuthProvider द्वारा लौटाए गए क्रेडेंशियल्स का प्रतिनिधित्व करता है .
फ़ोन प्रमाणीकरण प्रदाता PhoneAuthCredential बनाने के लिए प्रदाता .
फोन मल्टीफैक्टर जेनरेटर PhoneMultiFactorAssertion उत्पन्न करने के लिए प्रदाता .
रिकैप्चा सत्यापनकर्ता एक रीकैप्चा -आधारित एप्लिकेशन सत्यापनकर्ता।
SAMLAuthप्रदाता एसएएमएल के लिए एक प्रामाणिक प्रदाता
टोटपमल्टीफैक्टर जेनरेटर TotpMultiFactorAssertion उत्पन्न करने के लिए प्रदाता .
टोटपसीक्रेट TotpMultiFactorAssertion उत्पन्न करने के लिए प्रदाता . समय-आधारित ओटीपी उत्पन्न करने के लिए साझा गुप्त कुंजी और अन्य मापदंडों को संग्रहीत करता है। साझा गुप्त कुंजी को पुनः प्राप्त करने और एक क्यूआर कोड यूआरएल उत्पन्न करने के तरीकों को लागू करता है।
TwitterAuthProvider प्रदाता आईडी के लिए OAuthCredential उत्पन्न करने के लिए प्रदाता ।ट्विटर।

इंटरफेस

इंटरफेस विवरण
एक्शनकोडइन्फो checkActionCode() से एक प्रतिक्रिया .
एक्शनकोडसेटिंग्स एक इंटरफ़ेस जो वैकल्पिक एंड्रॉइड और आईओएस बंडल पहचानकर्ताओं के साथ आवश्यक जारी/स्थिति यूआरएल को परिभाषित करता है।
अतिरिक्त उपयोगकर्ता जानकारी एक संरचना जिसमें फ़ेडरेटेड पहचान प्रदाता से अतिरिक्त उपयोगकर्ता जानकारी शामिल है।
अनुप्रयोगसत्यापनकर्ता डोमेन सत्यापन और दुरुपयोग की रोकथाम के लिए एक सत्यापनकर्ता।
प्रमाणीकरण फ़ायरबेस प्रामाणिक सेवा का प्रतिनिधित्व करने वाला इंटरफ़ेस।
लेखकत्रुटि Auth त्रुटि के लिए इंटरफ़ेस.
AuthErrorMap त्रुटि संदेशों के लिए त्रुटि कोड का मानचित्रण।
प्रामाणिकप्रदाता इंटरफ़ेस जो एक प्रामाणिक प्रदाता का प्रतिनिधित्व करता है, जिसका उपयोग प्रामाणिक क्रेडेंशियल बनाने की सुविधा के लिए किया जाता है .
प्रामाणिकसेटिंग्स इंटरफ़ेस एक प्रामाणिक उदाहरण की सेटिंग्स का प्रतिनिधित्व करता है।
कॉन्फ़िग Auth कॉन्फिगरेशन का प्रतिनिधित्व करने वाला इंटरफ़ेस।
पुष्टिकरणपरिणाम फ़ोन नंबर साइन-इन, लिंक, या पुनःप्रमाणित कॉल का परिणाम।
निर्भरताएँ निर्भरताएँ जिनका उपयोग किसी प्रामाणिक उदाहरण को आरंभ करने के लिए किया जा सकता है।
एमुलेटर कॉन्फिग फायरबेस प्रमाणीकरण एमुलेटर का कॉन्फ़िगरेशन।
IdTokenResult User.getIdTokenResult() से प्राप्त आईडी टोकन परिणाम का प्रतिनिधित्व करने वाला इंटरफ़ेस .
मल्टीफ़ैक्टर अभिकथन दूसरे कारक के स्वामित्व का दावा करने के लिए आधार वर्ग।
मल्टीफैक्टरत्रुटि त्रुटि तब उत्पन्न हुई जब उपयोगकर्ता को सफलतापूर्वक साइन इन करने के लिए दूसरा कारक प्रदान करने की आवश्यकता होती है।
मल्टीफ़ैक्टरइन्फो एक संरचना जिसमें दूसरे कारक इकाई की जानकारी होती है।
मल्टीफ़ैक्टर रिज़ॉल्वर जब किसी उपयोगकर्ता को साइन इन करने के लिए दूसरा कारक प्रदान करने की आवश्यकता होती है, तो मल्टीफ़ैक्टर एरर से पुनर्प्राप्ति की सुविधा के लिए क्लास का उपयोग किया जाता है।
मल्टीफ़ैक्टर सत्र बहु-कारक सत्र ऑब्जेक्ट को परिभाषित करने वाला एक इंटरफ़ेस जिसका उपयोग किसी उपयोगकर्ता पर दूसरे कारक को नामांकित करने या दूसरे कारक के साथ नामांकित उपयोगकर्ता को साइन इन करने में मदद करने के लिए किया जाता है।
मल्टीफ़ैक्टर उपयोगकर्ता एक इंटरफ़ेस जो उपयोगकर्ता से संबंधित बहु-कारक संबंधित गुणों और संचालन को परिभाषित करता है .
OAuthCredentialOptions OAuthCredential प्रारंभ करने के लिए विकल्पों को परिभाषित करता है .
पार्सडटोकन पार्स किए गए आईडी टोकन का प्रतिनिधित्व करने वाला इंटरफ़ेस।
पासवर्ड नीति पासवर्ड नीति आवश्यकताओं को निर्दिष्ट करने वाली एक संरचना।
पासवर्डसत्यापनस्थिति एक संरचना जो दर्शाती है कि कौन सी पासवर्ड नीति आवश्यकताओं को पूरा किया गया या उल्लंघन किया गया और आवश्यकताएँ क्या हैं।
अटलता संभावित दृढ़ता तंत्र प्रकारों को कवर करने वाला एक इंटरफ़ेस।
फ़ोनमल्टीफ़ैक्टर अभिकथन फ़ोन के दूसरे कारक के स्वामित्व का दावा करने के लिए वर्ग। PhoneMultiFactorGenerator.assertion() द्वारा प्रदान किया गया .
फ़ोनमल्टीफ़ैक्टरएनरोलइन्फोऑप्शंस दूसरे कारक को नामांकित करने के लिए उपयोग किए जाने वाले विकल्प।
फोनमल्टीफैक्टरइन्फो फ़ोन नंबर दूसरे कारकों के लिए मल्टीफ़ैक्टरइन्फो इंटरफ़ेस का उपवर्ग। इस दूसरे कारक का factorId FactorId है ।फ़ोन।
फ़ोनमल्टीफैक्टरसाइनइनइन्फोऑप्शंस दूसरे कारक के साथ साइन इन करने के लिए उपयोग किए जाने वाले विकल्प।
फ़ोनसिंगलफैक्टरइन्फोऑप्शंस एकल-कारक साइन-इन के लिए उपयोग किए जाने वाले विकल्प।
पॉपअपरीडायरेक्टरिज़ॉल्वर एक रिज़ॉल्वर जिसका उपयोग DOM विशिष्ट संचालन जैसे साइनइनविथपॉपअप() या साइनइनविथरीडायरेक्ट() को संभालने के लिए किया जाता है .
ReactNativeAsyncStorage आपूर्ति किए गए AsyncStorage के लिए इंटरफ़ेस।
रिकैप्चा पैरामीटर्स इंटरफ़ेस reCAPTCHA पैरामीटर का प्रतिनिधित्व करता है। स्वीकृत मापदंडों की सूची के लिए [reCAPTCHA दस्तावेज़](https://developers.google.com/recaptcha/docs/display#render_param) देखें। sitekey को छोड़कर सभी पैरामीटर स्वीकार किए जाते हैं: फायरबेस ऑथ प्रत्येक प्रोजेक्ट के लिए एक रीकैप्चा का प्रावधान करता है और रेंडरिंग पर साइट कुंजी को कॉन्फ़िगर करेगा। अदृश्य रीकैप्चा के लिए, size कुंजी को invisible पर सेट करें।
TotpMultiFactorAssertion टीओटीपी दूसरे कारक के स्वामित्व का दावा करने के लिए वर्ग। TotpMultiFactorGenerator.assertionForEnrollment() और TotpMultiFactorGenerator.assertionForSignIn() द्वारा प्रदान किया गया .
TotpMultiFactorInfo TOTP दूसरे कारकों के लिए MultiFactorInfo इंटरफ़ेस का उपवर्ग। इस दूसरे कारक का factorId FactorId है .TOTP.
उपयोगकर्ता एक उपयोगकर्ता खाता.
उपयोगकर्ता क्रेडेंशियल एक संरचना जिसमें एक उपयोगकर्ता है , ऑपरेशन प्रकार , और प्रदाता आईडी।
उपयोगकर्ता जानकारी उपयोगकर्ता प्रोफ़ाइल जानकारी, केवल फ़ायरबेस प्रोजेक्ट के ऐप्स पर दिखाई देती है।
उपयोगकर्तामेटाडेटा उपयोगकर्ता के मेटाडेटा का प्रतिनिधित्व करने वाला इंटरफ़ेस।

चर

चर विवरण
एक्शनकोडऑपरेशन संभावित ईमेल कार्रवाई प्रकारों की गणना.
AuthErrorCodes एसडीके द्वारा फेंकी गई त्रुटियों के साथ आसान तुलना के लिए संभावित Auth त्रुटि कोड का एक मानचित्र।
ब्राउज़रलोकलपर्सिस्टेंस अंतर्निहित भंडारण के लिए localStorage उपयोग करके LOCAL प्रकार की दृढ़ता का कार्यान्वयन।
ब्राउज़रपॉपअपरीडायरेक्टरिसॉल्वर ब्राउज़र आधारित अनुप्रयोगों के लिए उपयुक्त PopupRedirectResolver का कार्यान्वयन।
ब्राउज़र सत्र दृढ़ता अंतर्निहित भंडारण के लिए sessionStorage का उपयोग करके SESSION की दृढ़ता का कार्यान्वयन।
कॉर्डोवापॉपअपरीडायरेक्टरिज़ॉल्वर कॉर्डोवा आधारित अनुप्रयोगों के लिए उपयुक्त PopupRedirectResolver का कार्यान्वयन।
डिबगत्रुटि मानचित्र अधिकांश त्रुटि कोड के विस्तृत विवरण के साथ एक वर्बोज़ त्रुटि मानचित्र। AuthErrorMap पर चर्चा देखें
FactorId कारकों की एक सूची जिसका उपयोग बहुकारक प्रमाणीकरण के लिए किया जा सकता है।
अनुक्रमितDBLocalPersistence अंतर्निहित भंडारण के लिए indexedDB का उपयोग करके LOCAL प्रकार की दृढ़ता का कार्यान्वयन।
इनमेमोरीपर्सिस्टेंस 'कोई नहीं' प्रकार की दृढ़ता का कार्यान्वयन।
ऑपरेशन प्रकार समर्थित ऑपरेशन प्रकारों की गणना.
prodErrorMap सभी वर्बोज़ त्रुटि संदेशों के साथ एक न्यूनतम त्रुटि मानचित्र हटा दिया गया। AuthErrorMap पर चर्चा देखें
प्रदाता आईडी समर्थित प्रदाताओं की गणना.
साइन इन विधि समर्थित साइन-इन विधियों की गणना.

उपनाम टाइप करें

उपनाम टाइप करें विवरण
कस्टम पैरामीटर्स OAuth कस्टम पैरामीटर्स का मानचित्र.
NextOrObserver इवेंट कॉलबैक के लिए परिभाषा टाइप करें।
फ़ोन जानकारी विकल्प फ़ोन नंबर के स्वामित्व को सत्यापित करने के लिए आवश्यक जानकारी।
उपयोगकर्ता रूपरेखा AdditionUserInfo में उपयोगकर्ता प्रोफ़ाइल का उपयोग किया गया .

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

getAuth(ऐप)

दिए गए FirebaseApp से संबद्ध प्रामाणिक उदाहरण लौटाता है . यदि कोई उदाहरण मौजूद नहीं है, तो प्लेटफ़ॉर्म-विशिष्ट डिफ़ॉल्ट निर्भरता के साथ एक प्रामाणिक उदाहरण प्रारंभ करता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
अनुप्रयोग फायरबेस ऐप फायरबेस ऐप।

रिटर्न:

प्रमाणीकरण

इनिशियलाइज़ऑथ(ऐप, डीपीएस)

निर्भरता पर सूक्ष्म नियंत्रण के साथ एक प्रामाणिक उदाहरण प्रारंभ करता है .

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

उदाहरण के लिए, यदि आपका ऐप केवल गुमनाम खातों का उपयोग करता है और आप केवल वर्तमान सत्र के लिए खातों को सहेजना चाहते हैं, तो इसके साथ Auth प्रारंभ करें:

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
अनुप्रयोग फायरबेस ऐप
विभाग निर्भरताएँ

रिटर्न:

प्रमाणीकरण

फ़ंक्शन (भंडारण, ...)

getReactNativePersistence(भंडारण)

एक दृढ़ता ऑब्जेक्ट लौटाता है जो react-native या @react-native-community/async-storage से आयातित AsyncStorage लपेटता है , और इनिशियलाइज़ऑथ() में दृढ़ता निर्भरता क्षेत्र में उपयोग किया जा सकता है .

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
भंडारण ReactNativeAsyncStorage

रिटर्न:

अटलता

फ़ंक्शन (प्रामाणिक, ...)

अप्लाईएक्शनकोड(ऑथ, ओओबीकोड)

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
oobCode डोरी उपयोगकर्ता को एक सत्यापन कोड भेजा गया.

रिटर्न:

वादा<शून्य>

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

एक ब्लॉकिंग कॉलबैक जोड़ता है जो ऑथ स्थिति परिवर्तन से पहले चलता है और एक नया उपयोगकर्ता सेट करता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
वापस बुलाओ (उपयोगकर्ता: उपयोगकर्ता | शून्य) => शून्य | वादा<शून्य> नया उपयोगकर्ता मान सेट होने से पहले कॉलबैक ट्रिगर हो गया। यदि यह थ्रो होता है, तो यह उपयोगकर्ता को सेट होने से रोकता है।
गर्भपात पर () => शून्य यदि बाद में beforeAuthStateChanged() कॉलबैक फेंकता है, तो कॉलबैक ट्रिगर हो जाता है, जिससे आप किसी भी दुष्प्रभाव को पूर्ववत कर सकते हैं।

रिटर्न:

सदस्यता रद्द

चेकएक्शनकोड(ऑथ, ओओबीकोड)

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
oobCode डोरी उपयोगकर्ता को एक सत्यापन कोड भेजा गया.

रिटर्न:

वादा< ActionCodeInfo >

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

कन्फर्मपासवर्डरीसेट(ऑथ, ओओबीकोड, न्यूपासवर्ड)

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
oobCode डोरी उपयोगकर्ता को एक पुष्टिकरण कोड भेजा गया।
नया पासवर्ड डोरी नया पासवर्ड.

रिटर्न:

वादा<शून्य>

कनेक्टऑथएमुलेटर(ऑथ, यूआरएल, विकल्प)

फायरबेस ऑथेंटिक सेवाओं के उत्पादन के बजाय, फायरबेस ऑथेंटिक एमुलेटर के साथ संचार करने के लिए ऑथ इंस्टेंस को बदलता है।

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

हस्ताक्षर:

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

पैरामीटर

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

रिटर्न:

खालीपन

उदाहरण

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

createUserWithEmailAndPassword(प्रमाणीकरण, ईमेल, पासवर्ड)

निर्दिष्ट ईमेल पते और पासवर्ड से संबद्ध एक नया उपयोगकर्ता खाता बनाता है।

उपयोगकर्ता खाते के सफल निर्माण पर, इस उपयोगकर्ता को भी आपके एप्लिकेशन में साइन इन किया जाएगा।

यदि खाता पहले से मौजूद है या पासवर्ड अमान्य है तो उपयोगकर्ता खाता निर्माण विफल हो सकता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
ईमेल डोरी उपयोगकर्ता का ईमेल पता.
पासवर्ड डोरी उपयोगकर्ता का चुना हुआ पासवर्ड.

रिटर्न:

वादा < उपयोगकर्ता क्रेडेंशियल >

FetchSignInMethodsForEmail(auth, ईमेल)

दिए गए ईमेल पते के लिए संभावित साइन इन तरीकों की सूची प्राप्त करता है। [ईमेल गणना सुरक्षा](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) सक्षम होने पर यह विधि एक खाली सूची लौटाती है, भले ही प्रमाणीकरण विधियों की संख्या कितनी भी उपलब्ध हो। ईमेल दिया गया.

यह एक ही प्रदाता के लिए साइन-इन के तरीकों को अलग करने के लिए उपयोगी है, उदाहरण के लिए। ईमेलऑथप्रोवाइडर जिसमें साइन-इन के 2 तरीके हैं, साइनइनमेथोड .EMAIL_PASSWORD और साइनइन विधि .EMAIL_LINK.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
ईमेल डोरी उपयोगकर्ता का ईमेल पता. बहिष्कृत. सुरक्षा के सर्वोत्तम अभ्यास के रूप में इस पद्धति से माइग्रेट करने की अनुशंसा की जाती है। [ईमेल गणना सुरक्षा](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) के लिए पहचान प्लेटफ़ॉर्म दस्तावेज़ में और जानें।

रिटर्न:

वादा<स्ट्रिंग[]>

getMultiFactorResolver(प्रमाणीकरण, त्रुटि)

बहु-कारक प्रवाह को पूरा करने के लिए उपयुक्त मल्टीफ़ैक्टर रिज़ॉल्वर प्रदान करता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
गलती मल्टीफैक्टरत्रुटि मल्टीफ़ैक्टर त्रुटि साइन-इन, या पुन:प्रमाणीकरण ऑपरेशन के दौरान उत्पन्न हुई।

रिटर्न:

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

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

रीडायरेक्ट-आधारित साइन-इन प्रवाह से एक उपयोगकर्ता क्रेडेंशियल लौटाता है।

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

यह विधि Node.js वातावरण में काम नहीं करती है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
रिज़ॉल्वर पॉपअपरीडायरेक्टरिज़ॉल्वर PopupRedirectResolver का एक उदाहरण , वैकल्पिक यदि पहले से ही इनिशियलाइज़ऑथ() को प्रदान किया गया है या 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;

इनिशियलाइज़RecaptchaConfig(auth)

ReCAPTCHA कॉन्फ़िगरेशन को Auth उदाहरण में लोड करता है।

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

यदि InitializeRecaptchaConfig() लागू नहीं किया गया है, तो प्रमाणीकरण प्रवाह हमेशा reCAPTCHA सत्यापन के बिना प्रारंभ होगा। यदि प्रदाता को reCAPTCHA सत्यापन की आवश्यकता के लिए कॉन्फ़िगर किया गया है, तो SDK पारदर्शी रूप से reCAPTCHA कॉन्फ़िगरेशन को लोड करेगा और प्रमाणीकरण प्रवाह को पुनरारंभ करेगा।

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

यह विधि Node.js वातावरण में काम नहीं करती है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.

रिटर्न:

वादा<शून्य>

उदाहरण

initializeRecaptchaConfig(auth);

जाँचता है कि कोई आने वाला लिंक साइन-इन है या नहीं, साइनइनविथईमेललिंक() के लिए उपयुक्त ईमेल लिंक के साथ .

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
ईमेललिंक डोरी लिंक उपयोगकर्ता के ईमेल पते पर भेजा गया।

रिटर्न:

बूलियन

onAuthStateChanged(auth, NextOrObserver, त्रुटि, पूर्ण)

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

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

हस्ताक्षर:

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

पैरामीटर

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

रिटर्न:

सदस्यता रद्द

onIdTokenChanged(auth, NextOrObserver, त्रुटि, पूर्ण)

साइन-इन किए गए उपयोगकर्ता के आईडी टोकन में परिवर्तन के लिए एक पर्यवेक्षक जोड़ता है।

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

हस्ताक्षर:

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

पैरामीटर

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

रिटर्न:

सदस्यता रद्द

रिवोकएक्सेसटोकन(प्रमाणीकरण, टोकन)

दिए गए एक्सेस टोकन को रद्द कर देता है। वर्तमान में केवल Apple OAuth एक्सेस टोकन का समर्थन करता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
टोकन डोरी Apple OAuth एक्सेस टोकन।

रिटर्न:

वादा<शून्य>

सेंडपासवर्डरीसेटईमेल(ऑथ, ईमेल, एक्शनकोडसेटिंग्स)

दिए गए ईमेल पते पर पासवर्ड रीसेट ईमेल भेजता है। जब दिए गए ईमेल पते के साथ कोई उपयोगकर्ता खाता नहीं है और [ईमेल गणना सुरक्षा] (https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) सक्षम है तो यह विधि कोई त्रुटि नहीं देती है .

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

हस्ताक्षर:

export declare function sendPasswordResetEmail(auth: Auth, email: string, actionCodeSettings?: ActionCodeSettings): Promise<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);

भेजेंSignInLinkToEmail(auth, ईमेल, ActionCodeSettings)

निर्दिष्ट ईमेल के साथ उपयोगकर्ता को एक साइन-इन ईमेल लिंक भेजता है।

साइन-इन ऑपरेशन को अन्य आउट ऑफ बैंड ईमेल क्रियाओं (पासवर्ड रीसेट और ईमेल सत्यापन) के विपरीत हमेशा ऐप में पूरा करना होता है। ऐसा इसलिए है, क्योंकि प्रवाह के अंत में, उपयोगकर्ता से साइन इन होने की उम्मीद की जाती है और ऐप के भीतर उनकी प्रामाणिक स्थिति बनी रहती है।

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

हस्ताक्षर:

export declare function sendSignInLinkToEmail(auth: Auth, email: string, actionCodeSettings: ActionCodeSettings): Promise<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 स्थिति को कभी भी जारी नहीं रखना आसान बनाता है जो अन्य उपयोगकर्ताओं द्वारा साझा किए जाते हैं या जिनमें संवेदनशील डेटा होता है।

यह विधि Node.js वातावरण में काम नहीं करती है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
अटलता अटलता उपयोग करने की दृढ़ता .

रिटर्न:

वादा<शून्य>

एक Promise जो दृढ़ता परिवर्तन पूरा होने के बाद हल हो जाता है

उदाहरण

setPersistence(auth, browserSessionPersistence);

साइनइनअनाम रूप से(auth)

एक अज्ञात उपयोगकर्ता के रूप में एसिंक्रोनस रूप से साइन इन करें।

यदि पहले से ही कोई अनाम उपयोगकर्ता साइन इन है, तो उस उपयोगकर्ता को वापस कर दिया जाएगा; अन्यथा, एक नई अनाम उपयोगकर्ता पहचान बनाई जाएगी और वापस कर दी जाएगी।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.

रिटर्न:

वादा < उपयोगकर्ता क्रेडेंशियल >

साइनइनविथक्रेडेंशियल(प्रमाणीकरण, क्रेडेंशियल)

दिए गए क्रेडेंशियल के साथ अतुल्यकालिक रूप से साइन इन करें।

क्रेडेंशियल उत्पन्न करने के लिए एक AuthProvider का उपयोग किया जा सकता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
क्रेडेंशियल प्रामाणिक क्रेडेंशियल प्रामाणिक क्रेडेंशियल.

रिटर्न:

वादा < उपयोगकर्ता क्रेडेंशियल >

साइनइनविथकस्टमटोकन(प्रमाणीकरण, कस्टमटोकन)

एक कस्टम टोकन का उपयोग करके अतुल्यकालिक रूप से साइन इन करें।

कस्टम टोकन का उपयोग फायरबेस ऑथ को मौजूदा ऑथ सिस्टम के साथ एकीकृत करने के लिए किया जाता है, और एडमिन एसडीके में createCustomToken विधि का उपयोग करके ऑथ बैकएंड द्वारा उत्पन्न किया जाना चाहिए।

यदि टोकन अमान्य है, समाप्त हो गया है, या फायरबेस प्रामाणिक सेवा द्वारा स्वीकार नहीं किया गया है, तो एक त्रुटि के साथ विफल हो जाता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
कस्टमटोकन डोरी साइन इन करने के लिए कस्टम टोकन.

रिटर्न:

वादा < उपयोगकर्ता क्रेडेंशियल >

साइनइनविथईमेलएंडपासवर्ड(प्रमाणीकरण, ईमेल, पासवर्ड)

ईमेल और पासवर्ड का उपयोग करके असिंक्रोनस रूप से साइन इन करें।

यदि ईमेल पता और पासवर्ड मेल नहीं खाते तो त्रुटि के साथ विफल हो जाता है। जब [ईमेल गणना सुरक्षा](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) सक्षम होता है, तो अमान्य होने की स्थिति में यह विधि "auth/invalid-credential" के साथ विफल हो जाती है ईमेल पासवर्ड।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
ईमेल डोरी उपयोगकर्ता का ईमेल पता.
पासवर्ड डोरी उपयोगकर्ता पासवर्ड.

रिटर्न:

वादा < उपयोगकर्ता क्रेडेंशियल >

ईमेल और साइन-इन ईमेल लिंक का उपयोग करके अतुल्यकालिक रूप से साइन इन करें।

यदि कोई लिंक पास नहीं किया जाता है, तो लिंक का अनुमान वर्तमान URL से लगाया जाता है।

यदि ईमेल पता अमान्य है या ईमेल लिंक में ओटीपी समाप्त हो जाता है तो त्रुटि के साथ विफल हो जाता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
ईमेल डोरी उपयोगकर्ता का ईमेल पता.
ईमेललिंक डोरी लिंक उपयोगकर्ता के ईमेल पते पर भेजा गया।

रिटर्न:

वादा < उपयोगकर्ता क्रेडेंशियल >

उदाहरण

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

साइनइनविथफ़ोननंबर(प्रमाणीकरण, फ़ोननंबर, ऐपसत्यापनकर्ता)

फ़ोन नंबर का उपयोग करके अतुल्यकालिक रूप से साइन इन करें।

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

दुरुपयोग की रोकथाम के लिए, इस विधि के लिए एक एप्लिकेशन सत्यापनकर्ता की भी आवश्यकता होती है . इस SDK में एक reCAPTCHA-आधारित कार्यान्वयन, RecaptchaVerifier शामिल है . यह फ़ंक्शन अन्य प्लेटफ़ॉर्म पर काम कर सकता है जो रिकैप्चा वेरिफ़ायर (जैसे रिएक्ट नेटिव) का समर्थन नहीं करता है, लेकिन आपको तृतीय-पक्ष एप्लिकेशन वेरिफ़ायर कार्यान्वयन का उपयोग करने की आवश्यकता है।

यह विधि Node.js वातावरण में काम नहीं करती है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
फ़ोन नंबर डोरी उपयोगकर्ता का फ़ोन नंबर E.164 प्रारूप में (जैसे +16505550101)।
ऐपसत्यापनकर्ता अनुप्रयोगसत्यापनकर्ता एप्लिकेशन सत्यापनकर्ता .

रिटर्न:

वादा< पुष्टिकरणपरिणाम >

उदाहरण

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

साइनइनविथपॉपअप(प्रमाणीकरण, प्रदाता, रिज़ॉल्वर)

पॉपअप-आधारित OAuth प्रमाणीकरण प्रवाह का उपयोग करके फायरबेस क्लाइंट को प्रमाणित करता है।

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

यह विधि Node.js वातावरण में काम नहीं करती है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
प्रदाता प्रामाणिकप्रदाता प्रमाणित करने वाला प्रदाता. प्रदाता को OAuthProvider होना चाहिए . ईमेलऑथप्रोवाइडर जैसे गैर-ओएथ प्रदाता एक त्रुटि उत्पन्न करेंगे।
रिज़ॉल्वर पॉपअपरीडायरेक्टरिज़ॉल्वर PopupRedirectResolver का एक उदाहरण , वैकल्पिक यदि पहले से ही इनिशियलाइज़ऑथ() को प्रदान किया गया है या getAuth() द्वारा प्रदान किया गया है .

रिटर्न:

वादा < उपयोगकर्ता क्रेडेंशियल >

उदाहरण

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

साइनइनविथरीडायरेक्ट(प्रमाणीकरण, प्रदाता, रिज़ॉल्वर)

पूर्ण-पृष्ठ रीडायरेक्ट प्रवाह का उपयोग करके फ़ायरबेस क्लाइंट को प्रमाणित करता है।

इस ऑपरेशन के परिणामों और त्रुटियों को संभालने के लिए, getRedirectResult() देखें . साइनइनविथरीडायरेक्ट() का उपयोग करते समय सर्वोत्तम प्रथाओं का पालन करें .

यह विधि Node.js वातावरण में काम नहीं करती है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
प्रदाता प्रामाणिकप्रदाता प्रमाणित करने वाला प्रदाता. प्रदाता को OAuthProvider होना चाहिए . ईमेलऑथप्रोवाइडर जैसे गैर-ओएथ प्रदाता एक त्रुटि उत्पन्न करेंगे।
रिज़ॉल्वर पॉपअपरीडायरेक्टरिज़ॉल्वर PopupRedirectResolver का एक उदाहरण , वैकल्पिक यदि पहले से ही इनिशियलाइज़ऑथ() को प्रदान किया गया है या 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;

साइनआउट(प्रमाणीकरण)

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.

रिटर्न:

वादा<शून्य>

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

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

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

यह अन्य साइन इन विधियों की तरह onAuthStateChanged() और onIdTokenChanged() श्रोताओं को ट्रिगर करेगा।

यदि अद्यतन किया जाने वाला उपयोगकर्ता किसी भिन्न फ़ायरबेस प्रोजेक्ट से संबंधित है, तो ऑपरेशन एक त्रुटि के साथ विफल हो जाता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
उपयोगकर्ता उपयोगकर्ता | व्यर्थ नया उपयोगकर्ता .

रिटर्न:

वादा<शून्य>

यूज़डिवाइसलैंग्वेज(auth)

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.

रिटर्न:

खालीपन

मान्य पासवर्ड (प्रमाणीकरण, पासवर्ड)

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

यदि Auth उदाहरण पर कोई किरायेदार आईडी सेट नहीं है, तो यह विधि प्रोजेक्ट के लिए कॉन्फ़िगर की गई पासवर्ड नीति का उपयोग करेगी। अन्यथा, यह विधि किरायेदार के लिए कॉन्फ़िगर की गई नीति का उपयोग करेगी। यदि पासवर्ड नीति कॉन्फ़िगर नहीं की गई है, तो सभी परियोजनाओं के लिए कॉन्फ़िगर की गई डिफ़ॉल्ट नीति का उपयोग किया जाएगा।

यदि कोई प्रमाणीकरण प्रवाह विफल हो जाता है क्योंकि सबमिट किया गया पासवर्ड पासवर्ड नीति आवश्यकताओं को पूरा नहीं करता है और इस विधि को पहले कॉल किया जा चुका है, तो यह विधि दोबारा कॉल करने पर उपलब्ध नवीनतम नीति का उपयोग करेगी।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
पासवर्ड डोरी सत्यापित करने के लिए पासवर्ड.

रिटर्न:

वादा < पासवर्ड सत्यापन स्थिति >

उदाहरण

validatePassword(auth, 'some-password');

VerifyPasswordResetCode(auth, कोड)

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण प्रामाणिक उदाहरण.
कोड डोरी उपयोगकर्ता को एक सत्यापन कोड भेजा गया.

रिटर्न:

वादा<स्ट्रिंग>

यदि वैध हो तो उपयोगकर्ता का ईमेल पता।

पार्सएक्शनकोडयूआरएल(लिंक)

ईमेल एक्शन लिंक स्ट्रिंग को पार्स करता है और यदि लिंक मान्य है तो ActionCodeURL लौटाता है, अन्यथा शून्य लौटाता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
जोड़ना डोरी

रिटर्न:

एक्शनकोडयूआरएल | व्यर्थ

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

हटाएँउपयोगकर्ता(उपयोगकर्ता)

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
उपयोगकर्ता उपयोगकर्ता प्रयोगकर्ता।

रिटर्न:

वादा<शून्य>

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

उपयोगकर्ता को फायरबेस सेवा में पहचानने के लिए उपयोग किया जाने वाला JSON वेब टोकन (JWT) लौटाता है।

यदि वर्तमान टोकन समाप्त नहीं हुआ है या अगले पांच मिनट में समाप्त नहीं होगा तो उसे लौटा देता है। अन्यथा, यह टोकन ताज़ा कर देगा और एक नया लौटा देगा।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
उपयोगकर्ता उपयोगकर्ता प्रयोगकर्ता।
ForceRefresh बूलियन टोकन समाप्ति की परवाह किए बिना बलपूर्वक ताज़ा करें।

रिटर्न:

वादा<स्ट्रिंग>

getIdTokenResult(उपयोगकर्ता, ForceRefresh)

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

यदि वर्तमान टोकन समाप्त नहीं हुआ है या अगले पांच मिनट में समाप्त नहीं होगा तो उसे लौटा देता है। अन्यथा, यह टोकन ताज़ा कर देगा और एक नया लौटा देगा।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
उपयोगकर्ता उपयोगकर्ता प्रयोगकर्ता।
ForceRefresh बूलियन टोकन समाप्ति की परवाह किए बिना बलपूर्वक ताज़ा करें।

रिटर्न:

वादा< IdTokenResult >

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

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

क्रेडेंशियल उत्पन्न करने के लिए एक AuthProvider का उपयोग किया जा सकता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
उपयोगकर्ता उपयोगकर्ता प्रयोगकर्ता।
क्रेडेंशियल प्रामाणिक क्रेडेंशियल प्रामाणिक क्रेडेंशियल.

रिटर्न:

वादा < उपयोगकर्ता क्रेडेंशियल >

लिंकविथफ़ोननंबर(उपयोगकर्ता, फ़ोननंबर, ऐपसत्यापनकर्ता)

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

यह विधि Node.js वातावरण में काम नहीं करती है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
उपयोगकर्ता उपयोगकर्ता प्रयोगकर्ता।
फ़ोन नंबर डोरी उपयोगकर्ता का फ़ोन नंबर E.164 प्रारूप में (जैसे +16505550101)।
ऐपसत्यापनकर्ता अनुप्रयोगसत्यापनकर्ता एप्लिकेशन सत्यापनकर्ता .

रिटर्न:

वादा< पुष्टिकरणपरिणाम >

लिंकविथपॉपअप (उपयोगकर्ता, प्रदाता, रिज़ॉल्वर)

पॉप-अप आधारित OAuth प्रवाह का उपयोग करके प्रमाणित प्रदाता को उपयोगकर्ता खाते से लिंक करता है।

यदि लिंकिंग सफल होती है, तो लौटाए गए परिणाम में उपयोगकर्ता और प्रदाता का क्रेडेंशियल शामिल होगा।

यह विधि Node.js वातावरण में काम नहीं करती है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
उपयोगकर्ता उपयोगकर्ता प्रयोगकर्ता।
प्रदाता प्रामाणिकप्रदाता प्रमाणित करने वाला प्रदाता. प्रदाता को OAuthProvider होना चाहिए . ईमेलऑथप्रोवाइडर जैसे गैर-ओएथ प्रदाता एक त्रुटि उत्पन्न करेंगे।
रिज़ॉल्वर पॉपअपरीडायरेक्टरिज़ॉल्वर PopupRedirectResolver का एक उदाहरण , वैकल्पिक यदि पहले से ही इनिशियलाइज़ऑथ() को प्रदान किया गया है या getAuth() द्वारा प्रदान किया गया है .

रिटर्न:

वादा < उपयोगकर्ता क्रेडेंशियल >

उदाहरण

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

इस ऑपरेशन के परिणामों और त्रुटियों को संभालने के लिए, getRedirectResult() देखें . LinkWithRedirect() का उपयोग करते समय सर्वोत्तम प्रथाओं का पालन करें .

यह विधि Node.js वातावरण में काम नहीं करती है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
उपयोगकर्ता उपयोगकर्ता प्रयोगकर्ता।
प्रदाता प्रामाणिकप्रदाता प्रमाणित करने वाला प्रदाता. प्रदाता को OAuthProvider होना चाहिए . ईमेलऑथप्रोवाइडर जैसे गैर-ओएथ प्रदाता एक त्रुटि उत्पन्न करेंगे।
रिज़ॉल्वर पॉपअपरीडायरेक्टरिज़ॉल्वर PopupRedirectResolver का एक उदाहरण , वैकल्पिक यदि पहले से ही इनिशियलाइज़ऑथ() को प्रदान किया गया है या 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;

पैरामीटर

पैरामीटर प्रकार विवरण
उपयोगकर्ता उपयोगकर्ता प्रयोगकर्ता।

रिटर्न:

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

क्रेडेंशियल के साथ पुन: प्रमाणित करें (उपयोगकर्ता, क्रेडेंशियल)

ताज़ा क्रेडेंशियल का उपयोग करके उपयोगकर्ता को पुनः प्रमाणित करता है।

अपडेटपासवर्ड() जैसे ऑपरेशन से पहले उपयोग करें जिनके लिए हाल के साइन-इन प्रयासों से टोकन की आवश्यकता होती है। इस पद्धति का उपयोग CREDENTIAL_TOO_OLD_LOGIN_AGAIN त्रुटि या TOKEN_EXPIRED त्रुटि से उबरने के लिए किया जा सकता है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
उपयोगकर्ता उपयोगकर्ता प्रयोगकर्ता।
क्रेडेंशियल प्रामाणिक क्रेडेंशियल प्रामाणिक क्रेडेंशियल.

रिटर्न:

वादा < उपयोगकर्ता क्रेडेंशियल >

फ़ोननंबर के साथ पुन: प्रमाणित करें(उपयोगकर्ता, फ़ोननंबर, ऐपसत्यापनकर्ता)

ताज़ा फ़ोन क्रेडेंशियल का उपयोग करके उपयोगकर्ता को पुनः प्रमाणित करता है।

अपडेटपासवर्ड() जैसे ऑपरेशन से पहले उपयोग करें जिनके लिए हाल के साइन-इन प्रयासों से टोकन की आवश्यकता होती है।

यह विधि Node.js वातावरण में काम नहीं करती है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
उपयोगकर्ता उपयोगकर्ता प्रयोगकर्ता।
फ़ोन नंबर डोरी उपयोगकर्ता का फ़ोन नंबर E.164 प्रारूप में (जैसे +16505550101)।
ऐपसत्यापनकर्ता अनुप्रयोगसत्यापनकर्ता एप्लिकेशन सत्यापनकर्ता .

रिटर्न:

वादा< पुष्टिकरणपरिणाम >

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

पॉप-अप आधारित OAuth प्रवाह का उपयोग करके वर्तमान उपयोगकर्ता को निर्दिष्ट OAuthProvider के साथ पुनः प्रमाणित करता है।

यदि पुन:प्रमाणीकरण सफल होता है, तो लौटाए गए परिणाम में उपयोगकर्ता और प्रदाता के क्रेडेंशियल शामिल होंगे।

यह विधि Node.js वातावरण में काम नहीं करती है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
उपयोगकर्ता उपयोगकर्ता प्रयोगकर्ता।
प्रदाता प्रामाणिकप्रदाता प्रमाणित करने वाला प्रदाता. प्रदाता को OAuthProvider होना चाहिए . ईमेलऑथप्रोवाइडर जैसे गैर-ओएथ प्रदाता एक त्रुटि उत्पन्न करेंगे।
रिज़ॉल्वर पॉपअपरीडायरेक्टरिज़ॉल्वर PopupRedirectResolver का एक उदाहरण , वैकल्पिक यदि पहले से ही इनिशियलाइज़ऑथ() को प्रदान किया गया है या getAuth() द्वारा प्रदान किया गया है .

रिटर्न:

वादा < उपयोगकर्ता क्रेडेंशियल >

उदाहरण

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

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

पूर्ण-पृष्ठ रीडायरेक्ट प्रवाह का उपयोग करके निर्दिष्ट OAuthProvider के साथ वर्तमान उपयोगकर्ता को पुनः प्रमाणित करता है।

इस ऑपरेशन के परिणामों और त्रुटियों को संभालने के लिए, getRedirectResult() देखें . ReauthenticateWithRedirect() का उपयोग करते समय सर्वोत्तम प्रथाओं का पालन करें .

यह विधि Node.js वातावरण में काम नहीं करती है।

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
उपयोगकर्ता उपयोगकर्ता प्रयोगकर्ता।
प्रदाता प्रामाणिकप्रदाता प्रमाणित करने वाला प्रदाता. प्रदाता को OAuthProvider होना चाहिए . ईमेलऑथप्रोवाइडर जैसे गैर-ओएथ प्रदाता एक त्रुटि उत्पन्न करेंगे।
रिज़ॉल्वर पॉपअपरीडायरेक्टरिज़ॉल्वर PopupRedirectResolver का एक उदाहरण , वैकल्पिक यदि पहले से ही इनिशियलाइज़ऑथ() को प्रदान किया गया है या 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>;

पैरामीटर

पैरामीटर प्रकार विवरण
उपयोगकर्ता उपयोगकर्ता प्रयोगकर्ता।

रिटर्न:

वादा<शून्य>

ईमेलसत्यापन भेजें(उपयोगकर्ता, एक्शनकोडसेटिंग्स)

किसी उपयोगकर्ता को सत्यापन ईमेल भेजता है.

सत्यापन प्रक्रिया applyActionCode() को कॉल करके पूरी की जाती है .

हस्ताक्षर:

export declare function sendEmailVerification(user: User, actionCodeSettings?: ActionCodeSettings | null): Promise<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);

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
उपयोगकर्ता उपयोगकर्ता प्रयोगकर्ता।
प्रदाताआईडी डोरी अनलिंक करने वाला प्रदाता.

रिटर्न:

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

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

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

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
उपयोगकर्ता उपयोगकर्ता प्रयोगकर्ता।
नया ईमेल डोरी नया ईमेल पता. [ईमेल गणना सुरक्षा](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) सक्षम होने पर "auth/operation-not-allowed" त्रुटि आती है। अस्वीकृत - इसके बजाय VerifyBeforeUpdateEmail() का उपयोग करें।

रिटर्न:

वादा<शून्य>

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

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
उपयोगकर्ता उपयोगकर्ता प्रयोगकर्ता।
नया पासवर्ड डोरी नया पासवर्ड.

रिटर्न:

वादा<शून्य>

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

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

यह विधि Node.js वातावरण में काम नहीं करती है।

हस्ताक्षर:

export declare function updatePhoneNumber(user: User, credential: PhoneAuthCredential): Promise<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);

अपडेटप्रोफाइल (उपयोगकर्ता, {डिस्प्लेनाम, फोटोयूआरएल: फोटोयूआरएल })

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर प्रकार विवरण
उपयोगकर्ता उपयोगकर्ता प्रयोगकर्ता।
{डिस्प्लेनाम, फोटोयूआरएल: फोटोयूआरएल } {डिस्प्लेनाम?:स्ट्रिंग | व्यर्थ; फोटोयूआरएल?: स्ट्रिंग | व्यर्थ; }

रिटर्न:

वादा<शून्य>

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

एक नए ईमेल पते पर सत्यापन ईमेल भेजता है।

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

यदि आपके पास एक कस्टम ईमेल एक्शन हैंडलर है, तो आप applyActionCode() पर कॉल करके सत्यापन प्रक्रिया पूरी कर सकते हैं .

हस्ताक्षर:

export declare function verifyBeforeUpdateEmail(user: User, newEmail: string, actionCodeSettings?: ActionCodeSettings | null): Promise<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(userCredential)

दिए गए क्रेडेंशियल के लिए प्रदाता विशिष्ट ExtraUserInfo निकालता है।

हस्ताक्षर:

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

पैरामीटर

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

रिटर्न:

अतिरिक्त उपयोगकर्ता जानकारी | व्यर्थ

एक्शनकोडऑपरेशन

संभावित ईमेल कार्रवाई प्रकारों की गणना.

हस्ताक्षर:

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 त्रुटि कोड का एक मानचित्र।

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

हस्ताक्षर:

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

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

ब्राउज़र आधारित अनुप्रयोगों के लिए उपयुक्त PopupRedirectResolver का कार्यान्वयन।

यह विधि Node.js वातावरण में काम नहीं करती है।

हस्ताक्षर:

browserPopupRedirectResolver: PopupRedirectResolver

ब्राउज़र सत्र दृढ़ता

अंतर्निहित भंडारण के लिए sessionStorage का उपयोग करके SESSION की दृढ़ता का कार्यान्वयन।

हस्ताक्षर:

browserSessionPersistence: Persistence

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

कॉर्डोवा आधारित अनुप्रयोगों के लिए उपयुक्त PopupRedirectResolver का कार्यान्वयन।

हस्ताक्षर:

cordovaPopupRedirectResolver: PopupRedirectResolver

डिबगत्रुटि मानचित्र

अधिकांश त्रुटि कोड के विस्तृत विवरण के साथ एक वर्बोज़ त्रुटि मानचित्र।

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

हस्ताक्षर:

debugErrorMap: AuthErrorMap

FactorId

कारकों की एक सूची जिसका उपयोग बहुकारक प्रमाणीकरण के लिए किया जा सकता है।

हस्ताक्षर:

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

अनुक्रमितDBLocalPersistence

अंतर्निहित भंडारण के लिए indexedDB का उपयोग करके LOCAL प्रकार की दृढ़ता का कार्यान्वयन।

हस्ताक्षर:

indexedDBLocalPersistence: Persistence

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

'कोई नहीं' प्रकार की दृढ़ता का कार्यान्वयन।

हस्ताक्षर:

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

NextOrObserver

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

हस्ताक्षर:

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

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

फ़ोन नंबर के स्वामित्व को सत्यापित करने के लिए आवश्यक जानकारी।

आवश्यक जानकारी इस पर निर्भर करती है कि आप एकल-कारक साइन-इन कर रहे हैं, बहु-कारक नामांकन या बहु-कारक साइन-इन कर रहे हैं।

हस्ताक्षर:

export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;

उपयोगकर्ता रूपरेखा

AdditionUserInfo में उपयोगकर्ता प्रोफ़ाइल का उपयोग किया गया .

हस्ताक्षर:

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