Guía
Cómo usar la autenticación de Firebase en Capacitor
Usando @capgo/capacitor-autenticación-firebase
Plugin de Capacitor para la autenticación de Firebase.
Instalar
bun add @capgo/capacitor-firebase-authentication
bunx cap sync
bunx cap sync copia el code nativo del plugin en tus proyectos nativos. Ejecútalo de nuevo después de cada actualización del plugin.
Importar
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
Vista general de API
| Metodo | Descripción |
|---|---|
applyActionCode |
Aplica una verificación code enviada al usuario por correo electrónico. |
confirmPasswordReset |
Completa el proceso de restablecimiento de contraseña. |
confirmVerificationCode |
Finaliza el proceso de verificación de número de teléfono. |
createUserWithEmailAndPassword |
Crear una nueva cuenta de usuario con correo electrónico y contraseña. Si se creó la nueva cuenta, el usuario se inicia sesión automáticamente. |
deleteUser |
Elimina y se desconecta al usuario. |
fetchSignInMethodsForEmail |
Fetches the sign-in methods for an email address. |
getCurrentUser |
Obtiene al usuario actualmente conectado. |
getPendingAuthResult |
Devuelve el SignInResult si su aplicación lanzó un flujo de inicio de sesión web y el sistema operativo elimina la aplicación mientras está en segundo plano. |
getIdToken |
Obtiene el token de autenticación de Firebase ID para el usuario actualmente conectado. |
getIdTokenResult |
Devuelve un JWT deserializado (JSON Web Token) utilizado para identificar al usuario a un servicio de Firebase. |
getRedirectResult |
Devuelve el SignInResult from the redirect-based sign-in flow. |
getTenantId |
Obtiene el ID de inquilino. |
isSignInWithEmailLink |
Verifica si un enlace de entrada es un enlace de inicio de sesión con correo electrónico adecuado para signInWithEmailLink. |
linkWithApple |
Une la cuenta de usuario con el proveedor de autenticación de Apple. |
linkWithEmailAndPassword |
Une la cuenta de usuario con el proveedor de autenticación de correo electrónico. |
linkWithEmailLink |
Une la cuenta de usuario con el proveedor de autenticación de correo electrónico. |
linkWithFacebook |
Une la cuenta de usuario con el proveedor de autenticación de Facebook. |
linkWithGameCenter |
Asocia la cuenta de usuario con el proveedor de autenticación de Game Center. |
linkWithGithub |
Conecta la cuenta de usuario con GitHub proveedor de autenticación. |
linkWithGoogle |
Asocia la cuenta de usuario con el proveedor de autenticación de Google. |
linkWithMicrosoft |
Asocia la cuenta de usuario con el proveedor de autenticación de Microsoft. |
linkWithOpenIdConnect |
Conecta la cuenta de usuario con un proveedor de autenticación OpenID Connect. |
linkWithPhoneNumber |
Asocia la cuenta de usuario con el proveedor de autenticación de Número de Teléfono. |
linkWithPlayGames |
Asocia la cuenta de usuario con el proveedor de autenticación de Play Games. |
linkWithTwitter |
Asocia la cuenta de usuario con el proveedor de autenticación de Twitter. |
linkWithYahoo |
Asocia la cuenta de usuario con el proveedor de autenticación de Yahoo. |
reload |
Recarga los datos de cuenta del usuario, si está conectado. |
revokeAccessToken |
Revoque el token de acceso dado. Actualmente solo admite tokens de acceso OAuth de Apple. |
sendEmailVerification |
Envía un correo electrónico de verificación al usuario actualmente conectado. |
sendPasswordResetEmail |
Envía un correo electrónico de restablecimiento de contraseña. |
sendSignInLinkToEmail |
Envía un enlace de inicio de sesión al usuario con el correo electrónico especificado. |
setLanguageCode |
Establece el idioma de usuario code para operaciones de autenticación. |
setPersistence |
Establece el tipo de persistencia para la sesión de autenticación actualmente guardada. |
setTenantId |
Establece el ID de inquilino. |
signInAnonymously |
Inicia sesión como un usuario anónimo. |
signInWithApple |
Inicia el flujo de inicio de sesión de Apple. |
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 |
Inicia el flujo de inicio de sesión de Facebook. |
signInWithGameCenter |
Inicia el flujo de inicio de sesión de Game Center. |
signInWithGithub |
Inicia el flujo de inicio de sesión GitHub. |
signInWithGoogle |
Inicia el flujo de inicio de sesión de Google. |
signInWithMicrosoft |
Inicia el flujo de inicio de sesión de Microsoft. |
signInWithOpenIdConnect |
Inicia el flujo de inicio de sesión de OpenID Connect. |
signInWithPhoneNumber |
Starts the sign-in flow using a phone number. |
signInWithPlayGames |
Inicia el flujo de inicio de sesión de Play Games. |
signInWithTwitter |
Inicia el flujo de inicio de sesión de Twitter. |
signInWithYahoo |
Inicia el flujo de inicio de sesión de Yahoo. |
signOut |
Inicia el flujo de cierre de sesión. |
unlink |
Desvincula un proveedor de una cuenta de usuario. |
updateEmail |
Actualiza la dirección de correo electrónico del usuario actualmente conectado. |
updatePassword |
Actualiza la contraseña del usuario actualmente conectado. |
updateProfile |
Actualiza los datos de perfil del usuario. |
useAppLanguage |
Establece el idioma de usuario code como el idioma predeterminado de la aplicación. |
useEmulator |
Instrumenta tu aplicación para comunicarse con el emulador de Autenticación. |
verifyBeforeUpdateEmail |
Verifica la nueva dirección de correo electrónico antes de actualizar la dirección de correo electrónico del usuario actualmente conectado. |
checkAppTrackingTransparencyPermission |
Verifica el estado actual de la transparencia de seguimiento de la aplicación. |
requestAppTrackingTransparencyPermission |
Abre el diálogo del sistema para autorizar la transparencia de seguimiento de la aplicación. |
Ejemplos
applyActionCode()
Aplica una verificación code enviada al usuario por correo electrónico.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.applyActionCode({ oobCode: 'oob-code' });
confirmPasswordReset()
Completa el proceso de restablecimiento de contraseña.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.confirmPasswordReset({
oobCode: 'oob-code',
newPassword: 'new-password',
});
confirmVerificationCode()
Finaliza el proceso de verificación del número de teléfono.
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()
Crear una nueva cuenta de usuario con correo electrónico y contraseña. Si se creó la nueva cuenta, el usuario se conecta automáticamente.
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()
Elimina y desconecta al usuario.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.deleteUser();
fetchSignInMethodsForEmail()
Fetches the sign-in methods for an email address.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.fetchSignInMethodsForEmail({ email: 'user@example.com' });
console.log(result);
La tabla anterior muestra los 59 métodos básicos. Los ayudantes de escucha y versión, y el contrato completo de cada método, se documentan en el repositorio de GitHub.
Escuchar eventos
addListener devuelve un manejador. Llame a handle.remove() cuando se desmonta la pantalla, o FirebaseAuthentication.removeAllListeners() para eliminar todos los escuchadores.
Referencia completa
Continúa desde Usando @capgo/capacitor-firebase-authentication
Si estás utilizando Usando @capgo/capacitor-firebase-authentication para planificar la autenticación y los flujos de cuenta, conecte con @capgo/capacitor-login-social para los detalles de implementación en @capgo/capacitor-social-login, @capgo/capacitor-clave de acceso para los detalles de implementación en @capgo/capacitor-passkey, @capgo/capacitor-nativo-biometria para los detalles de implementación en @capgo/capacitor-native-biometric, Autenticación en dos factores para los detalles de implementación en Autenticación en dos factores, y SSO (Empresas) para los detalles de implementación en SSO (Enterprise).