חשבון משתמש.
Signature:
export interface User extends UserInfo
הרחבה: UserInfo
תכונות
| מאפיין (property) | סוג | תיאור |
|---|---|---|
| emailVerified | boolean | האם האימייל אומת באמצעות sendEmailVerification() ו-applyActionCode(). |
| isAnonymous | boolean | האם המשתמש מאומת באמצעות הספק ProviderId.ANONYMOUS. |
| מטא-נתונים | UserMetadata | מטא-נתונים נוספים לגבי יצירת משתמשים וזמני הכניסה שלהם. |
| providerData | UserInfo[] | אפשרויות נוספות של כל ספק, כמו displayName ופרטי פרופיל. |
| refreshToken | מחרוזת | אסימון רענון משמש לאימות מחדש של המשתמש. לא משתמשים בה ישירות. במקום זאת, עדיף להשתמש בפונקציה User.getIdToken() כדי לרענן את האסימון המזהה. |
| tenantId | מחרוזת | null | מזהה הדייר של המשתמש. |
שיטות
| שיטה | תיאור |
|---|---|
| delete() | מוחק את המשתמש ומוציא אותו מהחשבון. |
| getIdToken(forceRefresh) | הפונקציה מחזירה אסימון אינטרנט מסוג JSON (JWT) שמשמש לזיהוי המשתמש בשירות Firebase. |
| getIdTokenResult(forceRefresh) | הפונקציה מחזירה אסימון אינטרנט מסוג JSON (JWT) שעבר deserialed כדי לזהות את המשתמש בשירות Firebase. |
| reload() | המערכת תרענן את המשתמש, אם הוא מחובר לחשבון. |
| toJSON() | מחזירה ייצוג שניתן להפעלה על ידי JSON של האובייקט הזה. |
User.emailVerified
האם האימייל אומת באמצעות sendEmailVerification() ו-applyActionCode().
Signature:
readonly emailVerified: boolean;
User.isAnonymous
האם המשתמש מאומת באמצעות הספק ProviderId.ANONYMOUS.
Signature:
readonly isAnonymous: boolean;
User.metadata
מטא-נתונים נוספים לגבי יצירת משתמשים וזמני הכניסה שלהם.
Signature:
readonly metadata: UserMetadata;
User.providerData
אפשרויות נוספות של כל ספק, כמו displayName ופרטי פרופיל.
Signature:
readonly providerData: UserInfo[];
User.refreshToken
אסימון רענון משמש לאימות מחדש של המשתמש. לא משתמשים בה ישירות. במקום זאת, עדיף להשתמש בפונקציה User.getIdToken() כדי לרענן את האסימון המזהה.
Signature:
readonly refreshToken: string;
User.tenantId
מזהה הדייר של המשתמש.
זהו נכס לקריאה בלבד, שמציין את מזהה הדייר המשמש לכניסה של המשתמש. הערך הזה הוא null אם המשתמש נכנס מפרויקט ההורה.
Signature:
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()
מוחק את המשתמש ומוציא אותו מהחשבון.
השיטה הזו לא נתמכת באף משתמש שנכנס על ידי מופעי Auth שנוצרו באמצעות FirebaseServerApp.
Signature:
delete(): Promise<void>;
החזרות:
Promise<void>
User.getIdToken()
הפונקציה מחזירה אסימון אינטרנט מסוג JSON (JWT) שמשמש לזיהוי המשתמש בשירות Firebase.
מחזירה את האסימון הנוכחי אם תוקפו עדיין לא פג או אם התוקף שלו לא יפוג בחמש הדקות הבאות. אחרת, הפעולה הזו תרענן את האסימון ותחזיר אסימון חדש.
Signature:
getIdToken(forceRefresh?: boolean): Promise<string>;
פרמטרים
| פרמטר | סוג | תיאור |
|---|---|---|
| forceRefresh | boolean | אילוץ רענון ללא קשר לתאריך התפוגה של האסימון. |
החזרות:
הבטחה<string>
User.getIdTokenResult()
הפונקציה מחזירה אסימון אינטרנט מסוג JSON (JWT) שעבר deserialed כדי לזהות את המשתמש בשירות Firebase.
מחזירה את האסימון הנוכחי אם תוקפו עדיין לא פג או אם התוקף שלו לא יפוג בחמש הדקות הבאות. אחרת, הפעולה הזו תרענן את האסימון ותחזיר אסימון חדש.
Signature:
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
פרמטרים
| פרמטר | סוג | תיאור |
|---|---|---|
| forceRefresh | boolean | אילוץ רענון ללא קשר לתאריך התפוגה של האסימון. |
החזרות:
Promise<IdTokenResult>
User.reload()
המערכת תרענן את המשתמש, אם הוא מחובר לחשבון.
Signature:
reload(): Promise<void>;
החזרות:
Promise<void>
User.toJSON()
מחזירה ייצוג שניתן להפעלה על ידי JSON של האובייקט הזה.
Signature:
toJSON(): object;
החזרות:
אובייקט
ייצוג של האובייקט הזה שניתן להקראה באמצעות JSON.