auth package

Firebase Authentication

Functions

Fungsi	Deskripsi
fungsi(aplikasi, ...)
getAuth(aplikasi)	Menampilkan instance Auth yang terkait dengan FirebaseApp yang disediakan. Jika tidak ada instance, lakukan inisialisasi instance Auth dengan dependensi default khusus platform.
InitializeAuth(app, deps)	Menginisialisasi instance Auth dengan kontrol terperinci atas Dependensi.
fungsi(penyimpanan, ...)
getReactNativePersistence(penyimpanan)	Menampilkan objek persistensi yang menggabungkan AsyncStorage yang diimpor dari react-native atau @react-native-community/async-storage, dan dapat digunakan dalam kolom dependensi persistensi di InitializeAuth().
function(auth, ...)
applyActionCode(auth, oobCode)	Menerapkan kode verifikasi yang dikirim kepada pengguna melalui email atau mekanisme lain.
beforeAuthStateChanges(auth, callback, onAbort)	Menambahkan callback pemblokiran yang berjalan sebelum perubahan status autentikasi menetapkan pengguna baru.
checkActionCode(auth, oobCode)	Memeriksa kode verifikasi yang dikirim kepada pengguna melalui email atau mekanisme out-of-band lainnya.
confirmPasswordReset(auth, oobCode, newPassword)	Menyelesaikan proses reset sandi, yang diberi kode konfirmasi dan sandi baru.
connectAuthEmulator(auth, url, opsi)	Mengubah instance Auth untuk berkomunikasi dengan Emulator Firebase Auth, bukan layanan Firebase Auth produksi.
createUserWithEmailAndPassword(autentikasi, email, sandi)	Membuat akun pengguna baru yang dikaitkan dengan alamat email dan sandi yang ditentukan.
fetchSignInMethodsForEmail(auth, email)	Mendapatkan daftar metode login yang mungkin untuk alamat email tertentu. Metode ini menampilkan daftar kosong saat Perlindungan Enumerasi Email diaktifkan, terlepas dari jumlah metode autentikasi yang tersedia untuk email tertentu.
getMultiFactorResolver(auth, error)	Menyediakan MultiFactorResolver yang sesuai untuk penyelesaian alur multi-faktor.
getRedirectResult(auth, resolver)	Menampilkan UserCredential dari alur login berbasis pengalihan.
InitializeRecaptchaConfig(auth)	Memuat konfigurasi reCAPTCHA ke instance Auth.
isSignInWithEmailLink(auth, emailLink)	Memeriksa apakah link masuk merupakan login dengan link email yang cocok untuk signInWithEmailLink().
onAuthStateChanges(auth, nextOrObserver, error, completed)	Menambahkan observer untuk perubahan pada status login pengguna.
onIdTokenDiubah(auth, nextOrObserver, error, selesai)	Menambahkan observer untuk perubahan pada token ID pengguna yang login.
revokeAccessToken(auth, token)	Mencabut token akses yang diberikan. Saat ini hanya mendukung token akses Apple OAuth.
sendPasswordResetEmail(auth, email, actionCodeSettings)	Mengirim email reset sandi ke alamat email yang diberikan. Metode ini tidak menampilkan error jika tidak ada akun pengguna dengan alamat email yang diberikan dan Email Enumeration Protection diaktifkan.
sendSignInLinkToEmail(auth, email, actionCodeSettings)	Mengirim link email login kepada pengguna dengan email yang ditentukan.
setPersistence(auth, persistensi)	Mengubah jenis persistensi pada instance Auth untuk sesi Auth yang saat ini disimpan dan menerapkan jenis persistensi ini untuk permintaan login berikutnya, termasuk login dengan permintaan pengalihan.
signInAnonymously(auth)	Login secara asinkron sebagai pengguna anonim.
signInWithCredential(auth, kredensial)	Login secara asinkron dengan kredensial yang diberikan.
signInWithCustomToken(auth, customToken)	Login secara asinkron menggunakan token kustom.
signInWithEmailAndPassword(auth, email, sandi)	Login secara asinkron menggunakan email dan sandi.
signInWithEmailLink(auth, email, emailLink)	Login secara asinkron menggunakan email dan link email login.
signInWithPhoneNumber(auth, phoneNumber, appVerifier)	Login secara asinkron menggunakan nomor telepon.
signInWithPop-up(auth, provider, resolver)	Mengautentikasi klien Firebase menggunakan alur autentikasi OAuth berbasis pop-up.
signInWithRedirect(auth, provider, resolver)	Mengautentikasi klien Firebase menggunakan alur pengalihan halaman penuh.
signOut(auth)	Membuat pengguna saat ini logout.
updateCurrentUser(auth, pengguna)	Tetapkan pengguna yang disediakan secara asinkron sebagai Auth.currentUser pada instance Auth.
useDeviceLanguage(auth)	Menyetel bahasa saat ini ke preferensi perangkat/browser default.
validatePassword(auth, sandi)	Memvalidasi sandi terhadap kebijakan sandi yang dikonfigurasi untuk project atau tenant.
verifyPasswordResetCode(auth, code)	Memeriksa kode reset sandi yang dikirim kepada pengguna melalui email atau mekanisme lain.
fungsi(link, ...)
parseActionCodeURL(link)	Mengurai string link tindakan email dan menampilkan ActionCodeURL jika link tersebut valid, jika tidak, menampilkan null.
fungsi(pengguna, ...)
deleteUser(pengguna)	Menghapus dan membuat pengguna logout.
getIdToken(pengguna, forceRefresh)	Menampilkan Token Web JSON (JWT) yang digunakan untuk mengidentifikasi pengguna ke layanan Firebase.
getIdTokenResult(pengguna, forceRefresh)	Menampilkan Token Web JSON (JWT) deserialisasi yang digunakan untuk mengidentifikasi pengguna ke layanan Firebase.
linkWithCredential(pengguna, kredensial)	Menautkan akun pengguna dengan kredensial yang diberikan.
linkWithPhoneNumber(pengguna, phoneNumber, appVerifier)	Menautkan akun pengguna dengan nomor telepon yang diberikan.
linkWithPop-up(pengguna, penyedia, resolver)	Menautkan penyedia yang diautentikasi ke akun pengguna menggunakan alur OAuth berbasis pop-up.
linkWithRedirect(pengguna, penyedia, resolver)	Menautkan OAuthProvider ke akun pengguna menggunakan alur pengalihan halaman penuh.
multiFaktor(pengguna)	MultiFactorUser yang sesuai dengan pengguna.
reauthenticateWithCredential(pengguna, kredensial)	Mengautentikasi ulang pengguna menggunakan kredensial baru.
reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier)	Mengautentikasi ulang pengguna menggunakan kredensial ponsel yang baru.
reauthenticateWithPop-up(pengguna, penyedia, resolver)	Mengautentikasi ulang pengguna saat ini dengan OAuthProvider yang ditentukan menggunakan alur OAuth berbasis pop-up.
reauthenticateWithRedirect(pengguna, penyedia, resolver)	Mengautentikasi ulang pengguna saat ini dengan OAuthProvider yang ditentukan menggunakan alur pengalihan halaman penuh.
muat ulang(pengguna)	Memuat ulang data akun pengguna, jika login.
sendEmailVerification(pengguna, actionCodeSettings)	Mengirim email verifikasi ke pengguna.
batalkan tautan(pengguna, penyediaId)	Membatalkan tautan penyedia dari akun pengguna.
updateEmail(pengguna, newEmail)	Memperbarui alamat email pengguna.
updatePassword(pengguna, newPassword)	Memperbarui sandi pengguna.
updatePhoneNumber(pengguna, kredensial)	Memperbarui nomor telepon pengguna.
updateProfile(user, { displayName, photoURL: photoUrl })	Memperbarui data profil pengguna.
verifyBeforeUpdateEmail(pengguna, newEmail, actionCodeSettings)	Mengirim email verifikasi ke alamat email baru.
function(userCredential, ...)
getAdditionalUserInfo(userCredential)	Mengekstrak AdditionalUserInfo khusus penyedia untuk kredensial yang diberikan.

Kelas

Class	Deskripsi
ActionCodeURL	Class utilitas untuk mengurai URL tindakan email seperti reset sandi, verifikasi email, login link email, dll.
AuthCredential	Antarmuka yang mewakili kredensial yang ditampilkan oleh AuthProvider.
EmailAuthCredential	Antarmuka yang mewakili kredensial yang ditampilkan oleh EmailAuthProvider untuk ProviderId.PASSWORD
EmailAuthProvider	Penyedia untuk membuat EmailAuthCredential.
FacebookAuthProvider	Penyedia untuk membuat OAuthCredential bagi ProviderId.FACEBOOK.
GitHubAuthProvider	Penyedia untuk membuat OAuthCredential bagi ProviderId.GITHUB.
GoogleAuthProvider	Penyedia untuk membuat OAuthCredential bagi ProviderId.GOOGLE.
OAuthCredential	Mewakili kredensial OAuth yang ditampilkan oleh OAuthProvider.
OAuthProvider	Penyedia untuk membuat OAuthCredential generik.
PhoneAuthCredential	Mewakili kredensial yang ditampilkan oleh PhoneAuthProvider.
PhoneAuthProvider	Penyedia untuk membuat PhoneAuthCredential.
PhoneMultiFactorGenerator	Penyedia untuk membuat PhoneMultiFactorAssertion.
RecaptchaVerifier	Pemverifikasi aplikasi berbasis reCAPTCHA.
SAMLAuthProvider	AuthProvider untuk SAML.
TotpMultiFactorGenerator	Penyedia untuk membuat TotpMultiFactorAssertion.
TotpSecret	Penyedia untuk membuat TotpMultiFactorAssertion.Menyimpan kunci rahasia bersama dan parameter lainnya untuk menghasilkan OTP berbasis waktu. Mengimplementasikan metode untuk mengambil kunci rahasia bersama dan membuat URL kode QR.
TwitterAuthProvider	Penyedia untuk membuat OAuthCredential bagi ProviderId.TWITTER.

Antarmuka

Antarmuka	Deskripsi
InfoKodeTindakan	Respons dari checkActionCode().
SetelanKodeTindakan	Antarmuka yang menentukan URL continue/status yang diperlukan dengan ID paket Android dan iOS opsional.
InfoPengguna Tambahan	Struktur yang berisi informasi pengguna tambahan dari penyedia identitas gabungan.
ApplicationVerifier	Pemverifikasi untuk verifikasi domain dan pencegahan penyalahgunaan.
Autentikasi	Antarmuka yang merepresentasikan layanan Firebase Auth.
AuthError	Antarmuka untuk error Auth.
AuthErrorMap	Pemetaan kode error terhadap pesan error.
AuthProvider	Antarmuka yang merepresentasikan penyedia autentikasi, yang digunakan untuk memfasilitasi pembuatan AuthCredential.
AuthSettings	Antarmuka yang mewakili setelan instance Auth.
Konfigurasi	Antarmuka yang mewakili konfigurasi Auth.
ConfirmationResult	Hasil dari login, link, atau autentikasi ulang panggilan dengan nomor telepon.
Dependensi	Dependensi yang dapat digunakan untuk menginisialisasi instance Auth.
EmulatorConfig	Konfigurasi Emulator Firebase Authentication.
IdTokenResult	Antarmuka yang mewakili hasil token ID yang diperoleh dari User.getIdTokenResult().
MultiFactorAssertion	Class dasar untuk menegaskan kepemilikan faktor kedua.
MultiFactorError	Error akan ditampilkan saat pengguna harus memberikan faktor kedua agar berhasil login.
Info MultiFaktor	Struktur yang berisi informasi entitas faktor kedua.
MultiFactorResolver	Class yang digunakan untuk memfasilitasi pemulihan dari MultiFactorError saat pengguna perlu memberikan faktor kedua untuk login.
MultiFactorSession	Antarmuka yang menentukan objek sesi multi-faktor yang digunakan untuk mendaftarkan faktor kedua pada pengguna atau membantu membuat pengguna terdaftar login dengan faktor kedua.
MultiFactorUser	Antarmuka yang menentukan properti dan operasi terkait multi-faktor yang berkaitan dengan Pengguna.
OAuthCredentialOptions	Menentukan opsi untuk melakukan inisialisasi OAuthCredential.
ParsedToken	Antarmuka yang mewakili token ID yang diuraikan.
PasswordPolicy	Struktur yang menentukan persyaratan kebijakan {i>password<i}.
PasswordValidationStatus	Struktur yang menunjukkan persyaratan kebijakan {i>password<i} mana yang dipenuhi atau dilanggar dan apa saja persyaratannya.
Persistensi	Antarmuka yang mencakup kemungkinan jenis mekanisme persistensi.
PhoneMultiFactorAssertion	Class untuk menegaskan kepemilikan faktor kedua ponsel. Disediakan oleh PhoneMultiFactorGenerator.Assertion().
PhoneMultiFactorEnrollInfoOptions	Opsi yang digunakan untuk mendaftarkan faktor kedua.
PhoneMultiFactorInfo	Subclass antarmuka MultiFactorInfo untuk faktor kedua nomor telepon. factorId dari faktor kedua ini adalah FactorId.PHONE.
PhoneMultiFactorSignInInfoOptions	Opsi yang digunakan untuk login dengan faktor kedua.
PhoneSingleFactorInfoOptions	Opsi yang digunakan untuk login dengan satu faktor.
PopupRedirectResolver	Resolver yang digunakan untuk menangani operasi khusus DOM seperti signInWithPopup() atau signInWithRedirect().
ReactNativeAsyncStorage	Antarmuka untuk AsyncStorage yang disediakan.
RecaptchaParameters	Antarmuka yang mewakili parameter reCAPTCHA.Lihat dokumen reCAPTCHA untuk mengetahui daftar parameter yang diterima. Semua parameter diterima kecuali sitekey: Firebase Auth menyediakan reCAPTCHA untuk setiap project dan akan mengonfigurasi kunci situs saat rendering.Untuk reCAPTCHA yang tidak terlihat, setel kunci size ke invisible.
TotpMultiFactorAssertion	Class untuk menegaskan kepemilikan faktor kedua TOTP. Disediakan oleh TotpMultiFactorGenerator.AssertionForEnrollment() dan TotpMultiFactorGenerator.bawaanForSignIn().
InfoTotpMultiFactor	Subclass antarmuka MultiFactorInfo untuk faktor kedua TOTP. factorId dari faktor kedua ini adalah FactorId.TOTP.
Pengguna	Akun pengguna.
Kredensial Pengguna	Struktur yang berisi User, OperationType, dan ID penyedia.
Info Pengguna	Informasi profil pengguna, hanya dapat dilihat oleh aplikasi project Firebase.
UserMetadata	Antarmuka yang mewakili metadata pengguna.

Variabel

Variabel	Deskripsi
ActionCodeOperation	Enumerasi kemungkinan jenis tindakan email.
AuthErrorCodes	Peta kode error Auth potensial, untuk memudahkan perbandingan dengan error yang ditampilkan oleh SDK.
browserLocalPersistence	Implementasi Persistensi jenis LOCAL menggunakan localStorage untuk penyimpanan pokok.
browserPopRedirectResolver	Implementasi PopRedirectPengalihanResolver yang cocok untuk aplikasi berbasis browser.
browserSessionPersistence	Implementasi Persistensi SESSION menggunakan sessionStorage untuk penyimpanan pokok.
cordovaPopRedirectResolver	Implementasi PopRedirectRedirectResolver yang cocok untuk aplikasi berbasis Cordova.
debugErrorMap	Peta error yang panjang dengan deskripsi mendetail untuk sebagian besar kode error.Lihat diskusi di AuthErrorMap
FactorId	Enuman faktor yang dapat digunakan untuk otentikasi multifaktor.
indexedDBLocalPersistence	Implementasi Persistensi jenis LOCAL menggunakan indexedDB untuk penyimpanan pokok.
inMemoryPersistence	Implementasi Persistence jenis 'NONE'.
Jenis Operasi	Enumerasi jenis operasi yang didukung.
prodErrorMap	Peta error minimal dengan semua pesan error panjang dihapus.Lihat diskusi di AuthErrorMap
ProviderId	Enumerasi penyedia yang didukung.
SignInMethod	Enumerasi metode login yang didukung.

Ketik Alias

Ketik Alias	Deskripsi
CustomParameters	Peta Parameter Kustom OAuth.
NextOrObserver	Definisi jenis untuk callback peristiwa.
PhoneInfoOptions	Informasi yang diperlukan untuk memverifikasi kepemilikan nomor telepon.
UserProfile	Profil pengguna yang digunakan di AdditionalUserInfo.

function(aplikasi, ...)

getAuth(aplikasi)

Menampilkan instance Auth yang terkait dengan FirebaseApp yang disediakan. Jika tidak ada instance, lakukan inisialisasi instance Auth dengan dependensi default khusus platform.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
aplikasi	AplikasiFirebase	Aplikasi Firebase.

Hasil:

Autentikasi

inisialisasiAuth(app, deps)

Menginisialisasi instance Auth dengan kontrol terperinci atas Dependensi.

Fungsi ini memberikan kontrol yang lebih besar atas instance Auth daripada getAuth(). getAuth menggunakan setelan default khusus platform untuk menyediakan Dependensi. Secara umum, getAuth adalah cara termudah untuk melakukan inisialisasi Auth dan berfungsi untuk sebagian besar kasus penggunaan. Gunakan initializeAuth jika Anda memerlukan kontrol atas lapisan persistensi yang digunakan, atau untuk meminimalkan ukuran paket jika Anda tidak menggunakan signInWithPopup atau signInWithRedirect.

Misalnya, jika aplikasi Anda hanya menggunakan akun anonim dan Anda hanya ingin akun disimpan untuk sesi saat ini, lakukan inisialisasi Auth dengan:

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

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
aplikasi	AplikasiFirebase
dependensi	Dependensi

Hasil:

Autentikasi

function(penyimpanan, ...)

getReactNativePersistence(penyimpanan)

Menampilkan objek persistensi yang menggabungkan AsyncStorage yang diimpor dari react-native atau @react-native-community/async-storage, dan dapat digunakan dalam kolom dependensi persistensi di InitializeAuth().

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
storage	ReactNativeAsyncStorage

Hasil:

Persistensi

function(auth, ...)

applyActionCode(auth, oobCode)

Menerapkan kode verifikasi yang dikirim kepada pengguna melalui email atau mekanisme lain.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
oobCode	string	Kode verifikasi yang dikirim ke pengguna.

Hasil:

Janji<void>

beforeAuthStateChanges(auth, callback, onAbort)

Menambahkan callback pemblokiran yang berjalan sebelum perubahan status autentikasi menetapkan pengguna baru.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
callback	(pengguna: User | null) => tidak berlaku | Janji<void>	yang dipicu sebelum nilai pengguna baru ditetapkan. Jika ditampilkan, tindakan ini akan memblokir penetapan pengguna.
Batalkan	() => kosong	callback dipicu jika callback beforeAuthStateChanged() berikutnya ditampilkan, yang memungkinkan Anda mengurungkan efek samping apa pun.

Hasil:

Berhenti berlangganan

checkActionCode(auth, oobCode)

Memeriksa kode verifikasi yang dikirim kepada pengguna melalui email atau mekanisme out-of-band lainnya.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
oobCode	string	Kode verifikasi yang dikirim ke pengguna.

Hasil:

Promise<ActionCodeInfo>

metadata tentang kode.

konfirmasiPasswordReset(auth, oobCode, newPassword)

Menyelesaikan proses reset sandi, yang diberi kode konfirmasi dan sandi baru.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
oobCode	string	Kode konfirmasi yang dikirim ke pengguna.
sandibaru	string	Sandi baru.

Hasil:

Janji<void>

connectAuthEmulator(auth, url, opsi)

Mengubah instance Auth untuk berkomunikasi dengan Emulator Firebase Auth, bukan layanan Firebase Auth produksi.

Nama ini harus dipanggil secara sinkron segera setelah panggilan pertama ke InitializeAuth(). Jangan gunakan dengan kredensial produksi karena traffic emulator tidak dienkripsi.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
url	string	URL tempat emulator berjalan (misalnya, 'http://localhost:9099').
opsi	{ DisableWarnings: boolean; }	Opsional. options.disableWarnings ditetapkan secara default ke false. Setel ke true untuk menonaktifkan banner peringatan yang dilampirkan ke DOM.

Hasil:

void

Contoh

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

createUserWithEmailAndPassword(autentikasi, email, sandi)

Membuat akun pengguna baru yang dikaitkan dengan alamat email dan sandi yang ditentukan.

Setelah berhasil membuat akun pengguna, pengguna ini juga akan login ke aplikasi Anda.

Pembuatan akun pengguna dapat gagal jika akun sudah ada atau sandi tidak valid.

Metode ini tidak didukung pada instance Auth yang dibuat dengan FirebaseServerApp.

Catatan: Alamat email berfungsi sebagai ID unik pengguna dan dapat digunakan untuk mereset sandi berbasis email. Fungsi ini akan membuat akun pengguna baru dan menetapkan sandi pengguna awal.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
email	string	Alamat email pengguna.
sandi	string	Sandi yang dipilih pengguna.

Hasil:

Promise<UserCredential>

pengambilanSignInMethodsForEmail(auth, email)

Mendapatkan daftar metode login yang mungkin untuk alamat email tertentu. Metode ini menampilkan daftar kosong saat Perlindungan Enumerasi Email diaktifkan, terlepas dari jumlah metode autentikasi yang tersedia untuk email tertentu.

Hal ini berguna untuk membedakan metode login untuk penyedia yang sama, misalnya EmailAuthProvider yang memiliki 2 metode login, SignInMethod.EMAIL_PASSWORD dan SignInMethod.EMAIL_LINK.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
email	string	Alamat email pengguna.Tidak digunakan lagi. Beralih dari metode ini direkomendasikan sebagai praktik terbaik keamanan. Pelajari lebih lanjut di dokumentasi Identity Platform untuk Perlindungan Enumerasi Email.

Hasil:

Promise&lt;string[]&gt;

getMultiFactorResolver(auth, error)

Menyediakan MultiFactorResolver yang sesuai untuk penyelesaian alur multi-faktor.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
error	MultiFactorError	MultiFactorError yang muncul selama login, atau operasi autentikasi ulang.

Hasil:

MultiFactorResolver

getRedirectResult(auth, resolver)

Menampilkan UserCredential dari alur login berbasis pengalihan.

Jika login berhasil, pengguna yang sudah login akan ditampilkan. Jika proses login tidak berhasil, proses akan gagal dengan error. Jika tidak ada operasi pengalihan yang dipanggil, null akan ditampilkan.

Metode ini tidak berfungsi di lingkungan Node.js atau dengan instance Auth yang dibuat dengan FirebaseServerApp.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
{i>resolver<i}	PopupRedirectResolver	Instance PopRedirectResolver, opsional jika sudah disediakan untuk InitializeAuth() atau disediakan oleh getAuth().

Hasil:

Promise<UserCredential | null>

Contoh

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

inisialisasiRecaptchaConfig(auth)

Memuat konfigurasi reCAPTCHA ke instance Auth.

Perintah ini akan memuat konfigurasi reCAPTCHA, yang menunjukkan apakah alur verifikasi reCAPTCHA harus dipicu untuk setiap penyedia autentikasi, ke dalam sesi Auth saat ini.

Jika inisialisasiRecaptchaConfig() tidak dipanggil, alur autentikasi akan selalu dimulai tanpa verifikasi reCAPTCHA. Jika penyedia dikonfigurasi untuk mewajibkan verifikasi reCAPTCHA, SDK akan memuat konfigurasi reCAPTCHA secara transparan dan memulai ulang alur autentikasi.

Jadi, dengan memanggil metode opsional ini, Anda akan mengurangi latensi alur autentikasi di masa mendatang. Memuat konfigurasi reCAPTCHA lebih awal juga akan meningkatkan sinyal yang dikumpulkan oleh reCAPTCHA.

Metode ini tidak berfungsi di lingkungan Node.js.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.

Hasil:

Janji<void>

Contoh

initializeRecaptchaConfig(auth);

isSignInWithEmailLink(auth, emailLink)

Memeriksa apakah link masuk merupakan login dengan link email yang cocok untuk signInWithEmailLink().

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
emailLink	string	Link dikirim ke alamat email pengguna.

Hasil:

boolean

onAuthStateChanges(auth, nextOrObserver, error, completed)

Menambahkan observer untuk perubahan pada status login pengguna.

Untuk mempertahankan perilaku lama, lihat onIdTokenDiubah().

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
nextOrObserver	NextOrObserver<Pengguna>	yang dipicu saat terjadi perubahan.
error	ErrorFn	Tidak digunakan lagi. Callback ini tidak pernah dipicu. Error saat login/logout dapat ditemukan dalam promise yang ditampilkan dari fungsi login/logout.
selesai	CompleteFn	Tidak digunakan lagi. Callback ini tidak pernah dipicu.

Hasil:

Berhenti berlangganan

onIdTokenDiubah(auth, nextOrObserver, error, selesai)

Menambahkan observer untuk perubahan pada token ID pengguna yang login.

Peristiwa ini mencakup peristiwa login, logout, dan refresh token. Tindakan ini tidak akan otomatis dipicu setelah token ID kedaluwarsa. Gunakan User.getIdToken() untuk memperbarui token ID.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
nextOrObserver	NextOrObserver<Pengguna>	yang dipicu saat terjadi perubahan.
error	ErrorFn	Tidak digunakan lagi. Callback ini tidak pernah dipicu. Error saat login/logout dapat ditemukan dalam promise yang ditampilkan dari fungsi login/logout.
selesai	CompleteFn	Tidak digunakan lagi. Callback ini tidak pernah dipicu.

Hasil:

Berhenti berlangganan

BrandConnectAccessToken(auth, token)

Mencabut token akses yang diberikan. Saat ini hanya mendukung token akses Apple OAuth.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
token	string	Token akses OAuth Apple.

Hasil:

Janji<void>

sendPasswordResetEmail(auth, email, actionCodeSettings)

Mengirim email reset sandi ke alamat email yang diberikan. Metode ini tidak menampilkan error jika tidak ada akun pengguna dengan alamat email yang diberikan dan Email Enumeration Protection diaktifkan.

Untuk menyelesaikan reset sandi, panggil confirmPasswordReset() dengan kode yang diberikan dalam email yang dikirimkan kepada pengguna, beserta sandi baru yang ditentukan oleh pengguna.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
email	string	Alamat email pengguna.
{i>actionCodeSettings<i}	SetelanKodeTindakan	ActionCodeSettings.

Hasil:

Janji<void>

Contoh

const actionCodeSettings = {
  url: 'https://www.example.com/?email=[e-mail]',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendPasswordResetEmail(auth, '[e-mail]', actionCodeSettings);
// Obtain code from user.
await confirmPasswordReset('[e-mail]', code);

sendSignInLinkToEmail(auth, email, actionCodeSettings)

Mengirim link email login kepada pengguna dengan email yang ditentukan.

Operasi login harus selalu diselesaikan di aplikasi, tidak seperti tindakan eksternal terkait email yang lain (reset sandi dan verifikasi email). Hal ini perlu dilakukan karena di akhir alur, pengguna diharapkan sudah login dan status Auth-nya tersimpan di dalam aplikasi.

Untuk menyelesaikan login dengan link email, panggil signInWithEmailLink() dengan alamat email dan link email yang dimasukkan dalam email yang dikirim kepada pengguna.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi
email	string	Alamat email pengguna.
{i>actionCodeSettings<i}	SetelanKodeTindakan	ActionCodeSettings.

Hasil:

Janji<void>

Contoh

const actionCodeSettings = {
  url: 'https://www.example.com/?email=[e-mail]',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendSignInLinkToEmail(auth, '[e-mail]', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
  await signInWithEmailLink(auth, '[e-mail]', emailLink);
}

setPersistence(auth, persistensi)

Mengubah jenis persistensi pada instance Auth untuk sesi Auth yang saat ini disimpan dan menerapkan jenis persistensi ini untuk permintaan login berikutnya, termasuk login dengan permintaan pengalihan.

Hal ini memudahkan pengguna untuk login untuk menentukan apakah sesi mereka harus diingat atau tidak. Hal ini juga mempermudah untuk tidak mempertahankan status Auth untuk aplikasi yang dibagikan oleh pengguna lain atau memiliki data sensitif.

Metode ini tidak berfungsi di lingkungan Node.js atau dengan instance Auth yang dibuat dengan FirebaseServerApp.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
persistensi	Persistensi	Persistensi yang akan digunakan.

Hasil:

Janji<void>

Promise yang di-resolve setelah perubahan persistensi selesai

Contoh

setPersistence(auth, browserSessionPersistence);

signInAnonymously(auth)

Login secara asinkron sebagai pengguna anonim.

Jika sudah ada pengguna anonim yang login, pengguna tersebut akan ditampilkan; jika tidak, identitas pengguna anonim baru akan dibuat dan dikembalikan.

Metode ini tidak didukung oleh instance Auth yang dibuat dengan FirebaseServerApp.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.

Hasil:

Promise<UserCredential>

signInWithCredential(auth, kredensial)

Login secara asinkron dengan kredensial yang diberikan.

AuthProvider dapat digunakan untuk membuat kredensial.

Metode ini tidak didukung oleh instance Auth yang dibuat dengan FirebaseServerApp.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
kredensial	AuthCredential	Kredensial auth.

Hasil:

Promise<UserCredential>

signInWithCustomToken(auth, customToken)

Login secara asinkron menggunakan token kustom.

Token kustom digunakan untuk mengintegrasikan Firebase Auth dengan sistem autentikasi yang ada, dan harus dibuat oleh backend autentikasi menggunakan metode createCustomToken di Admin SDK .

Gagal menampilkan error jika token tidak valid, sudah tidak berlaku, atau tidak diterima oleh layanan Firebase Auth.

Metode ini tidak didukung oleh instance Auth yang dibuat dengan FirebaseServerApp.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
tokenkustom	string	Token kustom untuk login.

Hasil:

Promise<UserCredential>

signInWithEmailAndPassword(auth, email, sandi)

Login secara asinkron menggunakan email dan sandi.

Gagal menampilkan pesan error jika alamat email dan sandi tidak cocok. Jika Email Enumeration Protection diaktifkan, metode ini akan gagal dengan "auth/invalid-credential" jika email/kata sandi tidak valid.

Metode ini tidak didukung pada instance Auth yang dibuat dengan FirebaseServerApp.

Catatan: Sandi pengguna BUKAN sandi yang digunakan untuk mengakses akun email pengguna. Alamat email berfungsi sebagai ID unik bagi pengguna, dan sandi digunakan untuk mengakses akun pengguna di project Firebase Anda. Lihat juga: createUserWithEmailAndPassword().

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
email	string	Alamat email pengguna.
sandi	string	Sandi pengguna.

Hasil:

Promise<UserCredential>

signInWithEmailLink(auth, email, emailLink)

Login secara asinkron menggunakan email dan link email login.

Jika tidak ada link yang diteruskan, link akan diambil dari URL saat ini.

Gagal menampilkan error jika alamat email tidak valid atau OTP di link email sudah tidak berlaku.

Metode ini tidak didukung oleh instance Auth yang dibuat dengan FirebaseServerApp.

Catatan: Pastikan bahwa link tersebut adalah link email login sebelum memanggil metode ini firebase.auth.Auth.isSignInWithEmailLink.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
email	string	Alamat email pengguna.
emailLink	string	Link dikirim ke alamat email pengguna.

Hasil:

Promise<UserCredential>

Contoh

const actionCodeSettings = {
  url: 'https://www.example.com/?email=[e-mail]',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendSignInLinkToEmail(auth, '[e-mail]', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
  await signInWithEmailLink(auth, '[e-mail]', emailLink);
}

signInWithPhoneNumber(auth, phoneNumber, appVerifier)

Login secara asinkron menggunakan nomor telepon.

Metode ini mengirimkan kode melalui SMS ke nomor telepon yang ditentukan, dan menampilkan ConfirmationResult. Setelah pengguna memasukkan kode yang dikirimkan ke ponselnya, panggil ConfirmationResult.confirm() dengan kode untuk memproses login pengguna.

Untuk mencegah penyalahgunaan, metode ini juga memerlukan ApplicationVerifier. SDK ini mencakup implementasi berbasis reCAPTCHA, RecaptchaVerifier. Fungsi ini dapat berfungsi di platform lain yang tidak mendukung RecaptchaVerifier (seperti React Native), tetapi Anda harus menggunakan implementasi ApplicationVerifier pihak ketiga.

Metode ini tidak berfungsi di lingkungan Node.js atau dengan instance Auth yang dibuat dengan FirebaseServerApp.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
Nomor telepon	string	Nomor telepon pengguna dalam format E.164 (misalnya, [phone]).
appVerifier	ApplicationVerifier	ApplicationVerifier.

Hasil:

Promise<ConfirmationResult>

Contoh

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

Mengautentikasi klien Firebase menggunakan alur autentikasi OAuth berbasis pop-up.

Jika berhasil, pengguna yang login akan ditampilkan beserta kredensial penyedia. Jika proses login tidak berhasil, objek error yang berisi informasi tambahan tentang error tersebut akan ditampilkan.

Metode ini tidak berfungsi di lingkungan Node.js atau dengan instance Auth yang dibuat dengan FirebaseServerApp.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
penyedia	AuthProvider	Penyedia yang melakukan autentikasi. Penyedia harus berupa OAuthProvider. Penyedia non-OAuth seperti EmailAuthProvider akan menampilkan error.
{i>resolver<i}	PopupRedirectResolver	Instance PopRedirectResolver, opsional jika sudah disediakan untuk InitializeAuth() atau disediakan oleh getAuth().

Hasil:

Promise<UserCredential>

Contoh

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

Mengautentikasi klien Firebase menggunakan alur pengalihan halaman penuh.

Untuk menangani hasil dan error untuk operasi ini, lihat getRedirectResult(). Ikuti praktik terbaik saat menggunakan signInWithRedirect().

Metode ini tidak berfungsi di lingkungan Node.js atau dengan instance Auth yang dibuat dengan FirebaseServerApp.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
penyedia	AuthProvider	Penyedia yang melakukan autentikasi. Penyedia harus berupa OAuthProvider. Penyedia non-OAuth seperti EmailAuthProvider akan menampilkan error.
{i>resolver<i}	PopupRedirectResolver	Instance PopRedirectResolver, opsional jika sudah disediakan untuk InitializeAuth() atau disediakan oleh getAuth().

Hasil:

Janjikan<tidak pernah>

Contoh

// 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(autentikasi)

Membuat pengguna saat ini logout.

Metode ini tidak didukung oleh instance Auth yang dibuat dengan FirebaseServerApp.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.

Hasil:

Janji<void>

updateCurrentUser(auth, pengguna)

Tetapkan pengguna yang disediakan secara asinkron sebagai Auth.currentUser pada instance Auth.

Salinan instance baru dari pengguna yang disediakan akan dibuat dan ditetapkan sebagai currentUser.

Tindakan ini akan memicu pemroses onAuthStateChange() dan onIdTokenDiubah() seperti metode login lainnya.

Operasi akan gagal dengan error jika pengguna yang akan diupdate adalah bagian dari project Firebase yang berbeda.

Metode ini tidak didukung oleh instance Auth yang dibuat dengan FirebaseServerApp.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
user	Pengguna | null (kosong)	Pengguna baru.

Hasil:

Janji<void>

useDeviceLanguage(auth)

Menyetel bahasa saat ini ke preferensi perangkat/browser default.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.

Hasil:

void

validasiPassword(auth, sandi)

Memvalidasi sandi terhadap kebijakan sandi yang dikonfigurasi untuk project atau tenant.

Jika tidak ada ID tenant yang ditetapkan pada instance Auth, metode ini akan menggunakan kebijakan sandi yang dikonfigurasi untuk project tersebut. Jika tidak, metode ini akan menggunakan kebijakan yang dikonfigurasi untuk tenant. Jika kebijakan sandi belum dikonfigurasi, kebijakan default yang dikonfigurasi untuk semua project akan digunakan.

Jika alur autentikasi gagal karena sandi yang dikirimkan tidak memenuhi persyaratan kebijakan sandi dan metode ini sebelumnya telah dipanggil, metode ini akan menggunakan kebijakan terbaru yang tersedia saat dipanggil lagi.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
sandi	string	Sandi yang akan divalidasi.

Hasil:

Promise<PasswordValidationStatus>

Contoh

validatePassword(auth, 'some-password');

VerifyPasswordResetCode(auth, code)

Memeriksa kode reset sandi yang dikirim kepada pengguna melalui email atau mekanisme lain.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
auth	Autentikasi	Instance Auth.
kode	string	Kode verifikasi yang dikirim ke pengguna.

Hasil:

Promise<string>

alamat email pengguna jika valid.

function(link, ...)

menguraiActionCodeURL(link)

Mengurai string link tindakan email dan menampilkan ActionCodeURL jika link tersebut valid, jika tidak, menampilkan null.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
link	string

Hasil:

ActionCodeURL | null (kosong)

function(pengguna, ...)

deleteUser(pengguna)

Menghapus dan membuat pengguna logout.

Penting: ini adalah operasi yang sensitif terhadap keamanan dan mengharuskan pengguna untuk sudah login baru-baru ini. Jika persyaratan ini tidak terpenuhi, minta pengguna untuk melakukan autentikasi lagi, lalu panggil reauthenticateWithCredential().

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.

Hasil:

Janji<void>

getIdToken(pengguna, forceRefresh)

Menampilkan Token Web JSON (JWT) yang digunakan untuk mengidentifikasi pengguna ke layanan Firebase.

Menampilkan token saat ini jika belum habis masa berlakunya atau jika tidak akan habis masa berlakunya dalam lima menit ke depan. Jika tidak, tindakan ini akan memperbarui token dan menampilkan token baru.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.
muat ulang paksa	boolean	Muat ulang paksa terlepas dari masa berlaku token.

Hasil:

Promise<string>

getIdTokenResult(pengguna, forceRefresh)

Menampilkan Token Web JSON (JWT) deserialisasi yang digunakan untuk mengidentifikasi pengguna ke layanan Firebase.

Menampilkan token saat ini jika belum habis masa berlakunya atau jika tidak akan habis masa berlakunya dalam lima menit ke depan. Jika tidak, tindakan ini akan memperbarui token dan menampilkan token baru.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.
muat ulang paksa	boolean	Muat ulang paksa terlepas dari masa berlaku token.

Hasil:

Promise<IdTokenResult>

linkWithCredential(pengguna, kredensial)

Menautkan akun pengguna dengan kredensial yang diberikan.

AuthProvider dapat digunakan untuk membuat kredensial.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.
kredensial	AuthCredential	Kredensial auth.

Hasil:

Promise<UserCredential>

linkWithPhoneNumber(pengguna, phoneNumber, appVerifier)

Menautkan akun pengguna dengan nomor telepon yang diberikan.

Metode ini tidak berfungsi di lingkungan Node.js.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.
Nomor telepon	string	Nomor telepon pengguna dalam format E.164 (misalnya, [phone]).
appVerifier	ApplicationVerifier	ApplicationVerifier.

Hasil:

Promise<ConfirmationResult>

linkWithPop-up(pengguna, penyedia, resolver)

Menautkan penyedia yang diautentikasi ke akun pengguna menggunakan alur OAuth berbasis pop-up.

Jika penautan berhasil, hasil yang ditampilkan akan berisi pengguna dan kredensial penyedia.

Metode ini tidak berfungsi di lingkungan Node.js.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.
penyedia	AuthProvider	Penyedia yang melakukan autentikasi. Penyedia harus berupa OAuthProvider. Penyedia non-OAuth seperti EmailAuthProvider akan menampilkan error.
{i>resolver<i}	PopupRedirectResolver	Instance PopRedirectResolver, opsional jika sudah disediakan untuk InitializeAuth() atau disediakan oleh getAuth().

Hasil:

Promise<UserCredential>

Contoh

// 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(pengguna, penyedia, resolver)

Menautkan OAuthProvider ke akun pengguna menggunakan alur pengalihan halaman penuh.

Untuk menangani hasil dan error untuk operasi ini, lihat getRedirectResult(). Ikuti praktik terbaik saat menggunakan linkWithRedirect().

Metode ini tidak berfungsi di lingkungan Node.js atau dengan instance Auth yang dibuat dengan FirebaseServerApp.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.
penyedia	AuthProvider	Penyedia yang melakukan autentikasi. Penyedia harus berupa OAuthProvider. Penyedia non-OAuth seperti EmailAuthProvider akan menampilkan error.
{i>resolver<i}	PopupRedirectResolver	Instance PopRedirectResolver, opsional jika sudah disediakan untuk InitializeAuth() atau disediakan oleh getAuth().

Hasil:

Janjikan<tidak pernah>

Contoh

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

multiFaktor(pengguna)

MultiFactorUser yang sesuai dengan pengguna.

Kunci ini digunakan untuk mengakses semua properti dan operasi multi-faktor yang terkait dengan pengguna.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.

Hasil:

MultiFactorUser

reauthenticateWithCredential(pengguna, kredensial)

Mengautentikasi ulang pengguna menggunakan kredensial baru.

Gunakan sebelum operasi seperti updatePassword() yang memerlukan token dari upaya login terbaru. Metode ini dapat digunakan untuk memulihkan dari error CREDENTIAL_TOO_OLD_LOGIN_AGAIN atau TOKEN_EXPIRED.

Metode ini tidak didukung pada User mana pun yang login oleh instance Auth yang dibuat dengan FirebaseServerApp.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.
kredensial	AuthCredential	Kredensial auth.

Hasil:

Promise<UserCredential>

reauthenticateWithPhoneNumber(pengguna, phoneNumber, appVerifier)

Mengautentikasi ulang pengguna menggunakan kredensial ponsel yang baru.

Gunakan sebelum operasi seperti updatePassword() yang memerlukan token dari upaya login terbaru.

Metode ini tidak berfungsi di lingkungan Node.js atau di User mana pun yang login oleh instance Auth yang dibuat dengan FirebaseServerApp.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.
Nomor telepon	string	Nomor telepon pengguna dalam format E.164 (misalnya, [phone]).
appVerifier	ApplicationVerifier	ApplicationVerifier.

Hasil:

Promise<ConfirmationResult>

reauthenticateWithPop-up(pengguna, penyedia, resolver)

Mengautentikasi ulang pengguna saat ini dengan OAuthProvider yang ditentukan menggunakan alur OAuth berbasis pop-up.

Jika autentikasi ulang berhasil, hasil yang ditampilkan akan berisi pengguna dan kredensial penyedia.

Metode ini tidak berfungsi di lingkungan Node.js atau di User mana pun yang login oleh instance Auth yang dibuat dengan FirebaseServerApp.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.
penyedia	AuthProvider	Penyedia yang melakukan autentikasi. Penyedia harus berupa OAuthProvider. Penyedia non-OAuth seperti EmailAuthProvider akan menampilkan error.
{i>resolver<i}	PopupRedirectResolver	Instance PopRedirectResolver, opsional jika sudah disediakan untuk InitializeAuth() atau disediakan oleh getAuth().

Hasil:

Promise<UserCredential>

Contoh

// 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(pengguna, penyedia, resolver)

Mengautentikasi ulang pengguna saat ini dengan OAuthProvider yang ditentukan menggunakan alur pengalihan halaman penuh.

Untuk menangani hasil dan error untuk operasi ini, lihat getRedirectResult(). Ikuti praktik terbaik saat menggunakan reauthenticateWithRedirect().

Metode ini tidak berfungsi di lingkungan Node.js atau dengan instance Auth yang dibuat dengan FirebaseServerApp.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.
penyedia	AuthProvider	Penyedia yang melakukan autentikasi. Penyedia harus berupa OAuthProvider. Penyedia non-OAuth seperti EmailAuthProvider akan menampilkan error.
{i>resolver<i}	PopupRedirectResolver	Instance PopRedirectResolver, opsional jika sudah disediakan untuk InitializeAuth() atau disediakan oleh getAuth().

Hasil:

Janjikan<tidak pernah>

Contoh

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

muat ulang(pengguna)

Memuat ulang data akun pengguna, jika login.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.

Hasil:

Janji<void>

sendEmailVerification(pengguna, actionCodeSettings)

Mengirim email verifikasi ke pengguna.

Proses verifikasi diselesaikan dengan memanggil applyActionCode().

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.
{i>actionCodeSettings<i}	ActionCodeSettings | null (kosong)	ActionCodeSettings.

Hasil:

Janji<void>

Contoh

const actionCodeSettings = {
  url: 'https://www.example.com/?email=[e-mail]',
  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);

batalkan tautan(pengguna, providerId)

Membatalkan tautan penyedia dari akun pengguna.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.
providerId	string	Penyedia yang akan dibatalkan tautannya.

Hasil:

Janjikan<User>

updateEmail(pengguna, newEmail)

Memperbarui alamat email pengguna.

Email akan dikirim ke alamat email asli (jika sudah ditetapkan) yang mengizinkan pencabutan perubahan alamat email, untuk melindungi pengguna dari pembajakan akun.

Metode ini tidak didukung pada User mana pun yang login oleh instance Auth yang dibuat dengan FirebaseServerApp.

Penting: ini adalah operasi yang sensitif terhadap keamanan dan mengharuskan pengguna untuk sudah login baru-baru ini. Jika persyaratan ini tidak terpenuhi, minta pengguna untuk melakukan autentikasi lagi, lalu panggil reauthenticateWithCredential().

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.
emailbaru	string	Alamat email baru.Menampilkan "auth/operation-not-permissions" error saat Email Enumeration Protection diaktifkan. Tidak digunakan lagi - Sebagai gantinya, gunakan verifyBeforeUpdateEmail().

Hasil:

Janji<void>

updatePassword(pengguna, newPassword)

Memperbarui sandi pengguna.

Penting: ini adalah operasi yang sensitif terhadap keamanan dan mengharuskan pengguna untuk sudah login baru-baru ini. Jika persyaratan ini tidak terpenuhi, minta pengguna untuk melakukan autentikasi lagi, lalu panggil reauthenticateWithCredential().

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.
sandibaru	string	Sandi baru.

Hasil:

Janji<void>

updatePhoneNumber(pengguna, kredensial)

Memperbarui nomor telepon pengguna.

Metode ini tidak berfungsi di lingkungan Node.js atau di User mana pun yang login oleh instance Auth yang dibuat dengan FirebaseServerApp.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.
kredensial	PhoneAuthCredential	Kredensial yang mengautentikasi nomor telepon baru.

Hasil:

Janji<void>

Contoh

// '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('[phone]', applicationVerifier);
// Obtain the verificationCode from the user.
const phoneCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
await updatePhoneNumber(user, phoneCredential);

updateProfile(pengguna, { displayName, photoURL: photoUrl })

Memperbarui data profil pengguna.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.
{ displayName, photoURL: photoUrl }	{ displayName?: string | null; photoURL?: string | null; }

Hasil:

Janji<void>

VerifyBeforeUpdateEmail(pengguna, newEmail, actionCodeSettings)

Mengirim email verifikasi ke alamat email baru.

Email pengguna akan diperbarui ke email baru setelah diverifikasi.

Jika memiliki pengendali tindakan email kustom, Anda dapat menyelesaikan proses verifikasi dengan memanggil applyActionCode().

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
user	Pengguna	Pengguna.
emailbaru	string	Alamat email baru yang akan diverifikasi sebelum update.
{i>actionCodeSettings<i}	ActionCodeSettings | null (kosong)	ActionCodeSettings.

Hasil:

Janji<void>

Contoh

const actionCodeSettings = {
  url: 'https://www.example.com/?email=[e-mail]',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await verifyBeforeUpdateEmail(user, '[e-mail]', actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);

function(userCredential, ...)

getAdditionalUserInfo(userCredential)

Mengekstrak AdditionalUserInfo khusus penyedia untuk kredensial yang diberikan.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
kredensialpengguna	Kredensial Pengguna	Kredensial pengguna.

Hasil:

AdditionalUserInfo | null (kosong)

ActionCodeOperation

Enumerasi kemungkinan jenis tindakan email.

Tanda Tangan:

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

AuthErrorCode

Peta kode error Auth potensial, untuk memudahkan perbandingan dengan error yang ditampilkan oleh SDK.

Perhatikan, Anda tidak dapat melakukan tree-shaking kunci individual pada peta, sehingga dengan menggunakan peta Anda dapat meningkatkan ukuran paket Anda secara substansial.

Tanda Tangan:

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

Implementasi Persistensi jenis LOCAL menggunakan localStorage untuk penyimpanan pokok.

Tanda Tangan:

browserLocalPersistence: Persistence

browserPop-RedirectResolver

Implementasi PopRedirectPengalihanResolver yang cocok untuk aplikasi berbasis browser.

Metode ini tidak berfungsi di lingkungan Node.js.

Tanda Tangan:

browserPopupRedirectResolver: PopupRedirectResolver

browserSessionPersistence

Implementasi Persistensi SESSION menggunakan sessionStorage untuk penyimpanan pokok.

Tanda Tangan:

browserSessionPersistence: Persistence

CordovaPopRedirectResolver

Implementasi PopRedirectRedirectResolver yang cocok untuk aplikasi berbasis Cordova.

Tanda Tangan:

cordovaPopupRedirectResolver: PopupRedirectResolver

debugErrorMap

Peta error panjang dengan deskripsi mendetail untuk sebagian besar kode error.

Lihat diskusi di AuthErrorMap

Tanda Tangan:

debugErrorMap: AuthErrorMap

IdFaktor

Enuman faktor yang dapat digunakan untuk otentikasi multifaktor.

Tanda Tangan:

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

diindeksDBLocalPersistence

Implementasi Persistensi jenis LOCAL menggunakan indexedDB untuk penyimpanan pokok.

Tanda Tangan:

indexedDBLocalPersistence: Persistence

inMemoryPersistence

Implementasi Persistence jenis 'NONE'.

Tanda Tangan:

inMemoryPersistence: Persistence

OperationType

Enumerasi jenis operasi yang didukung.

Tanda Tangan:

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

prodErrorMap

Peta error minimal dengan semua pesan error panjang dihapus.

Lihat diskusi di AuthErrorMap

Tanda Tangan:

prodErrorMap: AuthErrorMap

ID Penyedia

Enumerasi penyedia yang didukung.

Tanda Tangan:

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

SignInMethod

Enumerasi metode login yang didukung.

Tanda Tangan:

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

ParameterKustom

Peta Parameter Kustom OAuth.

Tanda Tangan:

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

NextOrObserver

Definisi jenis untuk callback peristiwa.

Tanda Tangan:

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

PhoneInfoOptions

Informasi yang diperlukan untuk memverifikasi kepemilikan nomor telepon.

Informasi yang diperlukan bergantung pada apakah Anda yang melakukan login dengan satu faktor, pendaftaran multi-faktor, atau login multi-faktor.

Tanda Tangan:

export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;

UserProfile

Profil pengguna yang digunakan di AdditionalUserInfo.

Tanda Tangan:

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