Auth interface

Interfejs reprezentujący usługę Uwierzytelnianie Firebase.

Zapoznaj się z sekcją Uwierzytelnianie Firebase, aby dowiedzieć się, jak korzystać z usługi Uwierzytelnianie Firebase.

Podpis:

export interface Auth

Właściwości

Właściwość Typ Opis
aplikacja FirebaseApp FirebaseApp powiązana z instancją usługi Auth.
config Konfiguracja Konfiguracja użyta do zainicjowania tej instancji.
currentUser Użytkownik | brak Obecnie zalogowany użytkownik (lub wartość null).
emulatorConfig EmulatorConfig | wartość null Bieżąca konfiguracja emulatora (lub wartość null).
languageCode string | null Kod języka instancji Auth.
name string, Nazwa aplikacji powiązanej z instancją usługi Auth.
ustawienia AuthSettings Ustawienia instancji Auth.
tenantId string | null Identyfikator najemcy instancji Auth.

Metody

Metoda Opis
authStateReady() zwraca obietnicę, która znika natychmiast po ustawieniu początkowego stanu uwierzytelniania. Gdy obietnica się zakończy, bieżący użytkownik może być prawidłowym użytkownikiem lub null, jeśli użytkownik się wylogował.
beforeAuthStateChanged(callback, onAbort) Dodaje blokujące wywołanie zwrotne, które jest wykonywane, zanim zmiana stanu uwierzytelniania ustawi nowego użytkownika.
onAuthStateChanged(nextOrObserver, error, completed) Dodaje obserwatora zmian w stanie logowania użytkownika.
onIdTokenChanged(nextOrObserver, error, completed) Dodaje obserwatora zmian w tokenie identyfikatora zalogowanego użytkownika.
setPersistence(persistence) Zmienia typ trwałości w instancji Auth.
signOut() Wylogowuje bieżącego użytkownika. Nie spowoduje to automatycznego unieważnienia tokena identyfikatora użytkownika.
updateCurrentUser(user) Asynchronicznie ustawia wskazanego 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 instancją usługi Auth.

Podpis:

readonly app: FirebaseApp;

Auth.config

Konfiguracja użyta do zainicjowania tej instancji.

Podpis:

readonly config: Config;

Auth.currentUser

Obecnie zalogowany użytkownik (lub wartość null).

Podpis:

readonly currentUser: User | null;

Auth.emulatorConfig

Bieżąca konfiguracja emulatora (lub wartość null).

Podpis:

readonly emulatorConfig: EmulatorConfig | null;

Auth.languageCode

Kod języka instancji Auth.

Jest to właściwość możliwa do odczytu i zapisu. Jeśli zasada ma wartość null, stosowane jest domyślne ustawienie języka konsoli Firebase. Kod języka zostanie rozpowszechniony w szablonach działań e-mail (resetowanie hasła, weryfikacja adresu e-mail i unieważnienie zmiany adresu e-mail), szablony SMS-ów do uwierzytelniania telefonu, weryfikatora reCAPTCHA i operacje pop-up/przekierowania OAuth, pod warunkiem że wskazani dostawcy obsługują lokalizację przy użyciu podanego kodu języka.

Podpis:

languageCode: string | null;

Auth.name

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;

Auth.tenantId

Identyfikator najemcy instancji Auth.

Jest to właściwość możliwa do odczytu i zapisu. Gdy ustawisz identyfikator najemcy instancji Auth, wszystkie przyszłe operacje logowania/rejestracji będą przekazywać ten identyfikator i logują się lub rejestrują użytkowników w określonym projekcie najemcy. Jeśli zasada ma wartość null, użytkownicy są 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 znika natychmiast po ustawieniu początkowego stanu uwierzytelniania. Gdy obietnica się zakończy, bieżący użytkownik może być prawidłowym użytkownikiem lub null, jeśli użytkownik się wylogował.

Podpis:

authStateReady(): Promise<void>;

Zwroty:

Promise<void>

Auth.beforeAuthStateChanged()

Dodaje blokujące wywołanie zwrotne, które jest wykonywane, 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 (user: User | null) => void | Promise<void> wywołanie zwrotne zostało aktywowane przed ustawieniem nowej wartości użytkownika. Jeśli wystąpi ten błąd, nie można ustawić użytkownika.
onAbort () => nieważna wywołanie zwrotne jest uruchamiane, gdy nastąpi późniejsze wywołanie zwrotne beforeAuthStateChanged(), co umożliwia cofnięcie wszelkich efektów ubocznych.

Zwroty:

Anuluj subskrypcję

Auth.onAuthStateChanged()

Dodaje obserwatora zmian w stanie logowania użytkownika.

Aby zachować stare zachowanie, zapoznaj się z sekcją Auth.onIdTokenChanged().

Podpis:

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

Parametry

Parametr Typ Opis
nextOrObserver NextOrObserver<User | null> wywołanie zwrotne zostało aktywowane w przypadku zmiany.
error ErrorFn Rola wycofana. To wywołanie zwrotne nigdy nie jest wywoływane. Błędy związane z logowaniem/wylogowywaniem się kryją w obietnicach zwracanych przez funkcje logowania lub wylogowywania.
ukończono CompleteFn Rola wycofana. To wywołanie zwrotne nigdy nie jest wywoływane.

Zwroty:

Anuluj subskrypcję

Auth.onIdTokenChanged()

Dodaje obserwatora zmian w tokenie identyfikatora zalogowanego użytkownika.

Obejmuje to zdarzenia logowania, wylogowywania i odświeżania tokenów.

Podpis:

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

Parametry

Parametr Typ Opis
nextOrObserver NextOrObserver<User | null> wywołanie zwrotne zostało aktywowane w przypadku zmiany.
error ErrorFn Rola wycofana. To wywołanie zwrotne nigdy nie jest wywoływane. Błędy związane z logowaniem/wylogowywaniem się kryją w obietnicach zwracanych przez funkcje logowania lub wylogowywania.
ukończono CompleteFn Rola wycofana. To wywołanie zwrotne nigdy nie jest wywoływane.

Zwroty:

Anuluj subskrypcję

Auth.setPersistence()

Zmienia typ trwałości w instancji Auth.

Będzie to miało wpływ na obecnie zapisaną sesję uwierzytelniania i zastosuje ten typ trwałości w przypadku przyszłych żądań logowania, w tym dotyczących logowania za pomocą żądań przekierowania.

Dzięki temu użytkownik może łatwo określić, czy jego sesja ma zostać zapamiętana. Ułatwia też nieutrzymywanie 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ść Trwałość Wartość Persistence, której chcesz użyć.

Zwroty:

Promise<void>

Przykład

auth.setPersistence(browserSessionPersistence);

Auth.signOut()

Wylogowuje bieżącego użytkownika. Nie spowoduje to automatycznego unieważnienia tokena identyfikatora użytkownika.

Ta metoda nie jest obsługiwana w instancjach Auth utworzonych przy użyciu FirebaseServerApp.

Podpis:

signOut(): Promise<void>;

Zwroty:

Promise<void>

Auth.updateCurrentUser()

Asynchronicznie ustawia wskazanego użytkownika jako Auth.currentUser w instancji Auth.

Zostanie utworzona nowa kopia wystąpienia wybranego przez użytkownika i ustawiona jako obecnaUżytkownik.

Spowoduje to aktywowanie detektorów Auth.onAuthStateChanged() i Auth.onIdTokenChanged() podobnie jak inne metody logowania.

Operacja kończy się błędem, jeśli użytkownik należy do innego projektu Firebase.

Podpis:

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

Parametry

Parametr Typ Opis
użytkownik Użytkownik | brak Nowy Użytkownik.

Zwroty:

Promise<void>

Auth.useDeviceLanguage()

Ustawia bieżący język na domyślne ustawienie urządzenia/przeglądarki.

Podpis:

useDeviceLanguage(): void;

Zwroty:

void