UserRecord class

يمثل مستخدمًا.

Signature:

export declare class UserRecord 

أماكن إقامة

الموقع	المعدِّلات	النوع	الوصف
customClaims		{ [key: string]: any; }	عنصر المطالبات المخصّص للمستخدم، في حال توفّره، ويُستخدَم عادةً لتحديد أدوار المستخدم ويتم نشره إلى الرمز المميّز لرقم تعريف المستخدم الذي تمت مصادقته. يتم ضبط ذلك من خلال BaseAuth.setCustomUserClaims().
غير مفعَّل		قيمة منطقية	سواء تم إيقاف المستخدم أم لا: true للإيقاف، false للتفعيل.
displayName		السلسلة	الاسم المعروض للمستخدم
email		السلسلة	هو عنوان البريد الإلكتروني الأساسي للمستخدم إذا تم ضبطه.
تم التحقق من عنوان البريد الإلكتروني		قيمة منطقية	ما إذا كان قد تم إثبات ملكية البريد الإلكتروني الأساسي للمستخدم أم لا
البيانات الوصفية		UserMetadata	بيانات وصفية إضافية عن المستخدم.
متعدد العوامل		إعدادات متعدّدة العوامل	تشير هذه السمة إلى السمات المتعددة العوامل للمستخدم الحالي، إذا كان ذلك متاحًا.
passwordHash		السلسلة	كلمة مرور المستخدم المجزّأة (بترميز base64)، فقط في حال استخدام خوارزمية تجزئة مصادقة Firebase (SCRYPT). إذا تم استخدام خوارزمية تجزئة مختلفة عند تحميل هذا المستخدم، كما هو الحال عادةً عند نقل البيانات من نظام Auth آخر، ستكون هذه سلسلة فارغة. إذا لم يتم تعيين كلمة مرور، تكون هذه القيمة خالية. ولا يتوفّر ذلك إلا عند الحصول على المستخدم من BaseAuth.listUsers().
passwordSalt		السلسلة	بيانات عشوائية مضافة إلى كلمة مرور المستخدم (بترميز base64)، فقط في حال استخدام خوارزمية تجزئة مصادقة Firebase (SCRYPT). وفي حال استخدام خوارزمية تجزئة مختلفة لتحميل هذا المستخدم، وهو ما يحدث عادةً عند نقل البيانات من نظام مصادقة آخر، ستكون هذه سلسلة فارغة. إذا لم يتم تعيين كلمة مرور، تكون هذه القيمة خالية. ولا يتوفّر ذلك إلا عند الحصول على المستخدم من BaseAuth.listUsers().
phoneNumber		السلسلة	رقم الهاتف الأساسي للمستخدم، إذا تم ضبطه.
photoURL		السلسلة	عنوان URL لصورة المستخدم.
providerData		معلومات المستخدم[]	مصفوفة من مقدّمي الخدمات (مثل Google وFacebook) مرتبطة بالمستخدم.
tenantId		سلسلة | فارغ	معرّف المستأجر الذي ينتمي إليه المستخدم، إذا كان متاحًا.
tokensValidafterTime		السلسلة	تشير هذه السمة إلى التاريخ الذي تكون فيه الرموز المميّزة للمستخدم صالحة، ويتم تنسيقه كسلسلة بالتوقيت العالمي المنسّق (UTC). يتمّ تعديل هذه الإعدادات في كلّ مرّة يتم فيها إبطال الرمز المميّز لإعادة التحميل للمستخدم إمّا من واجهة برمجة التطبيقات BaseAuth.revokeRefreshTokens() أو من الواجهة الخلفية لمصادقة Firebase عند إجراء تغييرات كبيرة على الحسابات (مثل عمليات إعادة ضبط كلمات المرور أو تعديلات كلمات المرور أو رسائل البريد الإلكتروني وما إلى ذلك).
رقم uid		السلسلة	uid للمستخدِم.

الطُرق

الطريقة	المعدِّلات	الوصف
toJSON()		تعرض تمثيلاً بتنسيق JSON لهذا الكائن.

UserRecord.customClaims

عنصر المطالبات المخصّص للمستخدم، في حال توفّره، ويُستخدَم عادةً لتحديد أدوار المستخدم ويتم نشره إلى الرمز المميّز لرقم تعريف المستخدم الذي تمت مصادقته. يتم ضبط ذلك من خلال BaseAuth.setCustomUserClaims().

Signature:

readonly customClaims?: {
        [key: string]: any;
    };

UserRecord.Disable

سواء تم إيقاف المستخدم أم لا: true للإيقاف، false للتفعيل.

Signature:

readonly disabled: boolean;

UserRecord.displayName

الاسم المعروض للمستخدم

Signature:

readonly displayName?: string;

UserRecord.email

هو عنوان البريد الإلكتروني الأساسي للمستخدم إذا تم ضبطه.

Signature:

readonly email?: string;

تم التحقق من عنوان البريد الإلكتروني لـ UserRecord.email

ما إذا كان قد تم إثبات ملكية البريد الإلكتروني الأساسي للمستخدم أم لا

Signature:

readonly emailVerified: boolean;

بيانات UserRecord.metadata

بيانات وصفية إضافية عن المستخدم.

Signature:

readonly metadata: UserMetadata;

UserRecord.multiFactor

تشير هذه السمة إلى السمات المتعددة العوامل للمستخدم الحالي، إذا كان ذلك متاحًا.

Signature:

readonly multiFactor?: MultiFactorSettings;

UserRecord.passwordHash

كلمة مرور المستخدم المجزّأة (بترميز base64)، فقط في حال استخدام خوارزمية تجزئة مصادقة Firebase (SCRYPT). إذا تم استخدام خوارزمية تجزئة مختلفة عند تحميل هذا المستخدم، كما هو الحال عادةً عند نقل البيانات من نظام Auth آخر، ستكون هذه سلسلة فارغة. إذا لم يتم تعيين كلمة مرور، تكون هذه القيمة خالية. ولا يتوفّر ذلك إلا عند الحصول على المستخدم من BaseAuth.listUsers().

Signature:

readonly passwordHash?: string;

UserRecord.passwordSalt

بيانات عشوائية مضافة إلى كلمة مرور المستخدم (بترميز base64)، فقط في حال استخدام خوارزمية تجزئة مصادقة Firebase (SCRYPT). وفي حال استخدام خوارزمية تجزئة مختلفة لتحميل هذا المستخدم، وهو ما يحدث عادةً عند نقل البيانات من نظام مصادقة آخر، ستكون هذه سلسلة فارغة. إذا لم يتم تعيين كلمة مرور، تكون هذه القيمة خالية. ولا يتوفّر ذلك إلا عند الحصول على المستخدم من BaseAuth.listUsers().

Signature:

readonly passwordSalt?: string;

رقم هاتف المستخدم

رقم الهاتف الأساسي للمستخدم، إذا تم ضبطه.

Signature:

readonly phoneNumber?: string;

UserRecord.photoURL

عنوان URL لصورة المستخدم.

Signature:

readonly photoURL?: string;

UserRecord.providerData

مصفوفة من مقدّمي الخدمات (مثل Google وFacebook) مرتبطة بالمستخدم.

Signature:

readonly providerData: UserInfo[];

رقم تعريف UserRecord.tenantId

معرّف المستأجر الذي ينتمي إليه المستخدم، إذا كان متاحًا.

Signature:

readonly tenantId?: string | null;

UserRecord.tokensValidafterTime

تشير هذه السمة إلى التاريخ الذي تكون فيه الرموز المميّزة للمستخدم صالحة، ويتم تنسيقه كسلسلة بالتوقيت العالمي المنسّق (UTC). يتمّ تعديل هذه الإعدادات في كلّ مرّة يتم فيها إبطال الرمز المميّز لإعادة التحميل للمستخدم إمّا من واجهة برمجة التطبيقات BaseAuth.revokeRefreshTokens() أو من الواجهة الخلفية لمصادقة Firebase عند إجراء تغييرات كبيرة على الحسابات (مثل عمليات إعادة ضبط كلمات المرور أو تعديلات كلمات المرور أو رسائل البريد الإلكتروني وما إلى ذلك).

Signature:

readonly tokensValidAfterTime?: string;

UserRecord.uid

uid للمستخدِم

Signature:

readonly uid: string;

UserRecord.toJSON()

تعرض تمثيلاً بتنسيق JSON لهذا الكائن.

Signature:

toJSON(): object;

المرتجعات:

كائن

تمثّل هذه السمة تمثيلاً بتنسيق JSON لهذا العنصر.