User interface

حساب مستخدم

Signature:

export interface User extends UserInfo 

امتداد: UserInfo

أماكن إقامة

الموقع النوع الوصف
emailVerified boolean ما إذا تم إثبات ملكية الرسالة الإلكترونية باستخدام sendEmailVerification() وapplyActionCode()
isAnonymous boolean تحدّد هذه القيمة ما إذا كان المستخدم قد تمت مصادقته باستخدام موفِّر خدمة ProviderId.ANONYMOUS.
البيانات الوصفية UserMetadata بيانات وصفية إضافية حول أوقات إنشاء المستخدمين وتسجيل الدخول
providerData UserInfo[] معرّف إضافي لكل مقدّم خدمة، مثل DisplayName ومعلومات الملف الشخصي
refreshToken سلسلة الرمز المميّز لإعادة التحميل المُستخدَم لإعادة مصادقة المستخدم تجنَّب استخدام هذا الإجراء مباشرةً وفضّل استخدام User.getIdToken() لإعادة تحميل الرمز المميّز لرقم التعريف بدلاً من ذلك.
tenantId سلسلة | فارغ رقم تعريف المستأجر الخاص بالمستخدم.

الطُرق

الطريقة الوصف
delete() حذف المستخدم وتسجيل خروجه
getIdToken(forceRefresh) لعرض رمز JSON المميّز للويب (JWT) المستخدَم لتحديد هوية المستخدم في خدمة Firebase.
getIdTokenResult(forceRefresh) تعرض رمز JSON المميّز للويب (JWT) لإلغاء التسلسل والمستخدَم لتحديد هوية المستخدم في إحدى خدمات 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

رقم تعريف المستأجر الخاص بالمستخدم.

هذه موقع للقراءة فقط، وهو يشير إلى رقم تعريف المستأجر المُستخدَم لتسجيل دخول المستخدم. ويكون هذا الحقل خاليًا إذا سجَّل المستخدم الدخول من المشروع الرئيسي.

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) لإلغاء التسلسل والمستخدَم لتحديد هوية المستخدم في إحدى خدمات 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 متسلسل لهذا الكائن.