시작하기

설치

AI-Assisted Setup으로 플러그인을 설치할 수 있습니다. 다음 명령어로 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.

수동 설정을 선호한다면, 다음 명령어를 실행하여 플러그인을 설치하고 아래의 플랫폼별 지침을 따르세요:

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

가져오기

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

빠른 시작

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.

자주 하는 실수

• 리스너: 화면이 언마운트될 때 핸들을 제거합니다.
• 네이티브 동기화: 실행 npx cap sync 플러그인 업그레이드 후.
• 신뢰할 수 있는 소스: 신뢰 src/definitions.ts GitHub 레포지토리에서.

API 개요

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

getCurrentUser

현재 로그인한 사용자를 가져옵니다.

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

const result = await FirebaseAuthentication.getCurrentUser();
// The result holds sensitive values: use it without logging it.

getPendingAuthResult

반환합니다: SignInResult 앱이 웹 로그인 흐름을 시작했고 백그라운드에 있는 동안 OS가 앱을 정리한 경우.

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

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

const result = await FirebaseAuthentication.getPendingAuthResult();
// The result holds sensitive values: use it without logging it.

getIdToken

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

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

const result = await FirebaseAuthentication.getIdToken();
// The result holds sensitive values: use it without logging it.

getIdTokenResult

Firebase 서비스에 사용자를 식별하는 데 사용되는 역직렬화된 JSON Web Token (JWT)을 반환합니다.

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

const result = await FirebaseAuthentication.getIdTokenResult();
// The result holds sensitive values: use it without logging it.

getRedirectResult

반환합니다: SignInResult 리다이렉트 기반 로그인 흐름에서

로그인에 실패하면 에러를 반환합니다. 리다이렉트 작업이 호출되지 않은 경우, 다음을 반환합니다. SignInResult 사용자가 null인 경우입니다.

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

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

const result = await FirebaseAuthentication.getRedirectResult();
// The result holds sensitive values: use it without logging it.

getTenantId

tenant id를 가져옵니다.

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

const result = await FirebaseAuthentication.getTenantId();
console.log(result);

isSignInWithEmailLink

들어오는 링크가 이메일 링크 로그인에 사용하기 적합한지 확인합니다. 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

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

사용자는 네이티브 레이어에서 로그인되어 있어야 합니다. The skipNativeAuth 설정 옵션이 여기서는 적용되지 않습니다.

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

const result = await FirebaseAuthentication.linkWithApple();
// The result holds sensitive values: use it without logging it.

linkWithEmailAndPassword

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

사용자는 네이티브 레이어에서 로그인되어 있어야 합니다. The skipNativeAuth 설정 옵션이 여기서는 적용되지 않습니다.

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

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

사용자는 네이티브 레이어에서 로그인되어 있어야 합니다. The skipNativeAuth 설정 옵션이 여기서는 적용되지 않습니다.

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

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

사용자는 네이티브 레이어에서 로그인되어 있어야 합니다. The skipNativeAuth 설정 옵션이 여기서는 적용되지 않습니다.

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

const result = await FirebaseAuthentication.linkWithFacebook();
// The result holds sensitive values: use it without logging it.

linkWithGameCenter

사용자 계정을 Game Center 인증 프로바이더와 연결합니다.

사용자는 네이티브 레이어에서 로그인되어 있어야 합니다. The skipNativeAuth 설정 옵션이 여기서는 적용되지 않습니다.

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

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

const result = await FirebaseAuthentication.linkWithGameCenter();
// The result holds sensitive values: use it without logging it.

linkWithGithub

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

사용자는 네이티브 레이어에서 로그인되어 있어야 합니다. The skipNativeAuth 설정 옵션이 여기서는 적용되지 않습니다.

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

const result = await FirebaseAuthentication.linkWithGithub();
// The result holds sensitive values: use it without logging it.

linkWithGoogle

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

사용자는 네이티브 레이어에서 로그인되어 있어야 합니다. The skipNativeAuth 설정 옵션이 여기서는 적용되지 않습니다.

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

const result = await FirebaseAuthentication.linkWithGoogle();
// The result holds sensitive values: use it without logging it.

linkWithMicrosoft

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

사용자는 네이티브 레이어에서 로그인되어 있어야 합니다. The skipNativeAuth 설정 옵션이 여기서는 적용되지 않습니다.

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

const result = await FirebaseAuthentication.linkWithMicrosoft();
// The result holds sensitive values: use it without logging it.

linkWithOpenIdConnect

사용자 계정을 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

사용자 계정을 전화번호 인증 프로바이더와 연결합니다.

사용자는 네이티브 레이어에서 로그인되어 있어야 합니다. The skipNativeAuth 설정 옵션이 여기서는 적용되지 않습니다.

트레이드오프를 평가하려면 phoneVerificationCompleted 인증이 완료되었을 때 호출되는 리스너입니다. 다음 사용: phoneVerificationFailed 인증에 실패했을 때 호출되는 리스너입니다. 다음 사용: phoneCodeSent verification id를 가져오기 위한 리스너입니다.

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

await FirebaseAuthentication.linkWithPhoneNumber({ phoneNumber: "+16505550101" });

linkWithPlayGames

사용자 계정을 Play Games 인증 프로바이더와 연결합니다.

사용자는 네이티브 레이어에서 로그인되어 있어야 합니다. The skipNativeAuth 설정 옵션이 여기서는 적용되지 않습니다.

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

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

const result = await FirebaseAuthentication.linkWithPlayGames();
// The result holds sensitive values: use it without logging it.

linkWithTwitter

사용자 계정을 Twitter 인증 프로바이더와 연결합니다.

사용자는 네이티브 레이어에서 로그인되어 있어야 합니다. The skipNativeAuth 설정 옵션이 여기서는 적용되지 않습니다.

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

const result = await FirebaseAuthentication.linkWithTwitter();
// The result holds sensitive values: use it without logging it.

linkWithYahoo

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

사용자는 네이티브 레이어에서 로그인되어 있어야 합니다. The skipNativeAuth 설정 옵션이 여기서는 적용되지 않습니다.

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

const result = await FirebaseAuthentication.linkWithYahoo();
// The result holds sensitive values: use it without logging it.

reload

로그인 상태인 경우 사용자 계정 데이터를 다시 불러옵니다.

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

await FirebaseAuthentication.reload();

revokeAccessToken

지정된 액세스 토큰을 취소합니다. 현재 Apple OAuth 액세스 토큰만 지원합니다.

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

await FirebaseAuthentication.revokeAccessToken({ token: 'token-123' });

sendEmailVerification

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

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

await FirebaseAuthentication.sendEmailVerification();

sendPasswordResetEmail

비밀번호 재설정 이메일을 보냅니다.

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

await FirebaseAuthentication.sendPasswordResetEmail({ email: 'user@example.com' });

sendSignInLinkToEmail

지정된 이메일 주소의 사용자에게 로그인 이메일 링크를 보냅니다.

이메일 링크로 로그인을 완료하려면 다음을 호출하세요: signInWithEmailLink 사용자에게 발송된 이메일에 포함된 이메일 주소와 이메일 링크를 인수로 전달하세요.

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

await FirebaseAuthentication.sendSignInLinkToEmail({
  email: 'user@example.com',
  actionCodeSettings: { url: 'https://example.com' },
});

setLanguageCode

인증 작업에서 사용자에게 표시할 언어를 code로 설정합니다.

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

await FirebaseAuthentication.setLanguageCode({ languageCode: "en-US" });

setPersistence

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

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

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

await FirebaseAuthentication.setPersistence({ persistence: Persistence.IndexedDbLocal });

setTenantId

테넌트 ID를 설정합니다.

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

await FirebaseAuthentication.setTenantId({ tenantId: 'tenant-id-123' });

signInAnonymously

익명 사용자로 로그인합니다.

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

const result = await FirebaseAuthentication.signInAnonymously();
// The result holds sensitive values: use it without logging it.

signInWithApple

Apple 로그인 플로우를 시작합니다.

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

const result = await FirebaseAuthentication.signInWithApple();
// The result holds sensitive values: use it without logging it.

signInWithCustomToken

Custom Token 로그인 플로우를 시작합니다.

이 메서드는 다음 기능과 함께 사용할 수 없습니다: skipNativeAuth Android 및 iOS 환경에서. 이 경우 다음을 사용해야 합니다: signInWithCustomToken Firebase JS SDK 인터페이스를 직접 사용하세요.

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

이메일과 비밀번호로 로그인 플로우를 시작합니다.

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

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

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

Facebook 로그인 플로우를 시작합니다.

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

const result = await FirebaseAuthentication.signInWithFacebook();
// The result holds sensitive values: use it without logging it.

signInWithGameCenter

Game Center 로그인 플로우를 시작합니다.

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

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

const result = await FirebaseAuthentication.signInWithGameCenter();
// The result holds sensitive values: use it without logging it.

signInWithGithub

GitHub 로그인 플로우를 시작합니다.

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

const result = await FirebaseAuthentication.signInWithGithub();
// The result holds sensitive values: use it without logging it.

signInWithGoogle

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

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

const result = await FirebaseAuthentication.signInWithGoogle();
// The result holds sensitive values: use it without logging it.

signInWithMicrosoft

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

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

const result = await FirebaseAuthentication.signInWithMicrosoft();
// The result holds sensitive values: use it without logging it.

signInWithOpenIdConnect

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

전화번호를 사용한 로그인 흐름을 시작합니다.

트레이드오프를 평가하려면 phoneVerificationCompleted 인증이 완료되었을 때 호출되는 리스너입니다. 다음을 사용하세요: phoneVerificationFailed 인증에 실패했을 때 호출되는 리스너입니다. 다음을 사용하세요: phoneCodeSent 인증 ID를 가져오는 리스너입니다.

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

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

await FirebaseAuthentication.signInWithPhoneNumber({ phoneNumber: "+16505550101" });

signInWithPlayGames

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

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

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

const result = await FirebaseAuthentication.signInWithPlayGames();
// The result holds sensitive values: use it without logging it.

signInWithTwitter

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

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

const result = await FirebaseAuthentication.signInWithTwitter();
// The result holds sensitive values: use it without logging it.

signInWithYahoo

Yahoo 로그인 프로세스를 시작합니다.

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

const result = await FirebaseAuthentication.signInWithYahoo();
// The result holds sensitive values: use it without logging it.

signOut

로그아웃 프로세스를 시작합니다.

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

await FirebaseAuthentication.signOut();

unlink

사용자 계정에서 프로바이더 연결을 해제합니다.

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

현재 로그인된 사용자의 이메일 주소를 업데이트합니다.

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

await FirebaseAuthentication.updateEmail({ newEmail: 'user@example.com' });

updatePassword

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

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

await FirebaseAuthentication.updatePassword({ newPassword: 'new-password' });

updateProfile

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

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

await FirebaseAuthentication.updateProfile({
  displayName: 'display',
  photoUrl: 'https://example.com',
});

useAppLanguage

사용자에게 표시되는 언어 code를 앱 기본 언어로 설정합니다.

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

await FirebaseAuthentication.useAppLanguage();

useEmulator

Authentication 에뮬레이터와 통신하도록 앱을 구성합니다.

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

await FirebaseAuthentication.useEmulator({ host: "127.0.0.1" });

verifyBeforeUpdateEmail

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

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

await FirebaseAuthentication.verifyBeforeUpdateEmail({ newEmail: 'user@example.com' });

checkAppTrackingTransparencyPermission

앱 추적 투명성(App Tracking Transparency)의 현재 상태를 확인합니다.

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

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

const result = await FirebaseAuthentication.checkAppTrackingTransparencyPermission();
console.log(result);

requestAppTrackingTransparencyPermission

앱 추적 투명성 승인을 위한 시스템 대화상자를 엽니다.

주의: 사용자가 기기 설정에서 추적 요청을 비활성화했을 수 있습니다. 다음을 참조하세요: Apple 문서.

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

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

const result = await FirebaseAuthentication.requestAppTrackingTransparencyPermission();
console.log(result);

타입 레퍼런스

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

Source of Truth

이 페이지는 플러그인의 src/definitions.tsupstream에서 public API가 변경되면 sync를 다시 실행하세요.

시작하기 다음 단계

사용 중이라면 시작하기 인증 및 계정 흐름을 설계할 때, 이를 다음 항목과 연결하세요: @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)의 구현 세부 사항은.