Anleitung
Firebase Authentication in Capacitor verwenden
@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 den nativen code des Plugins in deine nativen Projekte. Nach jedem Plugin-Upgrade erneut ausführen.
Importieren
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
API auf einen Blick
| Methode | Beschreibung |
|---|---|
applyActionCode |
Wendet einen Verifizierungs-code an, den der Nutzer per E-Mail erhalten hat. |
confirmPasswordReset |
Schließt den Passwort-Reset ab. |
confirmVerificationCode |
Schließt die Telefonnummer-Verifizierung ab. |
createUserWithEmailAndPassword |
Erstellt ein neues Benutzerkonto mit E-Mail und Passwort. Wenn das Konto erfolgreich erstellt wurde, wird der Benutzer automatisch angemeldet. |
deleteUser |
Löscht den Benutzer und meldet ihn ab. |
fetchSignInMethodsForEmail |
Ruft die Anmeldemethoden für eine E-Mail-Adresse ab. |
getCurrentUser |
Ruft den aktuell angemeldeten Benutzer ab. |
getPendingAuthResult |
Gibt den SignInResult falls deine App einen Web-Sign-in-Flow gestartet hat und das OS die App im Hintergrund beendet. |
getIdToken |
Ruft das Firebase Auth ID Token für den aktuell angemeldeten Benutzer ab. |
getIdTokenResult |
Gibt ein deserialisiertes JSON Web Token (JWT) zurück, mit dem der Benutzer gegenüber einem Firebase-Service identifiziert wird. |
getRedirectResult |
Gibt den SignInResult aus dem redirect-basierten Sign-in-Flow. |
getTenantId |
Tenant-ID abrufen. |
isSignInWithEmailLink |
Prüft, ob ein eingehender Link ein für den Sign-in per E-Mail-Link geeigneter Link ist signInWithEmailLink. |
linkWithApple |
Verknüpft das Benutzerkonto mit dem Apple Authentication Provider. |
linkWithEmailAndPassword |
Verknüpft das Benutzerkonto mit dem E-Mail-Authentifizierungsanbieter. |
linkWithEmailLink |
Verknüpft das Benutzerkonto mit dem E-Mail-Authentifizierungsanbieter. |
linkWithFacebook |
Verknüpft das Benutzerkonto mit dem Facebook Authentication Provider. |
linkWithGameCenter |
Verknüpft das Benutzerkonto mit dem Game Center Authentication Provider. |
linkWithGithub |
Verknüpft das Benutzerkonto mit dem GitHub Authentication Provider. |
linkWithGoogle |
Verknüpft das Benutzerkonto mit dem Google Authentication Provider. |
linkWithMicrosoft |
Verknüpft das Benutzerkonto mit dem Microsoft Authentication Provider. |
linkWithOpenIdConnect |
Verknüpft das Benutzerkonto mit einem OpenID-Connect-Provider. |
linkWithPhoneNumber |
Verknüpft das Benutzerkonto mit dem Phone-Number-Authentication-Provider. |
linkWithPlayGames |
Verknüpft das Benutzerkonto mit dem Play Games Authentication Provider. |
linkWithTwitter |
Verknüpft das Benutzerkonto mit dem Twitter Authentication Provider. |
linkWithYahoo |
Verknüpft das Benutzerkonto mit dem Authentifizierungsanbieter Yahoo. |
reload |
Lädt die Benutzerkontodaten neu, falls angemeldet. |
revokeAccessToken |
Widerruft den angegebenen Access Token. Derzeit werden nur Apple OAuth Access Tokens unterstützt. |
sendEmailVerification |
Sendet eine Verifizierungs-E-Mail an den aktuell angemeldeten Benutzer. |
sendPasswordResetEmail |
Sendet eine E-Mail zum Zurücksetzen des Passworts. |
sendSignInLinkToEmail |
Sendet dem Benutzer mit der angegebenen E-Mail-Adresse einen Anmelde-Link per E-Mail. |
setLanguageCode |
Legt die für Benutzer sichtbare Sprache code für Auth-Operationen fest. |
setPersistence |
Legt den Persistenztyp für die aktuell gespeicherte Auth-Session fest. |
setTenantId |
Legt die Tenant-ID fest. |
signInAnonymously |
Meldet sich als anonymen Benutzer an. |
signInWithApple |
Startet den Apple-Sign-in-Flow. |
signInWithCustomToken |
Startet den Custom-Token-Sign-in-Flow. |
signInWithEmailAndPassword |
Startet den Sign-in-Flow mit E-Mail und Passwort. |
signInWithEmailLink |
Meldet sich per E-Mail und Anmelde-Link an. |
signInWithFacebook |
Startet den Facebook-Anmelde-Flow. |
signInWithGameCenter |
Startet den Anmelde-Flow für Game Center. |
signInWithGithub |
Startet den GitHub-Sign-in-Flow. |
signInWithGoogle |
Startet den Google-Sign-in-Flow. |
signInWithMicrosoft |
Startet den Microsoft-Sign-in-Flow. |
signInWithOpenIdConnect |
Startet den OpenID-Connect-Sign-in-Flow. |
signInWithPhoneNumber |
Startet den Sign-in-Flow per Telefonnummer. |
signInWithPlayGames |
Startet den Play-Games-Sign-in-Flow. |
signInWithTwitter |
Startet den Twitter-Sign-in-Flow. |
signInWithYahoo |
Startet den Yahoo-Sign-in-Flow. |
signOut |
Startet den Sign-out-Flow. |
unlink |
Entkoppelt einen Provider von einem Benutzerkonto. |
updateEmail |
Aktualisiert die E-Mail-Adresse des aktuell angemeldeten Benutzers. |
updatePassword |
Aktualisiert das Passwort des aktuell angemeldeten Benutzers. |
updateProfile |
Aktualisiert die Profildaten eines Benutzers. |
useAppLanguage |
Setzt die für Nutzer sichtbare Sprache code als Standardsprache der App. |
useEmulator |
Instrumentiere deine App für die Kommunikation mit dem Authentication-Emulator. |
verifyBeforeUpdateEmail |
Verifiziert die neue E-Mail-Adresse, bevor die E-Mail-Adresse des aktuell angemeldeten Benutzers aktualisiert wird. |
checkAppTrackingTransparencyPermission |
Prüft den aktuellen Status der App Tracking Transparency. |
requestAppTrackingTransparencyPermission |
Öffnet den Systemdialog, um App Tracking Transparency zu autorisieren. |
Beispiele
applyActionCode()
Wendet einen Verifizierungs-code an, den der Nutzer per E-Mail erhalten hat.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.applyActionCode({ oobCode: 'oob-code' });
confirmPasswordReset()
Schließt den Passwort-Reset ab.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.confirmPasswordReset({
oobCode: 'oob-code',
newPassword: 'new-password',
});
confirmVerificationCode()
Schließt die Telefonnummer-Verifizierung ab.
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 und Passwort. Wenn das Konto erfolgreich 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 den Benutzer und meldet ihn ab.
import { FirebaseAuthentication } from '@capgo/capacitor-firebase-authentication';
await FirebaseAuthentication.deleteUser();
fetchSignInMethodsForEmail()
Ruft 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. Listener- und Versions-Helper sowie der vollständige Contract jeder Methode sind in der GitHub Repository.
Events abonnieren
addListener gibt ein Handle zurück. Rufe handle.remove() auf, wenn der Screen unmountet, oder FirebaseAuthentication.removeAllListeners() auf, um alle Listener zu entfernen.
Vollständige Referenz
Weiter geht's mit Using @capgo/capacitor-firebase-authentication
Wenn du es nutzt @capgo/capacitor-firebase-authentication verwenden Um Authentifizierungs- und Account-Flows zu planen, verbinde es mit @capgo/capacitor-social-login für die Implementierungsdetails in @capgo/capacitor-social-login, @capgo/capacitor-passkey für die Implementierungsdetails in @capgo/capacitor-passkey, @capgo/capacitor-native-biometric für die Implementierungsdetails in @capgo/capacitor-native-biometric, Zwei-Faktor-Authentifizierung für die Implementierungsdetails zur Zwei-Faktor-Authentifizierung, und SSO (Enterprise) für die Implementierungsdetails zu SSO (Enterprise).