auth package

การตรวจสอบสิทธิ์ Firebase

ฟังก์ชัน

การทำงาน คำอธิบาย
ฟังก์ชัน(แอป, ...)
getAuth(app) แสดงผลอินสแตนซ์การตรวจสอบสิทธิ์ที่เชื่อมโยงกับ FirebaseApp ที่ระบุ หากไม่มีอินสแตนซ์ ให้เริ่มต้นอินสแตนซ์การตรวจสอบสิทธิ์ด้วยทรัพยากร Dependency เริ่มต้นเฉพาะแพลตฟอร์ม
initializeAuth(app, deps) เริ่มต้นอินสแตนซ์ Auth ด้วยการควบคุมการขึ้นต่อกันแบบละเอียด
function(พื้นที่เก็บข้อมูล, ...)
getReactNativePersistence(storage) แสดงผลออบเจ็กต์การคงอยู่ที่รวม AsyncStorage ที่นำเข้าจาก react-native หรือ @react-native-community/async-storage และใช้ในฟิลด์ทรัพยากร Dependency ใน initializeAuth() ได้
function(auth, ...)
applyActionCode(auth, oobCode) ใช้รหัสยืนยันที่ส่งไปยังผู้ใช้ทางอีเมลหรือกลไกอื่นๆ นอกขอบเขต
beforeAuthStateChanged(auth, callback, onAbort) เพิ่มการเรียกกลับแบบบล็อกที่ทำงานก่อนการเปลี่ยนสถานะการตรวจสอบสิทธิ์จะกำหนดผู้ใช้ใหม่
checkActionCode(auth, oobCode) ตรวจสอบรหัสยืนยันที่ส่งไปยังผู้ใช้ทางอีเมลหรือกลไกอื่นๆ ที่ไม่ใช่ของขอบเขต
confirmPasswordReset(auth, oobCode, newPassword) ทําตามขั้นตอนการรีเซ็ตรหัสผ่านเรียบร้อยแล้ว จึงจะได้รับรหัสยืนยันและรหัสผ่านใหม่
connectAuthEmulator(auth, url, options) เปลี่ยนอินสแตนซ์ Auth ให้สื่อสารกับ Firebase Auth Emulator แทนบริการ Firebase Auth เวอร์ชันที่ใช้งานจริง
createUserWithEmailAndPassword(auth, email, password) สร้างบัญชีผู้ใช้ใหม่ที่เชื่อมโยงกับอีเมลและรหัสผ่านที่ระบุ
fetchSignInMethodsForEmail(auth, email) รับรายการวิธีการลงชื่อเข้าใช้ที่เป็นไปได้สำหรับอีเมลที่ระบุ เมธอดนี้จะแสดงรายการที่ว่างเปล่าเมื่อเปิดใช้ [การป้องกันการระบุอีเมล](https://cloud.google.com/identity-platform/docs/admin/email-enimeration-protection) โดยไม่คำนึงถึงวิธีการตรวจสอบสิทธิ์ที่ใช้ได้สำหรับอีเมลที่ระบุ
getMultiFactorResolver(auth, error) มี MultiFactorResolver เหมาะสำหรับการดำเนินการขั้นตอนแบบหลายปัจจัยให้เสร็จสมบูรณ์
getRedirectResult(auth, resolver) แสดงผล UserCredential จากขั้นตอนการลงชื่อเข้าใช้แบบเปลี่ยนเส้นทาง
initializeRecaptchaConfig(auth) โหลดการกำหนดค่า reCAPTCHA ลงในอินสแตนซ์ Auth
isSignInWithEmailLink(auth, emailLink) ตรวจสอบว่าลิงก์ขาเข้าเป็นการลงชื่อเข้าใช้ด้วยลิงก์อีเมลที่เหมาะสำหรับ signInWithEmailLink() หรือไม่
onAuthStateChanged(auth, nextOrObserver, error, completed) เพิ่มผู้สังเกตการณ์สำหรับการเปลี่ยนแปลงสถานะการลงชื่อเข้าใช้ของผู้ใช้
onIdTokenChanged(auth, nextOrObserver, error, completed) เพิ่มผู้สังเกตการณ์สำหรับการเปลี่ยนแปลงโทเค็นรหัสของผู้ใช้ที่ลงชื่อเข้าใช้
revokeAccessToken(auth, token) เพิกถอนโทเค็นเพื่อการเข้าถึงที่ระบุ ปัจจุบันรองรับเฉพาะโทเค็นเพื่อการเข้าถึงของ Apple OAuth เท่านั้น
sendPasswordResetEmail(auth, email, actionCodeSettings) ส่งอีเมลรีเซ็ตรหัสผ่านไปยังอีเมลที่ระบุ วิธีการนี้จะไม่แสดงข้อผิดพลาดเมื่อไม่มีบัญชีผู้ใช้ที่ใช้อีเมลที่ระบุและเปิดใช้[การป้องกันการระบุอีเมล](https://cloud.google.com/identity-platform/docs/admin/email-enimeration-protection)
sendSignInLinkToEmail(auth, email, actionCodeSettings) ส่งลิงก์อีเมลสำหรับลงชื่อเข้าใช้ให้ผู้ใช้พร้อมอีเมลที่ระบุ
setPersistence(auth, persistence) เปลี่ยนประเภทความต่อเนื่องในอินสแตนซ์ Auth ของเซสชัน Auth ที่บันทึกไว้ในปัจจุบัน และใช้ความต่อเนื่องประเภทนี้สำหรับคำขอลงชื่อเข้าใช้ในอนาคต รวมถึงการลงชื่อเข้าใช้ด้วยคำขอเปลี่ยนเส้นทาง
signInAnonymously(auth) ลงชื่อเข้าใช้ด้วยชื่อผู้ใช้ที่ไม่ระบุชื่อ
signInWithCredential(auth, credential) ลงชื่อเข้าใช้แบบไม่พร้อมกันด้วยข้อมูลเข้าสู่ระบบที่ระบุ
signInWithCustomToken(auth, customToken) ลงชื่อเข้าใช้แบบไม่พร้อมกันโดยใช้โทเค็นที่กำหนดเอง
signInWithEmailAndPassword(auth, email, password) ลงชื่อเข้าใช้ด้วยอีเมลและรหัสผ่านโดยไม่พร้อมกัน
signInWithEmailLink(auth, email, emailLink) ลงชื่อเข้าใช้แบบไม่พร้อมกันโดยใช้ลิงก์อีเมลและลงชื่อเข้าใช้
signInWithPhoneNumber(auth, phoneNumber, appVerifier) ลงชื่อเข้าใช้แบบไม่พร้อมกันโดยใช้หมายเลขโทรศัพท์
signInWithPopup(auth, provider, resolver) ตรวจสอบสิทธิ์ไคลเอ็นต์ Firebase โดยใช้ขั้นตอนการตรวจสอบสิทธิ์ OAuth แบบป๊อปอัป
signInWithRedirect(auth, provider, resolver) ตรวจสอบสิทธิ์ไคลเอ็นต์ Firebase โดยใช้ขั้นตอนการเปลี่ยนเส้นทางแบบเต็มหน้า
signOut(auth) นำผู้ใช้ปัจจุบันออกจากระบบ
updateCurrentUser(auth, user) ตั้งค่าผู้ใช้ที่ระบุเป็น Auth.currentUser ในอินสแตนซ์ Auth แบบอะซิงโครนัส
useDeviceLanguage(auth) ตั้งค่าภาษาปัจจุบันเป็นค่ากำหนดอุปกรณ์/เบราว์เซอร์เริ่มต้น
validatePassword(auth, password) ตรวจสอบรหัสผ่านกับนโยบายรหัสผ่านที่กำหนดค่าไว้สำหรับโปรเจ็กต์หรือกลุ่มผู้ใช้
verifyPasswordResetCode(auth, code) ตรวจสอบรหัสรีเซ็ตรหัสผ่านที่ส่งไปยังผู้ใช้ทางอีเมลหรือกลไกอื่นๆ ที่ไม่ใช่ของย่าน
Function(ลิงก์, ...)
parseActionCodeURL(ลิงก์) แยกวิเคราะห์สตริงลิงก์การดำเนินการกับอีเมลและแสดง ActionCodeURL หากลิงก์ถูกต้อง มิฉะนั้นจะแสดงผลเป็น Null
ฟังก์ชัน(ผู้ใช้, ...)
deleteUser(user) ลบและนำผู้ใช้ออกจากระบบ
getIdToken(user, forceRefresh) แสดงผล JSON Web Token (JWT) ที่ใช้ระบุผู้ใช้ไปยังบริการ Firebase
getIdTokenResult(user, forceRefresh) แสดงผลโทเค็นเว็บ JSON แบบดีซีเรียลไลซ์ (JWT) ที่ใช้ระบุผู้ใช้ไปยังบริการ Firebase
linkWithCredential(user, credential) ลิงก์บัญชีผู้ใช้ด้วยข้อมูลเข้าสู่ระบบที่ระบุ
linkWithPhoneNumber(user, phoneNumber, appVerifier) ลิงก์บัญชีผู้ใช้กับหมายเลขโทรศัพท์ที่ระบุ
linkWithPopup(user, provider, resolver) ลิงก์ผู้ให้บริการที่ตรวจสอบสิทธิ์แล้วกับบัญชีผู้ใช้โดยใช้ขั้นตอน OAuth แบบป๊อปอัป
linkWithRedirect(user, provider, resolver) ลิงก์ OAuthProvider กับบัญชีผู้ใช้โดยใช้ขั้นตอนการเปลี่ยนเส้นทางแบบเต็มหน้า
multiFactor(user) MultiFactorUser ที่สอดคล้องกับผู้ใช้
reauthenticateWithCredential(user, credential) ตรวจสอบสิทธิ์ผู้ใช้อีกครั้งโดยใช้ข้อมูลเข้าสู่ระบบใหม่
reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier) ตรวจสอบสิทธิ์ผู้ใช้อีกครั้งโดยใช้ข้อมูลเข้าสู่ระบบของโทรศัพท์ใหม่
reauthenticateWithPopup(user, provider, resolver) ตรวจสอบสิทธิ์ผู้ใช้ปัจจุบันอีกครั้งด้วย OAuthProvider ที่ระบุโดยใช้ขั้นตอน OAuth แบบป๊อปอัป
reauthenticateWithRedirect(user, provider, resolver) ตรวจสอบสิทธิ์ผู้ใช้ปัจจุบันอีกครั้งด้วย OAuthProvider ที่ระบุโดยใช้ขั้นตอนการเปลี่ยนเส้นทางแบบเต็มหน้า
reload(ผู้ใช้) โหลดข้อมูลบัญชีผู้ใช้ซ้ำเมื่อลงชื่อเข้าใช้
sendEmailVerification(user, actionCodeSettings) ส่งอีเมลยืนยันไปยังผู้ใช้
unlink(user, providerId) ยกเลิกการลิงก์ผู้ให้บริการกับบัญชีผู้ใช้
updateEmail(user, newEmail) อัปเดตอีเมลของผู้ใช้
updatePassword(user, newPassword) อัปเดตรหัสผ่านของผู้ใช้
updatePhoneNumber(user, credential) อัปเดตหมายเลขโทรศัพท์ของผู้ใช้
updateProfile(user, { displayName, photoURL: photoUrl }) อัปเดตข้อมูลโปรไฟล์ของผู้ใช้
verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings) ส่งอีเมลยืนยันไปยังอีเมลใหม่
function(userCredential, ...)
getAdditionalUserInfo(userCredential) ดึงข้อมูล AdditionalUserInfo เฉพาะผู้ให้บริการสําหรับข้อมูลเข้าสู่ระบบที่ระบุ

คลาส

ระดับ คำอธิบาย
ActionCodeURL คลาสยูทิลิตีสำหรับแยกวิเคราะห์ URL การดำเนินการอีเมล เช่น การรีเซ็ตรหัสผ่าน การยืนยันอีเมล การลงชื่อเข้าใช้ลิงก์อีเมล ฯลฯ
AuthCredential อินเทอร์เฟซที่แสดงข้อมูลเข้าสู่ระบบที่ AuthProvider ส่งคืนมา
EmailAuthCredential อินเทอร์เฟซที่แสดงข้อมูลเข้าสู่ระบบที่แสดงผลโดย EmailAuthProvider สำหรับ ProviderId.password
EmailAuthProvider ผู้ให้บริการสำหรับการสร้าง EmailAuthCredential
FacebookAuthProvider ผู้ให้บริการสำหรับสร้าง OAuthCredential สำหรับ ProviderId.FACEBOOK
GithubAuthProvider ผู้ให้บริการสำหรับสร้าง OAuthCredential สำหรับ ProviderId.GITHUB
GoogleAuthProvider ผู้ให้บริการสำหรับสร้าง OAuthCredential สำหรับ ProviderId.GOOGLE
OAuthCredential แสดงข้อมูลเข้าสู่ระบบ OAuth ที่แสดงโดย OAuthProvider
OAuthProvider ผู้ให้บริการสำหรับสร้าง OAuthCredential ทั่วไป
PhoneAuthCredential คือข้อมูลเข้าสู่ระบบที่ PhoneAuthProvider ส่งคืน
PhoneAuthProvider ผู้ให้บริการสำหรับการสร้าง PhoneAuthCredential
PhoneMultiFactorGenerator ผู้ให้บริการสําหรับการสร้าง PhoneMultiFactorAssertion
RecaptchaVerifier เครื่องมือยืนยันแอปพลิเคชันแบบ reCAPTCHA
SAMLAuthProvider AuthProvider สำหรับ SAML
TotpMultiFactorGenerator ผู้ให้บริการสําหรับการสร้าง TotpMultiFactorAssertion
TotpSecret ผู้ให้บริการสําหรับการสร้าง TotpMultiFactorAssertionจัดเก็บคีย์ลับที่ใช้ร่วมกันและพารามิเตอร์อื่นๆ เพื่อสร้าง OTP ตามเวลา ใช้วิธีการเรียกคีย์ลับที่ใช้ร่วมกันและสร้าง URL ของคิวอาร์โค้ด
TwitterAuthProvider ผู้ให้บริการสำหรับสร้าง OAuthCredential สำหรับ ProviderId.TWITTER

อินเทอร์เฟซ

SDK โฆษณา B คำอธิบาย
ActionCodeInfo การตอบกลับจาก checkActionCode()
ActionCodeSettings อินเทอร์เฟซที่กำหนด URL ดำเนินการต่อ/สถานะที่จำเป็น โดยมีตัวระบุกลุ่ม Android และ iOS ที่ไม่บังคับ
AdditionalUserInfo โครงสร้างที่มีข้อมูลผู้ใช้เพิ่มเติมจากผู้ให้บริการข้อมูลประจำตัวแบบรวมศูนย์
ApplicationVerifier เครื่องมือยืนยันสำหรับการยืนยันโดเมนและการป้องกันการละเมิด
การตรวจสอบสิทธิ์ อินเทอร์เฟซที่แสดงบริการ Firebase Auth
AuthError อินเทอร์เฟซสำหรับข้อผิดพลาด Auth
AuthErrorMap การจับคู่รหัสข้อผิดพลาดกับข้อความแสดงข้อผิดพลาด
AuthProvider อินเทอร์เฟซที่แสดงผู้ให้บริการตรวจสอบสิทธิ์ ซึ่งใช้เพื่อช่วยในการสร้าง AuthCredential
AuthSettings อินเทอร์เฟซที่แสดงการตั้งค่าของอินสแตนซ์ Auth
การกำหนดค่า อินเทอร์เฟซที่แสดงถึงการกำหนดค่า Auth
ConfirmationResult ผลลัพธ์จากการลงชื่อเข้าใช้ด้วยหมายเลขโทรศัพท์ ลิงก์ หรือการตรวจสอบสิทธิ์การโทรอีกครั้ง
การขึ้นต่อกัน ทรัพยากร Dependency ที่ใช้เริ่มต้นอินสแตนซ์ Auth ได้
EmulatorConfig การกำหนดค่าโปรแกรมจำลองการตรวจสอบสิทธิ์ Firebase
IdTokenResult อินเทอร์เฟซที่แสดงผลลัพธ์ของโทเค็นรหัสที่ได้จาก User.getIdTokenResult()
MultiFactorAssertion คลาสพื้นฐานสำหรับการยืนยันการเป็นเจ้าของปัจจัยที่สอง
MultiFactorError ข้อผิดพลาดนี้จะเกิดขึ้นเมื่อผู้ใช้ต้องระบุปัจจัยที่ 2 เพื่อลงชื่อเข้าใช้ให้สำเร็จ
MultiFactorInfo โครงสร้างที่มีข้อมูลของเอนทิตีจากปัจจัยที่สอง
MultiFactorResolver คลาสที่ใช้เพื่ออำนวยความสะดวกในการกู้คืนจาก MultiFactorError เมื่อผู้ใช้ต้องระบุปัจจัยที่ 2 เพื่อลงชื่อเข้าใช้
MultiFactorSession อินเทอร์เฟซที่กําหนดออบเจ็กต์เซสชันแบบหลายปัจจัยที่ใช้สำหรับการลงทะเบียนปัจจัยที่ 2 ให้กับผู้ใช้หรือช่วยลงชื่อเข้าใช้ผู้ใช้ที่ลงทะเบียนด้วยปัจจัยที่ 2
MultiFactorUser อินเทอร์เฟซที่กำหนดพร็อพเพอร์ตี้และการดำเนินการที่เกี่ยวข้องกับหลายปัจจัยเกี่ยวกับผู้ใช้
OAuthCredentialOptions กำหนดตัวเลือกสำหรับเริ่มต้น OAuthCredential
ParsedToken อินเทอร์เฟซแสดงโทเค็นรหัสที่แยกวิเคราะห์แล้ว
PasswordPolicy โครงสร้างที่ระบุข้อกำหนดของนโยบายรหัสผ่าน
PasswordValidationStatus โครงสร้างที่ระบุว่านโยบายรหัสผ่านใดเป็นไปตามหรือมีการละเมิดข้อกำหนดใดบ้าง
ความต่อเนื่อง อินเทอร์เฟซที่ครอบคลุมประเภทกลไกการคงอยู่ที่เป็นไปได้
PhoneMultiFactorAssertion ชั้นเรียนสําหรับการยืนยันการเป็นเจ้าของปัจจัยที่ 2 ของโทรศัพท์ โดย PhoneMultiFactorGenerator.assertion()
PhoneMultiFactorEnrollInfoOptions ตัวเลือกที่ใช้สำหรับการลงทะเบียนปัจจัยที่ 2
PhoneMultiFactorInfo คลาสย่อยของอินเทอร์เฟซ MultiFactorInfo สำหรับปัจจัยที่ 2 ของหมายเลขโทรศัพท์ factorId ของปัจจัยที่ 2 นี้คือ FactorId.PHONE
PhoneMultiFactorSignInInfoOptions ตัวเลือกที่ใช้สำหรับการลงชื่อเข้าใช้ด้วยปัจจัยที่ 2
PhoneSingleFactorInfoOptions ตัวเลือกที่ใช้สำหรับการลงชื่อเข้าใช้แบบปัจจัยเดียว
PopupRedirectResolver รีโซลเวอร์ที่ใช้สำหรับจัดการการดำเนินการเฉพาะ DOM เช่น signInWithPopup() หรือ signInWithRedirect()
ReactNativeAsyncStorage อินเทอร์เฟซสำหรับ AsyncStorage ที่มีให้
RecaptchaParameters อินเทอร์เฟซที่แสดงพารามิเตอร์ reCAPTCHAดูรายการพารามิเตอร์ที่ยอมรับได้ที่[เอกสาร reCAPTCHA](https://developers.google.com/recaptcha/docs/display#convert_param) ระบบยอมรับพารามิเตอร์ทั้งหมดยกเว้น sitekey: Firebase Auth จะจัดสรร reCAPTCHA สำหรับแต่ละโปรเจ็กต์และจะกำหนดค่าคีย์ของเว็บไซต์เมื่อแสดงผลสำหรับ reCAPTCHA ที่ไม่แสดง ให้ตั้งค่าคีย์ size เป็น invisible
TotpMultiFactorAssertion คลาสสำหรับการยืนยันการเป็นเจ้าของปัจจัยที่สองของ TOTP ให้บริการโดย TotpMultiFactorGenerator.assertionForEnrollment() และ TotpMultiFactorGenerator.assertionForSignIn()
TotpMultiFactorInfo คลาสย่อยของอินเทอร์เฟซ MultiFactorInfo สำหรับปัจจัยที่สองของ TOTP factorId ของปัจจัยที่ 2 นี้คือ FactorId.TOTP
ผู้ใช้ บัญชีผู้ใช้
UserCredential โครงสร้างที่มี User, OperationType และรหัสผู้ให้บริการ
UserInfo ข้อมูลโปรไฟล์ผู้ใช้ แสดงต่อแอปของโครงการ Firebase เท่านั้น
UserMetadata อินเทอร์เฟซที่แสดงข้อมูลเมตาของผู้ใช้

ตัวแปร

ตัวแปร คำอธิบาย
ActionCodeOperation การแจกแจงประเภทการดำเนินการอีเมลที่เป็นไปได้
AuthErrorCodes แผนที่แสดงรหัสข้อผิดพลาด Auth ที่อาจเกิดขึ้น เพื่อให้เปรียบเทียบกับข้อผิดพลาดที่ SDK แสดงได้ง่ายขึ้น
browserLocalPersistence การใช้งานความถาวรประเภท LOCAL โดยใช้ localStorage สำหรับพื้นที่เก็บข้อมูลที่จำเป็น
browserPopupRedirectResolver การใช้งาน PopupRedirectResolver ที่เหมาะสำหรับแอปพลิเคชันบนเบราว์เซอร์
browserSessionPersistence การใช้งานความต่อเนื่องของ SESSION ที่ใช้ sessionStorage สำหรับพื้นที่เก็บข้อมูลที่จำเป็น
cordovaPopupRedirectResolver การติดตั้งใช้งาน PopupRedirectResolver เหมาะสำหรับแอปพลิเคชันที่ใช้ Cordova
debugErrorMap แมปข้อผิดพลาดแบบละเอียดพร้อมคำอธิบายโดยละเอียดสำหรับรหัสข้อผิดพลาดส่วนใหญ่ดูการสนทนาได้ที่ AuthErrorMap
FactorId แจกแจงของปัจจัยที่อาจใช้สำหรับการตรวจสอบสิทธิ์แบบหลายปัจจัย
indexedDBLocalPersistence การใช้งานความถาวรประเภท LOCAL โดยใช้ indexedDB สำหรับพื้นที่เก็บข้อมูลที่จำเป็น
inMemoryPersistence การใช้งานความต่อเนื่องประเภท "NONE"
OperationType การแจงนับประเภทการดำเนินการที่รองรับ
prodErrorMap แผนที่ข้อผิดพลาดขั้นต่ำโดยตัดข้อความแสดงข้อผิดพลาดแบบละเอียดทั้งหมดออกดูการสนทนาได้ที่ AuthErrorMap
ProviderId การระบุผู้ให้บริการที่รองรับ
SignInMethod การระบุวิธีการลงชื่อเข้าใช้ที่รองรับ

ประเภทชื่อแทน

ประเภทชื่อแทน คำอธิบาย
CustomParameters แมปของพารามิเตอร์ที่กำหนดเองของ OAuth
NextOrObserver พิมพ์คำจำกัดความสำหรับโค้ดเรียกกลับของเหตุการณ์
PhoneInfoOptions ข้อมูลที่จําเป็นในการยืนยันความเป็นเจ้าของหมายเลขโทรศัพท์
UserProfile โปรไฟล์ผู้ใช้ที่ใช้ใน AdditionalUserInfo

ฟังก์ชัน(แอป, ...)

getAuth(app)

แสดงผลอินสแตนซ์การตรวจสอบสิทธิ์ที่เชื่อมโยงกับ FirebaseApp ที่ระบุ หากไม่มีอินสแตนซ์ ให้เริ่มต้นอินสแตนซ์การตรวจสอบสิทธิ์ด้วยทรัพยากร Dependency เริ่มต้นเฉพาะแพลตฟอร์ม

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
แอป FirebaseApp แอป Firebase

การคืนสินค้า:

การตรวจสอบสิทธิ์

initializeAuth(app, deps)

เริ่มต้นอินสแตนซ์ Auth ด้วยการควบคุมการขึ้นต่อกันแบบละเอียด

ฟังก์ชันนี้ช่วยให้ควบคุมอินสแตนซ์การตรวจสอบสิทธิ์ได้มากกว่า getAuth() getAuth ใช้ค่าเริ่มต้นเฉพาะแพลตฟอร์มเพื่อระบุการขึ้นต่อกัน โดยทั่วไป getAuth คือวิธีที่ง่ายที่สุดในการเริ่มต้นการตรวจสอบสิทธิ์และใช้ได้กับกรณีการใช้งานส่วนใหญ่ ใช้ initializeAuth หากต้องการควบคุมว่าจะใช้เลเยอร์การคงอยู่รายการใด หรือเพื่อลดขนาดกลุ่มหากคุณไม่ได้ใช้ signInWithPopup หรือ signInWithRedirect

ตัวอย่างเช่น หากแอปใช้เฉพาะบัญชีที่ไม่ระบุตัวตนและคุณต้องการเฉพาะบัญชีที่บันทึกไว้ในเซสชันปัจจุบัน ให้เริ่มต้น Auth ด้วย:

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

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
แอป FirebaseApp
Deps การขึ้นต่อกัน

การคืนสินค้า:

การตรวจสอบสิทธิ์

ฟังก์ชัน(พื้นที่เก็บข้อมูล, ...)

getReactNativePersistence(storage)

แสดงผลออบเจ็กต์ความต่อเนื่องที่รวม AsyncStorage ที่นำเข้าจาก react-native หรือ @react-native-community/async-storage และสามารถใช้ในช่องทรัพยากร Dependency ใน initializeAuth()

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
พื้นที่เก็บข้อมูล ReactNativeAsyncStorage

การคืนสินค้า:

ความต่อเนื่อง

ฟังก์ชัน(การตรวจสอบสิทธิ์, ...)

applyActionCode(auth, oobCode)

ใช้รหัสยืนยันที่ส่งไปยังผู้ใช้ทางอีเมลหรือกลไกอื่นๆ นอกขอบเขต

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ 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;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
Callback (user: User | null) => void | Promise<void> การเรียกกลับที่เรียกใช้ก่อนที่จะมีการตั้งค่าผู้ใช้ใหม่ หากมีการส่งแบบนี้ จะเป็นการบล็อกไม่ให้ผู้ใช้ตั้งค่า
onAbort () => เป็นโมฆะ จะมีการทริกเกอร์โค้ดเรียกกลับ หากโค้ดเรียกกลับ beforeAuthStateChanged() ในภายหลังมีผลอยู่ ซึ่งช่วยให้คุณเลิกทำผลข้างเคียงต่างๆ ได้

การคืนสินค้า:

ยกเลิกการรับข่าวสาร

checkActionCode(auth, oobCode)

ตรวจสอบรหัสยืนยันที่ส่งไปยังผู้ใช้ทางอีเมลหรือกลไกอื่นๆ ที่ไม่ใช่ของขอบเขต

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
oobCode string รหัสยืนยันที่ส่งไปยังผู้ใช้

การคืนสินค้า:

Promise<ActionCodeInfo>

ข้อมูลเมตาเกี่ยวกับโค้ด

confirmPasswordReset(auth, oobCode, newPassword)

ทําตามขั้นตอนการรีเซ็ตรหัสผ่านเรียบร้อยแล้ว จึงจะได้รับรหัสยืนยันและรหัสผ่านใหม่

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
oobCode string รหัสยืนยันที่ส่งไปยังผู้ใช้
newPassword string รหัสผ่านใหม่

การคืนสินค้า:

Promise<void>

connectAuthEmulator(auth, url, options)

เปลี่ยนอินสแตนซ์ Auth ให้สื่อสารกับ Firebase Auth Emulator แทนบริการ Firebase Auth เวอร์ชันที่ใช้งานจริง

โดยต้องเรียกใช้พร้อมกันทันทีหลังจากการเรียก initializeAuth() เป็นครั้งแรก อย่าใช้กับข้อมูลเข้าสู่ระบบเวอร์ชันที่ใช้งานจริงเนื่องจากการรับส่งข้อมูลของโปรแกรมจำลองไม่มีการเข้ารหัส

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
url string URL ที่โปรแกรมจำลองทำงานอยู่ (เช่น "http://localhost:9099")
ตัวเลือก { disableWarnings: boolean; } ไม่บังคับ options.disableWarnings มีค่าเริ่มต้นเป็น false โปรดตั้งค่าเป็น true เพื่อปิดใช้แบนเนอร์คำเตือนที่แนบมากับ DOM

การคืนสินค้า:

void

ตัวอย่าง

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

createUserWithEmailAndPassword(auth, email, password)

สร้างบัญชีผู้ใช้ใหม่ที่เชื่อมโยงกับอีเมลและรหัสผ่านที่ระบุ

เมื่อสร้างบัญชีผู้ใช้สำเร็จ ผู้ใช้รายนี้จะลงชื่อเข้าใช้แอปพลิเคชันของคุณด้วย

การสร้างบัญชีผู้ใช้อาจล้มเหลวได้หากมีบัญชีอยู่แล้วหรือรหัสผ่านไม่ถูกต้อง

อินสแตนซ์ Auth ที่สร้างด้วย FirebaseServerApp จะไม่รองรับวิธีนี้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
อีเมล string อีเมลของผู้ใช้
รหัสผ่าน string รหัสผ่านที่ผู้ใช้เลือก

การคืนสินค้า:

Promise<UserCredential>

fetchSignInMethodsForEmail(auth, email)

รับรายการวิธีการลงชื่อเข้าใช้ที่เป็นไปได้สำหรับอีเมลที่ระบุ เมธอดนี้จะแสดงรายการที่ว่างเปล่าเมื่อเปิดใช้ [การป้องกันการระบุอีเมล](https://cloud.google.com/identity-platform/docs/admin/email-enimeration-protection) โดยไม่คำนึงถึงวิธีการตรวจสอบสิทธิ์ที่ใช้ได้สำหรับอีเมลที่ระบุ

ซึ่งมีประโยชน์ในการแยกความแตกต่างระหว่างวิธีการลงชื่อเข้าใช้สำหรับผู้ให้บริการรายเดียวกัน เช่น EmailAuthProvider มีวิธีลงชื่อเข้าใช้ 2 วิธี ได้แก่ SignInMethod.EMAIL_password และ SignInMethod.EMAIL_LINK

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
อีเมล string อีเมลของผู้ใช้เลิกใช้งานแล้ว เราขอแนะนำให้ใช้การย้ายข้อมูลออกจากวิธีนี้ตามแนวทางปฏิบัติแนะนำด้านความปลอดภัย ดูข้อมูลเพิ่มเติมได้ในเอกสาร Identity Platform สำหรับ[การป้องกันการแจกแจงอีเมล](https://cloud.google.com/identity-platform/docs/admin/email-enimeration-protection)

การคืนสินค้า:

คำสัญญา<string[]>

getMultiFactorResolver(auth, error)

มี MultiFactorResolver เหมาะสำหรับการดำเนินการขั้นตอนแบบหลายปัจจัยให้เสร็จสมบูรณ์

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
error MultiFactorError MultiFactorError ซึ่งเกิดขึ้นระหว่างการลงชื่อเข้าใช้หรือการตรวจสอบสิทธิ์ซ้ำ

การคืนสินค้า:

MultiFactorResolver

getRedirectResult(auth, resolver)

แสดงผล UserCredential จากขั้นตอนการลงชื่อเข้าใช้แบบเปลี่ยนเส้นทาง

หากลงชื่อเข้าใช้สำเร็จ ระบบจะแสดงผลผู้ใช้ที่ลงชื่อเข้าใช้ไว้ หากลงชื่อเข้าใช้ไม่สำเร็จ ระบบจะดำเนินการไม่สำเร็จโดยมีข้อผิดพลาด หากไม่มีการเรียกใช้การเปลี่ยนเส้นทาง ให้แสดงผล null

วิธีนี้ใช้ไม่ได้ในสภาพแวดล้อม Node.js หรือกับอินสแตนซ์ Auth ที่สร้างด้วย FirebaseServerApp

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
รีโซลเวอร์ PopupRedirectResolver อินสแตนซ์ของ PopupRedirectResolver (ไม่บังคับ) หากมีการส่งให้กับ initializeAuth() หรือได้รับจาก getAuth() แล้ว

การคืนสินค้า:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth

การคืนสินค้า:

Promise<void>

ตัวอย่าง

initializeRecaptchaConfig(auth);

ตรวจสอบว่าลิงก์ขาเข้าเป็นการลงชื่อเข้าใช้ด้วยลิงก์อีเมลที่เหมาะสำหรับ signInWithEmailLink() หรือไม่

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
emailLink string ลิงก์ไปยังอีเมลของผู้ใช้

การคืนสินค้า:

boolean

onAuthStateChanged(auth, nextOrObserver, error, completed)

เพิ่มผู้สังเกตการณ์สำหรับการเปลี่ยนแปลงสถานะการลงชื่อเข้าใช้ของผู้ใช้

หากต้องการเก็บลักษณะการทำงานเดิมไว้ โปรดดู onIdTokenChanged()

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
nextOrObserver NextOrObserver<ผู้ใช้> โค้ดเรียกกลับถูกเรียกใช้เมื่อมีการเปลี่ยนแปลง
error ErrorFn เลิกใช้งานแล้ว โค้ดเรียกกลับนี้จะไม่ทริกเกอร์ ข้อผิดพลาดในการลงชื่อเข้าใช้/ออกจากระบบอาจพบได้ในสัญญาที่แสดงผลจากฟังก์ชันลงชื่อเข้าใช้/ออกจากระบบ
เสร็จสมบูรณ์ CompleteFn เลิกใช้งานแล้ว โค้ดเรียกกลับนี้จะไม่ทริกเกอร์

การคืนสินค้า:

ยกเลิกการรับข่าวสาร

onIdTokenChanged(auth, nextOrObserver, error, completed)

เพิ่มผู้สังเกตการณ์สำหรับการเปลี่ยนแปลงโทเค็นรหัสของผู้ใช้ที่ลงชื่อเข้าใช้

ซึ่งรวมถึงเหตุการณ์การลงชื่อเข้าใช้ การออกจากระบบ และการรีเฟรชโทเค็น การดำเนินการนี้จะไม่ทริกเกอร์โดยอัตโนมัติเมื่อโทเค็นรหัสหมดอายุ ใช้ User.getIdToken() เพื่อรีเฟรชโทเค็นรหัส

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
nextOrObserver NextOrObserver<ผู้ใช้> โค้ดเรียกกลับถูกเรียกใช้เมื่อมีการเปลี่ยนแปลง
error ErrorFn เลิกใช้งานแล้ว โค้ดเรียกกลับนี้จะไม่ทริกเกอร์ ข้อผิดพลาดในการลงชื่อเข้าใช้/ออกจากระบบอาจพบได้ในสัญญาที่แสดงผลจากฟังก์ชันลงชื่อเข้าใช้/ออกจากระบบ
เสร็จสมบูรณ์ CompleteFn เลิกใช้งานแล้ว โค้ดเรียกกลับนี้จะไม่ทริกเกอร์

การคืนสินค้า:

ยกเลิกการรับข่าวสาร

revokeAccessToken(auth, token)

เพิกถอนโทเค็นเพื่อการเข้าถึงที่ระบุ ปัจจุบันรองรับเฉพาะโทเค็นเพื่อการเข้าถึงของ Apple OAuth เท่านั้น

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
โทเค็น string โทเค็นเพื่อการเข้าถึง Apple OAuth

การคืนสินค้า:

Promise<void>

sendPasswordResetEmail(auth, email, actionCodeSettings)

ส่งอีเมลรีเซ็ตรหัสผ่านไปยังอีเมลที่ระบุ วิธีการนี้จะไม่แสดงข้อผิดพลาดเมื่อไม่มีบัญชีผู้ใช้ที่ใช้อีเมลที่ระบุและเปิดใช้[การป้องกันการระบุอีเมล](https://cloud.google.com/identity-platform/docs/admin/email-enimeration-protection)

หากต้องการรีเซ็ตรหัสผ่านให้เสร็จสมบูรณ์ ให้เรียก confirmPasswordReset() ด้วยรหัสที่ให้ไว้ในอีเมลที่ส่งถึงผู้ใช้ พร้อมกับรหัสผ่านใหม่ที่ผู้ใช้ระบุไว้

ลายเซ็น:

export declare function sendPasswordResetEmail(auth: Auth, email: string, actionCodeSettings?: ActionCodeSettings): Promise<void>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
อีเมล string อีเมลของผู้ใช้
actionCodeSettings 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, email, actionCodeSettings)

ส่งลิงก์อีเมลสำหรับลงชื่อเข้าใช้ให้ผู้ใช้พร้อมอีเมลที่ระบุ

การลงชื่อเข้าใช้จะต้องดำเนินการในแอปเสมอ ซึ่งต่างจากการดำเนินการทางอีเมลอื่นๆ นอกกลุ่ม (รีเซ็ตรหัสผ่านและการยืนยันอีเมล) ทั้งนี้เนื่องจากในตอนท้ายของกระบวนการ ผู้ใช้ต้องลงชื่อเข้าใช้และสถานะการตรวจสอบสิทธิ์ยังคงอยู่ภายในแอป

หากต้องการลงชื่อเข้าใช้ด้วยลิงก์อีเมลให้เสร็จสมบูรณ์ ให้เรียก signInWithEmailLink() ด้วยอีเมลและลิงก์อีเมลที่ให้ไว้ในอีเมลที่ส่งถึงผู้ใช้

ลายเซ็น:

export declare function sendSignInLinkToEmail(auth: Auth, email: string, actionCodeSettings: ActionCodeSettings): Promise<void>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์
อีเมล string อีเมลของผู้ใช้
actionCodeSettings 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>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
การคงอยู่ ความต่อเนื่อง ความต่อเนื่องที่จะใช้

การคืนสินค้า:

Promise<void>

Promise ที่จะได้รับการแก้ไขเมื่อการเปลี่ยนแปลงการคงอยู่เสร็จสมบูรณ์แล้ว

ตัวอย่าง

setPersistence(auth, browserSessionPersistence);

signInAnonymously(auth)

ลงชื่อเข้าใช้ด้วยชื่อผู้ใช้ที่ไม่ระบุชื่อ

หากมีผู้ใช้ที่ไม่ระบุชื่อลงชื่อเข้าใช้อยู่แล้ว ผู้ใช้จะถูกส่งคืน ไม่เช่นนั้น ระบบจะสร้างและส่งคืนข้อมูลระบุตัวตนผู้ใช้ที่ไม่ระบุชื่อใหม่

อินสแตนซ์ Auth ที่สร้างด้วย FirebaseServerApp ไม่รองรับวิธีการนี้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth

การคืนสินค้า:

Promise<UserCredential>

signInWithCredential(auth, credential)

ลงชื่อเข้าใช้แบบไม่พร้อมกันด้วยข้อมูลเข้าสู่ระบบที่ระบุ

คุณใช้ AuthProvider เพื่อสร้างข้อมูลเข้าสู่ระบบได้

อินสแตนซ์ Auth ที่สร้างด้วย FirebaseServerApp ไม่รองรับวิธีการนี้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
ข้อมูล เข้าสู่ระบบ AuthCredential ข้อมูลเข้าสู่ระบบ

การคืนสินค้า:

Promise<UserCredential>

signInWithCustomToken(auth, customToken)

ลงชื่อเข้าใช้แบบไม่พร้อมกันโดยใช้โทเค็นที่กำหนดเอง

โทเค็นที่กำหนดเองจะใช้เพื่อผสานรวม Firebase Auth กับระบบการตรวจสอบสิทธิ์ที่มีอยู่ และต้องสร้างโดยแบ็กเอนด์การตรวจสอบสิทธิ์โดยใช้เมธอด createCustomToken ใน Admin SDK

ล้มเหลวโดยมีข้อผิดพลาดหากโทเค็นไม่ถูกต้อง หมดอายุ หรือไม่ยอมรับโดยบริการ Firebase Auth

อินสแตนซ์ Auth ที่สร้างด้วย FirebaseServerApp ไม่รองรับวิธีการนี้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
customToken string โทเค็นที่กําหนดเองเพื่อลงชื่อเข้าใช้

การคืนสินค้า:

Promise<UserCredential>

signInWithEmailAndPassword(auth, email, password)

ลงชื่อเข้าใช้ด้วยอีเมลและรหัสผ่านโดยไม่พร้อมกัน

จะเกิดข้อผิดพลาดเมื่อที่อยู่อีเมลและรหัสผ่านไม่ตรงกัน เมื่อเปิดใช้[การป้องกันแจกแจงอีเมล](https://cloud.google.com/identity-platform/docs/admin/email-enimeration-protection) เมธอดนี้จะไม่สำเร็จโดยมี "auth/invalid-credential" ในกรณีที่อีเมล/รหัสผ่านไม่ถูกต้อง

อินสแตนซ์ Auth ที่สร้างด้วย FirebaseServerApp จะไม่รองรับวิธีนี้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
อีเมล string อีเมลของผู้ใช้
รหัสผ่าน string รหัสผ่านของผู้ใช้

การคืนสินค้า:

Promise<UserCredential>

ลงชื่อเข้าใช้แบบไม่พร้อมกันโดยใช้ลิงก์อีเมลและลงชื่อเข้าใช้

หากไม่ได้ส่งลิงก์ ระบบจะอนุมานลิงก์จาก URL ปัจจุบัน

จะเกิดข้อผิดพลาดเมื่ออีเมลไม่ถูกต้องหรือ OTP ในลิงก์อีเมลหมดอายุ

อินสแตนซ์ Auth ที่สร้างด้วย FirebaseServerApp ไม่รองรับวิธีการนี้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
อีเมล string อีเมลของผู้ใช้
emailLink string ลิงก์ไปยังอีเมลของผู้ใช้

การคืนสินค้า:

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)

ลงชื่อเข้าใช้แบบไม่พร้อมกันโดยใช้หมายเลขโทรศัพท์

วิธีนี้จะส่งรหัสผ่านทาง SMS ไปยังหมายเลขโทรศัพท์ที่ระบุ และแสดงผล 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>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
phoneNumber string หมายเลขโทรศัพท์ของผู้ใช้ในรูปแบบ E.164 (เช่น +16505550101)
appVerifier ApplicationVerifier ApplicationVerifier

การคืนสินค้า:

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(auth, provider, resolver)

ตรวจสอบสิทธิ์ไคลเอ็นต์ Firebase โดยใช้ขั้นตอนการตรวจสอบสิทธิ์ OAuth แบบป๊อปอัป

หากยืนยันสำเร็จ ระบบจะแสดงผลผู้ใช้ที่ลงชื่อเข้าใช้พร้อมข้อมูลเข้าสู่ระบบของผู้ให้บริการ หากลงชื่อเข้าใช้ไม่สำเร็จ ระบบจะแสดงออบเจ็กต์ข้อผิดพลาดที่มีข้อมูลเพิ่มเติมเกี่ยวกับข้อผิดพลาดดังกล่าว

วิธีนี้ใช้ไม่ได้ในสภาพแวดล้อม Node.js หรือกับอินสแตนซ์ Auth ที่สร้างด้วย FirebaseServerApp

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
provider AuthProvider ผู้ให้บริการที่จะตรวจสอบสิทธิ์ ผู้ให้บริการต้องเป็น OAuthProvider ผู้ให้บริการที่ไม่ใช่ OAuth เช่น EmailAuthProvider จะแสดงข้อผิดพลาด
รีโซลเวอร์ PopupRedirectResolver อินสแตนซ์ของ PopupRedirectResolver (ไม่บังคับ) หากมีการส่งให้กับ initializeAuth() หรือได้รับจาก getAuth() แล้ว

การคืนสินค้า:

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, provider, resolver)

ตรวจสอบสิทธิ์ไคลเอ็นต์ Firebase โดยใช้ขั้นตอนการเปลี่ยนเส้นทางแบบเต็มหน้า

หากต้องการจัดการผลลัพธ์และข้อผิดพลาดของการดำเนินการนี้ โปรดดู getRedirectResult() ปฏิบัติตามแนวทางปฏิบัติแนะนำ เมื่อใช้ signInWithRedirect()

วิธีนี้ใช้ไม่ได้ในสภาพแวดล้อม Node.js หรือกับอินสแตนซ์ Auth ที่สร้างด้วย FirebaseServerApp

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
provider AuthProvider ผู้ให้บริการที่จะตรวจสอบสิทธิ์ ผู้ให้บริการต้องเป็น OAuthProvider ผู้ให้บริการที่ไม่ใช่ OAuth เช่น EmailAuthProvider จะแสดงข้อผิดพลาด
รีโซลเวอร์ PopupRedirectResolver อินสแตนซ์ของ PopupRedirectResolver (ไม่บังคับ) หากมีการส่งให้กับ initializeAuth() หรือได้รับจาก getAuth() แล้ว

การคืนสินค้า:

คำสัญญา<ไม่มี>

ตัวอย่าง

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

signOut(auth)

นำผู้ใช้ปัจจุบันออกจากระบบ

อินสแตนซ์ Auth ที่สร้างด้วย FirebaseServerApp ไม่รองรับวิธีการนี้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth

การคืนสินค้า:

Promise<void>

updateCurrentUser(auth, user)

ตั้งค่าผู้ใช้ที่ระบุเป็น Auth.currentUser ในอินสแตนซ์ Auth แบบอะซิงโครนัส

ระบบจะสร้างสำเนาของอินสแตนซ์ใหม่ของผู้ใช้ที่ระบุและตั้งค่าเป็น currentUser

การดำเนินการนี้จะทริกเกอร์ Listener onAuthStateChanged() และ onIdTokenChanged() เช่นเดียวกับวิธีการลงชื่อเข้าใช้อื่นๆ

การดำเนินการจะล้มเหลวโดยมีข้อผิดพลาดหากผู้ใช้ที่จะอัปเดตเป็นของโปรเจ็กต์ Firebase อื่น

อินสแตนซ์ Auth ที่สร้างด้วย FirebaseServerApp ไม่รองรับวิธีการนี้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
ผู้ใช้ ผู้ใช้ | ไม่มีข้อมูล ผู้ใช้ใหม่

การคืนสินค้า:

Promise<void>

useDeviceLanguage(auth)

ตั้งค่าภาษาปัจจุบันเป็นค่ากำหนดอุปกรณ์/เบราว์เซอร์เริ่มต้น

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth

การคืนสินค้า:

void

validatePassword(auth, password)

ตรวจสอบรหัสผ่านกับนโยบายรหัสผ่านที่กำหนดค่าไว้สำหรับโปรเจ็กต์หรือกลุ่มผู้ใช้

หากไม่มีการตั้งค่ารหัสกลุ่มผู้ใช้บนอินสแตนซ์ Auth เมธอดนี้จะใช้นโยบายรหัสผ่านที่กำหนดค่าไว้สำหรับโปรเจ็กต์ มิฉะนั้น เมธอดนี้จะใช้นโยบายที่กำหนดค่าไว้สำหรับกลุ่มผู้ใช้ หากไม่ได้กำหนดค่านโยบายรหัสผ่าน ระบบจะใช้นโยบายเริ่มต้นที่กำหนดค่าไว้สำหรับโปรเจ็กต์ทั้งหมด

หากขั้นตอนการตรวจสอบสิทธิ์ล้มเหลวเนื่องจากรหัสผ่านที่ส่งไม่เป็นไปตามข้อกำหนดของนโยบายรหัสผ่านและมีการเรียกใช้เมธอดนี้ก่อนหน้านี้แล้ว วิธีนี้จะใช้นโยบายล่าสุดที่มีอยู่เมื่อมีการเรียกใช้อีกครั้ง

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
รหัสผ่าน string รหัสผ่านที่จะตรวจสอบ

การคืนสินค้า:

Promise<PasswordValidationStatus>

ตัวอย่าง

validatePassword(auth, 'some-password');

verifyPasswordResetCode(auth, code)

ตรวจสอบรหัสรีเซ็ตรหัสผ่านที่ส่งไปยังผู้ใช้ทางอีเมลหรือกลไกอื่นๆ ที่ไม่ใช่ของย่าน

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
การตรวจสอบสิทธิ์ การตรวจสอบสิทธิ์ อินสแตนซ์ Auth
รหัส string รหัสยืนยันที่ส่งไปยังผู้ใช้

การคืนสินค้า:

คำสัญญา<string>

อีเมลของผู้ใช้ หากถูกต้อง

ParActionCodeURL(ลิงก์)

แยกวิเคราะห์สตริงลิงก์การดำเนินการกับอีเมลและแสดง ActionCodeURL หากลิงก์ถูกต้อง มิฉะนั้นจะแสดงผลเป็น Null

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ลิงก์ string

การคืนสินค้า:

ActionCodeURL | null

ฟังก์ชัน(ผู้ใช้, ...)

deleteUser(user)

ลบและนำผู้ใช้ออกจากระบบ

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้

การคืนสินค้า:

Promise<void>

getIdToken(user, forceRefresh)

แสดงผล JSON Web Token (JWT) ที่ใช้ระบุผู้ใช้ไปยังบริการ Firebase

แสดงผลโทเค็นปัจจุบันหากยังไม่หมดอายุหรือไม่หมดอายุในอีก 5 นาทีข้างหน้า ไม่เช่นนั้น การดำเนินการนี้จะรีเฟรชโทเค็นและแสดงผลโทเค็นใหม่

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้
forceRefresh boolean บังคับรีเฟรชไม่ว่าโทเค็นจะหมดอายุหรือไม่ก็ตาม

การคืนสินค้า:

คำสัญญา<string>

getIdTokenResult(user, forceRefresh)

แสดงผลโทเค็นเว็บ JSON แบบดีซีเรียลไลซ์ (JWT) ที่ใช้ระบุผู้ใช้ไปยังบริการ Firebase

แสดงผลโทเค็นปัจจุบันหากยังไม่หมดอายุหรือไม่หมดอายุในอีก 5 นาทีข้างหน้า ไม่เช่นนั้น การดำเนินการนี้จะรีเฟรชโทเค็นและแสดงผลโทเค็นใหม่

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้
forceRefresh boolean บังคับรีเฟรชไม่ว่าโทเค็นจะหมดอายุหรือไม่ก็ตาม

การคืนสินค้า:

Promise<IdTokenResult>

linkWithCredential(user, credential)

ลิงก์บัญชีผู้ใช้ด้วยข้อมูลเข้าสู่ระบบที่ระบุ

คุณใช้ AuthProvider เพื่อสร้างข้อมูลเข้าสู่ระบบได้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้
ข้อมูล เข้าสู่ระบบ AuthCredential ข้อมูลเข้าสู่ระบบ

การคืนสินค้า:

Promise<UserCredential>

linkWithPhoneNumber(user, phoneNumber, appVerifier)

ลิงก์บัญชีผู้ใช้กับหมายเลขโทรศัพท์ที่ระบุ

เมธอดนี้ไม่ทำงานในสภาพแวดล้อม Node.js

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้
phoneNumber string หมายเลขโทรศัพท์ของผู้ใช้ในรูปแบบ E.164 (เช่น +16505550101)
appVerifier ApplicationVerifier ApplicationVerifier

การคืนสินค้า:

Promise<ConfirmationResult>

linkWithPopup(user, provider, resolver)

ลิงก์ผู้ให้บริการที่ตรวจสอบสิทธิ์แล้วกับบัญชีผู้ใช้โดยใช้ขั้นตอน OAuth แบบป๊อปอัป

หากลิงก์สำเร็จ ผลลัพธ์ที่แสดงจะมีผู้ใช้และข้อมูลรับรองของผู้ให้บริการ

เมธอดนี้ไม่ทำงานในสภาพแวดล้อม Node.js

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้
provider AuthProvider ผู้ให้บริการที่จะตรวจสอบสิทธิ์ ผู้ให้บริการต้องเป็น OAuthProvider ผู้ให้บริการที่ไม่ใช่ OAuth เช่น EmailAuthProvider จะแสดงข้อผิดพลาด
รีโซลเวอร์ PopupRedirectResolver อินสแตนซ์ของ PopupRedirectResolver (ไม่บังคับ) หากมีการส่งให้กับ initializeAuth() หรือได้รับจาก getAuth() แล้ว

การคืนสินค้า:

Promise<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(user, provider, resolver)

ลิงก์ OAuthProvider กับบัญชีผู้ใช้โดยใช้ขั้นตอนการเปลี่ยนเส้นทางแบบเต็มหน้า

หากต้องการจัดการผลลัพธ์และข้อผิดพลาดของการดำเนินการนี้ โปรดดูที่ getRedirectResult() ทำตามแนวทางปฏิบัติแนะนำเมื่อใช้ linkWithRedirect()

วิธีนี้ใช้ไม่ได้ในสภาพแวดล้อม Node.js หรือกับอินสแตนซ์ Auth ที่สร้างด้วย FirebaseServerApp

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้
provider AuthProvider ผู้ให้บริการที่จะตรวจสอบสิทธิ์ ผู้ให้บริการต้องเป็น OAuthProvider ผู้ให้บริการที่ไม่ใช่ OAuth เช่น EmailAuthProvider จะแสดงข้อผิดพลาด
รีโซลเวอร์ PopupRedirectResolver อินสแตนซ์ของ PopupRedirectResolver (ไม่บังคับ) หากมีการส่งให้กับ initializeAuth() หรือได้รับจาก getAuth() แล้ว

การคืนสินค้า:

คำสัญญา<ไม่มี>

ตัวอย่าง

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

multiFactor(user)

MultiFactorUser ที่สอดคล้องกับผู้ใช้

ใช้เพื่อเข้าถึงพร็อพเพอร์ตี้แบบหลายปัจจัยและการดำเนินการทั้งหมดที่เกี่ยวข้องกับผู้ใช้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้

การคืนสินค้า:

MultiFactorUser

reauthenticateWithCredential(user, credential)

ตรวจสอบสิทธิ์ผู้ใช้อีกครั้งโดยใช้ข้อมูลเข้าสู่ระบบใหม่

ใช้ก่อนการดำเนินการ เช่น updatePassword() ที่ต้องใช้โทเค็นจากการลงชื่อเข้าใช้ครั้งล่าสุด คุณใช้วิธีนี้เพื่อกู้คืนจากข้อผิดพลาด CREDENTIAL_TOO_OLD_LOGIN_AGAIN หรือข้อผิดพลาด TOKEN_EXPIRED ได้

ระบบไม่รองรับวิธีนี้ในผู้ใช้ที่ลงชื่อเข้าใช้โดยอินสแตนซ์ Auth ซึ่งสร้างขึ้นด้วย FirebaseServerApp

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้
ข้อมูล เข้าสู่ระบบ AuthCredential ข้อมูลเข้าสู่ระบบ

การคืนสินค้า:

Promise<UserCredential>

reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier)

ตรวจสอบสิทธิ์ผู้ใช้อีกครั้งโดยใช้ข้อมูลเข้าสู่ระบบของโทรศัพท์ใหม่

ใช้ก่อนการดำเนินการ เช่น updatePassword() ที่ต้องใช้โทเค็นจากการลงชื่อเข้าใช้ครั้งล่าสุด

วิธีการนี้ไม่ทำงานในสภาพแวดล้อม Node.js หรือกับผู้ใช้ที่ลงชื่อเข้าใช้โดยอินสแตนซ์ Auth ที่สร้างด้วย FirebaseServerApp

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้
phoneNumber string หมายเลขโทรศัพท์ของผู้ใช้ในรูปแบบ E.164 (เช่น +16505550101)
appVerifier ApplicationVerifier ApplicationVerifier

การคืนสินค้า:

Promise<ConfirmationResult>

reauthenticateWithPopup(user, provider, resolver)

ตรวจสอบสิทธิ์ผู้ใช้ปัจจุบันอีกครั้งด้วย OAuthProvider ที่ระบุโดยใช้ขั้นตอน OAuth แบบป๊อปอัป

หากการตรวจสอบสิทธิ์ซ้ำสำเร็จ ผลลัพธ์ที่แสดงจะมีผู้ใช้และข้อมูลรับรองของผู้ให้บริการ

วิธีการนี้ไม่ทำงานในสภาพแวดล้อม Node.js หรือกับผู้ใช้ที่ลงชื่อเข้าใช้โดยอินสแตนซ์ Auth ที่สร้างด้วย FirebaseServerApp

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้
provider AuthProvider ผู้ให้บริการที่จะตรวจสอบสิทธิ์ ผู้ให้บริการต้องเป็น OAuthProvider ผู้ให้บริการที่ไม่ใช่ OAuth เช่น EmailAuthProvider จะแสดงข้อผิดพลาด
รีโซลเวอร์ PopupRedirectResolver อินสแตนซ์ของ PopupRedirectResolver (ไม่บังคับ) หากมีการส่งให้กับ initializeAuth() หรือได้รับจาก getAuth() แล้ว

การคืนสินค้า:

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

reauthenticateWithRedirect(user, provider, resolver)

ตรวจสอบสิทธิ์ผู้ใช้ปัจจุบันอีกครั้งด้วย OAuthProvider ที่ระบุโดยใช้ขั้นตอนการเปลี่ยนเส้นทางแบบเต็มหน้า

หากต้องการจัดการผลลัพธ์และข้อผิดพลาดของการดำเนินการนี้ โปรดดูที่ getRedirectResult() ปฏิบัติตามแนวทางปฏิบัติแนะนำเมื่อใช้ reauthenticateWithRedirect()

วิธีนี้ใช้ไม่ได้ในสภาพแวดล้อม Node.js หรือกับอินสแตนซ์ Auth ที่สร้างด้วย FirebaseServerApp

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้
provider AuthProvider ผู้ให้บริการที่จะตรวจสอบสิทธิ์ ผู้ให้บริการต้องเป็น OAuthProvider ผู้ให้บริการที่ไม่ใช่ OAuth เช่น EmailAuthProvider จะแสดงข้อผิดพลาด
รีโซลเวอร์ PopupRedirectResolver อินสแตนซ์ของ PopupRedirectResolver (ไม่บังคับ) หากมีการส่งให้กับ initializeAuth() หรือได้รับจาก getAuth() แล้ว

การคืนสินค้า:

คำสัญญา<ไม่มี>

ตัวอย่าง

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้

การคืนสินค้า:

Promise<void>

sendEmailVerification(user, actionCodeSettings)

ส่งอีเมลยืนยันไปยังผู้ใช้

กระบวนการยืนยันจะเสร็จสมบูรณ์ได้ด้วยการเรียกใช้ applyActionCode()

ลายเซ็น:

export declare function sendEmailVerification(user: User, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้
actionCodeSettings ActionCodeSettings | null 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 sendEmailVerification(user, actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);

ยกเลิกการลิงก์ผู้ให้บริการกับบัญชีผู้ใช้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้
providerId string ผู้ให้บริการที่จะยกเลิกการลิงก์

การคืนสินค้า:

คำมั่นสัญญา<User>

updateEmail(user, newEmail)

อัปเดตอีเมลของผู้ใช้

ระบบจะส่งอีเมลไปยังอีเมลเดิม (หากตั้งค่าไว้) ซึ่งอนุญาตให้เพิกถอนการเปลี่ยนแปลงอีเมลได้ เพื่อปกป้องไม่ให้มีการลักลอบใช้บัญชี

ระบบไม่รองรับวิธีนี้ในผู้ใช้ที่ลงชื่อเข้าใช้โดยอินสแตนซ์ Auth ซึ่งสร้างขึ้นด้วย FirebaseServerApp

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้
newEmail string อีเมลใหม่แสดงข้อผิดพลาด "auth/operation-not-allowed" เมื่อเปิดใช้[การป้องกันการแจกแจงอีเมล](https://cloud.google.com/identity-platform/docs/admin/email-enimeration-protection) เลิกใช้งาน - ใช้ verifyBeforeUpdateEmail() แทน

การคืนสินค้า:

Promise<void>

updatePassword(user, newPassword)

อัปเดตรหัสผ่านของผู้ใช้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้
newPassword string รหัสผ่านใหม่

การคืนสินค้า:

Promise<void>

updatePhoneNumber(user, credential)

อัปเดตหมายเลขโทรศัพท์ของผู้ใช้

วิธีการนี้ไม่ทำงานในสภาพแวดล้อม Node.js หรือกับผู้ใช้ที่ลงชื่อเข้าใช้โดยอินสแตนซ์ Auth ที่สร้างด้วย FirebaseServerApp

ลายเซ็น:

export declare function updatePhoneNumber(user: User, credential: PhoneAuthCredential): Promise<void>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้
ข้อมูล เข้าสู่ระบบ 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(user, { displayName, photoURL: photoUrl })

อัปเดตข้อมูลโปรไฟล์ของผู้ใช้

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้
{ displayName, photoURL: photoUrl } { displayName?: string | null; photoURL?: string | null; }

การคืนสินค้า:

Promise<void>

verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings)

ส่งอีเมลยืนยันไปยังอีเมลใหม่

ระบบจะอัปเดตอีเมลของผู้ใช้เป็นอีเมลใหม่หลังจากได้รับการยืนยันแล้ว

หากมีเครื่องจัดการการดำเนินการอีเมลที่กำหนดเอง คุณจะทำการยืนยันให้เสร็จสมบูรณ์ได้โดยเรียกใช้ applyActionCode()

ลายเซ็น:

export declare function verifyBeforeUpdateEmail(user: User, newEmail: string, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
ผู้ใช้ ผู้ใช้ ผู้ใช้
newEmail string ที่อยู่อีเมลใหม่ที่ต้องยืนยันก่อนอัปเดต
actionCodeSettings ActionCodeSettings | null 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 verifyBeforeUpdateEmail(user, 'newemail@example.com', actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);

ฟังก์ชัน(userCredential, ...)

getAdditionalUserInfo(userCredential)

ดึงข้อมูล AdditionalUserInfo เฉพาะผู้ให้บริการสําหรับข้อมูลเข้าสู่ระบบที่ระบุ

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์ ประเภท คำอธิบาย
userCredential UserCredential ข้อมูลเข้าสู่ระบบของผู้ใช้

การคืนสินค้า:

AdditionalUserInfo | null

ActionCodeOperation

การแจกแจงประเภทการดำเนินการอีเมลที่เป็นไปได้

ลายเซ็น:

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

AuthErrorCodes

แผนที่แสดงรหัสข้อผิดพลาด 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";
}

browserLocalPersistence

การใช้งานความถาวรประเภท LOCAL โดยใช้ localStorage สำหรับพื้นที่เก็บข้อมูลที่จำเป็น

ลายเซ็น:

browserLocalPersistence: Persistence

browserPopupRedirectResolver

การใช้งาน PopupRedirectResolver ที่เหมาะสำหรับแอปพลิเคชันบนเบราว์เซอร์

เมธอดนี้ไม่ทำงานในสภาพแวดล้อม Node.js

ลายเซ็น:

browserPopupRedirectResolver: PopupRedirectResolver

browserSessionPersistence

การใช้งานความต่อเนื่องของ SESSION ที่ใช้ sessionStorage สำหรับพื้นที่เก็บข้อมูลที่จำเป็น

ลายเซ็น:

browserSessionPersistence: Persistence

cordovaPopupRedirectResolver

การติดตั้งใช้งาน PopupRedirectResolver เหมาะสำหรับแอปพลิเคชันที่ใช้ Cordova

ลายเซ็น:

cordovaPopupRedirectResolver: PopupRedirectResolver

debugErrorMap

แมปข้อผิดพลาดแบบละเอียดพร้อมคำอธิบายโดยละเอียดสำหรับรหัสข้อผิดพลาดส่วนใหญ่

ดูการสนทนาที่ AuthErrorMap

ลายเซ็น:

debugErrorMap: AuthErrorMap

FactorId

แจกแจงของปัจจัยที่อาจใช้สำหรับการตรวจสอบสิทธิ์แบบหลายปัจจัย

ลายเซ็น:

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

indexedDBLocalPersistence

การใช้งานความถาวรประเภท LOCAL โดยใช้ indexedDB สำหรับพื้นที่เก็บข้อมูลที่จำเป็น

ลายเซ็น:

indexedDBLocalPersistence: Persistence

inMemoryPersistence

การใช้งานความต่อเนื่องประเภท "NONE"

ลายเซ็น:

inMemoryPersistence: Persistence

OperationType

การแจงนับประเภทการดำเนินการที่รองรับ

ลายเซ็น:

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

prodErrorMap

แผนที่ข้อผิดพลาดขั้นต่ำที่มีข้อความแสดงข้อผิดพลาดแบบละเอียดทั้งหมดถูกตัดออก

ดูการสนทนาที่ AuthErrorMap

ลายเซ็น:

prodErrorMap: AuthErrorMap

ProviderId

การระบุผู้ให้บริการที่รองรับ

ลายเซ็น:

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

SignInMethod

การระบุวิธีการลงชื่อเข้าใช้ที่รองรับ

ลายเซ็น:

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

CustomParameters

แมปของพารามิเตอร์ที่กำหนดเองของ 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;

UserProfile

โปรไฟล์ผู้ใช้ที่ใช้ใน AdditionalUserInfo

ลายเซ็น:

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