Panduan Memulai
Salin prompt setup yang berisi langkah install dan panduan markdown lengkap untuk plugin ini.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-firebase-authentication`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/firebase-authentication/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
Anda bisa menggunakan AI-Assisted Setup kami untuk menginstal plugin ini. Tambahkan skill Capgo ke tool AI Anda dengan command berikut:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsLalu gunakan prompt berikut:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-firebase-authentication` plugin in my project.Jika Anda lebih memilih Manual Setup, instal plugin dengan menjalankan perintah berikut dan ikuti petunjuk khusus platform di bawah ini:
bun add @capgo/capacitor-firebase-authenticationnpx cap syncimport { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';Mulai cepat
Bagian berjudul “Mulai cepat”import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.applyActionCode({ oobCode: 'oob-code' });Contoh: confirmPasswordReset
Bagian berjudul “Contoh: confirmPasswordReset”import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.confirmPasswordReset({ oobCode: 'oob-code', newPassword: 'new-password',});Contoh: confirmVerificationCode
Bagian berjudul “Contoh: confirmVerificationCode”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.Kesalahan umum
Bagian berjudul “Kesalahan umum”- Listener: hapus handle saat screen unmount.
- Sinkronisasi Native: jalankan
npx cap syncsetelah upgrade plugin. - Sumber kebenaran tunggal: percayai
src/definitions.tsdi repo GitHub.
Ringkasan API
Bagian berjudul “Ikhtisar API”applyActionCode
Bagian berjudul “applyActionCode”Menerapkan verifikasi code yang dikirim ke pengguna lewat email.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.applyActionCode({ oobCode: 'oob-code' });confirmPasswordReset
Bagian berjudul “confirmPasswordReset”Menyelesaikan proses reset password.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.confirmPasswordReset({ oobCode: 'oob-code', newPassword: 'new-password',});confirmVerificationCode
Bagian berjudul “confirmVerificationCode”Menyelesaikan 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
Bagian berjudul “createUserWithEmailAndPassword”Membuat akun pengguna baru dengan email dan kata sandi. Jika akun baru berhasil 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
Bagian berjudul “deleteUser”Menghapus dan logout pengguna.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.deleteUser();fetchSignInMethodsForEmail
Bagian berjudul “fetchSignInMethodsForEmail”Mengambil metode sign-in untuk alamat email.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.fetchSignInMethodsForEmail({ email: 'user@example.com' });console.log(result);getCurrentUser
Bagian berjudul “getCurrentUser”Mengambil data pengguna yang sedang login.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.getCurrentUser();// The result holds sensitive values: use it without logging it.getPendingAuthResult
Bagian berjudul “getPendingAuthResult”Mengembalikan SignInResult jika aplikasi Anda memulai alur sign-in web dan OS membersihkan aplikasi saat berada di latar belakang.
Hanya tersedia untuk Android.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.getPendingAuthResult();// The result holds sensitive values: use it without logging it.getIdToken
Bagian berjudul “getIdToken”Mengambil Firebase Auth ID Token untuk user yang sedang login.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.getIdToken();// The result holds sensitive values: use it without logging it.getIdTokenResult
Bagian berjudul “getIdTokenResult”Mengembalikan JSON Web Token (JWT) hasil deserialisasi yang dipakai untuk mengidentifikasi user ke layanan Firebase.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.getIdTokenResult();// The result holds sensitive values: use it without logging it.getRedirectResult
Bagian berjudul “getRedirectResult”Mengembalikan SignInResult dari alur sign-in berbasis redirect.
Jika sign-in tidak berhasil, akan gagal dengan error.
Jika tidak ada operasi redirect yang dipanggil, akan mengembalikan SignInResult dengan user null.
Hanya tersedia untuk Web.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.getRedirectResult();// The result holds sensitive values: use it without logging it.getTenantId
Bagian berjudul “getTenantId”Dapatkan tenant id.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.getTenantId();console.log(result);isSignInWithEmailLink
Bagian berjudul “isSignInWithEmailLink”Memeriksa apakah link yang masuk adalah sign-in with email link yang cocok untuk signInWithEmailLink.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.isSignInWithEmailLink({ emailLink: 'https://example.com' });// The result holds sensitive values: use it without logging it.linkWithApple
Bagian berjudul “linkWithApple”Menghubungkan akun pengguna dengan penyedia autentikasi Apple.
User harus sudah login di layer native. skipNativeAuth opsi konfigurasi tidak berpengaruh di sini.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithApple();// The result holds sensitive values: use it without logging it.linkWithEmailAndPassword
Bagian berjudul “linkWithEmailAndPassword”Menghubungkan akun pengguna dengan penyedia autentikasi Email.
User harus sudah login di layer native. skipNativeAuth opsi konfigurasi tidak berpengaruh di sini.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithEmailAndPassword({ email: 'user@example.com', password: 'password',});// The result holds sensitive values: use it without logging it.linkWithEmailLink
Bagian berjudul “linkWithEmailLink”Menghubungkan akun pengguna dengan penyedia autentikasi Email.
User harus sudah login di layer native. skipNativeAuth opsi konfigurasi tidak berpengaruh di sini.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithEmailLink({ email: 'user@example.com', emailLink: 'https://example.com',});// The result holds sensitive values: use it without logging it.linkWithFacebook
Bagian berjudul “linkWithFacebook”Menghubungkan akun pengguna dengan provider autentikasi Facebook.
User harus sudah login di layer native. skipNativeAuth opsi konfigurasi tidak berpengaruh di sini.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithFacebook();// The result holds sensitive values: use it without logging it.linkWithGameCenter
Bagian berjudul “linkWithGameCenter”Menghubungkan akun pengguna dengan provider autentikasi Game Center.
User harus sudah login di layer native. skipNativeAuth opsi konfigurasi tidak berpengaruh di sini.
Hanya tersedia untuk iOS.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithGameCenter();// The result holds sensitive values: use it without logging it.linkWithGithub
Bagian berjudul “linkWithGithub”Menghubungkan akun pengguna dengan penyedia autentikasi GitHub.
User harus sudah login di layer native. skipNativeAuth opsi konfigurasi tidak berpengaruh di sini.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithGithub();// The result holds sensitive values: use it without logging it.linkWithGoogle
Bagian berjudul “linkWithGoogle”Menghubungkan akun pengguna dengan penyedia autentikasi Google.
User harus sudah login di layer native. skipNativeAuth opsi konfigurasi tidak berpengaruh di sini.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithGoogle();// The result holds sensitive values: use it without logging it.linkWithMicrosoft
Bagian berjudul “linkWithMicrosoft”Menghubungkan akun pengguna dengan penyedia autentikasi Microsoft.
User harus sudah login di layer native. skipNativeAuth opsi konfigurasi tidak berpengaruh di sini.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithMicrosoft();// The result holds sensitive values: use it without logging it.linkWithOpenIdConnect
Bagian berjudul “linkWithOpenIdConnect”Menghubungkan akun pengguna dengan provider OpenID Connect.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithOpenIdConnect({ providerId: 'provider-id-123' });// The result holds sensitive values: use it without logging it.linkWithPhoneNumber
Bagian berjudul “linkWithPhoneNumber”Menghubungkan akun pengguna dengan provider autentikasi nomor telepon.
User harus sudah login di layer native. skipNativeAuth opsi konfigurasi tidak berpengaruh di sini.
Gunakan phoneVerificationCompleted listener untuk menerima notifikasi saat verifikasi selesai.
Gunakan phoneVerificationFailed listener untuk menerima notifikasi saat verifikasi gagal.
Gunakan phoneCodeSent listener untuk mendapatkan verification id.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.linkWithPhoneNumber({ phoneNumber: "+16505550101" });linkWithPlayGames
Bagian berjudul “linkWithPlayGames”Menghubungkan akun pengguna dengan penyedia autentikasi Play Games.
User harus sudah login di layer native. skipNativeAuth opsi konfigurasi tidak berpengaruh di sini.
Hanya tersedia untuk Android.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithPlayGames();// The result holds sensitive values: use it without logging it.linkWithTwitter
Bagian berjudul “linkWithTwitter”Menghubungkan akun pengguna dengan penyedia autentikasi Twitter.
User harus sudah login di layer native. skipNativeAuth opsi konfigurasi tidak berpengaruh di sini.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithTwitter();// The result holds sensitive values: use it without logging it.linkWithYahoo
Bagian berjudul “linkWithYahoo”Menghubungkan akun pengguna dengan penyedia autentikasi Yahoo.
User harus sudah login di layer native. skipNativeAuth opsi konfigurasi tidak berpengaruh di sini.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.linkWithYahoo();// The result holds sensitive values: use it without logging it.reload
Bagian berjudul “reload”Memuat ulang data akun pengguna, jika sudah login.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.reload();revokeAccessToken
Bagian berjudul “revokeAccessToken”Mencabut access token yang diberikan. Saat ini hanya mendukung access token Apple OAuth.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.revokeAccessToken({ token: 'token-123' });sendEmailVerification
Bagian berjudul “sendEmailVerification”Mengirim email verifikasi ke pengguna yang sedang login.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.sendEmailVerification();sendPasswordResetEmail
Bagian berjudul “sendPasswordResetEmail”Mengirim email reset password.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.sendPasswordResetEmail({ email: 'user@example.com' });sendSignInLinkToEmail
Bagian berjudul “sendSignInLinkToEmail”Mengirim link sign-in ke pengguna dengan email yang ditentukan.
Untuk menyelesaikan sign in dengan tautan email, panggil signInWithEmailLink dengan alamat email dan tautan email yang disertakan dalam email yang dikirim ke pengguna.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.sendSignInLinkToEmail({ email: 'user@example.com', actionCodeSettings: { url: 'https://example.com' },});setLanguageCode
Bagian berjudul “setLanguageCode”Mengatur bahasa code untuk operasi auth.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.setLanguageCode({ languageCode: "en-US" });setPersistence
Bagian berjudul “setPersistence”Mengatur tipe persistensi untuk sesi auth yang tersimpan.
Hanya tersedia untuk Web.
import { FirebaseAuthentication, Persistence } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.setPersistence({ persistence: Persistence.IndexedDbLocal });setTenantId
Bagian berjudul “setTenantId”Mengatur tenant id.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.setTenantId({ tenantId: 'tenant-id-123' });signInAnonymously
Bagian berjudul “signInAnonymously”Masuk sebagai pengguna anonim.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInAnonymously();// The result holds sensitive values: use it without logging it.signInWithApple
Bagian berjudul “signInWithApple”Memulai alur sign-in Apple.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithApple();// The result holds sensitive values: use it without logging it.signInWithCustomToken
Bagian berjudul “signInWithCustomToken”Memulai alur sign-in Custom Token.
Metode ini tidak bisa digunakan bersamaan dengan skipNativeAuth di Android dan iOS.
Dalam hal ini, Anda harus menggunakan signInWithCustomToken interface dari Firebase JS SDK secara langsung.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithCustomToken({ token: 'token-123' });// The result holds sensitive values: use it without logging it.signInWithEmailAndPassword
Bagian berjudul “signInWithEmailAndPassword”Memulai alur sign-in menggunakan email dan password.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithEmailAndPassword({ email: 'user@example.com', password: 'password',});// The result holds sensitive values: use it without logging it.signInWithEmailLink
Bagian berjudul “signInWithEmailLink”Login menggunakan email dan link email sign-in.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithEmailLink({ email: 'user@example.com', emailLink: 'https://example.com',});// The result holds sensitive values: use it without logging it.signInWithFacebook
Bagian berjudul “signInWithFacebook”Memulai alur login Facebook.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithFacebook();// The result holds sensitive values: use it without logging it.signInWithGameCenter
Bagian berjudul “signInWithGameCenter”Memulai alur login Game Center.
Hanya tersedia untuk iOS.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithGameCenter();// The result holds sensitive values: use it without logging it.signInWithGithub
Bagian berjudul “signInWithGithub”Memulai alur login GitHub.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithGithub();// The result holds sensitive values: use it without logging it.signInWithGoogle
Bagian berjudul “signInWithGoogle”Memulai alur login Google.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithGoogle();// The result holds sensitive values: use it without logging it.signInWithMicrosoft
Bagian berjudul “signInWithMicrosoft”Memulai alur login Microsoft.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithMicrosoft();// The result holds sensitive values: use it without logging it.signInWithOpenIdConnect
Bagian berjudul “signInWithOpenIdConnect”Memulai alur login OpenID Connect.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithOpenIdConnect({ providerId: 'provider-id-123' });// The result holds sensitive values: use it without logging it.signInWithPhoneNumber
Bagian berjudul “signInWithPhoneNumber”Memulai alur login menggunakan nomor telepon.
Gunakan phoneVerificationCompleted listener untuk menerima notifikasi saat verifikasi selesai.
Gunakan phoneVerificationFailed listener untuk menerima notifikasi saat verifikasi gagal.
Gunakan phoneCodeSent listener untuk mendapatkan verification id.
Hanya tersedia untuk Android dan iOS.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signInWithPhoneNumber({ phoneNumber: "+16505550101" });signInWithPlayGames
Bagian berjudul “signInWithPlayGames”Memulai alur login Play Games.
Hanya tersedia untuk Android.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithPlayGames();// The result holds sensitive values: use it without logging it.signInWithTwitter
Bagian dengan judul “signInWithTwitter”Memulai alur login Twitter.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithTwitter();// The result holds sensitive values: use it without logging it.signInWithYahoo
Bagian berjudul “signInWithYahoo”Memulai alur login Yahoo.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.signInWithYahoo();// The result holds sensitive values: use it without logging it.signOut
Bagian berjudul “signOut”Memulai alur logout.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signOut();unlink
Bagian berjudul “unlink”Memutus tautan provider dari akun pengguna.
import { FirebaseAuthentication, ProviderId } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.unlink({ providerId: ProviderId.APPLE });// The result holds sensitive values: use it without logging it.updateEmail
Bagian berjudul “updateEmail”Memperbarui alamat email pengguna yang sedang login.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.updateEmail({ newEmail: 'user@example.com' });updatePassword
Bagian berjudul “updatePassword”Memperbarui password pengguna yang sedang login.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.updatePassword({ newPassword: 'new-password' });updateProfile
Bagian berjudul “updateProfile”Memperbarui data profil pengguna.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.updateProfile({ displayName: 'display', photoUrl: 'https://example.com',});useAppLanguage
Bagian berjudul “useAppLanguage”Menetapkan bahasa yang ditampilkan ke pengguna code sebagai bahasa default aplikasi.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.useAppLanguage();useEmulator
Bagian berjudul “useEmulator”Instrumenkan aplikasi Anda untuk berkomunikasi dengan emulator Authentication.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.useEmulator({ host: "127.0.0.1" });verifyBeforeUpdateEmail
Bagian berjudul “verifyBeforeUpdateEmail”Memverifikasi alamat email baru sebelum memperbarui email pengguna yang sedang login.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.verifyBeforeUpdateEmail({ newEmail: 'user@example.com' });checkAppTrackingTransparencyPermission
Bagian berjudul “checkAppTrackingTransparencyPermission”Memeriksa status app tracking transparency saat ini.
Hanya tersedia di iOS.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.checkAppTrackingTransparencyPermission();console.log(result);requestAppTrackingTransparencyPermission
Bagian berjudul “requestAppTrackingTransparencyPermission”Membuka dialog sistem untuk memberikan izin app tracking transparency.
Perhatian: Pengguna mungkin telah menonaktifkan permintaan tracking di pengaturan perangkat, lihat Dokumentasi Apple.
Hanya tersedia di iOS.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.requestAppTrackingTransparencyPermission();console.log(result);Referensi Tipe
Bagian berjudul “Referensi Tipe”ApplyActionCodeOptions
Bagian berjudul “ApplyActionCodeOptions”export interface ApplyActionCodeOptions { /** * A verification code sent to the user. * * @since 0.2.2 */ oobCode: string;}ConfirmPasswordResetOptions
Bagian berjudul “ConfirmPasswordResetOptions”export interface ConfirmPasswordResetOptions { /** * A verification code sent to the user. * * @since 0.2.2 */ oobCode: string; /** * The new password. * * @since 0.2.2 */ newPassword: string;}ConfirmVerificationCodeOptions
Bagian berjudul “ConfirmVerificationCodeOptions”export interface ConfirmVerificationCodeOptions { /** * The verification ID received from the `phoneCodeSent` listener. * * The `verificationCode` option must also be provided. * * @since 5.0.0 */ verificationId: string; /** * The verification code either received from the `phoneCodeSent` listener or entered by the user. * * The `verificationId` option must also be provided. * * @since 5.0.0 */ verificationCode: string;}SignInResult
Bagian berjudul “SignInResult”export interface SignInResult { /** * The currently signed-in user, or null if there isn't any. * * @since 0.1.0 */ user: User | null; /** * Credentials returned by an auth provider. * * @since 0.1.0 */ credential: AuthCredential | null; /** * Additional user information from a federated identity provider. * * @since 0.5.1 */ additionalUserInfo: AdditionalUserInfo | null;}CreateUserWithEmailAndPasswordOptions
Bagian berjudul “CreateUserWithEmailAndPasswordOptions”export interface CreateUserWithEmailAndPasswordOptions { /** * @since 0.2.2 */ email: string; /** * @since 0.2.2 */ password: string;}FetchSignInMethodsForEmailOptions
Bagian berjudul “FetchSignInMethodsForEmailOptions”export interface FetchSignInMethodsForEmailOptions { /** * The user's email address. * * @since 6.0.0 */ email: string;}FetchSignInMethodsForEmailResult
Bagian berjudul “FetchSignInMethodsForEmailResult”export interface FetchSignInMethodsForEmailResult { /** * The sign-in methods for the specified email address. * * This list is empty when [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) * is enabled, irrespective of the number of authentication methods available for the given email. * * @since 6.0.0 */ signInMethods: string[];}GetCurrentUserResult
Bagian berjudul “GetCurrentUserResult”export interface GetCurrentUserResult { /** * The currently signed-in user, or null if there isn't any. * * @since 0.1.0 */ user: User | null;}GetIdTokenOptions
Bagian berjudul “GetIdTokenOptions”export interface GetIdTokenOptions { /** * Force refresh regardless of token expiration. * * @since 0.1.0 */ forceRefresh: boolean;}GetIdTokenResult
Bagian berjudul “GetIdTokenResult”export interface GetIdTokenResult { /** * The Firebase Auth ID token JWT string. * * @since 0.1.0 */ token: string;}GetIdTokenResultOptions
Bagian berjudul “GetIdTokenResultOptions”export interface GetIdTokenResultOptions { /** * Force refresh regardless of token expiration. * * @since 7.4.0 */ forceRefresh: boolean;}GetIdTokenResultResult
Bagian berjudul “GetIdTokenResultResult”export interface GetIdTokenResultResult { /** * The authentication time in milliseconds since the epoch. * * This is the time the user authenticated (signed in) and not the time the token was refreshed. * * @since 7.4.0 */ authTime: number; /** * The ID token expiration time in milliseconds since the epoch. * * @since 7.4.0 */ expirationTime: number; /** * The ID token issuance time in milliseconds since the epoch. * * @since 7.4.0 */ issuedAtTime: number; /** * The sign-in provider through which the ID token was obtained. * * @since 7.4.0 */ signInProvider: string | null; /** * The type of second factor associated with this session, provided the user was multi-factor * authenticated (eg. phone, etc). * * @since 7.4.0 */ signInSecondFactor: string | null; /** * The entire payload claims of the ID token including the standard reserved claims as well as * the custom claims. * * @since 7.4.0 */ claims: Record<string, unknown>;}Sumber Kebenaran
Bagian berjudul “Sumber Kebenaran”Halaman ini dibuat dari plugin src/definitions.ts. Jalankan ulang sync saat API publik berubah di upstream.
Lanjutkan dari Getting Started
Bagian berjudul “Lanjutkan dari Getting Started”Jika Anda menggunakan Panduan Memulai untuk merencanakan alur autentikasi dan akun, hubungkan dengan @capgo/capacitor-social-login 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 pada Two-factor authentication, dan SSO (Enterprise) untuk detail implementasi pada SSO (Enterprise).