auth package

Uwierzytelnianie Firebase

Funkcje

Funkcja	Opis
funkcja(aplikacja, ...)
getAuth(app)	Zwraca instancję uwierzytelniania powiązaną z podaną FirebaseApp. Jeśli nie istnieje instancja, inicjuje instancję uwierzytelniania z domyślnymi zależnościami specyficznymi dla danej platformy.
initializeAuth(app, deps)	Inicjuje instancję Auth ze szczegółową kontrolą nad zależnościami.
funkcja(pamięć masowa, ...)
getReactNativePersistence(storage)	Zwraca obiekt trwałości, który pakuje obiekt AsyncStorage zaimportowany z react-native lub @react-native-community/async-storage i można go użyć w polu zależności trwałości w funkcji initializeAuth().
function(auth, ...)
applyActionCode(auth, oobCode)	Stosuje kod weryfikacyjny wysłany do użytkownika e-mailem lub za pomocą innego zewnętrznego mechanizmu.
beforeAuthStateChanged(auth, callback, onAbort)	Dodaje blokujące wywołanie zwrotne, które jest wykonywane, zanim zmiana stanu uwierzytelniania ustawi nowego użytkownika.
checkActionCode(auth, oobCode)	Sprawdza kod weryfikacyjny wysłany do użytkownika e-mailem lub przy użyciu innego zewnętrznego mechanizmu.
confirmPasswordReset(auth, oobCode, newPassword)	Kończy proces resetowania hasła, po otrzymaniu kodu potwierdzenia i nowego hasła.
connectAuthEmulator(auth, url, options)	Zmienia instancję Auth w taki sposób, aby komunikowała się z emulatorem uwierzytelniania Firebase, a nie z produkcyjnymi usługami uwierzytelniania Firebase.
createUserWithEmailAndPassword(auth, email, password)	Tworzy nowe konto użytkownika powiązane z określonym adresem e-mail i hasłem.
fetchSignInMethodsForEmail(auth, email)	Pobiera listę możliwych metod logowania się dla podanego adresu e-mail. Ta metoda zwraca pustą listę, gdy włączona jest [ochrona przed wyliczaniem adresów e-mail](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection), niezależnie od liczby metod uwierzytelniania dostępnych dla danego adresu e-mail.
getMultiFactorResolver(auth, error)	Udostępnia MultiFactorResolver, które jest odpowiednie do przeprowadzania przepływu pracy wielopoziomowej.
getRedirectResult(auth, resolver)	Zwraca wartość UserCredential z procesu logowania opartego na przekierowaniach.
initializeRecaptchaConfig(auth)	Wczytuje konfigurację reCAPTCHA do instancji Auth.
isSignInWithEmailLink(auth, emailLink)	Sprawdza, czy link przychodzący to link do logowania się przy użyciu e-maila odpowiedniego dla funkcji signInWithEmailLink().
onAuthStateChanged(auth, nextOrObserver, error, completed)	Dodaje obserwatora zmian w stanie logowania użytkownika.
onIdTokenChanged(auth, nextOrObserver, error, completed)	Dodaje obserwatora zmian w tokenie identyfikatora zalogowanego użytkownika.
revokeAccessToken(auth, token)	Unieważnia podany token dostępu. Obecnie obsługuje tylko tokeny dostępu Apple OAuth.
sendPasswordResetEmail(auth, email, actionCodeSettings)	Wysyła na podany adres e-mail wiadomość e-mail dotyczącą resetowania hasła. Ta metoda nie powoduje błędu, gdy nie ma konta użytkownika z podanym adresem e-mail i jest włączona [ochrona przed wyliczeniami e-maili](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection).
sendSignInLinkToEmail(auth, email, actionCodeSettings)	Wysyła użytkownikowi o podanym adresie e-mail link umożliwiający zalogowanie się.
setPersistence(auth, persistence)	Zmienia typ trwałości instancji Auth dla obecnie zapisanej sesji Auth i stosuje ten typ trwałości do przyszłych żądań logowania, w tym logowania za pomocą żądań przekierowania.
signInAnonymously(auth)	Asynchronicznie loguje się jako anonimowy użytkownik.
signInWithCredential(auth, credential)	Loguje się asynchronicznie przy użyciu danych logowania.
signInWithCustomToken(auth, customToken)	Loguje się asynchronicznie przy użyciu tokena niestandardowego.
signInWithEmailAndPassword(auth, email, password)	Loguje się asynchronicznie przy użyciu adresu e-mail i hasła.
signInWithEmailLink(auth, email, emailLink)	Loguje się asynchronicznie za pomocą adresu e-mail oraz linku umożliwiającego zalogowanie się.
signInWithPhoneNumber(auth, phoneNumber, appVerifier)	Logowanie asynchroniczne przy użyciu numeru telefonu.
signInWithPopup(auth, provider, resolver)	Uwierzytelnianie klienta Firebase przy użyciu procesu uwierzytelniania OAuth w wyskakującym okienku.
signInWithRedirect(auth, provider, resolver)	Uwierzytelnianie klienta Firebase za pomocą przekierowania obejmującego całą stronę.
signOut(auth)	Wylogowuje bieżącego użytkownika.
updateCurrentUser(auth, user)	Asynchronicznie ustawia wskazanego użytkownika jako Auth.currentUser w instancji Auth.
useDeviceLanguage(auth)	Ustawia bieżący język na domyślne ustawienie urządzenia/przeglądarki.
validatePassword(auth, password)	Weryfikuje hasło pod kątem zgodności z zasadami dotyczącymi haseł skonfigurowanymi dla projektu lub najemcy.
verifyPasswordResetCode(auth, code)	Sprawdza kod resetowania hasła wysłany do użytkownika e-mailem lub przy użyciu innego zewnętrznego mechanizmu.
funkcja(link, ...)
parseActionCodeURL(link)	Analizuje ciąg znaków linku działania e-mail i zwraca wartość ActionCodeURL, jeśli link jest prawidłowy. W przeciwnym razie zwraca wartość null.
funkcja(użytkownik, ...)
deleteUser(user)	usuwa użytkownika i wylogowuje go;
getIdToken(user, forceRefresh)	Zwraca token sieciowy JSON (JWT) służący do identyfikacji użytkownika w usłudze Firebase.
getIdTokenResult(user, forceRefresh)	Zwraca zdeserializowany token sieciowy JSON (JWT) służący do identyfikacji użytkownika w usłudze Firebase.
linkWithCredential(user, credential)	Łączy konto użytkownika z podanymi danymi logowania.
linkWithPhoneNumber(user, phoneNumber, appVerifier)	Łączy konto użytkownika z podanym numerem telefonu.
linkWithPopup(user, provider, resolver)	Łączy uwierzytelnionego dostawcę z kontem użytkownika za pomocą procesu OAuth opartego na wyskakującym okienku.
linkWithRedirect(user, provider, resolver)	Łączy metodę OAuthProvider z kontem użytkownika, korzystając z przekierowania całej strony.
multiFactor(user)	Wartość MultiFactorUser odpowiadająca użytkownikowi.
reauthenticateWithCredential(user, credential)	Ponownie uwierzytelnia użytkownika przy użyciu nowych danych logowania.
reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier)	Ponownie uwierzytelnia użytkownika przy użyciu nowych danych logowania do telefonu.
reauthenticateWithPopup(user, provider, resolver)	Ponownie uwierzytelnia bieżącego użytkownika przy użyciu określonego dostawcy OAuthProvider, korzystając z procesu OAuth opartego na wyskakującym okienku.
reauthenticateWithRedirect(user, provider, resolver)	Ponownie uwierzytelnia bieżącego użytkownika przy użyciu określonego dostawcy OAuthProvider, korzystając z przekierowania całej strony.
reload(użytkownik)	Ponownie wczytuje dane konta użytkownika, jeśli jest zalogowany.
sendEmailVerification(user, actionCodeSettings)	Wysyła do użytkownika e-maila weryfikacyjnego.
unlink(użytkownik; identyfikator dostawcy)	Odłącza dostawcę od konta użytkownika.
updateEmail(user, newEmail)	Aktualizuje adres e-mail użytkownika.
updatePassword(user, newPassword)	Aktualizuje hasło użytkownika.
updatePhoneNumber(user, credential)	Aktualizuje numer telefonu użytkownika.
updateProfile(user, { displayName, photoURL: photoUrl })	Aktualizuje dane profilowe użytkownika.
verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings)	Wysyła e-maila weryfikacyjnego na nowy adres e-mail.
funkcja(dane logowania użytkownika, ...)
getAdditionalUserInfo(userCredential)	Wyodrębnia element AdditionalUserInfo specyficzny dla dostawcy dla danych logowania.

Zajęcia

Klasa	Opis
ActionCodeURL	Klasa narzędzia służąca do analizowania adresów URL działań związanych z pocztą e-mail, takich jak resetowanie hasła, weryfikacja adresu e-mail, logowanie za pomocą linku w e-mailu itp.
AuthCredential	Interfejs reprezentujący dane logowania zwracane przez metodę AuthProvider.
EmailAuthCredential	Interfejs reprezentujący dane logowania zwracane przez EmailAuthProvider dla pola ProviderId.
EmailAuthProvider	Dostawca do generowania dokumentu EmailAuthCredential.
FacebookAuthProvider	Dostawca do generowania danych OAuthCredential dla pola ProviderId.FACEBOOK.
GithubAuthProvider	Dostawca do generowania wartości OAuthCredential dla parametru ProviderId.GITHUB.
GoogleAuthProvider	Dostawca do generowania wartości OAuthCredential dla pola ProviderId.GOOGLE.
OAuthCredential	Reprezentuje dane logowania OAuth zwrócone przez metodę OAuthProvider.
OAuthProvider	Dostawca do generowania ogólnych danych uwierzytelniających OAuthCredential.
PhoneAuthCredential	Reprezentuje dane logowania zwrócone przez PhoneAuthProvider.
PhoneAuthProvider	Dostawca usług generowania wartości PhoneAuthCredential.
PhoneMultiFactorGenerator	Dostawca do wygenerowania PhoneMultiFactorAssertion.
RecaptchaVerifier	Weryfikator aplikacji oparty na reCAPTCHA.
SAMLAuthProvider	AuthProvider (uwierzytelniania SAML).
TotpMultiFactorGenerator	Dostawca do generowania wartości TotpMultiFactorAssertion.
TotpSecret	Dostawca do generowania wartości TotpMultiFactorAssertion.Przechowuje udostępniony klucz obiektu tajnego i inne parametry na potrzeby generowania haseł jednorazowych opartych na czasie. Stosuje metody pobierania udostępnionego klucza tajnego i generowania adresu URL z kodem QR.
TwitterAuthProvider	Dostawca do wygenerowania OAuthCredential dla identyfikatora ProviderId.TWITTER.

Interfejsy

Interfejs	Opis
ActionCodeInfo	Odpowiedź z checkActionCode().
ActionCodeSettings	Interfejs określający wymagany adres URL kontynuowania/stanu z opcjonalnymi identyfikatorami pakietów na Androida i iOS.
AdditionalUserInfo	Struktura zawierająca dodatkowe informacje o użytkowniku od dostawcy tożsamości sfederowanej.
ApplicationVerifier	Narzędzie do weryfikacji domeny i zapobiegania nadużyciom.
Uwierzytelnianie	Interfejs reprezentujący usługę Uwierzytelnianie Firebase.
AuthError	Interfejs błędu Auth.
AuthErrorMap	Mapowanie kodów błędów na komunikaty o błędach.
AuthProvider	Interfejs reprezentujący dostawcę uwierzytelniania używany do tworzenia danych AuthCredential.
AuthSettings	Interfejs przedstawiający ustawienia instancji Auth.
Konfiguracja	Interfejs reprezentujący konfigurację Auth.
ConfirmationResult	Wynik logowania na numer telefonu, połączenia lub ponownego uwierzytelnienia połączenia.
Zależności	Zależności, które mogą zostać użyte do zainicjowania instancji Auth.
EmulatorConfig	Konfiguracja emulatora uwierzytelniania Firebase.
IdTokenResult	Interfejs przedstawiający wynik tokena identyfikatora uzyskany z funkcji User.getIdTokenResult().
MultiFactorAssertion	Klasa bazowa do potwierdzania własności drugiego składnika.
MultiFactorError	Błąd zgłaszany, gdy użytkownik musi podać drugi składnik, aby móc się zalogować.
MultiFactorInfo	Struktura zawierająca informacje o elemencie 2-poziomowego.
MultiFactorResolver	Klasa używana do odzyskiwania po MultiFactorError, gdy użytkownik musi podać drugi składnik, aby się zalogować.
MultiFactorSession	Interfejs określający obiekt sesji wielopoziomowej używany do rejestrowania drugiego składnika na koncie użytkownika lub ułatwiania logowania zarejestrowanego użytkownika przy użyciu drugiego składnika.
MultiFactorUser	Interfejs definiujący powiązane wielopoziomowe właściwości i operacje związane z użytkownikiem.
OAuthCredentialOptions	Określa opcje inicjowania pola OAuthCredential.
ParsedToken	Interfejs reprezentujący analizowany token identyfikatora.
PasswordPolicy	Struktura określająca wymagania dotyczące zasad dotyczących haseł.
PasswordValidationStatus	Struktura wskazująca, które wymagania zasad dotyczących haseł zostały spełnione lub naruszone oraz jakie są wymagania.
Trwałość	Interfejs przedstawiający możliwe typy mechanizmów trwałych.
PhoneMultiFactorAssertion	Klasa do potwierdzania własności telefonu na drugim etapie. Udostępnione przez PhoneMultiFactorGenerator.assertion().
PhoneMultiFactorEnrollInfoOptions	Opcje używane do rejestrowania drugiego składnika.
PhoneMultiFactorInfo	Podklasa interfejsu MultiFactorInfo dla drugich składników numeru telefonu. factorId tego drugiego składnika to FactorId.PHONE.
PhoneMultiFactorSignInInfoOptions	Opcje używane do logowania się przy użyciu drugiego składnika.
PhoneSingleFactorInfoOptions	Opcje używane do logowania jednokrotnego.
PopupRedirectResolver	resolver używany do obsługi operacji związanych z DOM, np. signInWithPopup() lub signInWithRedirect().
ReactNativeAsyncStorage	Interfejs dołączonego AsyncStorage.
RecaptchaParameters	Interfejs reprezentujący parametry reCAPTCHA.Lista akceptowanych parametrów znajdziesz w [dokumentach reCAPTCHA](https://developers.google.com/recaptcha/docs/display#render_param). Akceptowane są wszystkie parametry oprócz sitekey: Uwierzytelnianie Firebase udostępnia reCAPTCHA dla każdego projektu i konfiguruje klucz witryny podczas renderowania.W przypadku niewidocznej usługi reCAPTCHA ustaw klucz size na invisible.
TotpMultiFactorAssertion	Klasa do potwierdzania własności drugiego składnika TOTP. Udostępnione przez TotpMultiFactorGenerator.assertionForEnrollment() i TotpMultiFactorGenerator.assertionForSignIn().
TotpMultiFactorInfo	Podklasa interfejsu MultiFactorInfo dla drugich czynników TOTP. factorId tego drugiego składnika to FactorId.TOTP.
Użytkownik	Konto użytkownika.
UserCredential	Struktura zawierająca User, OperationType i identyfikator dostawcy.
UserInfo	Informacje profilowe użytkownika są widoczne tylko dla aplikacji projektu Firebase.
UserMetadata	Interfejs reprezentujący metadane użytkownika.

Zmienne

Zmienna	Opis
ActionCodeOperation	Lista możliwych typów działań dotyczących e-maili.
AuthErrorCodes	Mapa potencjalnych kodów błędów (Auth), która ułatwia porównywanie błędów zgłaszanych przez pakiet SDK.
browserLocalPersistence	Implementacja trwałości typu LOCAL wykorzystująca jako bazową pamięć masową localStorage.
browserPopupRedirectResolver	Implementacja PopupRedirectResolver w przypadku aplikacji działających w przeglądarce.
browserSessionPersistence	Implementacja trwałości elementu SESSION z wykorzystaniem sessionStorage jako bazowego miejsca na dane.
cordovaPopupRedirectResolver	Implementacja PopupRedirectResolver w przypadku aplikacji opartych na aplikacji Cordova.
debugErrorMap	Szczegółowa mapa błędów ze szczegółowymi opisami większości kodów błędów.Zobacz dyskusję na stronie AuthErrorMap
FactorId	Wyliczenie czynników, które mogą być używane do uwierzytelniania wielopoziomowego.
indexedDBLocalPersistence	Implementacja trwałości typu LOCAL wykorzystująca jako bazową pamięć masową indexedDB.
inMemoryPersistence	Implementacja trwałości typu „BRAK”.
OperationType	Wyliczenie obsługiwanych typów operacji.
prodErrorMap	Minimalna mapa błędów ze wszystkimi szczegółowymi komunikatami o błędach.Zobacz dyskusję na stronie AuthErrorMap.
ProviderId	Wyliczenie obsługiwanych dostawców.
SignInMethod	Wyliczenie obsługiwanych metod logowania.

Typ aliasów

Typ aliasu	Opis
CustomParameters	Mapa niestandardowych parametrów OAuth.
NextOrObserver	Wpisz definicję wywołania zwrotnego zdarzenia.
PhoneInfoOptions	Informacje wymagane do zweryfikowania własności numeru telefonu.
UserProfile	Profil użytkownika używany w AdditionalUserInfo.

funkcja(aplikacja, ...)

getAuth(app)

Zwraca instancję uwierzytelniania powiązaną z podaną FirebaseApp. Jeśli nie istnieje instancja, inicjuje instancję uwierzytelniania z domyślnymi zależnościami specyficznymi dla danej platformy.

Podpis:

export declare function getAuth(app?: FirebaseApp): Auth;

Parametry

Parametr	Typ	Opis
aplikacja	FirebaseApp	Aplikacja Firebase.

Zwroty:

Uwierzytelnianie

initializeAuth(app, deps)

Inicjuje instancję Auth ze szczegółową kontrolą nad zależnościami.

Ta funkcja zapewnia większą kontrolę nad instancją Auth niż getAuth(). getAuth używa domyślnych ustawień platformy, aby dostarczać zależności. Ogólnie rzecz biorąc, getAuth to najprostszy sposób na inicjowanie uwierzytelniania i sprawdza się w większości przypadków. Użyj narzędzia initializeAuth, jeśli chcesz kontrolować, która warstwa trwałości jest używana, lub aby zminimalizować rozmiar pakietu, jeśli nie używasz signInWithPopup ani signInWithRedirect.

Jeśli na przykład w aplikacji używane są tylko anonimowe konta i chcesz, aby konta były zapisane tylko na czas bieżącej sesji, zainicjuj Auth za pomocą:

const auth = initializeAuth(app, {
  persistence: browserSessionPersistence,
  popupRedirectResolver: undefined,
});

Podpis:

export declare function initializeAuth(app: FirebaseApp, deps?: Dependencies): Auth;

Parametry

Parametr	Typ	Opis
aplikacja	FirebaseApp
deps	Zależności

Zwroty:

Uwierzytelnianie

funkcja(pamięć masowa, ...)

getReactNativePersistence(storage)

Zwraca obiekt trwałości, który pakuje obiekt AsyncStorage zaimportowany z react-native lub @react-native-community/async-storage i można go użyć w polu zależności trwałości w funkcji initializeAuth().

Podpis:

export declare function getReactNativePersistence(storage: ReactNativeAsyncStorage): Persistence;

Parametry

Parametr	Typ	Opis
magazynowanie	ReactNativeAsyncStorage

Zwroty:

Trwałość

funkcja(uwierzytelnianie, ...)

applyActionCode(auth, oobCode)

Stosuje kod weryfikacyjny wysłany do użytkownika e-mailem lub za pomocą innego zewnętrznego mechanizmu.

Podpis:

export declare function applyActionCode(auth: Auth, oobCode: string): Promise<void>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
oobCode	string,	Kod weryfikacyjny został wysłany do użytkownika.

Zwroty:

Promise<void>

beforeAuthStateChanged(auth, callback, onAbort)

Dodaje blokujące wywołanie zwrotne, które jest wykonywane, zanim zmiana stanu uwierzytelniania ustawi nowego użytkownika.

Podpis:

export declare function beforeAuthStateChanged(auth: Auth, callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
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ę

checkActionCode(auth, oobCode)

Sprawdza kod weryfikacyjny wysłany do użytkownika e-mailem lub przy użyciu innego zewnętrznego mechanizmu.

Podpis:

export declare function checkActionCode(auth: Auth, oobCode: string): Promise<ActionCodeInfo>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
oobCode	string,	Kod weryfikacyjny został wysłany do użytkownika.

Zwroty:

Promise<ActionCodeInfo>

metadanych dotyczących kodu.

confirmPasswordReset(auth, oobCode, newPassword)

Kończy proces resetowania hasła, po otrzymaniu kodu potwierdzenia i nowego hasła.

Podpis:

export declare function confirmPasswordReset(auth: Auth, oobCode: string, newPassword: string): Promise<void>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
oobCode	string,	Kod potwierdzenia został wysłany do użytkownika.
newPassword	string,	Nowe hasło.

Zwroty:

Promise<void>

connectAuthEmulator(auth, url, options)

Zmienia instancję Auth w taki sposób, aby komunikowała się z emulatorem uwierzytelniania Firebase, a nie z produkcyjnymi usługami uwierzytelniania Firebase.

Należy je wywoływać synchronicznie bezpośrednio po pierwszym wywołaniu funkcji initializeAuth(). Nie używaj danych logowania produkcyjnego, ponieważ ruch generowany przez emulator nie jest szyfrowany.

Podpis:

export declare function connectAuthEmulator(auth: Auth, url: string, options?: {
    disableWarnings: boolean;
}): void;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
URL	string,	Adres URL, pod którym działa emulator (np. „http://localhost:9099”).
Opcje	{ disableWarnings: boolean; }	Opcjonalnie. options.disableWarnings ma wartość domyślną false. Ustaw wartość true, aby wyłączyć baner ostrzegawczy dołączony do DOM.

Zwroty:

void

Przykład

connectAuthEmulator(auth, 'http://127.0.0.1:9099', { disableWarnings: true });

createUserWithEmailAndPassword(auth, email, password)

Tworzy nowe konto użytkownika powiązane z określonym adresem e-mail i hasłem.

Po pomyślnym utworzeniu konta użytkownika ten użytkownik zostanie też zalogowany do Twojej aplikacji.

Utworzenie konta użytkownika może się nie udać, jeśli konto już istnieje lub hasło jest nieprawidłowe.

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

Podpis:

export declare function createUserWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
e-mail	string,	Adres e-mail użytkownika.
hasło	string,	Hasło wybrane przez użytkownika.

Zwroty:

Promise<UserCredential>

fetchSignInMethodsForEmail(auth, email)

Pobiera listę możliwych metod logowania się dla podanego adresu e-mail. Ta metoda zwraca pustą listę, gdy włączona jest [ochrona przed wyliczaniem adresów e-mail](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection), niezależnie od liczby metod uwierzytelniania dostępnych dla danego adresu e-mail.

Jest to przydatne w przypadku rozróżniania metod logowania w przypadku tego samego dostawcy, np. EmailAuthProvider, które ma 2 metody logowania: SignInMethod.EMAIL_PASSWORD i SignInMethod.EMAIL_LINK.

Podpis:

export declare function fetchSignInMethodsForEmail(auth: Auth, email: string): Promise<string[]>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
e-mail	string,	Adres e-mail użytkownika.Wycofano. Rezygnacja z tej metody jest zalecana jako sprawdzona metoda zapewniania bezpieczeństwa. Więcej informacji znajdziesz w dokumentacji Identity Platform dotyczącej [ochrony przed wyliczeniami poczty e-mail](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection).

Zwroty:

Obietnica<string[]>

getMultiFactorResolver(auth, error)

Udostępnia MultiFactorResolver, które jest odpowiednie do przeprowadzania przepływu pracy wielopoziomowej.

Podpis:

export declare function getMultiFactorResolver(auth: Auth, error: MultiFactorError): MultiFactorResolver;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
error	MultiFactorError	MultiFactorError zgłoszony podczas operacji logowania lub ponownego uwierzytelniania.

Zwroty:

MultiFactorResolver

getRedirectResult(auth, resolver)

Zwraca wartość UserCredential z procesu logowania opartego na przekierowaniach.

Jeśli logowanie się uda, użytkownik zwróci zalogowanego użytkownika. Jeśli logowanie się nie udało, wyświetla się błąd. Jeśli nie wywołano żadnej operacji przekierowania, zwraca wartość null.

Ta metoda nie działa w środowisku Node.js ani w instancjach Auth utworzonych przy użyciu aplikacji FirebaseServerApp.

Podpis:

export declare function getRedirectResult(auth: Auth, resolver?: PopupRedirectResolver): Promise<UserCredential | null>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
resolver	PopupRedirectResolver	Wystąpienie PopupRedirectResolver, które jest opcjonalne, jeśli zostało już dostarczone przez initializeAuth() lub zostało dostarczone przez getAuth().

Zwroty:

Promise<UserCredential | null>

Przykład

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
// You can add additional scopes to the provider:
provider.addScope('user_birthday');
// Start a sign in process for an unauthenticated user.
await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
if (result) {
  // This is the signed-in user
  const user = result.user;
  // This gives you a Facebook Access Token.
  const credential = provider.credentialFromResult(auth, result);
  const token = credential.accessToken;
}
// As this API can be used for sign-in, linking and reauthentication,
// check the operationType to determine what triggered this redirect
// operation.
const operationType = result.operationType;

initializeRecaptchaConfig(auth)

Wczytuje konfigurację reCAPTCHA do instancji Auth.

Spowoduje to załadowanie konfiguracji reCAPTCHA, która wskazuje, czy proces weryfikacji reCAPTCHA ma być aktywowany dla każdego dostawcy uwierzytelniania do bieżącej sesji uwierzytelniania.

Jeśli inicjacjaRecaptchaConfig() nie zostanie wywołana, przepływ uwierzytelniania zawsze będzie się uruchamiał bez weryfikacji reCAPTCHA. Jeśli dostawca jest skonfigurowany pod kątem wymagania weryfikacji reCAPTCHA, pakiet SDK w przejrzysty sposób wczyta konfigurację reCAPTCHA i ponownie uruchomi przepływy uwierzytelniania.

Dlatego wywołanie tej opcjonalnej metody skróci czas oczekiwania przyszłych przepływów uwierzytelniania. Wczesne wczytanie konfiguracji reCAPTCHA wzbogaci też sygnał zbierany przez reCAPTCHA.

Ta metoda nie działa w środowisku Node.js.

Podpis:

export declare function initializeRecaptchaConfig(auth: Auth): Promise<void>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.

Zwroty:

Promise<void>

Przykład

initializeRecaptchaConfig(auth);

isSignInWithEmailLink(auth, emailLink)

Sprawdza, czy link przychodzący to link do logowania się przy użyciu e-maila odpowiedniego dla funkcji signInWithEmailLink().

Podpis:

export declare function isSignInWithEmailLink(auth: Auth, emailLink: string): boolean;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
emailLink	string,	Link został wysłany na adres e-mail użytkownika.

Zwroty:

boolean

onAuthStateChanged(auth, nextOrObserver, error, completed)

Dodaje obserwatora zmian w stanie logowania użytkownika.

Aby zachować stare zachowanie, użyj funkcji onIdTokenChanged().

Podpis:

export declare function onAuthStateChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
nextOrObserver	NextOrObserver<użytkownik>	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ę

onIdTokenChanged(auth, nextOrObserver, error, completed)

Dodaje obserwatora zmian w tokenie identyfikatora zalogowanego użytkownika.

Obejmuje to zdarzenia logowania, wylogowywania i odświeżania tokenów. Nie zostanie to aktywowane automatycznie po wygaśnięciu tokena tożsamości. Użyj User.getIdToken(), aby odświeżyć token identyfikatora.

Podpis:

export declare function onIdTokenChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
nextOrObserver	NextOrObserver<użytkownik>	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ę

revokeAccessToken(auth, token)

Unieważnia podany token dostępu. Obecnie obsługuje tylko tokeny dostępu Apple OAuth.

Podpis:

export declare function revokeAccessToken(auth: Auth, token: string): Promise<void>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
token	string,	Token dostępu Apple OAuth.

Zwroty:

Promise<void>

sendPasswordResetEmail(auth, email, actionCodeSettings)

Wysyła na podany adres e-mail wiadomość e-mail dotyczącą resetowania hasła. Ta metoda nie powoduje błędu, gdy nie ma konta użytkownika z podanym adresem e-mail i jest włączona [ochrona przed wyliczeniami e-maili](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection).

Aby dokończyć resetowanie hasła, wywołaj metodę confirmPasswordReset(). Znajdziesz w niej kod podany w e-mailu wysłanym do użytkownika oraz nowe hasło określone przez użytkownika.

Podpis:

export declare function sendPasswordResetEmail(auth: Auth, email: string, actionCodeSettings?: ActionCodeSettings): Promise<void>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
e-mail	string,	Adres e-mail użytkownika.
actionCodeSettings	ActionCodeSettings	ActionCodeSettings.

Zwroty:

Promise<void>

Przykład

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendPasswordResetEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain code from user.
await confirmPasswordReset('user@example.com', code);

sendSignInLinkToEmail(auth, email, actionCodeSettings)

Wysyła użytkownikowi o podanym adresie e-mail link umożliwiający zalogowanie się.

Logowanie musi zawsze odbywać się w aplikacji – inaczej niż w przypadku innych działań związanych z wysyłaniem e-maili spoza zespołu (resetowanie hasła i weryfikacja adresu e-mail). Dzieje się tak, ponieważ na końcu procesu użytkownik powinien być zalogowany, a stan uwierzytelniania w aplikacji pozostaje niezmieniony.

Aby dokończyć logowanie za pomocą linku z e-maila, wywołaj funkcję signInWithEmailLink(), podając adres e-mail i link podany w e-mailu wysłanym do użytkownika.

Podpis:

export declare function sendSignInLinkToEmail(auth: Auth, email: string, actionCodeSettings: ActionCodeSettings): Promise<void>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie
e-mail	string,	Adres e-mail użytkownika.
actionCodeSettings	ActionCodeSettings	ActionCodeSettings.

Zwroty:

Promise<void>

Przykład

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendSignInLinkToEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
  await signInWithEmailLink(auth, 'user@example.com', emailLink);
}

setPersistence(auth, persistence)

Zmienia typ trwałości instancji Auth dla obecnie zapisanej sesji Auth i stosuje ten typ trwałości do przyszłych żądań logowania, w tym 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 Auth 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 ani w instancjach Auth utworzonych przy użyciu aplikacji FirebaseServerApp.

Podpis:

export declare function setPersistence(auth: Auth, persistence: Persistence): Promise<void>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
trwałość	Trwałość	Wartość Persistence, której chcesz użyć.

Zwroty:

Promise<void>

Promise, który zniknie po zakończeniu zmiany trwałości

Przykład

setPersistence(auth, browserSessionPersistence);

signInAnonymously(auth)

Asynchronicznie loguje się jako anonimowy użytkownik.

Jeśli na koncie jest już zalogowany anonimowy użytkownik, zostanie on zwrócony. W przeciwnym razie zostanie utworzona i zwrócona nowa anonimowa tożsamość użytkownika.

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

Podpis:

export declare function signInAnonymously(auth: Auth): Promise<UserCredential>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.

Zwroty:

Promise<UserCredential>

signInWithCredential(auth, credential)

Loguje się asynchronicznie przy użyciu danych logowania.

Do wygenerowania danych logowania można użyć obiektu AuthProvider.

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

Podpis:

export declare function signInWithCredential(auth: Auth, credential: AuthCredential): Promise<UserCredential>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
login	AuthCredential	Dane uwierzytelniające.

Zwroty:

Promise<UserCredential>

signInWithCustomToken(auth, customToken)

Loguje się asynchronicznie przy użyciu tokena niestandardowego.

Tokeny niestandardowe służą do integracji Uwierzytelniania Firebase z istniejącymi systemami uwierzytelniania i muszą być generowane przez backend uwierzytelniania przy użyciu metody createCustomToken w pakiecie Admin SDK .

Jeśli token jest nieprawidłowy, wygasł lub nie został zaakceptowany przez usługę Uwierzytelnianie Firebase, kończy się błędem.

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

Podpis:

export declare function signInWithCustomToken(auth: Auth, customToken: string): Promise<UserCredential>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
customToken	string,	Niestandardowy token służący do logowania się.

Zwroty:

Promise<UserCredential>

signInWithEmailAndPassword(auth, email, password)

Loguje się asynchronicznie przy użyciu adresu e-mail i hasła.

Niepowodzenie, jeśli adres e-mail i hasło nie pasują do siebie. Gdy włączona jest [ochrona przed wyliczeniami poczty e-mail](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection), ta metoda kończy się niepowodzeniem i w przypadku nieprawidłowego adresu e-mail lub hasła zwraca błąd „auth/invalid-credential”.

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

Podpis:

export declare function signInWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
e-mail	string,	Adres e-mail użytkownika.
hasło	string,	Hasło użytkownika.

Zwroty:

Promise<UserCredential>

signInWithEmailLink(auth, email, emailLink)

Loguje się asynchronicznie za pomocą adresu e-mail oraz linku umożliwiającego zalogowanie się.

Jeśli żaden link nie zostanie przekazany, zostanie on utworzony na podstawie bieżącego adresu URL.

Błąd, jeśli adres e-mail jest nieprawidłowy lub hasło jednorazowe podane w linku e-mail wygasło.

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

Podpis:

export declare function signInWithEmailLink(auth: Auth, email: string, emailLink?: string): Promise<UserCredential>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
e-mail	string,	Adres e-mail użytkownika.
emailLink	string,	Link został wysłany na adres e-mail użytkownika.

Zwroty:

Promise<UserCredential>

Przykład

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendSignInLinkToEmail(auth, 'user@example.com', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
  await signInWithEmailLink(auth, 'user@example.com', emailLink);
}

signInWithPhoneNumber(auth, phoneNumber, appVerifier)

Logowanie asynchroniczne przy użyciu numeru telefonu.

Ta metoda wysyła kod SMS-em na podany numer telefonu i zwraca ConfirmationResult. Gdy użytkownik poda kod wysłany na jego telefon, wywołaj ConfirmationResult.confirm() i podaj ten kod, aby zalogować użytkownika.

Aby zapobiegać nadużyciom, ta metoda wymaga również parametru ApplicationVerifier. Ten pakiet SDK zawiera implementację opartą na reCAPTCHA – RecaptchaVerifier. Ta funkcja może działać na innych platformach, które nie obsługują parametru RecaptchaVerifier (np. React Native), ale musisz użyć zewnętrznej implementacji ApplicationVerifier.

Ta metoda nie działa w środowisku Node.js ani w instancjach Auth utworzonych przy użyciu aplikacji FirebaseServerApp.

Podpis:

export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
phoneNumber	string,	Numer telefonu użytkownika w formacie E.164 (np. +16505550101).
appVerifier	ApplicationVerifier	ApplicationVerifier.

Zwroty:

Promise<ConfirmationResult>

Przykład

// 'recaptcha-container' is the ID of an element in the DOM.
const applicationVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container');
const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier);
// Obtain a verificationCode from the user.
const credential = await confirmationResult.confirm(verificationCode);

signInWithPopup(auth, provider, resolver)

Uwierzytelnianie klienta Firebase przy użyciu procesu uwierzytelniania OAuth w wyskakującym okienku.

Jeśli operacja się uda, funkcja zwróci zalogowanego użytkownika wraz z danymi logowania dostawcy. Jeśli logowanie się nie powiodło, zwracany jest obiekt błędu z dodatkowymi informacjami o błędzie.

Ta metoda nie działa w środowisku Node.js ani w instancjach Auth utworzonych przy użyciu aplikacji FirebaseServerApp.

Podpis:

export declare function signInWithPopup(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
provider	AuthProvider	Dostawca do uwierzytelnienia. Dostawcam musi być OAuthProvider. Dostawcy niekorzystający z protokołu OAuth, tacy jak EmailAuthProvider, zgłaszają błąd.
resolver	PopupRedirectResolver	Wystąpienie PopupRedirectResolver, które jest opcjonalne, jeśli zostało już dostarczone przez initializeAuth() lub zostało dostarczone przez getAuth().

Zwroty:

Promise<UserCredential>

Przykład

// Sign in using a popup.
const provider = new FacebookAuthProvider();
const result = await signInWithPopup(auth, provider);

// The signed-in user info.
const user = result.user;
// This gives you a Facebook Access Token.
const credential = provider.credentialFromResult(auth, result);
const token = credential.accessToken;

signInWithRedirect(auth, provider, resolver)

Uwierzytelnianie klienta Firebase za pomocą przekierowania obejmującego całą stronę.

Aby obsłużyć wyniki i błędy tej operacji, zapoznaj się z metodą getRedirectResult(). Podczas korzystania z funkcji signInWithRedirect() postępuj zgodnie ze sprawdzonymi metodami.

Ta metoda nie działa w środowisku Node.js ani w instancjach Auth utworzonych przy użyciu aplikacji FirebaseServerApp.

Podpis:

export declare function signInWithRedirect(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
provider	AuthProvider	Dostawca do uwierzytelnienia. Dostawcam musi być OAuthProvider. Dostawcy niekorzystający z protokołu OAuth, tacy jak EmailAuthProvider, zgłaszają błąd.
resolver	PopupRedirectResolver	Wystąpienie PopupRedirectResolver, które jest opcjonalne, jeśli zostało już dostarczone przez initializeAuth() lub zostało dostarczone przez getAuth().

Zwroty:

Obietnica<ni>

Przykład

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
// You can add additional scopes to the provider:
provider.addScope('user_birthday');
// Start a sign in process for an unauthenticated user.
await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
if (result) {
  // This is the signed-in user
  const user = result.user;
  // This gives you a Facebook Access Token.
  const credential = provider.credentialFromResult(auth, result);
  const token = credential.accessToken;
}
// As this API can be used for sign-in, linking and reauthentication,
// check the operationType to determine what triggered this redirect
// operation.
const operationType = result.operationType;

signOut(auth)

Wylogowuje bieżącego użytkownika.

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

Podpis:

export declare function signOut(auth: Auth): Promise<void>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.

Zwroty:

Promise<void>

updateCurrentUser(auth, user)

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 onAuthStateChanged() i onIdTokenChanged() podobnie jak inne metody logowania.

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

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

Podpis:

export declare function updateCurrentUser(auth: Auth, user: User | null): Promise<void>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
użytkownik	Użytkownik | brak	Nowy Użytkownik.

Zwroty:

Promise<void>

useDeviceLanguage(auth)

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

Podpis:

export declare function useDeviceLanguage(auth: Auth): void;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.

Zwroty:

void

validatePassword(auth, password)

Weryfikuje hasło pod kątem zgodności z zasadami dotyczącymi haseł skonfigurowanymi dla projektu lub najemcy.

Jeśli w instancji Auth nie jest ustawiony żaden identyfikator najemcy, ta metoda użyje zasad dotyczących haseł skonfigurowanych dla projektu. W przeciwnym razie ta metoda użyje zasad skonfigurowanych dla najemcy. Jeśli zasady dotyczące haseł nie zostały skonfigurowane, będą używane domyślne zasady skonfigurowane dla wszystkich projektów.

Jeśli proces uwierzytelniania nie powiedzie się, ponieważ przesłane hasło nie spełnia wymagań zasad dotyczących haseł, a ta metoda została wcześniej wywołana, przy ponownym wywołaniu metoda ta będzie używać najnowszej dostępnej zasady.

Podpis:

export declare function validatePassword(auth: Auth, password: string): Promise<PasswordValidationStatus>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
hasło	string,	Hasło do sprawdzenia.

Zwroty:

Promise<PasswordValidationStatus>

Przykład

validatePassword(auth, 'some-password');

verifyPasswordResetCode(auth, code)

Sprawdza kod resetowania hasła wysłany do użytkownika e-mailem lub przy użyciu innego zewnętrznego mechanizmu.

Podpis:

export declare function verifyPasswordResetCode(auth: Auth, code: string): Promise<string>;

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	Instancja Auth.
kod	string,	Kod weryfikacyjny został wysłany do użytkownika.

Zwroty:

Obietnica<string>

adres e-mail użytkownika, jeśli jest prawidłowy.

funkcja(link, ...)

ParseActionURL(link)

Analizuje ciąg znaków linku działania e-mail i zwraca wartość ActionCodeURL, jeśli link jest prawidłowy. W przeciwnym razie zwraca wartość null.

Podpis:

export declare function parseActionCodeURL(link: string): ActionCodeURL | null;

Parametry

Parametr	Typ	Opis
link	string,

Zwroty:

ActionCodeURL | wartość null

funkcja(użytkownik, ...)

deleteUser(user)

usuwa użytkownika i wylogowuje go;

Podpis:

export declare function deleteUser(user: User): Promise<void>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.

Zwroty:

Promise<void>

getIdToken(user, forceRefresh)

Zwraca token sieciowy JSON (JWT) służący do identyfikacji użytkownika w usłudze Firebase.

Zwraca bieżący token, jeśli nie wygasł lub nie wygaśnie w ciągu najbliższych 5 minut. W przeciwnym razie token zostanie odświeżony i pojawi się nowy.

Podpis:

export declare function getIdToken(user: User, forceRefresh?: boolean): Promise<string>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.
forceRefresh	boolean	Wymuś odświeżenie niezależnie od wygaśnięcia tokena.

Zwroty:

Obietnica<string>

getIdTokenResult(user, forceRefresh)

Zwraca zdeserializowany token sieciowy JSON (JWT) służący do identyfikacji użytkownika w usłudze Firebase.

Zwraca bieżący token, jeśli nie wygasł lub nie wygaśnie w ciągu najbliższych 5 minut. W przeciwnym razie token zostanie odświeżony i pojawi się nowy.

Podpis:

export declare function getIdTokenResult(user: User, forceRefresh?: boolean): Promise<IdTokenResult>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.
forceRefresh	boolean	Wymuś odświeżenie niezależnie od wygaśnięcia tokena.

Zwroty:

Promise<IdTokenResult>

linkWithCredential(user, credential)

Łączy konto użytkownika z podanymi danymi logowania.

Do wygenerowania danych logowania można użyć obiektu AuthProvider.

Podpis:

export declare function linkWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.
login	AuthCredential	Dane uwierzytelniające.

Zwroty:

Promise<UserCredential>

linkWithPhoneNumber(user, phoneNumber, appVerifier)

Łączy konto użytkownika z podanym numerem telefonu.

Ta metoda nie działa w środowisku Node.js.

Podpis:

export declare function linkWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.
phoneNumber	string,	Numer telefonu użytkownika w formacie E.164 (np. +16505550101).
appVerifier	ApplicationVerifier	ApplicationVerifier.

Zwroty:

Promise<ConfirmationResult>

linkWithPopup(user, provider, resolver)

Łączy uwierzytelnionego dostawcę z kontem użytkownika za pomocą procesu OAuth opartego na wyskakującym okienku.

Jeśli połączenie się powiedzie, w zwracanym wyniku znajdzie się użytkownik i dane logowania dostawcy.

Ta metoda nie działa w środowisku Node.js.

Podpis:

export declare function linkWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.
provider	AuthProvider	Dostawca do uwierzytelnienia. Dostawcam musi być OAuthProvider. Dostawcy niekorzystający z protokołu OAuth, tacy jak EmailAuthProvider, zgłaszają błąd.
resolver	PopupRedirectResolver	Wystąpienie PopupRedirectResolver, które jest opcjonalne, jeśli zostało już dostarczone przez initializeAuth() lub zostało dostarczone przez getAuth().

Zwroty:

Promise<UserCredential>

Przykład

// Sign in using some other provider.
const result = await signInWithEmailAndPassword(auth, email, password);
// Link using a popup.
const provider = new FacebookAuthProvider();
await linkWithPopup(result.user, provider);

linkWithRedirect(user, provider, resolver)

Łączy metodę OAuthProvider z kontem użytkownika, korzystając z przekierowania całej strony.

Aby zapoznać się z wynikami i błędami tej operacji, sprawdź funkcję getRedirectResult(). Podczas korzystania z funkcji linkWithRedirect() postępuj zgodnie ze sprawdzonymi metodami.

Ta metoda nie działa w środowisku Node.js ani w instancjach Auth utworzonych przy użyciu aplikacji FirebaseServerApp.

Podpis:

export declare function linkWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.
provider	AuthProvider	Dostawca do uwierzytelnienia. Dostawcam musi być OAuthProvider. Dostawcy niekorzystający z protokołu OAuth, tacy jak EmailAuthProvider, zgłaszają błąd.
resolver	PopupRedirectResolver	Wystąpienie PopupRedirectResolver, które jest opcjonalne, jeśli zostało już dostarczone przez initializeAuth() lub zostało dostarczone przez getAuth().

Zwroty:

Obietnica<ni>

Przykład

// Sign in using some other provider.
const result = await signInWithEmailAndPassword(auth, email, password);
// Link using a redirect.
const provider = new FacebookAuthProvider();
await linkWithRedirect(result.user, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);

multiFactor(user)

Wartość MultiFactorUser odpowiadająca użytkownikowi.

Uzyskasz dostęp do wszystkich właściwości uwierzytelniania wielopoziomowego i operacji związanych z użytkownikiem.

Podpis:

export declare function multiFactor(user: User): MultiFactorUser;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.

Zwroty:

MultiFactorUser

reauthenticateWithCredential(user, credential)

Ponownie uwierzytelnia użytkownika przy użyciu nowych danych logowania.

Używaj przed operacjami, takimi jak updatePassword(), które wymagają tokenów z ostatnich prób logowania. Tej metody można używać w przypadku usuwania błędów CREDENTIAL_TOO_OLD_LOGIN_AGAIN i TOKEN_EXPIRED.

Ta metoda nie jest obsługiwana w przypadku żadnego użytkownika zalogowanego za pomocą instancji Auth utworzonych przy użyciu FirebaseServerApp.

Podpis:

export declare function reauthenticateWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.
login	AuthCredential	Dane uwierzytelniające.

Zwroty:

Promise<UserCredential>

reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier)

Ponownie uwierzytelnia użytkownika przy użyciu nowych danych logowania do telefonu.

Używaj przed operacjami, takimi jak updatePassword(), które wymagają tokenów z ostatnich prób logowania.

Ta metoda nie działa w środowisku Node.js ani w żadnych użytkownikach zalogowanych za pomocą instancji Auth utworzonych przy użyciu aplikacji FirebaseServerApp.

Podpis:

export declare function reauthenticateWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.
phoneNumber	string,	Numer telefonu użytkownika w formacie E.164 (np. +16505550101).
appVerifier	ApplicationVerifier	ApplicationVerifier.

Zwroty:

Promise<ConfirmationResult>

reauthenticateWithPopup(user, provider, resolver)

Ponownie uwierzytelnia bieżącego użytkownika przy użyciu określonego dostawcy OAuthProvider, korzystając z procesu OAuth opartego na wyskakującym okienku.

Jeśli ponowne uwierzytelnianie się powiedzie, zwrócony wynik będzie zawierał użytkownika i dane logowania dostawcy.

Ta metoda nie działa w środowisku Node.js ani w żadnych użytkownikach zalogowanych za pomocą instancji Auth utworzonych przy użyciu aplikacji FirebaseServerApp.

Podpis:

export declare function reauthenticateWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.
provider	AuthProvider	Dostawca do uwierzytelnienia. Dostawcam musi być OAuthProvider. Dostawcy niekorzystający z protokołu OAuth, tacy jak EmailAuthProvider, zgłaszają błąd.
resolver	PopupRedirectResolver	Wystąpienie PopupRedirectResolver, które jest opcjonalne, jeśli zostało już dostarczone przez initializeAuth() lub zostało dostarczone przez getAuth().

Zwroty:

Promise<UserCredential>

Przykład

// Sign in using a popup.
const provider = new FacebookAuthProvider();
const result = await signInWithPopup(auth, provider);
// Reauthenticate using a popup.
await reauthenticateWithPopup(result.user, provider);

reauthenticateWithRedirect(user, provider, resolver)

Ponownie uwierzytelnia bieżącego użytkownika przy użyciu określonego dostawcy OAuthProvider, korzystając z przekierowania całej strony.

Aby obsłużyć wyniki i błędy tej operacji, zapoznaj się z metodą getRedirectResult(). Podczas korzystania z funkcji reauthenticateWithRedirect() postępuj zgodnie ze sprawdzonymi metodami.

Ta metoda nie działa w środowisku Node.js ani w instancjach Auth utworzonych przy użyciu aplikacji FirebaseServerApp.

Podpis:

export declare function reauthenticateWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.
provider	AuthProvider	Dostawca do uwierzytelnienia. Dostawcam musi być OAuthProvider. Dostawcy niekorzystający z protokołu OAuth, tacy jak EmailAuthProvider, zgłaszają błąd.
resolver	PopupRedirectResolver	Wystąpienie PopupRedirectResolver, które jest opcjonalne, jeśli zostało już dostarczone przez initializeAuth() lub zostało dostarczone przez getAuth().

Zwroty:

Obietnica<ni>

Przykład

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
const result = await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
// Reauthenticate using a redirect.
await reauthenticateWithRedirect(result.user, provider);
// This will again trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);

załaduj ponownie(użytkownik)

Ponownie wczytuje dane konta użytkownika, jeśli jest zalogowany.

Podpis:

export declare function reload(user: User): Promise<void>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.

Zwroty:

Promise<void>

sendEmailVerification(user, actionCodeSettings)

Wysyła do użytkownika e-maila weryfikacyjnego.

Proces weryfikacji kończy się przez wywołanie metody applyActionCode().

Podpis:

export declare function sendEmailVerification(user: User, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.
actionCodeSettings	ActionCodeSettings | wartość null	ActionCodeSettings.

Zwroty:

Promise<void>

Przykład

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendEmailVerification(user, actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);

rozłączyć(użytkownik, identyfikator dostawcy)

Odłącza dostawcę od konta użytkownika.

Podpis:

export declare function unlink(user: User, providerId: string): Promise<User>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.
providerId	string,	Dostawca, który ma zostać odłączony.

Zwroty:

Obietnica<Użytkownik>

updateEmail(user, newEmail)

Aktualizuje adres e-mail użytkownika.

Na pierwotny adres e-mail (jeśli został ustawiony) zostanie wysłana wiadomość e-mail, która umożliwia cofnięcie zmiany adresu e-mail w celu ochrony przed przejęciem konta.

Ta metoda nie jest obsługiwana w przypadku żadnego użytkownika zalogowanego za pomocą instancji Auth utworzonych przy użyciu FirebaseServerApp.

Podpis:

export declare function updateEmail(user: User, newEmail: string): Promise<void>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.
newEmail	string,	Nowy adres e-mail.Informuje o błędzie „auth/operation-not-allowed”, gdy włączona jest [ochrona przed wyliczeniami poczty e-mail](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection). Wycofano – zamiast niej użyj funkcji verifyBeforeUpdateEmail().

Zwroty:

Promise<void>

updatePassword(user, newPassword)

Aktualizuje hasło użytkownika.

Podpis:

export declare function updatePassword(user: User, newPassword: string): Promise<void>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.
newPassword	string,	Nowe hasło.

Zwroty:

Promise<void>

updatePhoneNumber(user, credential)

Aktualizuje numer telefonu użytkownika.

Ta metoda nie działa w środowisku Node.js ani w żadnych użytkownikach zalogowanych za pomocą instancji Auth utworzonych przy użyciu aplikacji FirebaseServerApp.

Podpis:

export declare function updatePhoneNumber(user: User, credential: PhoneAuthCredential): Promise<void>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.
login	PhoneAuthCredential	Dane logowania, które uwierzytelniają nowy numer telefonu.

Zwroty:

Promise<void>

Przykład

// 'recaptcha-container' is the ID of an element in the DOM.
const applicationVerifier = new RecaptchaVerifier('recaptcha-container');
const provider = new PhoneAuthProvider(auth);
const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier);
// Obtain the verificationCode from the user.
const phoneCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
await updatePhoneNumber(user, phoneCredential);

updateProfile(user, { displayName, photoURL: photoUrl })

Aktualizuje dane profilowe użytkownika.

Podpis:

export declare function updateProfile(user: User, { displayName, photoURL: photoUrl }: {
    displayName?: string | null;
    photoURL?: string | null;
}): Promise<void>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.
{ displayName, photoURL: photoUrl }	{ displayName?: string | null; photoURL?: string | null; }

Zwroty:

Promise<void>

verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings)

Wysyła e-maila weryfikacyjnego na nowy adres e-mail.

Po zakończeniu weryfikacji adres e-mail użytkownika zostanie zmieniony na nowy.

Jeśli masz własny moduł do obsługi działań e-mailowych, możesz zakończyć proces weryfikacji, wywołując metodę applyActionCode().

Podpis:

export declare function verifyBeforeUpdateEmail(user: User, newEmail: string, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	użytkownika.
newEmail	string,	Nowy adres e-mail do weryfikacji przed aktualizacją.
actionCodeSettings	ActionCodeSettings | wartość null	ActionCodeSettings.

Zwroty:

Promise<void>

Przykład

const actionCodeSettings = {
  url: 'https://www.example.com/?email=user@example.com',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await verifyBeforeUpdateEmail(user, 'newemail@example.com', actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);

funkcja(dane logowania użytkownika, ...)

getAdditionalUserInfo(userCredential)

Wyodrębnia element AdditionalUserInfo specyficzny dla dostawcy dla danych logowania.

Podpis:

export declare function getAdditionalUserInfo(userCredential: UserCredential): AdditionalUserInfo | null;

Parametry

Parametr	Typ	Opis
userCredential	UserCredential	Dane logowania użytkownika.

Zwroty:

AdditionalUserInfo | null

ActionCodeOperation

Lista możliwych typów działań dotyczących e-maili.

Podpis:

ActionCodeOperation: {
    readonly EMAIL_SIGNIN: "EMAIL_SIGNIN";
    readonly PASSWORD_RESET: "PASSWORD_RESET";
    readonly RECOVER_EMAIL: "RECOVER_EMAIL";
    readonly REVERT_SECOND_FACTOR_ADDITION: "REVERT_SECOND_FACTOR_ADDITION";
    readonly VERIFY_AND_CHANGE_EMAIL: "VERIFY_AND_CHANGE_EMAIL";
    readonly VERIFY_EMAIL: "VERIFY_EMAIL";
}

AuthErrorCodes

Mapa potencjalnych kodów błędów (Auth), która ułatwia porównywanie błędów zgłaszanych przez pakiet SDK.

Pamiętaj, że nie można potrząsać drzewem poszczególnych kluczy na mapie, więc korzystanie z mapy może znacznie zwiększyć rozmiar pakietu.

Podpis:

AUTH_ERROR_CODES_MAP_DO_NOT_USE_INTERNALLY: {
    readonly ADMIN_ONLY_OPERATION: "auth/admin-restricted-operation";
    readonly ARGUMENT_ERROR: "auth/argument-error";
    readonly APP_NOT_AUTHORIZED: "auth/app-not-authorized";
    readonly APP_NOT_INSTALLED: "auth/app-not-installed";
    readonly CAPTCHA_CHECK_FAILED: "auth/captcha-check-failed";
    readonly CODE_EXPIRED: "auth/code-expired";
    readonly CORDOVA_NOT_READY: "auth/cordova-not-ready";
    readonly CORS_UNSUPPORTED: "auth/cors-unsupported";
    readonly CREDENTIAL_ALREADY_IN_USE: "auth/credential-already-in-use";
    readonly CREDENTIAL_MISMATCH: "auth/custom-token-mismatch";
    readonly CREDENTIAL_TOO_OLD_LOGIN_AGAIN: "auth/requires-recent-login";
    readonly DEPENDENT_SDK_INIT_BEFORE_AUTH: "auth/dependent-sdk-initialized-before-auth";
    readonly DYNAMIC_LINK_NOT_ACTIVATED: "auth/dynamic-link-not-activated";
    readonly EMAIL_CHANGE_NEEDS_VERIFICATION: "auth/email-change-needs-verification";
    readonly EMAIL_EXISTS: "auth/email-already-in-use";
    readonly EMULATOR_CONFIG_FAILED: "auth/emulator-config-failed";
    readonly EXPIRED_OOB_CODE: "auth/expired-action-code";
    readonly EXPIRED_POPUP_REQUEST: "auth/cancelled-popup-request";
    readonly INTERNAL_ERROR: "auth/internal-error";
    readonly INVALID_API_KEY: "auth/invalid-api-key";
    readonly INVALID_APP_CREDENTIAL: "auth/invalid-app-credential";
    readonly INVALID_APP_ID: "auth/invalid-app-id";
    readonly INVALID_AUTH: "auth/invalid-user-token";
    readonly INVALID_AUTH_EVENT: "auth/invalid-auth-event";
    readonly INVALID_CERT_HASH: "auth/invalid-cert-hash";
    readonly INVALID_CODE: "auth/invalid-verification-code";
    readonly INVALID_CONTINUE_URI: "auth/invalid-continue-uri";
    readonly INVALID_CORDOVA_CONFIGURATION: "auth/invalid-cordova-configuration";
    readonly INVALID_CUSTOM_TOKEN: "auth/invalid-custom-token";
    readonly INVALID_DYNAMIC_LINK_DOMAIN: "auth/invalid-dynamic-link-domain";
    readonly INVALID_EMAIL: "auth/invalid-email";
    readonly INVALID_EMULATOR_SCHEME: "auth/invalid-emulator-scheme";
    readonly INVALID_IDP_RESPONSE: "auth/invalid-credential";
    readonly INVALID_LOGIN_CREDENTIALS: "auth/invalid-credential";
    readonly INVALID_MESSAGE_PAYLOAD: "auth/invalid-message-payload";
    readonly INVALID_MFA_SESSION: "auth/invalid-multi-factor-session";
    readonly INVALID_OAUTH_CLIENT_ID: "auth/invalid-oauth-client-id";
    readonly INVALID_OAUTH_PROVIDER: "auth/invalid-oauth-provider";
    readonly INVALID_OOB_CODE: "auth/invalid-action-code";
    readonly INVALID_ORIGIN: "auth/unauthorized-domain";
    readonly INVALID_PASSWORD: "auth/wrong-password";
    readonly INVALID_PERSISTENCE: "auth/invalid-persistence-type";
    readonly INVALID_PHONE_NUMBER: "auth/invalid-phone-number";
    readonly INVALID_PROVIDER_ID: "auth/invalid-provider-id";
    readonly INVALID_RECIPIENT_EMAIL: "auth/invalid-recipient-email";
    readonly INVALID_SENDER: "auth/invalid-sender";
    readonly INVALID_SESSION_INFO: "auth/invalid-verification-id";
    readonly INVALID_TENANT_ID: "auth/invalid-tenant-id";
    readonly MFA_INFO_NOT_FOUND: "auth/multi-factor-info-not-found";
    readonly MFA_REQUIRED: "auth/multi-factor-auth-required";
    readonly MISSING_ANDROID_PACKAGE_NAME: "auth/missing-android-pkg-name";
    readonly MISSING_APP_CREDENTIAL: "auth/missing-app-credential";
    readonly MISSING_AUTH_DOMAIN: "auth/auth-domain-config-required";
    readonly MISSING_CODE: "auth/missing-verification-code";
    readonly MISSING_CONTINUE_URI: "auth/missing-continue-uri";
    readonly MISSING_IFRAME_START: "auth/missing-iframe-start";
    readonly MISSING_IOS_BUNDLE_ID: "auth/missing-ios-bundle-id";
    readonly MISSING_OR_INVALID_NONCE: "auth/missing-or-invalid-nonce";
    readonly MISSING_MFA_INFO: "auth/missing-multi-factor-info";
    readonly MISSING_MFA_SESSION: "auth/missing-multi-factor-session";
    readonly MISSING_PHONE_NUMBER: "auth/missing-phone-number";
    readonly MISSING_SESSION_INFO: "auth/missing-verification-id";
    readonly MODULE_DESTROYED: "auth/app-deleted";
    readonly NEED_CONFIRMATION: "auth/account-exists-with-different-credential";
    readonly NETWORK_REQUEST_FAILED: "auth/network-request-failed";
    readonly NULL_USER: "auth/null-user";
    readonly NO_AUTH_EVENT: "auth/no-auth-event";
    readonly NO_SUCH_PROVIDER: "auth/no-such-provider";
    readonly OPERATION_NOT_ALLOWED: "auth/operation-not-allowed";
    readonly OPERATION_NOT_SUPPORTED: "auth/operation-not-supported-in-this-environment";
    readonly POPUP_BLOCKED: "auth/popup-blocked";
    readonly POPUP_CLOSED_BY_USER: "auth/popup-closed-by-user";
    readonly PROVIDER_ALREADY_LINKED: "auth/provider-already-linked";
    readonly QUOTA_EXCEEDED: "auth/quota-exceeded";
    readonly REDIRECT_CANCELLED_BY_USER: "auth/redirect-cancelled-by-user";
    readonly REDIRECT_OPERATION_PENDING: "auth/redirect-operation-pending";
    readonly REJECTED_CREDENTIAL: "auth/rejected-credential";
    readonly SECOND_FACTOR_ALREADY_ENROLLED: "auth/second-factor-already-in-use";
    readonly SECOND_FACTOR_LIMIT_EXCEEDED: "auth/maximum-second-factor-count-exceeded";
    readonly TENANT_ID_MISMATCH: "auth/tenant-id-mismatch";
    readonly TIMEOUT: "auth/timeout";
    readonly TOKEN_EXPIRED: "auth/user-token-expired";
    readonly TOO_MANY_ATTEMPTS_TRY_LATER: "auth/too-many-requests";
    readonly UNAUTHORIZED_DOMAIN: "auth/unauthorized-continue-uri";
    readonly UNSUPPORTED_FIRST_FACTOR: "auth/unsupported-first-factor";
    readonly UNSUPPORTED_PERSISTENCE: "auth/unsupported-persistence-type";
    readonly UNSUPPORTED_TENANT_OPERATION: "auth/unsupported-tenant-operation";
    readonly UNVERIFIED_EMAIL: "auth/unverified-email";
    readonly USER_CANCELLED: "auth/user-cancelled";
    readonly USER_DELETED: "auth/user-not-found";
    readonly USER_DISABLED: "auth/user-disabled";
    readonly USER_MISMATCH: "auth/user-mismatch";
    readonly USER_SIGNED_OUT: "auth/user-signed-out";
    readonly WEAK_PASSWORD: "auth/weak-password";
    readonly WEB_STORAGE_UNSUPPORTED: "auth/web-storage-unsupported";
    readonly ALREADY_INITIALIZED: "auth/already-initialized";
    readonly RECAPTCHA_NOT_ENABLED: "auth/recaptcha-not-enabled";
    readonly MISSING_RECAPTCHA_TOKEN: "auth/missing-recaptcha-token";
    readonly INVALID_RECAPTCHA_TOKEN: "auth/invalid-recaptcha-token";
    readonly INVALID_RECAPTCHA_ACTION: "auth/invalid-recaptcha-action";
    readonly MISSING_CLIENT_TYPE: "auth/missing-client-type";
    readonly MISSING_RECAPTCHA_VERSION: "auth/missing-recaptcha-version";
    readonly INVALID_RECAPTCHA_VERSION: "auth/invalid-recaptcha-version";
    readonly INVALID_REQ_TYPE: "auth/invalid-req-type";
}

browserLocalPersistence

Implementacja trwałości typu LOCAL wykorzystująca jako bazową pamięć masową localStorage.

Podpis:

browserLocalPersistence: Persistence

browserPopupRedirectResolver

Implementacja PopupRedirectResolver w przypadku aplikacji działających w przeglądarce.

Ta metoda nie działa w środowisku Node.js.

Podpis:

browserPopupRedirectResolver: PopupRedirectResolver

browserSessionPersistence

Implementacja trwałości elementu SESSION z wykorzystaniem sessionStorage jako bazowego miejsca na dane.

Podpis:

browserSessionPersistence: Persistence

cordovaPopupRedirectResolver

Implementacja PopupRedirectResolver w przypadku aplikacji opartych na aplikacji Cordova.

Podpis:

cordovaPopupRedirectResolver: PopupRedirectResolver

debugErrorMap

Szczegółowa mapa błędów ze szczegółowymi opisami większości kodów błędów.

Zobacz dyskusję na stronie AuthErrorMap

Podpis:

debugErrorMap: AuthErrorMap

FactorId

Wyliczenie czynników, które mogą być używane do uwierzytelniania wielopoziomowego.

Podpis:

FactorId: {
    readonly PHONE: "phone";
    readonly TOTP: "totp";
}

indexedDBLocalPersistence

Implementacja trwałości typu LOCAL wykorzystująca jako bazową pamięć masową indexedDB.

Podpis:

indexedDBLocalPersistence: Persistence

inMemoryPersistence

Implementacja trwałości typu „BRAK”.

Podpis:

inMemoryPersistence: Persistence

OperationType

Wyliczenie obsługiwanych typów operacji.

Podpis:

OperationType: {
    readonly LINK: "link";
    readonly REAUTHENTICATE: "reauthenticate";
    readonly SIGN_IN: "signIn";
}

prodErrorMap

Minimalna mapa błędów z usuniętymi wszystkimi szczegółowymi komunikatami o błędach.

Zobacz dyskusję na stronie AuthErrorMap

Podpis:

prodErrorMap: AuthErrorMap

ProviderId

Wyliczenie obsługiwanych dostawców.

Podpis:

ProviderId: {
    readonly FACEBOOK: "facebook.com";
    readonly GITHUB: "github.com";
    readonly GOOGLE: "google.com";
    readonly PASSWORD: "password";
    readonly PHONE: "phone";
    readonly TWITTER: "twitter.com";
}

SignInMethod

Wyliczenie obsługiwanych metod logowania.

Podpis:

SignInMethod: {
    readonly EMAIL_LINK: "emailLink";
    readonly EMAIL_PASSWORD: "password";
    readonly FACEBOOK: "facebook.com";
    readonly GITHUB: "github.com";
    readonly GOOGLE: "google.com";
    readonly PHONE: "phone";
    readonly TWITTER: "twitter.com";
}

CustomParameters

Mapa niestandardowych parametrów OAuth.

Podpis:

export declare type CustomParameters = Record<string, string>;

NextOrObserver

Wpisz definicję wywołania zwrotnego zdarzenia.

Podpis:

export declare type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;

PhoneInfoOptions

Informacje wymagane do zweryfikowania własności numeru telefonu.

Wymagane informacje zależą od tego, czy używasz logowania jednopoziomowego, rejestracji wielopoziomowej, czy też logowania wielopoziomowego.

Podpis:

export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;

UserProfile

Profil użytkownika używany w AdditionalUserInfo.

Podpis:

export declare type UserProfile = Record<string, unknown>;