Auth interface

واجهة تمثّل خدمة مصادقة Firebase

راجِع مصادقة Firebase للحصول على دليل كامل حول كيفية استخدام خدمة مصادقة Firebase.

Signature:

export interface Auth 

أماكن إقامة

الموقع	النوع	الوصف
التطبيق	تطبيق Firebase	FirebaseApp المرتبط بمثيل خدمة Auth
الإعداد	الإعداد	الإعداد المستخدَم لإعداد هذا المثيل.
الحالي	المستخدم | فارغ	المستخدم المسجّل دخوله حاليًا (أو فارغ).
emulatorConfig	EmulatorConfig | فارغ	إعدادات المحاكي الحالية (أو قيمة خالية).
languageCode	سلسلة | فارغ	رمز لغة مثيل Auth.
name	السلسلة	اسم التطبيق المرتبط بمثيل خدمة Auth.
الإعدادات	إعدادات المصادقة	إعدادات نسخة Auth الافتراضية.
tenantId	سلسلة | فارغ	رقم تعريف مستأجر مثيل Auth.

الطُرق

الطريقة	الوصف
authStateTrack()	وعدًا يتم حله على الفور عند تسوية حالة المصادقة الأولية. بعد انتهاء الوعد، قد يصبح المستخدم الحالي مستخدمًا صالحًا أو قد يكون null إذا سجّل الخروج.
beforeAuthStateChanged(callback, onAbort)	تضيف استدعاء حظر يتم تشغيله قبل تغيير حالة المصادقة إلى تعيين مستخدم جديد.
onAuthStateChanged(nextOrObserver, error, completed)	تتم إضافة مراقب للاطّلاع على التغييرات التي تطرأ على حالة تسجيل دخول المستخدم.
onIdTokenChanged(nextOrObserver, error, completed)	تتم إضافة مراقب عن التغييرات التي يتم إجراؤها على الرمز المميّز لرقم تعريف المستخدم الذي سجّل الدخول.
setPersistence(persistence)	تغيّر نوع الثبات على المثيل Auth.
signOut()	خروج المستخدم الحالي لا يؤدي ذلك إلى إبطال الرمز المميّز لمعرّف المستخدم تلقائيًا.
updateCurrentUser(user)	تضبط هذه السياسة المستخدم المقدَّم بشكلٍ غير متزامن على Auth.currentUser على النسخة الافتراضية من Auth.
useDeviceLanguage()	لضبط اللغة الحالية على تفضيل الجهاز/المتصفح التلقائي.

تطبيق المصادقة

FirebaseApp المرتبط بمثيل خدمة Auth

Signature:

readonly app: FirebaseApp;

إعدادات المصادقة

الإعداد المستخدَم لإعداد هذا المثيل.

Signature:

readonly config: Config;

المستخدم الحالي

المستخدم المسجّل دخوله حاليًا (أو فارغ).

Signature:

readonly currentUser: User | null;

إعدادات Auth.emulatorConfig

إعدادات المحاكي الحالية (أو قيمة خالية).

Signature:

readonly emulatorConfig: EmulatorConfig | null;

رمز Auth.languageCode

رمز لغة مثيل Auth.

هذه خاصية قابلة للقراءة/الكتابة. وعند ضبطها على قيمة فارغة، يتم تطبيق إعداد اللغة التلقائي في "وحدة تحكُّم Firebase". وسيتم نشر رمز اللغة في نماذج إجراءات البريد الإلكتروني (إعادة ضبط كلمة المرور والتحقق من عنوان البريد الإلكتروني وإبطال تغيير البريد الإلكتروني) ونماذج الرسائل القصيرة SMS لمصادقة الهاتف وأداة التحقّق من reCAPTCHA وعمليات النوافذ المنبثقة/إعادة توجيه OAuth شريطة أن يتيح موفّرو الخدمات المحدّدون الترجمة باستخدام رمز اللغة المحدَّد.

Signature:

languageCode: string | null;

اسم المصادق

اسم التطبيق المرتبط بمثيل خدمة Auth.

Signature:

readonly name: string;

إعدادات المصادقة

إعدادات نسخة Auth الافتراضية.

يُستخدَم هذا الإذن لتعديل/قراءة الخيارات المتعلّقة بالضبط، مثل وضع التحقّق من التطبيقات لمصادقة الهاتف.

Signature:

readonly settings: AuthSettings;

Auth.tenantId

رقم تعريف مستأجر مثيل Auth.

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

Signature:

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'.

Auth.authStateTrack()

وعدًا يتم حله على الفور عند تسوية حالة المصادقة الأولية. بعد انتهاء الوعد، قد يصبح المستخدم الحالي مستخدمًا صالحًا أو قد يكون null إذا سجّل الخروج.

Signature:

authStateReady(): Promise<void>;

المرتجعات:

وعود <باطلة>

Auth.beforeAuthStateChanged()

تضيف استدعاء حظر يتم تشغيله قبل تغيير حالة المصادقة إلى تعيين مستخدم جديد.

Signature:

beforeAuthStateChanged(callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;

المَعلمات

المعلمة	النوع	الوصف
رد الاتصال	(المستخدم: المستخدم | فارغ) => فارغ | وعود <باطلة>	تم تنفيذ طلب معاودة الاتصال قبل ضبط قيمة المستخدم الجديد. وفي حال طرح هذا الخطأ، سيؤدي ذلك إلى حظر ضبط بيانات المستخدم.
onAbort	() => فراغ	يتم تشغيل معاودة الاتصال في حال تكرار استدعاء beforeAuthStateChanged() لاحقًا، ما يسمح لك بالتراجع عن أي آثار جانبية.

المرتجعات:

إلغاء الاشتراك

Auth.onAuthStateChanged()

تتم إضافة مراقب للاطّلاع على التغييرات التي تطرأ على حالة تسجيل دخول المستخدم.

للاحتفاظ بالسلوك القديم، يُرجى الاطّلاع على Auth.onIdTokenChanged().

Signature:

onAuthStateChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

المَعلمات

المعلمة	النوع	الوصف
NextOrObserver	NextOrObserver<المستخدم | null>	تم تشغيل معاودة الاتصال عند التغيير.
خطأ	ErrorFn	تمّ الإيقاف. لا يتم مطلقًا تشغيل معاودة الاتصال هذه. يمكن اكتشاف الأخطاء المتعلقة بتسجيل الدخول والخروج في الوعود الناتجة عن وظائف تسجيل الدخول أو تسجيل الخروج.
مكتملة	CompleteFn	تمّ الإيقاف. لا يتم مطلقًا تشغيل معاودة الاتصال هذه.

المرتجعات:

إلغاء الاشتراك

Auth.onIdTokenChanged()

تتم إضافة مراقب عن التغييرات التي يتم إجراؤها على الرمز المميّز لرقم تعريف المستخدم الذي سجّل الدخول.

ويشمل ذلك أحداث تسجيل الدخول وتسجيل الخروج وإعادة تحميل الرمز المميّز.

Signature:

onIdTokenChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

المَعلمات

المعلمة	النوع	الوصف
NextOrObserver	NextOrObserver<المستخدم | null>	تم تشغيل معاودة الاتصال عند التغيير.
خطأ	ErrorFn	تمّ الإيقاف. لا يتم مطلقًا تشغيل معاودة الاتصال هذه. يمكن اكتشاف الأخطاء المتعلقة بتسجيل الدخول والخروج في الوعود الناتجة عن وظائف تسجيل الدخول أو تسجيل الخروج.
مكتملة	CompleteFn	تمّ الإيقاف. لا يتم مطلقًا تشغيل معاودة الاتصال هذه.

المرتجعات:

إلغاء الاشتراك

Auth.setPersistence()

تغيّر نوع الثبات على المثيل Auth.

سيؤثر ذلك في جلسة المصادقة المحفوظة حاليًا ويطبّق هذا النوع من المثابرة على طلبات تسجيل الدخول المستقبلية، بما في ذلك تسجيل الدخول باستخدام طلبات إعادة التوجيه.

ويسهِّل ذلك على المستخدم الذي يسجّل دخوله لتحديد ما إذا كان يجب تذكّر جلسته أم لا. ويسهل أيضًا عدم الاحتفاظ بحالة المصادقة أبدًا للتطبيقات التي يشاركها المستخدمون الآخرون أو التي تتضمن بيانات حساسة.

ولا تعمل هذه الطريقة في بيئة Node.js.

Signature:

setPersistence(persistence: Persistence): Promise<void>;

المَعلمات

المعلمة	النوع	الوصف
المثابرة	المثابرة	الاستمرارية المطلوب استخدامها.

المرتجعات:

وعود <باطلة>

مثال

auth.setPersistence(browserSessionPersistence);

Auth.signOut()

خروج المستخدم الحالي لا يؤدي ذلك إلى إبطال الرمز المميّز لمعرّف المستخدم تلقائيًا.

لا يمكن استخدام هذه الطريقة في مثيلات Auth التي تم إنشاؤها باستخدام FirebaseServerApp.

Signature:

signOut(): Promise<void>;

المرتجعات:

وعود <باطلة>

Auth.updateCurrentUser()

تضبط هذه السياسة المستخدم المقدَّم بشكلٍ غير متزامن على Auth.currentUser على النسخة الافتراضية من Auth.

سيتم إنشاء نسخة افتراضية جديدة من المستخدم المُقدَّم وضبطه على أنّه "المستخدم الحالي".

سيؤدي هذا إلى تشغيل أدوات استماع Auth.onAuthStateChanged() وAuth.onIdTokenChanged() مثل طرق تسجيل الدخول الأخرى.

يتعذّر تنفيذ العملية مع ظهور خطأ إذا كان المستخدم المطلوب تعديله ينتمي إلى مشروع Firebase مختلف.

Signature:

updateCurrentUser(user: User | null): Promise<void>;

المَعلمات

المعلمة	النوع	الوصف
المستخدم	المستخدم | فارغ	المستخدم الجديد.

المرتجعات:

وعود <باطلة>

Auth.useDeviceLanguage()

لضبط اللغة الحالية على تفضيل الجهاز/المتصفح التلقائي.

Signature:

useDeviceLanguage(): void;

المرتجعات:

فراغ