एक उपयोगकर्ता का प्रतिनिधित्व करता है.
हस्ताक्षर:
export declare class UserRecord
गुण
संपत्ति | संशोधक | प्रकार | विवरण |
---|---|---|---|
कस्टमदावे | {[कुंजी: स्ट्रिंग]: कोई भी; } | यदि उपलब्ध हो तो उपयोगकर्ता का कस्टम दावा ऑब्जेक्ट, आमतौर पर उपयोगकर्ता भूमिकाओं को परिभाषित करने के लिए उपयोग किया जाता है और एक प्रमाणित उपयोगकर्ता के आईडी टोकन के लिए प्रचारित किया जाता है। यह BaseAuth.setCustomUserClaims() के माध्यम से सेट किया गया है | |
अक्षम | बूलियन | उपयोगकर्ता अक्षम है या नहीं: अक्षम के लिए true ; सक्षम के लिए false । | |
प्रदर्शित होने वाला नाम | डोरी | उपयोगकर्ता का प्रदर्शन नाम. | |
ईमेल | डोरी | उपयोगकर्ता का प्राथमिक ईमेल, यदि सेट हो। | |
ईमेल सत्यापित हुआ | बूलियन | उपयोगकर्ता का प्राथमिक ईमेल सत्यापित है या नहीं. | |
मेटाडाटा | उपयोगकर्तामेटाडेटा | उपयोगकर्ता के बारे में अतिरिक्त मेटाडेटा. | |
बहुकारक | मल्टीफैक्टरसेटिंग्स | वर्तमान उपयोगकर्ता के लिए बहु-कारक संबंधी गुण, यदि उपलब्ध हो। | |
पासवर्डहैश | डोरी | उपयोगकर्ता का हैशेड पासवर्ड (बेस64-एन्कोडेड), केवल तभी जब फायरबेस ऑथ हैशिंग एल्गोरिदम (एससीआरवाईपीटी) का उपयोग किया जाता है। यदि इस उपयोगकर्ता को अपलोड करते समय एक अलग हैशिंग एल्गोरिदम का उपयोग किया गया था, जैसा कि किसी अन्य प्रामाणिक सिस्टम से माइग्रेट करते समय होता है, तो यह एक खाली स्ट्रिंग होगी। यदि कोई पासवर्ड सेट नहीं है, तो यह शून्य है। यह केवल तभी उपलब्ध होता है जब उपयोगकर्ता BaseAuth.listUsers() से प्राप्त किया जाता है . | |
पासवर्डनमक | डोरी | उपयोगकर्ता का पासवर्ड नमक (बेस64-एन्कोडेड), केवल तभी जब फायरबेस ऑथ हैशिंग एल्गोरिदम (एससीआरवाईपीटी) का उपयोग किया जाता है। यदि इस उपयोगकर्ता को अपलोड करने के लिए एक अलग हैशिंग एल्गोरिदम का उपयोग किया गया था, जो किसी अन्य प्रामाणिक सिस्टम से माइग्रेट करते समय विशिष्ट होता है, तो यह एक खाली स्ट्रिंग होगी। यदि कोई पासवर्ड सेट नहीं है, तो यह शून्य है। यह केवल तभी उपलब्ध होता है जब उपयोगकर्ता BaseAuth.listUsers() से प्राप्त किया जाता है . | |
फ़ोन नंबर | डोरी | उपयोगकर्ता का प्राथमिक फ़ोन नंबर, यदि सेट हो। | |
फोटोयूआरएल | डोरी | उपयोगकर्ता का फ़ोटो URL. | |
प्रदाताडेटा | उपयोगकर्ता जानकारी [] | प्रदाताओं की एक श्रृंखला (उदाहरण के लिए, Google, Facebook) उपयोगकर्ता से जुड़ी हुई है। | |
किरायेदारआईडी | स्ट्रिंग | व्यर्थ | यदि उपलब्ध हो तो उपयोगकर्ता के किरायेदार की आईडी। | |
टोकनवैलिडआफ्टरटाइम | डोरी | वह दिनांक जिसके बाद उपयोगकर्ता के टोकन मान्य होते हैं, उसे UTC स्ट्रिंग के रूप में स्वरूपित किया जाता है। इसे हर बार अपडेट किया जाता है जब उपयोगकर्ता का रीफ्रेश टोकन या तो BaseAuth.revokeRefreshTokens() API से या बड़े खाते में बदलाव (पासवर्ड रीसेट, पासवर्ड या ईमेल अपडेट इत्यादि) पर फायरबेस ऑथ बैकएंड से रद्द कर दिया जाता है। | |
यूआईडी | डोरी | उपयोगकर्ता का uid . |
तरीकों
तरीका | संशोधक | विवरण |
---|---|---|
toJSON() | इस ऑब्जेक्ट का JSON-क्रमबद्ध प्रतिनिधित्व लौटाता है। |
UserRecord.customदावे
यदि उपलब्ध हो तो उपयोगकर्ता का कस्टम दावा ऑब्जेक्ट, आमतौर पर उपयोगकर्ता भूमिकाओं को परिभाषित करने के लिए उपयोग किया जाता है और एक प्रमाणित उपयोगकर्ता के आईडी टोकन के लिए प्रचारित किया जाता है। यह BaseAuth.setCustomUserClaims() के माध्यम से सेट किया गया है
हस्ताक्षर:
readonly customClaims?: {
[key: string]: any;
};
UserRecord.अक्षम
उपयोगकर्ता अक्षम है या नहीं: अक्षम के लिए true
; सक्षम के लिए false
।
हस्ताक्षर:
readonly disabled: boolean;
UserRecord.displayName
उपयोगकर्ता का प्रदर्शन नाम.
हस्ताक्षर:
readonly displayName?: string;
UserRecord.ईमेल
उपयोगकर्ता का प्राथमिक ईमेल, यदि सेट हो।
हस्ताक्षर:
readonly email?: string;
UserRecord.email सत्यापित
उपयोगकर्ता का प्राथमिक ईमेल सत्यापित है या नहीं.
हस्ताक्षर:
readonly emailVerified: boolean;
UserRecord.metadata
उपयोगकर्ता के बारे में अतिरिक्त मेटाडेटा.
हस्ताक्षर:
readonly metadata: UserMetadata;
UserRecord.multiFactor
वर्तमान उपयोगकर्ता के लिए बहु-कारक संबंधी गुण, यदि उपलब्ध हो।
हस्ताक्षर:
readonly multiFactor?: MultiFactorSettings;
UserRecord.passwordHash
उपयोगकर्ता का हैशेड पासवर्ड (बेस64-एन्कोडेड), केवल तभी जब फायरबेस ऑथ हैशिंग एल्गोरिदम (एससीआरवाईपीटी) का उपयोग किया जाता है। यदि इस उपयोगकर्ता को अपलोड करते समय एक अलग हैशिंग एल्गोरिदम का उपयोग किया गया था, जैसा कि किसी अन्य प्रामाणिक सिस्टम से माइग्रेट करते समय होता है, तो यह एक खाली स्ट्रिंग होगी। यदि कोई पासवर्ड सेट नहीं है, तो यह शून्य है। यह केवल तभी उपलब्ध होता है जब उपयोगकर्ता BaseAuth.listUsers() से प्राप्त किया जाता है .
हस्ताक्षर:
readonly passwordHash?: string;
UserRecord.passwordSalt
उपयोगकर्ता का पासवर्ड नमक (बेस64-एन्कोडेड), केवल तभी जब फायरबेस ऑथ हैशिंग एल्गोरिदम (एससीआरवाईपीटी) का उपयोग किया जाता है। यदि इस उपयोगकर्ता को अपलोड करने के लिए एक अलग हैशिंग एल्गोरिदम का उपयोग किया गया था, जो किसी अन्य प्रामाणिक सिस्टम से माइग्रेट करते समय विशिष्ट होता है, तो यह एक खाली स्ट्रिंग होगी। यदि कोई पासवर्ड सेट नहीं है, तो यह शून्य है। यह केवल तभी उपलब्ध होता है जब उपयोगकर्ता BaseAuth.listUsers() से प्राप्त किया जाता है .
हस्ताक्षर:
readonly passwordSalt?: string;
UserRecord.phoneNumber
उपयोगकर्ता का प्राथमिक फ़ोन नंबर, यदि सेट हो।
हस्ताक्षर:
readonly phoneNumber?: string;
UserRecord.photoURL
उपयोगकर्ता का फ़ोटो URL.
हस्ताक्षर:
readonly photoURL?: string;
UserRecord.providerData
प्रदाताओं की एक श्रृंखला (उदाहरण के लिए, Google, Facebook) उपयोगकर्ता से जुड़ी हुई है।
हस्ताक्षर:
readonly providerData: UserInfo[];
UserRecord.tenantId
यदि उपलब्ध हो तो उपयोगकर्ता के किरायेदार की आईडी।
हस्ताक्षर:
readonly tenantId?: string | null;
UserRecord.tokensValidAfterTime
वह दिनांक जिसके बाद उपयोगकर्ता के टोकन मान्य होते हैं, उसे UTC स्ट्रिंग के रूप में स्वरूपित किया जाता है। इसे हर बार अपडेट किया जाता है जब उपयोगकर्ता का रीफ्रेश टोकन या तो BaseAuth.revokeRefreshTokens() API से या बड़े खाते में बदलाव (पासवर्ड रीसेट, पासवर्ड या ईमेल अपडेट इत्यादि) पर फायरबेस ऑथ बैकएंड से रद्द कर दिया जाता है।
हस्ताक्षर:
readonly tokensValidAfterTime?: string;
UserRecord.uid
उपयोगकर्ता का uid
.
हस्ताक्षर:
readonly uid: string;
UserRecord.toJSON()
इस ऑब्जेक्ट का JSON-क्रमबद्ध प्रतिनिधित्व लौटाता है।
हस्ताक्षर:
toJSON(): object;
रिटर्न:
वस्तु
इस ऑब्जेक्ट का JSON-क्रमबद्ध प्रतिनिधित्व।