UserRecord class

یک کاربر را نشان می دهد.

امضا:

export declare class UserRecord 

خواص

مواد و روش ها

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

رمز عبور هش شده کاربر (با پایه 64 رمزگذاری شده)، فقط در صورتی که از الگوریتم هش کردن Firebase Auth (SCRYPT) استفاده شده باشد. اگر هنگام آپلود این کاربر از الگوریتم هش متفاوتی استفاده شده باشد، همانطور که در هنگام مهاجرت از سیستم Auth دیگری معمول است، این یک رشته خالی خواهد بود. اگر پسوردی تنظیم نشده باشد، این کلمه تهی است. این تنها زمانی در دسترس است که کاربر از BaseAuth.listUsers() به دست آمده باشد. .

امضا:

readonly passwordHash?: string;

UserRecord.passwordSalt

رمز عبور کاربر (با پایه 64 رمزگذاری شده)، فقط در صورتی که از الگوریتم هش کردن Firebase Auth (SCRYPT) استفاده شود. اگر از الگوریتم هش متفاوتی برای آپلود این کاربر استفاده شده باشد، که معمولاً هنگام مهاجرت از یک سیستم Auth دیگر استفاده می‌شود، این یک رشته خالی خواهد بود. اگر پسوردی تنظیم نشده باشد، این کلمه تهی است. این تنها زمانی در دسترس است که کاربر از 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 یا از پشتیبان Firebase Auth در تغییرات بزرگ حساب (بازنشانی رمز عبور، به‌روزرسانی رمز عبور یا ایمیل و غیره) باطل می‌شود، به‌روزرسانی می‌شود.

امضا:

readonly tokensValidAfterTime?: string;

UserRecord.uid

uid کاربر .

امضا:

readonly uid: string;

UserRecord.toJSON()

نمایشی قابل سریال‌سازی با JSON از این شی را برمی‌گرداند.

امضا:

toJSON(): object;

برمی گرداند:

هدف - شی

نمایش JSON-Serializable از این شی.