auth package

אימות ב-Firebase

פונקציות

פעולה תיאור
function(app, ...)
getAuth(app) מחזירה את מופע האימות שמשויך ל-FirebaseApp שצוין. אם לא קיימת מכונה, מפעיל מופע אימות עם יחסי תלות שמוגדרים כברירת מחדל לפי פלטפורמה.
initializeAuth(app, deps) הפעלה של מכונת Auth עם שליטה מדויקת על תלות.
function(storage, ...)
getReactNativePersistence(storage) הפונקציה מחזירה אובייקט מתמיד מקיף את הפונקציה AsyncStorage שמיובאת מ-react-native או @react-native-community/async-storage, וניתן להשתמש בו בשדה של התלות בעקביות ב-initializeAuth().
function(auth, ...)
applyActionCode(auth, oobCode) מחיל קוד אימות שנשלח למשתמש באימייל או במנגנון אחר מחוץ למסגרת.
beforeAuthStateChanged(auth, callback, onAbort) הוספת קריאה חוזרת (callback) לחסימה שפועלת לפני ששינוי מצב האימות מגדיר משתמש חדש.
checkActionCode(auth, oobCode) בודק קוד אימות שנשלח למשתמש באימייל או במנגנון אחר מחוץ למסגרת.
confirmPasswordReset(auth, oobCode, newPassword) משלים את תהליך איפוס הסיסמה, בהינתן קוד אישור וסיסמה חדשה.
connectAuthEmulator(auth, url, options) משנים את המופע של Auth כדי לתקשר עם האמולטור Firebase Auth, במקום עם שירותי Firebase Auth בסביבת ייצור.
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) בדיקת קוד איפוס סיסמה שנשלח למשתמש באימייל או במנגנון אחר מחוץ למסגרת.
function(link, ...)
parseActionCodeURL(link) הפונקציה מנתחת את מחרוזת הקישור לפעולה באימייל ומחזירה ActionCodeURL אם הקישור תקין. במקרים אחרים, הפונקציה מחזירה את הערך null.
function(user, ...)
deleteUser(user) מוחק את המשתמש ומוציא אותו מהחשבון.
getIdToken(user, forceRefresh) הפונקציה מחזירה אסימון אינטרנט מסוג JSON (JWT) שמשמש לזיהוי המשתמש בשירות Firebase.
getIdTokenResult(user, forceRefresh) הפונקציה מחזירה אסימון אינטרנט מסוג JSON (JWT) שעבר deserialed כדי לזהות את המשתמש בשירות 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 שצוין באמצעות תהליך הפניה לדף מלא.
reload(user) טוען מחדש את נתוני חשבונות המשתמש, אם המשתמש מחובר.
sendEmailVerification(user, actionCodeSettings) שולחת הודעת אימות למשתמש.
unlink(user, providerId) מבטל את הקישור של ספק לחשבון משתמש.
updateEmail(user, newEmail) עדכון כתובת האימייל של המשתמש.
updatePassword(user, newPassword) עדכון הסיסמה של המשתמש.
updatePhoneNumber(user, credential) עדכון מספר הטלפון של המשתמש.
updateProfile(user, { displayName, photoURL: photoUrl }) עדכון נתוני פרופיל של משתמש.
verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings) שולח הודעת אימות לכתובת אימייל חדשה.
function(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.מאחסן את המפתח הסודי המשותף ופרמטרים אחרים כדי ליצור סיסמאות חד-פעמיות מבוססות-זמן. הטמעת שיטות לאחזור המפתח הסודי המשותף וליצירת כתובת URL של קוד QR.
TwitterAuthProvider ספק ליצירת OAuthCredential ל-ProviderId.TWITTER.

ממשקים

ממשק תיאור
ActionCodeInfo תשובה מ-checkActionCode().
ActionCodeSettings ממשק שמגדיר את כתובת ה-URL הנדרשת להמשך/מצב, עם מזהי חבילות אופציונליים של Android ו-iOS.
AdditionalUserInfo מבנה שמכיל מידע נוסף על המשתמשים מספק זהויות מאוחד.
ApplicationVerifier מאמת של אימות דומיין ומניעת ניצול לרעה.
אימות הממשק שמייצג את שירות Firebase Auth.
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 Auth מקצה reCAPTCHA לכל פרויקט ויגדיר את מפתח האתר בזמן העיבוד.ב-reCAPTCHA בלתי נראה, יש להגדיר את המפתח size כ-invisible.
TotpMultiFactorAssertion הכיתה להצהרת בעלות על גורם שני מסוג TOTP. סופק על ידי TotpMultiFactorGenerator.assertionForEnrollment() ו-TotpMultiFactorGenerator.assertionForSignIn().
TotpMultiFactorInfo מחלקת המשנה של הממשק MultiFactorInfo עבור גורמים משניים של TOTP. ה-factorId של הגורם השני הזה הוא FactorId.TOTP.
משתמש חשבון משתמש.
UserCredential מבנה שמכיל User, את ה-OperationType ואת מזהה הספק.
UserInfo פרטי פרופיל משתמש, גלויים רק לאפליקציות של פרויקט Firebase.
UserMetadata ממשק שמייצג את המטא-נתונים של משתמש.

משתנים

משתנה תיאור
ActionCodeOperation רשימת הסוגים האפשריים של פעולות באימייל.
AuthErrorCodes מפה של קודי שגיאה אפשריים של Auth, כדי להשוות בקלות רבה יותר לשגיאות שה-SDK שלח.
browserLocalPersistence הטמעה של Persistence מסוג LOCAL באמצעות localStorage לאחסון הבסיסי.
browserPopupRedirectResolver יישום של PopupRedirectResolver מתאים לאפליקציות מבוססות-דפדפן.
browserSessionPersistence הטמעה של Persistence של SESSION באמצעות sessionStorage לאחסון הבסיסי.
cordovaPopupRedirectResolver יישום של PopupRedirectResolver מתאים לאפליקציות המבוססות על Cordova.
debugErrorMap מפת שגיאות מפורטת עם תיאורים מפורטים לרוב קודי השגיאה.עיין בדיון ב-AuthErrorMap
FactorId רשימת גורמים שיכולים לשמש לאימות רב-גורמי.
indexedDBLocalPersistence הטמעה של Persistence מסוג LOCAL באמצעות indexedDB לאחסון הבסיסי.
inMemoryPersistence הטמעה של Persistence מסוג 'NONE'.
OperationType רשימת סוגי הפעולות הנתמכים.
prodErrorMap מפת שגיאות מינימלית שהוסרו כל הודעות השגיאה המנוסחות.ניתן לעיין בדיון ב-AuthErrorMap
ProviderId רשימת הספקים הנתמכים.
SignInMethod רשימת שיטות הכניסה הנתמכות.

יש להקליד כינויים

הקלד כינוי תיאור
CustomParameters מפה של פרמטרים מותאמים אישית של OAuth.
NextOrObserver יש להקליד את הגדרת הקריאה החוזרת לאירוע.
PhoneInfoOptions המידע הדרוש לאימות הבעלות על מספר טלפון.
UserProfile פרופיל המשתמש שנכלל ב-AdditionalUserInfo.

function(app, ...)

getAuth(app)

מחזירה את מופע האימות שמשויך ל-FirebaseApp שצוין. אם לא קיימת מכונה, מפעיל מופע אימות עם יחסי תלות שמוגדרים כברירת מחדל לפי פלטפורמה.

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

החזרות:

התמדה

function(auth, ...)

applyActionCode(auth, oobCode)

מחיל קוד אימות שנשלח למשתמש באימייל או במנגנון אחר מחוץ למסגרת.

Signature:

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

פרמטרים

פרמטר סוג תיאור
אימות אימות המכונה Auth.
oobCode מחרוזת קוד אימות נשלח למשתמש.

החזרות:

Promise<void>

beforeAuthStateChanged(auth, callback, onAbort)

הוספת קריאה חוזרת (callback) לחסימה שפועלת לפני ששינוי מצב האימות מגדיר משתמש חדש.

Signature:

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

פרמטרים

פרמטר סוג תיאור
אימות אימות המכונה Auth.
קריאה חוזרת (callback) (user: User | null) => void | Promise<void> הקריאה החוזרת הופעלה לפני שהוגדר ערך משתמש חדש. אם השורה מופיעה, היא חוסמת את הגדרת המשתמש.
onAbort () => בטל קריאה חוזרת מופעלת אם קריאה חוזרת (callback) של 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 Auth, במקום עם שירותי Firebase Auth בסביבת ייצור.

צריך לקרוא לפונקציה הזו באופן סינכרוני מיד לאחר הקריאה הראשונה ל-initializeAuth(). אין להשתמש באפשרות הזו עם פרטי כניסה של סביבת ייצור כי התנועה באמולטור לא מוצפנת.

Signature:

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

פרמטרים

פרמטר סוג תיאור
אימות אימות המכונה Auth.
כתובת אתר מחרוזת כתובת ה-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.
error 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 לכל ספק אימות, בסשן האימות הנוכחי.

אם לא מופעל startizeRecaptchaConfig() , תהליך האימות יתחיל תמיד בלי אימות 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<User> הקריאה החוזרת הופעלה בעקבות השינוי.
error 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<User> הקריאה החוזרת הופעלה בעקבות השינוי.
error ErrorFn הוּצא משימוש. הקריאה החוזרת לא מופעלת אף פעם. יכול להיות ששגיאות בכניסה וביציאה יזוהו בהבטחות שמוחזרות מפונקציות של כניסה/יציאה.
הושלמו CompleteFn הוּצא משימוש. הקריאה החוזרת לא מופעלת אף פעם.

החזרות:

ביטול ההרשמה

revokeAccessToken(auth, token)

ביטול אסימון הגישה שניתן. בשלב זה יש תמיכה רק באסימוני גישה מסוג Apple OAuth.

Signature:

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

פרמטרים

פרמטר סוג תיאור
אימות אימות המכונה Auth.
אסימון מחרוזת אסימון הגישה של Apple OAuth.

החזרות:

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.
עקביות התמדה ה-Persistence לשימוש.

החזרות:

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 Auth עם מערכות אימות קיימות, וצריך ליצור אותם באמצעות קצה עורפי של אימות באמצעות השיטה createCustomToken ב-Admin SDK .

האסימון ייכשל אם האסימון ייכשל, אם התוקף שלו חלף או אם הוא לא אושר על ידי שירות Firebase Auth.

השיטה הזו לא נתמכת במכונות 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/invalid-credential" במקרה של כתובת אימייל/סיסמה לא חוקית.

השיטה הזו לא נתמכת במכונות Auth שנוצרו באמצעות FirebaseServerApp.

Signature:

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

פרמטרים

פרמטר סוג תיאור
אימות אימות המכונה Auth.
אימייל מחרוזת כתובת האימייל של המשתמשים.
סיסמה מחרוזת סיסמת המשתמשים.

החזרות:

Promise<UserCredential>

מתבצעת כניסה אסינכרונית באמצעות כתובת אימייל וקישור לכניסה לחשבון.

אם לא הועבר קישור, המערכת תסיק את הקישור מכתובת האתר הנוכחית.

השגיאה תיכשל אם כתובת האימייל לא תקינה או אם התוקף של ה-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.

עותק חדש של מופע המשתמש שסופק ייווצר ויוגד כמשתמש נוכחי.

הפעולה הזו תפעיל מאזינים ל-onAuthStateChanged() ו-onIdTokenChanged(), כמו שיטות כניסה אחרות.

אם המשתמש שרוצים לעדכן שייך לפרויקט Firebase אחר, הפעולה תיכשל.

השיטה הזו לא נתמכת במכונות Auth שנוצרו באמצעות FirebaseServerApp.

Signature:

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

פרמטרים

פרמטר סוג תיאור
אימות אימות המכונה Auth.
user משתמש | null משתמש החדש.

החזרות:

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>

לכתובת האימייל של המשתמש, אם היא חוקית.

function(link, ...)

parseActionCodeURL(link)

הפונקציה מנתחת את מחרוזת הקישור לפעולה באימייל ומחזירה ActionCodeURL אם הקישור תקין. במקרים אחרים, הפונקציה מחזירה את הערך null.

Signature:

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

פרמטרים

פרמטר סוג תיאור
קישור מחרוזת

החזרות:

ActionCodeURL | null

function(user, ...)

deleteUser(user)

מוחק את המשתמש ומוציא אותו מהחשבון.

Signature:

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

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.

החזרות:

Promise<void>

getIdToken(user, forceRefresh)

הפונקציה מחזירה אסימון אינטרנט מסוג JSON (JWT) שמשמש לזיהוי המשתמש בשירות Firebase.

מחזירה את האסימון הנוכחי אם תוקפו עדיין לא פג או אם התוקף שלו לא יפוג בחמש הדקות הבאות. אחרת, הפעולה הזו תרענן את האסימון ותחזיר אסימון חדש.

Signature:

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

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.
forceRefresh boolean אילוץ רענון ללא קשר לתאריך התפוגה של האסימון.

החזרות:

הבטחה<string>

getIdTokenResult(user, forceRefresh)

הפונקציה מחזירה אסימון אינטרנט מסוג JSON (JWT) שעבר deserialed כדי לזהות את המשתמש בשירות Firebase.

מחזירה את האסימון הנוכחי אם תוקפו עדיין לא פג או אם התוקף שלו לא יפוג בחמש הדקות הבאות. אחרת, הפעולה הזו תרענן את האסימון ותחזיר אסימון חדש.

Signature:

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

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.
forceRefresh boolean אילוץ רענון ללא קשר לתאריך התפוגה של האסימון.

החזרות:

Promise<IdTokenResult>

linkWithCredential(user, credential)

מקשרת את חשבון המשתמש לפרטי הכניסה הנתונים שצוינו.

אפשר להשתמש ב-AuthProvider כדי ליצור את פרטי הכניסה.

Signature:

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

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.
פרטי כניסה לחשבון AuthCredential פרטי הכניסה לאימות.

החזרות:

Promise<UserCredential>

linkWithPhoneNumber(user, phoneNumber, appVerifier)

מקשר את חשבון המשתמש למספר הטלפון הנתון.

השיטה הזו לא פועלת בסביבת Node.js.

Signature:

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

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.
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>;

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.
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>;

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.
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;

פרמטרים

פרמטר סוג תיאור
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>;

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.
פרטי כניסה לחשבון 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>;

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.
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>;

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.
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>;

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.
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>;

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.

החזרות:

Promise<void>

sendEmailVerification(user, actionCodeSettings)

שולחת הודעת אימות למשתמש.

כדי להשלים את תהליך האימות, צריך לקרוא לפונקציה applyActionCode().

Signature:

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

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.
actionCodeSettings ActionCodeSettings | null 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>;

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.
providerId מחרוזת הספק שיש לבטל את הקישור שלו.

החזרות:

הבטחה<User>

updateEmail(user, newEmail)

עדכון כתובת האימייל של המשתמש.

הודעת אימייל תישלח לכתובת האימייל המקורית (אם היא הוגדרה) שמאפשרת לבטל את השינוי של כתובת האימייל, כדי להגן עליהם מפני פריצת החשבון.

השיטה הזו לא נתמכת באף משתמש שנכנס על ידי מופעי Auth שנוצרו באמצעות FirebaseServerApp.

Signature:

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

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.
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>;

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.
newPassword מחרוזת הסיסמה החדשה.

החזרות:

Promise<void>

updatePhoneNumber(user, credential)

עדכון מספר הטלפון של המשתמש.

השיטה הזו לא פועלת בסביבת Node.js או בכל פעם של משתמש שמחובר למופעי Auth שנוצרו באמצעות FirebaseServerApp.

Signature:

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

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.
פרטי כניסה לחשבון 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>;

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.
{ displayName, photoURL: PhotoUrl } { displayName?: string | null; photoURL?: string | null; }

החזרות:

Promise<void>

verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings)

שולח הודעת אימות לכתובת אימייל חדשה.

לאחר האימות, כתובת האימייל של המשתמש תעודכן לכתובת האימייל החדשה.

אם יש לכם handler בהתאמה אישית של פעולות באימייל, תוכלו להשלים את תהליך האימות באמצעות applyActionCode().

Signature:

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

פרמטרים

פרמטר סוג תיאור
user משתמש המשתמש.
newEmail מחרוזת כתובת האימייל החדשה שיש לאמת לפני העדכון.
actionCodeSettings ActionCodeSettings | null 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);

function(userCredential, ...)

getAdditionalUserInfo(userCredential)

מחלץ את פרטי AdditionalUserInfo הספציפיים של הספק לפרטי הכניסה הנתונים.

Signature:

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

פרמטרים

פרמטר סוג תיאור
userCredential UserCredential פרטי הכניסה של המשתמש.

החזרות:

AdditionalUserInfo | null

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

הטמעה של Persistence מסוג LOCAL באמצעות localStorage לאחסון הבסיסי.

Signature:

browserLocalPersistence: Persistence

browserPopupRedirectResolver

יישום של PopupRedirectResolver מתאים לאפליקציות מבוססות-דפדפן.

השיטה הזו לא פועלת בסביבת Node.js.

Signature:

browserPopupRedirectResolver: PopupRedirectResolver

browserSessionPersistence

הטמעה של Persistence של SESSION באמצעות sessionStorage לאחסון הבסיסי.

Signature:

browserSessionPersistence: Persistence

cordovaPopupRedirectResolver

יישום של PopupRedirectResolver מתאים לאפליקציות המבוססות על Cordova.

Signature:

cordovaPopupRedirectResolver: PopupRedirectResolver

debugErrorMap

מפת שגיאות מילולית עם תיאורים מפורטים של רוב קודי השגיאה.

עיין בדיון ב-AuthErrorMap

Signature:

debugErrorMap: AuthErrorMap

FactorId

רשימת גורמים שיכולים לשמש לאימות רב-גורמי.

Signature:

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

indexedDBLocalPersistence

הטמעה של Persistence מסוג 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

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