Firebase Authentication Capacitor 플러그인

@capgo/capacitor-firebase-authentication 사용법

Firebase Authentication용 Capacitor 플러그인

설치

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

bunx cap sync 플러그인의 네이티브 code를 네이티브 프로젝트에 복사합니다. 플러그인을 업그레이드할 때마다 다시 실행하세요.

가져오기

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

API 한눈에 보기

메서드	설명
applyActionCode	사용자에게 이메일로 전송된 인증 code를 적용합니다.
confirmPasswordReset	비밀번호 재설정 프로세스를 완료합니다.
confirmVerificationCode	전화번호 인증 프로세스를 완료합니다.
createUserWithEmailAndPassword	이메일과 비밀번호로 새 사용자 계정을 생성합니다. 새 계정이 생성되면 사용자는 자동으로 로그인됩니다.
deleteUser	사용자를 삭제하고 로그아웃합니다.
fetchSignInMethodsForEmail	이메일 주소의 로그인 방법을 가져옵니다.
getCurrentUser	현재 로그인한 사용자를 가져옵니다.
getPendingAuthResult	반환합니다: SignInResult 앱이 웹 로그인 흐름을 시작했고 백그라운드에 있는 동안 OS가 앱을 정리한 경우.
getIdToken	현재 로그인한 사용자의 Firebase Auth ID Token을 가져옵니다.
getIdTokenResult	Firebase 서비스에 사용자를 식별하는 데 사용되는 역직렬화된 JSON Web Token (JWT)을 반환합니다.
getRedirectResult	반환합니다: SignInResult 리다이렉트 기반 로그인 흐름에서
getTenantId	tenant id를 가져옵니다.
isSignInWithEmailLink	들어오는 링크가 이메일 링크 로그인에 사용하기 적합한지 확인합니다. signInWithEmailLink.
linkWithApple	사용자 계정을 Apple 인증 제공업체와 연결합니다.
linkWithEmailAndPassword	사용자 계정을 Email 인증 제공업체와 연결합니다.
linkWithEmailLink	사용자 계정을 Email 인증 제공업체와 연결합니다.
linkWithFacebook	사용자 계정을 Facebook 인증 제공업체와 연결합니다.
linkWithGameCenter	사용자 계정을 Game Center 인증 프로바이더와 연결합니다.
linkWithGithub	GitHub 인증 제공자와 사용자 계정을 연결합니다.
linkWithGoogle	Google 인증 제공자와 사용자 계정을 연결합니다.
linkWithMicrosoft	Microsoft 인증 제공자와 사용자 계정을 연결합니다.
linkWithOpenIdConnect	OpenID Connect 제공자와 사용자 계정을 연결합니다.
linkWithPhoneNumber	전화번호 인증 제공자와 사용자 계정을 연결합니다.
linkWithPlayGames	Play Games 인증 제공자와 사용자 계정을 연결합니다.
linkWithTwitter	Twitter 인증 제공자와 사용자 계정을 연결합니다.
linkWithYahoo	Yahoo 인증 제공자와 사용자 계정을 연결합니다.
reload	로그인된 경우 사용자 계정 데이터를 다시 불러옵니다.
revokeAccessToken	지정된 액세스 토큰을 폐기합니다. 현재 Apple OAuth 액세스 토큰만 지원합니다.
sendEmailVerification	현재 로그인한 사용자에게 인증 이메일을 보냅니다.
sendPasswordResetEmail	비밀번호 재설정 이메일을 보냅니다.
sendSignInLinkToEmail	지정된 이메일 주소의 사용자에게 로그인 이메일 링크를 보냅니다.
setLanguageCode	인증 작업에서 사용자에게 표시할 언어를 code로 설정합니다.
setPersistence	현재 저장된 인증 세션의 persistence 유형을 설정합니다.
setTenantId	테넌트 ID를 설정합니다.
signInAnonymously	익명 사용자로 로그인합니다.
signInWithApple	Apple 로그인 플로우를 시작합니다.
signInWithCustomToken	Custom Token 로그인 플로우를 시작합니다.
signInWithEmailAndPassword	이메일과 비밀번호로 로그인 플로우를 시작합니다.
signInWithEmailLink	이메일과 이메일 로그인 링크를 사용해 로그인합니다.
signInWithFacebook	Facebook 로그인 플로우를 시작합니다.
signInWithGameCenter	Game Center 로그인 플로우를 시작합니다.
signInWithGithub	GitHub 로그인 플로우를 시작합니다.
signInWithGoogle	Google 로그인 플로우를 시작합니다.
signInWithMicrosoft	Microsoft 로그인 플로우를 시작합니다.
signInWithOpenIdConnect	OpenID Connect 로그인 플로우를 시작합니다.
signInWithPhoneNumber	전화번호로 로그인 플로우를 시작합니다.
signInWithPlayGames	Play Games 로그인 플로우를 시작합니다.
signInWithTwitter	Twitter 로그인 플로우를 시작합니다.
signInWithYahoo	Yahoo 로그인 플로우를 시작합니다.
signOut	로그아웃 플로우를 시작합니다.
unlink	사용자 계정에서 제공자 연결을 해제합니다.
updateEmail	현재 로그인한 사용자의 이메일 주소를 업데이트합니다.
updatePassword	현재 로그인한 사용자의 비밀번호를 업데이트합니다.
updateProfile	사용자 프로필 데이터를 업데이트합니다.
useAppLanguage	사용자에게 표시되는 언어 code를 앱 기본 언어로 설정합니다.
useEmulator	Authentication 에뮬레이터와 통신하도록 앱을 구성합니다.
verifyBeforeUpdateEmail	현재 로그인한 사용자의 이메일 주소를 업데이트하기 전에 새 이메일 주소를 검증합니다.
checkAppTrackingTransparencyPermission	앱 추적 투명성(App Tracking Transparency)의 현재 상태를 확인합니다.
requestAppTrackingTransparencyPermission	앱 추적 투명성 승인을 위한 시스템 대화상자를 엽니다.

예시

applyActionCode()

사용자에게 이메일로 전송된 인증 code를 적용합니다.

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

await FirebaseAuthentication.applyActionCode({ oobCode: 'oob-code' });

confirmPasswordReset()

비밀번호 재설정 프로세스를 완료합니다.

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

await FirebaseAuthentication.confirmPasswordReset({
  oobCode: 'oob-code',
  newPassword: 'new-password',
});

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.

createUserWithEmailAndPassword()

이메일과 비밀번호로 새 사용자 계정을 생성합니다. 새 계정이 생성되면 사용자는 자동으로 로그인됩니다.

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

사용자를 삭제하고 로그아웃합니다.

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

await FirebaseAuthentication.deleteUser();

fetchSignInMethodsForEmail()

이메일 주소의 로그인 방법을 가져옵니다.

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

const result = await FirebaseAuthentication.fetchSignInMethodsForEmail({ email: 'user@example.com' });
console.log(result);

위 표에는 59개의 핵심 메서드가 나열되어 있습니다. 리스너와 버전 헬퍼, 각 메서드의 전체 계약은 다음 문서에 설명되어 있습니다. GitHub 리포지토리.

이벤트 수신

addListener 핸들을 반환합니다. 호출하세요 handle.remove() 화면이 언마운트될 때, 또는 FirebaseAuthentication.removeAllListeners() 모든 리스너를 해제하려면.

전체 레퍼런스

• GitHub 리포지토리
• 문서
• API 레퍼런스

@capgo/capacitor-firebase-authentication 사용하기에서 계속하기

사용 중이라면 @capgo/capacitor-firebase-authentication 사용법 인증 및 계정 흐름을 설계할 때, 이를 다음 항목과 연결하세요: @capgo/capacitor-social-login @capgo/capacitor-social-login의 구현 세부 사항은, @capgo/capacitor-passkey @capgo/capacitor-passkey의 구현 세부 사항은 @capgo/capacitor-native-biometric @capgo/capacitor-native-biometric의 구현 세부 사항은, 2단계 인증 2단계 인증(Two-factor authentication)의 구현 세부 사항은, SSO (기업용) SSO (Enterprise)의 구현 세부 사항은.