컨텐츠로 바로가기

__CAPGO_KEEP_0__

GitHub

설치

설치

설치 단계를 따라 설치할 수 있습니다. AI 도구에 Capgo 스킬을 추가하려면 다음 명령어를 사용하세요:

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

다음과 같은 명령어를 사용하세요.

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-firebase-authentication` plugin in my project.

만약 Manual Setup을 선호한다면, 플러그인을 설치하기 위해 다음 명령어를 실행하고 아래의 플랫폼별 설명을 따르세요.

터미널 창
bun add @capgo/capacitor-firebase-authentication
bunx cap sync
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

이메일로 보낸 인증 code를 적용합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.applyActionCode({} as ApplyActionCodeOptions);

비밀번호 재설정 과정을 완료합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.confirmPasswordReset({} as ConfirmPasswordResetOptions);

전화번호 인증 과정을 완료합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.confirmVerificationCode({} as ConfirmVerificationCodeOptions);

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

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.createUserWithEmailAndPassword({} as CreateUserWithEmailAndPasswordOptions);

__CAPGO_KEEP_1__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.deleteUser();

fetchSignInMethodsForEmail

__CAPGO_KEEP_0__

__CAPGO_KEEP_3__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.fetchSignInMethodsForEmail({} as FetchSignInMethodsForEmailOptions);

getCurrentUser

__CAPGO_KEEP_0__

__CAPGO_KEEP_4__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.getCurrentUser();

getPendingAuthResult

__CAPGO_KEEP_0__

__CAPGO_KEEP_5__ SignInResult __CAPGO_KEEP_6__

Android에서만 사용 가능합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.getPendingAuthResult();

getIdToken

getIdToken

현재 로그인한 사용자의 Firebase Auth ID 토큰을 가져옵니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.getIdToken();

getIdTokenResult

getIdTokenResult

JSON Web Token (JWT)을 사용하여 사용자를 Firebase 서비스에 식별하는 데 사용되는 디자일러라이즈된 토큰을 반환합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.getIdTokenResult();

getRedirectResult

getRedirectResult

redirect-based sign-in flow에서 사용자에게 반환하는 SignInResult redirect-based sign-in flow에서 성공적으로 로그인하지 못한 경우 오류로 실패합니다. redirect operation이 호출되지 않은 경우는

__CAPGO_KEEP_0__ SignInResult __CAPGO_KEEP_0__은 사용자가 없습니다.

Only available for Web.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.getRedirectResult();

사용자 ID를 가져옵니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.getTenantId();

이메일 링크로 로그인하는 incoming 링크가 맞는지 확인합니다. signInWithEmailLink.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.isSignInWithEmailLink({} as IsSignInWithEmailLinkOptions);

Apple 인증 제공자와 사용자 계정을 연결합니다.

사용자는 native layer에서 로그인되어 있어야 합니다. skipNativeAuth __CAPGO_KEEP_0__은 영향을 미치지 않습니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.linkWithApple();

이메일 인증 제공자와 사용자 계정을 연결합니다.

native layer에서 로그인해야 합니다. __CAPGO_KEEP_0__은 영향을 미치지 않습니다. skipNativeAuth __CAPGO_KEEP_1__을 클립보드에 복사합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.linkWithEmailAndPassword({} as LinkWithEmailAndPasswordOptions);

native layer에서 로그인해야 합니다. __CAPGO_KEEP_0__은 영향을 미치지 않습니다.

__CAPGO_KEEP_1__을 클립보드에 복사합니다. skipNativeAuth __CAPGO_KEEP_2__ 제목: 이메일 인증 링크 연결

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.linkWithEmailLink({} as LinkWithEmailLinkOptions);

Facebook 인증 제공자와 사용자 계정을 연결합니다.

native layer에서 로그인되어야 합니다. skipNativeAuth 설정 옵션은 여기에 영향을 미치지 않습니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.linkWithFacebook();

Game Center 인증 제공자와 사용자 계정을 연결합니다.

native layer에서 로그인되어야 합니다. skipNativeAuth 설정 옵션은 여기에 영향을 미치지 않습니다.

iOS에서만 사용 가능합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.linkWithGameCenter();

GitHub 인증 제공자와 사용자 계정을 연결합니다.

native layer에서 로그인한 사용자여야 합니다. skipNativeAuth 이 설정 옵션은 여기에 영향을 미치지 않습니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.linkWithGithub();

native layer에서 로그인한 사용자여야 합니다.

이 설정 옵션은 여기에 영향을 미치지 않습니다. skipNativeAuth 클립보드에 복사

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.linkWithGoogle();

이 설정 옵션은 여기에 영향을 미치지 않습니다.

클립보드에 복사 skipNativeAuth configuration option이 여기에 영향을 미치지 않습니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.linkWithMicrosoft();

linkWithOpenIdConnect

linkWithOpenIdConnect

OpenID Connect 제공자와 사용자 계정을 연결합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.linkWithOpenIdConnect({} as LinkWithOpenIdConnectOptions);

linkWithPhoneNumber

linkWithPhoneNumber

전화번호 인증 제공자와 사용자 계정을 연결합니다.

native layer에서 로그인한 사용자만 사용할 수 있습니다. The skipNativeAuth configuration option이 여기에 영향을 미치지 않습니다.

native layer에서 로그인한 사용자만 사용할 수 있습니다. phoneVerificationCompleted verification이 완료되면 phoneVerificationFailed listener를 사용하여 알림을 받으세요. verification이 실패하면 listener를 사용하여 알림을 받으세요. listener를 사용하여 알림을 받으세요. phoneCodeSent __CAPGO_KEEP_0__을 받기 위한 리스너.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.linkWithPhoneNumber({} as LinkWithPhoneNumberOptions);

linkWithPlayGames

linkWithPlayGames 섹션

Play Games 인증 제공자와 사용자 계정을 연결합니다.

native layer에서 로그인되어야 합니다. skipNativeAuth 이 설정 옵션은 여기에 영향을 미치지 않습니다.

Android에서만 사용할 수 있습니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.linkWithPlayGames();

linkWithTwitter

linkWithTwitter 섹션

Twitter 인증 제공자와 사용자 계정을 연결합니다.

native layer에서 로그인되어야 합니다. skipNativeAuth 이 설정 옵션은 여기에 영향을 미치지 않습니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.linkWithTwitter();

linkWithYahoo

__CAPGO_KEEP_1__

Yahoo 인증을 통한 사용자 계정 연결

native layer에서 로그인한 상태여야 함. 이 설정 옵션은 이곳에서 효과가 없습니다. skipNativeAuth __CAPGO_KEEP_0__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.linkWithYahoo();

Apple OAuth 액세스 토큰만 지원합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.reload();

revokeAccessToken

__CAPGO_KEEP_1__

__CAPGO_KEEP_0__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.revokeAccessToken({} as RevokeAccessTokenOptions);

sendEmailVerification

인증 이메일 전송

현재 로그인한 사용자에게 인증 이메일을 보냅니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.sendEmailVerification();

비밀번호 초기화 이메일을 보냅니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.sendPasswordResetEmail({} as SendPasswordResetEmailOptions);

이메일 링크를 사용하여 로그인하려면

이메일 주소와 이메일로 보낸 이메일 링크를 제공하세요. signInWithEmailLink 클립보드에 복사

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.sendSignInLinkToEmail({} as SendSignInLinkToEmailOptions);

setLanguageCode

__CAPGO_KEEP_0__

code 언어를 사용자에게 설정합니다. (인증 연산에 사용).

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.setLanguageCode({} as SetLanguageCodeOptions);

setPersistence

persistence 설정

현재 저장된 인증 세션의 유형을 설정합니다.

웹에서만 사용 가능합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.setPersistence({} as SetPersistenceOptions);

현재 tenant id를 설정합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.setTenantId({} as SetTenantIdOptions);

무작위로 로그인합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signInAnonymously();

Apple 로그인 흐름을 시작합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signInWithApple();

사용자 토큰으로 로그인 흐름을 시작합니다.

이 메소드는 Android 및 iOS에서 사용할 수 없습니다. 이 경우 Firebase JS __CAPGO_KEEP_0__의 직접적인 인터페이스를 사용해야 합니다. skipNativeAuth 클립보드에 복사 signInWithCustomToken interface of the Firebase JS SDK directly.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signInWithCustomToken({} as SignInWithCustomTokenOptions);

signInWithEmailAndPassword

targetLanguage

protectedTokens

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signInWithEmailAndPassword({} as SignInWithEmailAndPasswordOptions);

이메일과 로그인 이메일 링크를 사용하여 로그인합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signInWithEmailLink({} as SignInWithEmailLinkOptions);

Facebook 로그인 흐름을 시작합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signInWithFacebook();

Game Center 로그인 흐름을 시작합니다.

iOS에서만 사용 가능합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signInWithGameCenter();

GitHub 로그인 흐름을 시작합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signInWithGithub();

signInWithGoogle

__CAPGO_KEEP_1__

__CAPGO_KEEP_2__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signInWithGoogle();

signInWithMicrosoft

__CAPGO_KEEP_1__

__CAPGO_KEEP_3__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signInWithMicrosoft();

signInWithOpenIdConnect

__CAPGO_KEEP_1__

__CAPGO_KEEP_4__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signInWithOpenIdConnect({} as SignInWithOpenIdConnectOptions);

signInWithPhoneNumber

__CAPGO_KEEP_1__

__CAPGO_KEEP_5__

__CAPGO_KEEP_0__을 사용하여 인증이 완료되면 알림을 받을 수 있습니다. __CAPGO_KEEP_0__을 사용하여 인증이 실패하면 알림을 받을 수 있습니다. __CAPGO_KEEP_0__을 사용하여 인증 ID를 가져올 수 있습니다. phoneVerificationCompleted Android 및 iOS에서만 사용 가능합니다. phoneVerificationFailed __CAPGO_KEEP_0__을 클립보드에 복사 phoneCodeSent signInWithPlayGames

Play Games 로그인 흐름을 시작합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signInWithPhoneNumber({} as SignInWithPhoneNumberOptions);

signInWithTwitter

Twitter 로그인 흐름을 시작합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signInWithPlayGames();

__CAPGO_KEEP_0__을 사용하여 인증이 실패하면 알림을 받을 수 있습니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signInWithTwitter();

signInWithYahoo

__CAPGO_KEEP_1__

__CAPGO_KEEP_2__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signInWithYahoo();

__CAPGO_KEEP_3__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.signOut();

__CAPGO_KEEP_4__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.unlink({} as UnlinkOptions);

updateEmail

__CAPGO_KEEP_1__

__CAPGO_KEEP_5__

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.updateEmail({} as UpdateEmailOptions);

현재 로그인한 사용자의 비밀번호를 업데이트합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.updatePassword({} as UpdatePasswordOptions);

사용자의 프로필 데이터를 업데이트합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.updateProfile({} as UpdateProfileOptions);

Sets the user-facing language code to be the default app language.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.useAppLanguage();

앱이 인증 에뮬레이터와 대화할 수 있도록 합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.useEmulator({} as UseEmulatorOptions);

현재 로그인한 사용자의 이메일 주소를 업데이트하기 전에 새로운 이메일 주소를 확인합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.verifyBeforeUpdateEmail({} as VerifyBeforeUpdateEmailOptions);

checkAppTrackingTransparencyPermission

앱 추적성 투명성 확인

앱 추적성 투명성을 현재 상태로 확인합니다.

iOS에서만 사용 가능합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.checkAppTrackingTransparencyPermission();

requestAppTrackingTransparencyPermission

앱 추적성 투명성 권한 요청

앱 추적성 투명성 권한을 요청하는 시스템 대화창을 열어줍니다.

주의: 사용자는 장치 설정에서 추적 요청을 비활성화 할 수 있습니다. Apple의 문서.

iOS에서만 사용 가능합니다.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.requestAppTrackingTransparencyPermission();

타입 참조

타입 참조
export interface ApplyActionCodeOptions {
/**
* A verification code sent to the user.
*
* @since 0.2.2
*/
oobCode: string;
}
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

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

FetchSignInMethodsForEmailOptions

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

FetchSignInMethodsForEmailResult

__CAPGO_KEEP_3__
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

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

GetIdTokenOptions

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

GetIdTokenResult

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

GetIdTokenResultOptions

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

GetIdTokenResultResult

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

실제 원천

Source Of Truth

이 페이지는 플러그인의 src/definitions.ts API이 업스트림에서 변경될 때 다시 싱크를 실행하세요.

Getting Started에서 계속하기

Keep going from Getting Started

이미 사용 중입니다. 시작하기 인증 및 계정 흐름을 계획하고 연결하려면 @capgo/capacitor-social-login @capgo/capacitor-social-login의 구현 세부 정보를 참조하십시오. @capgo/capacitor-passkey @capgo/capacitor-passkey의 구현 세부 정보를 참조하십시오. @capgo/capacitor-native-biometric @capgo/capacitor-native-biometric의 구현 세부 정보를 참조하십시오. 두 단계 인증 두 단계 인증의 구현 세부 정보를 참조하십시오. 그리고 SSO (기업) SSO (기업)의 구현 세부 정보를 참조하십시오.