auth namespace

کارکرد

تابع شرح
کاربر (گزینه های کاربر) رویدادهای مربوط به رویدادهای کاربران Firebase Auth را مدیریت می کند.
userRecordConstructor(wireData) تابع Helper که یک کلاس UserRecord از داده های ارسال شده از طریق سیم ایجاد می کند.

کلاس ها

کلاس شرح
HttpsError یک خطای صریح که می تواند از یک کنترل کننده برای ارسال خطایی به کلاینتی که تابع را فراخوانی می کند، پرتاب شود.
UserBuilder سازنده برای ایجاد توابع برای رویدادهای چرخه عمر کاربر Firebase Auth استفاده می‌شود.
UserRecord Metadata کلاس Helper برای ایجاد ابرداده کاربر در یک شی UserRecord .

رابط ها

رابط شرح
UserOptions گزینه هایی برای عملکرد مسدودسازی Auth.

نام مستعار را تایپ کنید

نام مستعار را تایپ کنید شرح
اطلاعات کاربر UserInfo که بخشی از UserRecord است.
UserRecord UserRecord ارسال شده به Cloud Functions همان UserRecord است که توسط Firebase Admin SDK بازگردانده می شود.

auth.user()

رویدادهای مربوط به رویدادهای کاربران Firebase Auth را مدیریت می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
userOptions UserOptions گزینه های سطح منابع

برمی گرداند:

UserBuilder

UserBuilder - سازنده برای ایجاد توابع برای رویدادهای چرخه عمر کاربر Firebase Auth استفاده می شود

auth.userRecordConstructor()

تابع Helper که یک کلاس UserRecord از داده های ارسال شده از طریق سیم ایجاد می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
wireData ضبط <رشته، ناشناخته> داده های ارسال شده از طریق سیم

برمی گرداند:

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;