Getting Started

Installieren

Sie können unser AI-gestütztes Setup verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem AI-Tool hinzu, indem Sie den folgenden Befehl verwenden:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Dann verwenden Sie die folgende Anweisung:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-firebase-authentication` plugin in my project.

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und folgen Sie den unten angegebenen plattform-spezifischen Anweisungen:

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

Importieren

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

API Übersicht

applyActionCode

Wendet eine Bestätigung code an, die dem Nutzer per E-Mail gesendet wurde.

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

await FirebaseAuthentication.applyActionCode({} as ApplyActionCodeOptions);

confirmPasswordReset

Abschließt den Passwortsynchronisierungsprozess.

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

await FirebaseAuthentication.confirmPasswordReset({} as ConfirmPasswordResetOptions);

confirmVerificationCode

Beendet den Telefonnummernbestätigungsprozess.

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

await FirebaseAuthentication.confirmVerificationCode({} as ConfirmVerificationCodeOptions);

createUserWithEmailAndPassword

Erstellt ein neues Benutzerkonto mit E-Mail-Adresse und Passwort. Wenn das neue Konto erstellt wurde, wird der Nutzer automatisch angemeldet.

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

await FirebaseAuthentication.createUserWithEmailAndPassword({} as CreateUserWithEmailAndPasswordOptions);

deleteUser

Der Benutzer löscht und meldet sich aus.

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

await FirebaseAuthentication.deleteUser();

fetchSignInMethodsForEmail

Abholt die Anmeldemethoden für eine E-Mail-Adresse.

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

await FirebaseAuthentication.fetchSignInMethodsForEmail({} as FetchSignInMethodsForEmailOptions);

getCurrentUser

Abholt den derzeit angemeldeten Benutzer.

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

await FirebaseAuthentication.getCurrentUser();

getPendingAuthResult

Gibt zurück die SignInResult wenn Ihre App eine Web-Anmeldeflow gestartet hat und das Betriebssystem den App-Ordner im Hintergrund löscht.

Nur für Android verfügbar.

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

await FirebaseAuthentication.getPendingAuthResult();

getIdToken

Holt den Firebase Auth ID Token für den derzeit angemeldeten Benutzer.

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

await FirebaseAuthentication.getIdToken();

getIdTokenResult

Ruft einen deserialisierten JSON Web Token (JWT) ab, der zum Identifizieren des Benutzers bei einem Firebase-Dienst verwendet wird.

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

await FirebaseAuthentication.getIdTokenResult();

getRedirectResult

Gibt zurück das SignInResult aus dem redirect-basierten Anmeldefluss.

Wenn die Anmeldung fehlschlägt, schlägt sie mit einem Fehler aus. Wenn keine Redirect-Operation aufgerufen wurde, gibt sie ein SignInResult mit einem null-User.

Nur für Web verfügbar.

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

await FirebaseAuthentication.getRedirectResult();

getTenantId

Den Tenant-Id abrufen.

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

await FirebaseAuthentication.getTenantId();

isSignInWithEmailLink

Überprüft, ob ein eingehender Link eine Anmeldung per E-Mail-Link geeignet für signInWithEmailLink.

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

await FirebaseAuthentication.isSignInWithEmailLink({} as IsSignInWithEmailLinkOptions);

linkWithApple

Das Benutzerkonto mit dem Apple-Authentifizierungsanbieter verbindet.

Der Benutzer muss auf der native Ebene angemeldet sein. skipNativeAuth Die Konfigurationsoption hat hier keinen Einfluss.

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

await FirebaseAuthentication.linkWithApple();

linkWithEmailAndPassword

Verknüpft das Benutzerkonto mit dem E-Mail-Authentifizierungsanbieter.

Der Benutzer muss auf der native Layer angemeldet sein. Die skipNativeAuth Die Konfigurationsoption hat hier keinen Einfluss.

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

await FirebaseAuthentication.linkWithEmailAndPassword({} as LinkWithEmailAndPasswordOptions);

linkWithEmailLink

Verknüpft das Benutzerkonto mit dem E-Mail-Authentifizierungsanbieter.

Der Benutzer muss auf der native Layer angemeldet sein. Die skipNativeAuth Die Konfigurationsoption hat hier keinen Einfluss.

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

await FirebaseAuthentication.linkWithEmailLink({} as LinkWithEmailLinkOptions);

linkWithFacebook

Verbindet das Benutzerkonto mit dem Facebook-Authentifizierungsanbieter.

Der Benutzer muss sich auf der nativen Ebene angemeldet haben. Die skipNativeAuth Konfigurationsoption hat hier keinen Einfluss.

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

await FirebaseAuthentication.linkWithFacebook();

linkWithGameCenter

Verbindet das Benutzerkonto mit dem Game Center-Authentifizierungsanbieter.

Der Benutzer muss sich auf der nativen Ebene angemeldet haben. Die skipNativeAuth Konfigurationsoption hat hier keinen Einfluss.

Verfügbar nur für iOS.

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

await FirebaseAuthentication.linkWithGameCenter();

linkWithGithub

Links die Benutzerkonto mit GitHub Authentifizierungsanbieter.

Der Benutzer muss sich auf der native Layer angemeldet haben. Die skipNativeAuth Konfigurationsoption hat hier keinen Einfluss.

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

await FirebaseAuthentication.linkWithGithub();

linkWithGoogle

Links das Benutzerkonto mit Google Authentifizierungsanbieter.

Der Benutzer muss sich auf der native Layer angemeldet haben. Die skipNativeAuth Konfigurationsoption hat hier keinen Einfluss.

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

await FirebaseAuthentication.linkWithGoogle();

linkWithMicrosoft

Links das Benutzerkonto mit Microsoft Authentifizierungsanbieter.

Der Benutzer muss sich auf der native Layer angemeldet haben. Die skipNativeAuth Diese Konfigurationsoption hat keinen Einfluss hier.

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

await FirebaseAuthentication.linkWithMicrosoft();

linkWithOpenIdConnect

Das Benutzerkonto mit einem OpenID Connect-Anbieter verbindet.

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

await FirebaseAuthentication.linkWithOpenIdConnect({} as LinkWithOpenIdConnectOptions);

linkWithPhoneNumber

Das Benutzerkonto mit einem Anbieter für die Telefonnummer-Benutzerauthentifizierung verbindet.

Der Benutzer muss auf der native Ebene angemeldet sein. Diese skipNativeAuth Konfigurationsoption hat keinen Einfluss hier.

Verwenden Sie den phoneVerificationCompleted Listener, um benachrichtigt zu werden, wenn die Verifizierung abgeschlossen ist. Verwenden Sie den phoneVerificationFailed Listener, um benachrichtigt zu werden, wenn die Verifizierung fehlgeschlagen ist. Verwenden Sie den phoneCodeSent Hörer, um die Verifizierungs-ID zu erhalten.

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

await FirebaseAuthentication.linkWithPhoneNumber({} as LinkWithPhoneNumberOptions);

linkWithPlayGames

Verknüpft das Benutzerkonto mit dem Authentifizierungsanbieter Play Games.

Der Benutzer muss sich auf der native Ebene angemeldet haben. Die skipNativeAuth Konfigurationsoption hat hier keinen Einfluss.

Nur für Android verfügbar.

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

await FirebaseAuthentication.linkWithPlayGames();

linkWithTwitter

Verknüpft das Benutzerkonto mit dem Authentifizierungsanbieter Twitter.

Der Benutzer muss sich auf der native Ebene angemeldet haben. Die skipNativeAuth Konfigurationsoption hat hier keinen Einfluss.

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

await FirebaseAuthentication.linkWithTwitter();

linkWithYahoo

Verbindet das Benutzerkonto mit dem Yahoo-Authentifizierungsanbieter.

Der Benutzer muss sich auf der native Ebene angemeldet haben. Die skipNativeAuth Konfigurationsoption hat hier keinen Einfluss.

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

await FirebaseAuthentication.linkWithYahoo();

reload

Aktualisiert die Benutzerkontodaten, wenn angemeldet.

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

await FirebaseAuthentication.reload();

revokeAccessToken

Ruft den angegebenen Zugriffstoken ab. Aktuell unterstützt nur Apple OAuth-Zugriffstoken.

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

await FirebaseAuthentication.revokeAccessToken({} as RevokeAccessTokenOptions);

sendEmailVerification

Sendet eine Bestätigungs-E-Mail an den derzeit angemeldeten Benutzer.

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

await FirebaseAuthentication.sendEmailVerification();

sendPasswordResetEmail

Sendet eine E-Mail zur Passwort-Zurücksetzung.

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

await FirebaseAuthentication.sendPasswordResetEmail({} as SendPasswordResetEmailOptions);

sendSignInLinkToEmail

Sendet eine E-Mail-Link zum Anmelden an den Benutzer mit der angegebenen E-Mail-Adresse.

Um das Anmelden mit der E-Mail-Link zu beenden, rufen Sie signInWithEmailLink mit der E-Mail-Adresse und dem E-Mail-Link, der dem Benutzer in der E-Mail zugesendet wurde.

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

await FirebaseAuthentication.sendSignInLinkToEmail({} as SendSignInLinkToEmailOptions);

setLanguageCode

Setzt die Benutzerfachsprache code für Auth-Berechtigungen.

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

await FirebaseAuthentication.setLanguageCode({} as SetLanguageCodeOptions);

setPersistence

Setzt den Typ der Persistenz für die derzeit gespeicherte Auth-Sitzung.

Nur für Web verfügbar.

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

await FirebaseAuthentication.setPersistence({} as SetPersistenceOptions);

setTenantId

Setzt die Tenant-ID.

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

await FirebaseAuthentication.setTenantId({} as SetTenantIdOptions);

signInAnonymously

Als anonymer Benutzer anmelden.

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

await FirebaseAuthentication.signInAnonymously();

signInWithApple

Der Apple-Anmeldungsfluss startet.

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

await FirebaseAuthentication.signInWithApple();

signInWithCustomToken

Der Custom Token-Anmeldungsfluss startet.

Diese Methode kann nicht mit der skipNativeAuth auf Android und iOS verwendet werden. In diesem Fall müssen Sie die signInWithCustomToken Schnittstelle des Firebase JS SDK direkt verwenden.

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

await FirebaseAuthentication.signInWithCustomToken({} as SignInWithCustomTokenOptions);

signInWithEmailAndPassword

Der Anmeldungsfluss mit E-Mail und Passwort startet.

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

await FirebaseAuthentication.signInWithEmailAndPassword({} as SignInWithEmailAndPasswordOptions);

signInWithEmailLink

Mit E-Mail und E-Mail-Anmelde-Link anmeldet.

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

await FirebaseAuthentication.signInWithEmailLink({} as SignInWithEmailLinkOptions);

signInWithFacebook

Startet den Facebook-Anmelde-Flow.

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

await FirebaseAuthentication.signInWithFacebook();

signInWithGameCenter

Startet den Game Center-Anmelde-Flow.

Nur für iOS verfügbar.

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

await FirebaseAuthentication.signInWithGameCenter();

signInWithGithub

Startet den GitHub-Anmelde-Flow.

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

await FirebaseAuthentication.signInWithGithub();

signInWithGoogle

Der Google-Anmeldefluss startet.

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

await FirebaseAuthentication.signInWithGoogle();

signInWithMicrosoft

Der Microsoft-Anmeldefluss startet.

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

await FirebaseAuthentication.signInWithMicrosoft();

signInWithOpenIdConnect

Der OpenID-Connect-Anmeldefluss startet.

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

await FirebaseAuthentication.signInWithOpenIdConnect({} as SignInWithOpenIdConnectOptions);

signInWithPhoneNumber

Der Anmeldefluss mit einer Telefonnummer startet.

Benutze den phoneVerificationCompleted Listener, um benachrichtigt zu werden, wenn die Verifizierung abgeschlossen ist. Benutze den phoneVerificationFailed Listener, um benachrichtigt zu werden, wenn die Verifizierung fehlgeschlagen ist. Benutze den phoneCodeSent Listener, um die Verifizierungs-ID zu erhalten.

Nur für Android und iOS verfügbar.

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

await FirebaseAuthentication.signInWithPhoneNumber({} as SignInWithPhoneNumberOptions);

signInWithPlayGames

Startet den Play Games-Anmeldefluss.

Nur für Android verfügbar.

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

await FirebaseAuthentication.signInWithPlayGames();

signInWithTwitter

Startet den Twitter-Anmeldefluss.

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

await FirebaseAuthentication.signInWithTwitter();

signInWithYahoo

Der Yahoo-Anmeldefluss startet.

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

await FirebaseAuthentication.signInWithYahoo();

signOut

Der Abmeldefluss startet.

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

await FirebaseAuthentication.signOut();

unlink

Zur Zwischenablage kopieren

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

await FirebaseAuthentication.unlink({} as UnlinkOptions);

updateEmail

__CAPGO_KEEP_0__

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

await FirebaseAuthentication.updateEmail({} as UpdateEmailOptions);

updatePassword

Aktualisiert das Passwort des derzeit angemeldeten Benutzers.

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

await FirebaseAuthentication.updatePassword({} as UpdatePasswordOptions);

updateProfile

Aktualisiert die Profildaten eines Benutzers.

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

await FirebaseAuthentication.updateProfile({} as UpdateProfileOptions);

useAppLanguage

Setzt die Benutzerfacing-Sprache code als Standard-App-Sprache.

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

await FirebaseAuthentication.useAppLanguage();

useEmulator

Instrumentiert Ihre App, um mit dem Authentication-Emulator zu kommunizieren.

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

await FirebaseAuthentication.useEmulator({} as UseEmulatorOptions);

verifyBeforeUpdateEmail

Überprüft die neue E-Mail-Adresse, bevor die E-Mail-Adresse des aktuellen angemeldeten Benutzers aktualisiert wird.

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

await FirebaseAuthentication.verifyBeforeUpdateEmail({} as VerifyBeforeUpdateEmailOptions);

checkAppTrackingTransparencyPermission

Überprüft den aktuellen Status der App-Tracking-Transparenz.

Nur auf iOS verfügbar.

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

await FirebaseAuthentication.checkAppTrackingTransparencyPermission();

requestAppTrackingTransparencyPermission

Öffnet das Systemdialog, um die App-Tracking-Transparenz zu autorisieren.

Achtung: Der Benutzer kann die Anfrage zum Tracking in den Geräteeinstellungen deaktiviert haben, siehe Apple’s Dokumentation.

Nur auf iOS verfügbar.

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

await FirebaseAuthentication.requestAppTrackingTransparencyPermission();

Typenverweis

ApplyActionCodeOptions

export interface ApplyActionCodeOptions {
  /**
   * A verification code sent to the user.
   *
   * @since 0.2.2
   */
  oobCode: string;
}

ConfirmPasswordResetOptions

export interface ConfirmPasswordResetOptions {
  /**
   * A verification code sent to the user.
   *
   * @since 0.2.2
   */
  oobCode: string;
  /**
   * The new password.
   *
   * @since 0.2.2
   */
  newPassword: string;
}

ConfirmVerificationCodeOptions

export interface ConfirmVerificationCodeOptions {
  /**
   * The verification ID received from the `phoneCodeSent` listener.
   *
   * The `verificationCode` option must also be provided.
   *
   * @since 5.0.0
   */
  verificationId: string;
  /**
   * The verification code either received from the `phoneCodeSent` listener or entered by the user.
   *
   * The `verificationId` option must also be provided.
   *
   * @since 5.0.0
   */
  verificationCode: string;
}

SignInResult

export interface SignInResult {
  /**
   * The currently signed-in user, or null if there isn't any.
   *
   * @since 0.1.0
   */
  user: User | null;
  /**
   * Credentials returned by an auth provider.
   *
   * @since 0.1.0
   */
  credential: AuthCredential | null;
  /**
   * Additional user information from a federated identity provider.
   *
   * @since 0.5.1
   */
  additionalUserInfo: AdditionalUserInfo | null;
}

CreateUserWithEmailAndPasswordOptions

export interface CreateUserWithEmailAndPasswordOptions {
  /**
   * @since 0.2.2
   */
  email: string;
  /**
   * @since 0.2.2
   */
  password: string;
}

FetchSignInMethodsForEmailOptions

export interface FetchSignInMethodsForEmailOptions {
  /**
   * The user's email address.
   *
   * @since 6.0.0
   */
  email: string;
}

FetchSignInMethodsForEmailResult

export interface FetchSignInMethodsForEmailResult {
  /**
   * The sign-in methods for the specified email address.
   *
   * This list is empty when [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection)
   * is enabled, irrespective of the number of authentication methods available for the given email.
   *
   * @since 6.0.0
   */
  signInMethods: string[];
}

GetCurrentUserResult

export interface GetCurrentUserResult {
  /**
   * The currently signed-in user, or null if there isn't any.
   *
   * @since 0.1.0
   */
  user: User | null;
}

GetIdTokenOptions

export interface GetIdTokenOptions {
  /**
   * Force refresh regardless of token expiration.
   *
   * @since 0.1.0
   */
  forceRefresh: boolean;
}

GetIdTokenResult

export interface GetIdTokenResult {
  /**
   * The Firebase Auth ID token JWT string.
   *
   * @since 0.1.0
   */
  token: string;
}

GetIdTokenResultOptions

export interface GetIdTokenResultOptions {
  /**
   * Force refresh regardless of token expiration.
   *
   * @since 7.4.0
   */
  forceRefresh: boolean;
}

GetIdTokenResultResult

export interface GetIdTokenResultResult {
  /**
   * The authentication time in milliseconds since the epoch.
   *
   * This is the time the user authenticated (signed in) and not the time the token was refreshed.
   *
   * @since 7.4.0
   */
  authTime: number;
  /**
   * The ID token expiration time in milliseconds since the epoch.
   *
   * @since 7.4.0
   */
  expirationTime: number;
  /**
   * The ID token issuance time in milliseconds since the epoch.
   *
   * @since 7.4.0
   */
  issuedAtTime: number;
  /**
   * The sign-in provider through which the ID token was obtained.
   *
   * @since 7.4.0
   */
  signInProvider: string | null;
  /**
   * The type of second factor associated with this session, provided the user was multi-factor
   * authenticated (eg. phone, etc).
   *
   * @since 7.4.0
   */
  signInSecondFactor: string | null;
  /**
   * The entire payload claims of the ID token including the standard reserved claims as well as
   * the custom claims.
   *
   * @since 7.4.0
   */
  claims: Record<string, unknown>;
}

Quelle der Wahrheit

Diese Seite wurde aus dem Plugin generiert. src/definitions.ts. Wenn sich die öffentliche API im Hintergrund ändert, führen Sie die Synchronisation erneut durch.

Weitermachen von Getting Started

Wenn Sie Cloudflare verwenden Zum Starten um die Authentifizierung und die Kontoflows zu planen, verbinden Sie 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 in Zwei-Faktor-Authentifizierung, und SSO (Unternehmen) für die Implementierungsdetails in SSO (Unternehmen).