Auth interface

Schnittstelle, die den Firebase Auth-Dienst darstellt.

Eine vollständige Anleitung zur Verwendung des Firebase Auth-Dienstes finden Sie unter Firebase Authentication.

Unterschrift:

export interface Auth

Attribute

Property Typ Beschreibung
app FirebaseApp Die FirebaseApp, die der Dienstinstanz Auth zugeordnet ist.
Konfiguration Konfiguration Die zum Initialisieren dieser Instanz verwendete Config.
currentUser Nutzer | null Der aktuell angemeldete Nutzer (oder null)
emulatorConfig EmulatorConfig | null Die aktuelle Emulatorkonfiguration (oder null).
languageCode String | null Der Sprachcode der Auth-Instanz.
name String Der Name der Anwendung, die mit der Dienstinstanz Auth verknüpft ist.
Einstellungen AuthSettings Einstellungen der Auth-Instanz
tenantId String | null Die Mandanten-ID der Auth-Instanz.

Methoden

Method Beschreibung
authStateReady() gibt ein Versprechen zurück, das sofort aufgelöst wird, wenn der anfängliche Authentifizierungsstatus abgeschlossen ist. Wenn das Promise aufgelöst wird, ist der aktuelle Nutzer möglicherweise ein gültiger Nutzer oder null, falls er sich abgemeldet hat.
beforeAuthStateChanged(callback, onAbort) Fügt einen blockierenden Callback hinzu, der ausgeführt wird, bevor durch eine Änderung des Authentifizierungsstatus ein neuer Nutzer festgelegt wird.
onAuthStateChanged(nextOrObserver, error, completed) Fügt einen Beobachter für Änderungen am Anmeldestatus des Nutzers hinzu.
onIdTokenChanged(nextOrObserver, error, completed) Fügt einen Beobachter für Änderungen am ID-Token des angemeldeten Nutzers hinzu.
setPersistence(persistence) Ändert die Art der Persistenz für die Instanz Auth.
signOut() Der aktuelle Nutzer wird abgemeldet. Das ID-Token des Nutzers wird dadurch nicht automatisch widerrufen.
updateCurrentUser(user) Legt den angegebenen Nutzer in der Auth-Instanz asynchron als Auth.currentUser fest.
useDeviceLanguage() Legt die aktuelle Sprache auf die Standardeinstellung für Gerät/Browser fest.

Auth.app

Die FirebaseApp, die der Dienstinstanz Auth zugeordnet ist.

Unterschrift:

readonly app: FirebaseApp;

Auth.config

Die zum Initialisieren dieser Instanz verwendete Config.

Unterschrift:

readonly config: Config;

Auth.currentUser

Der aktuell angemeldete Nutzer (oder null)

Unterschrift:

readonly currentUser: User | null;

Auth.emulatorConfig

Die aktuelle Emulatorkonfiguration (oder null).

Unterschrift:

readonly emulatorConfig: EmulatorConfig | null;

Auth.languageCode

Der Sprachcode der Auth-Instanz.

Dies ist eine lesbare/beschreibbare Eigenschaft. Wenn dieser Wert auf null gesetzt ist, wird die standardmäßige Firebase Console-Spracheinstellung angewendet. Der Sprachcode wird an E-Mail-Aktionsvorlagen (Passwortzurücksetzung, E-Mail-Bestätigung und Widerruf von E-Mail-Änderungen), SMS-Vorlagen für die Telefonauthentifizierung, reCAPTCHA-Verifizierer und OAuth-Pop-up-/Weiterleitungsvorgänge weitergegeben, sofern die angegebenen Anbieter die Lokalisierung mit dem angegebenen Sprachcode unterstützen.

Unterschrift:

languageCode: string | null;

Auth.name

Der Name der Anwendung, die mit der Dienstinstanz Auth verknüpft ist.

Unterschrift:

readonly name: string;

Auth.settings

Einstellungen der Auth-Instanz

Wird verwendet, um konfigurationsbezogene Optionen wie den App-Überprüfungsmodus für die Telefonauthentifizierung zu bearbeiten/zu lesen.

Unterschrift:

readonly settings: AuthSettings;

Auth.tenantId

Die Mandanten-ID der Auth-Instanz.

Dies ist eine lesbare/beschreibbare Eigenschaft. Wenn Sie die Mandanten-ID einer Auth-Instanz festlegen, wird bei allen zukünftigen Anmelde-/Registrierungsvorgängen diese Mandanten-ID übergeben und Nutzer im angegebenen Mandantenprojekt angemeldet bzw. angemeldet. Wenn dieser Wert auf null gesetzt ist, sind Nutzer im übergeordneten Projekt angemeldet.

Unterschrift:

tenantId: string | null;

Beispiel

// Set the tenant ID on Auth instance.
auth.tenantId = 'TENANT_PROJECT_ID';

// All future sign-in request now include tenant ID.
const result = await signInWithEmailAndPassword(auth, email, password);
// result.user.tenantId should be 'TENANT_PROJECT_ID'.

Auth.authStateReady()

gibt ein Versprechen zurück, das sofort aufgelöst wird, wenn der anfängliche Authentifizierungsstatus abgeschlossen ist. Wenn das Promise aufgelöst wird, ist der aktuelle Nutzer möglicherweise ein gültiger Nutzer oder null, falls er sich abgemeldet hat.

Unterschrift:

authStateReady(): Promise<void>;

Gibt zurück:

Promise<void>

Auth.beforeAuthStateChanged()

Fügt einen blockierenden Callback hinzu, der ausgeführt wird, bevor durch eine Änderung des Authentifizierungsstatus ein neuer Nutzer festgelegt wird.

Unterschrift:

beforeAuthStateChanged(callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;

Parameter

Parameter Typ Beschreibung
callback (user: User | null) => void | Promise<void> , der ausgelöst wird, bevor ein neuer Nutzerwert festgelegt wird. Wenn dies ausgelöst wird, kann der Nutzer nicht festgelegt werden.
onAbort () => void Callback wird ausgelöst, wenn später ein beforeAuthStateChanged()-Callback ausgelöst wird, sodass du mögliche Nebeneffekte rückgängig machen kannst.

Gibt zurück:

Abbestellen

Auth.onAuthStateChanged()

Fügt einen Beobachter für Änderungen am Anmeldestatus des Nutzers hinzu.

Informationen zum Beibehalten des alten Verhaltens finden Sie unter Auth.onIdTokenChanged().

Unterschrift:

onAuthStateChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

Parameter

Parameter Typ Beschreibung
nextOrObserver NextOrObserver<User | null> -Rückruf wird bei einer Änderung ausgelöst.
error ErrorFn Veraltet. Dieser Callback wird nie ausgelöst. Fehler beim An- und Abmelden können in Promise enthalten sein, die von Anmelde-/Abmeldefunktionen zurückgegeben werden.
abgeschlossen CompleteFn Veraltet. Dieser Callback wird nie ausgelöst.

Gibt zurück:

Abbestellen

Auth.onIdTokenChanged()

Fügt einen Beobachter für Änderungen am ID-Token des angemeldeten Nutzers hinzu.

Dazu gehören die Anmeldung und Abmeldung sowie die Aktualisierung von Tokens.

Unterschrift:

onIdTokenChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

Parameter

Parameter Typ Beschreibung
nextOrObserver NextOrObserver<User | null> -Rückruf wird bei einer Änderung ausgelöst.
error ErrorFn Veraltet. Dieser Callback wird nie ausgelöst. Fehler beim An- und Abmelden können in Promise enthalten sein, die von Anmelde-/Abmeldefunktionen zurückgegeben werden.
abgeschlossen CompleteFn Veraltet. Dieser Callback wird nie ausgelöst.

Gibt zurück:

Abbestellen

Auth.setPersistence()

Ändert die Art der Persistenz für die Instanz Auth.

Dies wirkt sich auf die aktuell gespeicherte Auth-Sitzung aus und wendet diese Art der Persistenz auf zukünftige Anmeldeanfragen an, einschließlich der Anmeldung über Weiterleitungsanfragen.

So kann ein angemeldeter Nutzer einfach angeben, ob seine Sitzung gespeichert werden soll oder nicht. Außerdem wird es einfacher, den Authentifizierungsstatus für Anwendungen, die von anderen Nutzern gemeinsam genutzt werden oder sensible Daten enthalten, nie dauerhaft beizubehalten.

Diese Methode funktioniert nicht in einer Node.js-Umgebung.

Unterschrift:

setPersistence(persistence: Persistence): Promise<void>;

Parameter

Parameter Typ Beschreibung
Persistenz Persistenz Die zu verwendende Persistenz.

Gibt zurück:

Promise<void>

Beispiel

auth.setPersistence(browserSessionPersistence);

Auth.signOut()

Der aktuelle Nutzer wird abgemeldet. Das ID-Token des Nutzers wird dadurch nicht automatisch widerrufen.

Diese Methode wird nicht von Auth-Instanzen unterstützt, die mit einer FirebaseServerApp erstellt wurden.

Unterschrift:

signOut(): Promise<void>;

Gibt zurück:

Promise<void>

Auth.updateCurrentUser()

Legt den angegebenen Nutzer in der Auth-Instanz asynchron als Auth.currentUser fest.

Es wird eine neue Instanzkopie des bereitgestellten Nutzers erstellt und als currentUser festgelegt.

Dadurch werden wie bei anderen Anmeldemethoden die Listener Auth.onAuthStateChanged() und Auth.onIdTokenChanged() ausgelöst.

Der Vorgang schlägt mit einem Fehler fehl, wenn der zu aktualisierende Nutzer zu einem anderen Firebase-Projekt gehört.

Unterschrift:

updateCurrentUser(user: User | null): Promise<void>;

Parameter

Parameter Typ Beschreibung
Nutzer Nutzer | null Der neue Nutzer.

Gibt zurück:

Promise<void>

Auth.useDeviceLanguage()

Legt die aktuelle Sprache auf die Standardeinstellung für Gerät/Browser fest.

Unterschrift:

useDeviceLanguage(): void;

Gibt zurück:

void