Panduan
Cara menggunakan Autentikasi Firebase di Capacitor
Menggunakan @capgo/capacitor-autentikasi-firebase
Plugin Capacitor untuk Autentikasi Firebase.
Instal
bun add @capgo/capacitor-firebase-authentication
bunx cap sync
bunx cap sync Menggandakan kode plugin asli code ke proyek-proyek native Anda. Jalankan lagi setelah setiap pembaruan plugin.
Import
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
API secara ringkas
| Metode | Deskripsi |
|---|---|
applyActionCode |
Menerapkan verifikasi code yang dikirimkan melalui email. |
confirmPasswordReset |
Mengakhiri proses reset kata sandi. |
confirmVerificationCode |
Mengakhiri proses verifikasi nomor telepon. |
createUserWithEmailAndPassword |
Membuat akun pengguna baru dengan email dan kata sandi. Jika akun baru dibuat, pengguna akan masuk secara otomatis. |
deleteUser |
Menghapus dan keluar dari akun. |
fetchSignInMethodsForEmail |
Mengambil metode masuk untuk alamat email tertentu. |
getCurrentUser |
Mengambil pengguna yang sedang masuk. |
getPendingAuthResult |
Mengembalikan nilai SignInResult Jika aplikasi Anda meluncurkan alur masuk web dan sistem operasi membersihkan aplikasi saat berada di latar belakang. |
getIdToken |
Mengambil Token Auth Firebase untuk pengguna yang saat ini masuk. |
getIdTokenResult |
Mengembalikan token JWT yang telah di deserialisasi untuk mengidentifikasi pengguna ke layanan Firebase. |
getRedirectResult |
Mengembalikan nilai SignInResult Token dari alur masuk berbasis redirect. |
getTenantId |
Mengambil id tenant. |
isSignInWithEmailLink |
Mengidentifikasi apakah tautan masuk adalah tautan masuk email yang sesuai untuk signInWithEmailLink. |
linkWithApple |
Menghubungkan akun pengguna dengan penyedia autentikasi Apple. |
linkWithEmailAndPassword |
Menghubungkan akun pengguna dengan penyedia autentikasi email. |
linkWithEmailLink |
Menghubungkan akun pengguna dengan penyedia autentikasi email. |
linkWithFacebook |
Menghubungkan akun pengguna dengan penyedia autentikasi Facebook. |
linkWithGameCenter |
Terhubungkan akun pengguna dengan penyedia autentikasi Game Center. |
linkWithGithub |
Terhubungkan akun pengguna dengan penyedia autentikasi GitHub. |
linkWithGoogle |
Terhubungkan akun pengguna dengan penyedia autentikasi Google. |
linkWithMicrosoft |
Terhubungkan akun pengguna dengan penyedia autentikasi Microsoft. |
linkWithOpenIdConnect |
Terhubungkan akun pengguna dengan penyedia autentikasi OpenID Connect. |
linkWithPhoneNumber |
Terhubungkan akun pengguna dengan penyedia autentikasi Nomor Telepon. |
linkWithPlayGames |
Terhubungkan akun pengguna dengan penyedia autentikasi Play Games. |
linkWithTwitter |
Terhubungkan akun pengguna dengan penyedia autentikasi Twitter. |
linkWithYahoo |
Terhubungkan akun pengguna dengan penyedia autentikasi Yahoo. |
reload |
Memulihkan data akun pengguna, jika sudah masuk. |
revokeAccessToken |
Membatalkan token akses yang diberikan. Saat ini hanya mendukung token akses OAuth Apple. |
sendEmailVerification |
Mengirimkan email verifikasi kepada pengguna yang sudah masuk. |
sendPasswordResetEmail |
Mengirim email pengaturan kata sandi. |
sendSignInLinkToEmail |
Mengirim tautan login ke pengguna dengan alamat email yang ditentukan. |
setLanguageCode |
Mengatur bahasa pengguna untuk operasi autentikasi menjadi code. |
setPersistence |
Mengatur jenis penyimpanan untuk sesi autentikasi yang disimpan saat ini. |
setTenantId |
Mengatur ID penyewa. |
signInAnonymously |
Masuk sebagai pengguna anonim. |
signInWithApple |
Mengaktifkan alur login Apple. |
signInWithCustomToken |
Mengaktifkan alur login Token Kustom. |
signInWithEmailAndPassword |
Mengaktifkan alur login menggunakan email dan kata sandi. |
signInWithEmailLink |
Masuk menggunakan email dan tautan login email. |
signInWithFacebook |
Mengaktifkan alur login Facebook. |
signInWithGameCenter |
Mengaktifkan alur login Game Center. |
signInWithGithub |
Mengaktifkan GitHub alur masuk. |
signInWithGoogle |
Mengaktifkan alur masuk Google. |
signInWithMicrosoft |
Mengaktifkan alur masuk Microsoft. |
signInWithOpenIdConnect |
Mengaktifkan alur masuk OpenID Connect. |
signInWithPhoneNumber |
Mengaktifkan alur masuk menggunakan nomor telepon. |
signInWithPlayGames |
Mengaktifkan alur masuk Play Games. |
signInWithTwitter |
Mengaktifkan alur masuk Twitter. |
signInWithYahoo |
Mengaktifkan alur masuk Yahoo. |
signOut |
Mengaktifkan alur keluar. |
unlink |
Menghilangkan penyedia dari akun pengguna. |
updateEmail |
Mengupdate alamat email pengguna yang saat ini masuk. |
updatePassword |
Mengupdate kata sandi pengguna yang saat ini masuk. |
updateProfile |
Memperbarui data profil pengguna. |
useAppLanguage |
Menetapkan bahasa pengguna yang dihadapi code sebagai bahasa aplikasi default. |
useEmulator |
Menginstrument aplikasi untuk berbicara dengan emulator Autentikasi. |
verifyBeforeUpdateEmail |
Memverifikasi alamat email baru sebelum memperbarui alamat email pengguna yang sedang masuk. |
checkAppTrackingTransparencyPermission |
Mengecek status saat ini dari transparansi pelacakan aplikasi. |
requestAppTrackingTransparencyPermission |
Membuka dialog sistem untuk mengotorisasi transparansi pelacakan aplikasi. |
Contoh
applyActionCode()
Mengaplikasikan verifikasi code yang dikirimkan ke pengguna melalui email.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.applyActionCode({ oobCode: 'oob-code' });
confirmPasswordReset()
Mengakhiri proses reset kata sandi.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.confirmPasswordReset({
oobCode: 'oob-code',
newPassword: 'new-password',
});
confirmVerificationCode()
Mengakhiri proses verifikasi nomor telepon.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.confirmVerificationCode({
verificationId: 'phoneCodeSent',
verificationCode: 'phoneCodeSent',
});
// The result holds sensitive values: use it without logging it.
createUserWithEmailAndPassword()
Membuat akun pengguna baru dengan email dan kata sandi. Jika akun baru dibuat, pengguna akan masuk secara otomatis.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.createUserWithEmailAndPassword({
email: 'user@example.com',
password: 'password',
});
// The result holds sensitive values: use it without logging it.
deleteUser()
Menghapus dan keluar pengguna.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.deleteUser();
fetchSignInMethodsForEmail()
Memperoleh metode masuk untuk alamat email.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.fetchSignInMethodsForEmail({ email: 'user@example.com' });
console.log(result);
Tabel di atas menampilkan 59 metode inti. Bantuan listener dan versi, serta kontrak lengkap setiap metode, dapat dilihat di repository GitHub.
Dengarkan event
addListener mengembalikan sebuah handle. Panggil handle.remove() ketika layar dihapus, atau FirebaseAuthentication.removeAllListeners() untuk membersihkan setiap pendengar.
Referensi penuh
Teruskan dari Menggunakan @capgo/capacitor-firebase-authentication
If Anda menggunakan Menggunakan @capgo/capacitor-firebase-authentication untuk merencanakan autentikasi dan alur akun, hubungkannya dengan @capgo/capacitor-login Sosial untuk detail implementasi di @capgo/capacitor-social-login, @capgo/capacitor-passkey untuk detail implementasi di @capgo/capacitor-passkey, @capgo/capacitor-native-biometric untuk detail implementasi di @capgo/capacitor-native-biometric, Autentikasi dua faktor untuk detail implementasi di Autentikasi dua faktor, dan SSO (Enterprise) untuk detail implementasi di SSO (Enterprise).