auth package

Xác thực Firebase

Hàm

Chức năng Mô tả
hàm(app, ...)
getAuth(ứng dụng) Trả về phiên bản Xác thực được liên kết với FirebaseApp được cung cấp. Nếu không có phiên bản nào, hãy khởi chạy một phiên bản Xác thực với các phần phụ thuộc mặc định dành riêng cho nền tảng.
RestartAuth(app; phần phụ thuộc) Khởi chạy một thực thể Xác thực với quyền kiểm soát chi tiết đối với Phần phụ thuộc.
hàm(bộ nhớ, ...)
getReactNativePersistence(storage) Trả về một đối tượng cố định bao bọc AsyncStorage được nhập từ react-native hoặc @react-native-community/async-storage và có thể được dùng trong trường phần phụ thuộc cố định trong initializeAuth().
hàm(auth, ...)
applyActionCode(auth, oobCode) Áp dụng mã xác minh được gửi cho người dùng qua email hoặc cơ chế khác ngoài băng tần.
beforeAuthStateChanged(auth, callback, onabort) Thêm lệnh gọi lại chặn chạy trước khi thay đổi trạng thái xác thực sẽ thiết lập người dùng mới.
checkActionCode(auth, oobCode) Kiểm tra mã xác minh được gửi đến người dùng qua email hoặc cơ chế ngoài băng tần khác.
confirmPasswordReset(auth, oobCode, newPassword) Hoàn tất quá trình đặt lại mật khẩu, đã cung cấp một mã xác nhận và mật khẩu mới.
connectAuthEmulator(auth, url, options) Thay đổi thực thể Xác thực để giao tiếp với Trình mô phỏng xác thực Firebase, thay vì các dịch vụ Xác thực Firebase chính thức.
createUserWithEmailAndPassword(xác thực, email, mật khẩu) Tạo tài khoản người dùng mới được liên kết với địa chỉ email và mật khẩu đã chỉ định.
fetchSignInMethodsForEmail(xác thực, email) Lấy danh sách phương thức đăng nhập có thể sử dụng cho địa chỉ email đã cho. Phương thức này sẽ trả về một danh sách trống khi bật tính năng Bảo vệ liệt kê email, bất kể email đã chỉ định có bao nhiêu phương thức xác thực.
getMultiFactorResolver(auth, error) Cung cấp một MultiFactorResolver phù hợp để hoàn tất luồng đa yếu tố.
get RedirectResult(xác thực, trình phân giải) Trả về UserCredential từ quy trình đăng nhập dựa trên lệnh chuyển hướng.
khởi tạoReCAPTCHAConfig(xác thực) Tải cấu hình reCAPTCHA vào thực thể Auth.
isSignInWithEmailLink(auth, emailLink) Kiểm tra xem đường liên kết đến có phải là thông tin đăng nhập bằng đường liên kết email phù hợp với signInWithEmailLink() hay không.
onAuthStateChanged(auth, nextOrObserver, lỗi, đã hoàn tất) Thêm trình quan sát cho các thay đổi đối với trạng thái đăng nhập của người dùng.
onIdTokenChanged(auth, nextOrObserver, error, complete) Thêm trình quan sát cho các thay đổi đối với mã nhận dạng của người dùng đã đăng nhập.
RevokeAccessToken(xác thực, mã thông báo) Thu hồi mã truy cập đã cấp. Hiện chỉ hỗ trợ mã truy cập OAuth của Apple.
sendPasswordResetEmail(auth, email, actionCodeSettings) Gửi email đặt lại mật khẩu đến địa chỉ email đã cho. Phương thức này không gửi thông báo lỗi khi không có tài khoản người dùng nào có địa chỉ email đã cung cấp và chế độ Bảo vệ tính năng liệt kê email đang bật.
sendSignInLinkToEmail(auth, email, actionCodeSettings) Gửi đường liên kết đăng nhập qua email cho người dùng có email được chỉ định.
setPersistence(xác thực, cố định) Thay đổi kiểu cố định trên thực thể Xác thực cho phiên Auth hiện đã lưu và áp dụng kiểu cố định này cho các yêu cầu đăng nhập trong tương lai, bao gồm cả lượt đăng nhập bằng yêu cầu chuyển hướng.
signInAnonymously(auth) Đăng nhập không đồng bộ với tư cách người dùng ẩn danh.
signInWithCredential(auth, Credential) (Đăng nhập bằng thông tin xác thực, thông tin xác thực) Đăng nhập không đồng bộ bằng thông tin đăng nhập đã cho.
signInWithCustomToken(auth, customToken) Đăng nhập không đồng bộ bằng mã thông báo tuỳ chỉnh.
signInWithEmailAndPassword(auth, email, mật khẩu) Đăng nhập không đồng bộ bằng email và mật khẩu.
signInWithEmailLink(auth, email, emailLink) Đăng nhập không đồng bộ bằng email và đường liên kết đăng nhập vào email.
signInWithPhoneNumber(auth, phoneNumber, appVerifier) Đăng nhập không đồng bộ bằng số điện thoại.
signInWithPopup(xác thực, nhà cung cấp, trình phân giải) Xác thực ứng dụng Firebase bằng quy trình xác thực OAuth dựa trên cửa sổ bật lên.
signInWith Redirect(xác thực, nhà cung cấp, trình phân giải) Xác thực ứng dụng Firebase bằng quy trình chuyển hướng toàn trang.
signOut(auth) Đăng xuất người dùng hiện tại.
updateCurrentUser(auth; người dùng) Đặt người dùng được cung cấp là Auth.currentUser một cách không đồng bộ trên phiên bản Auth.
useDeviceLanguage(auth) Đặt ngôn ngữ hiện tại thành tuỳ chọn trình duyệt/thiết bị mặc định.
verifyPassword(xác thực, mật khẩu) Xác thực mật khẩu theo chính sách mật khẩu đã định cấu hình cho dự án hoặc đối tượng thuê.
verifyPasswordResetCode(auth, code) Kiểm tra mã đặt lại mật khẩu được gửi cho người dùng qua email hoặc cơ chế khác ngoài băng tần.
hàm(link, ...)
parseActionCodeURL(liên kết) Phân tích cú pháp chuỗi liên kết hành động qua email và trả về ActionCodeURL nếu liên kết hợp lệ, nếu không sẽ trả về giá trị rỗng.
hàm(người dùng, ...)
deleteUser(người dùng) Xoá và đăng xuất người dùng.
getIdToken(người dùng, forceRefresh) Trả về Mã thông báo web JSON (JWT) dùng để nhận dạng người dùng cho dịch vụ Firebase.
getIdTokenResult(user, forceRefresh) Trả về Mã thông báo web JSON giải tuần tự (JWT) dùng để xác định người dùng cho dịch vụ Firebase.
linkWithCredential(người dùng, thông tin xác thực) Liên kết tài khoản người dùng với thông tin đăng nhập đã cho.
linkWithPhoneNumber(người dùng, phoneNumber, appVerifier) Liên kết tài khoản người dùng với số điện thoại đã cho.
linkWithPopup(người dùng, nhà cung cấp, trình phân giải) Liên kết nhà cung cấp đã xác thực với tài khoản người dùng bằng quy trình OAuth dựa trên cửa sổ bật lên.
linkWithredirect(người dùng, nhà cung cấp, trình phân giải) Liên kết OAuthProvider với tài khoản người dùng bằng quy trình chuyển hướng toàn trang.
multiFactor(người dùng) MultiFactorUser tương ứng với người dùng.
xác thực lại bằng thông tin xác thực(người dùng, thông tin xác thực) Xác thực lại người dùng bằng thông tin đăng nhập mới.
reauthenticationWithPhoneNumber(người dùng, phoneNumber, appVerifier) Xác thực lại người dùng bằng thông tin đăng nhập mới trên điện thoại.
recredentialWithPopup(người dùng, nhà cung cấp, trình phân giải) Xác thực lại người dùng hiện tại bằng OAuthProvider được chỉ định bằng luồng OAuth dựa trên cửa sổ bật lên.
reauthenticationWith Redirect(người dùng, nhà cung cấp, trình phân giải) Xác thực lại người dùng hiện tại bằng OAuthProvider được chỉ định bằng quy trình chuyển hướng toàn trang.
tải lại(người dùng) Tải lại dữ liệu tài khoản người dùng nếu đã đăng nhập.
sendEmailVerify(người dùng, actionCodeSettings) Gửi email xác minh cho một người dùng.
huỷ liên kết(người dùng, mã nhà cung cấp) Huỷ liên kết một nhà cung cấp khỏi tài khoản người dùng.
updateEmail(người dùng; newEmail) Cập nhật địa chỉ email của người dùng.
updatePassword(user, newPassword) Cập nhật mật khẩu của người dùng.
updatePhoneNumber(người dùng, thông tin đăng nhập) Cập nhật số điện thoại của người dùng.
updateProfile(người dùng, { displayName, photoURL: photoUrl }) Cập nhật dữ liệu hồ sơ của người dùng.
verifybeforeUpdateEmail(người dùng, email mới, actionCodeSettings) Gửi email xác minh đến một địa chỉ email mới.
hàm(userCredential, ...)
getAdditionalUserInfo(userCredential) Trích xuất AdditionalUserInfo dành riêng cho nhà cung cấp cho thông tin đăng nhập đã cho.

Lớp học

Hạng Mô tả
ActionCodeURL Một lớp tiện ích giúp phân tích cú pháp các URL hành động liên quan đến email như đặt lại mật khẩu, xác minh email, đăng nhập vào đường liên kết email, v.v.
Xác thực thông tin xác thực Giao diện đại diện cho thông tin xác thực do AuthProvider trả về.
EmailAuthCredential Giao diện biểu thị thông tin xác thực mà EmailAuthProvider trả về cho ProviderId.
EmailAuthProvider Nhà cung cấp dịch vụ tạo EmailAuthCredential.
FacebookAuthProvider Nhà cung cấp dịch vụ tạo OAuthCredential cho ProviderId.FACEBOOK.
GithubAuthProvider Nhà cung cấp để tạo OAuthCredential cho ProviderId.GITHUB.
GoogleAuthProvider Nhà cung cấp để tạo OAuthCredential cho ProviderId.GOOGLE.
Thông tin xác thực OAuth Biểu thị thông tin xác thực OAuth do OAuthProvider trả về.
OAuthProvider Nhà cung cấp để tạo OAuthCredential chung.
PhoneAuthCredential Biểu thị thông tin xác thực do PhoneAuthProvider trả về.
PhoneAuthProvider Nhà cung cấp dùng để tạo PhoneAuthCredential.
PhoneMultiFactorGenerator Nhà cung cấp để tạo PhoneMultiFactorAssertion.
ReCAPTCHAVerifier Trình xác minh ứng dụng dựa trên reCAPTCHA.
SAMLAuthProvider AuthProvider cho SAML.
TotpMultiFactorGenerator Nhà cung cấp để tạo TotpMultiFactorAssertion.
TotpSecret Nhà cung cấp để tạo TotpMultiFactorAssertion.Lưu trữ khoá bí mật dùng chung và các tham số khác để tạo OTP dựa trên thời gian. Triển khai các phương thức để truy xuất khoá bí mật dùng chung và tạo URL của mã QR.
TwitterAuthProvider Nhà cung cấp để tạo OAuthCredential cho ProviderId.TWITTER.

Giao diện

Giao diện Mô tả
ActionCodeInfo Phản hồi của checkActionCode().
ActionCodeSettings Một giao diện xác định URL tiếp tục/trạng thái bắt buộc với giá trị nhận dạng gói Android và iOS không bắt buộc.
Thông tin người dùng bổ sung Cấu trúc chứa thông tin bổ sung về người dùng từ một nhà cung cấp danh tính được liên kết.
ApplicationVerifier Trình xác minh để xác minh miền và ngăn chặn hành vi sai trái.
Xác thực Giao diện đại diện cho dịch vụ Xác thực Firebase.
Lỗi Auth Giao diện cho lỗi Auth.
AuthErrorMap Liên kết mã lỗi với thông báo lỗi.
AuthProvider Giao diện đại diện cho trình cung cấp dịch vụ xác thực, dùng để hỗ trợ việc tạo AuthCredential.
AuthSettings (Cài đặt xác thực) Giao diện đại diện cho chế độ cài đặt của thực thể Auth (Xác thực).
Cấu hình Giao diện đại diện cho cấu hình Auth.
Xác nhận kết quả Kết quả từ việc đăng nhập, liên kết hoặc xác thực lại cuộc gọi bằng số điện thoại.
Phần phụ thuộc Các phần phụ thuộc có thể dùng để khởi chạy phiên bản Auth (Xác thực).
EmulatorConfig Cấu hình của Trình mô phỏng xác thực Firebase.
IdTokenResult Giao diện đại diện cho kết quả mã thông báo giá trị nhận dạng thu được từ User.getIdTokenResult().
MultiFactorAssertion (Xác nhận đa yếu tố) Lớp cơ sở để xác nhận quyền sở hữu yếu tố thứ hai.
Lỗi nhiều yếu tố Lỗi được báo cáo khi người dùng cần cung cấp một yếu tố thứ hai để đăng nhập thành công.
Thông tin đa yếu tố Cấu trúc chứa thông tin của thực thể yếu tố thứ hai.
Giải pháp đa yếu tố Lớp này được dùng để hỗ trợ việc khôi phục từ MultiFactorError khi người dùng cần cung cấp một yếu tố thứ hai để đăng nhập.
MultiFactorSession (Phiên đa yếu tố) Một giao diện xác định đối tượng phiên đa yếu tố dùng để đăng ký yếu tố thứ hai cho người dùng hoặc giúp đăng nhập vào người dùng đã đăng ký bằng yếu tố thứ hai.
MultiFactorUser (Người dùng đa yếu tố) Một giao diện xác định các thuộc tính và thao tác liên quan đến đa yếu tố liên quan đến một Người dùng.
OAuthCredentialOptions Xác định các tuỳ chọn để khởi chạy OAuthCredential.
ParedToken Giao diện biểu thị một mã thông báo giá trị nhận dạng đã phân tích cú pháp.
Chính sách mật khẩu Cấu trúc chỉ định các yêu cầu của chính sách mật khẩu.
PasswordValidationStatus Cấu trúc cho biết những yêu cầu nào của chính sách về mật khẩu được đáp ứng hoặc vi phạm và các yêu cầu đó là gì.
Khả năng duy trì Một giao diện bao gồm các loại cơ chế cố định có thể có.
PhoneMultiFactorAssertion Lớp để xác nhận quyền sở hữu yếu tố thứ hai của số điện thoại. Do PhoneMultiFactorGenerator.assertion() cung cấp.
PhoneMultiFactor Tốc độ đăng ký Các lựa chọn dùng để đăng ký yếu tố thứ hai.
PhoneMultiFactorInfo Lớp con của giao diện MultiFactorInfo cho các yếu tố thứ hai của số điện thoại. factorId của yếu tố thứ hai này là FactorId.PHONE.
PhoneMultiFactorSignInInfoOptions Các tuỳ chọn dùng để đăng nhập bằng yếu tố thứ hai.
PhoneSingleFactorInfoOptions Các tuỳ chọn dùng cho hoạt động đăng nhập bằng một yếu tố.
Trình chuyển hướng bật lên Trình phân giải dùng để xử lý các hoạt động cụ thể của DOM như signInWithPopup() hoặc signInWithredirect().
ReactNativeAsyncStorage Giao diện cho AsyncStorage được cung cấp.
ReCAPTCHAParameters Giao diện biểu thị các tham số reCAPTCHA.Hãy xem tài liệu về reCAPTCHA để biết danh sách các tham số được chấp nhận. Tất cả thông số đều được chấp nhận, ngoại trừ sitekey: Tính năng Xác thực Firebase cung cấp một reCAPTCHA cho mỗi dự án và sẽ định cấu hình khoá trang web khi kết xuất.Đối với một reCAPTCHA vô hình, hãy đặt khoá size thành invisible.
TotpMultiFactorAssertion Lớp để xác nhận quyền sở hữu đối với yếu tố thứ hai TOTP. Do TotpMultiFactorGenerator.assertionForCreation() và TotpMultiFactorGenerator.assertionForSignIn().
TotpMultiFactorInfo Lớp con của giao diện MultiFactorInfo cho các yếu tố thứ hai của TOTP. factorId của yếu tố thứ hai này là FactorId.TOTP.
User Tài khoản người dùng.
Thông tin đăng nhập của người dùng Một cấu trúc chứa User, OperationType và mã nhà cung cấp.
Thông tin người dùng Thông tin hồ sơ người dùng, chỉ hiển thị với các ứng dụng của dự án Firebase.
Siêu dữ liệu người dùng Giao diện trình bày siêu dữ liệu của một người dùng.

Biến

Biến Mô tả
ActionCodeOperation Bảng liệt kê các loại thao tác liên quan đến email.
AuthErrorCodes Bản đồ các mã lỗi Auth tiềm ẩn, giúp dễ dàng so sánh với các lỗi mà SDK tạo ra.
browserLocalPersistence Hoạt động triển khai tính năng Persistence (Tính bền vững) thuộc loại LOCAL sử dụng localStorage cho bộ nhớ cơ bản.
browserPopupRedirectResolver Việc triển khai PopupTransitionResolver phù hợp với các ứng dụng dựa trên trình duyệt.
browserSessionPersistence Hoạt động triển khai tính năng Persistence của SESSION bằng sessionStorage cho bộ nhớ cơ bản.
cordovaPopupRedirectResolver Việc triển khai PopupredirectResolver phù hợp với các ứng dụng dựa trên Cordova.
debugErrorMap Bản đồ lỗi chi tiết có nội dung mô tả chi tiết cho hầu hết các mã lỗi.Xem nội dung thảo luận tại AuthErrorMap
Mã nhận dạng yếu tố Một danh sách các yếu tố có thể dùng để xác thực đa yếu tố.
indexedDBLocalPersistence Hoạt động triển khai tính năng Persistence (Tính bền vững) thuộc loại LOCAL sử dụng indexedDB cho bộ nhớ cơ bản.
inMemoryPersistence Hoạt động triển khai Lưu trữ cố định thuộc loại "KHÔNG CÓ".
OperationType Bảng liệt kê các loại thao tác được hỗ trợ.
prodErrorMap Bản đồ lỗi tối thiểu đã loại bỏ tất cả thông báo lỗi chi tiết.Xem cuộc thảo luận tại AuthErrorMap
ProviderId Danh sách nhà cung cấp được hỗ trợ.
SignInMethod Bảng liệt kê phương thức đăng nhập được hỗ trợ.

Nhập bí danh

Nhập bí danh Mô tả
Thông số tuỳ chỉnh Bản đồ các Thông số tuỳ chỉnh OAuth.
NextOrObserver Định nghĩa kiểu dữ liệu cho lệnh gọi lại sự kiện.
PhoneInfoOptions Thông tin cần thiết để xác minh quyền sở hữu số điện thoại.
UserProfile Hồ sơ người dùng được dùng trong AdditionalUserInfo.

function(app, ...)

getAuth(ứng dụng)

Trả về phiên bản Xác thực được liên kết với FirebaseApp được cung cấp. Nếu không có phiên bản nào, hãy khởi chạy một phiên bản Xác thực với các phần phụ thuộc mặc định dành riêng cho nền tảng.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
ứng dụng Ứng dụng Firebase Ứng dụng Firebase.

Trường hợp trả lại hàng:

Xác thực

segmentationAuth(app; phần phụ thuộc)

Khởi chạy một thực thể Xác thực với quyền kiểm soát chi tiết đối với Phần phụ thuộc.

Hàm này cho phép kiểm soát thực thể Auth có nhiều hơn so với getAuth(). getAuth sử dụng các giá trị mặc định dành riêng cho từng nền tảng để cung cấp Phần phụ thuộc. Nhìn chung, getAuth là cách dễ nhất để khởi chạy tính năng Xác thực và hoạt động trong hầu hết các trường hợp sử dụng. Sử dụng initializeAuth nếu bạn cần kiểm soát lớp cố định nào được dùng hoặc để giảm thiểu kích thước gói nếu bạn hiện không sử dụng signInWithPopup hoặc signInWithRedirect.

Ví dụ: nếu ứng dụng của bạn chỉ sử dụng tài khoản ẩn danh và bạn chỉ muốn lưu tài khoản cho phiên hiện tại, hãy khởi chạy Auth bằng:

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

Chữ ký:

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

Thông số

Thông số Loại Mô tả
ứng dụng Ứng dụng Firebase
Phần phụ thuộc Phần phụ thuộc

Trường hợp trả lại hàng:

Xác thực

function(lưu trữ, ...)

getReactNativePersistence(bộ nhớ)

Trả về một đối tượng cố định bao bọc AsyncStorage được nhập từ react-native hoặc @react-native-community/async-storage và có thể dùng trong trường phần phụ thuộc cố định trong initializeAuth().

Chữ ký:

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

Thông số

Thông số Loại Mô tả
lượng nước giữ lại ReactNativeAsyncStorage

Trường hợp trả lại hàng:

Khả năng duy trì

hàm(auth, ...)

ApplyActionCode(auth, oobCode)

Áp dụng mã xác minh được gửi cho người dùng qua email hoặc cơ chế khác ngoài băng tần.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
mã oob chuỗi Đã gửi mã xác minh cho người dùng.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

beforeAuthStateChanged(auth, callback, onabort)

Thêm lệnh gọi lại chặn chạy trước khi thay đổi trạng thái xác thực sẽ thiết lập người dùng mới.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
số gọi lại (người dùng: Người dùng | rỗng) => vô hiệu | Lời hứa<vô hiệu> lệnh gọi lại được kích hoạt trước khi đặt giá trị người dùng mới. Nếu điều này gửi, thì hệ thống sẽ chặn không cho thiết lập người dùng.
onHuỷ () => trống lệnh gọi lại được kích hoạt nếu một lệnh gọi lại beforeAuthStateChanged() sau đó gửi, cho phép bạn huỷ mọi tác dụng phụ.

Trường hợp trả lại hàng:

Huỷ đăng ký

checkActionCode(auth, oobCode)

Kiểm tra mã xác minh được gửi đến người dùng qua email hoặc cơ chế ngoài băng tần khác.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
mã oob chuỗi Đã gửi mã xác minh cho người dùng.

Trường hợp trả lại hàng:

Cam kết<ActionCodeInfo>

siêu dữ liệu về mã.

VerifyPasswordReset(auth, oobCode, newPassword)

Hoàn tất quá trình đặt lại mật khẩu, đã cung cấp một mã xác nhận và mật khẩu mới.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
mã oob chuỗi Đã gửi mã xác nhận cho người dùng.
newPassword chuỗi Mật khẩu mới.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

connectAuthEmulator(auth, url, options)

Thay đổi thực thể Xác thực để giao tiếp với Trình mô phỏng xác thực Firebase, thay vì các dịch vụ Xác thực Firebase chính thức.

Mã này phải được gọi đồng bộ ngay sau lệnh gọi đầu tiên đến startupAuth(). Không sử dụng với thông tin xác thực phát hành công khai vì lưu lượng truy cập của trình mô phỏng không được mã hoá.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
url chuỗi URL mà trình mô phỏng đang chạy (ví dụ: "http://localhost:9099").
tuỳ chọn { disabledCảnh báo: boolean; } Không bắt buộc. options.disableWarnings mặc định là false. Đặt chính sách này thành true để vô hiệu hoá biểu ngữ cảnh báo được đính kèm vào DOM.

Trường hợp trả lại hàng:

trống

Ví dụ

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

createUserWithEmailAndPassword(xác thực, email, mật khẩu)

Tạo tài khoản người dùng mới được liên kết với địa chỉ email và mật khẩu đã chỉ định.

Khi tạo thành công tài khoản người dùng, người dùng này cũng sẽ được đăng nhập vào ứng dụng của bạn.

Việc tạo tài khoản người dùng có thể không thành công nếu tài khoản đã tồn tại hoặc mật khẩu không hợp lệ.

Phương thức này không được hỗ trợ trên các thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
email chuỗi Địa chỉ email của người dùng.
mật khẩu chuỗi Mật khẩu mà người dùng đã chọn.

Trường hợp trả lại hàng:

Cam kết<UserCredential>

Tìm nạpSignInMethodsForEmail(xác thực, email)

Lấy danh sách phương thức đăng nhập có thể sử dụng cho địa chỉ email đã cho. Phương thức này sẽ trả về một danh sách trống khi bật tính năng Bảo vệ liệt kê email, bất kể email đã chỉ định có bao nhiêu phương thức xác thực.

Điều này rất hữu ích để phân biệt các phương thức đăng nhập cho cùng một nhà cung cấp, ví dụ: EmailAuthProvider có 2 phương thức đăng nhập là SignInMethod.EMAIL_Password và SignInMethod.EMAIL_LINK.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
email chuỗi Địa chỉ email của người dùng.Không dùng nữa. Phương pháp hay nhất về bảo mật là di chuyển khỏi phương thức này. Tìm hiểu thêm trong tài liệu về Nền tảng nhận dạng cho nội dung Bảo vệ việc liệt kê email.

Trường hợp trả lại hàng:

Promise&lt;string[]&gt;

getMultiFactorResolver(xác thực, lỗi)

Cung cấp một MultiFactorResolver phù hợp để hoàn tất luồng đa yếu tố.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
error Lỗi nhiều yếu tố Lỗi MultiFactorError xuất hiện trong thao tác đăng nhập hoặc xác thực lại.

Trường hợp trả lại hàng:

Giải pháp đa yếu tố

get RedirectResult(xác thực, trình phân giải)

Trả về UserCredential từ quy trình đăng nhập dựa trên lệnh chuyển hướng.

Nếu đăng nhập thành công, trả về người dùng đã đăng nhập. Nếu đăng nhập không thành công, tức là không thành công do lỗi. Nếu không có hoạt động chuyển hướng nào được gọi, hãy trả về null.

Phương thức này không hoạt động trong môi trường Node.js hoặc với các thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
trình phân giải Trình chuyển hướng bật lên Một bản sao của PopupredirectResolver, không bắt buộc nếu đã được cung cấp để initializeAuth() hoặc do getAuth() cung cấp.

Trường hợp trả lại hàng:

Cam kết<UserCredential | rỗng>

Ví dụ

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

segmentationReCAPTCHAConfig(auth) (xác thực)

Tải cấu hình reCAPTCHA vào thực thể Auth.

Thao tác này sẽ tải cấu hình reCAPTCHA (cho biết liệu quy trình xác minh reCAPTCHA có được kích hoạt cho mỗi nhà cung cấp dịch vụ xác thực hay không) vào phiên Xác thực hiện tại.

Nếu launchReCAPTCHAConfig() không được gọi, thì quy trình xác thực sẽ luôn bắt đầu mà không cần xác minh reCAPTCHA. Nếu nhà cung cấp được định cấu hình để yêu cầu xác minh reCAPTCHA, SDK sẽ tải cấu hình reCAPTCHA một cách minh bạch và khởi động lại luồng xác thực.

Do đó, bằng cách gọi phương thức không bắt buộc này, bạn sẽ giảm độ trễ của các luồng xác thực trong tương lai. Việc tải cấu hình reCAPTCHA sớm cũng sẽ cải thiện tín hiệu mà reCAPTCHA thu thập.

Phương thức này không hoạt động trong môi trường Node.js.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Ví dụ

initializeRecaptchaConfig(auth);

Kiểm tra xem đường liên kết đến có phải là thông tin đăng nhập bằng đường liên kết email phù hợp với signInWithEmailLink() hay không.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
Đường liên kết của email chuỗi Đường liên kết được gửi đến địa chỉ email của người dùng.

Trường hợp trả lại hàng:

boolean

onAuthStateChanged(auth, nextOrObserver, lỗi, đã hoàn tất)

Thêm trình quan sát cho các thay đổi đối với trạng thái đăng nhập của người dùng.

Để giữ hành vi cũ, hãy xem phần onIdTokenChanged().

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
NextOrObserver NextOrObserver<Người dùng> lệnh gọi lại được kích hoạt khi thay đổi.
error ErrorFn Không dùng nữa. Lệnh gọi lại này không bao giờ được kích hoạt. Lỗi đăng nhập/đăng xuất có thể mắc trong các lời hứa được trả về từ chức năng đăng nhập/đăng xuất.
đã hoàn tất Hoàn thành tệp Không dùng nữa. Lệnh gọi lại này không bao giờ được kích hoạt.

Trường hợp trả lại hàng:

Huỷ đăng ký

onIdTokenChanged(auth, nextOrObserver, lỗi, đã hoàn tất)

Thêm trình quan sát cho các thay đổi đối với mã nhận dạng của người dùng đã đăng nhập.

Bao gồm các sự kiện đăng nhập, đăng xuất và làm mới mã thông báo. Mã này sẽ không tự động được kích hoạt khi mã thông báo giá trị nhận dạng hết hạn. Sử dụng User.getIdToken() để làm mới mã thông báo giá trị nhận dạng.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
NextOrObserver NextOrObserver<Người dùng> lệnh gọi lại được kích hoạt khi thay đổi.
error ErrorFn Không dùng nữa. Lệnh gọi lại này không bao giờ được kích hoạt. Lỗi đăng nhập/đăng xuất có thể mắc trong các lời hứa được trả về từ chức năng đăng nhập/đăng xuất.
đã hoàn tất Hoàn thành tệp Không dùng nữa. Lệnh gọi lại này không bao giờ được kích hoạt.

Trường hợp trả lại hàng:

Huỷ đăng ký

thu hồiAccessToken(xác thực, mã thông báo)

Thu hồi mã truy cập đã cấp. Hiện chỉ hỗ trợ mã truy cập OAuth của Apple.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
mã thông báo chuỗi Mã truy cập OAuth của Apple.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

sendPasswordResetEmail(auth, email, actionCodeSettings)

Gửi email đặt lại mật khẩu đến địa chỉ email đã cho. Phương thức này không gửi thông báo lỗi khi không có tài khoản người dùng nào có địa chỉ email đã cung cấp và chế độ Bảo vệ tính năng liệt kê email đang bật.

Để hoàn tất việc đặt lại mật khẩu, hãy gọi confirmPasswordReset() bằng mã được cung cấp trong email mà người dùng đã gửi, cùng với mật khẩu mới do người dùng chỉ định.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
email chuỗi Địa chỉ email của người dùng.
Cài đặt mã hành động ActionCodeSettings ActionCodeSettings.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Ví dụ

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)

Gửi đường liên kết đăng nhập qua email cho người dùng có email được chỉ định.

Không giống như các thao tác email ngoài nhóm khác (đặt lại mật khẩu và xác minh email), bạn phải luôn hoàn tất thao tác đăng nhập trong ứng dụng. Lý do là khi kết thúc luồng, người dùng được dự kiến sẽ đăng nhập và trạng thái Xác thực của họ vẫn được duy trì trong ứng dụng.

Để hoàn tất quy trình đăng nhập bằng đường liên kết email, hãy gọi signInWithEmailLink() bằng địa chỉ email và đường liên kết email được cung cấp trong email gửi cho người dùng.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực
email chuỗi Địa chỉ email của người dùng.
Cài đặt mã hành động ActionCodeSettings ActionCodeSettings.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Ví dụ

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(xác thực, dữ liệu cố định)

Thay đổi kiểu cố định trên thực thể Xác thực cho phiên Auth hiện đã lưu và áp dụng kiểu cố định này cho các yêu cầu đăng nhập trong tương lai, bao gồm cả lượt đăng nhập bằng yêu cầu chuyển hướng.

Nhờ đó, người dùng có thể dễ dàng chỉ định liệu phiên của họ có được ghi nhớ hay không khi đăng nhập. Việc này cũng giúp bạn không bao giờ duy trì trạng thái Auth cho các ứng dụng mà người dùng khác chia sẻ hoặc có dữ liệu nhạy cảm một cách dễ dàng hơn.

Phương thức này không hoạt động trong môi trường Node.js hoặc với các thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
bền vững Khả năng duy trì Giá trị Persistence để sử dụng.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Promise được phân giải sau khi hoàn tất thay đổi liên tục

Ví dụ

setPersistence(auth, browserSessionPersistence);

signInẨn danh(auth)

Đăng nhập không đồng bộ với tư cách người dùng ẩn danh.

Nếu đã có một người dùng ẩn danh đăng nhập, thì người dùng đó sẽ được trả về; nếu không, danh tính người dùng ẩn danh mới sẽ được tạo và trả về.

Các bản sao Auth được tạo bằng FirebaseServerApp không hỗ trợ phương thức này.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).

Trường hợp trả lại hàng:

Cam kết<UserCredential>

signInWithCredential(xác thực, thông tin xác thực)

Đăng nhập không đồng bộ bằng thông tin đăng nhập đã cho.

Bạn có thể sử dụng AuthProvider để tạo thông tin xác thực.

Các bản sao Auth được tạo bằng FirebaseServerApp không hỗ trợ phương thức này.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
giấy chứng nhận Xác thực thông tin xác thực Thông tin xác thực.

Trường hợp trả lại hàng:

Cam kết<UserCredential>

signInWithCustomToken(xác thực, customToken)

Đăng nhập không đồng bộ bằng mã thông báo tuỳ chỉnh.

Mã thông báo tuỳ chỉnh dùng để tích hợp tính năng Xác thực Firebase với các hệ thống xác thực hiện có và phải do một phần phụ trợ xác thực tạo ra bằng cách sử dụng phương thức createCustomToken trong SDK dành cho quản trị viên .

Không thành công với lỗi nếu mã thông báo không hợp lệ, đã hết hạn hoặc không được dịch vụ Xác thực Firebase chấp nhận.

Các bản sao Auth được tạo bằng FirebaseServerApp không hỗ trợ phương thức này.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
mã thông báo tuỳ chỉnh chuỗi Mã thông báo tuỳ chỉnh để đăng nhập.

Trường hợp trả lại hàng:

Cam kết<UserCredential>

signInWithEmailAndPassword(xác thực, email, mật khẩu)

Đăng nhập không đồng bộ bằng email và mật khẩu.

Xảy ra lỗi nếu địa chỉ email và mật khẩu không khớp. Khi tính năng Bảo vệ liệt kê email được bật, phương thức này sẽ không xử lý được thông báo "auth/invalid-credential" trong trường hợp email/mật khẩu không hợp lệ.

Phương thức này không được hỗ trợ trên các thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
email chuỗi Địa chỉ email của người dùng.
mật khẩu chuỗi Mật khẩu của người dùng.

Trường hợp trả lại hàng:

Cam kết<UserCredential>

Đăng nhập không đồng bộ bằng email và đường liên kết đăng nhập vào email.

Nếu không có đường liên kết nào được truyền, thì đường liên kết đó sẽ được suy ra từ URL hiện tại.

Lỗi nếu địa chỉ email không hợp lệ hoặc OTP trong đường liên kết email đã hết hạn.

Các bản sao Auth được tạo bằng FirebaseServerApp không hỗ trợ phương thức này.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
email chuỗi Địa chỉ email của người dùng.
Đường liên kết của email chuỗi Đường liên kết được gửi đến địa chỉ email của người dùng.

Trường hợp trả lại hàng:

Cam kết<UserCredential>

Ví dụ

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)

Đăng nhập không đồng bộ bằng số điện thoại.

Phương thức này gửi một mã qua SMS đến số điện thoại đã cho và trả về một ConfirmationResult. Sau khi người dùng cung cấp mã được gửi đến điện thoại của họ, hãy gọi ConfirmationResult.confirm() kèm theo mã để đăng nhập người dùng.

Để ngăn chặn hành vi sai trái, phương pháp này cũng yêu cầu phải có ApplicationVerifier. SDK này bao gồm một phương thức triển khai dựa trên reCAPTCHA, ReCAPTCHAVerifier. Chức năng này có thể hoạt động trên các nền tảng khác không hỗ trợ RecaptchaVerifier (như React Native), nhưng bạn cần sử dụng hoạt động triển khai ApplicationVerifier của bên thứ ba.

Phương thức này không hoạt động trong môi trường Node.js hoặc với các thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
số điện thoại chuỗi Số điện thoại của người dùng ở định dạng E.164 (ví dụ: +16505550101).
appVerifier ApplicationVerifier ApplicationVerifier.

Trường hợp trả lại hàng:

Cam kết<ConfirmationResult>

Ví dụ

// '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(xác thực, nhà cung cấp, trình phân giải)

Xác thực ứng dụng Firebase bằng quy trình xác thực OAuth dựa trên cửa sổ bật lên.

Nếu thành công, sẽ trả về người dùng đã đăng nhập cùng với thông tin đăng nhập của nhà cung cấp. Nếu đăng nhập không thành công, hàm sẽ trả về đối tượng lỗi chứa thông tin bổ sung về lỗi đó.

Phương thức này không hoạt động trong môi trường Node.js hoặc với các thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
đám mây AuthProvider Nhà cung cấp để xác thực. Trình cung cấp phải là OAuthProvider. Các nhà cung cấp không phải OAuth như EmailAuthProvider sẽ gửi một lỗi.
trình phân giải Trình chuyển hướng bật lên Một bản sao của PopupredirectResolver, không bắt buộc nếu đã được cung cấp để initializeAuth() hoặc do getAuth() cung cấp.

Trường hợp trả lại hàng:

Cam kết<UserCredential>

Ví dụ

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

signInWith Redirect(xác thực, nhà cung cấp, trình phân giải)

Xác thực ứng dụng Firebase bằng quy trình chuyển hướng toàn trang.

Để xử lý kết quả và lỗi cho thao tác này, hãy tham khảo getredirectResult(). Hãy làm theo các phương pháp hay nhất khi sử dụng signInWith chuyển hướng().

Phương thức này không hoạt động trong môi trường Node.js hoặc với các thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
đám mây AuthProvider Nhà cung cấp để xác thực. Trình cung cấp phải là OAuthProvider. Các nhà cung cấp không phải OAuth như EmailAuthProvider sẽ gửi một lỗi.
trình phân giải Trình chuyển hướng bật lên Một bản sao của PopupredirectResolver, không bắt buộc nếu đã được cung cấp để initializeAuth() hoặc do getAuth() cung cấp.

Trường hợp trả lại hàng:

Hứa<không bao giờ>

Ví dụ

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

đăng xuất(auth)

Đăng xuất người dùng hiện tại.

Các bản sao Auth được tạo bằng FirebaseServerApp không hỗ trợ phương thức này.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

updateCurrentUser(auth, người dùng)

Đặt người dùng được cung cấp là Auth.currentUser một cách không đồng bộ trên phiên bản Auth.

Một bản sao mới của người dùng được cung cấp sẽ được tạo và đặt làm currentUser.

Thao tác này sẽ kích hoạt trình nghe onAuthStateChanged() và onIdTokenChanged() như các phương thức đăng nhập khác.

Thao tác này sẽ không thực hiện được kèm theo lỗi nếu người dùng cần cập nhật thuộc về một dự án Firebase khác.

Các bản sao Auth được tạo bằng FirebaseServerApp không hỗ trợ phương thức này.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
người dùng Người dùng | rỗng Người dùng mới.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

useDeviceLanguage(auth)

Đặt ngôn ngữ hiện tại thành tuỳ chọn trình duyệt/thiết bị mặc định.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).

Trường hợp trả lại hàng:

trống

VerifyPassword(xác thực, mật khẩu)

Xác thực mật khẩu theo chính sách mật khẩu đã định cấu hình cho dự án hoặc đối tượng thuê.

Nếu bạn chưa đặt mã đối tượng thuê trên thực thể Auth, thì phương thức này sẽ sử dụng chính sách mật khẩu được định cấu hình cho dự án. Nếu không, phương thức này sẽ sử dụng chính sách đã thiết lập cho đối tượng thuê. Nếu bạn chưa định cấu hình chính sách mật khẩu thì chính sách mặc định đã định cấu hình cho tất cả dự án sẽ được sử dụng.

Nếu quy trình xác thực không thành công do mật khẩu đã gửi không đáp ứng các yêu cầu của chính sách mật khẩu và phương thức này trước đó đã được gọi, thì phương thức này sẽ sử dụng chính sách gần đây nhất hiện có khi được gọi lại.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
mật khẩu chuỗi Mật khẩu để xác thực.

Trường hợp trả lại hàng:

Cam kết<PasswordValidationStatus>

Ví dụ

validatePassword(auth, 'some-password');

VerifyPasswordResetCode(auth, mã)

Kiểm tra mã đặt lại mật khẩu được gửi cho người dùng qua email hoặc cơ chế khác ngoài băng tần.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
xác thực Xác thực Phiên bản Auth (Xác thực).
mã chuỗi Đã gửi mã xác minh cho người dùng.

Trường hợp trả lại hàng:

Cam kết<string>

địa chỉ email của người dùng nếu hợp lệ.

hàm(liên kết, ...)

parseActionCodeURL(liên kết)

Phân tích cú pháp chuỗi liên kết hành động qua email và trả về ActionCodeURL nếu liên kết hợp lệ, nếu không sẽ trả về giá trị rỗng.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
đường liên kết chuỗi

Trường hợp trả lại hàng:

ActionCodeURL | rỗng

hàm(người dùng, ...)

deleteUser(người dùng)

Xoá và đăng xuất người dùng.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

getIdToken(người dùng, forceRefresh)

Trả về Mã thông báo web JSON (JWT) dùng để nhận dạng người dùng cho dịch vụ Firebase.

Trả về mã thông báo hiện tại nếu mã này chưa hết hạn hoặc chưa hết hạn trong 5 phút tiếp theo. Nếu không, thao tác này sẽ làm mới mã thông báo và trả về một mã mới.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.
Bắt buộc làm mới boolean Buộc làm mới bất kể mã thông báo hết hạn.

Trường hợp trả lại hàng:

Cam kết<string>

getIdTokenResult(người dùng, forceRefresh)

Trả về Mã thông báo web JSON giải tuần tự (JWT) dùng để xác định người dùng cho dịch vụ Firebase.

Trả về mã thông báo hiện tại nếu mã này chưa hết hạn hoặc chưa hết hạn trong 5 phút tiếp theo. Nếu không, thao tác này sẽ làm mới mã thông báo và trả về một mã mới.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.
Bắt buộc làm mới boolean Buộc làm mới bất kể mã thông báo hết hạn.

Trường hợp trả lại hàng:

Cam kết<IdTokenResult>

linkWithCredential(người dùng, thông tin xác thực)

Liên kết tài khoản người dùng với thông tin đăng nhập đã cho.

Bạn có thể sử dụng AuthProvider để tạo thông tin xác thực.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.
giấy chứng nhận Xác thực thông tin xác thực Thông tin xác thực.

Trường hợp trả lại hàng:

Cam kết<UserCredential>

linkWithPhoneNumber(người dùng, phoneNumber, appVerifier)

Liên kết tài khoản người dùng với số điện thoại đã cho.

Phương thức này không hoạt động trong môi trường Node.js.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.
số điện thoại chuỗi Số điện thoại của người dùng ở định dạng E.164 (ví dụ: +16505550101).
appVerifier ApplicationVerifier ApplicationVerifier.

Trường hợp trả lại hàng:

Cam kết<ConfirmationResult>

linkWithPopup(người dùng, nhà cung cấp, trình phân giải)

Liên kết nhà cung cấp đã xác thực với tài khoản người dùng bằng quy trình OAuth dựa trên cửa sổ bật lên.

Nếu liên kết thành công, kết quả trả về sẽ chứa thông tin đăng nhập của người dùng và nhà cung cấp.

Phương thức này không hoạt động trong môi trường Node.js.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.
đám mây AuthProvider Nhà cung cấp để xác thực. Trình cung cấp phải là OAuthProvider. Các nhà cung cấp không phải OAuth như EmailAuthProvider sẽ gửi một lỗi.
trình phân giải Trình chuyển hướng bật lên Một bản sao của PopupredirectResolver, không bắt buộc nếu đã được cung cấp để initializeAuth() hoặc do getAuth() cung cấp.

Trường hợp trả lại hàng:

Cam kết<UserCredential>

Ví dụ

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

linkWith Redirect(người dùng, nhà cung cấp, trình phân giải)

Liên kết OAuthProvider với tài khoản người dùng bằng quy trình chuyển hướng toàn trang.

Để xử lý kết quả và lỗi cho thao tác này, hãy tham khảo getredirectResult(). Hãy làm theo các phương pháp hay nhất khi sử dụng linkWithredirect().

Phương thức này không hoạt động trong môi trường Node.js hoặc với các thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.
đám mây AuthProvider Nhà cung cấp để xác thực. Trình cung cấp phải là OAuthProvider. Các nhà cung cấp không phải OAuth như EmailAuthProvider sẽ gửi một lỗi.
trình phân giải Trình chuyển hướng bật lên Một bản sao của PopupredirectResolver, không bắt buộc nếu đã được cung cấp để initializeAuth() hoặc do getAuth() cung cấp.

Trường hợp trả lại hàng:

Hứa<không bao giờ>

Ví dụ

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

đa yếu tố(người dùng)

MultiFactorUser tương ứng với người dùng.

Thuộc tính này dùng để truy cập vào tất cả các thuộc tính và thao tác đa yếu tố liên quan đến người dùng.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.

Trường hợp trả lại hàng:

MultiFactorUser (Người dùng đa yếu tố)

xác thực lại bằng thông tin xác thực(người dùng, thông tin xác thực)

Xác thực lại người dùng bằng thông tin đăng nhập mới.

Sử dụng trước các thao tác như updatePassword() yêu cầu mã thông báo của những lần đăng nhập gần đây. Bạn có thể dùng phương thức này để khôi phục từ lỗi CREDENTIAL_TOO_OLD_LOGIN_AGAIN hoặc lỗi TOKEN_EXPIRED.

Phương thức này không được hỗ trợ trên bất cứ Người dùng nào đã đăng nhập bằng các bản sao Xác thực được tạo bằng FirebaseServerApp.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.
giấy chứng nhận Xác thực thông tin xác thực Thông tin xác thực.

Trường hợp trả lại hàng:

Cam kết<UserCredential>

rexác thựcWithPhoneNumber(người dùng, phoneNumber, appVerifier)

Xác thực lại người dùng bằng thông tin đăng nhập mới trên điện thoại.

Sử dụng trước các thao tác như updatePassword() yêu cầu mã thông báo của những lần đăng nhập gần đây.

Phương thức này không hoạt động trong môi trường Node.js hoặc trên bất kỳ Người dùng nào đăng nhập bằng các bản sao Xác thực được tạo bằng FirebaseServerApp.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.
số điện thoại chuỗi Số điện thoại của người dùng ở định dạng E.164 (ví dụ: +16505550101).
appVerifier ApplicationVerifier ApplicationVerifier.

Trường hợp trả lại hàng:

Cam kết<ConfirmationResult>

reverifyWithPopup(người dùng, nhà cung cấp, trình phân giải)

Xác thực lại người dùng hiện tại bằng OAuthProvider được chỉ định bằng luồng OAuth dựa trên cửa sổ bật lên.

Nếu xác thực lại thành công, kết quả được trả về sẽ chứa thông tin xác thực của người dùng và nhà cung cấp.

Phương thức này không hoạt động trong môi trường Node.js hoặc trên bất kỳ Người dùng nào đăng nhập bằng các bản sao Xác thực được tạo bằng FirebaseServerApp.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.
đám mây AuthProvider Nhà cung cấp để xác thực. Trình cung cấp phải là OAuthProvider. Các nhà cung cấp không phải OAuth như EmailAuthProvider sẽ gửi một lỗi.
trình phân giải Trình chuyển hướng bật lên Một bản sao của PopupredirectResolver, không bắt buộc nếu đã được cung cấp để initializeAuth() hoặc do getAuth() cung cấp.

Trường hợp trả lại hàng:

Cam kết<UserCredential>

Ví dụ

// Sign in using a popup.
const provider = new FacebookAuthProvider();
const result = await signInWithPopup(auth, provider);
// Reauthenticate using a popup.
await reauthenticateWithPopup(result.user, provider);

reVerifyWithTransition(người dùng, nhà cung cấp, trình phân giải)

Xác thực lại người dùng hiện tại bằng OAuthProvider được chỉ định bằng quy trình chuyển hướng toàn trang.

Để xử lý kết quả và lỗi cho thao tác này, hãy tham khảo getredirectResult(). Hãy làm theo các phương pháp hay nhất khi sử dụng reauthenticatorWithredirect().

Phương thức này không hoạt động trong môi trường Node.js hoặc với các thực thể Auth được tạo bằng FirebaseServerApp.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.
đám mây AuthProvider Nhà cung cấp để xác thực. Trình cung cấp phải là OAuthProvider. Các nhà cung cấp không phải OAuth như EmailAuthProvider sẽ gửi một lỗi.
trình phân giải Trình chuyển hướng bật lên Một bản sao của PopupredirectResolver, không bắt buộc nếu đã được cung cấp để initializeAuth() hoặc do getAuth() cung cấp.

Trường hợp trả lại hàng:

Hứa<không bao giờ>

Ví dụ

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

tải lại(người dùng)

Tải lại dữ liệu tài khoản người dùng nếu đã đăng nhập.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

sendEmailVerify(người dùng, actionCodeSettings)

Gửi email xác minh cho một người dùng.

Quy trình xác minh hoàn tất bằng cách gọi applyActionCode().

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.
Cài đặt mã hành động ActionCodeSettings | rỗng ActionCodeSettings.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Ví dụ

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

Huỷ liên kết một nhà cung cấp khỏi tài khoản người dùng.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.
mã nhà cung cấp chuỗi Nhà cung cấp bạn muốn huỷ liên kết.

Trường hợp trả lại hàng:

Cam kết<Người dùng>

updateEmail(người dùng; email mới)

Cập nhật địa chỉ email của người dùng.

Một email sẽ được gửi đến địa chỉ email ban đầu (nếu có thiết lập) cho phép thu hồi việc thay đổi địa chỉ email nhằm bảo vệ các địa chỉ email này khỏi bị chiếm đoạt tài khoản.

Phương thức này không được hỗ trợ trên bất cứ Người dùng nào đã đăng nhập bằng các bản sao Xác thực được tạo bằng FirebaseServerApp.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.
email mới chuỗi Địa chỉ email mới.Gửi "auth/operation-not- allowed" khi tính năng Bảo vệ liệt kê email đang bật. Không dùng nữa – Thay vào đó, hãy sử dụng verifyBeforeUpdateEmail().

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

updatePassword(người dùng, newPassword)

Cập nhật mật khẩu của người dùng.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.
newPassword chuỗi Mật khẩu mới.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

updatePhoneNumber(người dùng, thông tin đăng nhập)

Cập nhật số điện thoại của người dùng.

Phương thức này không hoạt động trong môi trường Node.js hoặc trên bất kỳ Người dùng nào đăng nhập bằng các bản sao Xác thực được tạo bằng FirebaseServerApp.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.
giấy chứng nhận PhoneAuthCredential Thông tin xác thực xác thực số điện thoại mới.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Ví dụ

// '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(người dùng, { displayName, photoURL: photoUrl })

Cập nhật dữ liệu hồ sơ của người dùng.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.
{ displayName, photoURL: photoUrl } { displayName?: string | null; photoURL?: string | null; }

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Xác minhtrướcUpdateEmail(người dùng, Email mới, actionCodeSettings)

Gửi email xác minh đến một địa chỉ email mới.

Email của người dùng sẽ được cập nhật thành email mới sau khi quá trình xác minh hoàn tất.

Nếu có một trình xử lý thao tác qua email tuỳ chỉnh, bạn có thể hoàn tất quy trình xác minh bằng cách gọi applyActionCode().

Chữ ký:

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

Thông số

Thông số Loại Mô tả
người dùng User Người dùng.
email mới chuỗi Địa chỉ email mới cần được xác minh trước khi cập nhật.
Cài đặt mã hành động ActionCodeSettings | rỗng ActionCodeSettings.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Ví dụ

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

function(userCredential, ...)

getAdditionalUserInfo(userCredential)

Trích xuất AdditionalUserInfo dành riêng cho nhà cung cấp cho thông tin đăng nhập đã cho.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
thông tin xác thực người dùng Thông tin đăng nhập của người dùng Thông tin đăng nhập của người dùng.

Trường hợp trả lại hàng:

Thông tin người dùng bổ sung | rỗng

Hành động mã

Bảng liệt kê các loại thao tác liên quan đến email.

Chữ ký:

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

Mã AuthError

Bản đồ các mã lỗi Auth tiềm ẩn, giúp dễ dàng so sánh với các lỗi mà SDK tạo ra.

Lưu ý rằng bạn không thể lắc từng khoá riêng lẻ trong bản đồ, vì vậy, bằng cách sử dụng bản đồ, bạn có thể tăng đáng kể kích thước gói của mình.

Chữ ký:

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

Hoạt động triển khai tính năng Persistence (Tính bền vững) thuộc loại LOCAL sử dụng localStorage cho bộ nhớ cơ bản.

Chữ ký:

browserLocalPersistence: Persistence

trình duyệtPopupredirectResolver

Việc triển khai PopupTransitionResolver phù hợp với các ứng dụng dựa trên trình duyệt.

Phương thức này không hoạt động trong môi trường Node.js.

Chữ ký:

browserPopupRedirectResolver: PopupRedirectResolver

browserSessionPersistence

Hoạt động triển khai tính năng Persistence của SESSION bằng sessionStorage cho bộ nhớ cơ bản.

Chữ ký:

browserSessionPersistence: Persistence

cordovaPopupRedirectResolver

Việc triển khai PopupredirectResolver phù hợp với các ứng dụng dựa trên Cordova.

Chữ ký:

cordovaPopupRedirectResolver: PopupRedirectResolver

DebugErrorMap

Bản đồ lỗi chi tiết có nội dung mô tả chi tiết cho hầu hết các mã lỗi.

Xem cuộc thảo luận tại AuthErrorMap

Chữ ký:

debugErrorMap: AuthErrorMap

Mã nhận dạng yếu tố

Một danh sách các yếu tố có thể dùng để xác thực đa yếu tố.

Chữ ký:

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

lập chỉ mụcDBLocalPersistence

Hoạt động triển khai tính năng Persistence (Tính bền vững) thuộc loại LOCAL sử dụng indexedDB cho bộ nhớ cơ bản.

Chữ ký:

indexedDBLocalPersistence: Persistence

trong bộ nhớ cố định

Hoạt động triển khai Lưu trữ cố định thuộc loại "KHÔNG CÓ".

Chữ ký:

inMemoryPersistence: Persistence

OperationType

Bảng liệt kê các loại thao tác được hỗ trợ.

Chữ ký:

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

Lỗi sản xuất

Bản đồ lỗi tối thiểu đã loại bỏ tất cả các thông báo lỗi chi tiết.

Xem cuộc thảo luận tại AuthErrorMap

Chữ ký:

prodErrorMap: AuthErrorMap

Mã nhà cung cấp

Danh sách nhà cung cấp được hỗ trợ.

Chữ ký:

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

Phương thức đăng nhập

Bảng liệt kê phương thức đăng nhập được hỗ trợ.

Chữ ký:

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

Thông số tùy chỉnh

Bản đồ các Thông số tuỳ chỉnh OAuth.

Chữ ký:

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

NextOrObserver

Định nghĩa kiểu dữ liệu cho lệnh gọi lại sự kiện.

Chữ ký:

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

Tùy chọn thông tin điện thoại

Thông tin cần thiết để xác minh quyền sở hữu số điện thoại.

Thông tin cần thiết tuỳ thuộc vào việc bạn đang đăng nhập bằng một yếu tố, đăng ký đa yếu tố hay đăng nhập đa yếu tố.

Chữ ký:

export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;

UserProfile

Hồ sơ người dùng được dùng trong AdditionalUserInfo.

Chữ ký:

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