Auth interface

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

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

Signature:

export interface Auth 

أماكن إقامة

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

الطُرق

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

Auth.app

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

Signature:

readonly app: FirebaseApp;

Auth.config

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

Signature:

readonly config: Config;

Auth.currentUser

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

Signature:

readonly currentUser: User | null;

Auth.emulatorConfig

إعدادات المحاكي الحالية (أو قيمة فارغة)

Signature:

readonly emulatorConfig: EmulatorConfig | null;

Auth.languageCode

رمز لغة مثيل Auth

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

Signature:

languageCode: string | null;

Auth.name

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

Signature:

readonly name: string;

Auth.settings

إعدادات مثيل Auth

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

Signature:

readonly settings: AuthSettings;

Auth.tenantId

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

هذه خاصية قابلة للقراءة/قابلة للكتابة. عند ضبط رقم تعريف المستأجر لمثيل 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.authStateReady()

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

Signature:

authStateReady(): Promise<void>;

المرتجعات:

Promise<void>

Auth.beforeAuthStateChanged()

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

Signature:

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

المَعلمات

المَعلمة	النوع	الوصف
معاودة الاتصال	(user: User | null) => void | Promise<void>	تم تفعيل معاودة الاتصال قبل ضبط قيمة المستخدِم الجديد. إذا تم تنفيذ هذا الإجراء، سيتم حظر المستخدم من التسجيل.
onAbort	() => باطء	يتم تفعيل معاودة الاتصال في حال ظهور معاودة اتصال beforeAuthStateChanged() لاحقًا، ما يسمح لك بالتراجع عن أي آثار جانبية.

المرتجعات:

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

Auth.onAuthStateChanged()

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

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

Signature:

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

المَعلمات

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

المرتجعات:

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

Auth.onIdTokenChanged()

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

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

Signature:

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

المَعلمات

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

المرتجعات:

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

Auth.setPersistence()

تعمل هذه السياسة على تغيير نوع الثبات في مثيل Auth.

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

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

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

Signature:

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

المَعلمات

المَعلمة	النوع	الوصف
الإصرار	الإصرار	تمثّل هذه السمة الثبات المطلوب استخدامه.

المرتجعات:

Promise<void>

مثال

auth.setPersistence(browserSessionPersistence);

Auth.signOut()

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

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

Signature:

signOut(): Promise<void>;

المرتجعات:

Promise<void>

Auth.updateCurrentUser()

يضبط هذا الإعداد المستخدم المقدّم بشكل غير متزامن على أنّه Auth.currentUser على مثيل Auth.

سيتم إنشاء نسخة جديدة من المستخدم الذي تم تقديمه وضبطها على الخيار currentUser.

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

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

Signature:

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

المَعلمات

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

المرتجعات:

Promise<void>

Auth.useDeviceLanguage()

ضبط اللغة الحالية على الإعدادات المفضّلة للمتصفح أو الجهاز

Signature:

useDeviceLanguage(): void;

المرتجعات:

void