Guide
Comment utiliser l'authentification Firebase dans Capacitor
Utilisation de @capgo/capacitor-authentification-firebase
Le plugin Capacitor pour l'authentification Firebase.
Installer
bun add @capgo/capacitor-firebase-authentication
bunx cap sync
bunx cap sync copie le code natif du plugin dans vos projets natifs. Exécutez-l’à nouveau après chaque mise à jour du plugin.
Importer
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
API en un coup d'œil
| Méthode | Description |
|---|---|
applyActionCode |
Applique une vérification code envoyée à l'utilisateur par email. |
confirmPasswordReset |
Completes the password reset process. |
confirmVerificationCode |
Termine le processus de vérification du numéro de téléphone. |
createUserWithEmailAndPassword |
Crée un nouveau compte utilisateur avec adresse e-mail et mot de passe. Si le nouveau compte a été créé, l'utilisateur est connecté automatiquement. |
deleteUser |
Supprime et déconnecte l'utilisateur. |
fetchSignInMethodsForEmail |
Récupère les méthodes de connexion pour une adresse e-mail. |
getCurrentUser |
Récupère l'utilisateur connecté actuellement. |
getPendingAuthResult |
Returns le SignInResult if votre application a lancé une session de connexion web et que le système a nettoyé l'application pendant l'exécution en arrière-plan. |
getIdToken |
Récupère le jeton d'authentification Firebase ID pour l'utilisateur actuellement connecté. |
getIdTokenResult |
Returns un jeton Web JSON désérialisé (JWT) utilisé pour identifier l'utilisateur à un service Firebase. |
getRedirectResult |
Returns le SignInResult du flux de connexion basé sur la redirection. |
getTenantId |
Obtenez l'ID de locataire. |
isSignInWithEmailLink |
Vérifiez si un lien entrant est une session de connexion par e-mail appropriée pour signInWithEmailLink. |
linkWithApple |
Liens le compte utilisateur avec le fournisseur d'authentification Apple. |
linkWithEmailAndPassword |
Liens le compte utilisateur avec le fournisseur d'authentification Email. |
linkWithEmailLink |
Liens le compte utilisateur avec le fournisseur d'authentification Email. |
linkWithFacebook |
Liens le compte utilisateur avec le fournisseur d'authentification Facebook. |
linkWithGameCenter |
Lié l'account utilisateur avec le fournisseur d'authentification Game Center. |
linkWithGithub |
Lié l'account utilisateur avec le fournisseur d'authentification GitHub. |
linkWithGoogle |
Lié l'account utilisateur avec le fournisseur d'authentification Google. |
linkWithMicrosoft |
Lié l'account utilisateur avec le fournisseur d'authentification Microsoft. |
linkWithOpenIdConnect |
Lié l'account utilisateur avec un fournisseur d'authentification OpenID Connect. |
linkWithPhoneNumber |
Lié l'account utilisateur avec le fournisseur d'authentification du numéro de téléphone. |
linkWithPlayGames |
Lié l'account utilisateur avec le fournisseur d'authentification Play Games. |
linkWithTwitter |
Lié l'account utilisateur avec le fournisseur d'authentification Twitter. |
linkWithYahoo |
Lié l'account utilisateur avec le fournisseur d'authentification Yahoo. |
reload |
Rafraîchit les données de compte utilisateur, si connecté. |
revokeAccessToken |
Révoque l'access token spécifié. Actuellement, uniquement pris en charge pour les jetons d'accès OAuth Apple. |
sendEmailVerification |
Envoie un e-mail de vérification à l'utilisateur actuellement connecté. |
sendPasswordResetEmail |
Envoie un courriel de réinitialisation de mot de passe. |
sendSignInLinkToEmail |
Envoie un lien de connexion à l'utilisateur avec l'adresse e-mail spécifiée. |
setLanguageCode |
Fixe la langue utilisateur code pour les opérations d'authentification. |
setPersistence |
Fixe le type de persistance pour la session d'authentification enregistrée. |
setTenantId |
Fixe l'ID de locataire. |
signInAnonymously |
Se connecte en tant qu'utilisateur anonyme. |
signInWithApple |
Démarrage de la procédure de connexion Apple. |
signInWithCustomToken |
Démarre le flux de connexion par jeton personnalisé. |
signInWithEmailAndPassword |
Démarrage de la procédure de connexion avec un e-mail et un mot de passe. |
signInWithEmailLink |
Se connecte avec un e-mail et un lien de connexion. |
signInWithFacebook |
Démarrage de la procédure de connexion Facebook. |
signInWithGameCenter |
Démarrage de la procédure de connexion Game Center. |
signInWithGithub |
Démarre le flux de connexion GitHub. |
signInWithGoogle |
Démarre le flux de connexion Google. |
signInWithMicrosoft |
Démarre le flux de connexion Microsoft. |
signInWithOpenIdConnect |
Démarre le flux de connexion OpenID Connect. |
signInWithPhoneNumber |
Démarre le flux de connexion à l'aide d'un numéro de téléphone. |
signInWithPlayGames |
Démarre le flux de connexion Play Games. |
signInWithTwitter |
Démarre le flux de connexion Twitter. |
signInWithYahoo |
Démarre le flux de connexion Yahoo. |
signOut |
Démarre le flux de déconnexion. |
unlink |
Supprime un fournisseur d'un compte utilisateur. |
updateEmail |
Mise à jour de l'adresse e-mail de l'utilisateur actuellement connecté. |
updatePassword |
Mise à jour du mot de passe de l'utilisateur actuellement connecté. |
updateProfile |
Updates a user's profile data. |
useAppLanguage |
Fixe la langue utilisée par l'utilisateur code comme langue par défaut de l'application. |
useEmulator |
Instrumentez votre application pour communiquer avec l'émetteur d'authentification. |
verifyBeforeUpdateEmail |
Vérifie la nouvelle adresse e-mail avant de mettre à jour l'adresse e-mail de l'utilisateur actuellement connecté. |
checkAppTrackingTransparencyPermission |
Vérifie l'état actuel de la transparence de suivi de l'application. |
requestAppTrackingTransparencyPermission |
Autorise l'accès à la transparence de suivi de l'application. |
Exemples
applyActionCode()
Applique une vérification code envoyée à l'utilisateur par e-mail.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.applyActionCode({ oobCode: 'oob-code' });
confirmPasswordReset()
Completes the password reset process.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.confirmPasswordReset({
oobCode: 'oob-code',
newPassword: 'new-password',
});
confirmVerificationCode()
Termine le processus de vérification du numéro de téléphone.
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()
Crée un nouveau compte utilisateur avec e-mail et mot de passe. Si le nouveau compte a été créé, l'utilisateur est connecté automatiquement.
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()
Supprime et déconnecte l'utilisateur.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.deleteUser();
fetchSignInMethodsForEmail()
Récupère les méthodes de connexion pour une adresse e-mail.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.fetchSignInMethodsForEmail({ email: 'user@example.com' });
console.log(result);
La table ci-dessus liste les 59 méthodes de base. Les aides aux écouteurs et aux versions, ainsi que le contrat complet de chaque méthode, sont documentés dans le GitHub dépôt.
Écoutez les événements
addListener retourne un gestionnaire. Appelez handle.remove() lorsque l'écran est démonté, ou FirebaseAuthentication.removeAllListeners() pour supprimer tous les écouteurs.
Référence complète
Continuez à partir de l'utilisation de @capgo/capacitor-firebase-authentication
If vous utilisez Utilisation de @capgo/capacitor-firebase-authentication pour planifier l'authentification et les flux de compte, connectez-l’avec @capgo/capacitor-connexion-social pour les détails d'implémentation dans @capgo/capacitor-social-login, @capgo/capacitor-clé de passe pour les détails d'implémentation dans @capgo/capacitor-passkey, @capgo/capacitor-native-biometrique pour les détails d'implémentation dans @capgo/capacitor-native-biometric, Deux facteurs d'authentification pour les détails d'implémentation dans Deux facteurs d'authentification, et SSO (Entreprise) pour les détails d'implémentation dans SSO (Entreprise).