@capgo/capacitor-firebase-authentication

概要

Firebase Authentication 用の Capacitor プラグイン

まずは applyActionCode() および以下に示すその他のコアメソッド。

プラットフォーム対応

プラットフォーム	サポート	備考
iOSと	はい	ネイティブ
Androidでは	はい	ネイティブ
Web	いいえ	Capacitor.getPlatform() でガード

コア機能

• applyActionCode - ユーザーにメールで送信された検証codeを適用します。
• confirmPasswordReset - パスワードリセットプロセスを完了します。
• confirmVerificationCode - 電話番号の認証プロセスを完了します。
• createUserWithEmailAndPassword - メールアドレスとパスワードで新しいユーザーアカウントを作成します。新しいアカウントが作成されると、ユーザーは自動的にサインインします。

公開 API

メソッド	説明
applyActionCode	メールでユーザーに送信された検証用 code を適用します。
confirmPasswordReset	パスワードリセット処理を完了します。
confirmVerificationCode	電話番号の検証プロセスを完了します。
createUserWithEmailAndPassword	メールアドレスとパスワードで新しいユーザーアカウントを作成します。新しいアカウントが作成されると、ユーザーは自動的にサインインします。
deleteUser	ユーザーを削除してサインアウトします。
fetchSignInMethodsForEmail	指定したメールアドレスのサインイン方法を取得します。
getCurrentUser	現在サインインしているユーザーを取得します。
getPendingAuthResult	リダイレクトによるサインインフローから SignInResult アプリがWebサインインフローを開始し、バックグラウンド中にOSがアプリを終了した場合。
getIdToken	現在サインインしているユーザーの Firebase Auth ID Token を取得します。
getIdTokenResult	Firebase サービスでユーザーを識別するために使用される、デシリアライズされた JSON Web Token (JWT) を返します。
getRedirectResult	リダイレクトによるサインインフローから SignInResult を返します。
getTenantId	テナント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	現在保存されている認証セッションの永続化タイプを設定します。
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	App Tracking Transparency の許可を求めるシステムダイアログを表示します。
addListener	ユーザーのサインイン状態の変更を監視します。
addListener	現在サインインしているユーザーのIDトークン変更を監視します。
addListener	電話番号認証の完了を監視します。
addListener	電話番号認証の失敗を監視します。
addListener	電話番号認証の code を監視します。
removeAllListeners	このプラグインのすべてのリスナーを削除します。
getPluginVersion	このプラグインのバージョンを取得します。

Source of Truth

このリファレンスは以下から同期されています： src/definitions.ts における capacitor-firebase.

@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要素認証 二要素認証の実装の詳細については、また、 SSO (エンタープライズ) SSO (Enterprise) の実装の詳細については。