Einstieg

Installieren

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

Importieren

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

API Übersicht

applyActionCode

Eine Bestätigung für den code übermittelt, der dem Nutzer per E-Mail gesendet wurde.

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

await FirebaseAuthentication.applyActionCode({} as ApplyActionCodeOptions);

confirmPasswordReset

Fertigt den Passwortschutzprozess ab.

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

await FirebaseAuthentication.confirmPasswordReset({} as ConfirmPasswordResetOptions);

confirmVerificationCode

Fertigt den Telefonnummernbestätigungsprozess ab.

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 zurück die SignInResult wenn Ihre App eine Web-Anmeldung startete und das Betriebssystem die App während der Hintergrund-Aktivität löscht.

Nur für Android verfügbar.

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

await FirebaseAuthentication.getPendingAuthResult();

getIdToken

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

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

await FirebaseAuthentication.getIdToken();

getIdTokenResult

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

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

await FirebaseAuthentication.getIdTokenResult();

getRedirectResult

Rückgibt das SignInResult aus dem redirect-basierten Anmeldeprozess.

Wenn die Anmeldung fehlschlägt, fehlschlägt sie mit einem Fehler. Wenn keine Redirect-Operation aufgerufen wurde, gibt sie ein SignInResult mit einem nullen Benutzer zurück.

Nur für Web verfügbar.

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

await FirebaseAuthentication.getRedirectResult();

getTenantId

Erhalte die Tenant-ID.

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

await FirebaseAuthentication.getTenantId();

isSignInWithEmailLink

Überprüft, ob ein eingehender Link ein Anmelden mit E-Mail-Link geeignet ist 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. Die skipNativeAuth 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 sich auf der native Ebene angemeldet haben. 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 sich auf der native Ebene angemeldet haben. skipNativeAuth Diese 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 native Ebene angemeldet haben. skipNativeAuth Diese Konfigurationsoption hat hier keinen Einfluss.

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

await FirebaseAuthentication.linkWithFacebook();

linkWithGameCenter

Verknüpft das Benutzerkonto mit dem Game Center-Authentifizierungsanbieter.

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

Nur für iOS verfügbar.

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

await FirebaseAuthentication.linkWithGameCenter();

linkWithGithub

Verknüpft 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 dem 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. Die skipNativeAuth 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

Verknüpft das Benutzerkonto mit dem Telefonnummer-Authentifizierungsanbieter.

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

Verwende den phoneVerificationCompleted Hörer, um benachrichtigt zu werden, wenn die Verifizierung abgeschlossen ist. phoneVerificationFailed Verwende den phoneCodeSent Hörer, um benachrichtigt zu werden, wenn die Verifizierung fehlgeschlagen ist.

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

await FirebaseAuthentication.linkWithPhoneNumber({} as LinkWithPhoneNumberOptions);

linkWithPlayGames

Zur Zwischenablage kopieren

Der Benutzer muss sich auf der native Ebene angemeldet haben. skipNativeAuth Die

Konfigurationsoption hat hier keinen Einfluss.

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

await FirebaseAuthentication.linkWithPlayGames();

linkWithTwitter

Abschnitt mit dem Titel “linkWithTwitter”

Verbindet das Benutzerkonto mit dem Twitter-Authentifizierungsanbieter. skipNativeAuth Der Benutzer muss sich auf der native Ebene angemeldet haben.

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

await FirebaseAuthentication.linkWithTwitter();

linkWithYahoo

In die Zwischenablage kopieren

Abschnitt mit dem Titel “linkWithYahoo” skipNativeAuth Konfigurationsoption hat hier keinen Einfluss.

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

await FirebaseAuthentication.linkWithYahoo();

reload

Laden Sie die Benutzerdaten neu, wenn Sie angemeldet sind.

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

await FirebaseAuthentication.reload();

revokeAccessToken

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

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

await FirebaseAuthentication.revokeAccessToken({} as RevokeAccessTokenOptions);

sendEmailVerification

Sendet eine Verifizierungs-E-Mail an den derzeit angemeldeten Benutzer.

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

await FirebaseAuthentication.sendEmailVerification();

sendPasswordResetEmail

Sendet ein Passwort-Restitutions-E-Mail.

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

await FirebaseAuthentication.sendPasswordResetEmail({} as SendPasswordResetEmailOptions);

sendSignInLinkToEmail

Sendet einem Benutzer mit der angegebenen E-Mail-Adresse einen Anmelde-Link.

Um sich mit der E-Mail-Link-Anmeldung abzuschließen, rufen Sie signInWithEmailLink mit der E-Mail-Adresse und dem im an den Benutzer gesendeten E-Mail-Link bereitgestellten Link auf.

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

await FirebaseAuthentication.sendSignInLinkToEmail({} as SendSignInLinkToEmailOptions);

setLanguageCode

Setzt die Benutzerfassungssprache code für Auth-Bereiche.

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

Startet den Apple-Anmeldungsfluss.

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

await FirebaseAuthentication.signInWithApple();

signInWithCustomToken

Startet den benutzerdefinierten Token-Anmeldeflow.

Diese Methode kann nicht in combination mit 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

Startet den Anmeldeflow mit E-Mail-Adresse und Passwort.

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

await FirebaseAuthentication.signInWithEmailAndPassword({} as SignInWithEmailAndPasswordOptions);

signInWithEmailLink

Meldet sich mit E-Mail-Adresse und Anmelde-Link an.

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

await FirebaseAuthentication.signInWithEmailLink({} as SignInWithEmailLinkOptions);

signInWithFacebook

Startet den Facebook-Anmeldefluss.

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

await FirebaseAuthentication.signInWithFacebook();

signInWithGameCenter

Startet den Game Center-Anmeldefluss.

Nur für iOS verfügbar.

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

await FirebaseAuthentication.signInWithGameCenter();

signInWithGithub

Startet den GitHub-Anmeldefluss.

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

await FirebaseAuthentication.signInWithGithub();

signInWithGoogle

Startet den Google-Anmeldefluss.

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

await FirebaseAuthentication.signInWithGoogle();

signInWithMicrosoft

Der Microsoft-Anmeldevorgang wird gestartet.

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

await FirebaseAuthentication.signInWithMicrosoft();

signInWithOpenIdConnect

Der OpenID Connect-Anmeldevorgang wird gestartet.

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

await FirebaseAuthentication.signInWithOpenIdConnect({} as SignInWithOpenIdConnectOptions);

signInWithPhoneNumber

Der Anmeldevorgang mit Telefonnummer wird gestartet.

Verwenden Sie den phoneVerificationCompleted Verwenden Sie den phoneVerificationFailed Verwenden Sie den phoneCodeSent Verwenden Sie den

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-Anmeldevorgang.

Nur für Android verfügbar.

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

await FirebaseAuthentication.signInWithPlayGames();

signInWithTwitter

Startet den Twitter-Anmeldevorgang.

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

await FirebaseAuthentication.signInWithTwitter();

signInWithYahoo

Startet den Yahoo-Anmeldevorgang.

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

await FirebaseAuthentication.signInWithYahoo();

signOut

Der Ausloggingsprozess wird gestartet.

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

await FirebaseAuthentication.signOut();

unlink

Ein Anbieter wird von einem Benutzerkonto entkoppelt.

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

Das Passwort des aktuellen angemeldeten Benutzers wird aktualisiert.

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 Benutzerfremdsprache code als Standardanwendungsprache.

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

await FirebaseAuthentication.useAppLanguage();

useEmulator

Instrumentiert Ihre App, um mit dem Authentifizierungsimulator 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 derzeit 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 Systemdialogfeld, um die App-Tracking-Transparenz zu autorisieren.

Achtung: Der Benutzer hat möglicherweise die Trackinganfrage in den Geräteeinstellungen deaktiviert, siehe Apple-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 wird aus dem Plugin generiert. src/definitions.tsRe-run the sync when the public API changes upstream.