يمثل المستخدم.
إمضاء:
export declare class UserRecord
ملكيات
ملكية | الصفات التعريفية | يكتب | وصف |
---|---|---|---|
customClaims | { [مفتاح: سلسلة]: أي؛ } | كائن المطالبات المخصصة للمستخدم، إذا كان متاحًا، يُستخدم عادةً لتحديد أدوار المستخدم ويتم نشره إلى رمز معرف مستخدم تمت مصادقته. يتم تعيين هذا عبر BaseAuth.setCustomUserClaims() | |
عاجز | منطقية | ما إذا كان المستخدم معطلاً أم لا: true للمعاقين؛ false للتمكين. | |
اسم العرض | خيط | اسم العرض الخاص بالمستخدم. | |
بريد إلكتروني | خيط | البريد الإلكتروني الأساسي للمستخدم، إذا تم تعيينه. | |
تم التحقق من البريد الإلكتروني | منطقية | ما إذا كان قد تم التحقق من البريد الإلكتروني الأساسي للمستخدم أم لا. | |
البيانات الوصفية | بيانات تعريف المستخدم | بيانات تعريف إضافية عن المستخدم. | |
multiFactor | إعدادات متعددة العوامل | الخصائص ذات الصلة متعددة العوامل للمستخدم الحالي، إذا كانت متوفرة. | |
com.passwordHash | خيط | كلمة المرور المجزأة للمستخدم (المشفرة بـ base64)، فقط في حالة استخدام خوارزمية تجزئة Firebase Auth (SCRYPT). إذا تم استخدام خوارزمية تجزئة مختلفة عند تحميل هذا المستخدم، كما هو معتاد عند الترحيل من نظام مصادقة آخر، فستكون هذه سلسلة فارغة. إذا لم يتم تعيين كلمة مرور، فهذا يعد فارغًا. يتوفر هذا فقط عندما يتم الحصول على المستخدم من BaseAuth.listUsers() . | |
com.passwordSalt | خيط | كلمة مرور المستخدم الملحة (تشفير base64)، فقط في حالة استخدام خوارزمية تجزئة Firebase Auth (SCRYPT). إذا تم استخدام خوارزمية تجزئة مختلفة لتحميل هذا المستخدم، كما هو الحال عند الترحيل من نظام مصادقة آخر، فستكون هذه سلسلة فارغة. إذا لم يتم تعيين كلمة مرور، فهذا يعد فارغًا. يتوفر هذا فقط عندما يتم الحصول على المستخدم من BaseAuth.listUsers() . | |
رقم التليفون | خيط | رقم الهاتف الأساسي للمستخدم، إذا تم تعيينه. | |
photoURL | خيط | عنوان URL لصورة المستخدم. | |
ProvideData | معلومات المستخدم [] | مجموعة من مقدمي الخدمة (مثل Google وFacebook) المرتبطين بالمستخدم. | |
معرف المستأجر | سلسلة | باطل | معرف المستأجر الذي ينتمي إليه المستخدم إن وجد. | |
الرموز المميزةValidAfterTime | خيط | التاريخ الذي تصبح فيه الرموز المميزة للمستخدم صالحة بعد تنسيقه كسلسلة UTC. يتم تحديث هذا في كل مرة يتم فيها إبطال رمز التحديث المميز للمستخدم إما من BaseAuth.revocRefreshTokens() API أو من الواجهة الخلفية لـ Firebase Auth عند حدوث تغييرات كبيرة في الحساب (إعادة تعيين كلمة المرور، أو تحديثات كلمة المرور أو البريد الإلكتروني، وما إلى ذلك). | |
uid | خيط | uid المستخدم . |
طُرق
طريقة | الصفات التعريفية | وصف |
---|---|---|
toJSON() | تقوم بإرجاع تمثيل JSON قابل للتسلسل لهذا الكائن. |
UserRecord.customClaims
كائن المطالبات المخصصة للمستخدم، إذا كان متاحًا، يُستخدم عادةً لتحديد أدوار المستخدم ويتم نشره إلى رمز معرف مستخدم تمت مصادقته. يتم تعيين هذا عبر BaseAuth.setCustomUserClaims()
إمضاء:
readonly customClaims?: {
[key: string]: any;
};
سجل المستخدم.معطل
ما إذا كان المستخدم معطلاً أم لا: true
للمعاقين؛ false
للتمكين.
إمضاء:
readonly disabled: boolean;
UserRecord.displayName
اسم العرض الخاص بالمستخدم.
إمضاء:
readonly displayName?: string;
سجل المستخدم.البريد الإلكتروني
البريد الإلكتروني الأساسي للمستخدم، إذا تم تعيينه.
إمضاء:
readonly email?: string;
تم التحقق من UserRecord.email
ما إذا كان قد تم التحقق من البريد الإلكتروني الأساسي للمستخدم أم لا.
إمضاء:
readonly emailVerified: boolean;
UserRecord.metadata
بيانات تعريف إضافية عن المستخدم.
إمضاء:
readonly metadata: UserMetadata;
UserRecord.multiFactor
الخصائص ذات الصلة متعددة العوامل للمستخدم الحالي، إذا كانت متوفرة.
إمضاء:
readonly multiFactor?: MultiFactorSettings;
UserRecord.passwordHash
كلمة المرور المجزأة للمستخدم (المشفرة بـ base64)، فقط في حالة استخدام خوارزمية تجزئة Firebase Auth (SCRYPT). إذا تم استخدام خوارزمية تجزئة مختلفة عند تحميل هذا المستخدم، كما هو معتاد عند الترحيل من نظام مصادقة آخر، فستكون هذه سلسلة فارغة. إذا لم يتم تعيين كلمة مرور، فهذا يعد فارغًا. يتوفر هذا فقط عندما يتم الحصول على المستخدم من BaseAuth.listUsers() .
إمضاء:
readonly passwordHash?: string;
UserRecord.passwordSalt
كلمة مرور المستخدم الملحة (تشفير base64)، فقط في حالة استخدام خوارزمية تجزئة Firebase Auth (SCRYPT). إذا تم استخدام خوارزمية تجزئة مختلفة لتحميل هذا المستخدم، كما هو الحال عند الترحيل من نظام مصادقة آخر، فستكون هذه سلسلة فارغة. إذا لم يتم تعيين كلمة مرور، فهذا يعد فارغًا. يتوفر هذا فقط عندما يتم الحصول على المستخدم من BaseAuth.listUsers() .
إمضاء:
readonly passwordSalt?: string;
سجل المستخدم.رقم الهاتف
رقم الهاتف الأساسي للمستخدم، إذا تم تعيينه.
إمضاء:
readonly phoneNumber?: string;
UserRecord.photoURL
عنوان URL لصورة المستخدم.
إمضاء:
readonly photoURL?: string;
UserRecord.providerData
مجموعة من مقدمي الخدمة (مثل Google وFacebook) المرتبطين بالمستخدم.
إمضاء:
readonly providerData: UserInfo[];
UserRecord.tenantId
معرف المستأجر الذي ينتمي إليه المستخدم إن وجد.
إمضاء:
readonly tenantId?: string | null;
UserRecord.tokensValidAfterTime
التاريخ الذي تصبح فيه الرموز المميزة للمستخدم صالحة بعد تنسيقه كسلسلة UTC. يتم تحديث هذا في كل مرة يتم فيها إبطال رمز التحديث المميز للمستخدم إما من BaseAuth.revocRefreshTokens() API أو من الواجهة الخلفية لـ Firebase Auth عند حدوث تغييرات كبيرة في الحساب (إعادة تعيين كلمة المرور، أو تحديثات كلمة المرور أو البريد الإلكتروني، وما إلى ذلك).
إمضاء:
readonly tokensValidAfterTime?: string;
UserRecord.uid
uid
المستخدم .
إمضاء:
readonly uid: string;
UserRecord.toJSON()
تقوم بإرجاع تمثيل JSON قابل للتسلسل لهذا الكائن.
إمضاء:
toJSON(): object;
عائدات:
هدف
تمثيل JSON قابل للتسلسل لهذا الكائن.