Auth interface

رابط نشان دهنده سرویس Firebase Auth.

برای راهنمای کامل نحوه استفاده از سرویس Firebase Auth به احراز هویت Firebase مراجعه کنید.

امضا:

export interface Auth

خواص

ویژگی تایپ کنید شرح
برنامه Firebase App FirebaseApp مرتبط با نمونه سرویس Auth .
پیکربندی پیکربندی Config برای مقداردهی اولیه این نمونه استفاده می شود.
کاربر فعلی کاربر | خالی کاربر وارد شده در حال حاضر (یا تهی).
emulatorConfig EmulatorConfig | خالی پیکربندی شبیه ساز فعلی (یا تهی).
کد زبان رشته | خالی کد زبان نمونه Auth .
نام رشته نام برنامه مرتبط با نمونه سرویس Auth .
تنظیمات AuthSettings تنظیمات نمونه Auth .
شناسه مستاجر رشته | خالی شناسه مستاجر نمونه Auth .

مواد و روش ها

روش شرح
authStateReady() وعده ای را برمی گرداند که بلافاصله پس از تسویه حالت تأیید اولیه برطرف می شود. وقتی وعده حل شد، کاربر فعلی ممکن است یک کاربر معتبر باشد یا اگر کاربر از سیستم خارج شود null .
beforeAuthStateChanged (بازگشت به تماس، onAbort) یک تماس مسدودکننده اضافه می‌کند که قبل از تغییر وضعیت احراز هویت یک کاربر جدید را اجرا می‌کند.
onAuthStateChanged(nextOrObserver، خطا، تکمیل شد) یک ناظر برای تغییرات در وضعیت ورود به سیستم کاربر اضافه می کند.
onIdTokenChanged(nextOrObserver، خطا، تکمیل شد) یک ناظر برای تغییرات به شناسه شناسه کاربر وارد شده اضافه می کند.
setPersistence (تداوم) نوع ماندگاری را در نمونه Auth تغییر می‌دهد.
خروج از سیستم() کاربر فعلی را از سیستم خارج می کند. این به طور خودکار نشان ID کاربر را باطل نمی کند.
updateCurrentUser(کاربر) به طور ناهمزمان کاربر ارائه شده را به عنوان Auth.currentUser در نمونه Auth تنظیم می کند.
useDeviceLanguage() زبان فعلی را روی تنظیمات پیش‌فرض دستگاه/مرورگر تنظیم می‌کند.

Auth.app

FirebaseApp مرتبط با نمونه سرویس Auth .

امضا:

readonly app: FirebaseApp;

Auth.config

Config برای مقداردهی اولیه این نمونه استفاده می شود.

امضا:

readonly config: Config;

Auth.currentUser

کاربر وارد شده در حال حاضر (یا تهی).

امضا:

readonly currentUser: User | null;

Auth.emulatorConfig

پیکربندی شبیه ساز فعلی (یا تهی).

امضا:

readonly emulatorConfig: EmulatorConfig | null;

Auth.languageCode

کد زبان نمونه Auth .

این یک ویژگی قابل خواندن/نوشتن است. وقتی روی null تنظیم شود، تنظیمات زبان Firebase Console پیش‌فرض اعمال می‌شود. کد زبان به الگوهای اقدام ایمیل (بازنشانی رمز عبور، تأیید ایمیل و لغو تغییر ایمیل)، الگوهای پیامک برای احراز هویت تلفن، تأییدکننده reCAPTCHA و عملیات بازشو/تغییر مسیر OAuth منتشر می شود، مشروط بر اینکه ارائه دهندگان مشخص شده از محلی سازی با کد زبان مشخص شده پشتیبانی کنند.

امضا:

languageCode: string | null;

Auth.name

نام برنامه مرتبط با نمونه سرویس Auth .

امضا:

readonly name: string;

Auth.settings

تنظیمات نمونه Auth .

این برای ویرایش/خواندن گزینه‌های مرتبط با پیکربندی مانند حالت تأیید برنامه برای احراز هویت تلفن استفاده می‌شود.

امضا:

readonly settings: AuthSettings;

Auth.tenantId

شناسه مستاجر نمونه Auth .

این یک ویژگی قابل خواندن/نوشتن است. وقتی شناسه مستاجر یک نمونه Auth را تنظیم می‌کنید، تمام عملیات ورود/ثبت‌نام آینده، این شناسه مستاجر را منتقل می‌کند و کاربران را در پروژه مستاجر مشخص‌شده وارد یا ثبت‌نام می‌کند. وقتی روی null تنظیم شود، کاربران وارد پروژه والد می شوند.

امضا:

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 .

امضا:

authStateReady(): Promise<void>;

برمی‌گرداند:

قول<باطل>

Auth.beforeAuthStateChanged()

یک تماس مسدودکننده اضافه می‌کند که قبل از تغییر وضعیت احراز هویت یک کاربر جدید را اجرا می‌کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
پاسخ به تماس (کاربر: کاربر | null) => void | قول<باطل> قبل از تنظیم مقدار کاربر جدید، پاسخ تماس آغاز شد. اگر این پرتاب شود، کاربر را از تنظیم مسدود می کند.
onAbort () => باطل در صورتی که بعداً beforeAuthStateChanged() پاسخ تماس برقرار شود، به شما امکان می دهد هر گونه عوارض جانبی را لغو کنید.

برمی‌گرداند:

لغو اشتراک

Auth.onAuthStateChanged()

یک ناظر برای تغییرات در وضعیت ورود به سیستم کاربر اضافه می کند.

برای حفظ رفتار قدیمی، به Auth.onIdTokenChanged() مراجعه کنید. .

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
nextOrObserver NextOrObserver < کاربر | null> پاسخ تماس با تغییر فعال شد.
خطا ErrorFn منسوخ. این تماس برگشتی هرگز راه اندازی نمی شود. خطاهای مربوط به ورود/خروج می‌تواند در وعده‌های بازگردانده شده از توابع ورود/خروج مشاهده شود.
تکمیل شد CompleteFn منسوخ. این تماس برگشتی هرگز راه اندازی نمی شود.

برمی‌گرداند:

لغو اشتراک

Auth.onIdTokenChanged()

یک ناظر برای تغییرات به شناسه شناسه کاربر وارد شده اضافه می کند.

این شامل رویدادهای ورود به سیستم، خروج از سیستم و به‌روزرسانی نشانه است.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
nextOrObserver NextOrObserver < کاربر | null> پاسخ تماس با تغییر فعال شد.
خطا ErrorFn منسوخ. این تماس برگشتی هرگز راه اندازی نمی شود. خطاهای مربوط به ورود/خروج می‌تواند در وعده‌های بازگردانده شده از توابع ورود/خروج مشاهده شود.
تکمیل شد CompleteFn منسوخ. این تماس برگشتی هرگز راه اندازی نمی شود.

برمی‌گرداند:

لغو اشتراک

Auth.setPersistence()

نوع ماندگاری را در نمونه Auth تغییر می‌دهد.

این روی جلسه Auth ذخیره‌شده فعلی تأثیر می‌گذارد و این نوع ماندگاری را برای درخواست‌های ورود به سیستم آینده، از جمله ورود به سیستم با درخواست‌های تغییر مسیر، اعمال می‌کند.

این امر باعث می‌شود کاربر با ورود به سیستم، تعیین کند که آیا جلسه خود را باید به خاطر بسپارد یا خیر. همچنین حفظ وضعیت Auth را برای برنامه هایی که توسط سایر کاربران به اشتراک گذاشته می شوند یا داده های حساسی دارند آسان تر می کند.

این روش در محیط Node.js کار نمی کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
ماندگاری ماندگاری پایداری برای استفاده

برمی‌گرداند:

قول<باطل>

مثال

auth.setPersistence(browserSessionPersistence);

Auth.signOut()

کاربر فعلی را از سیستم خارج می کند. این به طور خودکار نشان ID کاربر را باطل نمی کند.

این روش توسط نمونه‌های Auth ایجاد شده با FirebaseServerApp پشتیبانی نمی‌شود .

امضا:

signOut(): Promise<void>;

برمی‌گرداند:

قول<باطل>

Auth.updateCurrentUser()

به طور ناهمزمان کاربر ارائه شده را به عنوان Auth.currentUser در نمونه Auth تنظیم می کند.

یک کپی نمونه جدید از کاربر ارائه شده ساخته می شود و به عنوان فعلی کاربر تنظیم می شود.

این کار شنوندگان Auth.onAuthStateChanged() و Auth.onIdTokenChanged() را مانند سایر روش های ورود به سیستم فعال می کند.

اگر کاربری که به‌روزرسانی می‌شود متعلق به پروژه Firebase دیگری باشد، عملیات با خطا انجام نمی‌شود.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
کاربر کاربر | خالی کاربر جدید .

برمی‌گرداند:

قول<باطل>

Auth.useDeviceLanguage()

زبان فعلی را روی تنظیمات پیش‌فرض دستگاه/مرورگر تنظیم می‌کند.

امضا:

useDeviceLanguage(): void;

برمی‌گرداند:

خالی