auth package

مصادقة Firebase

الدوال

دالة الوصف
الدالّة(app, ...)
getAuth(app) تعرض النسخة الافتراضية للمصادقة المرتبطة بـ FirebaseApp المقدَّم. في حال عدم توفّر مثيل، يتم إعداد مثيل مصادقة باستخدام التبعيات التلقائية الخاصة بالنظام الأساسي.
InitializeAuth(app, deps) يبدأ مثيل المصادقة مع التحكّم بدقة في التبعيات.
الدالّة(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) الحصول على قائمة بالطرق المحتملة لتسجيل الدخول لعنوان البريد الإلكتروني المحدّد. تعرض هذه الطريقة قائمة فارغة عند تفعيل حماية تعداد البريد الإلكتروني، بغض النظر عن عدد طرق المصادقة المتاحة للبريد الإلكتروني المحدّد.
getMultiFactorFixr(auth, error) توفر MultiFactorأداة حل متعدد العوامل مناسبة لإكمال تدفق متعدد العوامل.
getRedirectResult(auth, authorr) عرض UserCredential من مسار تسجيل الدخول القائم على إعادة التوجيه.
InitializeRecaptchaConfig(auth) يتم تحميل إعدادات reCAPTCHA في مثيل Auth.
isSignInWithEmailLink(auth, emailLink) يتحقّق مما إذا كان الرابط الوارد عبارة عن عملية تسجيل دخول باستخدام رابط بريد إلكتروني مناسب لـ signInWithEmailLink().
onAuthStateChanged(auth, nextOrObserver, error, completed) تتم إضافة مراقب للاطّلاع على التغييرات التي تطرأ على حالة تسجيل دخول المستخدم.
onIdTokenChanged(auth, nextOrObserver, error, completed) تتم إضافة مراقب عن التغييرات التي يتم إجراؤها على الرمز المميّز لرقم تعريف المستخدم الذي سجّل الدخول.
revokeAccessToken(المصادقة، الرمز المميّز) إبطال رمز الدخول المحدّد. لا يتوافق هذا الإعداد حاليًا إلا مع رموز الدخول عبر بروتوكول OAuth من Apple.
sendPasswordResetEmail(auth, email, actionCodeSettings) ترسل رسالة إلكترونية لإعادة ضبط كلمة المرور إلى عنوان البريد الإلكتروني المحدّد. لا تؤدي هذه الطريقة إلى حدوث خطأ عندما لا يكون هناك حساب مستخدم بعنوان البريد الإلكتروني المحدّد مع تفعيل حماية تعداد البريد الإلكتروني.
sendSignInLinkToEmail(auth, email, actionCodeSettings) يتم إرسال رابط عنوان البريد الإلكتروني المخصّص لتسجيل الدخول إلى المستخدم باستخدام عنوان البريد الإلكتروني المحدّد.
setPersistence(auth, existingence) تغيّر نوع التثبيت على مثيل المصادقة لجلسة Auth المحفوظة حاليًا، ويطبّق هذا النوع من المثابرة على طلبات تسجيل الدخول المستقبلية، بما في ذلك تسجيل الدخول باستخدام طلبات إعادة التوجيه.
signInAnonymously(auth) تسجيل الدخول بشكل غير متزامن كمستخدم مجهول.
signInWithCredential(auth, Credential) تسجيل الدخول بشكل غير متزامن باستخدام بيانات الاعتماد المحددة
signInWithCustomToken(auth, customToken) يتم تسجيل الدخول بشكل غير متزامن باستخدام رمز مميّز مخصَّص.
signInWithEmailAndPassword(auth, email, password) تسجيل الدخول بشكل غير متزامن باستخدام بريد إلكتروني وكلمة مرور.
signInWithEmailLink(auth, email, emailLink) يتم تسجيل الدخول بشكل غير متزامن باستخدام رسالة بريد إلكتروني ورابط لبريد إلكتروني لتسجيل الدخول.
signInWithPhoneNumber(auth, phoneNumber, appVerifier) يتم تسجيل الدخول بشكل غير متزامن باستخدام رقم هاتف.
signInWithPopup(auth, provider, واضحer) لكي تتم مصادقة برنامج Firebase باستخدام مسار مصادقة OAuth المستند إلى نافذة منبثقة.
signInWithRedirect(auth, provider, واضحr) يجب مصادقة برنامج Firebase باستخدام عملية إعادة توجيه بملء الصفحة.
signOut(auth) خروج المستخدم الحالي
updateCurrentUser(auth, user) تضبط هذه السياسة المستخدم المقدَّم بشكلٍ غير متزامن على Auth.currentUser على النسخة الافتراضية من Auth.
useDeviceLanguage(auth) لضبط اللغة الحالية على تفضيل الجهاز/المتصفح التلقائي.
VerifyatePassword(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, returnr) يربط موفِّر الخدمة الذي تمت مصادقته بحساب المستخدم باستخدام مسار OAuth المستند إلى نافذة منبثقة.
linkWithRedirect(user, provider, reportr) يربط OAuthProvider بحساب المستخدم باستخدام تدفق إعادة التوجيه بملء الصفحة.
multiFactor(user) تمثّل هذه السمة MultiFactorUser المقابل للمستخدم.
reauthenticateWithCredential(user, Credential) تتم إعادة مصادقة مستخدم باستخدام بيانات اعتماد جديدة.
reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier) تتم إعادة مصادقة مستخدم باستخدام بيانات اعتماد جديدة للهاتف.
reauthenticateWithPopup(user, provider, التعيين) لإعادة مصادقة المستخدم الحالي مع OAuthProvider المحدَّد باستخدام تدفق OAuth المستند إلى نافذة منبثقة.
reauthenticateWithRedirect(user, provider, goalr) لإعادة مصادقة المستخدم الحالي مع OAuthProvider المحدَّد باستخدام مسار إعادة التوجيه بملء الصفحة
reload(user) إعادة تحميل بيانات حساب المستخدم في حال تسجيل الدخول.
sendEmailVerify(user, actionCodeSettings) تُرسِل رسالة تحقُّق إلى مستخدِم.
unlink(user, providerId) يؤدي إلى إلغاء ربط مقدّم خدمة بحساب مستخدم.
updateEmail(user, newEmail) لتعديل عنوان البريد الإلكتروني للمستخدِم.
updatePassword(user, newPassword) لتعديل كلمة مرور المستخدم
updatePhoneNumber(user, Credential) لتعديل رقم هاتف المستخدِم
updateProfile(user, { displayName, imageURL: imageUrl }) لتعديل بيانات الملف الشخصي للمستخدم
verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings) تُرسِل رسالة تحقُّق إلى عنوان بريد إلكتروني جديد.
الدالّة(userCredential, ...)
getAdditionalUserInfo(userCredential) لاستخراج البيانات من النوع AdditionalUserInfo الخاصة بالموفّر لبيانات الاعتماد المحدّدة.

صفوف

الفئة الوصف
ActionCodeURL فئة برامج مساعدة لتحليل عناوين URL لإجراءات البريد الإلكتروني مثل إعادة ضبط كلمة المرور، والتحقق من عنوان البريد الإلكتروني، وتسجيل الدخول باستخدام رابط البريد الإلكتروني، وما إلى ذلك.
AuthCredential واجهة تمثّل بيانات الاعتماد التي يعرضها AuthProvider.
EmailAuthCredential واجهة تمثّل بيانات الاعتماد التي يعرضها EmailAuthProvider لـ ProviderId.كلمة المرور
EmailAuthProvider موفّر بيانات إنشاء EmailAuthCredential.
FacebookAuthProvider موفّر بيانات لإنشاء OAuthCredential لـ ProviderId.FACEBOOK.
GithubAuthProvider موفّر بيانات لإنشاء OAuthCredential لـ ProviderId.GITHUB.
GoogleAuthProvider موفّر لإنشاء OAuthCredential لـ ProviderId.GOOGLE.
بيانات اعتماد OAuth تُمثل بيانات اعتماد OAuth التي يعرضها OAuthProvider.
OAuthProvider موفّر بيانات لإنشاء بيانات اعتماد OAuth عامة.
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.
إعدادات المصادقة واجهة تمثِّل إعدادات مثيل Auth
الإعداد واجهة تمثِّل إعدادات Auth
نتيجة التأكيد نتيجة عملية تسجيل الدخول إلى رقم هاتف أو رابط أو إعادة مصادقة مكالمة
التبعيات يشير ذلك المصطلح إلى الملحقات التي يمكن استخدامها لإعداد مثيل Auth.
EmulatorConfig تهيئة محاكي مصادقة Firebase
IdTokenResult واجهة تمثّل نتيجة الرمز المميّز لرقم التعريف الذي تم الحصول عليه من User.getIdTokenResult().
التأكيد المتعدّد العوامل الفئة الأساسية لتأكيد ملكية العامل الثاني.
خطأ متعدد العوامل يظهر الخطأ عندما يحتاج المستخدم إلى تقديم عامل ثانٍ لتسجيل الدخول بنجاح.
متعدد العوامل يشير ذلك المصطلح إلى بنية تحتوي على معلومات عامل تشغيل ثانٍ.
متعدد العوامل الفئة المستخدمة لتسهيل الاسترداد من MultiFactorError عندما يحتاج المستخدم إلى تقديم عامل ثانٍ لتسجيل الدخول.
متعدد العوامل هي واجهة تحدِّد كائن الجلسة متعدد العوامل المستخدم لتسجيل عامل ثانٍ في أحد المستخدمين أو المساعدة في تسجيل دخول مستخدم مسجَّل باستخدام عامل ثانٍ.
متعدد العوامل واجهة تحدِّد السمات والعمليات ذات الصلة المتعدّدة العوامل والمرتبطة بالمستخدِم
OAuthCredentialOptions تُحدِّد خيارات إعداد OAuthCredential.
ParsedToken واجهة تمثِّل رمزًا مميّزًا للمعرّف الذي تم تحليله
سياسة كلمة المرور بنية تحدد متطلبات سياسة كلمة المرور.
حالة التحقق من صحة كلمة المرور هيكل يوضح متطلبات سياسة كلمة المرور التي تم استيفاؤها أو انتهاكها والمتطلبات.
المثابرة واجهة تغطي أنواع آليات التثبيت المحتملة.
PhoneMultiFactorAssertion فئة تأكيد ملكية العامل الثاني للهاتف. يتوفر من خلال PhoneMultiFactorGenerator.assertion().
PhoneMultiFactorregistrationInfoOptions الخيارات المستخدَمة لتسجيل عامل ثانٍ.
PhoneMultiFactorInfo الفئة الفرعية لواجهة MultiFactorInfo للعوامل الثانية لرقم الهاتف. factorId للعامل الثاني هذا هو FactorId.PHONE.
PhoneMultiFactorSignInInfoOptions الخيارات المستخدمة لتسجيل الدخول بعامل ثانٍ.
PhoneOneFactorInfoOptions الخيارات المستخدمة لتسجيل الدخول من عامل واحد.
PopupRedirecter أداة تعيين تُستخدم للتعامل مع عمليات خاصة بنموذج DOM، مثل signInWithPopup() أو signInWithRedirect().
ReactNativeAsyncStorage واجهة لجهاز AsyncStorage تم توفيره
Recaptchaparams واجهة تمثّل معلَمات reCAPTCHA.يمكنك الاطّلاع على مستندات reCAPTCHA للاطّلاع على قائمة بالمعلَمات المقبولة. يتم قبول جميع المَعلمات باستثناء sitekey: توفّر مصادقة Firebase اختبار reCAPTCHA لكل مشروع وستضبط مفتاح الموقع الإلكتروني عند العرض.بالنسبة إلى اختبار reCAPTCHA غير المرئي، اضبط مفتاح size على invisible.
TotpMultiFactorAssertion فئة تأكيد ملكية العامل الثاني لـ TOTP. يتوفر من خلال TotpMultiFactorGenerator.assertionForSUBSCRIPTION() وTotpMultiFactorGenerator.assertionForSignIn().
TotpMultiFactorInfo الفئة الفرعية لواجهة MultiFactorInfo لعوامل TOTP الثانية. تمثّل factorId لهذا العامل الثاني FactorId.TOTP.
المستخدم حساب مستخدم.
UserCredential بنية تحتوي على المستخدم وOperationType ورقم تعريف المزوّد.
معلومات المستخدم معلومات الملف الشخصي للمستخدم، ولا تظهر إلا لتطبيقات مشروع Firebase.
UserMetadata واجهة تمثّل البيانات الوصفية لمستخدم

المتغيرات

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

كتابة العناوين البديلة للبريد الإلكتروني

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

function(app, ...)

getAuth(app)

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

Signature:

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

المَعلمات

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

المرتجعات:

المصادقة

startizeAuth(app, deps)

يبدأ مثيل المصادقة مع التحكّم بدقة في التبعيات.

تتيح هذه الدالة التحكّم في مثيل 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;

المَعلمات

المعلمة النوع الوصف
التطبيق تطبيق Firebase
الانخفاضات التبعيات

المرتجعات:

المصادقة

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

getReactNativePersistence(storage)

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

Signature:

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

المَعلمات

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

المرتجعات:

المثابرة

function(auth, ...)

applicationActionCode(auth, oobCode)

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

Signature:

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

المَعلمات

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

المرتجعات:

وعود <باطلة>

beforeAuthStateChanged(auth, callback, onAbort)

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

Signature:

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

المَعلمات

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

المرتجعات:

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

CheckActionCode(auth, oobCode)

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

Signature:

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

المَعلمات

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

المرتجعات:

Promise<ActionCodeInfo>

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

تأكيد كلمة المرور(auth, oobCode, newPassword)

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

Signature:

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

المَعلمات

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

المرتجعات:

وعود <باطلة>

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

المرتجعات:

فراغ

مثال

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

createUserWithEmailAndPassword(auth, البريد الإلكتروني، كلمة المرور)

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

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

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

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

Signature:

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

المَعلمات

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

المرتجعات:

الوعد<UserCredential>

getSignInMethodsForEmail(auth, email)

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

ويفيد ذلك في التمييز بين طرق تسجيل الدخول لمقدم الخدمة نفسه، على سبيل المثال: EmailAuthProvider الذي يتضمّن طريقتَين لتسجيل الدخول، هما SignInMethod.EMAIL_password وSignInMethod.EMAIL_LINK

Signature:

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

المَعلمات

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

المرتجعات:

Promise&lt;string[]&gt;

getMultiFactorsolutionsr(auth, error)

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

Signature:

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

المَعلمات

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

المرتجعات:

متعدد العوامل

getRedirectResult(auth, arranger)

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

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

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

Signature:

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

المَعلمات

المعلمة النوع الوصف
المصادقة المصادقة مثيل Auth.
برنامج التعيين PopupRedirecter مثال على PopupRedirectCancelr، وهو اختياري إذا كان قد تم تقديمه إلى InitializeAuth() أو تم تقديمه من خلال getAuth().

المرتجعات:

الوعد<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;

startizeRecaptchaConfig(auth)

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

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

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

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

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

Signature:

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

المَعلمات

المعلمة النوع الوصف
المصادقة المصادقة مثيل Auth.

المرتجعات:

وعود <باطلة>

مثال

initializeRecaptchaConfig(auth);

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

Signature:

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

المَعلمات

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

المرتجعات:

قيمة منطقية

onAuthStateChanged(auth, nextOrObserver, error, complete)

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

للاحتفاظ بالسلوك القديم، يُرجى الاطّلاع على 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, complete)

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

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

Signature:

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

المَعلمات

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

المرتجعات:

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

إبطالAccessToken(المصادقة، رمز مميّز)

إبطال رمز الدخول المحدّد. لا يتوافق هذا الإعداد حاليًا إلا مع رموز الدخول عبر بروتوكول OAuth من Apple.

Signature:

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

المَعلمات

المعلمة النوع الوصف
المصادقة المصادقة مثيل Auth.
رمز مميز السلسلة رمز الدخول إلى Apple OAuth.

المرتجعات:

وعود <باطلة>

إرسال كلمة المرور إعادة ضبط البريد الإلكتروني(auth, email, actionCodeSettings)

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

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

Signature:

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

المَعلمات

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

المرتجعات:

وعود <باطلة>

مثال

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.

المرتجعات:

وعود <باطلة>

مثال

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, nextence)

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

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

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

Signature:

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

المَعلمات

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

المرتجعات:

وعود <باطلة>

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

مثال

setPersistence(auth, browserSessionPersistence);

SignInمجهولly(auth)

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

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

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

Signature:

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

المَعلمات

المعلمة النوع الوصف
المصادقة المصادقة مثيل Auth.

المرتجعات:

الوعد<UserCredential>

SignInWithCredential(auth, Credential)

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

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

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

Signature:

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

المَعلمات

المعلمة النوع الوصف
المصادقة المصادقة مثيل Auth.
شهادة AuthCredential بيانات اعتماد المصادقة.

المرتجعات:

الوعد<UserCredential>

SignInWithCustomToken(auth, customToken)

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

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

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

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

Signature:

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

المَعلمات

المعلمة النوع الوصف
المصادقة المصادقة مثيل Auth.
رمز مميّز مخصّص السلسلة الرمز المميّز المخصّص الذي يمكن استخدامه لتسجيل الدخول

المرتجعات:

الوعد<UserCredential>

SignInWithEmailAndPassword(المصادقة، البريد الإلكتروني، كلمة المرور)

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

يتعذّر عرض رسالة خطأ إذا لم يتطابق عنوان البريد الإلكتروني وكلمة المرور. عندما تكون حماية تعداد البريد الإلكتروني مفعلة، يتعذّر تنفيذ هذه الطريقة مع ظهور "auth/invalid-certified" في حالة إدخال عنوان بريد إلكتروني أو كلمة مرور غير صالحة.

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

Signature:

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

المَعلمات

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

المرتجعات:

الوعد<UserCredential>

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

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

يتعذّر عرض رسالة خطأ إذا كان عنوان البريد الإلكتروني غير صالح أو إذا انتهت صلاحية كلمة المرور لمرة واحدة في رابط البريد الإلكتروني.

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

Signature:

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

المَعلمات

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

المرتجعات:

الوعد<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.
رقم الهاتف السلسلة رقم هاتف المستخدم بتنسيق E.164 (مثل +16505550101).
واجهة appVerifier ApplicationVerifier ApplicationVerifier:

المرتجعات:

الوعد <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, التعيين)

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

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

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

Signature:

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

المَعلمات

المعلمة النوع الوصف
المصادقة المصادقة مثيل Auth.
مزوِّد الخدمة AuthProvider الموفِّر المطلوب للمصادقة. يجب أن يكون الموفِّر OAuthProvider. سيعرض موفرو غير OAuth مثل EmailAuthProvider رسالة خطأ.
برنامج التعيين PopupRedirecter مثال على PopupRedirectCancelr، وهو اختياري إذا كان قد تم تقديمه إلى InitializeAuth() أو تم تقديمه من خلال getAuth().

المرتجعات:

الوعد<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, التعيين)

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

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

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

Signature:

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

المَعلمات

المعلمة النوع الوصف
المصادقة المصادقة مثيل Auth.
مزوِّد الخدمة AuthProvider الموفِّر المطلوب للمصادقة. يجب أن يكون الموفِّر OAuthProvider. سيعرض موفرو غير OAuth مثل EmailAuthProvider رسالة خطأ.
برنامج التعيين PopupRedirecter مثال على PopupRedirectCancelr، وهو اختياري إذا كان قد تم تقديمه إلى 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;

تسجيل الخروج(auth)

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

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

Signature:

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

المَعلمات

المعلمة النوع الوصف
المصادقة المصادقة مثيل Auth.

المرتجعات:

وعود <باطلة>

UpdateCurrentUser(auth, user)

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

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

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

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

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

Signature:

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

المَعلمات

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

المرتجعات:

وعود <باطلة>

UseDeviceLanguage(auth)

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

Signature:

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

المَعلمات

المعلمة النوع الوصف
المصادقة المصادقة مثيل Auth.

المرتجعات:

فراغ

التحقق من صحة كلمة المرور(auth, كلمة المرور)

يتم التحقُّق من كلمة المرور وفقًا لسياسة كلمة المرور التي تم ضبطها للمشروع أو المستأجر.

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

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

Signature:

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

المَعلمات

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

المرتجعات:

الوعد <PasswordValidationStatus>

مثال

validatePassword(auth, 'some-password');

التحقق من رمز إعادة ضبط كلمة المرور(auth, code)

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

Signature:

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

المَعلمات

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

المرتجعات:

وعود<string>

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

function(link, ...)

ParseActionCodeURL(link)

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

Signature:

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

المَعلمات

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

المرتجعات:

ActionCodeURL | فارغ

function(user, ...)

deleteUser(user)

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

Signature:

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

المَعلمات

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

المرتجعات:

وعود <باطلة>

getIdToken(user, forceRefresh)

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

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

Signature:

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

المَعلمات

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

المرتجعات:

وعود<string>

getIdTokenResult(user, forceRefresh)

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

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

Signature:

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

المَعلمات

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

المرتجعات:

الوعد<IdTokenResult>

linkWithCredential(user, Credential)

يربط حساب المستخدم ببيانات الاعتماد المقدَّمة.

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

Signature:

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

المَعلمات

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

المرتجعات:

الوعد<UserCredential>

linkWithPhoneNumber(user, phoneNumber, appVerifier)

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

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

Signature:

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

المَعلمات

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

المرتجعات:

الوعد <ConfirmationResult>

linkWithPopup(user, provider, returnr)

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

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

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

Signature:

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

المَعلمات

المعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
مزوِّد الخدمة AuthProvider الموفِّر المطلوب للمصادقة. يجب أن يكون الموفِّر OAuthProvider. سيعرض موفرو غير OAuth مثل EmailAuthProvider رسالة خطأ.
برنامج التعيين PopupRedirecter مثال على PopupRedirectCancelr، وهو اختياري إذا كان قد تم تقديمه إلى InitializeAuth() أو تم تقديمه من خلال getAuth().

المرتجعات:

الوعد<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, marketr)

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

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

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

Signature:

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

المَعلمات

المعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
مزوِّد الخدمة AuthProvider الموفِّر المطلوب للمصادقة. يجب أن يكون الموفِّر OAuthProvider. سيعرض موفرو غير OAuth مثل EmailAuthProvider رسالة خطأ.
برنامج التعيين PopupRedirecter مثال على PopupRedirectCancelr، وهو اختياري إذا كان قد تم تقديمه إلى 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);

متعدد العوامل(المستخدم)

تمثّل هذه السمة MultiFactorUser المقابل للمستخدم.

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

Signature:

export declare function multiFactor(user: User): 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 بيانات اعتماد المصادقة.

المرتجعات:

الوعد<UserCredential>

reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier)

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

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

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

Signature:

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

المَعلمات

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

المرتجعات:

الوعد <ConfirmationResult>

reauthenticateWithPopup(user, provider, التعيين)

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

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

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

Signature:

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

المَعلمات

المعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
مزوِّد الخدمة AuthProvider الموفِّر المطلوب للمصادقة. يجب أن يكون الموفِّر OAuthProvider. سيعرض موفرو غير OAuth مثل EmailAuthProvider رسالة خطأ.
برنامج التعيين PopupRedirecter مثال على PopupRedirectCancelr، وهو اختياري إذا كان قد تم تقديمه إلى InitializeAuth() أو تم تقديمه من خلال getAuth().

المرتجعات:

الوعد<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, التقريرr)

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

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

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

Signature:

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

المَعلمات

المعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
مزوِّد الخدمة AuthProvider الموفِّر المطلوب للمصادقة. يجب أن يكون الموفِّر OAuthProvider. سيعرض موفرو غير OAuth مثل EmailAuthProvider رسالة خطأ.
برنامج التعيين PopupRedirecter مثال على PopupRedirectCancelr، وهو اختياري إذا كان قد تم تقديمه إلى 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>;

المَعلمات

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

المرتجعات:

وعود <باطلة>

SendEmailverification(user, actionCodeSettings)

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

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

Signature:

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

المَعلمات

المعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
إعدادات رمز الإجراء ActionCodeSettings | فارغ ActionCodeSettings.

المرتجعات:

وعود <باطلة>

مثال

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>;

المَعلمات

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

المرتجعات:

تقديم وعود<المستخدم>

updateEmail(user, newEmail)

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

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

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

Signature:

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

المَعلمات

المعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
بريد إلكتروني جديد السلسلة عنوان البريد الإلكتروني الجديد.يعرض العنوان "auth/operation-not-allowed" عند تفعيل حماية تعداد البريد الإلكتروني. متوقّفة نهائيًا - يمكنك استخدام verifyBeforeUpdateEmail() بدلاً منها.

المرتجعات:

وعود <باطلة>

UpdatePassword(user, newPassword)

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

Signature:

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

المَعلمات

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

المرتجعات:

وعود <باطلة>

UpdatePhoneNumber(user, Credential)

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

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

Signature:

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

المَعلمات

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

المرتجعات:

وعود <باطلة>

مثال

// '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, imageURL: imageUrl })

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

Signature:

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

المَعلمات

المعلمة النوع الوصف
المستخدم المستخدم المستخدِم.
{ displayName, imageURL: imageUrl } { displayName?: سلسلة | null; imageURL?: سلسلة | null; }

المرتجعات:

وعود <باطلة>

VerifyBeforeUpdateEmail(user, newEmail, actionCodeSettings)

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

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

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

Signature:

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

المَعلمات

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

المرتجعات:

وعود <باطلة>

مثال

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);

function(userCredential, ...)

getAdditionalUserInfo(userCredential)

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

Signature:

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

المَعلمات

المعلمة النوع الوصف
بيانات اعتماد المستخدم UserCredential بيانات اعتماد المستخدم

المرتجعات:

AdditionalUserInfo | فارغ

عملية رمز الإجراء

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

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";
}

الاستمرارية في المتصفح

يشير ذلك المصطلح إلى تنفيذ الثبات من النوع LOCAL باستخدام القيمة localStorage لمساحة التخزين الأساسية.

Signature:

browserLocalPersistence: Persistence

InternetPopupRedirectمحلل

طريقة تنفيذ PopupRedirectCancelr مناسبة للتطبيقات المستندة إلى المتصفّح.

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

Signature:

browserPopupRedirectResolver: PopupRedirectResolver

userSessionPersistence

يشير ذلك المصطلح إلى تنفيذ الثبات لـ SESSION باستخدام القيمة sessionStorage لمساحة التخزين الأساسية.

Signature:

browserSessionPersistence: Persistence

cordovaPopupRedirectDisabler

يشير ذلك المصطلح إلى تنفيذ PopupRedirectCancelr مناسب للتطبيقات المستندة إلى Cordova.

Signature:

cordovaPopupRedirectResolver: PopupRedirectResolver

خريطة خطأ تصحيح الأخطاء

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

الاطّلاع على المناقشة على AuthErrorMap

Signature:

debugErrorMap: AuthErrorMap

معرّف العامل

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

Signature:

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

قاعدة البيانات المحلية المفهرَسة

يشير ذلك المصطلح إلى تنفيذ الثبات من النوع LOCAL باستخدام القيمة indexedDB لمساحة التخزين الأساسية.

Signature:

indexedDBLocalPersistence: Persistence

InMemoryPersistence

يشير ذلك المصطلح إلى تنفيذ للدالة Persistence من النوع "NONE".

Signature:

inMemoryPersistence: Persistence

OperationType

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

Signature:

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

prodErrorMap

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

الاطّلاع على المناقشة على AuthErrorMap

Signature:

prodErrorMap: AuthErrorMap

رقم تعريف موفّر الخدمة

تعداد مقدّمي الخدمة المعتمَدين

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";
}

المعلّمات المخصّصة

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

Signature:

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

NextOrObserver

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

Signature:

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

خيارات PhoneInfo

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

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

Signature:

export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;

UserProfile

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

Signature:

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