UserRecord class

מייצג משתמש.

חֲתִימָה:

export declare class UserRecord 

נכסים

תכונה	משנה	סוּג	תיאור
תביעות מותאמות אישית		{ [מפתח: מחרוזת]: כל; }	אובייקט התביעות המותאם אישית של המשתמש אם זמין, משמש בדרך כלל להגדרת תפקידי משתמש ומופץ לאסימון מזהה משתמש מאומת. זה מוגדר באמצעות BaseAuth.setCustomUserClaims()
נָכֶה		בוליאני	בין אם המשתמש מושבת או לא: true עבור מושבת; false עבור מופעל.
הצג שם		חוּט	שם התצוגה של המשתמש.
אימייל		חוּט	האימייל הראשי של המשתמש, אם מוגדר.
emailVerified		בוליאני	האם האימייל הראשי של המשתמש מאומת או לא.
מטא נתונים		User Metadata	מטא נתונים נוספים על המשתמש.
multi-Factor		MultiFactorSettings	המאפיינים הקשורים לריבוי גורמים עבור המשתמש הנוכחי, אם זמינים.
passwordHash		חוּט	סיסמת הגיבוב של המשתמש (מקודדת base64), רק אם נעשה שימוש באלגוריתם גיבוב של Firebase Auth (SCRYPT). אם נעשה שימוש באלגוריתם גיבוב אחר בעת העלאת משתמש זה, כפי שאופייני בעת הגירה ממערכת Auth אחרת, זו תהיה מחרוזת ריקה. אם לא הוגדרה סיסמה, זו היא null. זה זמין רק כאשר המשתמש מתקבל מ- BaseAuth.listUsers() .
סיסמהSalt		חוּט	סיסמת הסיסמה של המשתמש (מקודדת base64), רק אם נעשה שימוש באלגוריתם גיבוב של Firebase Auth (SCRYPT). אם נעשה שימוש באלגוריתם גיבוב אחר להעלאת משתמש זה, אופייני בעת הגירה ממערכת Auth אחרת, זו תהיה מחרוזת ריקה. אם לא הוגדרה סיסמה, זו היא null. זה זמין רק כאשר המשתמש מתקבל מ- BaseAuth.listUsers() .
מספר טלפון		חוּט	מספר הטלפון הראשי של המשתמש, אם מוגדר.
photoURL		חוּט	כתובת האתר של התמונה של המשתמש.
providerData		מידע על משתמש []	מערך של ספקים (לדוגמה, גוגל, פייסבוק) המקושרים למשתמש.
זיהוי דייר		מחרוזת | ריק	מזהה הדייר אליו שייך המשתמש, אם זמין.
tokensValidAfterTime		חוּט	התאריך שבו האסימונים של המשתמש תקפים אחריו, בפורמט כמחרוזת UTC. זה מתעדכן בכל פעם שאסימון הרענון של המשתמש מבוטל מה-API של BaseAuth.revokeRefreshTokens() או מה-backend של Firebase Auth בשינויים גדולים בחשבון (איפוסי סיסמה, עדכוני סיסמה או אימייל וכו').
uid		חוּט	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 Auth (SCRYPT). אם נעשה שימוש באלגוריתם גיבוב אחר בעת העלאת משתמש זה, כפי שאופייני בעת הגירה ממערכת Auth אחרת, זו תהיה מחרוזת ריקה. אם לא הוגדרה סיסמה, זו היא null. זה זמין רק כאשר המשתמש מתקבל מ- BaseAuth.listUsers() .

חֲתִימָה:

readonly passwordHash?: string;

UserRecord.passwordSalt

סיסמת הסיסמה של המשתמש (מקודדת base64), רק אם נעשה שימוש באלגוריתם גיבוב של Firebase Auth (SCRYPT). אם נעשה שימוש באלגוריתם גיבוב אחר להעלאת משתמש זה, אופייני בעת הגירה ממערכת Auth אחרת, זו תהיה מחרוזת ריקה. אם לא הוגדרה סיסמה, זו היא null. זה זמין רק כאשר המשתמש מתקבל מ- BaseAuth.listUsers() .

חֲתִימָה:

readonly passwordSalt?: string;

UserRecord.phoneNumber

מספר הטלפון הראשי של המשתמש, אם מוגדר.

חֲתִימָה:

readonly phoneNumber?: string;

UserRecord.photoURL

כתובת האתר של התמונה של המשתמש.

חֲתִימָה:

readonly photoURL?: string;

UserRecord.providerData

מערך של ספקים (לדוגמה, גוגל, פייסבוק) המקושרים למשתמש.

חֲתִימָה:

readonly providerData: UserInfo[];

UserRecord.tenantId

מזהה הדייר אליו שייך המשתמש, אם זמין.

חֲתִימָה:

readonly tenantId?: string | null;

UserRecord.tokensValidAfterTime

התאריך שבו האסימונים של המשתמש תקפים אחריו, בפורמט כמחרוזת UTC. זה מתעדכן בכל פעם שאסימון הרענון של המשתמש מבוטל מה-API של BaseAuth.revokeRefreshTokens() או מה-backend של Firebase Auth בשינויים גדולים בחשבון (איפוסי סיסמה, עדכוני סיסמה או אימייל וכו').

חֲתִימָה:

readonly tokensValidAfterTime?: string;

UserRecord.uid

uid של המשתמש .

חֲתִימָה:

readonly uid: string;

UserRecord.toJSON()

מחזיר ייצוג ניתן להמשכה של JSON של אובייקט זה.

חֲתִימָה:

toJSON(): object;

החזרות:

לְהִתְנַגֵד

ייצוג הניתן להמשכה של JSON של אובייקט זה.