Getting Started

Installieren

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

Importieren

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

API Übersicht

applyActionCode

Eine von der E-Mail an den Benutzer gesendete Bestätigungs-code anwendet.

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

Abschließt den Telefonnummernverifizierungsprozess.

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

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

Holt die Anmeldemethoden für eine E-Mail-Adresse ab.

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

await FirebaseAuthentication.fetchSignInMethodsForEmail({} as FetchSignInMethodsForEmailOptions);

getCurrentUser

Liefert den derzeit angemeldeten Benutzer.

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

await FirebaseAuthentication.getCurrentUser();

getPendingAuthResult

Gibt den SignInResult wenn Ihre App eine Web-Anmeldeflow gestartet hat und das Betriebssystem die App während der Hintergrund-Aktivität gelöscht hat.

Nur für Android verfügbar.

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

await FirebaseAuthentication.getPendingAuthResult();

getIdToken

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

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 an einen Firebase-Dienst verwendet wird.

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

await FirebaseAuthentication.getIdTokenResult();

getRedirectResult

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

Wenn die Anmeldung fehlschlägt, schlägt sie mit einem Fehler fehl. Wenn keine Redirect-Operation aufgerufen wurde, gibt sie eine mit einem nullen Benutzer zurück. Nur für Web verfügbar. SignInResult Zur Zwischenablage kopieren

Abschnitt mit dem Titel “getTenantId”

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

await FirebaseAuthentication.getRedirectResult();

getTenantId

Abschnitt mit dem Titel “isSignInWithEmailLink”

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

await FirebaseAuthentication.getTenantId();

isSignInWithEmailLink

Überprüft, ob ein eingehendes 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 Layer angemeldet sein. Die skipNativeAuth Konfigurationsoption hat hier keinen Einfluss.

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

await FirebaseAuthentication.linkWithApple();

linkWithEmailAndPassword

Verbindet das Benutzerkonto mit E-Mail-Authentifizierungsanbieter.

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

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

await FirebaseAuthentication.linkWithEmailAndPassword({} as LinkWithEmailAndPasswordOptions);

linkWithEmailLink

Das Benutzerkonto wird mit dem E-Mail-Authentifizierungsanbieter verknüpft.

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.linkWithEmailLink({} as LinkWithEmailLinkOptions);

linkWithFacebook

Das Benutzerkonto wird mit dem Facebook-Authentifizierungsanbieter verknüpft.

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.linkWithFacebook();

linkWithGameCenter

Das Benutzerkonto wird mit dem Game Center-Authentifizierungsanbieter verknüpft.

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

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 Die Konfigurationsoption hat hier keinen Einfluss.

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

await FirebaseAuthentication.linkWithGoogle();

linkWithMicrosoft

Verknüpft das Benutzerkonto mit dem Microsoft-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.linkWithMicrosoft();

linkWithOpenIdConnect

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

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 Listener, um die Verifizierungs-ID zu erhalten.

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

await FirebaseAuthentication.linkWithPhoneNumber({} as LinkWithPhoneNumberOptions);

linkWithPlayGames

Verbindet 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

Verbindet das Benutzerkonto mit dem Twitter-Authentifizierungsanbieter.

Der Benutzer muss auf der native Layer angemeldet sein. Die skipNativeAuth __CAPGO_KEEP_0__

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

await FirebaseAuthentication.linkWithTwitter();

linkWithYahoo

Verbindet das Benutzerkonto mit dem Yahoo-Authentifizierungsanbieter.

Der Benutzer muss auf der native Layer angemeldet sein. Die skipNativeAuth __CAPGO_KEEP_0__

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

await FirebaseAuthentication.linkWithYahoo();

reload

Lädt Benutzerkonto-Daten neu, wenn angemeldet.

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

await FirebaseAuthentication.reload();

revokeAccessToken

Umworfen des angegebenen Zugriffstokens. 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-Rest-Email.

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

await FirebaseAuthentication.sendPasswordResetEmail({} as SendPasswordResetEmailOptions);

sendSignInLinkToEmail

Sendet eine Anmelde-Email-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

Legt die Benutzerfassungssprache code für Auth-Vorgänge fest.

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

await FirebaseAuthentication.setLanguageCode({} as SetLanguageCodeOptions);

setPersistence

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

Erstellt 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 Custom Token-Anmeldungsfluss.

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

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

await FirebaseAuthentication.signInWithCustomToken({} as SignInWithCustomTokenOptions);

signInWithEmailAndPassword

Durchführt den Anmeldevorgang mithilfe einer E-Mail-Adresse und eines Passworts.

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

await FirebaseAuthentication.signInWithEmailAndPassword({} as SignInWithEmailAndPasswordOptions);

signInWithEmailLink

Mithilfe einer E-Mail-Adresse und eines Anmelde-Linkes anmelden.

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

await FirebaseAuthentication.signInWithEmailLink({} as SignInWithEmailLinkOptions);

signInWithFacebook

Durchführt den Facebook-Anmeldevorgang.

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

Startet den Microsoft-Anmeldefluss.

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

await FirebaseAuthentication.signInWithMicrosoft();

signInWithOpenIdConnect

Der OpenID-Connect-Anmeldeprozess wird gestartet.

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

await FirebaseAuthentication.signInWithOpenIdConnect({} as SignInWithOpenIdConnectOptions);

signInWithPhoneNumber

Der Anmeldeprozess mit einer Telefonnummer wird gestartet.

Verwenden Sie das phoneVerificationCompleted Verwenden Sie das phoneVerificationFailed Verwenden Sie das phoneCodeSent Nur für Android und iOS verfügbar.

Auf die Zwischenablage kopieren

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

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

Ein Provider 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 aktualisiert.

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

await FirebaseAuthentication.updateEmail({} as UpdateEmailOptions);

updatePassword

Das Passwort des aktuellen angemeldeten Benutzers aktualisiert.

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

await FirebaseAuthentication.updatePassword({} as UpdatePasswordOptions);

updateProfile

Ein Benutzers Profildaten aktualisiert.

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

await FirebaseAuthentication.updateProfile({} as UpdateProfileOptions);

useAppLanguage

Setzt die vom Benutzer verwendete Sprache code als Standard-Sprache der App.

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

await FirebaseAuthentication.useAppLanguage();

useEmulator

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

Achtung: Der Benutzer hat möglicherweise die Trackinganfrage in den Geräte-Einstellungen deaktiviert, siehe Nur bei Apple verfügbar..

Zur Zwischenablage kopieren

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

await FirebaseAuthentication.requestAppTrackingTransparencyPermission();

Abschnitt mit dem Titel “Type Reference”

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 den Sync erneut durch.

Fortsetzen Sie mit Getting Started

Wenn Sie Getting Started zur Planung der Authentifizierung und der Kontoflows verwenden, 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 zur Implementierungsdetail in @capgo/capacitor-native-biometric, Zwei-Faktor-Authentifizierung zur Implementierungsdetail in Zwei-Faktor-Authentifizierung, und SSO (Unternehmen) zur Implementierungsdetail in SSO (Unternehmen).