Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem AI-Tool hinzu, indem Sie die folgende Befehlszeile verwenden:

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

Verwenden Sie dann die folgende Anfrage:

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 die unten aufgeführten Plattform-spezifischen Anweisungen befolgen:

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

Importieren

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

API Übersicht

applyActionCode

Eine Bestätigung des code wird dem Benutzer per E-Mail gesendet.

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

await FirebaseAuthentication.applyActionCode({} as ApplyActionCodeOptions);

confirmPasswordReset

Das Passwort-Reset-Verfahren abschließen.

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

await FirebaseAuthentication.confirmPasswordReset({} as ConfirmPasswordResetOptions);

confirmVerificationCode

Das Telefonnummer-Verifizierungsverfahren abschließen.

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 Benutzer automatisch angemeldet.

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

await FirebaseAuthentication.createUserWithEmailAndPassword({} as CreateUserWithEmailAndPasswordOptions);

deleteUser

Löscht und meldet den Benutzer ab.

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

await FirebaseAuthentication.deleteUser();

fetchSignInMethodsForEmail

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

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

await FirebaseAuthentication.fetchSignInMethodsForEmail({} as FetchSignInMethodsForEmailOptions);

getCurrentUser

Abruft den derzeit angemeldeten Benutzer.

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

await FirebaseAuthentication.getCurrentUser();

getPendingAuthResult

Gibt die SignInResult wenn Ihre App einen Web-Anmeldevorgang gestartet hat und das Betriebssystem die App während des Hintergrunds löscht.

Erstellt 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 ab.

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

await FirebaseAuthentication.getIdToken();

getIdTokenResult

Gibt ein deserialisiertes JSON Web Token (JWT) zurück, das zum Identifizieren des Benutzers bei einem Firebase-Dienst verwendet wird.

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

await FirebaseAuthentication.getIdTokenResult();

getRedirectResult

Gibt die SignInResult aus dem redirect-basierten Anmeldefluss.

Wenn die Anmeldung fehlschlägt, fehlt mit einem Fehler. SignInResult Wenn keine Redirect-Operation aufgerufen wurde, gibt eine mit einem null-User zurück.

Nur für Web verfügbar.

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

await FirebaseAuthentication.getRedirectResult();

getTenantId

Ermitteln Sie die Mieter-ID.

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

await FirebaseAuthentication.getTenantId();

isSignInWithEmailLink

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

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

await FirebaseAuthentication.isSignInWithEmailLink({} as IsSignInWithEmailLinkOptions);

linkWithApple

Verbindet das Benutzerkonto mit dem Apple-Authentifizierungsanbieter.

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

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

await FirebaseAuthentication.linkWithApple();

linkWithEmailAndPassword

Verbindet das Benutzerkonto mit dem E-Mail-Authentifizierungsanbieter.

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

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

await FirebaseAuthentication.linkWithEmailAndPassword({} as LinkWithEmailAndPasswordOptions);

linkWithEmailLink

Verbindet das Benutzerkonto mit dem E-Mail-Authentifizierungsanbieter.

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

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

await FirebaseAuthentication.linkWithEmailLink({} as LinkWithEmailLinkOptions);

linkWithFacebook

Verbindet das Benutzerkonto mit dem Facebook-Authentifizierungsanbieter.

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

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

await FirebaseAuthentication.linkWithFacebook();

linkWithGameCenter

Verbindet das Benutzerkonto mit dem Game Center-Authentifizierungsanbieter.

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

Nur für iOS verfügbar.

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

await FirebaseAuthentication.linkWithGameCenter();

linkWithGithub

Verbindet das Benutzerkonto mit GitHub-Authentifizierungsanbieter.

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

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

await FirebaseAuthentication.linkWithGithub();

linkWithGoogle

Verbindet das Benutzerkonto mit Google-Authentifizierungsanbieter.

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

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

await FirebaseAuthentication.linkWithGoogle();

linkWithMicrosoft

Verbindet das Benutzerkonto mit dem Microsoft-Authentifizierungsanbieter.

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

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

await FirebaseAuthentication.linkWithMicrosoft();

linkWithOpenIdConnect

Verbindet das Benutzerkonto mit einem OpenID-Connect-Anbieter.

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

await FirebaseAuthentication.linkWithOpenIdConnect({} as LinkWithOpenIdConnectOptions);

linkWithPhoneNumber

Verbindet das Benutzerkonto mit dem Telefonnummer-Authentifizierungsanbieter.

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

Verwende das phoneVerificationCompleted Benachrichtigung zum Empfangen einer Benachrichtigung, wenn die Überprüfung abgeschlossen ist. Verwenden Sie das phoneVerificationFailed Benachrichtigung zum Empfangen einer Benachrichtigung, wenn die Überprüfung fehlschlägt. Verwenden Sie das phoneCodeSent Benachrichtigung zum Empfangen der Überprüfungs-ID.

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

await FirebaseAuthentication.linkWithPhoneNumber({} as LinkWithPhoneNumberOptions);

linkWithPlayGames

Verbindet das Benutzerkonto mit dem Authentifizierungsanbieter von Play Games.

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

Verfügbar nur für Android.

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

await FirebaseAuthentication.linkWithPlayGames();

linkWithTwitter

Verbindet das Benutzerkonto mit dem Authentifizierungsanbieter von Twitter.

Das Benutzerkonto muss auf der native Layer angemeldet sein. Der skipNativeAuth Diese Konfigurationsoption hat hier keinen Einfluss.

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

await FirebaseAuthentication.linkWithTwitter();

linkWithYahoo

Verbindet das Benutzerkonto mit dem Yahoo-Authentifizierungsanbieter.

Das Benutzerkonto muss auf der native Layer angemeldet sein. Der skipNativeAuth Diese Konfigurationsoption hat hier keinen Einfluss.

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

await FirebaseAuthentication.linkWithYahoo();

reload

Neuladet die Benutzerkontodaten, wenn angemeldet.

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

await FirebaseAuthentication.reload();

revokeAccessToken

Entzieht das angegebene Zugriffstoken. Aktuell nur Apple OAuth-Zugriffstoken unterstützt.

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 ein Passwort-Restore-E-Mail.

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

await FirebaseAuthentication.sendPasswordResetEmail({} as SendPasswordResetEmailOptions);

sendSignInLinkToEmail

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

Um den Anmeldevorgang mit dem E-Mail-Link abzuschließen, rufen Sie signInWithEmailLink mit der E-Mail-Adresse und dem E-Mail-Link auf, der dem Benutzer in der E-Mail gesendet wurde.

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

await FirebaseAuthentication.sendSignInLinkToEmail({} as SendSignInLinkToEmailOptions);

setLanguageCode

Setzt die Benutzerfremdsprache code für Auth-Betriebsvorgänge.

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 Mieter-ID.

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

await FirebaseAuthentication.setTenantId({} as SetTenantIdOptions);

signInAnonymously

Mithilfe einer anonymen Benutzerkonto anmeldet.

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

await FirebaseAuthentication.signInAnonymously();

signInWithApple

Startet den Apple-Anmeldungsfluss.

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

await FirebaseAuthentication.signInWithApple();

signInWithCustomToken

Startet den Custom Token-Anmeldungsfluss.

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

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

await FirebaseAuthentication.signInWithCustomToken({} as SignInWithCustomTokenOptions);

signInWithEmailAndPassword

Startet den Anmeldeprozess mit E-Mail und Passwort.

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

await FirebaseAuthentication.signInWithEmailAndPassword({} as SignInWithEmailAndPasswordOptions);

signInWithEmailLink

Mit E-Mail und Anmelde-Link anmeldet.

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

await FirebaseAuthentication.signInWithEmailLink({} as SignInWithEmailLinkOptions);

signInWithFacebook

Startet den Facebook-Anmeldeprozess.

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

await FirebaseAuthentication.signInWithFacebook();

signInWithGameCenter

Startet den Game Center-Anmeldeprozess.

Nur für iOS verfügbar.

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

await FirebaseAuthentication.signInWithGameCenter();

signInWithGithub

Startet den GitHub Anmeldeprozess.

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

await FirebaseAuthentication.signInWithGithub();

signInWithGoogle

Startet den Google-Anmeldeprozess.

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

await FirebaseAuthentication.signInWithGoogle();

signInWithMicrosoft

Startet den Microsoft-Anmeldeprozess.

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

await FirebaseAuthentication.signInWithMicrosoft();

signInWithOpenIdConnect

Startet den OpenID Connect-Anmeldeprozess.

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

await FirebaseAuthentication.signInWithOpenIdConnect({} as SignInWithOpenIdConnectOptions);

signInWithPhoneNumber

Startet den Anmeldeprozess mit einer Telefonnummer.

Verwenden Sie den phoneVerificationCompleted Zum Empfangen einer Benachrichtigung, wenn die Bestätigung abgeschlossen ist. phoneVerificationFailed Verwenden Sie den phoneCodeSent Zum Empfangen einer Benachrichtigung, wenn die Bestätigung fehlschlägt.

Verwenden Sie den

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

await FirebaseAuthentication.signInWithPhoneNumber({} as SignInWithPhoneNumberOptions);

signInWithPlayGames

Zurücksetzen

Abschnitt mit dem Titel “signInWithPlayGames”

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

Startet den Yahoo-Anmeldefluss.

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

await FirebaseAuthentication.signInWithYahoo();

signOut

Startet den Abmeldefluss.

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

await FirebaseAuthentication.signOut();

unlink

Entkoppelt einen Anbieter von einem Benutzerkonto.

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

await FirebaseAuthentication.unlink({} as UnlinkOptions);

updateEmail

Die E-Mail-Adresse des aktuellen angemeldeten Benutzers wird aktualisiert.

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

await FirebaseAuthentication.updateEmail({} as UpdateEmailOptions);

updatePassword

Die Passwörter des aktuellen angemeldeten Benutzers werden aktualisiert.

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

await FirebaseAuthentication.updatePassword({} as UpdatePasswordOptions);

updateProfile

Ein Benutzerprofil wird aktualisiert.

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

await FirebaseAuthentication.updateProfile({} as UpdateProfileOptions);

useAppLanguage

Sets the user-facing language code to be the default app language.

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

await FirebaseAuthentication.useAppLanguage();

useEmulator

Konfigurieren Sie Ihr App, um mit der Authentifizierungseмуlator 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.

Verfügbar nur auf iOS.

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

await FirebaseAuthentication.checkAppTrackingTransparencyPermission();

requestAppTrackingTransparencyPermission

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

Achtung: Der Benutzer hat möglicherweise die Trackinganfrage in den Geräteeinstellungen deaktiviert, siehe Apple-Dokumentation.

Verfügbar nur auf iOS.

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

await FirebaseAuthentication.requestAppTrackingTransparencyPermission();

Typenreferenz

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 von dem Plugin generiert. src/definitions.tsRe-run die Synchronisation, wenn die öffentliche API upstream geändert wird.

Weiter von Getting Started

Wenn Sie "Anfangen" verwenden Anfangen um die Authentifizierung und die Kontenflüsse 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 Ein-Ort-Authentifizierung (Unternehmen) zur Implementierungsdetail in Ein-Ort-Authentifizierung (Unternehmen).