یک حساب کاربری
امضا:
export interface User extends UserInfo
گسترش می یابد: UserInfo
خواص
| ویژگی | تایپ کنید | شرح |
|---|---|---|
| ایمیل تأییده شده است | بولی | آیا ایمیل با sendEmailVerification() و applicationActionCode() تایید شده است یا نه . |
| ناشناس است | بولی | اینکه آیا کاربر با استفاده از ProviderId احراز هویت شده است یا خیر ارائه دهنده .ANONYMOUS. |
| ابرداده | UserMetadata | فراداده اضافی در مورد زمان ایجاد کاربر و ورود به سیستم. |
| ارائه دهنده داده ها | اطلاعات کاربر [] | هر ارائه دهنده اضافی مانند displayName و اطلاعات نمایه. |
| refreshToken | رشته | نشانه Refresh برای احراز هویت مجدد کاربر استفاده می شود. از استفاده مستقیم از آن خودداری کنید و ترجیح دهید ()User.getIdToken را برای بازخوانی نشانه شناسه انتخاب کند. |
| شناسه مستاجر | رشته | خالی | شناسه مستاجر کاربر. |
مواد و روش ها
| روش | شرح |
|---|---|
| حذف() | کاربر را حذف و از سیستم خارج می کند. |
| getIdToken (forceRefresh) | یک رمز وب JSON (JWT) که برای شناسایی کاربر استفاده می‌شود را به سرویس Firebase برمی‌گرداند. |
| getIdTokenResult(forceRefresh) | یک توکن وب JSON (JWT) که برای شناسایی کاربر استفاده می‌شود را به سرویس Firebase برمی‌گرداند. |
| بارگذاری مجدد () | در صورت ورود به سیستم، کاربر را تازه می کند. |
| toJSON() | نمایشی قابل سریال‌سازی با JSON از این شی را برمی‌گرداند. |
User.emailVerified
آیا ایمیل با sendEmailVerification() و applicationActionCode() تایید شده است یا نه .
امضا:
readonly emailVerified: boolean;
User.isAnonymous
اینکه آیا کاربر با استفاده از ProviderId احراز هویت شده است یا خیر ارائه دهنده .ANONYMOUS.
امضا:
readonly isAnonymous: boolean;
User.metadata
فراداده اضافی در مورد زمان ایجاد کاربر و ورود به سیستم.
امضا:
readonly metadata: UserMetadata;
User.providerData
هر ارائه دهنده اضافی مانند displayName و اطلاعات نمایه.
امضا:
readonly providerData: UserInfo[];
User.refreshToken
نشانه Refresh برای احراز هویت مجدد کاربر استفاده می شود. از استفاده مستقیم از آن خودداری کنید و ترجیح دهید ()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()
کاربر را حذف و از سیستم خارج می کند.
این روش در هیچ کاربری که توسط نمونه‌های Auth وارد شده با FirebaseServerApp پشتیبانی نمی‌شود .
امضا:
delete(): Promise<void>;
برمی‌گرداند:
قول<باطل>
User.getIdToken()
یک رمز وب JSON (JWT) که برای شناسایی کاربر استفاده می‌شود را به سرویس Firebase برمی‌گرداند.
اگر توکن فعلی منقضی نشده باشد یا در پنج دقیقه آینده منقضی نشود، آن را برمی‌گرداند. در غیر این صورت، این توکن را تازه می کند و یک توکن جدید برمی گرداند.
امضا:
getIdToken(forceRefresh?: boolean): Promise<string>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| forceRefresh | بولی | اجباری به‌روزرسانی بدون در نظر گرفتن انقضای رمز. |
برمی‌گرداند:
قول<رشته>
User.getIdTokenResult()
یک توکن وب JSON (JWT) که برای شناسایی کاربر استفاده می‌شود را به سرویس Firebase برمی‌گرداند.
اگر توکن فعلی منقضی نشده باشد یا در پنج دقیقه آینده منقضی نشود، آن را برمی‌گرداند. در غیر این صورت، این توکن را تازه می کند و یک توکن جدید برمی گرداند.
امضا:
getIdTokenResult(forceRefresh?: boolean): Promise<IdTokenResult>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| forceRefresh | بولی | اجباری به‌روزرسانی بدون در نظر گرفتن انقضای رمز. |
برمی‌گرداند:
Promise< IdTokenResult >
User.reload()
در صورت ورود به سیستم، کاربر را تازه می کند.
امضا:
reload(): Promise<void>;
برمی‌گرداند:
قول<باطل>
User.toJSON()
نمایشی قابل سریال‌سازی با JSON از این شی را برمی‌گرداند.
امضا:
toJSON(): object;
برمی‌گرداند:
هدف - شی
نمایش JSON-Serializable از این شی.