उपयोगकर्ता खाता.
हस्ताक्षर:
export interface User extends UserInfo
बताया गया: UserInfo
प्रॉपर्टी
| प्रॉपर्टी | टाइप | ब्यौरा |
|---|---|---|
| emailVerified | boolean | ईमेल पते की पुष्टि, sendEmailVerification() और applyActionCode() की मदद से की गई है. |
| isAnonymous | boolean | ProviderId.ANONYMOUS सेवा देने वाली कंपनी का इस्तेमाल करके, उपयोगकर्ता की पुष्टि की गई है या नहीं. |
| मेटाडेटा | UserMetadata | उपयोगकर्ता बनाने और साइन इन करने के समय के बारे में अतिरिक्त मेटाडेटा. |
| providerData | UserInfo[] | सेवा देने वाली हर कंपनी के हिसाब से अतिरिक्त जानकारी. जैसे, displayName और प्रोफ़ाइल की जानकारी. |
| refreshToken | स्ट्रिंग | उपयोगकर्ता की फिर से पुष्टि करने के लिए इस्तेमाल किया जाने वाला रीफ़्रेश टोकन. सीधे तौर पर इसका इस्तेमाल करने से बचें. इसके बजाय, आईडी टोकन को रीफ़्रेश करने के लिए User.getIdToken() को प्राथमिकता दें. |
| tenantId | स्ट्रिंग | शून्य | उपयोगकर्ता का टेनेंट आईडी. |
तरीके
| तरीका | ब्यौरा |
|---|---|
| delete() | उपयोगकर्ता को मिटाता है और साइन आउट करता है. |
| getIdToken(forceRefresh) | यह फ़ंक्शन, Firebase सेवा में उपयोगकर्ता की पहचान करने के लिए इस्तेमाल किया जाने वाला JSON Web Token (JWT) दिखाता है. |
| getIdTokenResult(forceRefresh) | यह फ़ंक्शन, Firebase सेवा में उपयोगकर्ता की पहचान करने के लिए इस्तेमाल किए जाने वाले, डीसीरियलाइज़्ड JSON वेब टोकन (JWT) दिखाता है. |
| reload() | अगर उपयोगकर्ता ने साइन इन किया हुआ है, तो उसे रीफ़्रेश करता है. |
| toJSON() | यह फ़ंक्शन, इस ऑब्जेक्ट का JSON के क्रम के हिसाब से दिखने वाला प्रज़ेंटेशन दिखाता है. |
User.emailVerified
ईमेल पते की पुष्टि, sendEmailVerification() और applyActionCode() की मदद से की गई है.
हस्ताक्षर:
readonly emailVerified: boolean;
User.isAnonymous
ProviderId.ANONYMOUS सेवा देने वाली कंपनी का इस्तेमाल करके, उपयोगकर्ता की पुष्टि की गई है या नहीं.
हस्ताक्षर:
readonly isAnonymous: boolean;
User.metadata
उपयोगकर्ता बनाने और साइन इन करने के समय के बारे में अतिरिक्त मेटाडेटा.
हस्ताक्षर:
readonly metadata: UserMetadata;
User.providerData
सेवा देने वाली हर कंपनी के हिसाब से अतिरिक्त जानकारी. जैसे, displayName और प्रोफ़ाइल की जानकारी.
हस्ताक्षर:
readonly providerData: UserInfo[];
User.refreshToken
उपयोगकर्ता की फिर से पुष्टि करने के लिए इस्तेमाल किया जाने वाला रीफ़्रेश टोकन. सीधे तौर पर इसका इस्तेमाल करने से बचें. इसके बजाय, आईडी टोकन को रीफ़्रेश करने के लिए User.getIdToken() को प्राथमिकता दें.
हस्ताक्षर:
readonly refreshToken: string;
User.tenantId
उपयोगकर्ता का टेनेंट आईडी.
यह रीड-ओनली प्रॉपर्टी है. इससे पता चलता है कि टेनेंट आईडी का इस्तेमाल करके उपयोगकर्ता ने किस खाते से साइन इन किया. अगर उपयोगकर्ता ने पैरंट प्रोजेक्ट से साइन इन किया है, तो यह वैल्यू शून्य होती है.
हस्ताक्षर:
readonly 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'.
User.delete()
उपयोगकर्ता को मिटाता है और साइन आउट करता है.
यह तरीका ऐसे किसी भी उपयोगकर्ता के लिए काम नहीं करता जिसमें FirebaseServerApp की मदद से पुष्टि करने वाले इंस्टेंस से साइन इन किया गया हो.
हस्ताक्षर:
delete(): Promise<void>;
लौटाए जाने वाले प्रॉडक्ट:
Promise<void>
User.getIdToken()
यह फ़ंक्शन, Firebase सेवा में उपयोगकर्ता की पहचान करने के लिए इस्तेमाल किया जाने वाला JSON Web Token (JWT) दिखाता है.
अगर मौजूदा टोकन की समयसीमा खत्म नहीं हुई है या उसकी समयसीमा अगले पांच मिनट में खत्म नहीं होगी, तो उसे दिखाता है. ऐसा न करने पर, यह टोकन रीफ़्रेश हो जाएगा और नया टोकन दिखाएगा.
हस्ताक्षर:
getIdToken(forceRefresh?: boolean): Promise<string>;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| forceRefresh | boolean | टोकन की समयसीमा खत्म होने पर भी इसे हर हाल में रीफ़्रेश करें. |
लौटाए जाने वाले प्रॉडक्ट:
प्रॉमिस<string>
User.getIdTokenResult()
यह फ़ंक्शन, Firebase सेवा में उपयोगकर्ता की पहचान करने के लिए इस्तेमाल किए जाने वाले, डीसीरियलाइज़्ड JSON वेब टोकन (JWT) दिखाता है.
अगर मौजूदा टोकन की समयसीमा खत्म नहीं हुई है या उसकी समयसीमा अगले पांच मिनट में खत्म नहीं होगी, तो उसे दिखाता है. ऐसा न करने पर, यह टोकन रीफ़्रेश हो जाएगा और नया टोकन दिखाएगा.
हस्ताक्षर:
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| forceRefresh | boolean | टोकन की समयसीमा खत्म होने पर भी इसे हर हाल में रीफ़्रेश करें. |
लौटाए जाने वाले प्रॉडक्ट:
Promise<IdTokenResult>
User.reload()
अगर उपयोगकर्ता ने साइन इन किया हुआ है, तो उसे रीफ़्रेश करता है.
हस्ताक्षर:
reload(): Promise<void>;
लौटाए जाने वाले प्रॉडक्ट:
Promise<void>
User.toJSON()
यह फ़ंक्शन, इस ऑब्जेक्ट का JSON के क्रम के हिसाब से दिखने वाला प्रज़ेंटेशन दिखाता है.
हस्ताक्षर:
toJSON(): object;
लौटाए जाने वाले प्रॉडक्ट:
ऑब्जेक्ट
इस ऑब्जेक्ट का JSON क्रम के हिसाब से दिखाया गया वर्शन.