Firebase Authentication Plugin Capacitor

Utiliser @capgo/capacitor-firebase-authentication

Plugin Capacitor pour Firebase Authentication.

Installer

bun add @capgo/capacitor-firebase-authentication
bunx cap sync

bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.

Importer

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

Aperçu de API

Méthode	Description
applyActionCode	Applique un code de vérification envoyé à l'utilisateur par e-mail.
confirmPasswordReset	Finalise la réinitialisation du mot de passe.
confirmVerificationCode	Termine le processus de vérification du numéro de téléphone.
createUserWithEmailAndPassword	Crée un nouveau compte utilisateur avec un e-mail et un mot de passe. Si le compte est créé, l'utilisateur est automatiquement connecté.
deleteUser	Supprime l'utilisateur et le déconnecte.
fetchSignInMethodsForEmail	Récupère les méthodes de connexion pour une adresse e-mail.
getCurrentUser	Récupère l'utilisateur actuellement connecté.
getPendingAuthResult	Retourne le SignInResult si votre application a lancé un flux de connexion web et que l'OS ferme l'application en arrière-plan.
getIdToken	Récupère le token ID Firebase Auth pour l'utilisateur actuellement connecté.
getIdTokenResult	Retourne un JSON Web Token (JWT) désérialisé utilisé pour identifier l'utilisateur auprès d'un service Firebase.
getRedirectResult	Retourne le SignInResult du flux de connexion basé sur une redirection.
getTenantId	Récupérer l'ID du tenant.
isSignInWithEmailLink	Vérifie si un lien entrant est une connexion par lien e-mail compatible avec signInWithEmailLink.
linkWithApple	Lier le compte utilisateur au fournisseur d'authentification Apple.
linkWithEmailAndPassword	Lier le compte utilisateur au fournisseur d'authentification par e-mail.
linkWithEmailLink	Lier le compte utilisateur au fournisseur d'authentification par e-mail.
linkWithFacebook	Lier le compte utilisateur au fournisseur d'authentification Facebook.
linkWithGameCenter	Associe le compte utilisateur au fournisseur d'authentification Game Center.
linkWithGithub	Associe le compte utilisateur au fournisseur d’authentification GitHub.
linkWithGoogle	Associe le compte utilisateur au fournisseur d’authentification Google.
linkWithMicrosoft	Associe le compte utilisateur au fournisseur d’authentification Microsoft.
linkWithOpenIdConnect	Associe le compte utilisateur à un fournisseur OpenID Connect.
linkWithPhoneNumber	Associe le compte utilisateur au fournisseur d’authentification par numéro de téléphone.
linkWithPlayGames	Associe le compte utilisateur au fournisseur d’authentification Play Games.
linkWithTwitter	Associe le compte utilisateur au fournisseur d’authentification Twitter.
linkWithYahoo	Associe le compte utilisateur au fournisseur d'authentification Yahoo.
reload	Recharge les données du compte utilisateur, si connecté.
revokeAccessToken	Révoque le token d'accès fourni. Prend actuellement en charge uniquement les tokens d'accès Apple OAuth.
sendEmailVerification	Envoie un e-mail de vérification à l'utilisateur actuellement connecté.
sendPasswordResetEmail	Envoie un e-mail de réinitialisation de mot de passe.
sendSignInLinkToEmail	Envoie un lien de connexion par e-mail à l'utilisateur ayant l'adresse e-mail indiquée.
setLanguageCode	Définit la langue code pour les opérations d'authentification.
setPersistence	Définit le type de persistance de la session d'authentification enregistrée.
setTenantId	Définit l'ID du tenant.
signInAnonymously	Se connecte en tant qu'utilisateur anonyme.
signInWithApple	Lance le flux de connexion Apple.
signInWithCustomToken	Lance le flux de connexion via Custom Token.
signInWithEmailAndPassword	Lance le flux de connexion par e-mail et mot de passe.
signInWithEmailLink	Se connecte via un e-mail et un lien de connexion.
signInWithFacebook	Lance le flux de connexion Facebook.
signInWithGameCenter	Lance le flux de connexion Game Center.
signInWithGithub	Lance le flux de connexion GitHub.
signInWithGoogle	Lance le flux de connexion Google.
signInWithMicrosoft	Lance le flux de connexion Microsoft.
signInWithOpenIdConnect	Lance le flux de connexion OpenID Connect.
signInWithPhoneNumber	Lance le flux de connexion par numéro de téléphone.
signInWithPlayGames	Lance le flux de connexion Play Games.
signInWithTwitter	Lance le flux de connexion Twitter.
signInWithYahoo	Lance le flux de connexion Yahoo.
signOut	Lance le flux de déconnexion.
unlink	Dissocie un fournisseur d’un compte utilisateur.
updateEmail	Met à jour l’adresse e-mail de l’utilisateur connecté.
updatePassword	Met à jour le mot de passe de l’utilisateur connecté.
updateProfile	Met à jour les données du profil utilisateur.
useAppLanguage	Définit la langue d'affichage code comme langue par défaut de l'application.
useEmulator	Configure votre application pour communiquer avec l'émulateur Authentication.
verifyBeforeUpdateEmail	Vérifie la nouvelle adresse e-mail avant de mettre à jour l'adresse e-mail de l'utilisateur actuellement connecté.
checkAppTrackingTransparencyPermission	Vérifie le statut actuel de l'App Tracking Transparency.
requestAppTrackingTransparencyPermission	Ouvre la boîte de dialogue système pour autoriser l'App Tracking Transparency.

Exemples

applyActionCode()

Applique un code de vérification envoyé à l'utilisateur par e-mail.

import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';

await FirebaseAuthentication.applyActionCode({ oobCode: 'oob-code' });

confirmPasswordReset()

Finalise la réinitialisation du mot de passe.

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 un e-mail et un mot de passe. Si le compte est créé, l'utilisateur est automatiquement connecté.

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 l'utilisateur et le déconnecte.

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);

Le tableau ci-dessus liste les 59 méthodes principales. Les helpers de listener et de version, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.

Écouter les événements

addListener renvoie un handle. Appelez handle.remove() lors du démontage de l'écran, ou FirebaseAuthentication.removeAllListeners() pour supprimer tous les listeners.

Référence complète

• dépôt GitHub
• Documentation
• Référence API

Continuer depuis « Utiliser @capgo/capacitor-firebase-authentication »

Si vous utilisez Utiliser @capgo/capacitor-firebase-authentication pour planifier les flux d'authentification et de compte, le connecter à @capgo/capacitor-social-login pour les détails d'implémentation dans @capgo/capacitor-social-login @capgo/capacitor-passkey pour les détails d'implémentation dans @capgo/capacitor-passkey @capgo/capacitor-native-biometric pour les détails d'implémentation dans @capgo/capacitor-native-biometric, Authentification à deux facteurs pour les détails d'implémentation dans l'authentification à deux facteurs, et SSO (Entreprise) pour les détails d'implémentation dans le SSO (Enterprise).