auth namespace

פונקציות

פוּנקצִיָה	תיאור
משתמש (אפשרויות משתמש)	מטפל באירועים הקשורים לאירועי משתמשי Firebase Auth.
userRecordConstructor(wireData)	פונקציית עוזר שיוצרת מחלקה UserRecord מנתונים שנשלחו דרך החוט.

שיעורים

מעמד	תיאור
HttpsError	שגיאה מפורשת שניתן לזרוק ממטפל כדי לשלוח שגיאה ללקוח שקרא לפונקציה.
UserBuilder	Builder משמש ליצירת פונקציות עבור אירועי מחזור חיים של משתמש Firebase Auth.
UserRecordMetadata	מחלקה עוזרת ליצירת מטא נתונים של המשתמש באובייקט UserRecord .

ממשקים

מִמְשָׁק	תיאור
אפשרויות משתמש	אפשרויות לפונקציית חסימת Auth.

הקלד כינויים

הקלד כינוי	תיאור
מידע על משתמש	UserInfo שהוא חלק מה- UserRecord .
UserRecord	UserRecord המועבר ל-Cloud Functions הוא אותו UserRecord שמוחזר על ידי Firebase Admin SDK.

auth.user()

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

חֲתִימָה:

export declare function user(userOptions?: UserOptions): UserBuilder;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
אפשרויות משתמש	אפשרויות משתמש	אפשרויות ברמת המשאב

החזרות:

UserBuilder

UserBuilder - Builder המשמש ליצירת פונקציות עבור אירועי מחזור חיים של משתמש Firebase Auth

auth.userRecordConstructor()

פונקציית עוזר שיוצרת מחלקה UserRecord מנתונים שנשלחו דרך החוט.

חֲתִימָה:

export declare function userRecordConstructor(wireData: Record<string, unknown>): UserRecord;

פרמטרים

פָּרָמֶטֶר	סוּג	תיאור
wireData	הקלט<string, unknown>	נתונים שנשלחו דרך החוט

החזרות:

UserRecord

מופע של UserRecord עם פונקציות toJSON נכונות

auth.UserInfo

UserInfo שהוא חלק מה- UserRecord .

חֲתִימָה:

export type UserInfo = auth.UserInfo;

auth.UserRecord

UserRecord המועבר ל-Cloud Functions הוא אותו UserRecord שמוחזר על ידי Firebase Admin SDK.

חֲתִימָה:

export type UserRecord = auth.UserRecord;