UserRecord class

इससे उपयोगकर्ता का प्रतिनिधित्व किया जाता है.

हस्ताक्षर:

export declare class UserRecord 

प्रॉपर्टी

प्रॉपर्टी	मॉडिफ़ायर	टाइप	ब्यौरा
customClaims		{ [की: स्ट्रिंग]: कोई भी; } पर स्विच करने के मकसद से, हमसे संपर्क करने के लिए धन्यवाद.	अगर उपयोगकर्ता का कस्टम दावा ऑब्जेक्ट उपलब्ध है, तो इसका इस्तेमाल आम तौर पर उपयोगकर्ता की भूमिकाएं तय करने के लिए किया जाता है. साथ ही, इसे पुष्टि किए गए उपयोगकर्ता के आईडी टोकन पर लागू किया जाता है. इसे BaseAuth.setCustomUserClaims() के ज़रिए सेट किया जाता है
बंद है		बूलियन	उपयोगकर्ता बंद है या नहीं: true के लिए बंद है; false को चालू किया गया.
डिसप्ले नेम		स्ट्रिंग	उपयोगकर्ता का डिसप्ले नेम.
email		स्ट्रिंग	अगर सेट हो, तो उपयोगकर्ता का मुख्य ईमेल पता.
ईमेल की पुष्टि की गई		बूलियन	उपयोगकर्ता के मुख्य ईमेल पते की पुष्टि की गई है या नहीं.
मेटाडेटा		उपयोगकर्ता का मेटाडेटा	उपयोगकर्ता के बारे में अतिरिक्त मेटाडेटा.
कई फ़ैक्टर		मल्टीफ़ैक्टर सेटिंग	मौजूदा उपयोगकर्ता के लिए, कई तरीकों से इस्तेमाल होने वाली प्रॉपर्टी (अगर उपलब्ध हों).
passwordHash		स्ट्रिंग	उपयोगकर्ता का हैश किया गया पासवर्ड (base64-एन्कोडेड). यह सिर्फ़ तब उपलब्ध होता है, जब Firebase ऑथराइज़ेशन हैशिंग एल्गोरिदम (SCRYPT) का इस्तेमाल किया गया हो. अगर इस उपयोगकर्ता को अपलोड करते समय किसी दूसरे हैशिंग एल्गोरिदम का इस्तेमाल किया गया था, तो यह एक खाली स्ट्रिंग होगी. यह आम तौर पर, किसी दूसरे पुष्टि सिस्टम से माइग्रेट करते समय होता है. अगर कोई पासवर्ड सेट नहीं है, तो यह शून्य होता है. यह सिर्फ़ तब उपलब्ध होता है, जब उपयोगकर्ता को BaseAuth.listUsers() से जानकारी मिलती है.
passwordSalt		स्ट्रिंग	उपयोगकर्ता के पासवर्ड सॉल्ट (base64-एनकोडेड) का इस्तेमाल सिर्फ़ तब किया जा सकता है, जब Firebase ऑथराइज़ेशन हैशिंग एल्गोरिदम (SCRYPT) का इस्तेमाल किया गया हो. अगर इस उपयोगकर्ता को अपलोड करने के लिए किसी दूसरे हैशिंग एल्गोरिदम का इस्तेमाल किया गया है, तो आम तौर पर किसी दूसरे पुष्टि सिस्टम से माइग्रेट करते समय यह एक खाली स्ट्रिंग होगी. अगर कोई पासवर्ड सेट नहीं है, तो यह शून्य होता है. यह सिर्फ़ तब उपलब्ध होता है, जब उपयोगकर्ता को BaseAuth.listUsers() से जानकारी मिलती है.
फ़ोन नंबर		स्ट्रिंग	उपयोगकर्ता का मुख्य फ़ोन नंबर, अगर सेट हो.
फ़ोटो का यूआरएल		स्ट्रिंग	उपयोगकर्ता की फ़ोटो का यूआरएल.
providerData		उपयोगकर्ता की जानकारी[]	सेवा देने वाली कंपनियों (जैसे कि Google, Facebook) का कलेक्शन, जिसे उपयोगकर्ता से लिंक किया गया है.
tenantId		स्ट्रिंग | शून्य	अगर उपलब्ध हो, तो उस किरायेदार का आईडी जिससे उपयोगकर्ता जुड़ा है.
tokensValidAfterTime		स्ट्रिंग	उपयोगकर्ता के टोकन के मान्य होने की तारीख. यह यूटीसी स्ट्रिंग के तौर पर फ़ॉर्मैट की जाती है. जब भी उपयोगकर्ता का रीफ़्रेश टोकन, BaseAuth.RevokeRefreshTokens() API से या खाते में बड़े बदलाव (पासवर्ड रीसेट, पासवर्ड या ईमेल अपडेट वगैरह) पर Firebase पुष्टि बैकएंड से निरस्त किया जाता है, तो इसे अपडेट किया जाता है.
यूआईडी		स्ट्रिंग	उपयोगकर्ता का uid.

तरीके

तरीका	मॉडिफ़ायर	ब्यौरा
toJSON()		यह फ़ंक्शन इस ऑब्जेक्ट को JSON के क्रम में लगाकर दिखाया जाता है.

UserRecord.customClaims

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

हस्ताक्षर:

readonly customClaims?: {
        [key: string]: any;
    };

UserRecord.disabled

उपयोगकर्ता बंद है या नहीं: true के लिए बंद है; false को चालू किया गया.

हस्ताक्षर:

readonly disabled: boolean;

UserRecord.displayName

उपयोगकर्ता का डिसप्ले नेम.

हस्ताक्षर:

readonly displayName?: string;

UserRecord.email

अगर सेट हो, तो उपयोगकर्ता का मुख्य ईमेल पता.

हस्ताक्षर:

readonly email?: string;

UserRecord.emailVerified

उपयोगकर्ता के मुख्य ईमेल पते की पुष्टि की गई है या नहीं.

हस्ताक्षर:

readonly emailVerified: boolean;

UserRecord.metadata

उपयोगकर्ता के बारे में अतिरिक्त मेटाडेटा.

हस्ताक्षर:

readonly metadata: UserMetadata;

UserRecord.multiFactor

मौजूदा उपयोगकर्ता के लिए, कई तरीकों से इस्तेमाल होने वाली प्रॉपर्टी (अगर उपलब्ध हों).

हस्ताक्षर:

readonly multiFactor?: MultiFactorSettings;

UserRecord.passwordHash

उपयोगकर्ता का हैश किया गया पासवर्ड (base64-एन्कोडेड). यह सिर्फ़ तब उपलब्ध होता है, जब Firebase ऑथराइज़ेशन हैशिंग एल्गोरिदम (SCRYPT) का इस्तेमाल किया गया हो. अगर इस उपयोगकर्ता को अपलोड करते समय किसी दूसरे हैशिंग एल्गोरिदम का इस्तेमाल किया गया था, तो यह एक खाली स्ट्रिंग होगी. यह आम तौर पर, किसी दूसरे पुष्टि सिस्टम से माइग्रेट करते समय होता है. अगर कोई पासवर्ड सेट नहीं है, तो यह शून्य होता है. यह सिर्फ़ तब उपलब्ध होता है, जब उपयोगकर्ता को BaseAuth.listUsers() से जानकारी मिलती है.

हस्ताक्षर:

readonly passwordHash?: string;

UserRecord.passwordSalt

उपयोगकर्ता के पासवर्ड सॉल्ट (base64-एनकोडेड) का इस्तेमाल सिर्फ़ तब किया जा सकता है, जब Firebase ऑथराइज़ेशन हैशिंग एल्गोरिदम (SCRYPT) का इस्तेमाल किया गया हो. अगर इस उपयोगकर्ता को अपलोड करने के लिए किसी दूसरे हैशिंग एल्गोरिदम का इस्तेमाल किया गया है, तो आम तौर पर किसी दूसरे पुष्टि सिस्टम से माइग्रेट करते समय यह एक खाली स्ट्रिंग होगी. अगर कोई पासवर्ड सेट नहीं है, तो यह शून्य होता है. यह सिर्फ़ तब उपलब्ध होता है, जब उपयोगकर्ता को BaseAuth.listUsers() से जानकारी मिलती है.

हस्ताक्षर:

readonly passwordSalt?: string;

UserRecord.phoneNumber

उपयोगकर्ता का मुख्य फ़ोन नंबर, अगर सेट हो.

हस्ताक्षर:

readonly phoneNumber?: string;

UserRecord.photoURL

उपयोगकर्ता की फ़ोटो का यूआरएल.

हस्ताक्षर:

readonly photoURL?: string;

UserRecord.providerData

सेवा देने वाली कंपनियों (जैसे कि Google, Facebook) का कलेक्शन, जिसे उपयोगकर्ता से लिंक किया गया है.

हस्ताक्षर:

readonly providerData: UserInfo[];

UserRecord.tenantId

अगर उपलब्ध हो, तो उस किरायेदार का आईडी जिससे उपयोगकर्ता जुड़ा है.

हस्ताक्षर:

readonly tenantId?: string | null;

UserRecord.tokensValidAfterTime

उपयोगकर्ता के टोकन के मान्य होने की तारीख. यह यूटीसी स्ट्रिंग के तौर पर फ़ॉर्मैट की जाती है. जब भी उपयोगकर्ता का रीफ़्रेश टोकन, BaseAuth.RevokeRefreshTokens() API से या खाते में बड़े बदलाव (पासवर्ड रीसेट, पासवर्ड या ईमेल अपडेट वगैरह) पर Firebase पुष्टि बैकएंड से निरस्त किया जाता है, तो इसे अपडेट किया जाता है.

हस्ताक्षर:

readonly tokensValidAfterTime?: string;

UserRecord.uid

उपयोगकर्ता का uid.

हस्ताक्षर:

readonly uid: string;

UserRecord.toJSON()

यह फ़ंक्शन इस ऑब्जेक्ट को JSON के क्रम में लगाकर दिखाया जाता है.

हस्ताक्षर:

toJSON(): object;

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

ऑब्जेक्ट

इस ऑब्जेक्ट को JSON के क्रम में लगाकर दिखाया जा सकता है.