Richtlinie
Wie Sie Firebase Authentication in Capacitor verwenden
Mit @capgo/capacitor-firebase-authentication verwenden
Capacitor-Plugin für Firebase Authentication
Installieren
bun add @capgo/capacitor-firebase-authentication
bunx cap sync
bunx cap sync kopiert die native code-Implementierung in Ihren native Projekten. Führen Sie es erneut durch, nachdem jede Plugin-Upgrade durchgeführt wurde.
Importieren
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
API im Überblick
| Methode | Beschreibung |
|---|---|
applyActionCode |
Erfolgt eine Bestätigung des von der E-Mail gesendeten code. |
confirmPasswordReset |
Abschließt den Passwort-Restore-Prozess. |
confirmVerificationCode |
Abschließt den Telefonnummer-Verifizierungsprozess. |
createUserWithEmailAndPassword |
Erstellt ein neues Benutzerkonto mit E-Mail-Adresse und Passwort. Wenn das neue Konto erstellt wurde, wird der Benutzer automatisch angemeldet. |
deleteUser |
Löscht und meldet den Benutzer ab. |
fetchSignInMethodsForEmail |
Holt die Anmeldemethoden für eine E-Mail-Adresse. |
getCurrentUser |
Holt den derzeit angemeldeten Benutzer. |
getPendingAuthResult |
Returns the SignInResult Holt den Firebase Auth ID-Token für den derzeit angemeldeten Benutzer. |
getIdToken |
Holt die Firebase Auth ID Token für den derzeit angemeldeten Benutzer. |
getIdTokenResult |
Rückgibt ein deserialisiertes JSON Web Token (JWT), das verwendet wird, um den Benutzer bei einem Firebase-Dienst zu identifizieren. |
getRedirectResult |
Returns the SignInResult aus der redirect-basierten Anmeldeablauf. |
getTenantId |
Rufe die Tenant-ID ab. |
isSignInWithEmailLink |
Überprüft, ob ein eingehender Link eine Anmeldelinke per E-Mail ist, der für signInWithEmailLink. |
linkWithApple |
Verbindet das Benutzerkonto mit dem Apple-Authentifizierungsanbieter. |
linkWithEmailAndPassword |
Verbindet das Benutzerkonto mit dem E-Mail-Authentifizierungsanbieter. |
linkWithEmailLink |
Verbindet das Benutzerkonto mit dem E-Mail-Authentifizierungsanbieter. |
linkWithFacebook |
Verbindet das Benutzerkonto mit dem Facebook-Authentifizierungsanbieter. |
linkWithGameCenter |
Verbindet das Benutzerkonto mit dem Game Center-Authentifizierungsanbieter. |
linkWithGithub |
Verbindet das Benutzerkonto mit GitHub Authentifizierungsanbieter. |
linkWithGoogle |
Verbindet das Benutzerkonto mit dem Google-Authentifizierungsanbieter. |
linkWithMicrosoft |
Verbindet das Benutzerkonto mit dem Microsoft-Authentifizierungsanbieter. |
linkWithOpenIdConnect |
Verbindet das Benutzerkonto mit einem OpenID-Connect-Anbieter. |
linkWithPhoneNumber |
Verbindet das Benutzerkonto mit dem Telefonnummer-Authentifizierungsanbieter. |
linkWithPlayGames |
Verbindet das Benutzerkonto mit dem Play Games-Authentifizierungsanbieter. |
linkWithTwitter |
Verbindet das Benutzerkonto mit dem Twitter-Authentifizierungsanbieter. |
linkWithYahoo |
Verbindet das Benutzerkonto mit dem Yahoo-Authentifizierungsanbieter. |
reload |
Neuladet die Benutzerdaten, wenn angemeldet. |
revokeAccessToken |
Rückgängig macht den gegebenen Zugriffstoken. Aktuell nur Apple OAuth-Zugriffstoken unterstützt. |
sendEmailVerification |
Sendet eine Bestätigungs-E-Mail an den derzeit angemeldeten Benutzer. |
sendPasswordResetEmail |
Sendet eine Passwortsatz-E-Mail. |
sendSignInLinkToEmail |
Sendet eine Anmelde-Link-E-Mail an den Benutzer mit der angegebenen E-Mail-Adresse. |
setLanguageCode |
Setzt die Benutzerfassungssprache code für Auth-Betriebe. |
setPersistence |
Setzt den Typ der Persistenz für die derzeit gespeicherte Auth-Sitzung. |
setTenantId |
Setzt die Tenant-ID. |
signInAnonymously |
Melde sich als anonymer Benutzer an. |
signInWithApple |
Startet den Apple-Anmeldefluss. |
signInWithCustomToken |
Startet den Custom Token-Anmeldefluss. |
signInWithEmailAndPassword |
Startet den Anmeldeprozess mit E-Mail- und Passwort. |
signInWithEmailLink |
Mithilfe einer E-Mail und einer Anmelde-Link-E-Mail anmeldet. |
signInWithFacebook |
Startet den Facebook-Anmeldeprozess. |
signInWithGameCenter |
Startet den Game Center-Anmeldeprozess. |
signInWithGithub |
Startet den GitHub-Anmeldeprozess. |
signInWithGoogle |
Startet den Google-Anmeldeprozess. |
signInWithMicrosoft |
Startet den Microsoft-Anmeldeprozess. |
signInWithOpenIdConnect |
Startet den OpenID Connect-Anmeldeprozess. |
signInWithPhoneNumber |
Startet den Anmeldeprozess mit einer Telefonnummer. |
signInWithPlayGames |
Startet den Play Games-Anmeldeprozess. |
signInWithTwitter |
Startet den Twitter-Anmeldeprozess. |
signInWithYahoo |
Startet den Yahoo-Anmeldeprozess. |
signOut |
Startet den Abmeldeflow. |
unlink |
Entkoppelt einen Anbieter von einem Benutzerkonto. |
updateEmail |
Aktualisiert die E-Mail-Adresse des aktuellen angemeldeten Benutzers. |
updatePassword |
Aktualisiert das Passwort des aktuellen angemeldeten Benutzers. |
updateProfile |
Aktualisiert die Profildaten eines Benutzers. |
useAppLanguage |
Setzt die Benutzer-code-Sprache zur Standard-App-Sprache. |
useEmulator |
Konfiguriert Ihre App, um mit der Authentifizierungsimulator zu kommunizieren. |
verifyBeforeUpdateEmail |
Überprüft die neue E-Mail-Adresse, bevor die E-Mail-Adresse des aktuellen angemeldeten Benutzers aktualisiert wird. |
checkAppTrackingTransparencyPermission |
Überprüft den aktuellen Status der App-Tracking-Transparenz. |
requestAppTrackingTransparencyPermission |
Öffnet das Systemdialogfeld zur Autorisierung der App-Tracking-Transparenz. |
Beispiele
applyActionCode()
Anwendet eine Bestätigung code, die dem Benutzer per E-Mail gesendet wurde.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.applyActionCode({ oobCode: 'oob-code' });
confirmPasswordReset()
Abschließt das Passwortsynchronisierungsverfahren.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.confirmPasswordReset({
oobCode: 'oob-code',
newPassword: 'new-password',
});
confirmVerificationCode()
Beendet das Telefonnummernverifizierungsverfahren.
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()
Erstellt ein neues Benutzerkonto mit E-Mail-Adresse und Passwort. Wenn das neue Konto erstellt wurde, wird der Benutzer automatisch angemeldet.
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()
Löscht und meldet den Benutzer ab.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.deleteUser();
fetchSignInMethodsForEmail()
Holt die Anmeldemethoden für eine E-Mail-Adresse ab.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
const result = await FirebaseAuthentication.fetchSignInMethodsForEmail({ email: 'user@example.com' });
console.log(result);
Die obige Tabelle listet die 59 Kernmethoden auf. Helfer für Listener und Versionen sowie die vollständige Vertragsstruktur jeder Methode sind im GitHub Repository.
Zu Ereignissen hören
addListener gibt einen Handle zurück. Ruf handle.remove() auf, wenn die Seite entladen wird, oder FirebaseAuthentication.removeAllListeners() um jeden Listener zu löschen.
Vollständige Referenz
Fortfahren von Using @capgo/capacitor-firebase-authentication
Wenn Sie Using @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-firebase-authentication verwenden Mit @capgo/capacitor-firebase-authentifizierung um Authentifizierung und Kontoflows zu planen, verbinden Sie es mit zur Implementierungsdetail in @capgo/capacitor-social-login für die Implementierungsdetails in @capgo/capacitor-Social-Login, zur Implementierungsdetail in @capgo/capacitor-passkey für die Implementierungsdetails in @capgo/capacitor-Passkey, @capgo/capacitor-native-biometrisch zur Implementierungsdetail in @capgo/capacitor-native-biometric, Zweifaktor-Authentifizierung zur Implementierungsdetail in Zweifaktor-Authentifizierung, und SSO (Unternehmen) zur Implementierungsdetail in SSO (Unternehmen).