コンテンツにジャンプ

@capgo/capacitor-ファイアベース認証

CapacitorのFirebase認証プラグイン

概要

概要

CapacitorのFirebase認証プラグイン

始めるから applyActionCode() そして他の主要なメソッドは以下のとおりです。

プラットフォームサポート

プラットフォームサポート
プラットフォームサポート注意
iOSはいネイティブ
Androidはいネイティブ
WebNoGuard with Capacitor.getPlatform()

コア機能

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

Public API

Public API
メソッド概要
applyActionCodeメールで送信された検証codeを適用します。
confirmPasswordResetパスワードリセットプロセスを完了します。
confirmVerificationCode電話番号検証プロセスを完了します。
createUserWithEmailAndPasswordメールアドレスとパスワードを使用して新しいユーザーアカウントを作成します。新しいアカウントが作成された場合、ユーザーは自動的にログインします。
deleteUserユーザーを削除し、ログアウトします。
fetchSignInMethodsForEmailメールアドレスに対してサインイン方法を取得します。
getCurrentUser現在ログインしているユーザーを取得します。
getPendingAuthResultリターンします SignInResult アプリがWebサインインフローを開始し、OSがバックグラウンドでアプリをクリーンアップした場合に返します。
getIdToken現在ログインしているユーザーのFirebase Auth IDトークンを取得します。
getIdTokenResult現在ログインしているユーザーを識別するために使用されるデシリアライズされたJSON Webトークン (JWT) を返します。
getRedirectResultリターンします。 SignInResult リダイレクトベースのサインインフローから
getTenantIdテナントIDを取得します。
isSignInWithEmailLinkメールリンクでサインインするための適切なリンクが入ってくる場合に、チェックします。 signInWithEmailLink.
linkWithAppleApple認証プロバイダとユーザーアカウントをリンクします。
linkWithEmailAndPasswordEmail認証プロバイダとユーザーアカウントをリンクします。
linkWithEmailLinkEmail認証プロバイダとユーザーアカウントをリンクします。
linkWithFacebookFacebook認証プロバイダとユーザーアカウントをリンクします。
linkWithGameCenterGame Center認証プロバイダとユーザーアカウントをリンクします。
linkWithGithub認証プロバイダGitHubとユーザーアカウントをリンクします。
linkWithGoogleGoogle認証プロバイダとユーザーアカウントをリンクします。
linkWithMicrosoftMicrosoft認証プロバイダとユーザーアカウントをリンクします。
linkWithOpenIdConnectOpenID Connect プロバイダーとユーザーアカウントをリンクします。
linkWithPhoneNumber電話番号認証プロバイダーとユーザーアカウントをリンクします。
linkWithPlayGamesPlay Games認証プロバイダーとユーザーアカウントをリンクします。
linkWithTwitterTwitter認証プロバイダーとユーザーアカウントをリンクします。
linkWithYahooYahoo認証プロバイダーとユーザーアカウントをリンクします。
reloadサインイン中のユーザーアカウントデータを再読み込みします。
revokeAccessToken指定されたアクセストークンの有効性を取り消します。現在はApple OAuthアクセストークンにのみ対応しています。
sendEmailVerification現在サインイン中のユーザーに確認メールを送信します。
sendPasswordResetEmailパスワードリセットメールを送信します。
sendSignInLinkToEmail指定されたメールアドレスのユーザーにサインインメールリンクを送信します。
setLanguageCode認証操作用のユーザー向け言語をcodeに設定します。
setPersistence現在保存されている認証セッションの保存方法を設定します。
setTenantIdテナントIDを設定します。
signInAnonymously匿名ユーザーとしてログインします。
signInWithAppleAppleサインインフローを開始します。
signInWithCustomTokenカスタムトークンによるサインインフローを開始します。
signInWithEmailAndPasswordメールアドレスとパスワードを使用したサインインフローを開始します。
signInWithEmailLinkメールアドレスとサインインメールリンクを使用したサインインを実行します。
signInWithFacebookFacebookサインインフローを開始します。
signInWithGameCenterGame Centerサインインフローを開始します。
signInWithGithubGitHubサインインフローを開始します。
signInWithGoogleGoogleサインインフローを開始します。
signInWithMicrosoftMicrosoftサインインフローを開始します。
signInWithOpenIdConnectOpenID Connectサインインフローを開始します。
signInWithPhoneNumber電話番号を使用してサインインフローを開始します。
signInWithPlayGamesPlay Gamesサインインフローを開始します。
signInWithTwitterTwitterサインインフローを開始します。
signInWithYahooYahooサインインフローを開始します。
signOutサインアウトフローを開始します。
unlinkユーザーアカウントからプロバイダーをアンリンクします。
updateEmail現在サインインしているユーザーのメールアドレスを更新します。
updatePassword現在サインインしているユーザーのパスワードを更新します。
updateProfileユーザーのプロファイルデータを更新します。
useAppLanguageユーザー向けの言語codeをデフォルトのアプリ言語に設定します。
useEmulatorAuthenticationエミュレータとアプリを連携するためのインストルメンテーションを実行します。
verifyBeforeUpdateEmail現在サインインしているユーザーのメールアドレスを更新する前に、新しいメールアドレスを検証します。
checkAppTrackingTransparencyPermissionアプリのトラッキング透明性の現在の状態を確認します。
requestAppTrackingTransparencyPermissionアプリのトラッキング透明性のシステムダイアログを開きます。
addListenerユーザーのサインイン状態の変更をリスンします。
addListener現在サインインしているユーザーのIDトークンの変更をリスンします。
addListener電話認証が完了したときにリスンします。
addListener電話認証が失敗したときにリスンします。
addListener電話認証がcodeのときにリスンします。
removeAllListenersこのプラグインのリスナーをすべて削除します。
getPluginVersionこのプラグインのバージョンを取得します。

この参照は src/definitions.ts in capacitor-firebase.

Capgoから続けて@capgo/capacitor-firebase-authentication

@capgo/capacitor-firebase-authenticationから続ける

「__CAPGO_KEEP_0__-firebase-authentication」を使用している場合 @capgo/capacitor-ファイアベース認証 __CAPGO_KEEP_0__-social-login @capgo/capacitor-ソーシャルログイン @capgo/capacitor-ソーシャルログインの実装詳細について @capgo/capacitor-パスキー @capgo/capacitor-パスキーの実装詳細について @capgo/capacitor-native-biometric Capgoの実装詳細については@capgo/capacitor-native-biometricを参照してください。 2要素認証 Capgoの実装詳細については2要素認証、そして SSO (Enterprise) Capgoの実装詳細についてはSSO (Enterprise)を参照してください。