@capgo/capacitor-firebase-authentication

Overview

Capacitor plugin for Firebase Authentication.

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

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	Creates a new user account with email and password. If the new account was created, the user is signed in automatically.
deleteUser	Deletes and signs out the user.
fetchSignInMethodsForEmail	Fetches the sign-in methods for an email address.
getCurrentUser	Fetches the currently signed-in user.
getPendingAuthResult	Returns the SignInResult if your app launched a web sign-in flow and the OS cleans up the app while in the background.
getIdToken	Fetches the Firebase Auth ID Token for the currently signed-in user.
getIdTokenResult	Returns a deserialized JSON Web Token (JWT) used to identify the user to a Firebase service.
getRedirectResult	Returns the SignInResult from the redirect-based sign-in flow.
getTenantId	Get the tenant id.
isSignInWithEmailLink	Checks if an incoming link is a sign-in with email link suitable for signInWithEmailLink.
linkWithApple	Links the user account with Apple authentication provider.
linkWithEmailAndPassword	Links the user account with Email authentication provider.
linkWithEmailLink	Links the user account with Email authentication provider.
linkWithFacebook	Links the user account with Facebook authentication provider.
linkWithGameCenter	Links the user account with Game Center authentication provider.
linkWithGithub	Links the user account with GitHub authentication provider.
linkWithGoogle	Links the user account with Google authentication provider.
linkWithMicrosoft	Links the user account with Microsoft authentication provider.
linkWithOpenIdConnect	Links the user account with an OpenID Connect provider.
linkWithPhoneNumber	Links the user account with Phone Number authentication provider.
linkWithPlayGames	Links the user account with Play Games authentication provider.
linkWithTwitter	Links the user account with Twitter authentication provider.
linkWithYahoo	Links the user account with Yahoo authentication provider.
reload	Reloads user account data, if signed in.
revokeAccessToken	Revokes the given access token. Currently only supports Apple OAuth access tokens.
sendEmailVerification	Sends a verification email to the currently signed in user.
sendPasswordResetEmail	Sends a password reset email.
sendSignInLinkToEmail	Sends a sign-in email link to the user with the specified email.
setLanguageCode	Sets the user-facing language code for auth operations.
setPersistence	Sets the type of persistence for the currently saved auth session.
setTenantId	Sets the tenant id.
signInAnonymously	Signs in as an anonymous user.
signInWithApple	Starts the Apple sign-in flow.
signInWithCustomToken	Starts the Custom Token sign-in flow.
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	Unlinks a provider from a user account.
updateEmail	Updates the email address of the currently signed in user.
updatePassword	Updates the password of the currently signed in user.
updateProfile	Updates a user’s profile data.
useAppLanguage	Sets the user-facing language code to be the default app language.
useEmulator	Instrument your app to talk to the Authentication emulator.
verifyBeforeUpdateEmail	Verifies the new email address before updating the email address of the currently signed in user.
checkAppTrackingTransparencyPermission	Checks the current status of app tracking transparency.
requestAppTrackingTransparencyPermission	Opens the system dialog to authorize app tracking transparency.
addListener	Listen for the user’s sign-in state changes.
addListener	Listen to ID token changes for the currently signed-in user.
addListener	Listen for a completed phone verification.
addListener	Listen for a failed phone verification.
addListener	Listen for a phone verification code.
removeAllListeners	Remove all listeners for this plugin.
getPluginVersion	Get the version of this plugin.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-firebase.