auth namespace

Funktionen

Funktion Beschreibung
Benutzer(Benutzeroptionen) Verarbeitet Ereignisse im Zusammenhang mit Firebase Auth-Benutzerereignissen.
userRecordConstructor(wireData) Hilfsfunktion, die aus über die Leitung gesendeten Daten eine UserRecord Klasse erstellt.

Klassen

Klasse Beschreibung
HttpsError Ein expliziter Fehler, der von einem Handler ausgelöst werden kann, um einen Fehler an den Client zu senden, der die Funktion aufgerufen hat.
UserBuilder Builder zum Erstellen von Funktionen für Firebase Auth-Benutzerlebenszyklusereignisse.
UserRecordMetadata Hilfsklasse zum Erstellen der Benutzermetadaten in einem UserRecord Objekt.

Schnittstellen

Schnittstelle Beschreibung
Benutzeroptionen Optionen für die Authentifizierungsblockierungsfunktion.

Geben Sie Aliase ein

Geben Sie Alias ​​ein Beschreibung
Benutzerinformation UserInfo , die Teil des UserRecord ist.
Benutzerdatensatz Der an Cloud Functions übergebene UserRecord ist derselbe UserRecord , der vom Firebase Admin SDK zurückgegeben wird.

auth.user()

Verarbeitet Ereignisse im Zusammenhang mit Firebase Auth-Benutzerereignissen.

Unterschrift:

export declare function user(userOptions?: UserOptions): UserBuilder;

Parameter

Parameter Typ Beschreibung
Benutzeroptionen Benutzeroptionen Optionen auf Ressourcenebene

Kehrt zurück:

UserBuilder

UserBuilder – Builder zum Erstellen von Funktionen für Firebase Auth-Benutzerlebenszyklusereignisse

auth.userRecordConstructor()

Hilfsfunktion, die aus über die Leitung gesendeten Daten eine UserRecord Klasse erstellt.

Unterschrift:

export declare function userRecordConstructor(wireData: Record<string, unknown>): UserRecord;

Parameter

Parameter Typ Beschreibung
WireData Record<string, unbekannt> Daten, die über das Kabel gesendet werden

Kehrt zurück:

Benutzerdatensatz

eine Instanz von UserRecord mit korrekten toJSON-Funktionen

auth.UserInfo

UserInfo , die Teil des UserRecord ist .

Unterschrift:

export type UserInfo = auth.UserInfo;

auth.UserRecord

Der an Cloud Functions übergebene UserRecord ist derselbe UserRecord , der vom Firebase Admin SDK zurückgegeben wird.

Unterschrift:

export type UserRecord = auth.UserRecord;