Auth interface

הממשק שמייצג את שירות Firebase Auth.

למדריך מלא על השימוש בשירות Firebase Auth אפשר למצוא במאמר אימות ב-Firebase.

Signature:

export interface Auth

תכונות

מאפיין (property) סוג תיאור
אפליקציה FirebaseApp FirebaseApp שמשויך למופע של השירות Auth.
config הגדרה ה-Config ששימש לאתחול המופע הזה.
currentUser משתמש | null המשתמש שמחובר עכשיו (או null).
emulatorConfig EmulatorConfig | null הגדרת האמולטור הנוכחית (או ערך null).
languageCode מחרוזת | null קוד השפה של המכונה של Auth.
name מחרוזת שם האפליקציה שמשויכת למופע של השירות Auth.
הגדרות AuthSettings בהגדרות של המכונה Auth.
tenantId מחרוזת | null מזהה הדייר של המכונה Auth.

שיטות

שיטה תיאור
authStateReady() מחזירה הבטחה שנפתרת מיד לאחר הסדרת מצב האימות הראשוני. כשההבטחה תסתיים, המשתמש הנוכחי עשוי להיות משתמש חוקי או null אם המשתמש לא מחובר.
beforeAuthStateChanged(callback, onAbort) הוספת קריאה חוזרת (callback) לחסימה שפועלת לפני ששינוי מצב האימות מגדיר משתמש חדש.
onAuthStateChanged(nextOrObserver, error, completed) הוספת צופה לשינויים במצב הכניסה של המשתמש.
onIdTokenChanged(nextOrObserver, error, completed) הוספת צופה לשינויים באסימון המזהה של המשתמש המחובר.
setPersistence(persistence) שינוי סוג של התמדה במכונה Auth.
signOut() ניתוק המשתמש הנוכחי. הפעולה הזו לא מבטלת באופן אוטומטי את האסימון המזהה של המשתמש.
updateCurrentUser(user) המשתמש שצוין מגדיר באופן אסינכרוני את המשתמש כ-Auth.currentUser במכונה של Auth.
useDeviceLanguage() מגדיר את השפה הנוכחית להעדפת ברירת המחדל של המכשיר/הדפדפן.

Auth.app

FirebaseApp שמשויך למופע של השירות Auth.

Signature:

readonly app: FirebaseApp;

Auth.config

ה-Config ששימש לאתחול המופע הזה.

Signature:

readonly config: Config;

Auth.currentUser

המשתמש שמחובר עכשיו (או null).

Signature:

readonly currentUser: User | null;

Auth.emulatorConfig

הגדרת האמולטור הנוכחית (או ערך null).

Signature:

readonly emulatorConfig: EmulatorConfig | null;

Auth.languageCode

קוד השפה של המכונה של Auth.

זהו נכס קריא/ניתן לכתיבה. אם הערך הוא null, המערכת מחילה את הגדרת ברירת המחדל של שפת מסוף Firebase. קוד השפה יופץ לתבניות פעולה באימייל (איפוס סיסמה, אימות אימייל וביטול שינוי אימייל), תבניות SMS לאימות טלפון, אימות reCAPTCHA ופעולות הפניה/חלון קופץ של OAuth שסופקו, בתנאי שהספקים שצוינו תומכים בלוקליזציה עם קוד השפה שצוין.

Signature:

languageCode: string | null;

Auth.name

שם האפליקציה שמשויכת למופע של השירות Auth.

Signature:

readonly name: string;

Auth.settings

בהגדרות של המכונה Auth.

ההרשאה הזו משמשת לעריכה או לקריאה של אפשרויות שקשורות להגדרות, כמו מצב אימות אפליקציות לאימות טלפון.

Signature:

readonly settings: AuthSettings;

Auth.tenantId

מזהה הדייר של המכונה Auth.

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

Signature:

tenantId: string | null;

דוגמה

// Set the tenant ID on Auth instance.
auth.tenantId = 'TENANT_PROJECT_ID';

// All future sign-in request now include tenant ID.
const result = await signInWithEmailAndPassword(auth, email, password);
// result.user.tenantId should be 'TENANT_PROJECT_ID'.

Auth.authStateReady()

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

Signature:

authStateReady(): Promise<void>;

החזרות:

Promise<void>

Auth.beforeAuthStateChanged()

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

Signature:

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

פרמטרים

פרמטר סוג תיאור
קריאה חוזרת (callback) (user: User | null) => void | Promise<void> הקריאה החוזרת הופעלה לפני שהוגדר ערך משתמש חדש. אם השורה מופיעה, היא חוסמת את הגדרת המשתמש.
onAbort () => בטל קריאה חוזרת מופעלת אם קריאה חוזרת (callback) של beforeAuthStateChanged() מאוחר יותר גורמת לביטול, אם יש תופעות לוואי.

החזרות:

ביטול ההרשמה

Auth.onAuthStateChanged()

הוספת צופה לשינויים במצב הכניסה של המשתמש.

כדי להשאיר את ההתנהגות הישנה, צריך לעיין ב-Auth.onIdTokenChanged().

Signature:

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

פרמטרים

פרמטר סוג תיאור
nextOrObserver NextOrObserver<User | null> הקריאה החוזרת הופעלה בעקבות השינוי.
error ErrorFn הוּצא משימוש. הקריאה החוזרת לא מופעלת אף פעם. יכול להיות ששגיאות בכניסה וביציאה יזוהו בהבטחות שמוחזרות מפונקציות של כניסה/יציאה.
הושלמו CompleteFn הוּצא משימוש. הקריאה החוזרת לא מופעלת אף פעם.

החזרות:

ביטול ההרשמה

Auth.onIdTokenChanged()

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

זה כולל אירועי כניסה, יציאה ורענון אסימונים.

Signature:

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

פרמטרים

פרמטר סוג תיאור
nextOrObserver NextOrObserver<User | null> הקריאה החוזרת הופעלה בעקבות השינוי.
error ErrorFn הוּצא משימוש. הקריאה החוזרת לא מופעלת אף פעם. יכול להיות ששגיאות בכניסה וביציאה יזוהו בהבטחות שמוחזרות מפונקציות של כניסה/יציאה.
הושלמו CompleteFn הוּצא משימוש. הקריאה החוזרת לא מופעלת אף פעם.

החזרות:

ביטול ההרשמה

Auth.setPersistence()

שינוי סוג של התמדה במכונה Auth.

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

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

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

Signature:

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

פרמטרים

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

החזרות:

Promise<void>

דוגמה

auth.setPersistence(browserSessionPersistence);

Auth.signOut()

ניתוק המשתמש הנוכחי. הפעולה הזו לא מבטלת באופן אוטומטי את האסימון המזהה של המשתמש.

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

Signature:

signOut(): Promise<void>;

החזרות:

Promise<void>

Auth.updateCurrentUser()

המשתמש שצוין מגדיר באופן אסינכרוני את המשתמש כ-Auth.currentUser במכונה של Auth.

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

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

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

Signature:

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

פרמטרים

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

החזרות:

Promise<void>

Auth.useDeviceLanguage()

מגדיר את השפה הנוכחית להעדפת ברירת המחדל של המכשיר/הדפדפן.

Signature:

useDeviceLanguage(): void;

החזרות:

void