Auth interface

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

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

हस्ताक्षर:

export interface Auth

प्रॉपर्टी

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

तरीके

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

Auth.app

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

हस्ताक्षर:

readonly app: FirebaseApp;

Auth.config

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

हस्ताक्षर:

readonly config: Config;

अनुमति देने वाले मौजूदा उपयोगकर्ता

वर्तमान में प्रवेश किया हुआ उपयोगकर्ता (या शून्य).

हस्ताक्षर:

readonly currentUser: User | null;

Auth.emulatorConfig

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

हस्ताक्षर:

readonly emulatorConfig: EmulatorConfig | null;

Auth.languageCode

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

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

हस्ताक्षर:

languageCode: string | null;

प्राधिकरण नाम

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

हस्ताक्षर:

readonly name: string;

अनुमति की सेटिंग

Auth इंस्टेंस की सेटिंग.

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

हस्ताक्षर:

readonly settings: AuthSettings;

Auth.tenantId

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

इस प्रॉपर्टी को पढ़ा जा सकता है या इसमें लिखा जा सकता है. जब किसी 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>;

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

प्रॉमिस<void>

Auth.beforeAuthStateChanged()

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

हस्ताक्षर:

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

पैरामीटर

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

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

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

Auth.onAuthStateChanged()

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

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

Auth.onIdTokenChanged()

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

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

Auth.setPersistence()

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

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<void>

उदाहरण

auth.setPersistence(browserSessionPersistence);

Auth.signOut()

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

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

हस्ताक्षर:

signOut(): Promise<void>;

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

प्रॉमिस<void>

Auth.updateCurrentUser()

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

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

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

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

हस्ताक्षर:

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

पैरामीटर

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

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

प्रॉमिस<void>

Auth.useDeviceLanguage()

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

हस्ताक्षर:

useDeviceLanguage(): void;

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

अमान्य