概要
概要のセクションCapacitor用Firebase認証プラグイン
Capgoの基本機能
Section titled “Core Capabilities”applyActionCode- Applies a verification code sent to the user by email.confirmPasswordReset- Completes the password reset process.confirmVerificationCode- Finishes the phone number verification process.createUserWithEmailAndPassword- Creates a new user account with email and password. If the new account was created, the user is signed in automatically.
Public API
Section titled “Public API”| Method | Description |
|---|---|
applyActionCode | Applies a verification code sent to the user by email. |
confirmPasswordReset | Completes the password reset process. |
confirmVerificationCode | Finishes the phone number verification process. |
createUserWithEmailAndPassword | 新しいユーザーアカウントを作成します。メールアドレスとパスワードを使用して新しいアカウントを作成すると、自動的にユーザーがログインされます。 |
deleteUser | ユーザーを削除し、ログアウトします。 |
fetchSignInMethodsForEmail | メールアドレスに対してサインイン方法を取得します。 |
getCurrentUser | 現在ログインしているユーザーを取得します。 |
getPendingAuthResult | if your app launched a web sign-in flow and the OS cleans up the app while in the background. SignInResult 現在ログインしているユーザーのFirebase Auth IDトークンを取得します。 |
getIdToken | 現在ログインしているユーザーを識別するために使用されるデシリアライズされたJSON Web Token (JWT)を取得します。 |
getIdTokenResult | redirect-based sign-in flowからトークンを取得します。 |
getRedirectResult | テナントIDを取得します。 SignInResult 入力されたリンクがメールアドレスでサインインするための適切なリンクであるかどうかを確認します。 |
getTenantId | Fetches the sign-in methods for an email address. |
isSignInWithEmailLink | Checks if an incoming link is a sign-in with email link suitable for 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 | __CAPGO_KEEP_0__をYahoo認証プロバイダーとリンクします。 |
reload | ユーザーアカウントデータを再読み込みします。 |
revokeAccessToken | アクセストークンを取り消します。現在、Apple OAuthアクセストークンのみをサポートしています。 |
sendEmailVerification | 現在のユーザーに確認メールを送信します。 |
sendPasswordResetEmail | パスワードリセットメールを送信します。 |
sendSignInLinkToEmail | 指定されたメールアドレスのユーザーにサインインリンクを送信します。 |
setLanguageCode | 認証操作用のユーザー向け言語をcodeに設定します。 |
setPersistence | 現在の保存済み認証セッションの保存方法を設定します。 |
setTenantId | テナントIDを設定します。 |
signInAnonymously | 匿名ユーザーとしてサインインします。 |
signInWithApple | Appleサインインフローを開始します。 |
signInWithCustomToken | カスタムトークンサインインフローを開始します。 |
signInWithEmailAndPassword | Starts the sign-in flow using an email and password. |
signInWithEmailLink | Signs in using an email and sign-in email link. |
signInWithFacebook | Starts the Facebook sign-in flow. |
signInWithGameCenter | Starts the Game Center sign-in flow. |
signInWithGithub | Starts the GitHub sign-in flow. |
signInWithGoogle | Starts the Google sign-in flow. |
signInWithMicrosoft | Starts the Microsoft sign-in flow. |
signInWithOpenIdConnect | Starts the OpenID Connect sign-in flow. |
signInWithPhoneNumber | Starts the sign-in flow using a phone number. |
signInWithPlayGames | Starts the Play Games sign-in flow. |
signInWithTwitter | Starts the Twitter sign-in flow. |
signInWithYahoo | Starts the Yahoo sign-in flow. |
signOut | Starts the sign-out flow. |
unlink | ユーザーアカウントからプロバイダをアンリンクします。 |
updateEmail | 現在ログイン中のユーザーのメールアドレスを更新します。 |
updatePassword | 現在ログイン中のユーザーのパスワードを更新します。 |
updateProfile | ユーザーのプロファイルデータを更新します。 |
useAppLanguage | ユーザーに表示される言語codeをデフォルトのアプリ言語に設定します。 |
useEmulator | Authentication エミュレータとアプリを連携するためのインストルメンテーションを実行します。 |
verifyBeforeUpdateEmail | 現在ログイン中のユーザーの新しいメールアドレスを検証する前にメールアドレスを更新します。 |
checkAppTrackingTransparencyPermission | アプリのトラッキング透明性の現在のステータスを確認します。 |
requestAppTrackingTransparencyPermission | アプリのトラッキング透明性の許可を求めるシステムダイアログを開きます。 |
addListener | ユーザーのサインイン状態の変更をリスンします。 |
addListener | 現在ログイン中のユーザーのIDトークンの変更をリスンします。 |
addListener | 電話番号の検証が完了したときに通知を受ける |
addListener | 電話番号の検証が失敗したときに通知を受ける |
addListener | 電話番号の検証がcodeのときに通知を受ける |
removeAllListeners | このプラグインのすべてのリスナーを削除する |
getPluginVersion | このプラグインのバージョンを取得する |
真実の源
「真実の源」この参照は src/definitions.ts から capacitor-firebase.
@capgo/capacitor-firebase-authenticationから続ける
「@capgo/capacitor-firebase-authenticationから続ける」あなたが @capgo/capacitor-firebase-authentication を使用している場合、認証とアカウントフローの計画に使用し、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-social-login に接続してください。@capgo/capacitor-social-login の実装詳細は@capgo/capacitor-social-login で確認してください。@capgo/capacitor-passkey の実装詳細は@capgo/capacitor-passkey で確認してください。@capgo/capacitor-native-biometric の実装詳細は@capgo/capacitor-native-biometric で確認してください。2要素認証 の実装詳細は2要素認証 で確認してください。SSO (Enterprise) __CAPGO_KEEP_0__の実装詳細については、SSO (Enterprise)のドキュメントを参照してください。