Auth interface

Firebase में पुष्टि करने की सेवा को दिखाने वाला इंटरफ़ेस.

Firebase से पुष्टि करने की सेवा का इस्तेमाल करने के तरीके के बारे में पूरी गाइड के लिए, Firebase से पुष्टि करने की सुविधा देखें.

हस्ताक्षर:

export interface Auth 

प्रॉपर्टी

प्रॉपर्टी	टाइप	ब्यौरा
ऐप्लिकेशन	FirebaseApp	Auth सेवा इंस्टेंस से जुड़ा FirebaseApp.
कॉन्फ़िगरेशन	कॉन्फ़िगरेशन	इस इंस्टेंस को शुरू करने के लिए इस्तेमाल किया गया कॉन्फ़िगरेशन.
currentUser	उपयोगकर्ता | शून्य	फ़िलहाल, साइन इन किया हुआ उपयोगकर्ता (या कोई वैल्यू नहीं है).
emulatorConfig	EmulatorConfig | शून्य	मौजूदा एम्युलेटर कॉन्फ़िगरेशन (या शून्य).
languageCode	स्ट्रिंग | शून्य	Auth इंस्टेंस का भाषा कोड.
name	स्ट्रिंग	Auth सेवा इंस्टेंस से जुड़े ऐप्लिकेशन का नाम.
सेटिंग	AuthSettings	आधिकारिक इंस्टेंस की सेटिंग.
tenantId	स्ट्रिंग | शून्य	Auth इंस्टेंस का टेनेंट आईडी.

तरीके

तरीका	ब्यौरा
authStateReady()	पुष्टि करने की शुरुआती स्थिति के सेटलमेंट के तुरंत बाद, प्रॉमिस देता है. प्रॉमिस रिज़ॉल्व होने पर, मौजूदा उपयोगकर्ता मान्य उपयोगकर्ता हो सकता है. इसके अलावा, अगर उपयोगकर्ता ने साइन आउट कर दिया हो, तो उसे null माना जाए.
beforeAuthStateChanged(callback, onAbort)	पुष्टि करने की स्थिति बदलने से पहले चलने वाला ब्लॉक करने वाला कॉलबैक जोड़ता है, जो नए उपयोगकर्ता को सेट करता है.
onAuthStateChanged(nextOrObserver, error, completed)	उपयोगकर्ता की साइन-इन स्थिति में बदलावों के लिए, एक ऑब्ज़र्वर जोड़ता है.
onIdTokenChanged(nextOrObserver, error, completed)	साइन इन किए हुए उपयोगकर्ता के आईडी टोकन में हुए बदलावों के लिए, ऑब्ज़र्वर जोड़ता है.
setPersistence(persistence)	इससे Auth इंस्टेंस पर, परसिस्टेंस के टाइप को बदलता है.
signOut()	वर्तमान उपयोगकर्ता को साइन आउट करता है. इससे उपयोगकर्ता का आईडी टोकन अपने-आप रद्द नहीं होता.
updateCurrentUser(user)	एसिंक्रोनस तरीके से, दिए गए उपयोगकर्ता को Auth इंस्टेंस पर Auth.currentUser के रूप में सेट करता है.
useDeviceLanguage()	मौजूदा भाषा को डिफ़ॉल्ट डिवाइस/ब्राउज़र की प्राथमिकता पर सेट करता है.

Auth.app

Auth सेवा इंस्टेंस से जुड़ा FirebaseApp.

हस्ताक्षर:

readonly app: FirebaseApp;

Auth.config

इस इंस्टेंस को शुरू करने के लिए इस्तेमाल किया गया कॉन्फ़िगरेशन.

हस्ताक्षर:

readonly config: Config;

Auth.currentUser

फ़िलहाल, साइन इन किया हुआ उपयोगकर्ता (या कोई वैल्यू नहीं है).

हस्ताक्षर:

readonly currentUser: User | null;

Auth.emulatorConfig

मौजूदा एम्युलेटर कॉन्फ़िगरेशन (या शून्य).

हस्ताक्षर:

readonly emulatorConfig: EmulatorConfig | null;

Auth.languageCode

Auth इंस्टेंस का भाषा कोड.

यह ऐसी प्रॉपर्टी है जिसे पढ़ा जा सकता है या उसमें लिखा जा सकता है. 'शून्य' पर सेट करने पर, Firebase कंसोल की भाषा की डिफ़ॉल्ट सेटिंग लागू होती है. भाषा कोड, ईमेल ऐक्शन टेंप्लेट (पासवर्ड रीसेट करना, ईमेल की पुष्टि करना, और ईमेल में बदलाव रद्द करना), फ़ोन की पुष्टि करने के लिए एसएमएस टेंप्लेट, reCAPTCHA की पुष्टि करने वाले टूल, और OAuth पॉप-अप/रीडायरेक्ट कार्रवाइयों पर लागू होगा. हालांकि, तय की गई भाषा के कोड की मदद से, सेवा देने वाली कंपनियां, स्थानीय भाषा के हिसाब से काम करने की सुविधा देती हैं.

हस्ताक्षर:

languageCode: string | null;

Auth.name

Auth सेवा इंस्टेंस से जुड़े ऐप्लिकेशन का नाम.

हस्ताक्षर:

readonly name: string;

Auth.settings

आधिकारिक इंस्टेंस की सेटिंग.

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

हस्ताक्षर:

readonly settings: AuthSettings;

Auth.tenantId

Auth इंस्टेंस का टेनेंट आईडी.

यह ऐसी प्रॉपर्टी है जिसे पढ़ा जा सकता है या उसमें लिखा जा सकता है. जब आधिकारिक इंस्टेंस के टेनेंट आईडी को सेट किया जाता है, तो आने वाले समय में सभी साइन इन/साइन अप की कार्रवाइयां इस टेनेंट आईडी को पास करेंगी और तय किए गए किरायेदार प्रोजेक्ट में उपयोगकर्ताओं को साइन इन या साइन अप करेंगी. अगर नीति को 'शून्य' पर सेट किया जाता है, तो उपयोगकर्ता पैरंट प्रोजेक्ट में साइन इन हो जाते हैं.

हस्ताक्षर:

tenantId: string | null;

उदाहरण

// Set the tenant ID on Auth instance.
auth.tenantId = 'TENANT_PROJECT_ID';

// All future sign-in request now include tenant ID.
const result = await signInWithEmailAndPassword(auth, email, password);
// result.user.tenantId should be 'TENANT_PROJECT_ID'.

Auth.authStateReady()

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

हस्ताक्षर:

authStateReady(): Promise<void>;

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

Promise<void>

Auth.beforeAuthStateChanged()

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

हस्ताक्षर:

beforeAuthStateChanged(callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;

पैरामीटर

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

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

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

Auth.onAuthStateChanged()

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

पुरानी सेटिंग को बनाए रखने के लिए, Auth.onIdTokenChanged() देखें.

हस्ताक्षर:

onAuthStateChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

पैरामीटर

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

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

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

Auth.onIdTokenChanged()

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

इसमें साइन इन, साइन आउट, और टोकन रीफ़्रेश करने से जुड़े इवेंट शामिल हैं.

हस्ताक्षर:

onIdTokenChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

पैरामीटर

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

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

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

Auth.setPersistence()

इससे Auth इंस्टेंस पर, परसिस्टेंस के टाइप को बदलता है.

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

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

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

हस्ताक्षर:

setPersistence(persistence: Persistence): Promise<void>;

पैरामीटर

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

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

Promise<void>

उदाहरण

auth.setPersistence(browserSessionPersistence);

Auth.signOut()

वर्तमान उपयोगकर्ता को साइन आउट करता है. इससे उपयोगकर्ता का आईडी टोकन अपने-आप रद्द नहीं होता.

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

हस्ताक्षर:

signOut(): Promise<void>;

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

Promise<void>

Auth.updateCurrentUser()

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

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

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

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

हस्ताक्षर:

updateCurrentUser(user: User | null): Promise<void>;

पैरामीटर

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

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

Promise<void>

Auth.useDeviceLanguage()

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

हस्ताक्षर:

useDeviceLanguage(): void;

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

void