Funkcje
Funkcja | Opis |
---|---|
user(userOptions), | Obsługuje zdarzenia związane ze zdarzeniami użytkowników uwierzytelniania Firebase. |
userRecordConstructor(wireData) | Funkcja pomocnicza, która tworzy klasę UserRecord na podstawie danych przesłanych przewodem. |
Zajęcia
Klasa | Opis |
---|---|
Błąd HTTP | Jawny błąd, który może zostać zgłoszony z modułu obsługi, aby wysłać błąd do klienta, który wywołał tę funkcję. |
UserBuilder | Kreator służący do tworzenia funkcji dla zdarzeń cyklu życia użytkownika Uwierzytelniania Firebase. |
UserRecordMetadata | Klasa pomocnicza do tworzenia metadanych użytkownika w obiekcie UserRecord . |
Interfejsy
Interfejs | Opis |
---|---|
UserOptions | Opcje funkcji blokowania uwierzytelniania. |
Aliasy typu
Wpisz alias | Opis |
---|---|
Informacje o użytkowniku | UserInfo , który jest częścią UserRecord . |
Rekord użytkownika | UserRecord przekazywany do Cloud Functions to ten sam UserRecord, który jest zwracany przez pakiet SDK Firebase Admin. |
auth.user()
Obsługuje zdarzenia związane ze zdarzeniami użytkowników uwierzytelniania Firebase.
Podpis:
export declare function user(userOptions?: UserOptions): UserBuilder;
Parametry
Parametr | Typ | Opis |
---|---|---|
Opcje użytkownika | UserOptions | Opcje na poziomie zasobu |
Zwroty:
UserBuilder – kreator służący do tworzenia funkcji dla zdarzeń cyklu życia użytkownika Uwierzytelniania Firebase
auth.userRecordConstructor()
Funkcja pomocnicza, która tworzy klasę UserRecord
na podstawie danych przesłanych przewodem.
Podpis:
export declare function userRecordConstructor(wireData: Record<string, unknown>): UserRecord;
Parametry
Parametr | Typ | Opis |
---|---|---|
dane przewodowe | Rekord<ciąg, nieznany> | dane wysyłane przez przewód |
Zwroty:
instancja UserRecord
z prawidłowymi funkcjami toJSON
auth.UserInfo
UserInfo
, który jest częścią UserRecord
.
Podpis:
export type UserInfo = auth.UserInfo;
auth.UserRecord
UserRecord
przekazywany do Cloud Functions to ten sam UserRecord, który jest zwracany przez pakiet SDK Firebase Admin.
Podpis:
export type UserRecord = auth.UserRecord;