auth package

احراز هویت Firebase

کارکرد

کلاس ها

رابط ها

متغیرها

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

عملکرد (برنامه، ...)

getAuth (برنامه)

نمونه Auth مرتبط با FirebaseApp ارائه شده را برمی گرداند . اگر هیچ نمونه ای وجود نداشته باشد، یک نمونه Auth با وابستگی های پیش فرض خاص پلت فرم را مقداردهی اولیه می کند.

امضا:

export declare function getAuth(app?: FirebaseApp): Auth;

مولفه های

برمی گرداند:

احراز هویت

InitializeAuth (برنامه، deps)

یک نمونه Auth را با کنترل دقیق بر روی Dependencies راه اندازی می کند .

این تابع اجازه می دهد تا کنترل بیشتری بر روی نمونه Auth نسبت به getAuth() داشته باشید. . getAuth از پیش‌فرض‌های مخصوص پلتفرم برای تامین وابستگی‌ها استفاده می‌کند . به طور کلی، getAuth ساده ترین راه برای مقداردهی اولیه Auth است و برای اکثر موارد استفاده کار می کند. اگر نیاز به کنترل روی لایه‌های ماندگاری استفاده شده دارید از initializeAuth استفاده کنید، یا اگر از signInWithPopup یا signInWithRedirect استفاده نمی‌کنید، اندازه بسته را به حداقل برسانید. .

به عنوان مثال، اگر برنامه شما فقط از حساب‌های ناشناس استفاده می‌کند و فقط می‌خواهید حساب‌هایی را برای جلسه جاری ذخیره کنید، Auth را با:

const auth = initializeAuth(app, {
  persistence: browserSessionPersistence,
  popupRedirectResolver: undefined,
});

امضا:

export declare function initializeAuth(app: FirebaseApp, deps?: Dependencies): Auth;

مولفه های

برمی گرداند:

احراز هویت

عملکرد (ذخیره، ...)

getReactNativePersistence (ذخیره‌سازی)

یک شیء پایدار را برمی‌گرداند که AsyncStorage وارد شده از react-native یا @react-native-community/async-storage را می‌پوشاند. ، و می تواند در فیلد وابستگی ماندگاری در initializeAuth() استفاده شود .

امضا:

export declare function getReactNativePersistence(storage: ReactNativeAsyncStorage): Persistence;

مولفه های

برمی گرداند:

ماندگاری

تابع (auth، ...)

applicationActionCode (auth، oobCode)

یک کد تأیید را اعمال می کند که از طریق ایمیل یا مکانیسم های خارج از باند دیگر برای کاربر ارسال شده است.

امضا:

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

مولفه های

برمی گرداند:

قول<باطل>

beforeAuthStateChanged (auth، callback، onAbort)

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

امضا:

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

مولفه های

برمی گرداند:

لغو اشتراک

checkActionCode (auth، oobCode)

کد تأیید ارسال شده به کاربر از طریق ایمیل یا مکانیسم های خارج از باند را بررسی می کند.

امضا:

export declare function checkActionCode(auth: Auth, oobCode: string): Promise<ActionCodeInfo>;

مولفه های

برمی گرداند:

Promise< ActionCodeInfo >

ابرداده در مورد کد

confirmPasswordReset (auth، oobCode، newPassword)

با دادن کد تایید و رمز عبور جدید، فرآیند بازنشانی رمز عبور را تکمیل می کند.

امضا:

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

مولفه های

برمی گرداند:

قول<باطل>

connectAuthEmulator (auth، url، گزینه ها)

نمونه Auth را برای برقراری ارتباط با Firebase Auth Emulator به جای تولید خدمات Firebase Auth تغییر می‌دهد.

این باید بلافاصله پس از اولین فراخوانی برای InitializeAuth() به صورت همزمان فراخوانی شود. . با اعتبار تولید استفاده نکنید زیرا ترافیک شبیه ساز رمزگذاری نشده است.

امضا:

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

مولفه های

برمی گرداند:

خالی

مثال

connectAuthEmulator(auth, 'http://127.0.0.1:9099', { disableWarnings: true });

createUserWithEmailAndPassword (تأثیر، ایمیل، رمز عبور)

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

با ایجاد موفقیت آمیز حساب کاربری، این کاربر نیز به برنامه شما وارد می شود.

اگر حساب کاربری از قبل وجود داشته باشد یا رمز عبور نامعتبر باشد، ایجاد حساب کاربری ممکن است با شکست مواجه شود.

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

امضا:

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

مولفه های

برمی گرداند:

Promise< UserCredential >

fetchSignInMethodsForEmail (auth، ایمیل)

لیستی از روش های احتمالی ورود به سیستم را برای آدرس ایمیل داده شده دریافت می کند. این روش زمانی که [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) فعال باشد، یک لیست خالی برمی گرداند، صرف نظر از تعداد روش های احراز هویت موجود برای ایمیل داده شده

این برای متمایز کردن روش های ورود به سیستم برای همان ارائه دهنده مفید است، به عنوان مثال. EmailAuthProvider که دارای 2 روش ورود به سیستم، SignInMethod است .EMAIL_PASSWORD و SignInMethod .EMAIL_LINK.

امضا:

export declare function fetchSignInMethodsForEmail(auth: Auth, email: string): Promise<string[]>;

مولفه های

برمی گرداند:

قول<string[]>

getMultiFactorResolver (auth, error)

یک MultiFactorResolver مناسب برای تکمیل یک جریان چند عاملی ارائه می دهد.

امضا:

export declare function getMultiFactorResolver(auth: Auth, error: MultiFactorError): MultiFactorResolver;

مولفه های

برمی گرداند:

MultiFactorResolver

getRedirectResult (تأثیر، حل‌کننده)

یک UserCredential را از جریان ورود به سیستم مبتنی بر تغییر مسیر برمی‌گرداند.

اگر ورود به سیستم با موفقیت انجام شد، کاربر وارد شده را برمی‌گرداند. اگر ورود به سیستم ناموفق بود، با خطا ناموفق بود. اگر عملیات تغییر مسیر فراخوانی نشد، null را برمی‌گرداند .

این روش در محیط Node.js یا با نمونه های Auth ایجاد شده با FirebaseServerApp کار نمی کند. .

امضا:

export declare function getRedirectResult(auth: Auth, resolver?: PopupRedirectResolver): Promise<UserCredential | null>;

مولفه های

برمی گرداند:

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 باید برای هر ارائه‌دهنده تأییدیه فعال شود، در جلسه تأیید فعلی بارگیری می‌شود.

اگر ()initializeRecaptchaConfig فراخوانی نشود، جریان تأیید همیشه بدون تأیید reCAPTCHA شروع می شود. اگر ارائه‌دهنده به گونه‌ای پیکربندی شده باشد که به تأیید reCAPTCHA نیاز داشته باشد، SDK به‌طور شفاف پیکربندی reCAPTCHA را بارگیری می‌کند و جریان‌های تأیید را مجدداً راه‌اندازی می‌کند.

بنابراین، با فراخوانی این روش اختیاری، تاخیر جریان های اعتبارسنجی آینده را کاهش می دهید. بارگیری زودهنگام پیکربندی reCAPTCHA باعث افزایش سیگنال جمع آوری شده توسط reCAPTCHA نیز می شود.

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

امضا:

export declare function initializeRecaptchaConfig(auth: Auth): Promise<void>;

مولفه های

برمی گرداند:

قول<باطل>

مثال

initializeRecaptchaConfig(auth);

isSignInWithEmailLink (auth، emailLink)

بررسی می کند که آیا یک پیوند ورودی یک ورود به سیستم با پیوند ایمیل مناسب برای signInWithEmailLink () است یا خیر. .

امضا:

export declare function isSignInWithEmailLink(auth: Auth, emailLink: string): boolean;

مولفه های

برمی گرداند:

بولی

onAuthStateChanged(auth، nextOrObserver، خطا، تکمیل شد)

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

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

امضا:

export declare function onAuthStateChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

مولفه های

برمی گرداند:

لغو اشتراک

onIdTokenChanged (auth، nextOrObserver، خطا، تکمیل شد)

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

این شامل رویدادهای ورود به سیستم، خروج از سیستم و به‌روزرسانی نشانه است. پس از انقضای رمز ID، این به طور خودکار فعال نمی شود. از User.getIdToken() برای رفرش شناسه استفاده کنید.

امضا:

export declare function onIdTokenChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

مولفه های

برمی گرداند:

لغو اشتراک

revokeAccessToken (auth, token)

نشانه دسترسی داده شده را باطل می کند. در حال حاضر فقط از توکن های دسترسی Apple OAuth پشتیبانی می کند.

امضا:

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

مولفه های

برمی گرداند:

قول<باطل>

sendPasswordResetEmail (Auth، ایمیل، actionCodeSettings)

یک ایمیل بازنشانی رمز عبور به آدرس ایمیل داده شده ارسال می کند. این روش وقتی هیچ حساب کاربری با آدرس ایمیل داده شده وجود نداشته باشد و [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) فعال باشد، خطایی ایجاد نمی کند. .

برای تکمیل بازنشانی رمز عبور، با کد ارسال شده در ایمیل ارسال شده به کاربر، به همراه رمز عبور جدید مشخص شده توسط کاربر، با confirmPasswordReset() تماس بگیرید.

امضا:

export declare function sendPasswordResetEmail(auth: Auth, email: string, 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، ایمیل، actionCodeSettings)

یک لینک ایمیل ورود به سیستم را با ایمیل مشخص شده برای کاربر ارسال می کند.

عملیات ورود به سیستم برخلاف سایر اقدامات ایمیل خارج از باند (بازنشانی رمز عبور و تأیید ایمیل) باید همیشه در برنامه تکمیل شود. این به این دلیل است که در پایان جریان، انتظار می رود کاربر وارد سیستم شود و وضعیت Auth او در برنامه باقی بماند.

برای تکمیل ورود به سیستم با پیوند ایمیل، signInWithEmailLink() را با آدرس ایمیل و پیوند ایمیل ارائه شده در ایمیل ارسال شده به کاربر تماس بگیرید.

امضا:

export declare function sendSignInLinkToEmail(auth: Auth, email: string, 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 کار نمی کند. .

امضا:

export declare function setPersistence(auth: Auth, persistence: Persistence): Promise<void>;

مولفه های

برمی گرداند:

قول<باطل>

Promise که پس از تکمیل تغییر پایدار حل می شود

مثال

setPersistence(auth, browserSessionPersistence);

signInAnonymously (auth)

به صورت ناهمزمان به عنوان یک کاربر ناشناس وارد سیستم می شود.

اگر قبلاً یک کاربر ناشناس وارد شده باشد، آن کاربر برگردانده خواهد شد. در غیر این صورت، یک هویت کاربر ناشناس جدید ایجاد و بازگردانده می شود.

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

امضا:

export declare function signInAnonymously(auth: Auth): Promise<UserCredential>;

مولفه های

برمی گرداند:

Promise< UserCredential >

signInWithCredential (معتبر، اعتبار)

به صورت ناهمزمان با اعتبار داده شده وارد می شود.

برای تولید اعتبار می توان از AuthProvider استفاده کرد.

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

امضا:

export declare function signInWithCredential(auth: Auth, credential: AuthCredential): Promise<UserCredential>;

مولفه های

برمی گرداند:

Promise< UserCredential >

signInWithCustomToken (auth، customToken)

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

توکن‌های سفارشی برای ادغام Firebase Auth با سیستم‌های احراز هویت موجود استفاده می‌شوند و باید توسط یک پشتیبان تأیید با استفاده از روش createCustomToken در Admin SDK تولید شوند.

اگر توکن نامعتبر باشد، منقضی شده باشد یا توسط سرویس Firebase Auth پذیرفته نشود، با خطا مواجه می شود.

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

امضا:

export declare function signInWithCustomToken(auth: Auth, customToken: string): Promise<UserCredential>;

مولفه های

برمی گرداند:

Promise< UserCredential >

signInWithEmailAndPassword (تأثیر، ایمیل، رمز عبور)

به صورت ناهمزمان با استفاده از ایمیل و رمز عبور وارد سیستم می شود.

اگر آدرس ایمیل و رمز عبور مطابقت نداشته باشند، با خطا مواجه می شود. هنگامی که [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) فعال است، در صورت نامعتبر بودن، این روش با "auth/invalid-credential" ناموفق است. رمز ایمیل.

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

امضا:

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

مولفه های

برمی گرداند:

Promise< UserCredential >

signInWithEmailLink (تأثیر، ایمیل، پیوند ایمیل)

به صورت ناهمزمان با استفاده از ایمیل و پیوند ایمیل ورود به سیستم وارد سیستم می شود.

اگر هیچ پیوندی ارسال نشود، پیوند از URL فعلی استنباط می شود.

اگر آدرس ایمیل نامعتبر باشد یا OTP در پیوند ایمیل منقضی شود، با خطا مواجه می شود.

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

امضا:

export declare function signInWithEmailLink(auth: Auth, email: string, emailLink?: string): Promise<UserCredential>;

مولفه های

برمی گرداند:

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)

به صورت ناهمزمان با استفاده از شماره تلفن وارد سیستم می شود.

این روش یک کد از طریق پیامک به شماره تلفن داده شده ارسال می کند و یک ConfirmationResult برمی گرداند . پس از اینکه کاربر کد ارسال شده به تلفن خود را ارائه کرد، با کد ConfirmationResult.confirm () تماس بگیرید تا کاربر وارد شود.

برای پیشگیری از سوء استفاده، این روش به ApplicationVerifier نیز نیاز دارد . این SDK شامل یک پیاده سازی مبتنی بر reCAPTCHA، RecaptchaVerifier است . این تابع می‌تواند روی پلتفرم‌های دیگری که RecaptchaVerifier را پشتیبانی نمی‌کنند (مانند React Native) کار کند، اما شما باید از پیاده‌سازی ApplicationVerifier شخص ثالث استفاده کنید.

این روش در محیط Node.js یا با نمونه های Auth ایجاد شده با FirebaseServerApp کار نمی کند. .

امضا:

export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

مولفه های

برمی گرداند:

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 (تأیید کننده، ارائه دهنده، حل کننده)

یک کلاینت Firebase را با استفاده از یک جریان تأیید اعتبار OAuth مبتنی بر پنجره بازشو تأیید می کند.

در صورت موفقیت آمیز بودن، کاربر وارد شده به سیستم را همراه با اعتبار ارائه دهنده برمی گرداند. اگر ورود ناموفق بود، یک شی خطا حاوی اطلاعات اضافی درباره خطا را برمی‌گرداند.

این روش در محیط Node.js یا با نمونه های Auth ایجاد شده با FirebaseServerApp کار نمی کند. .

امضا:

export declare function signInWithPopup(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

مولفه های

برمی گرداند:

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، ارائه دهنده، حل کننده)

یک کلاینت Firebase را با استفاده از یک جریان تغییر مسیر تمام صفحه تأیید می کند.

برای رسیدگی به نتایج و خطاهای این عملیات، به getRedirectResult() مراجعه کنید. . هنگام استفاده از signInWithRedirect() بهترین شیوه ها را دنبال کنید .

این روش در محیط Node.js یا با نمونه های Auth ایجاد شده با FirebaseServerApp کار نمی کند. .

امضا:

export declare function signInWithRedirect(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

مولفه های

برمی گرداند:

قول <هرگز>

مثال

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

خروج از سیستم (auth)

کاربر فعلی را از سیستم خارج می کند.

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

امضا:

export declare function signOut(auth: Auth): Promise<void>;

مولفه های

برمی گرداند:

قول<باطل>

updateCurrentUser (auth، کاربر)

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

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

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

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

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

امضا:

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

مولفه های

برمی گرداند:

قول<باطل>

useDeviceLanguage (auth)

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

امضا:

export declare function useDeviceLanguage(auth: Auth): void;

مولفه های

برمی گرداند:

خالی

validatePassword (حقوق، رمز عبور)

رمز عبور را در برابر خط مشی رمز عبور پیکربندی شده برای پروژه یا مستاجر اعتبار سنجی می کند.

اگر هیچ شناسه مستاجر روی نمونه Auth تنظیم نشده باشد، این روش از خط مشی رمز عبور پیکربندی شده برای پروژه استفاده می کند. در غیر این صورت، این روش از سیاست تنظیم شده برای مستاجر استفاده می کند. اگر خط مشی رمز عبور پیکربندی نشده باشد، از خط مشی پیش فرض پیکربندی شده برای همه پروژه ها استفاده خواهد شد.

اگر یک جریان احراز هویت ناموفق باشد زیرا رمز عبور ارسال شده الزامات خط مشی رمز عبور را برآورده نمی کند و این روش قبلاً فراخوانی شده است، این روش از آخرین خط مشی موجود در هنگام فراخوانی مجدد استفاده می کند.

امضا:

export declare function validatePassword(auth: Auth, password: string): Promise<PasswordValidationStatus>;

مولفه های

برمی گرداند:

Promise< PasswordValidationStatus >

مثال

validatePassword(auth, 'some-password');

verifyPasswordResetCode (auth, code)

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

امضا:

export declare function verifyPasswordResetCode(auth: Auth, code: string): Promise<string>;

مولفه های

برمی گرداند:

قول<رشته>

آدرس ایمیل کاربر در صورت معتبر بودن

تابع (لینک، ...)

parseActionCodeURL(پیوند)

رشته پیوند اقدام ایمیل را تجزیه می کند و در صورت معتبر بودن پیوند، یک ActionCodeURL را برمی گرداند، در غیر این صورت null را برمی گرداند.

امضا:

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

مولفه های

برمی گرداند:

ActionCodeURL | خالی

تابع (کاربر، ...)

حذف کاربر (کاربر)

کاربر را حذف و از سیستم خارج می کند.

امضا:

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

مولفه های

برمی گرداند:

قول<باطل>

getIdToken (کاربر، forceRefresh)

یک رمز وب JSON (JWT) که برای شناسایی کاربر استفاده می‌شود را به سرویس Firebase برمی‌گرداند.

اگر توکن فعلی منقضی نشده باشد یا در پنج دقیقه آینده منقضی نشود، آن را برمی‌گرداند. در غیر این صورت، این توکن را تازه می کند و یک توکن جدید برمی گرداند.

امضا:

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

مولفه های

برمی گرداند:

قول<رشته>

getIdTokenResult (کاربر، forceRefresh)

یک توکن وب JSON (JWT) که برای شناسایی کاربر استفاده می‌شود را به سرویس Firebase برمی‌گرداند.

اگر توکن فعلی منقضی نشده باشد یا در پنج دقیقه آینده منقضی نشود، آن را برمی‌گرداند. در غیر این صورت، این توکن را تازه می کند و یک توکن جدید برمی گرداند.

امضا:

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

مولفه های

برمی گرداند:

Promise< IdTokenResult >

linkWithCredential (کاربر، اعتبار)

حساب کاربری را با اعتبار داده شده پیوند می دهد.

برای تولید اعتبار می توان از AuthProvider استفاده کرد.

امضا:

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

مولفه های

برمی گرداند:

Promise< UserCredential >

linkWithPhoneNumber (کاربر، شماره تلفن، تأییدکننده برنامه)

حساب کاربری را با شماره تلفن داده شده پیوند می دهد.

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

امضا:

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

مولفه های

برمی گرداند:

Promise< ConfirmationResult >

linkWithPopup (کاربر، ارائه دهنده، حل کننده)

ارائه دهنده احراز هویت شده را با استفاده از یک جریان OAuth مبتنی بر پاپ آپ به حساب کاربری پیوند می دهد.

در صورت موفقیت آمیز بودن پیوند، نتیجه بازگشتی شامل اعتبار کاربر و ارائه دهنده خواهد بود.

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

امضا:

export declare function linkWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

مولفه های

برمی گرداند:

وعده < 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 (کاربر ، ارائه دهنده ، حل کننده)

OAuthProvider را با استفاده از یک جریان تغییر مسیر تمام صفحه به حساب کاربری پیوند می دهد.

برای رسیدگی به نتایج و خطاهای این عمل ، به getRedirectresult مراجعه کنید () . بهترین روشها را هنگام استفاده از LinkWithRedirect دنبال کنید () .

این روش در یک محیط Node.js یا با موارد AUT که با FirebaseServerapp ایجاد شده است کار نمی کند .

امضا:

export declare function linkWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

مولفه های

برمی گرداند:

وعده <هرگز>

مثال

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

چند عاملی (کاربر)

چند عیار مربوط به کاربر.

این برای دسترسی به کلیه خصوصیات و عملیات چند عاملی مربوط به کاربر استفاده می شود.

امضا:

export declare function multiFactor(user: User): MultiFactorUser;

مولفه های

برمی گرداند:

چند عامل

uthententicateWithCredential (کاربر ، اعتبارنامه)

کاربر را با استفاده از یک اعتبار تازه دوباره تأیید می کند.

قبل از عملیات مانند UpdatePassword () که به نشانه های ورود به سیستم اخیر نیاز دارند ، استفاده کنید. از این روش می توان برای بازیابی از خطای CREDENTIAL_TOO_OLD_LOGIN_AGAIN یا خطای TOKEN_EXPIRED استفاده کرد.

این روش در هیچ کاربر امضا شده توسط موارد AUTH ایجاد شده با FirebaseServerapp پشتیبانی نمی شود .

امضا:

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

مولفه های

برمی گرداند:

وعده < userCredential >

AuthentIctitWithPhonEnumber (کاربر ، phonenumber ، appverifer)

کاربر را با استفاده از اعتبار تلفن تازه مجدداً تأیید می کند.

قبل از عملیات مانند UpdatePassword () که به نشانه های ورود به سیستم اخیر نیاز دارند ، استفاده کنید.

این روش در یک محیط Node.js یا در هر کاربر امضا شده توسط موارد AUTH ایجاد شده با FirebaseServerapp کار نمی کند .

امضا:

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

مولفه های

برمی گرداند:

وعده < تأییدیه >

AuthentIcateWithPopup (کاربر ، ارائه دهنده ، حل کننده)

کاربر فعلی را با استفاده از OAuthProvider مشخص شده با استفاده از یک جریان OAUTH مبتنی بر پاپ آپ مجدداً تأیید می کند.

اگر تأیید مجدد موفقیت آمیز باشد ، نتیجه برگشتی شامل کاربر و اعتبار ارائه دهنده خواهد بود.

این روش در یک محیط Node.js یا در هر کاربر امضا شده توسط موارد AUTH ایجاد شده با FirebaseServerapp کار نمی کند .

امضا:

export declare function reauthenticateWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

مولفه های

برمی گرداند:

وعده < 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);

AuthentIctitWithDirect (کاربر ، ارائه دهنده ، حل کننده)

کاربر فعلی را با استفاده از OAuthProvider مشخص شده با استفاده از یک جریان تغییر مسیر تمام صفحه ، مجدداً تأیید می کند.

برای رسیدگی به نتایج و خطاهای این عمل ، به getRedirectresult مراجعه کنید () . بهترین روشها را هنگام استفاده از مجدداً با retentiCtitTithRedirect دنبال کنید () .

این روش در یک محیط Node.js یا با موارد AUT که با FirebaseServerapp ایجاد شده است کار نمی کند .

امضا:

export declare function reauthenticateWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

مولفه های

برمی گرداند:

وعده <هرگز>

مثال

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

بارگیری مجدد (کاربر)

در صورت ورود به سیستم ، داده های حساب کاربری را بارگیری مجدد کنید.

امضا:

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

مولفه های

برمی گرداند:

قول<باطل>

SendemailVerification (کاربر ، ActionCodesettings)

یک ایمیل تأیید را به کاربر ارسال می کند.

فرآیند تأیید با فراخوانی Apply ActionActionCode () تکمیل می شود .

امضا:

export declare function sendEmailVerification(user: User, actionCodeSettings?: ActionCodeSettings | null): 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);

inlink (کاربر ، ارائه دهنده)

یک ارائه دهنده را از یک حساب کاربری جدا کنید.

امضا:

export declare function unlink(user: User, providerId: string): Promise<User>;

مولفه های

برمی گرداند:

وعده < کاربر >

UpdateMail (کاربر ، NewEmail)

آدرس ایمیل کاربر را به روز می کند.

یک ایمیل به آدرس ایمیل اصلی (در صورت تنظیم) ارسال می شود که اجازه می دهد تغییر آدرس ایمیل را لغو کند ، تا بتواند آنها را از ربودن حساب محافظت کند.

این روش در هیچ کاربر امضا شده توسط موارد AUTH ایجاد شده با FirebaseServerapp پشتیبانی نمی شود .

امضا:

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

مولفه های

برمی گرداند:

قول<باطل>

UpdatePassword (کاربر ، NewPassword)

رمز ورود کاربر را به روز می کند.

امضا:

export declare function updatePassword(user: User, newPassword: string): Promise<void>;

مولفه های

برمی گرداند:

قول<باطل>

UpdatePhonEnumber (کاربر ، اعتبارنامه)

شماره تلفن کاربر را به روز می کند.

این روش در یک محیط Node.js یا در هر کاربر امضا شده توسط موارد AUTH ایجاد شده با FirebaseServerapp کار نمی کند .

امضا:

export declare function updatePhoneNumber(user: User, credential: 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 (کاربر ، {DisplayName ، Photourl: Photourl})

داده های پروفایل کاربر را به روز می کند.

امضا:

export declare function updateProfile(user: User, { displayName, photoURL: photoUrl }: {
    displayName?: string | null;
    photoURL?: string | null;
}): Promise<void>;

مولفه های

برمی گرداند:

قول<باطل>

VerifyBeforeUpdateEmail (کاربر ، NewEmail ، ActionCodesettings)

یک ایمیل تأیید را به یک آدرس ایمیل جدید ارسال می کند.

ایمیل کاربر پس از تأیید به روز جدید به روز می شود.

اگر یک کنترل کننده اقدام به ایمیل سفارشی دارید ، می توانید با فراخوانی ApplyActionCode () فرآیند تأیید را انجام دهید () .

امضا:

export declare function verifyBeforeUpdateEmail(user: User, newEmail: string, actionCodeSettings?: ActionCodeSettings | null): 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);

تابع (UserCredential ، ...)

GetAdditionSerinfo (UserCredential)

Extracts ارائه دهنده اضافی اضافی برای اعتبار داده شده.

امضا:

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

مولفه های

برمی گرداند:

Extra uSerinfo | خالی

عمل کدگذاری

شمارش انواع اقدامات احتمالی ایمیل.

امضا:

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

دارایی

نقشه ای از کدهای خطای Auth بالقوه ، برای مقایسه آسان تر با خطاهای پرتاب شده توسط SDK.

توجه داشته باشید که شما نمی توانید کلیدهای جداگانه در نقشه را در نقشه قرار دهید ، بنابراین با استفاده از نقشه ممکن است به میزان قابل توجهی اندازه بسته نرم افزاری خود را افزایش دهید.

امضا:

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

مرورگر

اجرای تداوم نوع LOCAL با استفاده از localStorage برای ذخیره سازی زیربنایی.

امضا:

browserLocalPersistence: Persistence

مرورگر

اجرای Popupredirectresolver مناسب برای برنامه های مبتنی بر مرورگر.

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

امضا:

browserPopupRedirectResolver: PopupRedirectResolver

مرورگر

اجرای تداوم SESSION با استفاده از sessionStorage برای ذخیره سازی اساسی.

امضا:

browserSessionPersistence: Persistence

Cordovapopupredirectresolver

اجرای Popupredirectresolver مناسب برای برنامه های مبتنی بر کوردووا.

امضا:

cordovaPopupRedirectResolver: PopupRedirectResolver

اشکال اشکال زدایی

نقشه خطای کلامی با توضیحات مفصل برای بیشتر کدهای خطا.

بحث را در AutherRormap مشاهده کنید

امضا:

debugErrorMap: AuthErrorMap

عارضه

عکسبرداری از عواملی که ممکن است برای احراز هویت چند عاملی استفاده شود.

امضا:

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

شاخص

اجرای تداوم نوع LOCAL با استفاده از indexedDB برای ذخیره سازی اساسی.

امضا:

indexedDBLocalPersistence: Persistence

امنی

اجرای تداوم نوع "هیچ".

امضا:

inMemoryPersistence: Persistence

نوع عمل

شمارش انواع عملکرد پشتیبانی شده.

امضا:

OperationType: {
    readonly LINK: "link";
    readonly REAUTHENTICATE: "reauthenticate";
    readonly SIGN_IN: "signIn";
}

شکل

نقشه خطای حداقل با تمام پیام های خطای Verbose سلب شده است.

بحث را در AutherRormap مشاهده کنید

امضا:

prodErrorMap: AuthErrorMap

ارائه دهنده

شمارش ارائه دهندگان پشتیبانی شده.

امضا:

ProviderId: {
    readonly FACEBOOK: "facebook.com";
    readonly GITHUB: "github.com";
    readonly GOOGLE: "google.com";
    readonly PASSWORD: "password";
    readonly PHONE: "phone";
    readonly TWITTER: "twitter.com";
}

ممتاز

شمارش روشهای ورود به سیستم پشتیبانی.

امضا:

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

پارامترهای سفارشی

نقشه پارامترهای سفارشی OAUTH.

امضا:

export declare type CustomParameters = Record<string, string>;

Nextorobserver

تعریف را برای پاسخ به تماس تلفنی تایپ کنید.

امضا:

export declare type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;

PhoneInfooptions

اطلاعات لازم برای تأیید مالکیت یک شماره تلفن.

اطلاعات مورد نیاز بستگی به این دارد که آیا شما در حال انجام ورود به سیستم ، ثبت نام چند عاملی یا ورود به سیستم چند عاملی هستید.

امضا:

export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;

مشخصات کاربر

مشخصات کاربر در ExtereUserInfo استفاده می شود .

امضا:

export declare type UserProfile = Record<string, unknown>;