auth package

Uwierzytelnianie Firebase

Funkcje

Funkcja	Opis
function(aplikacja, ...)
getAuth(aplikacja)	Zwraca wystąpienie Auth powiązane z podaną aplikacją FirebaseApp. Jeśli nie ma żadnej instancji, inicjuje instancję uwierzytelniania z domyślnymi zależnościami na poszczególnych platformach.
initializeAuth(aplikacja, deps)	Inicjuje instancję Auth ze szczegółową kontrolą nad zależnościami.
function(storage, ...)
getReactNativePersistence(storage),	Zwraca obiekt trwałości, który opakowuje obiekt AsyncStorage zaimportowany z metody react-native lub @react-native-community/async-storage i może być użyty w polu zależności trwałości w initializeAuth().
function(auth, ...)
applyActionCode(auth, oobCode)	Stosuje kod weryfikacyjny wysłany do użytkownika e-mailem lub w inny sposób spoza zakresu.
beforeAuthStateChanged(uwierzytelnianie, wywołanie zwrotne, onAbort)	Dodaje blokujące wywołanie zwrotne, które jest uruchamiane, zanim zmiana stanu uwierzytelniania ustawi nowego użytkownika.
checkActionCode(auth, oobCode)	Sprawdza kod weryfikacyjny wysłany do użytkownika e-mailem lub w inny sposób spoza zespołu.
confirmPasswordReset(auth, oobCode, newPassword)	Kończy proces resetowania hasła, otrzymując kod potwierdzenia i nowe hasło.
connectAuthEmulator(auth, url, options)	Zmienia instancję Auth, tak aby komunikowała się z Emulatorem uwierzytelniania Firebase, a nie z usługami uwierzytelniania Firebase.
createUserWithEmailAndPassword(uwierzytelnianie, adres e-mail, hasło)	Tworzy nowe konto użytkownika powiązane z określonym adresem e-mail i hasłem.
fetchSignInMethodsForEmail(auth, e-mail)	Pobiera listę możliwych metod logowania dla danego adresu e-mail. Ta metoda zwraca pustą listę, gdy włączona jest ochrona wyliczania e-maili, niezależnie od liczby metod uwierzytelniania dostępnych dla danego adresu e-mail.
getMultiFactor resolver(auth, error)	Udostępnia obiekt MultiFactorResolutionr odpowiedni do ukończenia procesu wielopoziomowego.
getRedirectResult(auth, resolver)	Zwraca wartość UserCredential z procesu logowania opartego na przekierowaniu.
initializeRecaptchaConfig(auth)	Wczytuje konfigurację reCAPTCHA do instancji Auth.
isSignInWithEmailLink(auth, emailLink)	Sprawdza, czy link przychodzący jest linkiem umożliwiającym zalogowanie się z adresem e-mail odpowiednim dla signInWithEmailLink().
onAuthStateChanged(auth, nextOrObserver, error, complete)	Dodaje obserwatora ds. zmian stanu logowania użytkownika.
onIdTokenChanged(auth, nextOrObserver, błąd, ukończono)	Dodaje obserwatora na potrzeby zmian w tokenie tożsamości zalogowanego użytkownika.
revokeAccessToken(auth, token)	Unieważnia dany token dostępu. Obecnie obsługuje tylko tokeny dostępu OAuth Apple.
sendPasswordResetEmail(auth, email, actionCodeSettings)	Wysyła wiadomość e-mail do zresetowania hasła na podany adres e-mail. Ta metoda nie powoduje błędu, jeśli nie ma konta użytkownika z podanym adresem e-mail i jest włączona ochrona wyliczania e-maili.
sendSignInLinkToEmail(auth, email, actionCodeSettings)	Wysyła do użytkownika link umożliwiający zalogowanie się z podanym adresem e-mail.
setPersistence(auth, trwałość)	Zmienia typ trwałości instancji Uwierzytelnianie dla obecnie zapisanej sesji Auth i stosuje ten typ trwałości w przypadku przyszłych żądań logowania, w tym logowania z żądaniami przekierowania.
logowanie anonimowe(uwierzytelnianie)	Asynchronicznie loguje się jako użytkownik anonimowy.
signInWithCredential(auth, credential)	Asynchronicznie loguje się przy użyciu podanych danych logowania.
signInWithCustomToken(auth, customToken)	Asynchronicznie loguje się przy użyciu tokena niestandardowego.
signInWithEmailAndPassword(uwierzytelnianie, e-mail, hasło)	Loguje się asynchronicznie przy użyciu adresu e-mail i hasła.
signInWithEmailLink(auth, email, emailLink)	Asynchronicznie loguje się przy użyciu adresu e-mail i linku e-mail logowania.
signInWithPhoneNumber(auth, phoneNumber, appVerifier)	Loguje się asynchronicznie za pomocą numeru telefonu.
signInWithPopup(auth, dostawca, resolver)	Uwierzytelnia klienta Firebase z użyciem procesu uwierzytelniania OAuth opartego na wyskakującym okienku.
signInWithRedirect(auth, Provider, resolver)	Uwierzytelnia klienta Firebase za pomocą procesu przekierowania całej strony.
signOut(auth)	Wylogowuje bieżącego użytkownika.
updateCurrentUser(uwierzytelnianie, użytkownik)	Asynchronicznie ustawia podanego użytkownika jako Auth.currentUser w instancji Auth.
useDeviceLanguage(auth)	Ustawia bieżący język na domyślne ustawienie urządzenia/przeglądarki.
validatePassword(uwierzytelnianie, hasło)	Weryfikuje hasło pod kątem zasad dotyczących haseł skonfigurowanych dla projektu lub najemcy.
verifyPasswordResetCode(auth, kod)	Sprawdza kod resetowania hasła, który został wysłany do użytkownika e-mailem lub w inny sposób spoza zespołu.
function(link, ...)
parseActionCodeURL(link)	Analizuje ciąg znaków linku do działania w e-mailu i zwraca wartość ActionCodeURL, jeśli link jest prawidłowy. W przeciwnym razie zwraca wartość null.
function(user, ...)
deleteUser(użytkownik)	Usuwa użytkownika i wylogowuje go.
getIdToken(użytkownik; forceRefresh)	Zwraca token internetowy JSON (JWT) używany do identyfikowania użytkownika w usłudze Firebase.
getIdTokenResult(użytkownik; forceRefresh)	Zwraca zdeserializowany token sieciowy JSON (JWT) używany do identyfikacji użytkownika w usłudze Firebase.
linkWithCredential(użytkownik, dane logowania)	Łączy konto użytkownika z podanymi danymi logowania.
linkWithPhoneNumber(użytkownik, phoneNumber, appVerifier)	Łączy konto użytkownika z podanym numerem telefonu.
linkWithPopup(użytkownik, dostawca, resolver)	Łączy uwierzytelnionego dostawcę z kontem użytkownika za pomocą procesu OAuth opartego na wyskakującym okienku.
linkWithRedirect(użytkownik, usługodawca, resolver)	Łączy parametr OAuthProvider z kontem użytkownika za pomocą procesu przekierowania na całą stronę.
multiFactor(użytkownik)	Wartość MultiFactorUser odpowiadający użytkownikowi.
reauthenticateWithCredential(użytkownik, dane logowania)	Ponownie uwierzytelnia użytkownika przy użyciu nowych danych logowania.
reauthenticateWithPhoneNumber(użytkownik, phoneNumber, appVerifier)	Ponownie uwierzytelnia użytkownika przy użyciu nowych danych logowania telefonu.
reauthenticateWithPopup(użytkownik, dostawca, resolver)	Ponownie uwierzytelnia bieżącego użytkownika za pomocą podanego dostawcy OAuthProvider, korzystając z procesu OAuth opartego na wyskakującym okienku.
reauthenticateWithRedirect(użytkownik, dostawca, resolver)	Ponownie uwierzytelnia bieżącego użytkownika za pomocą określonego dostawcy protokołu OAuthProvider, korzystając z procesu przekierowania na całą stronę.
reload(user)	Jeśli użytkownik się zaloguje, ponownie wczytuje dane konta użytkownika.
sendEmailverification(użytkownik, actionCodeSettings)	Wysyła do użytkownika e-maila weryfikacyjnego.
unlink(user, providerId)	Powoduje odłączenie dostawcy od konta użytkownika.
updateEmail(użytkownik; nowyEmail)	Aktualizuje adres e-mail użytkownika.
updatePassword(użytkownik, nowehasło)	aktualizuje hasło użytkownika.
updatePhoneNumber(użytkownik; dane logowania)	Aktualizuje numer telefonu użytkownika.
updateProfile(użytkownik, { displayName, photoURL: photoUrl })	Aktualizuje dane profilowe użytkownika.
verifyBeforeUpdateEmail(użytkownik, newEmail, actionCodeSettings)	Wysyła weryfikacyjną wiadomość e-mail na nowy adres e-mail.
function(userCredential, ...)
getAdditionalUserInfo(userCredential)	Wyodrębnia element AdditionalUserInfo specyficzny dla dostawcy dla określonych danych logowania.

Zajęcia

Klasa	Opis
URL kodu działania	Klasa narzędzia 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 (Dane uwierzytelniające)	Interfejs przedstawiający dane logowania zwracane przez dostawcę AuthProvider.
EmailAuthCredential (Dane logowania e-mail)	Interfejs przedstawiający dane logowania zwrócone przez EmailAuthProvider dla ProviderId.
EmailAuthProvider,	Dostawca do generowania danych EmailAuthCredential.
FacebookAuthProvider,	Dostawca do generowania OAuthCredential dla identyfikatora ProviderId.FACEBOOK.
GithubAuthProvider,	Dostawca do generowania OAuthCredential dla identyfikatora ProviderId.GITHUB.
GoogleAuthProvider,	Dostawca do generowania danych OAuthCredential dla identyfikatora ProviderId.GOOGLE.
OAuthCredential	Reprezentuje dane logowania OAuth zwracane przez dostawcę OAuthProvider.
OAuthProvider,	Dostawca do generowania ogólnego atrybutu OAuthCredential.
PhoneAuthCredential (Dane logowania PhoneAuthCredential)	Reprezentuje dane logowania zwrócone przez PhoneAuthProvider.
PhoneAuthProvider,	Dostawca do generowania PhoneAuthCredential.
PhoneMultiFactorGenerator	Dostawca do wygenerowania PhoneMultiFactorAssertion.
Weryfikacja reCAPTCHA	Weryfikator aplikacji oparty na reCAPTCHA.
SAMLAuthProvider,	AuthProvider dla SAML.
TotpMultiFactorGenerator	Dostawca do wygenerowania TotpMultiFactorAssertion.
TotpSecret,	Dostawca do generowania TotpMultiFactorAssertion.Przechowuje udostępniony klucz tajny i inne parametry w celu generowania haseł jednorazowych na podstawie czasu. implementuje metody pobierania udostępnionego tajnego klucza i generowania adresu URL kodu QR.
TwitterAuthProvider	Dostawca do generowania OAuthCredential dla identyfikatora ProviderId.TWITTER.

Interfejsy

Interfejs	Opis
ActionCodeInfo	Odpowiedź z metody checkActionCode().
ActionCodeSettings	Interfejs określający wymagany adres URL kontynuacji/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	Weryfikator do weryfikacji domeny i zapobiegania nadużyciom.
Uwierzytelnianie	Interfejs przedstawiający usługę uwierzytelniania Firebase.
Błąd uwierzytelniania	Interfejs błędu Auth.
AuthErrorMap	Mapowanie kodów błędów na komunikaty o błędach.
AuthProvider,	Interfejs reprezentujący dostawcę uwierzytelniania, który ułatwia tworzenie danych AuthCredential.
AuthSettings,	Interfejs reprezentujący ustawienia instancji Auth.
Konfiguracja	Interfejs reprezentujący konfigurację Auth.
ConfirmationResult (Wynik potwierdzenia)	wynik w wyniku zalogowania się na numer telefonu, utworzenia linku lub ponownego uwierzytelnienia połączenia.
Zależności	Zależności, których można użyć do zainicjowania instancji Auth.
EmulatorConfig	Konfiguracja emulatora uwierzytelniania Firebase.
IdTokenResult (Wynik tokena)	Interfejs przedstawiający wynik tokena identyfikatora uzyskany z User.getIdTokenResult().
Assertion wieloskładnikowy	Klasa podstawowa do zgłaszania własności drugiego składnika.
Błąd wieloskładnikowy	Błąd wyświetlany, gdy użytkownik musi podać drugi składnik, aby można było się zalogować.
MultiFactorInfo	Struktura zawierająca informacje o jednostce drugiego składnika.
Program do rozpoznawania czynników wieloskładnikowych	Klasa używana do odzyskiwania po wystąpieniu MultiFactorError, gdy użytkownik musi podać drugi składnik logowania, aby się zalogować.
Sesja wieloskładnikowa	Interfejs określający obiekt sesji wielopoziomowej używany do rejestracji drugiego składnika u użytkownika lub do pomocy przy logowaniu zarejestrowanego użytkownika przy użyciu drugiego składnika.
Użytkownik wieloskładnikowy	Interfejs określający właściwości i operacje związane z wielopoziomowymi elementami, które dotyczą użytkownika.
OAuthCredentialOptions	Określa opcje inicjowania OAuthCredential.
ParsedToken	Interfejs przedstawiający przeanalizowany token tożsamości.
Zasady dotyczące haseł	Struktura określająca wymagania dotyczące haseł.
PasswordValidationStatus (Stan sprawdzania hasła)	Struktura wskazująca, które zasady dotyczące haseł zostały spełnione lub naruszone, a także jakie wymagania należy spełnić.
Wytrwałość	Interfejs przedstawiający możliwe typy mechanizmów trwałości.
PhoneMultiFactorAssertion	Klasa potwierdzania własności drugiego składnika telefonu. Udostępnione przez PhoneMultiFactorGenerator.assertion().
PhoneMultiFactorRegistrationInfoOptions	Opcje używane do rejestracji drugiego składnika.
PhoneMultiFactorInfo	Podklasa interfejsu MultiFactorInfo dla drugiego składnika 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 w przypadku logowania jednokrotnego.
PopupRedirectRedirectr	resolver używany do obsługi operacji specyficznych dla DOM, takich jak signInWithPopup() lub signInWithRedirect().
ReactNativeAsyncStorage.	Interfejs dostarczonego zasobu AsyncStorage.
Parametry reCAPTCHA	Interfejs przedstawiający parametry reCAPTCHA.Listę akceptowanych parametrów znajdziesz w dokumentacji reCAPTCHA. Akceptowane są wszystkie parametry oprócz sitekey: Uwierzytelnianie Firebase udostępnia reCAPTCHA dla każdego projektu i konfiguruje klucz witryny podczas renderowania.W przypadku niewidocznego reCAPTCHA ustaw klucz size na invisible.
TotpMultiFactorAssertion	Klasa 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 (Dane logowania użytkownika)	Struktura zawierająca User, OperationType oraz identyfikator dostawcy.
Informacje o użytkowniku	Informacje z profilu użytkownika widoczne tylko dla aplikacji projektu Firebase.
UserMetadata	Interfejs przedstawiający metadane użytkownika.

Zmienne

Zmienna	Opis
Działanie kodu akcji	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ównanie z błędami zgłaszanymi przez pakiet SDK.
browserLocalPersistence,	Implementacja trwałości typu LOCAL z wykorzystaniem localStorage dla bazowego miejsca na dane.
browserPopupRedirectAnswerr	Implementacja obiektu PopupRedirectAnswerr odpowiedniego dla aplikacji opartych na przeglądarce.
browserSessionPersistence,	Implementacja trwałości wartości SESSION z wykorzystaniem sessionStorage dla bazowego miejsca na dane.
cordovaPopupRedirectAnswerr	Implementacja klasy PopupRedirectUpgrader odpowiedniej dla aplikacji opartych na 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
Identyfikator procesu	Enum czynników, które mogą być używane do uwierzytelniania wielopoziomowego.
indexedDBLocalPersistence	Implementacja trwałości typu LOCAL z wykorzystaniem indexedDB dla bazowego miejsca na dane.
inMemoryPersistence,	Implementacja atrybutu Persistence typu „NONE”.
Typ operacji	Lista obsługiwanych typów operacji.
prodErrorMap	Minimalna mapa błędów z usuniętymi wszystkimi szczegółowymi komunikatami o błędach.Zobacz dyskusję na stronie AuthErrorMap
Identyfikator dostawcy	Lista obsługiwanych dostawców.
SignInMethod (Metoda logowania)	Lista obsługiwanych metod logowania.

Aliasy typu

Wpisz alias	Opis
Parametry niestandardowe	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 na stronie AdditionalUserInfo.

funkcja(aplikacja, ...)

getAuth(aplikacja)

Zwraca wystąpienie Auth powiązane z podaną aplikacją FirebaseApp. Jeśli nie ma żadnej instancji, inicjuje instancję uwierzytelniania z domyślnymi zależnościami na poszczególnych platformach.

Podpis:

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

Parametry

Parametr	Typ	Opis
aplikacja	Aplikacja Firebase	Aplikacja Firebase.

Zwroty:

Uwierzytelnianie

firstizeAuth(aplikacja, deps)

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

Ta funkcja zapewnia większą kontrolę nad instancją Auth w porównaniu z funkcją getAuth(). getAuth wykorzystuje ustawienia domyślne platformy do dostarczania zależności. Ogólnie rzecz biorąc, najłatwiejszym sposobem na zainicjowanie uwierzytelniania jest getAuth, który sprawdza się w większości przypadków. Użyj funkcji 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 Twoja aplikacja korzysta tylko z kont anonimowych i chcesz, żeby na potrzeby bieżącej sesji były zapisywane tylko konta, 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	Aplikacja Firebase
depsy	Zależności

Zwroty:

Uwierzytelnianie

funkcja(miejsce na dane, ...)

getReactNativePersistence(miejsce na dane)

Zwraca obiekt trwałości, który opakowuje obiekt AsyncStorage zaimportowany z metody react-native lub @react-native-community/async-storage i może zostać użyty 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:

Wytrwałość

function(auth, ...)

applyActionCode(auth, oobCode)

Stosuje kod weryfikacyjny wysłany do użytkownika e-mailem lub w inny sposób spoza zakresu.

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.
Kod OobCode	ciąg znaków	Kod weryfikacyjny wysłany do użytkownika.

Zwroty:

Obietnica<void>

beforeAuthStateChanged(uwierzytelnianie, wywołanie zwrotne, onAbort)

Dodaje blokujące wywołanie zwrotne, które jest uruchamiane, 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	(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:

Anuluj subskrypcję

checkActionCode(auth, oobCode)

Sprawdza kod weryfikacyjny wysłany do użytkownika e-mailem lub w inny sposób spoza zespołu.

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.
Kod OobCode	ciąg znaków	Kod weryfikacyjny wysłany do użytkownika.

Zwroty:

Obietnica<ActionCodeInfo>

metadanych dotyczących kodu.

confirmPasswordReset(auth, oobCode, newPassword)

Kończy proces resetowania hasła, otrzymując kod potwierdzenia i nowe hasło.

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.
Kod OobCode	ciąg znaków	Kod potwierdzenia wysłany do użytkownika.
noweHasło	ciąg znaków	Nowe hasło.

Zwroty:

Obietnica<void>

ConnectAuthEmulator(uwierzytelnianie, adres URL, opcje)

Zmienia instancję Auth, tak aby komunikowała się z Emulatorem uwierzytelniania Firebase, a nie z usługami uwierzytelniania Firebase.

Ta metoda musi być wywoływana synchronicznie bezpośrednio po pierwszym wywołaniu metody initializeAuth(). Nie używaj produkcyjnych danych logowania, ponieważ ruch emulatora 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 (adres URL)	ciąg znaków	Adres URL, pod którym działa emulator (np. „http://localhost:9099”).
opcje	{disableWARNINGs: boolean;	Opcjonalnie. options.disableWarnings ma domyślną wartość false. Aby wyłączyć baner ostrzegawczy dołączony do DOM, ustaw wartość true.

Zwroty:

nieważne

Przykład

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

createUserWithEmailAndPassword(uwierzytelnianie, adres e-mail, hasło)

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

Po utworzeniu konta użytkownika ten użytkownik zostanie również 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 za pomocą FirebaseServerApp.

Uwaga: adres e-mail pełni funkcję unikalnego identyfikatora użytkownika i umożliwia resetowanie hasła za pomocą adresu e-mail. Ta funkcja utworzy nowe konto użytkownika i ustawi początkowe hasło użytkownika.

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.
e-mail	ciąg znaków	Adres e-mail użytkownika.
hasło	ciąg znaków	Wybrane hasło użytkownika.

Zwroty:

Obietnica<UserCredential>

downloadSignInMethodsForEmail(auth, e-mail)

Pobiera listę możliwych metod logowania dla danego adresu e-mail. Ta metoda zwraca pustą listę, gdy włączona jest ochrona wyliczania e-maili, niezależnie od liczby metod uwierzytelniania dostępnych dla danego adresu e-mail.

Przydaje się to do rozróżniania metod logowania w przypadku tego samego dostawcy, np. EmailAuthProvider, który udostępnia 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	ciąg znaków	Adres e-mail użytkownika.Wycofano. Zalecamy migrację z tej metody jako jedną ze sprawdzonych metod dotyczących bezpieczeństwa. Więcej informacji znajdziesz w dokumentacji Identity Platform dotyczącej ochrony wyliczania adresów e-mail.

Zwroty:

Promise&lt;string[]&gt;

getMultiFactor resolver(auth; błąd)

Udostępnia obiekt MultiFactorResolutionr odpowiedni do ukończenia procesu wielopoziomowego.

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.
błąd	Błąd wieloskładnikowy	MultiFactorError zgłoszony podczas logowania lub ponownego uwierzytelniania.

Zwroty:

Program do rozpoznawania czynników wieloskładnikowych

getRedirectResult(auth, resolver)

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

Jeśli logowanie się udało, zwraca nazwę zalogowanego użytkownika. Jeśli logowanie się nie powiedzie, wyświetli się błąd. Jeśli nie została wywołana żadna operacja przekierowania, zwraca null.

Ta metoda nie działa w środowisku Node.js ani w instancjach Auth utworzonych za pomocą FirebaseServerApp.

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.
resolver	PopupRedirectRedirectr	Wystąpienie PopupRedirectAnswerr (opcjonalne, jeśli zostało już podane w metodzie initializeAuth() lub udostępnione przez funkcję getAuth().

Zwroty:

Obietnica<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;

inicjujRecaptchaConfig(auth)

Wczytuje konfigurację reCAPTCHA do instancji Auth.

Spowoduje to wczytanie konfiguracji reCAPTCHA, która wskazuje, czy należy aktywować przepływ weryfikacji reCAPTCHA dla każdego dostawcy uwierzytelniania do bieżącej sesji uwierzytelniania.

Jeśli nie zostanie wywołana inicjalizacjaRecaptchaConfig(), proces uwierzytelniania będzie się zawsze rozpoczynał bez weryfikacji reCAPTCHA. Jeśli dostawca jest skonfigurowany tak, aby wymagał weryfikacji reCAPTCHA, pakiet SDK w przejrzysty sposób załaduje konfigurację reCAPTCHA i ponownie uruchomi przepływy uwierzytelniania.

Dzięki temu dzięki wywołaniu tej opcjonalnej metody zredukujesz czas oczekiwania w przyszłych przepływach uwierzytelniania. Wczesne wczytanie konfiguracji reCAPTCHA wzmacnia 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:

Obietnica<void>

Przykład

initializeRecaptchaConfig(auth);

isSignInWithEmailLink(auth, emailLink)

Sprawdza, czy link przychodzący jest linkiem umożliwiającym zalogowanie się z adresem e-mail odpowiednim dla signInWithEmailLink().

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.
Link do e-maila	ciąg znaków	Link został wysłany na adres e-mail użytkownika.

Zwroty:

wartość logiczna

onAuthStateChanged(uwierzytelnianie, nextOrObserver, błąd, ukończono)

Dodaje obserwatora ds. zmian stanu logowania użytkownika.

Aby zachować poprzedni sposób działania, zobacz 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 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:

Anuluj subskrypcję

onIdTokenChanged(auth, nextOrObserver, błąd, ukończono)

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. Nie zostanie ono uruchomione automatycznie po wygaśnięciu tokena tożsamości. Użyj metody 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 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:

Anuluj subskrypcję

cancelAccessToken(auth, token)

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

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.
token	ciąg znaków	Token dostępu protokołu OAuth Apple.

Zwroty:

Obietnica<void>

sendPasswordResetEmail(auth, email, actionCodeSettings)

Wysyła wiadomość e-mail do zresetowania hasła na podany adres e-mail. Ta metoda nie powoduje błędu, jeśli nie ma konta użytkownika z podanym adresem e-mail i jest włączona ochrona wyliczania e-maili.

Aby dokończyć resetowanie hasła, wywołaj metodę confirmPasswordReset(), podając 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	ciąg znaków	Adres e-mail użytkownika.
Ustawienia kodu akcji	ActionCodeSettings	ActionCodeSettings.

Zwroty:

Obietnica<void>

Przykład

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

sendSignInLinkToEmail(auth, email, actionCodeSettings)

Wysyła do użytkownika link umożliwiający zalogowanie się z podanym adresem e-mail.

Operacja logowania musi być zawsze wykonywana w aplikacji, w przeciwieństwie do innych pozapasmowych działań związanych z pocztą e-mail (resetowanie hasła i potwierdzanie adresu e-mail). Dzieje się tak, ponieważ na koniec procesu użytkownik powinien być zalogowany, a jego stan uwierzytelniania zachowa się w aplikacji.

Aby dokończyć logowanie za pomocą linku z e-maila, wywołaj signInWithEmailLink(), podając adres e-mail i link e-mail 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	ciąg znaków	Adres e-mail użytkownika.
Ustawienia kodu akcji	ActionCodeSettings	ActionCodeSettings.

Zwroty:

Obietnica<void>

Przykład

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

setPersistence(uwierzytelnianie, trwałość)

Zmienia typ trwałości instancji Uwierzytelnianie dla obecnie zapisanej sesji Auth i stosuje 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 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 za pomocą FirebaseServerApp.

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.
trwałość	Wytrwałość	Trwałość do użycia.

Zwroty:

Obietnica<void>

Promise, który rozwiązuje się po zakończeniu zmiany trwałości

Przykład

setPersistence(auth, browserSessionPersistence);

Logowanie anonimowe(uwierzytelnianie)

Asynchronicznie loguje się jako użytkownik anonimowy.

Jeśli zalogował się już 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 za pomocą FirebaseServerApp.

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.

Zwroty:

Obietnica<UserCredential>

signInWithCredential(auth, dane logowania)

Asynchronicznie loguje się przy użyciu podanych danych logowania.

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

Ta metoda nie jest obsługiwana w instancjach Auth utworzonych za pomocą FirebaseServerApp.

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.
certyfikat	AuthCredential (Dane uwierzytelniające)	Dane uwierzytelniające.

Zwroty:

Obietnica<UserCredential>

signInWithCustomToken(auth; customToken)

Asynchronicznie loguje się przy użyciu tokena niestandardowego.

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

Pojawi się błąd, jeśli token jest nieprawidłowy, wygasł lub nie został zaakceptowany przez usługę Uwierzytelnianie Firebase.

Ta metoda nie jest obsługiwana w instancjach Auth utworzonych za pomocą FirebaseServerApp.

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.
token niestandardowy	ciąg znaków	Niestandardowy token do logowania.

Zwroty:

Obietnica<UserCredential>

signInWithEmailAndPassword(uwierzytelnianie, e-mail, hasło)

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

Jeśli adres e-mail i hasło nie pasują do siebie, pojawia się błąd. Gdy włączona jest ochrona wyliczania e-maili, ta metoda kończy się niepowodzeniem i wyświetla się błąd „auth/invalid-credential” w przypadku nieprawidłowego adresu e-mail lub hasła.

Ta metoda nie jest obsługiwana w instancjach Auth utworzonych za pomocą FirebaseServerApp.

Uwaga: hasło użytkownika NIE jest hasłem używanym do uzyskiwania dostępu do konta e-mail użytkownika. Adres e-mail jest unikalnym identyfikatorem użytkownika, a hasło umożliwia dostęp do konta użytkownika w projekcie Firebase. Zobacz też: createUserWithEmailAndPassword().

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.
e-mail	ciąg znaków	Adres e-mail użytkownika.
hasło	ciąg znaków	Hasło użytkownika.

Zwroty:

Obietnica<UserCredential>

signInWithEmailLink(auth, email, emailLink)

Asynchronicznie loguje się przy użyciu adresu e-mail i linku e-mail logowania.

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

Wyświetla się błąd, jeśli adres e-mail jest nieprawidłowy lub hasło jednorazowe w linku e-mail wygasa.

Ta metoda nie jest obsługiwana w instancjach Auth utworzonych za pomocą FirebaseServerApp.

Uwaga: zanim wywołasz tę metodę firebase.auth.Auth.isSignInWithEmailLink, potwierdź, że link to link z e-mailem logowania.

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.
e-mail	ciąg znaków	Adres e-mail użytkownika.
Link do e-maila	ciąg znaków	Link został wysłany na adres e-mail użytkownika.

Zwroty:

Obietnica<UserCredential>

Przykład

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

signInWithPhoneNumber(uwierzytelnianie, numer telefonu, weryfikacja aplikacji)

Loguje się asynchronicznie za pomocą numeru telefonu.

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

Aby zapobiegać nadużyciom, ta metoda wymaga też parametru ApplicationVerifier. Ten pakiet SDK zawiera implementację opartą na reCAPTCHA – RecaptchaVerifier. Może ona działać na innych platformach, które nie obsługują narzędzia RecaptchaVerifier (np. React Native), ale musisz skorzystać z implementacji ApplicationVerifier innej firmy.

Ta metoda nie działa w środowisku Node.js ani w instancjach Auth utworzonych za pomocą FirebaseServerApp.

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.
numer telefonu	ciąg znaków	Numer telefonu użytkownika w formacie E.164 (np. [phone]).
weryfikator aplikacji	ApplicationVerifier	ApplicationVerifier.

Zwroty:

Obietnica<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, dostawca, resolver)

Uwierzytelnia klienta Firebase z użyciem procesu uwierzytelniania OAuth opartego na wyskakującym okienku.

Jeśli proces się powiedzie, zwraca zalogowanego użytkownika razem z danymi logowania dostawcy. Jeśli logowanie się nie powiodło, zwraca obiekt błędu zawierający dodatkowe informacje o błędzie.

Ta metoda nie działa w środowisku Node.js ani w instancjach Auth utworzonych za pomocą FirebaseServerApp.

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.
dostawca	AuthProvider,	Dostawca do uwierzytelnienia. Dostawca musi być obiektem OAuthProvider. Dostawcy inni niż OAuth, tacy jak EmailAuthProvider, zgłosi błąd.
resolver	PopupRedirectRedirectr	Wystąpienie PopupRedirectAnswerr (opcjonalne, jeśli zostało już podane w metodzie initializeAuth() lub udostępnione przez funkcję getAuth().

Zwroty:

Obietnica<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(uwierzytelnianie, dostawca, resolver)

Uwierzytelnia klienta Firebase za pomocą procesu przekierowania całej strony.

Informacje o obsłudze wyników i błędów tej operacji znajdziesz w sekcji 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 za pomocą FirebaseServerApp.

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.
dostawca	AuthProvider,	Dostawca do uwierzytelnienia. Dostawca musi być obiektem OAuthProvider. Dostawcy inni niż OAuth, tacy jak EmailAuthProvider, zgłosi błąd.
resolver	PopupRedirectRedirectr	Wystąpienie PopupRedirectAnswerr (opcjonalne, jeśli zostało już podane w metodzie initializeAuth() lub udostępnione przez funkcję getAuth().

Zwroty:

Obietnica<nigdy>

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;

wylogowanie(uwierzytelnianie)

Wylogowuje bieżącego użytkownika.

Ta metoda nie jest obsługiwana w instancjach Auth utworzonych za pomocą FirebaseServerApp.

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.

Zwroty:

Obietnica<void>

updateCurrentUser(uwierzytelnianie, użytkownik)

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 onAuthStateChanged() i 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.

Ta metoda nie jest obsługiwana w instancjach Auth utworzonych za pomocą 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 | wartość null	Nowy Użytkownik.

Zwroty:

Obietnica<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:

nieważne

validatePassword(auth; hasło)

Weryfikuje hasło pod kątem zasad dotyczących haseł skonfigurowanych dla projektu lub najemcy.

Jeśli w instancji Auth nie ustawiono identyfikatora najemcy, ta metoda będzie używać zasad dotyczących haseł skonfigurowanych dla projektu. W przeciwnym razie ta metoda będzie używać zasady skonfigurowanej 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ń dotyczących haseł, a ta metoda została wcześniej wywołana, przy ponownym wywołaniu ta metoda użyje 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	ciąg znaków	Hasło do weryfikacji.

Zwroty:

Obietnica<PasswordValidationStatus>

Przykład

validatePassword(auth, 'some-password');

VerifyPasswordResetCode(uwierzytelnianie, kod)

Sprawdza kod resetowania hasła, który został wysłany do użytkownika e-mailem lub w inny sposób spoza zespołu.

Podpis:

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

Parametry

Parametr	Typ	Opis
uwierzytelnienie	Uwierzytelnianie	instancja Auth.
kod	ciąg znaków	Kod weryfikacyjny wysłany do użytkownika.

Zwroty:

Obietnica<ciąg>

(jeśli jest prawidłowy).

funkcja(link, ...)

parseActionCodeURL(link)

Analizuje ciąg znaków linku do działania w e-mailu 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	ciąg znaków

Zwroty:

ActionCodeURL | wartość null

funkcja(użytkownik, ...)

deleteUser(użytkownik)

Usuwa użytkownika i wylogowuje go.

Ważne: jest to operacja związana z bezpieczeństwem, którą użytkownik musi niedawno zalogować. Jeśli to wymaganie nie jest spełnione, poproś użytkownika o ponowne uwierzytelnienie, a następnie wywołaj reauthenticateWithCredential().

Podpis:

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

Parametry

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

Zwroty:

Obietnica<void>

getIdToken(użytkownik; forceRefresh)

Zwraca token internetowy JSON (JWT) używany do identyfikowania użytkownika w usłudze Firebase.

Zwraca bieżący token, jeśli jeszcze nie wygasł lub nie wygaśnie w ciągu najbliższych 5 minut. W przeciwnym razie spowoduje to odświeżenie tokena i zwrócenie nowego.

Podpis:

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

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	Użytkownik.
wymuszanie odświeżania	wartość logiczna	Wymuszaj odświeżanie niezależnie od daty wygaśnięcia tokena.

Zwroty:

Obietnica<ciąg>

getIdTokenResult(użytkownik; forceRefresh)

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

Zwraca bieżący token, jeśli jeszcze nie wygasł lub nie wygaśnie w ciągu najbliższych 5 minut. W przeciwnym razie spowoduje to odświeżenie tokena i zwrócenie nowego.

Podpis:

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

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	Użytkownik.
wymuszanie odświeżania	wartość logiczna	Wymuszaj odświeżanie niezależnie od daty wygaśnięcia tokena.

Zwroty:

Obietnica<IdTokenResult>

linkWithCredential(użytkownik; dane logowania)

Łą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żytkownik.
certyfikat	AuthCredential (Dane uwierzytelniające)	Dane uwierzytelniające.

Zwroty:

Obietnica<UserCredential>

linkWithPhoneNumber(użytkownik; 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żytkownik.
numer telefonu	ciąg znaków	Numer telefonu użytkownika w formacie E.164 (np. [phone]).
weryfikator aplikacji	ApplicationVerifier	ApplicationVerifier.

Zwroty:

Obietnica<ConfirmationResult>

linkWithPopup(użytkownik, dostawca, resolver)

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

Jeśli połączenie się powiedzie, zwrócony wynik będzie zawierał dane logowania użytkownika i 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żytkownik.
dostawca	AuthProvider,	Dostawca do uwierzytelnienia. Dostawca musi być obiektem OAuthProvider. Dostawcy inni niż OAuth, tacy jak EmailAuthProvider, zgłosi błąd.
resolver	PopupRedirectRedirectr	Wystąpienie PopupRedirectAnswerr (opcjonalne, jeśli zostało już podane w metodzie initializeAuth() lub udostępnione przez funkcję getAuth().

Zwroty:

Obietnica<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(użytkownik, dostawca, resolver)

Łączy parametr OAuthProvider z kontem użytkownika za pomocą procesu przekierowania na całą stronę.

Informacje o obsłudze wyników i błędów tej operacji znajdziesz w sekcji 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 za pomocą FirebaseServerApp.

Podpis:

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

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	Użytkownik.
dostawca	AuthProvider,	Dostawca do uwierzytelnienia. Dostawca musi być obiektem OAuthProvider. Dostawcy inni niż OAuth, tacy jak EmailAuthProvider, zgłosi błąd.
resolver	PopupRedirectRedirectr	Wystąpienie PopupRedirectAnswerr (opcjonalne, jeśli zostało już podane w metodzie initializeAuth() lub udostępnione przez funkcję getAuth().

Zwroty:

Obietnica<nigdy>

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);

wieloskładnikowy(użytkownik)

Wartość MultiFactorUser odpowiadający użytkownikowi.

Służy on do uzyskiwania dostępu do wszystkich właściwości wielopoziomowych i operacji związanych z użytkownikiem.

Podpis:

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

Parametry

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

Zwroty:

Użytkownik wieloskładnikowy

reauthenticateWithCredential(użytkownik, dane logowania)

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żyć do naprawienia błędu CREDENTIAL_TOO_OLD_LOGIN_AGAIN lub TOKEN_EXPIRED.

Ta metoda nie jest obsługiwana w przypadku instancji User zalogowanych przez instancje Auth utworzone za pomocą FirebaseServerApp.

Podpis:

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

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	Użytkownik.
certyfikat	AuthCredential (Dane uwierzytelniające)	Dane uwierzytelniające.

Zwroty:

Obietnica<UserCredential>

reauthenticateWithPhoneNumber(użytkownik; phoneNumber; appVerifier)

Ponownie uwierzytelnia użytkownika przy użyciu nowych danych logowania 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 przypadku użytkowników zalogowanych w instancjach Auth utworzonych za pomocą FirebaseServerApp.

Podpis:

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

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	Użytkownik.
numer telefonu	ciąg znaków	Numer telefonu użytkownika w formacie E.164 (np. [phone]).
weryfikator aplikacji	ApplicationVerifier	ApplicationVerifier.

Zwroty:

Obietnica<ConfirmationResult>

reauthenticateWithPopup(użytkownik, dostawca, resolver)

Ponownie uwierzytelnia bieżącego użytkownika za pomocą podanego dostawcy OAuthProvider, korzystając z procesu OAuth opartego na wyskakującym okienku.

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

Ta metoda nie działa w środowisku Node.js ani w przypadku użytkowników zalogowanych w instancjach Auth utworzonych za pomocą FirebaseServerApp.

Podpis:

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

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	Użytkownik.
dostawca	AuthProvider,	Dostawca do uwierzytelnienia. Dostawca musi być obiektem OAuthProvider. Dostawcy inni niż OAuth, tacy jak EmailAuthProvider, zgłosi błąd.
resolver	PopupRedirectRedirectr	Wystąpienie PopupRedirectAnswerr (opcjonalne, jeśli zostało już podane w metodzie initializeAuth() lub udostępnione przez funkcję getAuth().

Zwroty:

Obietnica<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(użytkownik, dostawca, resolver)

Ponownie uwierzytelnia bieżącego użytkownika za pomocą określonego dostawcy protokołu OAuthProvider, korzystając z procesu przekierowania na całą stronę.

Informacje o obsłudze wyników i błędów tej operacji znajdziesz w sekcji 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 za pomocą FirebaseServerApp.

Podpis:

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

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	Użytkownik.
dostawca	AuthProvider,	Dostawca do uwierzytelnienia. Dostawca musi być obiektem OAuthProvider. Dostawcy inni niż OAuth, tacy jak EmailAuthProvider, zgłosi błąd.
resolver	PopupRedirectRedirectr	Wystąpienie PopupRedirectAnswerr (opcjonalne, jeśli zostało już podane w metodzie initializeAuth() lub udostępnione przez funkcję getAuth().

Zwroty:

Obietnica<nigdy>

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);

odśwież(użytkownik)

Jeśli użytkownik się zaloguje, ponownie wczytuje dane konta użytkownika.

Podpis:

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

Parametry

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

Zwroty:

Obietnica<void>

sendEmailverification(użytkownik; 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żytkownik.
Ustawienia kodu akcji	ActionCodeSettings | wartość null	ActionCodeSettings.

Zwroty:

Obietnica<void>

Przykład

const actionCodeSettings = {
  url: 'https://www.example.com/?email=[e-mail]',
  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);

odłącz(użytkownik, identyfikator dostawcy)

Powoduje odłączenie dostawcy od konta użytkownika.

Podpis:

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

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	Użytkownik.
Identyfikator dostawcy	ciąg znaków	Dostawca, który chcesz odłączyć.

Zwroty:

Obietnica<Użytkownik>

updateEmail(użytkownik; nowyEmail)

Aktualizuje adres e-mail użytkownika.

Na pierwotny adres e-mail (jeśli został ustawiony) zostanie wysłany e-mail umożliwiający cofnięcie zmiany adresu w celu zabezpieczenia konta przed przejęciem.

Ta metoda nie jest obsługiwana w przypadku instancji User zalogowanych przez instancje Auth utworzone za pomocą FirebaseServerApp.

Ważne: jest to operacja związana z bezpieczeństwem, którą użytkownik musi niedawno zalogować. Jeśli to wymaganie nie jest spełnione, poproś użytkownika o ponowne uwierzytelnienie, a następnie wywołaj reauthenticateWithCredential().

Podpis:

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

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	Użytkownik.
nowyAdres e-mail	ciąg znaków	Nowy adres e-mail.zwraca „auth/operation-not-allowed” jest wyświetlany, gdy włączona jest ochrona wyliczania e-maili. Wycofane – użyj metody verifyBeforeUpdateEmail().

Zwroty:

Obietnica<void>

updatePassword(użytkownik, nowehasło)

aktualizuje hasło użytkownika.

Ważne: jest to operacja związana z bezpieczeństwem, którą użytkownik musi niedawno zalogować. Jeśli to wymaganie nie jest spełnione, poproś użytkownika o ponowne uwierzytelnienie, a następnie wywołaj reauthenticateWithCredential().

Podpis:

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

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	Użytkownik.
noweHasło	ciąg znaków	Nowe hasło.

Zwroty:

Obietnica<void>

updatePhoneNumber(użytkownik; dane logowania)

Aktualizuje numer telefonu użytkownika.

Ta metoda nie działa w środowisku Node.js ani w przypadku użytkowników zalogowanych w instancjach Auth utworzonych za pomocą FirebaseServerApp.

Podpis:

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

Parametry

Parametr	Typ	Opis
użytkownik	Użytkownik	Użytkownik.
certyfikat	PhoneAuthCredential (Dane logowania PhoneAuthCredential)	Dane logowania do uwierzytelniania nowego numeru telefonu.

Zwroty:

Obietnica<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('[phone]', applicationVerifier);
// Obtain the verificationCode from the user.
const phoneCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
await updatePhoneNumber(user, phoneCredential);

updateProfile(użytkownik, { 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żytkownik.
{ displayName, photoURL: photoUrl }	{ displayName?: string | null; photoURL?: ciąg znaków | null;

Zwroty:

Obietnica<void>

VerifyBeforeUpdateEmail(użytkownik, newEmail, actionCodeSettings)

Wysyła weryfikacyjną wiadomość e-mail na nowy adres e-mail.

Po zweryfikowaniu adres e-mail użytkownika zostanie zmieniony na nowy.

Jeśli masz niestandardowy moduł obsługi działań związanych z pocztą e-mail, możesz ukoń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żytkownik.
nowyAdres e-mail	ciąg znaków	Nowy adres e-mail do zweryfikowania przed aktualizacją.
Ustawienia kodu akcji	ActionCodeSettings | wartość null	ActionCodeSettings.

Zwroty:

Obietnica<void>

Przykład

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

function(userCredential, ...)

getAdditionalUserInfo(userCredential)

Wyodrębnia element AdditionalUserInfo specyficzny dla dostawcy dla określonych danych logowania.

Podpis:

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

Parametry

Parametr	Typ	Opis
userCredential	UserCredential (Dane logowania użytkownika)	Dane logowania użytkownika.

Zwroty:

AdditionalUserInfo | wartość null

Operacja na kodzie działania

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";
}

Kody błędów Auth

Mapa potencjalnych kodów błędów Auth, która ułatwia porównanie z błędami zgłaszanymi przez pakiet SDK.

Pamiętaj, że nie można potrząsać poszczególnymi klawiszami na mapie, więc korzystanie z tej 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";
}

przeglądarkaLocalPersistence

Implementacja trwałości typu LOCAL z wykorzystaniem localStorage dla bazowego miejsca na dane.

Podpis:

browserLocalPersistence: Persistence

Program do rozwiązywania problemów z przekierowaniem pop-up

Implementacja obiektu PopupRedirectAnswerr odpowiedniego dla aplikacji opartych na przeglądarce.

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

Podpis:

browserPopupRedirectResolver: PopupRedirectResolver

Czas trwania sesji przeglądarki

Implementacja trwałości wartości SESSION z wykorzystaniem sessionStorage dla bazowego miejsca na dane.

Podpis:

browserSessionPersistence: Persistence

cordovaPopupRedirectRedirectr

Implementacja klasy PopupRedirectUpgrader odpowiedniej dla aplikacji opartych na 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

Identyfikator czynnika

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

Podpis:

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

zindeksowana DBLocalPersistence

Implementacja trwałości typu LOCAL z wykorzystaniem indexedDB dla bazowego miejsca na dane.

Podpis:

indexedDBLocalPersistence: Persistence

Trwałość pamięci

Implementacja atrybutu Persistence typu „NONE”.

Podpis:

inMemoryPersistence: Persistence

OperationType

Lista 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

Identyfikator dostawcy

Lista 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";
}

Metoda logowania

Lista 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";
}

Parametry niestandardowe

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>;

Opcje informacji o telefonie

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

Wymagane informacje zależą od tego, czy korzystasz z logowania jednoskładnikowego, rejestracji wielopoziomowego czy logowania wielopoziomowego.

Podpis:

export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;

UserProfile

Profil użytkownika używany na stronie AdditionalUserInfo.

Podpis:

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