Getting Started

Instal

Anda dapat menggunakan Pengaturan AI-Assisted untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI Anda menggunakan perintah berikut:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Lalu 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 suka Setup Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah ini:

bun add @capgo/capacitor-firebase-authentication
bunx cap sync

Impor

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

API Ringkasan

applyActionCode

Applies a verification code sent to the user by email.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.applyActionCode({} as ApplyActionCodeOptions);

confirmPasswordReset

Menggunakan proses reset kata sandi.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.confirmPasswordReset({} as ConfirmPasswordResetOptions);

confirmVerificationCode

Menggunakan proses verifikasi nomor telepon.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.confirmVerificationCode({} as ConfirmVerificationCodeOptions);

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

await FirebaseAuthentication.createUserWithEmailAndPassword({} as CreateUserWithEmailAndPasswordOptions);

deleteUser

Menghapus dan keluar dari akun pengguna.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.deleteUser();

fetchSignInMethodsForEmail

Mengambil metode masuk untuk alamat email.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.fetchSignInMethodsForEmail({} as FetchSignInMethodsForEmailOptions);

getCurrentUser

Mengambil pengguna yang sedang masuk.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.getCurrentUser();

getPendingAuthResult

Mengembalikan SignInResult jika aplikasi Anda meluncurkan alur masuk web dan sistem operasi membersihkan aplikasi saat di latar belakang.

Hanya tersedia untuk Android.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.getPendingAuthResult();

getIdToken

Mengambil Token Otorisasi Firebase untuk pengguna yang saat ini telah masuk.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.getIdToken();

getIdTokenResult

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

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.getIdTokenResult();

getRedirectResult

Mengembalikan SignInResult dari aliran sign-in berdasarkan redirect.

Jika sign-in gagal, gagal dengan kesalahan. Jika tidak ada operasi redirect yang dipanggil, mengembalikan SignInResult dengan pengguna null.

Hanya tersedia untuk Web.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.getRedirectResult();

getTenantId

Dapatkan id penyewa.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.getTenantId();

isSignInWithEmailLink

Mengecek apakah tautan masuk adalah tanda masuk dengan link email yang sesuai untuk signInWithEmailLink.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.isSignInWithEmailLink({} as IsSignInWithEmailLinkOptions);

linkWithApple

Menghubungkan akun pengguna dengan penyedia autentikasi Apple.

Pengguna harus sudah masuk di layer native. skipNativeAuth Opsi konfigurasi tidak berpengaruh di sini.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithApple();

linkWithEmailAndPassword

Menghubungkan akun pengguna dengan penyedia autentikasi Email.

Pengguna harus sudah masuk di layer native. skipNativeAuth Opsi konfigurasi tidak berpengaruh di sini.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithEmailAndPassword({} as LinkWithEmailAndPasswordOptions);

linkWithEmailLink

Menghubungkan akun pengguna dengan penyedia autentikasi Email.

Pengguna harus sudah masuk di layer native. skipNativeAuth Opsi konfigurasi tidak berpengaruh di sini.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithEmailLink({} as LinkWithEmailLinkOptions);

linkWithFacebook

Menghubungkan akun pengguna dengan penyedia autentikasi Facebook.

Pengguna harus sudah masuk di layer native. Tidak ada efek pada opsi konfigurasi di sini. skipNativeAuth Salin ke clipboard

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithFacebook();

linkWithGameCenter

Pengguna harus sudah masuk di layer native. Tidak ada efek pada opsi konfigurasi di sini.

Hanya tersedia untuk iOS. skipNativeAuth Salin ke clipboard

Bagian berjudul “linkDenganGitHub”

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithGameCenter();

linkWithGithub

Menghubungkan akun pengguna dengan GitHub penyedia autentikasi.

Pengguna harus sudah masuk di layer native. Opsi konfigurasi tidak berpengaruh di sini. skipNativeAuth Salin ke clipboard

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithGithub();

linkWithGoogle

Pengguna harus sudah masuk di layer native. Opsi konfigurasi tidak berpengaruh di sini.

Salin ke clipboard skipNativeAuth Bagian berjudul “linkWithMicrosoft”

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithGoogle();

linkWithMicrosoft

Salin ke clipboard

Bagian berjudul “linkWithMicrosoft” skipNativeAuth opsi konfigurasi tidak berpengaruh di sini.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithMicrosoft();

linkWithOpenIdConnect

Menghubungkan akun pengguna dengan penyedia OpenID Connect.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithOpenIdConnect({} as LinkWithOpenIdConnectOptions);

linkWithPhoneNumber

Menghubungkan akun pengguna dengan penyedia autentikasi nomor telepon.

Pengguna harus sudah masuk di layer native. Tidak skipNativeAuth opsi konfigurasi tidak berpengaruh di sini.

Gunakan phoneVerificationCompleted untuk menerima pemberitahuan ketika verifikasi selesai. Gunakan phoneVerificationFailed untuk menerima pemberitahuan ketika verifikasi gagal. Gunakan phoneCodeSent pengguna untuk mendapatkan id verifikasi.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithPhoneNumber({} as LinkWithPhoneNumberOptions);

linkWithPlayGames

Menghubungkan akun pengguna dengan penyedia autentikasi Play Games.

Pengguna harus sudah masuk di layer native. skipNativeAuth Opsi konfigurasi tidak memiliki efek di sini.

Hanya tersedia untuk Android.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithPlayGames();

linkWithTwitter

Menghubungkan akun pengguna dengan penyedia autentikasi Twitter.

Pengguna harus sudah masuk di layer native. skipNativeAuth Opsi konfigurasi tidak memiliki efek di sini.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithTwitter();

linkWithYahoo

Menghubungkan akun pengguna dengan penyedia autentikasi Yahoo.

Pengguna harus sudah masuk di layer native. Opsi konfigurasi tidak berpengaruh di sini. skipNativeAuth Salin ke clipboard

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.linkWithYahoo();

reload

Salin ke clipboard

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.reload();

revokeAccessToken

Salin ke clipboard

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.revokeAccessToken({} as RevokeAccessTokenOptions);

sendEmailVerification

Mengirimkan email verifikasi ke pengguna yang saat ini sudah masuk.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.sendEmailVerification();

sendPasswordResetEmail

Mengirimkan email reset kata sandi.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.sendPasswordResetEmail({} as SendPasswordResetEmailOptions);

sendSignInLinkToEmail

Mengirimkan tautan login ke pengguna dengan alamat email yang ditentukan.

Untuk menyelesaikan login dengan tautan email, panggil signInWithEmailLink dengan alamat email dan tautan email yang disediakan dalam email yang dikirimkan ke pengguna.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.sendSignInLinkToEmail({} as SendSignInLinkToEmailOptions);

setLanguageCode

Mengatur bahasa pengguna code untuk operasi autentikasi.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.setLanguageCode({} as SetLanguageCodeOptions);

setPersistence

Mengatur jenis penyimpanan untuk sesi autentikasi yang disimpan saat ini.

Hanya tersedia untuk Web.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.setPersistence({} as SetPersistenceOptions);

setTenantId

Mengatur ID penyewa.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.setTenantId({} as SetTenantIdOptions);

signInAnonymously

Masuk sebagai pengguna anonim.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInAnonymously();

signInWithApple

Mulai alur sign-in Apple.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithApple();

signInWithCustomToken

Mulai alur sign-in Token Kustom.

Metode ini tidak dapat digunakan bersamaan dengan skipNativeAuth pada Android dan iOS. Dalam kasus ini Anda harus menggunakan signInWithCustomToken interface dari Firebase JS SDK secara langsung.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithCustomToken({} as SignInWithCustomTokenOptions);

signInWithEmailAndPassword

Mulai alur sign-in menggunakan email dan kata sandi.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithEmailAndPassword({} as SignInWithEmailAndPasswordOptions);

signInWithEmailLink

Masuk menggunakan email dan tautan masuk email.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithEmailLink({} as SignInWithEmailLinkOptions);

signInWithFacebook

Mulai alur masuk Facebook.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithFacebook();

signInWithGameCenter

Mulai alur masuk Game Center.

Hanya tersedia untuk iOS.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithGameCenter();

signInWithGithub

Mulai alur masuk GitHub.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithGithub();

signInWithGoogle

Mulai alur sign-in Google.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithGoogle();

signInWithMicrosoft

Mulai alur sign-in Microsoft.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithMicrosoft();

signInWithOpenIdConnect

Mulai alur sign-in OpenID Connect.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithOpenIdConnect({} as SignInWithOpenIdConnectOptions);

signInWithPhoneNumber

Mulai alur sign-in menggunakan nomor telepon.

Gunakan untuk mendapatkan pemberitahuan ketika verifikasi selesai. Gunakan untuk mendapatkan pemberitahuan ketika verifikasi gagal. Gunakan untuk mendapatkan ID verifikasi. phoneVerificationCompleted Hanya tersedia untuk Android dan iOS. phoneVerificationFailed Salin ke clipboard phoneCodeSent Judul bagian “signInWithPlayGames”

Mulai alur masuk Play Games.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithPhoneNumber({} as SignInWithPhoneNumberOptions);

signInWithPlayGames

Judul bagian “signInWithTwitter”

Mulai alur masuk Twitter.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithPlayGames();

signInWithTwitter

__CAPGO_KEEP_0__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithTwitter();

signInWithYahoo

Mulai alur masuk Yahoo.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signInWithYahoo();

signOut

Mulai alur keluar.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.signOut();

unlink

Menghapus koneksi penyedia dari akun pengguna.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.unlink({} as UnlinkOptions);

updateEmail

Mengupdate alamat email pengguna yang sedang masuk.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.updateEmail({} as UpdateEmailOptions);

updatePassword

Mengupdate kata sandi pengguna yang saat ini masuk.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.updatePassword({} as UpdatePasswordOptions);

updateProfile

Mengupdate data profil pengguna.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.updateProfile({} as UpdateProfileOptions);

useAppLanguage

Mengatur bahasa pengguna code menjadi bahasa aplikasi default.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.useAppLanguage();

useEmulator

Menginstrument aplikasi untuk berbicara dengan emulator Autentikasi.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.useEmulator({} as UseEmulatorOptions);

verifyBeforeUpdateEmail

Mengverifikasi alamat email baru sebelum mengupdate alamat email pengguna yang sedang masuk.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.verifyBeforeUpdateEmail({} as VerifyBeforeUpdateEmailOptions);

checkAppTrackingTransparencyPermission

Mengatur status saat ini pengawasan aplikasi.

Hanya tersedia di iOS.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.checkAppTrackingTransparencyPermission();

requestAppTrackingTransparencyPermission

Membuka dialog sistem untuk mengizinkan pengawasan aplikasi.

Perhatian: Pengguna mungkin telah menonaktifkan permintaan pengawasan di pengaturan perangkat, lihat Dokumentasi Apple.

Hanya tersedia di iOS.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.requestAppTrackingTransparencyPermission();

Referensi Tipe

ApplyActionCodeOptions

export interface ApplyActionCodeOptions {
  /**
   * A verification code sent to the user.
   *
   * @since 0.2.2
   */
  oobCode: string;
}

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

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

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

export interface CreateUserWithEmailAndPasswordOptions {
  /**
   * @since 0.2.2
   */
  email: string;
  /**
   * @since 0.2.2
   */
  password: string;
}

FetchSignInMethodsForEmailOptions

export interface FetchSignInMethodsForEmailOptions {
  /**
   * The user's email address.
   *
   * @since 6.0.0
   */
  email: string;
}

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

export interface GetCurrentUserResult {
  /**
   * The currently signed-in user, or null if there isn't any.
   *
   * @since 0.1.0
   */
  user: User | null;
}

GetIdTokenOptions

export interface GetIdTokenOptions {
  /**
   * Force refresh regardless of token expiration.
   *
   * @since 0.1.0
   */
  forceRefresh: boolean;
}

GetIdTokenResult

export interface GetIdTokenResult {
  /**
   * The Firebase Auth ID token JWT string.
   *
   * @since 0.1.0
   */
  token: string;
}

GetIdTokenResultOptions

export interface GetIdTokenResultOptions {
  /**
   * Force refresh regardless of token expiration.
   *
   * @since 7.4.0
   */
  forceRefresh: boolean;
}

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

Halaman ini dihasilkan dari plugin’s src/definitions.ts. Re-run sync ketika publik API berubah di atas

Teruskan dari Getting Started

Jika Anda menggunakan Mulai Berjalan untuk merencanakan autentikasi dan alur akun, hubungkannya dengan @capgo/capacitor-login-sosial untuk detail implementasi di @capgo/capacitor-login-sosial, @capgo/capacitor-passkey untuk detail implementasi di @capgo/capacitor-passkey, @capgo/capacitor-biometrik-nativ untuk detail implementasi di @capgo/capacitor-biometrik-nativ, Autentikasi Dua Faktor untuk detail implementasi di Autentikasi Dua Faktor, dan SSO (Perusahaan) untuk detail implementasi di SSO (Perusahaan).