Interfejs przedstawiający usługę uwierzytelniania Firebase.
Pełną instrukcję korzystania z usługi Uwierzytelnianie Firebase znajdziesz w artykule Uwierzytelnianie Firebase.
Podpis:
export interface Auth
Właściwości
| Właściwość | Typ | Opis |
|---|---|---|
| aplikacja | Aplikacja Firebase | FirebaseApp powiązana z wystąpieniem usługi Auth. |
| config | Konfiguracja | Wartość Config używana do zainicjowania tej instancji. |
| currentUser (aktualny użytkownik) | Użytkownik | wartość null | Aktualnie zalogowany użytkownik (lub wartość null). |
| emulatorConfig, | EmulatorConfig | wartość null | Bieżąca konfiguracja emulatora (lub wartość null). |
| languageCode, | ciąg znaków | wartość null | Kod języka instancji Auth. |
| name | ciąg znaków | Nazwa aplikacji powiązanej z instancją usługi Auth. |
| ustawienia | AuthSettings, | Ustawienia instancji Auth. |
| tenantId, | ciąg znaków | wartość null | Identyfikator najemcy instancji Auth. |
Metody
| Metoda | Opis |
|---|---|
| authStateReady() | zwraca obietnicę, która jest aktywowana natychmiast po ustaleniu początkowego stanu uwierzytelniania. Po zrealizowaniu obietnicy bieżący użytkownik może być prawidłowym użytkownikiem lub null, jeśli się wylogował. |
| beforeAuthStateChanged(wywołanie zwrotne, onAbort) | Dodaje blokujące wywołanie zwrotne, które jest uruchamiane, zanim zmiana stanu uwierzytelniania ustawi nowego użytkownika. |
| onAuthStateChanged(nextOrObserver, błąd, ukończono) | Dodaje obserwatora ds. zmian stanu logowania użytkownika. |
| onIdTokenChanged(nextOrObserver, błąd, ukończono) | Dodaje obserwatora na potrzeby zmian w tokenie tożsamości zalogowanego użytkownika. |
| setPersistence(trwałość) | Zmienia typ trwałości instancji Auth. |
| signOut() | Wylogowuje bieżącego użytkownika. Nie unieważnia to automatycznie tokena identyfikatora użytkownika. |
| updateCurrentUser(użytkownik) | Asynchronicznie ustawia podanego użytkownika jako Auth.currentUser w instancji Auth. |
| useDeviceLanguage() | Ustawia bieżący język na domyślne ustawienie urządzenia/przeglądarki. |
Auth.app
FirebaseApp powiązana z wystąpieniem usługi Auth.
Podpis:
readonly app: FirebaseApp;
Auth.config
Wartość Config używana do zainicjowania tej instancji.
Podpis:
readonly config: Config;
Auth.currentUser
Aktualnie zalogowany użytkownik (lub wartość null).
Podpis:
readonly currentUser: User | null;
Konfiguracja Auth.emulatorConfig
Bieżąca konfiguracja emulatora (lub wartość null).
Podpis:
readonly emulatorConfig: EmulatorConfig | null;
Kod języka Auth.languageCode
Kod języka instancji Auth.
Ta właściwość jest dostępna do odczytu i zapisu. Gdy ustawisz wartość null, stosowane będzie domyślne ustawienie języka konsoli Firebase. Kod języka zostanie zastosowany do szablonów działań e-mail (resetowanie hasła, weryfikacja adresu e-mail i unieważnienie zmiany adresu e-mail), szablony SMS do uwierzytelniania przez telefon, weryfikator reCAPTCHA i operacje przekierowania protokołu OAuth, o ile wskazani dostawcy obsługują lokalizację na podstawie określonego kodu języka.
Podpis:
languageCode: string | null;
Nazwa.uwierzytelniania
Nazwa aplikacji powiązanej z instancją usługi Auth.
Podpis:
readonly name: string;
Auth.settings
Ustawienia instancji Auth.
Służy do edytowania i odczytywania opcji związanych z konfiguracją, takich jak tryb weryfikacji aplikacji na potrzeby uwierzytelniania przez telefon.
Podpis:
readonly settings: AuthSettings;
Identyfikator uwierzytelniania najemcy
Identyfikator najemcy instancji Auth.
Ta właściwość jest dostępna do odczytu i zapisu. Gdy ustawisz identyfikator najemcy instancji Auth, wszystkie przyszłe operacje logowania/rejestracji będą przekazywać ten identyfikator najemcy i logować lub rejestrować użytkowników w określonym projekcie najemcy. Jeśli ustawisz wartość null, użytkownicy będą zalogowani w projekcie nadrzędnym.
Podpis:
tenantId: string | null;
Przykład
// 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()
zwraca obietnicę, która jest aktywowana natychmiast po ustaleniu początkowego stanu uwierzytelniania. Po zrealizowaniu obietnicy bieżący użytkownik może być prawidłowym użytkownikiem lub null, jeśli się wylogował.
Podpis:
authStateReady(): Promise<void>;
Zwroty:
Obietnica<void>
Auth.beforeAuthStateChanged()
Dodaje blokujące wywołanie zwrotne, które jest uruchamiane, zanim zmiana stanu uwierzytelniania ustawi nowego użytkownika.
Podpis:
beforeAuthStateChanged(callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| wywołanie zwrotne | (użytkownik: Użytkownik | wartość null) => nieważna | Obietnica<void> | wywołanie zwrotne jest aktywowane przed ustawieniem wartości nowego użytkownika. Jeśli to nastąpi, uniemożliwi to ustawienie użytkownika. |
| onAbort | () => nieważne | wywołanie zwrotne beforeAuthStateChanged(), które zostanie zgłoszone później, co pozwala cofnąć efekty uboczne. |
Zwroty:
Auth.onAuthStateChanged()
Dodaje obserwatora ds. zmian stanu logowania użytkownika.
Aby zachować poprzedni sposób działania, zobacz Auth.onIdTokenChanged().
Podpis:
onAuthStateChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| nextOrObserver | NextOrObserver<Użytkownik | null> | wywołanie zwrotne jest aktywowane po zmianie. |
| błąd | ErrorFn | Rola wycofana. To wywołanie zwrotne nigdy nie jest wywoływane. Błędy związane z logowaniem i wylogowywaniem mogą być wyłapane w obietnice zwracane przez funkcje logowania/wylogowywania. |
| gotowa | CompleteFn | Rola wycofana. To wywołanie zwrotne nigdy nie jest wywoływane. |
Zwroty:
Auth.onIdTokenChanged()
Dodaje obserwatora na potrzeby zmian w tokenie tożsamości zalogowanego użytkownika.
Obejmuje to zdarzenia związane z logowaniem i wylogowywaniem się oraz odświeżanie tokenów.
Podpis:
onIdTokenChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| nextOrObserver | NextOrObserver<Użytkownik | null> | wywołanie zwrotne jest aktywowane po zmianie. |
| błąd | ErrorFn | Rola wycofana. To wywołanie zwrotne nigdy nie jest wywoływane. Błędy związane z logowaniem i wylogowywaniem mogą być wyłapane w obietnice zwracane przez funkcje logowania/wylogowywania. |
| gotowa | CompleteFn | Rola wycofana. To wywołanie zwrotne nigdy nie jest wywoływane. |
Zwroty:
Auth.setPersistence(),
Zmienia typ trwałości instancji Auth.
Będzie to miało wpływ na obecnie zapisaną sesję uwierzytelniania i będzie stosować ten typ trwałości w przypadku przyszłych żądań logowania, w tym logowania z żądaniami przekierowania.
Dzięki temu użytkownik może łatwo określić, czy jego sesja ma zostać zapamiętana. Ułatwia to też utrzymanie stanu uwierzytelniania w przypadku aplikacji, które są udostępniane przez innych użytkowników lub zawierają dane wrażliwe.
Ta metoda nie działa w środowisku Node.js.
Podpis:
setPersistence(persistence: Persistence): Promise<void>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| trwałość | Wytrwałość | Trwałość do użycia. |
Zwroty:
Obietnica<void>
Przykład
auth.setPersistence(browserSessionPersistence);
Auth.signOut()
Wylogowuje bieżącego użytkownika. Nie unieważnia to automatycznie tokena identyfikatora użytkownika.
Ta metoda nie jest obsługiwana w instancjach Auth utworzonych za pomocą FirebaseServerApp.
Podpis:
signOut(): Promise<void>;
Zwroty:
Obietnica<void>
Auth.updateCurrentUser()
Asynchronicznie ustawia podanego użytkownika jako Auth.currentUser w instancji Auth.
Zostanie utworzona nowa kopia instancji podanej przez użytkownika i ustawiona jako bieżący użytkownik.
Spowoduje to aktywowanie detektorów Auth.onAuthStateChanged() i Auth.onIdTokenChanged(), tak jak inne metody logowania.
Operacja zakończy się niepowodzeniem i wyświetli się błąd, jeśli użytkownik, którego konto ma zostać zaktualizowany, należy do innego projektu Firebase.
Podpis:
updateCurrentUser(user: User | null): Promise<void>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| użytkownik | Użytkownik | wartość null | Nowy Użytkownik. |
Zwroty:
Obietnica<void>
Auth.useDeviceLanguage()
Ustawia bieżący język na domyślne ustawienie urządzenia/przeglądarki.
Podpis:
useDeviceLanguage(): void;
Zwroty:
nieważne