auth package

مصادقة Firebase

الدوال

الوظيفة الوصف
الوظيفة(التطبيق، ...)
getAuth(app) تعرض هذه الدالة مثيل Auth المرتبط بتطبيق FirebaseApp المقدَّم. في حال عدم توفّر مثيل، يتم إعداد مثيل Auth مع التبعيات التلقائية الخاصة بالنظام الأساسي.
initializeAuth(app, deps) تعمل هذه السياسة على إعداد مثيل Auth مع التحكّم بدقة في التبعيات.
الوظيفة(storage, ...)
getReactNativePersistence(storage) تعرض عنصر استمرارية يضمّ AsyncStorage الذي تم استيراده من react-native أو @react-native-community/async-storage، ويمكن استخدامه في حقل تبعية الثبات في initializeAuth().
الوظيفة(auth, ...)
applyActionCode(auth, oobCode) يتيح هذا الخيار تطبيق رمز التحقّق الذي تم إرساله إلى المستخدم عبر البريد الإلكتروني أو أي آلية أخرى خارج النطاق.
beforeAuthStateChanged(auth, callback, onAbort) يضيف هذا الإعداد معاودة الاتصال للحظر التي يتم تشغيلها قبل تغيير حالة المصادقة لتعيين مستخدم جديد.
checkActionCode(auth, oobCode) تفحص رمز التحقّق الذي تم إرساله إلى المستخدم عبر البريد الإلكتروني أو أي آلية أخرى خارج النطاق.
confirmPasswordReset(auth, oobCode, newPassword) من أجل إكمال عملية إعادة تعيين كلمة المرور، مع تقديم رمز تأكيد وكلمة مرور جديدة.
connectAuthEmulator(auth, url, options) يغيّر مثيل Auth للاتصال بمحاكي مصادقة Firebase، بدلاً من خدمات مصادقة Firebase للإنتاج.
createUserWithEmailAndPassword(auth, email, password) ينشئ حساب مستخدم جديدًا مرتبطًا بعنوان البريد الإلكتروني وكلمة المرور المحدّدين.
fetchSignInMethodsForEmail(auth, email) للحصول على قائمة بطرق تسجيل الدخول المحتملة لعنوان البريد الإلكتروني المحدّد. تعرض هذه الطريقة قائمة فارغة عند تفعيل ميزة [حماية تعداد البريد الإلكتروني](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection)، بغض النظر عن عدد طرق المصادقة المتاحة لهذا البريد الإلكتروني.
getMultiFactorResolver(auth, error) توفر أداة MultiFactorResolver مناسب لإكمال تدفق متعدد العوامل.
getRedirectResult(auth, resolver) تعرض UserCredential من عملية تسجيل الدخول المستندة إلى إعادة التوجيه.
initializeRecaptchaConfig(auth) لتحميل إعدادات reCAPTCHA في المثيل Auth.
isSignInWithEmailLink(auth, emailLink) يتحقّق مما إذا كان الرابط الوارد يؤدي إلى تسجيل الدخول باستخدام رابط بريد إلكتروني مناسب لـ signInWithEmailLink().
onAuthStateChanged(auth, nextOrObserver, error, completed) إضافة مراقب للتغييرات التي تطرأ على حالة تسجيل دخول المستخدِم.
onIdTokenChanged(auth, nextOrObserver, error, completed) تتم إضافة مراقب للتغييرات التي تطرأ على الرمز المميّز لرقم تعريف المستخدم الذي سجّل الدخول.
revokeAccessToken(auth, token) يؤدي هذا الإجراء إلى إبطال رمز الدخول المحدَّد. لا تتوافق حاليًا إلا مع رموز دخول Apple OAuth.
sendPasswordResetEmail(auth, email, actionCodeSettings) يرسل رسالة إلكترونية لإعادة ضبط كلمة المرور إلى عنوان البريد الإلكتروني المحدّد. لا تؤدي هذه الطريقة إلى ظهور خطأ في حال عدم توفّر حساب مستخدم بعنوان البريد الإلكتروني المحدّد وتفعيل ميزة [حماية تعداد البريد الإلكتروني](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection).
sendSignInLinkToEmail(auth, email, actionCodeSettings) يتم إرسال رابط بريد إلكتروني لتسجيل الدخول إلى المستخدم باستخدام عنوان البريد الإلكتروني المحدّد.
setPersistence(auth, persistence) تغيير نوع التثبيت على مثيل Auth لجلسة Auth المحفوظة حاليًا ويطبّق هذا النوع من التثبيت لطلبات تسجيل الدخول المستقبلية، بما في ذلك تسجيل الدخول باستخدام طلبات إعادة التوجيه.
signInAnonymously(auth) يسجّل الدخول بشكل غير متزامن كمستخدم مجهول.
signInWithCredential(auth, credential) تسجيل الدخول بشكل غير متزامن باستخدام بيانات الاعتماد المقدمة
signInWithCustomToken(auth, customToken) يسجِّل الدخول بشكل غير متزامن باستخدام رمز مميّز مخصّص.
signInWithEmailAndPassword(auth, email, password) تسجيل الدخول بشكل غير متزامن باستخدام بريد إلكتروني وكلمة مرور.
signInWithEmailLink(auth, email, emailLink) يمكن تسجيل الدخول بشكل غير متزامن باستخدام عنوان بريد إلكتروني ورابط خاص بتسجيل الدخول.
signInWithPhoneNumber(auth, phoneNumber, appVerifier) يسجِّل الدخول بشكل غير متزامن باستخدام رقم هاتف.
signInWithPopup(auth, provider, resolver) مصادقة عميل Firebase باستخدام إجراءات مصادقة OAuth مستندة إلى نافذة منبثقة.
signInWithRedirect(auth, provider, resolver) مصادقة عميل Firebase باستخدام عملية إعادة توجيه بملء الصفحة.
signOut(auth) يسجِّل خروج المستخدم الحالي.
updateCurrentUser(auth, user) يضبط هذا الإعداد المستخدم المقدّم بشكل غير متزامن على أنّه Auth.currentUser على مثيل Auth.
useDeviceLanguage(auth) ضبط اللغة الحالية على الإعدادات المفضّلة للمتصفح أو الجهاز
validatePassword(auth, password) يتحقق من صحة كلمة المرور مقابل سياسة كلمة المرور التي تم إعدادها للمشروع أو المستأجر.
verifyPasswordResetCode(auth, code) يتحقق من رمز إعادة ضبط كلمة المرور الذي تم إرساله إلى المستخدم عبر البريد الإلكتروني أو أي آلية أخرى خارج النطاق.
الوظيفة(link, ...)
parseActionCodeURL(link) تحلّل سلسلة رابط إجراء البريد الإلكتروني وتعرض ActionCodeURL إذا كان الرابط صالحًا أو يتم عرض قيمة فارغة.
الوظيفة(user, ...)
deleteUser(user) حذف المستخدم وتسجيل خروجه
getIdToken(user, forceRefresh) لعرض رمز JSON المميّز للويب (JWT) المستخدَم لتحديد هوية المستخدم في خدمة Firebase.
getIdTokenResult(user, forceRefresh) تعرض رمز JSON المميّز للويب (JWT) لإلغاء التسلسل والمستخدَم لتحديد هوية المستخدم في إحدى خدمات Firebase.
linkWithCredential(user, credential) يؤدي هذا الإجراء إلى ربط حساب المستخدم ببيانات الاعتماد المقدَّمة.
linkWithPhoneNumber(user, phoneNumber, appVerifier) يربط حساب المستخدم برقم الهاتف المحدّد.
linkWithPopup(user, provider, resolver) لربط المقدِّم الذي تمت المصادقة عليه بحساب المستخدم باستخدام مسار OAuth مستند إلى نافذة منبثقة.
linkWithRedirect(user, provider, resolver) لربط OAuthProvider بحساب المستخدم باستخدام تدفق إعادة توجيه الصفحة الكاملة.
multiFactor(user) MultiFactorUser المقابل للمستخدم.
reauthenticateWithCredential(user, credential) تتم إعادة مصادقة مستخدم باستخدام بيانات اعتماد جديدة.
reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier) تتم إعادة مصادقة المستخدم باستخدام بيانات اعتماد هاتف جديدة.
reauthenticateWithPopup(user, provider, resolver) تتم إعادة مصادقة المستخدم الحالي باستخدام OAuthProvider المحدد باستخدام تدفق OAuth يستند إلى نافذة منبثقة.
reauthenticateWithRedirect(user, provider, resolver) تتم إعادة مصادقة المستخدم الحالي باستخدام OAuthProvider المحدَّد باستخدام تدفق إعادة توجيه صفحة كاملة.
إعادة تحميل(المستخدم) إعادة تحميل بيانات حساب المستخدم في حال تسجيل الدخول
sendEmailVerification(user, actionCodeSettings) إرسال رسالة تحقُّق إلى مستخدم
unlink(user, providerId) لإلغاء ربط مقدّم خدمة بحساب مستخدم.
updateEmail(user, newEmail) تعدِّل عنوان البريد الإلكتروني للمستخدِم.
updatePassword(user, newPassword) لتعديل كلمة مرور المستخدم.
updatePhoneNumber(user, credential) تعدِّل رقم هاتف المستخدم.
updateProfile(user, { displayName, photoURL: photoUrl }) لتعديل بيانات الملف الشخصي لمستخدم.
verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings) لإرسال رسالة تحقُّق إلى عنوان بريد إلكتروني جديد.
الوظيفة(userCredential, ...)
getAdditionalUserInfo(userCredential) استخراج AdditionalUserInfo الخاصة بالموفِّر لبيانات الاعتماد المحددة.

صفوف

دورات تدريبية الوصف
ActionCodeURL فئة أدوات لتحليل عناوين URL لإجراءات البريد الإلكتروني، مثل إعادة ضبط كلمة المرور، والتحقق من عنوان البريد الإلكتروني، وتسجيل الدخول إلى رابط البريد الإلكتروني، وما إلى ذلك.
AuthCredential واجهة تمثل بيانات الاعتماد التي يعرضها AuthProvider.
EmailAuthCredential الواجهة التي تمثل بيانات الاعتماد التي يعرضها EmailAuthProvider لـ ProviderId.password
EmailAuthProvider موفِّر لإنشاء EmailAuthCredential.
FacebookAuthProvider موفِّر خدمة إنشاء OAuthCredential لـ ProviderId.FACEBOOK.
GithubAuthProvider موفِّر خدمة إنشاء OAuthCredential لـ ProviderId.GITHUB.
GoogleAuthProvider موفِّر خدمة إنشاء OAuthCredential لـ ProviderId.GOOGLE.
OAuthCredential تمثل بيانات اعتماد OAuth التي يعرضها OAuthProvider.
OAuthProvider موفِّر لإنشاء OAuthCredential العام.
PhoneAuthCredential تمثل بيانات الاعتماد التي يعرضها PhoneAuthProvider.
PhoneAuthProvider موفِّر خدمة إنشاء PhoneAuthCredential.
PhoneMultiFactorGenerator موفِّر خدمة إنشاء PhoneMultiFactorAssertion
RecaptchaVerifier أداة للتحقُّق من التطبيقات مستندة إلى reCAPTCHA
SAMLAuthProvider AuthProvider لـ SAML.
TotpMultiFactorGenerator موفِّر خدمة إنشاء TotpMultiFactorAssertion
TotpSecret موفِّر لإنشاء TotpMultiFactorAssertion.يخزِّن المفتاح السري المشترك والمعلَمات الأخرى لإنشاء كلمات مرور صالحة لمرة واحدة (OTP) مستندة إلى الوقت. تنفيذ طرق لاسترداد المفتاح السري المشترك وإنشاء عنوان URL لرمز الاستجابة السريعة.
TwitterAuthProvider موفِّر خدمة إنشاء OAuthCredential لـ ProviderId.TWITTER.

واجهات

الواجهة الوصف
ActionCodeInfo استجابة من checkActionCode().
ActionCodeSettings واجهة تحدِّد عنوان URL المطلوب للمتابعة/الحالة باستخدام معرّفات اختيارية لحِزم Android وiOS
AdditionalUserInfo بنية تحتوي على معلومات إضافية عن المستخدمين من موفِّر الهوية الموحّدة.
ApplicationVerifier أداة للتحقّق من إثبات ملكية النطاق ومنع إساءة الاستخدام
المصادقة واجهة تمثِّل خدمة مصادقة Firebase
AuthError واجهة لخطأ Auth.
AuthErrorMap تعيين رموز الخطأ لرسائل الخطأ.
AuthProvider واجهة تمثّل موفّر المصادقة، وتُستخدَم لتسهيل إنشاء AuthCredential.
AuthSettings واجهة تمثِّل إعدادات مثيل Auth
الإعداد واجهة تمثِّل إعدادات Auth
ConfirmationResult نتيجة لتسجيل الدخول إلى رقم هاتف أو الربط به أو إعادة مصادقة مكالمة
التبعيات يشير ذلك المصطلح إلى التبعيات التي يمكن استخدامها لإعداد مثيل Auth.
EmulatorConfig ضبط محاكي مصادقة Firebase
IdTokenResult واجهة تمثّل نتيجة الرمز المميّز لرقم التعريف الذي تم الحصول عليه من User.getIdTokenResult().
MultiFactorAssertion الفئة الأساسية لتأكيد ملكية العامل الثاني.
MultiFactorError يظهر الخطأ عندما يحتاج المستخدم إلى تقديم عامل ثانٍ لتسجيل الدخول بنجاح.
MultiFactorInfo يشير ذلك المصطلح إلى بنية تحتوي على معلومات عن العامل الثاني.
MultiFactorResolver الفئة المستخدَمة لتسهيل الاسترداد من MultiFactorError عندما يحتاج المستخدم إلى توفير عامل ثانٍ لتسجيل الدخول.
MultiFactorSession واجهة تحدِّد عنصر الجلسة المتعدّدة العوامل والمستخدَمة لتسجيل عامل ثانٍ في مستخدِم أو المساعدة في تسجيل دخول مستخدِم مسجَّل بعامل ثانٍ.
MultiFactorUser واجهة تحدِّد السمات والعمليات ذات الصلة المتعدّدة العوامل المستخدِم
OAuthCredentialOptions تحدِّد هذه السياسة خيارات إعداد OAuthCredential.
ParsedToken واجهة تمثّل رمزًا مميّزًا تم تحليله لرقم التعريف
PasswordPolicy بنية تحدد متطلبات سياسة كلمة المرور.
PasswordValidationStatus بنية تشير إلى متطلبات سياسة كلمة المرور التي تم استيفاؤها أو انتهاكها والمتطلبات.
الإصرار واجهة تغطي أنواع آليات الاستمرار المحتملة.
PhoneMultiFactorAssertion الفئة المطلوب تأكيد ملكية العامل الثاني للهاتف مُقدَّم من PhoneMultiFactorGenerator.assertion().
PhoneMultiFactorEnrollInfoOptions الخيارات المستخدَمة لتسجيل عامل ثانٍ.
PhoneMultiFactorInfo الفئة الفرعية من واجهة MultiFactorInfo للعوامل الثانية لرقم الهاتف. factorId لهذا العامل الثاني هو FactorId.PHONE.
PhoneMultiFactorSignInInfoOptions الخيارات المستخدمة لتسجيل الدخول بالعامل الثاني.
PhoneSingleFactorInfoOptions الخيارات المستخدمة لتسجيل الدخول بعامل واحد.
PopupRedirectResolver برنامج تعيين يُستخدم لمعالجة عمليات محدّدة في DOM، مثل signInWithPopup() أو signInWithRedirect().
ReactNativeAsyncStorage واجهة لـ AsyncStorage مقدّم
RecaptchaParameters واجهة تمثِّل مَعلمات reCAPTCHA.يمكنك الاطّلاع على [مستندات ReCAPTCHA](https://developers.google.com/recaptcha/docs/display#render_param) للاطّلاع على قائمة المَعلمات المقبولة. يتم قبول جميع المَعلمات باستثناء sitekey: توفّر مصادقة Firebase اختبار reCAPTCHA لكل مشروع، كما تضبط مفتاح الموقع الإلكتروني عند العرض.بالنسبة إلى reCAPTCHA غير المرئية، اضبط مفتاح size على invisible.
TotpMultiFactorAssertion الفئة المطلوب تأكيد ملكيتها لعامل TOTP الثاني. مقدَّمة من TotpMultiFactorGenerator.assertionForEnrollment() وTotpMultiFactorGenerator.assertionForSignIn()
TotpMultiFactorInfo تمثّل هذه السمة الفئة الفرعية لواجهة MultiFactorInfo للعوامل الثانية في دالة TOTP. قيمة factorId لهذا العامل الثاني هي FactorId.TOTP.
المستخدم حساب مستخدم
UserCredential بنية تحتوي على المستخدم وOperationType ومعرّف مقدّم الخدمة.
UserInfo معلومات الملف الشخصي للمستخدم، لا تظهر إلا لتطبيقات مشروع Firebase.
UserMetadata واجهة تمثّل البيانات الوصفية للمستخدِم.

المتغيرات

متغير الوصف
ActionCodeOperation تعداد لأنواع إجراءات البريد الإلكتروني المحتملة.
AuthErrorCodes خريطة لرموز أخطاء Auth المحتمَلة، وذلك لتسهيل المقارنة مع الأخطاء الناتجة عن حزمة تطوير البرامج (SDK)
browserLocalPersistence تنفيذ الثبات من النوع LOCAL باستخدام localStorage لمساحة التخزين الأساسية.
browserPopupRedirectResolver تنفيذ PopupRedirectResolver المناسب للتطبيقات التي تستند إلى المتصفح.
browserSessionPersistence تنفيذ الثبات لـ SESSION باستخدام sessionStorage لمساحة التخزين الأساسية.
cordovaPopupRedirectResolver تطبيق PopupRedirectResolver مناسب للتطبيقات التي يعتمد على كوردوفا.
debugErrorMap خريطة أخطاء مطوّلة تتضمّن أوصافًا تفصيلية لمعظم رموز الأخطاء.اطّلِع على المناقشة على الرابط AuthErrorMap.
FactorId يشير ذلك المصطلح إلى تعداد العوامل التي يمكن استخدامها للمصادقة المتعدّدة العوامل.
indexedDBLocalPersistence تنفيذ الثبات من النوع LOCAL باستخدام indexedDB لمساحة التخزين الأساسية.
inMemoryPersistence تنفيذ نوع الثبات من النوع 'NONE'
OperationType تعداد أنواع العمليات المتوافقة.
prodErrorMap خريطة خطأ بسيطة تعرض كل رسائل الأخطاء المطوَّلة.اطّلِع على المناقشة على الرابط AuthErrorMap.
ProviderId تعداد المزوّدين المتوافقين.
SignInMethod تعداد طُرق تسجيل الدخول المتوافقة

الأسماء المستعارة للنوع

النوع البديل الوصف
CustomParameters ربط مَعلمات OAuth المخصَّصة.
NextOrObserver اكتب تعريفًا لمعاودة الاتصال بالحدث.
PhoneInfoOptions المعلومات المطلوبة لإثبات ملكية رقم هاتف.
UserProfile الملف الشخصي للمستخدم المستخدَم في AdditionalUserInfo.

الدالة(app, ...)

getAuth(app)

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

Signature:

export declare function getAuth(app?: FirebaseApp): Auth;

المَعلمات

المَعلمة النوع الوصف
التطبيق FirebaseApp تطبيق Firebase

المرتجعات:

المصادقة

initializeAuth(app, deps)

تعمل هذه السياسة على إعداد مثيل Auth مع التحكّم بدقة في التبعيات.

تتيح هذه الدالة مزيدًا من التحكم في مثيل Auth مقارنةً بالإجراء getAuth(). وتستخدم getAuth الإعدادات التلقائية الخاصة بالنظام الأساسي لتوفير التبعيات. بشكلٍ عام، الطريقة getAuth هي أسهل طريقة لإعداد المصادقة وتعمل مع معظم حالات الاستخدام. استخدِم initializeAuth إذا كنت بحاجة إلى التحكّم في طبقة الثبات المستخدَمة، أو لتقليل حجم الحزمة في حال عدم استخدام signInWithPopup أو signInWithRedirect.

على سبيل المثال، إذا كان تطبيقك يستخدم الحسابات المخفية الهوية فقط وكنت تريد فقط حفظ الحسابات للجلسة الحالية، يمكنك إعداد تطبيق "Auth" باستخدام ما يلي:

const auth = initializeAuth(app, {
  persistence: browserSessionPersistence,
  popupRedirectResolver: undefined,
});

Signature:

export declare function initializeAuth(app: FirebaseApp, deps?: Dependencies): Auth;

المَعلمات

المَعلمة النوع الوصف
التطبيق FirebaseApp
أقسام التبعيات

المرتجعات:

المصادقة

الدالة(storage, ...)

getReactNativePersistence(storage)

تعرض عنصر استمرارية يلتف على AsyncStorage الذي تم استيراده من react-native أو @react-native-community/async-storage، ويمكن استخدامه في حقل تبعية الثبات في initializeAuth().

Signature:

export declare function getReactNativePersistence(storage: ReactNativeAsyncStorage): Persistence;

المَعلمات

المَعلمة النوع الوصف
التخزين ReactNativeAsyncStorage

المرتجعات:

الإصرار

الدالة(auth, ...)

applyActionCode(auth, oobCode)

يتيح هذا الخيار تطبيق رمز التحقّق الذي تم إرساله إلى المستخدم عبر البريد الإلكتروني أو أي آلية أخرى خارج النطاق.

Signature:

export declare function applyActionCode(auth: Auth, oobCode: string): Promise<void>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
oobCode سلسلة رمز التحقّق الذي يتم إرساله إلى المستخدم.

المرتجعات:

Promise<void>

beforeAuthStateChanged(auth, callback, onAbort)

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

Signature:

export declare function beforeAuthStateChanged(auth: Auth, callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;

المَعلمات

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

المرتجعات:

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

checkActionCode(auth, oobCode)

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

Signature:

export declare function checkActionCode(auth: Auth, oobCode: string): Promise<ActionCodeInfo>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
oobCode سلسلة رمز التحقّق الذي يتم إرساله إلى المستخدم.

المرتجعات:

Promise<ActionCodeInfo>

بيانات التعريف حول التعليمة البرمجية.

confirmPasswordReset(auth, oobCode, newPassword)

من أجل إكمال عملية إعادة تعيين كلمة المرور، مع تقديم رمز تأكيد وكلمة مرور جديدة.

Signature:

export declare function confirmPasswordReset(auth: Auth, oobCode: string, newPassword: string): Promise<void>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
oobCode سلسلة رمز تأكيد البيانات يتم إرساله إلى المستخدم
newPassword سلسلة كلمة المرور الجديدة

المرتجعات:

Promise<void>

connectAuthEmulator(auth, url, options)

يغيّر مثيل Auth للاتصال بمحاكي مصادقة Firebase، بدلاً من خدمات مصادقة Firebase للإنتاج.

ويجب استدعاء هذه العملية بشكل متزامن بعد الاتصال الأول مباشرةً إلى initializeAuth(). لا تستخدِمه مع بيانات اعتماد الإنتاج لأنّ حركة بيانات المحاكي غير مشفّرة.

Signature:

export declare function connectAuthEmulator(auth: Auth, url: string, options?: {
    disableWarnings: boolean;
}): void;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
url سلسلة عنوان URL الذي يتم تشغيل المحاكي عليه (على سبيل المثال، "http://localhost:9099").
الخيارات { disableWarnings: boolean; } اختياريّ. يتم ضبط options.disableWarnings تلقائيًا على false. اضبط القيمة على true لإيقاف بانر التحذير المرفق بنموذج العناصر في المستند (DOM).

المرتجعات:

void

مثال

connectAuthEmulator(auth, 'http://127.0.0.1:9099', { disableWarnings: true });

createUserWithEmailAndPassword(auth, email, password)

ينشئ حساب مستخدم جديدًا مرتبطًا بعنوان البريد الإلكتروني وكلمة المرور المحدّدين.

عند إنشاء حساب المستخدم بنجاح، سيتم أيضًا تسجيل دخول هذا المستخدم إلى تطبيقك.

قد يتعذّر إنشاء حساب المستخدم إذا كان الحساب موجودًا من قبل أو إذا كانت كلمة المرور غير صالحة.

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

Signature:

export declare function createUserWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
بريد إلكتروني سلسلة عنوان البريد الإلكتروني للمستخدِم.
كلمة مرور سلسلة كلمة المرور التي اختارها المستخدم.

المرتجعات:

Promise<UserCredential>

fetchSignInMethodsForEmail(auth, email)

للحصول على قائمة بطرق تسجيل الدخول المحتملة لعنوان البريد الإلكتروني المحدّد. تعرض هذه الطريقة قائمة فارغة عند تفعيل ميزة [حماية تعداد البريد الإلكتروني](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection)، بغض النظر عن عدد طرق المصادقة المتاحة لهذا البريد الإلكتروني.

يُعدّ هذا الإجراء مفيدًا للتمييز بين طُرق تسجيل الدخول لموفِّر الخدمة نفسه، على سبيل المثال: يحتوي EmailAuthProvider على طريقتين لتسجيل الدخول، وهما SignInMethod.EMAIL_password وSignInMethod.EMAIL_LINK.

Signature:

export declare function fetchSignInMethodsForEmail(auth: Auth, email: string): Promise<string[]>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
بريد إلكتروني سلسلة عنوان البريد الإلكتروني للمستخدم.تم إيقافه. وبالتالي، ننصح بعدم اتّباع هذه الطريقة كأحد أفضل ممارسات الأمان. يمكنك الاطّلاع على مزيد من المعلومات في مستندات "منصة الهوية" بشأن [حماية تعداد البريد الإلكتروني](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection).

المرتجعات:

وعد<string[]>

getMultiFactorResolver(auth, error)

توفر أداة MultiFactorResolver مناسب لإكمال تدفق متعدد العوامل.

Signature:

export declare function getMultiFactorResolver(auth: Auth, error: MultiFactorError): MultiFactorResolver;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
خطأ MultiFactorError الخطأ MultiFactorError الذي ظهر أثناء عملية تسجيل الدخول أو إعادة المصادقة.

المرتجعات:

MultiFactorResolver

getRedirectResult(auth, resolver)

تعرض UserCredential من عملية تسجيل الدخول المستندة إلى إعادة التوجيه.

إذا تم تسجيل الدخول بنجاح، سيتم عرض المستخدم الذي تم تسجيل الدخول إليه. في حال تعذَّر تسجيل الدخول، ستتعذّر عملية تسجيل الدخول مع ظهور خطأ. إذا لم يتم استدعاء أي عملية إعادة توجيه، سيتم عرض null.

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

Signature:

export declare function getRedirectResult(auth: Auth, resolver?: PopupRedirectResolver): Promise<UserCredential | null>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
برنامج التعيين PopupRedirectResolver مثيل PopupRedirectResolver، بشكل اختياري إذا تم تقديمه مسبقًا إلى initializeAuth() أو تم تقديمه من خلال getAuth().

المرتجعات:

Promise<UserCredential | null>

مثال

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
// You can add additional scopes to the provider:
provider.addScope('user_birthday');
// Start a sign in process for an unauthenticated user.
await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
if (result) {
  // This is the signed-in user
  const user = result.user;
  // This gives you a Facebook Access Token.
  const credential = provider.credentialFromResult(auth, result);
  const token = credential.accessToken;
}
// As this API can be used for sign-in, linking and reauthentication,
// check the operationType to determine what triggered this redirect
// operation.
const operationType = result.operationType;

initializeRecaptchaConfig(auth)

لتحميل إعدادات reCAPTCHA في المثيل Auth.

سيؤدي هذا الإجراء إلى تحميل إعدادات reCAPTCHA، ما يشير إلى ما إذا كان يجب بدء مسار التحقّق من reCAPTCHA لكل موفِّر مصادقة، في جلسة المصادقة الحالية.

إذا لم يتم استدعاء firstizeRecaptchaConfig() ، ستبدأ مسار المصادقة دائمًا بدون التحقق من reCAPTCHA. في حال ضبط موفِّر طلب التحقّق من reCAPTCHA، ستعمل حزمة SDK على تحميل إعدادات reCAPTCHA بوضوح، ثم تعيد تشغيل مسارات المصادقة.

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

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

Signature:

export declare function initializeRecaptchaConfig(auth: Auth): Promise<void>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth

المرتجعات:

Promise<void>

مثال

initializeRecaptchaConfig(auth);

يتحقّق مما إذا كان الرابط الوارد يؤدي إلى تسجيل الدخول باستخدام رابط بريد إلكتروني مناسب لـ signInWithEmailLink().

Signature:

export declare function isSignInWithEmailLink(auth: Auth, emailLink: string): boolean;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
emailLink سلسلة تم إرسال الرابط إلى عنوان البريد الإلكتروني للمستخدم.

المرتجعات:

boolean

onAuthStateChanged(auth, nextOrObserver, error, completed)

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

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

Signature:

export declare function onAuthStateChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

المَعلمات

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

المرتجعات:

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

onIdTokenChanged(auth, nextOrObserver, error, completed)

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

ويشمل ذلك أحداث تسجيل الدخول وتسجيل الخروج وإعادة تحميل الرمز المميّز. لن يتم تفعيل هذه الميزة تلقائيًا عند انتهاء صلاحية الرمز المميّز للمستند. استخدِم User.getIdToken() لإعادة تحميل الرمز المميّز لرقم التعريف.

Signature:

export declare function onIdTokenChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

المَعلمات

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

المرتجعات:

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

revokeAccessToken(auth, token)

يؤدي هذا الإجراء إلى إبطال رمز الدخول المحدَّد. لا تتوافق حاليًا إلا مع رموز دخول Apple OAuth.

Signature:

export declare function revokeAccessToken(auth: Auth, token: string): Promise<void>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
رمز مميّز سلسلة رمز الدخول عبر بروتوكول OAuth من Apple.

المرتجعات:

Promise<void>

sendPasswordResetEmail(auth, email, actionCodeSettings)

يرسل رسالة إلكترونية لإعادة ضبط كلمة المرور إلى عنوان البريد الإلكتروني المحدّد. لا تؤدي هذه الطريقة إلى ظهور خطأ في حال عدم توفّر حساب مستخدم بعنوان البريد الإلكتروني المحدّد وتفعيل ميزة [حماية تعداد البريد الإلكتروني](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection).

لإكمال عملية إعادة ضبط كلمة المرور، عليك استدعاء confirmPasswordReset() باستخدام الرمز المقدَّم في الرسالة الإلكترونية التي تم إرسالها إلى المستخدم، بالإضافة إلى كلمة المرور الجديدة التي حدّدها المستخدم.

Signature:

export declare function sendPasswordResetEmail(auth: Auth, email: string, actionCodeSettings?: ActionCodeSettings): Promise<void>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
بريد إلكتروني سلسلة عنوان البريد الإلكتروني للمستخدِم.
actionCodeSettings ActionCodeSettings ActionCodeSettings

المرتجعات:

Promise<void>

مثال

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendPasswordResetEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain code from user.
await confirmPasswordReset('user@example.com', code);

sendSignInLinkToEmail(auth, email, actionCodeSettings)

يتم إرسال رابط بريد إلكتروني لتسجيل الدخول إلى المستخدم باستخدام عنوان البريد الإلكتروني المحدَّد.

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

لإكمال عملية تسجيل الدخول باستخدام رابط الرسالة الإلكترونية، عليك استدعاء signInWithEmailLink() باستخدام عنوان البريد الإلكتروني ورابط البريد الإلكتروني المدرَج في الرسالة الإلكترونية المُرسَلة إلى المستخدم.

Signature:

export declare function sendSignInLinkToEmail(auth: Auth, email: string, actionCodeSettings: ActionCodeSettings): Promise<void>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة
بريد إلكتروني سلسلة عنوان البريد الإلكتروني للمستخدِم.
actionCodeSettings ActionCodeSettings ActionCodeSettings

المرتجعات:

Promise<void>

مثال

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendSignInLinkToEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
  await signInWithEmailLink(auth, 'user@example.com', emailLink);
}

setPersistence(auth, persistence)

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

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

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

Signature:

export declare function setPersistence(auth: Auth, persistence: Persistence): Promise<void>;

المَعلمات

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

المرتجعات:

Promise<void>

Promise التي يتم حلها بعد اكتمال تغيير الثبات

مثال

setPersistence(auth, browserSessionPersistence);

signInAnonymously(auth)

يسجّل الدخول بشكل غير متزامن كمستخدم مجهول.

إذا كان هناك مستخدم مجهول الهوية مسجّل الدخول من قبل، سيتم إرجاع هذا المستخدم، وإلا سيتم إنشاء هوية جديدة للمستخدم مجهول الهوية وعرضها.

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

Signature:

export declare function signInAnonymously(auth: Auth): Promise<UserCredential>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth

المرتجعات:

Promise<UserCredential>

signInWithCredential(auth, credential)

تسجيل الدخول بشكل غير متزامن باستخدام بيانات الاعتماد المقدمة

يمكن استخدام AuthProvider لإنشاء بيانات الاعتماد.

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

Signature:

export declare function signInWithCredential(auth: Auth, credential: AuthCredential): Promise<UserCredential>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
بيانات اعتماد AuthCredential بيانات اعتماد المصادقة.

المرتجعات:

Promise<UserCredential>

signInWithCustomToken(auth, customToken)

يسجِّل الدخول بشكل غير متزامن باستخدام رمز مميّز مخصّص.

تُستخدم الرموز المميزة المخصّصة لدمج تفويض Firebase مع أنظمة المصادقة الحالية، ويجب إنشاؤها بواسطة خلفية مصادقة باستخدام الإجراء createCustomToken في SDK للمشرف .

تتعذّر العملية مع ظهور خطأ إذا كان الرمز المميّز غير صالح أو منتهي الصلاحية أو غير مقبولة من خلال خدمة مصادقة Firebase.

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

Signature:

export declare function signInWithCustomToken(auth: Auth, customToken: string): Promise<UserCredential>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
customToken سلسلة الرمز المميّز المخصّص لتسجيل الدخول باستخدامه

المرتجعات:

Promise<UserCredential>

signInWithEmailAndPassword(auth, email, password)

تسجيل الدخول بشكل غير متزامن باستخدام بريد إلكتروني وكلمة مرور.

فشل ظهور خطأ إذا لم يتطابق عنوان البريد الإلكتروني وكلمة المرور. عند تفعيل [حماية تعداد البريد الإلكتروني](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection)

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

Signature:

export declare function signInWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
بريد إلكتروني سلسلة عنوان البريد الإلكتروني للمستخدم.
كلمة مرور سلسلة كلمة مرور المستخدمين.

المرتجعات:

Promise<UserCredential>

يمكن تسجيل الدخول بشكل غير متزامن باستخدام عنوان بريد إلكتروني ورابط خاص بتسجيل الدخول.

في حال عدم تمرير أي رابط، يتم استنتاج الرابط من عنوان URL الحالي.

لن ينجح مع ظهور خطأ إذا كان عنوان البريد الإلكتروني غير صالح أو إذا انتهت صلاحية رابط كلمة المرور لمرة واحدة (OTP) في رابط البريد الإلكتروني.

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

Signature:

export declare function signInWithEmailLink(auth: Auth, email: string, emailLink?: string): Promise<UserCredential>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
بريد إلكتروني سلسلة عنوان البريد الإلكتروني للمستخدِم.
emailLink سلسلة تم إرسال الرابط إلى عنوان البريد الإلكتروني للمستخدم.

المرتجعات:

Promise<UserCredential>

مثال

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendSignInLinkToEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
  await signInWithEmailLink(auth, 'user@example.com', emailLink);
}

signInWithPhoneNumber(auth, phoneNumber, appVerifier)

يسجِّل الدخول بشكل غير متزامن باستخدام رقم هاتف.

ترسِل هذه الطريقة رمزًا عبر رسالة قصيرة SMS إلى رقم الهاتف المحدَّد وتعرض رسالة ConfirmationResult. بعد أن يقدّم المستخدم الرمز الذي تم إرساله إلى هاتفه، يمكنك الاتصال بـ ConfirmationResult.confirm() مع تضمين الرمز لتسجيل دخول المستخدم.

لمنع إساءة الاستخدام، تتطلّب هذه الطريقة أيضًا ApplicationVerifier. وتتضمّن حزمة تطوير البرامج (SDK) هذه عملية تنفيذ مستندة إلى reCAPTCHA، وهي RecaptchaVerifier. يمكن أن تعمل هذه الدالة على أنظمة أساسية أخرى لا تتوافق مع RecaptchaVerifier (مثل React Native)، ولكنّك تحتاج إلى استخدام تطبيق تابع لجهة خارجية ApplicationVerifier.

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

Signature:

export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
phoneNumber سلسلة رقم هاتف المستخدم بالتنسيق E.164 (على سبيل المثال: +16505550101).
appVerifier ApplicationVerifier ApplicationVerifier

المرتجعات:

Promise<ConfirmationResult>

مثال

// 'recaptcha-container' is the ID of an element in the DOM.
const applicationVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container');
const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier);
// Obtain a verificationCode from the user.
const credential = await confirmationResult.confirm(verificationCode);

signInWithPopup(auth, provider, resolver)

مصادقة عميل Firebase باستخدام إجراءات مصادقة OAuth مستندة إلى نافذة منبثقة.

في حال نجحت العملية، يتم عرض المستخدم الذي تم تسجيل الدخول إليه مع بيانات اعتماد الموفِّر. في حال تعذَّر تسجيل الدخول، سيتم عرض عنصر خطأ يحتوي على معلومات إضافية حول الخطأ.

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

Signature:

export declare function signInWithPopup(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
provider AuthProvider مقدم الخدمة المراد المصادقة عليه. يجب أن يكون موفِّر الهوية OAuthProvider. سيعرض موفِّرو الخدمات الذين لا يستخدمون OAuth، مثل EmailAuthProvider، خطأ.
برنامج التعيين PopupRedirectResolver مثيل PopupRedirectResolver، بشكل اختياري إذا تم تقديمه مسبقًا إلى initializeAuth() أو تم تقديمه من خلال getAuth().

المرتجعات:

Promise<UserCredential>

مثال

// Sign in using a popup.
const provider = new FacebookAuthProvider();
const result = await signInWithPopup(auth, provider);

// The signed-in user info.
const user = result.user;
// This gives you a Facebook Access Token.
const credential = provider.credentialFromResult(auth, result);
const token = credential.accessToken;

signInWithRedirect(auth, provider, resolver)

مصادقة عميل Firebase باستخدام عملية إعادة توجيه بملء الصفحة.

لمعالجة النتائج والأخطاء لهذه العملية، راجِع getRedirectResult(). اتّبِع أفضل الممارسات عند استخدام signInWithRedirect().

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

Signature:

export declare function signInWithRedirect(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
provider AuthProvider مقدم الخدمة المراد المصادقة عليه. يجب أن يكون موفِّر الهوية OAuthProvider. سيعرض موفِّرو الخدمات الذين لا يستخدمون OAuth، مثل EmailAuthProvider، خطأ.
برنامج التعيين PopupRedirectResolver مثيل PopupRedirectResolver، بشكل اختياري إذا تم تقديمه مسبقًا إلى initializeAuth() أو تم تقديمه من خلال getAuth().

المرتجعات:

وعد<أبدًا>

مثال

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
// You can add additional scopes to the provider:
provider.addScope('user_birthday');
// Start a sign in process for an unauthenticated user.
await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
if (result) {
  // This is the signed-in user
  const user = result.user;
  // This gives you a Facebook Access Token.
  const credential = provider.credentialFromResult(auth, result);
  const token = credential.accessToken;
}
// As this API can be used for sign-in, linking and reauthentication,
// check the operationType to determine what triggered this redirect
// operation.
const operationType = result.operationType;

signOut(auth)

يسجِّل خروج المستخدم الحالي.

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

Signature:

export declare function signOut(auth: Auth): Promise<void>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth

المرتجعات:

Promise<void>

updateCurrentUser(auth, user)

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

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

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

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

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

Signature:

export declare function updateCurrentUser(auth: Auth, user: User | null): Promise<void>;

المَعلمات

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

المرتجعات:

Promise<void>

useDeviceLanguage(auth)

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

Signature:

export declare function useDeviceLanguage(auth: Auth): void;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth

المرتجعات:

void

validatePassword(auth, password)

يتحقق من صحة كلمة المرور مقابل سياسة كلمة المرور التي تم إعدادها للمشروع أو المستأجر.

إذا لم يتم ضبط رقم تعريف مستأجر على مثيل Auth، ستستخدم هذه الطريقة سياسة كلمة المرور التي تم ضبطها للمشروع. وبخلاف ذلك، ستستخدم هذه الطريقة السياسة التي تم ضبطها للمستأجر. وفي حال عدم ضبط سياسة كلمة المرور، سيتم استخدام السياسة التلقائية التي تم ضبطها لجميع المشاريع.

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

Signature:

export declare function validatePassword(auth: Auth, password: string): Promise<PasswordValidationStatus>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
كلمة مرور سلسلة كلمة المرور المطلوب التحقق منها.

المرتجعات:

Promise<PasswordValidationStatus>

مثال

validatePassword(auth, 'some-password');

verifyPasswordResetCode(auth, code)

يتحقق من رمز إعادة ضبط كلمة المرور الذي تم إرساله إلى المستخدم عبر البريد الإلكتروني أو أي آلية أخرى خارج النطاق.

Signature:

export declare function verifyPasswordResetCode(auth: Auth, code: string): Promise<string>;

المَعلمات

المَعلمة النوع الوصف
أخفقت المصادقة المصادقة مثيل Auth
رمز سلسلة رمز التحقّق الذي يتم إرساله إلى المستخدم.

المرتجعات:

وعد<string>

عنوان البريد الإلكتروني للمستخدم إذا كان صالحًا.

ParseActionCodeURL(link)

تحلّل سلسلة رابط إجراء البريد الإلكتروني وتعرض ActionCodeURL إذا كان الرابط صالحًا أو يتم عرض قيمة فارغة.

Signature:

export declare function parseActionCodeURL(link: string): ActionCodeURL | null;

المَعلمات

المَعلمة النوع الوصف
رابط سلسلة

المرتجعات:

ActionCodeURL | فارغ

الدالة(المستخدم، ...)

deleteUser(user)

حذف المستخدم وتسجيل خروجه

Signature:

export declare function deleteUser(user: User): Promise<void>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.

المرتجعات:

Promise<void>

getIdToken(user, forceRefresh)

لعرض رمز JSON المميّز للويب (JWT) المستخدَم لتحديد هوية المستخدم في خدمة Firebase.

عرض الرمز المميّز الحالي إذا لم تنتهِ صلاحيته أو إذا كانت لن تنتهي صلاحيته خلال الدقائق الخمس التالية. بخلاف ذلك، سيتم إعادة تحميل الرمز المميّز وعرض رمز جديد.

Signature:

export declare function getIdToken(user: User, forceRefresh?: boolean): Promise<string>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
forceRefresh boolean فرض إعادة التحميل بغض النظر عن انتهاء صلاحية الرمز المميّز

المرتجعات:

وعد<string>

getIdTokenResult(user, forceRefresh)

تعرض رمز JSON المميّز للويب (JWT) لإلغاء التسلسل والمستخدَم لتحديد هوية المستخدم في إحدى خدمات Firebase.

عرض الرمز المميّز الحالي إذا لم تنتهِ صلاحيته أو إذا كانت لن تنتهي صلاحيته خلال الدقائق الخمس التالية. بخلاف ذلك، سيتم إعادة تحميل الرمز المميّز وعرض رمز جديد.

Signature:

export declare function getIdTokenResult(user: User, forceRefresh?: boolean): Promise<IdTokenResult>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
forceRefresh boolean فرض إعادة التحميل بغض النظر عن انتهاء صلاحية الرمز المميّز

المرتجعات:

Promise<IdTokenResult>

linkWithCredential(user, credential)

يؤدي هذا الإجراء إلى ربط حساب المستخدم ببيانات الاعتماد المقدَّمة.

يمكن استخدام AuthProvider لإنشاء بيانات الاعتماد.

Signature:

export declare function linkWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
بيانات اعتماد AuthCredential بيانات اعتماد المصادقة.

المرتجعات:

Promise<UserCredential>

linkWithPhoneNumber(user, phoneNumber, appVerifier)

يربط حساب المستخدم برقم الهاتف المحدّد.

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

Signature:

export declare function linkWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
phoneNumber سلسلة رقم هاتف المستخدم بالتنسيق E.164 (على سبيل المثال: +16505550101).
appVerifier ApplicationVerifier ApplicationVerifier

المرتجعات:

Promise<ConfirmationResult>

linkWithPopup(user, provider, resolver)

لربط المقدِّم الذي تمت المصادقة عليه بحساب المستخدم باستخدام مسار OAuth مستند إلى نافذة منبثقة.

إذا كان الربط ناجحًا، ستحتوي النتيجة المعروضة على بيانات اعتماد المستخدم والموفِّر.

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

Signature:

export declare function linkWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
provider AuthProvider مقدم الخدمة المراد المصادقة عليه. يجب أن يكون موفِّر الهوية OAuthProvider. سيعرض موفِّرو الخدمات الذين لا يستخدمون OAuth، مثل EmailAuthProvider، خطأ.
برنامج التعيين PopupRedirectResolver مثيل PopupRedirectResolver، بشكل اختياري إذا تم تقديمه مسبقًا إلى initializeAuth() أو تم تقديمه من خلال getAuth().

المرتجعات:

Promise<UserCredential>

مثال

// Sign in using some other provider.
const result = await signInWithEmailAndPassword(auth, email, password);
// Link using a popup.
const provider = new FacebookAuthProvider();
await linkWithPopup(result.user, provider);

linkWithRedirect(user, provider, resolver)

لربط OAuthProvider بحساب المستخدم باستخدام تدفق إعادة توجيه الصفحة الكاملة.

لمعالجة النتائج والأخطاء لهذه العملية، راجِع getRedirectResult(). اتّبِع أفضل الممارسات عند استخدام linkWithRedirect().

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

Signature:

export declare function linkWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
provider AuthProvider مقدم الخدمة المراد المصادقة عليه. يجب أن يكون موفِّر الهوية OAuthProvider. سيعرض موفِّرو الخدمات الذين لا يستخدمون OAuth، مثل EmailAuthProvider، خطأ.
برنامج التعيين PopupRedirectResolver مثيل PopupRedirectResolver، بشكل اختياري إذا تم تقديمه مسبقًا إلى initializeAuth() أو تم تقديمه من خلال getAuth().

المرتجعات:

وعد<أبدًا>

مثال

// Sign in using some other provider.
const result = await signInWithEmailAndPassword(auth, email, password);
// Link using a redirect.
const provider = new FacebookAuthProvider();
await linkWithRedirect(result.user, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);

multiFactor(user)

MultiFactorUser المقابل للمستخدم.

يستخدم هذا للوصول إلى جميع الخصائص متعددة العوامل والعمليات المتعلقة بالمستخدم.

Signature:

export declare function multiFactor(user: User): MultiFactorUser;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.

المرتجعات:

MultiFactorUser

reauthenticateWithCredential(user, credential)

تتم إعادة مصادقة مستخدم باستخدام بيانات اعتماد جديدة.

استخدِم هذا الخيار قبل العمليات مثل updatePassword() التي تتطلب رموزًا مميّزة من محاولات تسجيل الدخول الأخيرة. يمكن استخدام هذه الطريقة لإصلاح الخطأ "CREDENTIAL_TOO_OLD_LOGIN_AGAIN" أو خطأ TOKEN_EXPIRED.

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

Signature:

export declare function reauthenticateWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
بيانات اعتماد AuthCredential بيانات اعتماد المصادقة.

المرتجعات:

Promise<UserCredential>

reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier)

تتم إعادة مصادقة المستخدم باستخدام بيانات اعتماد هاتف جديدة.

استخدِم هذا الخيار قبل العمليات مثل updatePassword() التي تتطلب رموزًا مميّزة من محاولات تسجيل الدخول الأخيرة.

لا تعمل هذه الطريقة في بيئة Node.js أو على أي مثيلات مستخدم تم تسجيل الدخول إليها من خلال Auth تم إنشاؤها باستخدام FirebaseServerApp.

Signature:

export declare function reauthenticateWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
phoneNumber سلسلة رقم هاتف المستخدم بالتنسيق E.164 (على سبيل المثال: +16505550101).
appVerifier ApplicationVerifier ApplicationVerifier

المرتجعات:

Promise<ConfirmationResult>

reauthenticateWithPopup(user, provider, resolver)

تتم إعادة مصادقة المستخدم الحالي باستخدام OAuthProvider المحدد باستخدام تدفق OAuth يستند إلى نافذة منبثقة.

إذا نجحت إعادة المصادقة، فستحتوي النتيجة المعروضة على بيانات اعتماد المستخدم والموفر.

لا تعمل هذه الطريقة في بيئة Node.js أو على أي مثيلات مستخدم تم تسجيل الدخول إليها من خلال Auth تم إنشاؤها باستخدام FirebaseServerApp.

Signature:

export declare function reauthenticateWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
provider AuthProvider مقدم الخدمة المراد المصادقة عليه. يجب أن يكون موفِّر الهوية OAuthProvider. سيعرض موفِّرو الخدمات الذين لا يستخدمون OAuth، مثل EmailAuthProvider، خطأ.
برنامج التعيين PopupRedirectResolver مثيل PopupRedirectResolver، بشكل اختياري إذا تم تقديمه مسبقًا إلى initializeAuth() أو تم تقديمه من خلال getAuth().

المرتجعات:

Promise<UserCredential>

مثال

// Sign in using a popup.
const provider = new FacebookAuthProvider();
const result = await signInWithPopup(auth, provider);
// Reauthenticate using a popup.
await reauthenticateWithPopup(result.user, provider);

reauthenticateWithRedirect(user, provider, resolver)

تتم إعادة مصادقة المستخدم الحالي باستخدام OAuthProvider المحدَّد باستخدام تدفق إعادة توجيه صفحة كاملة.

لمعالجة النتائج والأخطاء لهذه العملية، راجِع getRedirectResult(). اتّبِع أفضل الممارسات عند استخدام reauthenticateWithRedirect().

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

Signature:

export declare function reauthenticateWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
provider AuthProvider مقدم الخدمة المراد المصادقة عليه. يجب أن يكون موفِّر الهوية OAuthProvider. سيعرض موفِّرو الخدمات الذين لا يستخدمون OAuth، مثل EmailAuthProvider، خطأ.
برنامج التعيين PopupRedirectResolver مثيل PopupRedirectResolver، بشكل اختياري إذا تم تقديمه مسبقًا إلى initializeAuth() أو تم تقديمه من خلال getAuth().

المرتجعات:

وعد<أبدًا>

مثال

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
const result = await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
// Reauthenticate using a redirect.
await reauthenticateWithRedirect(result.user, provider);
// This will again trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);

إعادة تحميل(المستخدم)

إعادة تحميل بيانات حساب المستخدم في حال تسجيل الدخول

Signature:

export declare function reload(user: User): Promise<void>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.

المرتجعات:

Promise<void>

sendEmailVerification(user, actionCodeSettings)

إرسال رسالة تحقُّق إلى مستخدم

وتكتمل عملية التحقّق من خلال استدعاء الإجراء applyActionCode().

Signature:

export declare function sendEmailVerification(user: User, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
actionCodeSettings ActionCodeSettings | قيمة فارغة ActionCodeSettings

المرتجعات:

Promise<void>

مثال

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendEmailVerification(user, actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);

لإلغاء ربط مقدّم خدمة بحساب مستخدم.

Signature:

export declare function unlink(user: User, providerId: string): Promise<User>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
providerId سلسلة مزوّد الخدمة الذي سيتم إلغاء ربطه.

المرتجعات:

تعهد بأن<المستخدم>

updateEmail(user, newEmail)

تعدِّل عنوان البريد الإلكتروني للمستخدِم.

سيتم إرسال رسالة إلكترونية إلى عنوان البريد الإلكتروني الأصلي (إذا كان قد تم ضبطه) للسماح بإبطال تغيير عنوان البريد الإلكتروني، وذلك لحمايته من الاستيلاء على الحساب.

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

Signature:

export declare function updateEmail(user: User, newEmail: string): Promise<void>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
newEmail سلسلة عنوان البريد الإلكتروني الجديد.يظهر الخطأ "auth/operation-not-allowed" عند تفعيل [حماية تعداد البريد الإلكتروني](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection). مهملة - استخدِم verifyBeforeUpdateEmail() بدلاً من ذلك.

المرتجعات:

Promise<void>

updatePassword(user, newPassword)

لتعديل كلمة مرور المستخدم.

Signature:

export declare function updatePassword(user: User, newPassword: string): Promise<void>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
newPassword سلسلة كلمة المرور الجديدة

المرتجعات:

Promise<void>

updatePhoneNumber(user, credential)

تعدِّل رقم هاتف المستخدم.

لا تعمل هذه الطريقة في بيئة Node.js أو على أي مثيلات مستخدم تم تسجيل الدخول إليها من خلال Auth تم إنشاؤها باستخدام FirebaseServerApp.

Signature:

export declare function updatePhoneNumber(user: User, credential: PhoneAuthCredential): Promise<void>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
بيانات اعتماد PhoneAuthCredential بيانات اعتماد تعمل على مصادقة رقم الهاتف الجديد.

المرتجعات:

Promise<void>

مثال

// 'recaptcha-container' is the ID of an element in the DOM.
const applicationVerifier = new RecaptchaVerifier('recaptcha-container');
const provider = new PhoneAuthProvider(auth);
const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier);
// Obtain the verificationCode from the user.
const phoneCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
await updatePhoneNumber(user, phoneCredential);

updateProfile(user, { displayName, photoURL: photoUrl })

لتعديل بيانات الملف الشخصي لمستخدم.

Signature:

export declare function updateProfile(user: User, { displayName, photoURL: photoUrl }: {
    displayName?: string | null;
    photoURL?: string | null;
}): Promise<void>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
{ DisplayName, photoURL: photoUrl } { displayName?: string | null; photoURL?: string | null; }

المرتجعات:

Promise<void>

verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings)

لإرسال رسالة تحقُّق إلى عنوان بريد إلكتروني جديد.

سيتم تعديل عنوان البريد الإلكتروني للمستخدم إلى البريد الإلكتروني الجديد بعد إثبات ملكيته.

إذا كان لديك معالج مخصّص لإجراءات البريد الإلكتروني، يمكنك إكمال عملية إثبات الهوية من خلال استدعاء الإجراء applyActionCode().

Signature:

export declare function verifyBeforeUpdateEmail(user: User, newEmail: string, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;

المَعلمات

المَعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
newEmail سلسلة عنوان البريد الإلكتروني الجديد الذي سيتم إثبات ملكيته قبل التحديث.
actionCodeSettings ActionCodeSettings | قيمة فارغة ActionCodeSettings

المرتجعات:

Promise<void>

مثال

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await verifyBeforeUpdateEmail(user, 'newemail@example.com', actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);

الدالة(userCredential, ...)

getAdditionalUserInfo(userCredential)

استخراج AdditionalUserInfo الخاصة بالموفِّر لبيانات الاعتماد المحددة.

Signature:

export declare function getAdditionalUserInfo(userCredential: UserCredential): AdditionalUserInfo | null;

المَعلمات

المَعلمة النوع الوصف
userCredential UserCredential تمثّل هذه السمة بيانات اعتماد المستخدم.

المرتجعات:

AdditionalUserInfo | قيمة خالية

ActionCodeOperation

تعداد لأنواع إجراءات البريد الإلكتروني المحتملة.

Signature:

ActionCodeOperation: {
    readonly EMAIL_SIGNIN: "EMAIL_SIGNIN";
    readonly PASSWORD_RESET: "PASSWORD_RESET";
    readonly RECOVER_EMAIL: "RECOVER_EMAIL";
    readonly REVERT_SECOND_FACTOR_ADDITION: "REVERT_SECOND_FACTOR_ADDITION";
    readonly VERIFY_AND_CHANGE_EMAIL: "VERIFY_AND_CHANGE_EMAIL";
    readonly VERIFY_EMAIL: "VERIFY_EMAIL";
}

AuthErrorCodes

خريطة لرموز أخطاء Auth المحتمَلة، وذلك لتسهيل المقارنة مع الأخطاء الناتجة عن حزمة تطوير البرامج (SDK)

لاحظ أنه لا يمكنك هزّة المفاتيح الفردية في الخريطة، لذا قد يؤدي استخدام الخريطة إلى زيادة حجم الحزمة بشكل كبير.

Signature:

AUTH_ERROR_CODES_MAP_DO_NOT_USE_INTERNALLY: {
    readonly ADMIN_ONLY_OPERATION: "auth/admin-restricted-operation";
    readonly ARGUMENT_ERROR: "auth/argument-error";
    readonly APP_NOT_AUTHORIZED: "auth/app-not-authorized";
    readonly APP_NOT_INSTALLED: "auth/app-not-installed";
    readonly CAPTCHA_CHECK_FAILED: "auth/captcha-check-failed";
    readonly CODE_EXPIRED: "auth/code-expired";
    readonly CORDOVA_NOT_READY: "auth/cordova-not-ready";
    readonly CORS_UNSUPPORTED: "auth/cors-unsupported";
    readonly CREDENTIAL_ALREADY_IN_USE: "auth/credential-already-in-use";
    readonly CREDENTIAL_MISMATCH: "auth/custom-token-mismatch";
    readonly CREDENTIAL_TOO_OLD_LOGIN_AGAIN: "auth/requires-recent-login";
    readonly DEPENDENT_SDK_INIT_BEFORE_AUTH: "auth/dependent-sdk-initialized-before-auth";
    readonly DYNAMIC_LINK_NOT_ACTIVATED: "auth/dynamic-link-not-activated";
    readonly EMAIL_CHANGE_NEEDS_VERIFICATION: "auth/email-change-needs-verification";
    readonly EMAIL_EXISTS: "auth/email-already-in-use";
    readonly EMULATOR_CONFIG_FAILED: "auth/emulator-config-failed";
    readonly EXPIRED_OOB_CODE: "auth/expired-action-code";
    readonly EXPIRED_POPUP_REQUEST: "auth/cancelled-popup-request";
    readonly INTERNAL_ERROR: "auth/internal-error";
    readonly INVALID_API_KEY: "auth/invalid-api-key";
    readonly INVALID_APP_CREDENTIAL: "auth/invalid-app-credential";
    readonly INVALID_APP_ID: "auth/invalid-app-id";
    readonly INVALID_AUTH: "auth/invalid-user-token";
    readonly INVALID_AUTH_EVENT: "auth/invalid-auth-event";
    readonly INVALID_CERT_HASH: "auth/invalid-cert-hash";
    readonly INVALID_CODE: "auth/invalid-verification-code";
    readonly INVALID_CONTINUE_URI: "auth/invalid-continue-uri";
    readonly INVALID_CORDOVA_CONFIGURATION: "auth/invalid-cordova-configuration";
    readonly INVALID_CUSTOM_TOKEN: "auth/invalid-custom-token";
    readonly INVALID_DYNAMIC_LINK_DOMAIN: "auth/invalid-dynamic-link-domain";
    readonly INVALID_EMAIL: "auth/invalid-email";
    readonly INVALID_EMULATOR_SCHEME: "auth/invalid-emulator-scheme";
    readonly INVALID_IDP_RESPONSE: "auth/invalid-credential";
    readonly INVALID_LOGIN_CREDENTIALS: "auth/invalid-credential";
    readonly INVALID_MESSAGE_PAYLOAD: "auth/invalid-message-payload";
    readonly INVALID_MFA_SESSION: "auth/invalid-multi-factor-session";
    readonly INVALID_OAUTH_CLIENT_ID: "auth/invalid-oauth-client-id";
    readonly INVALID_OAUTH_PROVIDER: "auth/invalid-oauth-provider";
    readonly INVALID_OOB_CODE: "auth/invalid-action-code";
    readonly INVALID_ORIGIN: "auth/unauthorized-domain";
    readonly INVALID_PASSWORD: "auth/wrong-password";
    readonly INVALID_PERSISTENCE: "auth/invalid-persistence-type";
    readonly INVALID_PHONE_NUMBER: "auth/invalid-phone-number";
    readonly INVALID_PROVIDER_ID: "auth/invalid-provider-id";
    readonly INVALID_RECIPIENT_EMAIL: "auth/invalid-recipient-email";
    readonly INVALID_SENDER: "auth/invalid-sender";
    readonly INVALID_SESSION_INFO: "auth/invalid-verification-id";
    readonly INVALID_TENANT_ID: "auth/invalid-tenant-id";
    readonly MFA_INFO_NOT_FOUND: "auth/multi-factor-info-not-found";
    readonly MFA_REQUIRED: "auth/multi-factor-auth-required";
    readonly MISSING_ANDROID_PACKAGE_NAME: "auth/missing-android-pkg-name";
    readonly MISSING_APP_CREDENTIAL: "auth/missing-app-credential";
    readonly MISSING_AUTH_DOMAIN: "auth/auth-domain-config-required";
    readonly MISSING_CODE: "auth/missing-verification-code";
    readonly MISSING_CONTINUE_URI: "auth/missing-continue-uri";
    readonly MISSING_IFRAME_START: "auth/missing-iframe-start";
    readonly MISSING_IOS_BUNDLE_ID: "auth/missing-ios-bundle-id";
    readonly MISSING_OR_INVALID_NONCE: "auth/missing-or-invalid-nonce";
    readonly MISSING_MFA_INFO: "auth/missing-multi-factor-info";
    readonly MISSING_MFA_SESSION: "auth/missing-multi-factor-session";
    readonly MISSING_PHONE_NUMBER: "auth/missing-phone-number";
    readonly MISSING_SESSION_INFO: "auth/missing-verification-id";
    readonly MODULE_DESTROYED: "auth/app-deleted";
    readonly NEED_CONFIRMATION: "auth/account-exists-with-different-credential";
    readonly NETWORK_REQUEST_FAILED: "auth/network-request-failed";
    readonly NULL_USER: "auth/null-user";
    readonly NO_AUTH_EVENT: "auth/no-auth-event";
    readonly NO_SUCH_PROVIDER: "auth/no-such-provider";
    readonly OPERATION_NOT_ALLOWED: "auth/operation-not-allowed";
    readonly OPERATION_NOT_SUPPORTED: "auth/operation-not-supported-in-this-environment";
    readonly POPUP_BLOCKED: "auth/popup-blocked";
    readonly POPUP_CLOSED_BY_USER: "auth/popup-closed-by-user";
    readonly PROVIDER_ALREADY_LINKED: "auth/provider-already-linked";
    readonly QUOTA_EXCEEDED: "auth/quota-exceeded";
    readonly REDIRECT_CANCELLED_BY_USER: "auth/redirect-cancelled-by-user";
    readonly REDIRECT_OPERATION_PENDING: "auth/redirect-operation-pending";
    readonly REJECTED_CREDENTIAL: "auth/rejected-credential";
    readonly SECOND_FACTOR_ALREADY_ENROLLED: "auth/second-factor-already-in-use";
    readonly SECOND_FACTOR_LIMIT_EXCEEDED: "auth/maximum-second-factor-count-exceeded";
    readonly TENANT_ID_MISMATCH: "auth/tenant-id-mismatch";
    readonly TIMEOUT: "auth/timeout";
    readonly TOKEN_EXPIRED: "auth/user-token-expired";
    readonly TOO_MANY_ATTEMPTS_TRY_LATER: "auth/too-many-requests";
    readonly UNAUTHORIZED_DOMAIN: "auth/unauthorized-continue-uri";
    readonly UNSUPPORTED_FIRST_FACTOR: "auth/unsupported-first-factor";
    readonly UNSUPPORTED_PERSISTENCE: "auth/unsupported-persistence-type";
    readonly UNSUPPORTED_TENANT_OPERATION: "auth/unsupported-tenant-operation";
    readonly UNVERIFIED_EMAIL: "auth/unverified-email";
    readonly USER_CANCELLED: "auth/user-cancelled";
    readonly USER_DELETED: "auth/user-not-found";
    readonly USER_DISABLED: "auth/user-disabled";
    readonly USER_MISMATCH: "auth/user-mismatch";
    readonly USER_SIGNED_OUT: "auth/user-signed-out";
    readonly WEAK_PASSWORD: "auth/weak-password";
    readonly WEB_STORAGE_UNSUPPORTED: "auth/web-storage-unsupported";
    readonly ALREADY_INITIALIZED: "auth/already-initialized";
    readonly RECAPTCHA_NOT_ENABLED: "auth/recaptcha-not-enabled";
    readonly MISSING_RECAPTCHA_TOKEN: "auth/missing-recaptcha-token";
    readonly INVALID_RECAPTCHA_TOKEN: "auth/invalid-recaptcha-token";
    readonly INVALID_RECAPTCHA_ACTION: "auth/invalid-recaptcha-action";
    readonly MISSING_CLIENT_TYPE: "auth/missing-client-type";
    readonly MISSING_RECAPTCHA_VERSION: "auth/missing-recaptcha-version";
    readonly INVALID_RECAPTCHA_VERSION: "auth/invalid-recaptcha-version";
    readonly INVALID_REQ_TYPE: "auth/invalid-req-type";
}

browserLocalPersistence

تنفيذ الثبات من النوع LOCAL باستخدام localStorage لمساحة التخزين الأساسية.

Signature:

browserLocalPersistence: Persistence

browserPopupRedirectResolver

تنفيذ PopupRedirectResolver المناسب للتطبيقات التي تستند إلى المتصفح.

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

Signature:

browserPopupRedirectResolver: PopupRedirectResolver

browserSessionPersistence

تنفيذ الثبات لـ SESSION باستخدام sessionStorage لمساحة التخزين الأساسية.

Signature:

browserSessionPersistence: Persistence

cordovaPopupRedirectResolver

تطبيق PopupRedirectResolver مناسب للتطبيقات التي يعتمد على كوردوفا.

Signature:

cordovaPopupRedirectResolver: PopupRedirectResolver

debugErrorMap

خريطة أخطاء مطوَّلة مع أوصاف تفصيلية لمعظم رموز الأخطاء.

عرض المناقشة على AuthErrorMap

Signature:

debugErrorMap: AuthErrorMap

FactorId

يشير ذلك المصطلح إلى تعداد العوامل التي يمكن استخدامها للمصادقة المتعدّدة العوامل.

Signature:

FactorId: {
    readonly PHONE: "phone";
    readonly TOTP: "totp";
}

indexedDBLocalPersistence

تنفيذ الثبات من النوع LOCAL باستخدام indexedDB لمساحة التخزين الأساسية.

Signature:

indexedDBLocalPersistence: Persistence

inMemoryPersistence

تنفيذ نوع الثبات من النوع 'NONE'

Signature:

inMemoryPersistence: Persistence

OperationType

تعداد أنواع العمليات المتوافقة.

Signature:

OperationType: {
    readonly LINK: "link";
    readonly REAUTHENTICATE: "reauthenticate";
    readonly SIGN_IN: "signIn";
}

prodErrorMap

خريطة خطأ مبسَّطة مع إزالة جميع رسائل الأخطاء المطوَّلة.

عرض المناقشة على AuthErrorMap

Signature:

prodErrorMap: AuthErrorMap

ProviderId

تعداد المزوّدين المتوافقين.

Signature:

ProviderId: {
    readonly FACEBOOK: "facebook.com";
    readonly GITHUB: "github.com";
    readonly GOOGLE: "google.com";
    readonly PASSWORD: "password";
    readonly PHONE: "phone";
    readonly TWITTER: "twitter.com";
}

SignInMethod

تعداد طُرق تسجيل الدخول المتوافقة

Signature:

SignInMethod: {
    readonly EMAIL_LINK: "emailLink";
    readonly EMAIL_PASSWORD: "password";
    readonly FACEBOOK: "facebook.com";
    readonly GITHUB: "github.com";
    readonly GOOGLE: "google.com";
    readonly PHONE: "phone";
    readonly TWITTER: "twitter.com";
}

CustomParameters

ربط مَعلمات OAuth المخصَّصة.

Signature:

export declare type CustomParameters = Record<string, string>;

NextOrObserver

اكتب تعريفًا لمعاودة الاتصال بالحدث.

Signature:

export declare type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;

PhoneInfoOptions

المعلومات المطلوبة لإثبات ملكية رقم هاتف.

تعتمِد المعلومات المطلوبة على ما إذا كنت تسجِّل الدخول بعامل واحد أو التسجيل المتعدّد العوامل أو تسجيل الدخول المتعدّد العوامل.

Signature:

export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;

UserProfile

الملف الشخصي للمستخدم المستخدَم في AdditionalUserInfo.

Signature:

export declare type UserProfile = Record<string, unknown>;