auth package

Firebase Authentication

İşlevler

İşlev Açıklama
function(uygulama; ...)
getAuth(app) Sağlanan FirebaseApp ile ilişkili Auth örneğini döndürür. Örnek yoksa platforma özgü varsayılan bağımlılıklara sahip bir Auth örneği başlatır.
initializeAuth(app, deps) Bağımlılıklar üzerinde ayrıntılı denetime sahip bir Auth örneği başlatır.
function(storage, ...)
getReactNativePersistence(storage) react-native veya @react-native-community/async-storage kaynağından içe aktarılan AsyncStorage öğesini sarmalayan bir kalıcılık nesnesi döndürür ve initializeAuth() işlevindeki kalıcılık bağımlılık alanında kullanılabilir.
function(auth, ...)
applyActionCode(auth, oobCode) Kullanıcıya e-posta veya bant dışı başka bir mekanizma ile gönderilen doğrulama kodunu uygular.
beforeAuthStateChanged(auth, callback, onAbort) Bir yetkilendirme durumu değişikliği yeni bir kullanıcıyı ayarlamadan önce çalışan bir engelleme geri çağırması ekler.
checkActionCode(auth, oobCode) Kullanıcıya e-postayla veya bant dışı başka bir mekanizma ile gönderilen doğrulama kodunu kontrol eder.
confirmPasswordReset(auth, oobCode, newPassword) Verilen onay kodu ve yeni şifreyle şifre sıfırlama işlemini tamamlar.
connectAuthEmulator(auth, url, options) Auth örneğini, üretim Firebase Auth hizmetleri yerine Firebase Auth Emulator ile iletişim kuracak şekilde değiştirir.
createUserWithEmailAndPassword(auth, email, password) Belirtilen e-posta adresi ve şifreyle ilişkilendirilmiş yeni bir kullanıcı hesabı oluşturur.
fetchSignInMethodsForEmail(auth, email) Belirtilen e-posta adresi için olası oturum açma yöntemlerinin listesini alır. Bu yöntem, [E-posta Sıralama Koruması](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) etkinleştirildiğinde boş bir liste döndürür. Söz konusu e-posta için kullanılabilen kimlik doğrulama yöntemlerinin sayısı önemli değildir.
getMultiFactorResolver(auth, error) Çok öğeli bir akışın tamamlanmasına uygun bir MultiFactorResolver sağlar.
getRedirectResult(auth, resolver) Yönlendirme tabanlı oturum açma akışından bir UserCredential döndürür.
initializeRecaptchaConfig(auth) reCAPTCHA yapılandırmasını Auth örneğine yükler.
isSignInWithEmailLink(auth, emailLink) Gelen bağlantının, e-posta bağlantısını kullanarak signInWithEmailLink() için uygun bir oturum açma işlemi olup olmadığını kontrol eder.
onAuthStateChanged(auth, nextOrObserver, error, completed) Kullanıcının oturum açma durumundaki değişiklikler için bir gözlemci ekler.
onIdTokenChanged(auth, nextOrObserver, error, completed) Oturum açmış kullanıcının kimlik jetonunda yapılan değişiklikler için bir gözlemci ekler.
revokeAccessToken(auth, token) Verilen erişim jetonunu iptal eder. Şu anda yalnızca Apple OAuth erişim jetonları desteklenmektedir.
sendPasswordResetEmail(auth, email, actionCodeSettings) Belirtilen e-posta adresine bir şifre sıfırlama e-postası gönderir. Belirtilen e-posta adresine sahip bir kullanıcı hesabı yoksa ve [E-posta Sıralama Koruması](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) etkinse bu yöntem hata bildirmez.
sendSignInLinkToEmail(auth, email, actionCodeSettings) Belirtilen e-posta adresiyle kullanıcıya bir oturum açma e-posta bağlantısı gönderir.
setPersistence(auth, persistence) Kayıtlı durumdaki Auth oturumu için Auth örneğindeki kalıcılık türünü değiştirir ve bu tür kalıcılığı gelecekteki oturum açma isteklerine (yönlendirme istekleriyle oturum açma dahil) uygular.
signInAnonymously(auth) Zaman uyumsuz şekilde anonim kullanıcı olarak oturum açar.
signInWithCredential(auth, credential) Belirtilen kimlik bilgileriyle eşzamansız olarak oturum açılır.
signInWithCustomToken(auth, customToken) Özel jeton kullanarak eşzamansız olarak oturum açar.
signInWithEmailAndPassword(auth, email, password) E-posta ve şifre kullanarak zaman uyumsuz şekilde oturum açıyor.
signInWithEmailLink(auth, email, emailLink) E-posta ve oturum açma e-posta bağlantısı kullanarak eşzamansız olarak oturum açıyor.
signInWithPhoneNumber(auth, phoneNumber, appVerifier) Telefon numarası kullanarak eşzamansız olarak oturum açıyorsa.
signInWithPopup(auth, provider, resolver) Pop-up tabanlı bir OAuth kimlik doğrulama akışı kullanarak Firebase istemcisinin kimliğini doğrular.
signInWithRedirect(auth, provider, resolver) Tam sayfa yönlendirme akışı kullanarak Firebase istemcisinin kimliğini doğrular.
signOut(auth) Geçerli kullanıcının oturumu kapatılır.
updateCurrentUser(auth, user) Sağlanan kullanıcıyı, Auth örneğinde eşzamansız olarak Auth.currentUser olarak ayarlar.
useDeviceLanguage(auth) Geçerli dili varsayılan cihaz/tarayıcı tercihine ayarlar.
validatePassword(auth, password) Şifreyi, proje veya kiracı için yapılandırılan şifre politikasına göre doğrular.
verifyPasswordResetCode(auth, code) Kullanıcıya e-postayla veya bant dışı başka bir mekanizma ile gönderilen şifre sıfırlama kodunu kontrol eder.
function(link, ...)
parseActionCodeURL(bağlantı) E-posta işlemi bağlantı dizesini ayrıştırır ve bağlantı geçerliyse bir ActionCodeURL döndürür, aksi takdirde boş döndürür.
function(kullanıcı, ...)
deleteUser(user) Kullanıcıyı siler ve kullanıcının oturumunu kapatır.
getIdToken(user, forceRefresh) Kullanıcıyı Firebase hizmetine tanımlamak için kullanılan JSON Web Jetonu (JWT) döndürür.
getIdTokenResult(user, forceRefresh) Kullanıcıyı Firebase hizmetine tanımlamak için kullanılan, seri durumdan çıkarılmış JSON Web Token (JWT) döndürür.
linkWithCredential(user, credential) Kullanıcı hesabını verilen kimlik bilgilerine bağlar.
linkWithPhoneNumber(user, phoneNumber, appVerifier) Kullanıcı hesabını verilen telefon numarasına bağlar.
linkWithPopup(user, provider, resolver) Pop-up tabanlı bir OAuth akışı kullanarak kimliği doğrulanmış sağlayıcıyı kullanıcı hesabına bağlar.
linkWithRedirect(user, provider, resolver) Tam sayfa yönlendirme akışı kullanarak OAuthProvider'ı kullanıcı hesabına bağlar.
multiFactor(user) Kullanıcıya karşılık gelen MultiFactorUser.
reauthenticateWithCredential(user, credential) Yeni bir kimlik bilgisi kullanarak kullanıcının kimliğini yeniden doğrular.
reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier) Yeni bir telefon kimlik bilgisi kullanarak kullanıcının kimliğini yeniden doğrular.
reauthenticateWithPopup(user, provider, resolver) Pop-up tabanlı bir OAuth akışı kullanarak, belirtilen OAuthProvider ile geçerli kullanıcının kimliğini yeniden doğrular.
reauthenticateWithRedirect(user, provider, resolver) Tam sayfa yönlendirme akışı kullanarak, belirtilen OAuthProvider ile geçerli kullanıcının kimliğini yeniden doğrular.
reload(kullanıcı) Oturum açılmışsa kullanıcı hesabı verilerini yeniden yükler.
sendEmailVerification(user, actionCodeSettings) Kullanıcıya doğrulama e-postası gönderir.
unlink(user, providerId) Sağlayıcının kullanıcı hesabıyla olan bağlantısını kaldırır.
updateEmail(user, newEmail) Kullanıcının e-posta adresini günceller.
updatePassword(user, newPassword) Kullanıcının şifresini günceller.
updatePhoneNumber(user, credential) Kullanıcının telefon numarasını günceller.
updateProfile(user, { displayName, photoURL: photoUrl }) Kullanıcının profil verilerini günceller.
verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings) Yeni e-posta adresine bir doğrulama e-postası gönderir.
function(userCredential, ...)
getAdditionalUserInfo(userCredential) Belirtilen kimlik bilgisi için sağlayıcıya özgü AdditionalUserInfo öğesini ayıklar.

Sınıflar

Sınıf Açıklama
ActionCodeURL Şifre sıfırlama, e-posta doğrulaması, e-posta bağlantısında oturum açma gibi e-posta işlemi URL'lerini ayrıştıran bir yardımcı program sınıfı.
AuthCredential AuthProvider tarafından döndürülen kimlik bilgilerini temsil eden arayüz.
EmailAuthCredential ProviderId.PASSWORD için EmailAuthProvider tarafından döndürülen kimlik bilgilerini temsil eden arayüz.
EmailAuthProvider EmailAuthCredential oluşturmak için sağlayıcı.
FacebookAuthProvider ProviderId.FACEBOOK için OAuthCredential oluşturan sağlayıcı.
GithubAuthProvider ProviderId.GITHUB için OAuthCredential oluşturan sağlayıcı.
GoogleAuthProvider ProviderId.GOOGLE için OAuthCredential oluşturan sağlayıcı.
OAuthCredential Bir OAuthProvider tarafından döndürülen OAuth kimlik bilgilerini temsil eder.
OAuthProvider Genel OAuthCredential oluşturmak için sağlayıcı.
PhoneAuthCredential PhoneAuthProvider tarafından döndürülen kimlik bilgilerini temsil eder.
PhoneAuthProvider PhoneAuthCredential oluşturmak için sağlayıcı.
PhoneMultiFactorGenerator PhoneMultiFactorAssertion oluşturma sağlayıcı.
RecaptchaVerifier reCAPTCHA tabanlı bir uygulama doğrulayıcısı.
SAMLAuthProvider SAML için bir AuthProvider.
TotpMultiFactorGenerator TotpMultiFactorAssertion oluşturma sağlayıcı.
TotpSecret TotpMultiFactorAssertion oluşturma sağlayıcı.Zamana dayalı OTP'ler oluşturmak için paylaşılan gizli anahtarı ve diğer parametreleri depolar. Paylaşılan gizli anahtarı almak ve QR kodu URL'si oluşturmak için yöntemler uygular.
TwitterAuthProvider ProviderId.TWITTER için OAuthCredential oluşturan sağlayıcı.

Arayüzler

Arayüz Açıklama
ActionCodeInfo checkActionCode() yanıtı.
ActionCodeSettings İsteğe bağlı Android ve iOS paket tanımlayıcılarıyla birlikte zorunlu devam/durum URL'sini tanımlayan arayüz.
AdditionalUserInfo Birleştirilmiş kimlik sağlayıcıdan gelen ek kullanıcı bilgilerini içeren yapı.
ApplicationVerifier Alan doğrulaması ve kötüye kullanımı önleme için bir doğrulayıcı.
Auth Firebase Auth hizmetini temsil eden arayüz.
AuthError Auth hatası için arayüz.
AuthErrorMap Hata kodlarının hata mesajlarıyla eşleştirilmesi.
AuthProvider Bir kimlik doğrulama sağlayıcıyı temsil eden ve AuthCredential oluşturmayı kolaylaştırmak amacıyla kullanılan arayüz.
AuthSettings Auth örneğinin ayarlarını temsil eden arayüz.
Yapılandırma Auth yapılandırmasını temsil eden arayüz.
ConfirmationResult Telefon numarasıyla oturum açma, bağlantı oluşturma veya yeniden kimlik doğrulama aramasının sonucudur.
Bağımlılıklar Bir Auth örneğini başlatmak için kullanılabilecek bağımlılıklar.
EmulatorConfig Firebase Authentication Emulator yapılandırması.
IdTokenResult User.getIdTokenResult() öğesinden alınan kimlik jetonu sonucunu temsil eden arayüz.
MultiFactorAssertion İkinci bir faktörün sahipliği iddiasında bulunmak için kullanılan temel sınıf.
MultiFactorError Kullanıcının başarılı bir şekilde oturum açmak için ikinci bir faktör sağlaması gerektiğinde hata verilir.
MultiFactorInfo İki etmenli bir varlığa ait bilgileri içeren bir yapı.
MultiFactorResolver Kullanıcının oturum açmak için ikinci bir faktör sağlaması gerektiğinde MultiFactorError hatalarından kurtarmayı kolaylaştırmak için kullanılan sınıf.
MultiFactorSession Bir kullanıcının ikinci faktörünü kaydetmek veya kayıtlı bir kullanıcının ikinci bir faktörle oturum açmasını sağlamak için kullanılan çok öğeli oturum nesnesini tanımlayan bir arayüz.
MultiFactorUser Bir Kullanıcı ile ilişkili çok öğeli özellikleri ve işlemleri tanımlayan arayüz.
OAuthCredentialOptions OAuthCredential başlatmayla ilgili seçenekleri tanımlar.
ParsedToken Ayrıştırılmış kimlik jetonunu temsil eden arayüz.
PasswordPolicy Şifre politikası gereksinimlerini belirten bir yapı.
PasswordValidationStatus Hangi şifre politikası gereksinimlerinin karşılandığını veya ihlal edildiğini ve gereksinimlerin neler olduğunu gösteren bir yapı.
Karar Olası kalıcılık mekanizması türlerini kapsayan bir arayüz.
PhoneMultiFactorAssertion Telefonda ikinci faktör sahipliği iddiasında bulunan sınıf. PhoneMultiFactorGenerator.assertion() tarafından sağlanır.
PhoneMultiFactorEnrollInfoOptions İkinci bir faktörü kaydetmek için kullanılan seçenekler.
PhoneMultiFactorInfo Telefon numarası ikinci faktörleri için MultiFactorInfo arayüzünün alt sınıfı. Bu ikinci faktörün factorId değeri: FactorId.PHONE.
PhoneMultiFactorSignInInfoOptions İkinci faktörle oturum açmak için kullanılan seçenekler.
PhoneSingleFactorInfoOptions Tek öğeli oturum açma için kullanılan seçenekler.
PopupRedirectResolver signInWithPopup() veya signInWithRedirect() gibi DOM'a özel işlemleri işlemek için kullanılan bir çözümleyici.
ReactNativeAsyncStorage Sağlanan AsyncStorage için arayüz.
RecaptchaParameters reCAPTCHA parametrelerini temsil eden arayüz.Kabul edilen parametrelerin listesi için [reCAPTCHA belgelerine](https://developers.google.com/recaptcha/docs/display#render_param) bakın. sitekey dışındaki tüm parametreler kabul edilir: Firebase Auth her proje için bir reCAPTCHA sağlar ve oluşturma işleminden sonra site anahtarını yapılandırır.Görünmez reCAPTCHA için size anahtarını invisible olarak ayarlayın.
TotpMultiFactorAssertion TOTP ikinci faktör için sahiplik iddiasında bulunan sınıf. TotpMultiFactorGenerator.assertionForEnrollment() ve TotpMultiFactorGenerator.assertionForSignIn() tarafından sağlanır.
TotpMultiFactorInfo TOTP ikinci faktörler için MultiFactorInfo arayüzünün alt sınıfı. Bu ikinci faktörün factorId'i FactorId.TOTP'dir.
Kullanıcı Kullanıcı hesabı.
UserCredential User, OperationType ve sağlayıcı kimliğini içeren bir yapı.
UserInfo Yalnızca Firebase projesinin uygulamaları tarafından görülebilen kullanıcı profili bilgileri.
UserMetadata Kullanıcının meta verilerini temsil eden arayüz.

Değişkenler

Değişken Açıklama
ActionCodeOperation Olası e-posta işlemi türlerinin listesi.
AuthErrorCodes SDK tarafından oluşturulan hatalarla daha kolay karşılaştırma yapılabilmesi için olası Auth hata kodlarının haritası.
browserLocalPersistence Temel depolama alanı için localStorage kullanılarak LOCAL türünde Kalıcılık uygulaması.
browserPopupRedirectResolver Tarayıcı tabanlı uygulamalar için uygun bir PopupRedirectResolver uygulaması.
browserSessionPersistence Temel depolama alanı için sessionStorage kullanılarak SESSION uygulamasının Kalıcılığı uygulanması.
cordovaPopupRedirectResolver Cordova tabanlı uygulamalara uygun bir PopupRedirectResolver uygulaması.
debugErrorMap Çoğu hata kodunun ayrıntılı açıklamalarını içeren ayrıntılı bir hata haritası.AuthErrorMap sayfasında tartışmayı bulabilirsiniz.
FactorId Çok öğeli kimlik doğrulaması için kullanılabilecek faktörlerin bir listesi.
indexedDBLocalPersistence Temel depolama alanı için indexedDB kullanılarak LOCAL türünde Kalıcılık uygulaması.
inMemoryPersistence "HİÇBİRİ" türünde Kalıcılık uygulaması.
OperationType Desteklenen işlem türlerinin sayısı.
prodErrorMap Tüm ayrıntılı hata mesajlarının kaldırıldığı minimal hata haritası.Tartışmaya AuthErrorMap adresinden erişebilirsiniz.
ProviderId Desteklenen sağlayıcıların listesi.
SignInMethod Desteklenen oturum açma yöntemlerinin listesi.

Takma Adları Yazın

Takma Ad Yazın Açıklama
CustomParameters OAuth Özel Parametreleri eşlemesi.
NextOrObserver Etkinlik geri çağırma işlevinin tür tanımı.
PhoneInfoOptions Telefon numarasının sahipliğini doğrulamak için gereken bilgiler.
UserProfile AdditionalUserInfo özelliğinde kullanılan kullanıcı profili.

Functions(uygulama; ...)

getAuth(app)

Sağlanan FirebaseApp ile ilişkili Auth örneğini döndürür. Örnek yoksa platforma özgü varsayılan bağımlılıklara sahip bir Auth örneği başlatır.

İmza:

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

Parametreler

Parametre Tür Açıklama
uygulama FirebaseApp Firebase Uygulaması.

İadeler:

Auth

initializeAuth(app, deps)

Bağımlılıklar üzerinde ayrıntılı denetime sahip bir Auth örneği başlatır.

Bu işlev, Auth örneği üzerinde getAuth() yöntemine göre daha fazla kontrol sağlar. getAuth, Bağımlılıkları sağlamak için platforma özgü varsayılanları kullanır. Genel olarak, getAuth, Auth'u başlatmanın en kolay yoludur ve çoğu kullanım alanında işe yarar. Hangi kalıcı katmanın kullanılacağı konusunda kontrol sahibi olmanız gerekiyorsa initializeAuth kullanın. signInWithPopup veya signInWithRedirect kullanmıyorsanız paket boyutunu en aza indirin.

Örneğin, uygulamanızda yalnızca anonim hesaplar kullanılıyorsa ve hesapların yalnızca geçerli oturum için kaydedilmesini istiyorsanız Auth uygulamasını şununla başlatın:

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

İmza:

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

Parametreler

Parametre Tür Açıklama
uygulama FirebaseApp
hareketler Bağımlılıklar

İadeler:

Auth

Functions(depolama, ...)

getReactNativePersistence(storage)

react-native veya @react-native-community/async-storage kaynağından içe aktarılan AsyncStorage öğesini sarmalayan bir kalıcılık nesnesi döndürür ve initializeAuth() işlevindeki kalıcılık bağımlılık alanında kullanılabilir.

İmza:

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

Parametreler

Parametre Tür Açıklama
depolama ReactNativeAsyncStorage

İadeler:

Karar

Functions(kimlik doğrulama; ...)

applyActionCode(auth, oobCode)

Kullanıcıya e-posta veya bant dışı başka bir mekanizma ile gönderilen doğrulama kodunu uygular.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
oobCode dize Kullanıcıya gönderilen doğrulama kodu.

İadeler:

Promise<void>

beforeAuthStateChanged(auth, callback, onAbort)

Bir yetkilendirme durumu değişikliği yeni bir kullanıcıyı ayarlamadan önce çalışan bir engelleme geri çağırması ekler.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
geri çağırma (user: User | null) => void | Promise<void> yeni kullanıcı değeri belirlenmeden önce tetiklenen geri arama işlevidir. Hata oluşursa kullanıcının ayarlanması engellenir.
onAbort () => geçersiz Daha sonra gerçekleşen bir beforeAuthStateChanged() geri çağırması gerçekleşirse geri çağırma tetiklenir. Bu sayede olası yan etkileri geri alabilirsiniz.

İadeler:

E-posta listesinden çık

checkActionCode(auth, oobCode)

Kullanıcıya e-postayla veya bant dışı başka bir mekanizma ile gönderilen doğrulama kodunu kontrol eder.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
oobCode dize Kullanıcıya gönderilen doğrulama kodu.

İadeler:

Promise<ActionCodeInfo>

meta verileri içerir.

confirmPasswordReset(auth, oobCode, newPassword)

Verilen onay kodu ve yeni şifreyle şifre sıfırlama işlemini tamamlar.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
oobCode dize Kullanıcıya onay kodu gönderildi.
newPassword dize Yeni şifre.

İadeler:

Promise<void>

connectAuthEmulator(auth, url, options)

Auth örneğini, üretim Firebase Auth hizmetleri yerine Firebase Auth Emulator ile iletişim kuracak şekilde değiştirir.

Bu, initializeAuth() işlevine yapılan ilk çağrıdan hemen sonra eşzamanlı olarak çağrılmalıdır. Emülatör trafiği şifrelenmediğinden, üretim kimlik bilgileriyle kullanmayın.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
url dize Emülatörün çalıştığı URL (ör. "http://localhost:9099").
seçenekler { disableWarnings: boolean; } İsteğe bağlı. options.disableWarnings varsayılan olarak false değerine ayarlanır. DOM'ye eklenmiş uyarı banner'ını devre dışı bırakmak için bunu true olarak ayarlayın.

İadeler:

void

Örnek

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

createUserWithEmailAndPassword(auth, email, password)

Belirtilen e-posta adresi ve şifreyle ilişkilendirilmiş yeni bir kullanıcı hesabı oluşturur.

Kullanıcı hesabı başarıyla oluşturulduktan sonra, bu kullanıcı uygulamanızda da oturum açmış olur.

Hesap zaten mevcutsa veya şifre geçersizse kullanıcı hesabı oluşturma işlemi başarısız olabilir.

Bu yöntem, bir FirebaseServerApp ile oluşturulan Auth örneklerinde desteklenmez.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
e-posta dize Kullanıcının e-posta adresi.
şifre dize Kullanıcının seçtiği şifre.

İadeler:

Promise<UserCredential>

fetchSignInMethodsForEmail(auth, email)

Belirtilen e-posta adresi için olası oturum açma yöntemlerinin listesini alır. Bu yöntem, [E-posta Sıralama Koruması](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) etkinleştirildiğinde boş bir liste döndürür. Söz konusu e-posta için kullanılabilen kimlik doğrulama yöntemlerinin sayısı önemli değildir.

Bu özellik, aynı sağlayıcının oturum açma yöntemlerini birbirinden ayırt etmek için yararlıdır (ör. 2 oturum açma yöntemi olan EmailAuthProvider: SignInMethod.EMAIL_PASSWORD ve SignInMethod.EMAIL_LINK.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
e-posta dize Kullanıcının e-posta adresi.Kullanımdan kaldırıldı. Güvenlikle ilgili en iyi uygulama olarak bu yöntemin başka bir yere taşınması önerilir. Daha fazla bilgi edinmek için [E-posta Sıralama Koruması](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) ile ilgili Kimlik Platformu dokümanlarına göz atın.

İadeler:

Söz<dize[]>

getMultiFactorResolver(auth, error)

Çok öğeli bir akışın tamamlanmasına uygun bir MultiFactorResolver sağlar.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
hata MultiFactorError Oturum açma veya yeniden kimlik doğrulama işlemi sırasında ortaya çıkan MultiFactorError.

İadeler:

MultiFactorResolver

getRedirectResult(auth, resolver)

Yönlendirme tabanlı oturum açma akışından bir UserCredential döndürür.

Oturum açma başarılı olursa oturum açmış olan kullanıcıyı döndürür. Oturum açma başarısız olduysa hata vererek başarısız olur. Hiçbir yönlendirme işlemi çağrılmadıysa null değerini döndürür.

Bu yöntem Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örnekleri ile çalışmaz.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
çözümleyici PopupRedirectResolver initializeAuth() işlevine zaten sağlanmışsa veya getAuth() tarafından sağlanmışsa isteğe bağlı bir PopupRedirectResolver örneği.

İadeler:

Promise<UserCredential | null>

Örnek

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

reCAPTCHA yapılandırmasını Auth örneğine yükler.

Bu işlem, reCAPTCHA doğrulama akışının her kimlik doğrulama sağlayıcısı için tetiklenip tetiklenmeyeceğini belirten reCAPTCHA yapılandırmasını mevcut Yetkilendirme oturumuna yükler.

initializeRecaptchaConfig() çağrılmazsa kimlik doğrulama akışı her zaman reCAPTCHA doğrulaması olmadan başlar. Sağlayıcı, reCAPTCHA doğrulaması gerektirecek şekilde yapılandırılmışsa SDK, reCAPTCHA yapılandırmasını şeffaf bir şekilde yükler ve kimlik doğrulama akışlarını yeniden başlatır.

Böylece, bu isteğe bağlı yöntemi çağırarak gelecekteki kimlik doğrulama akışlarının gecikmesini azaltabilirsiniz. reCAPTCHA yapılandırmasını erkenden yüklemek, reCAPTCHA'nın topladığı sinyali de iyileştirir.

Bu yöntem Node.js ortamında çalışmaz.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.

İadeler:

Promise<void>

Örnek

initializeRecaptchaConfig(auth);

Gelen bağlantının, e-posta bağlantısını kullanarak signInWithEmailLink() için uygun bir oturum açma işlemi olup olmadığını kontrol eder.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
emailLink dize Kullanıcının e-posta adresine gönderilen bağlantı.

İadeler:

boolean

onAuthStateChanged(auth, nextOrObserver, error, completed)

Kullanıcının oturum açma durumundaki değişiklikler için bir gözlemci ekler.

Eski davranışı korumak için onIdTokenChanged() politikasını inceleyin.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
nextOrObserver NextOrObserver<Kullanıcı> geri arama tetiklendi.
hata ErrorFn Kullanımdan kaldırıldı. Bu geri çağırma hiçbir zaman tetiklenmez. Oturum açma/kapatma sırasındaki hatalar, oturum açma/oturum kapatma işlevlerinden döndürülen sözlerde yakalanabilir.
tamamlandı CompleteFn Kullanımdan kaldırıldı. Bu geri çağırma hiçbir zaman tetiklenmez.

İadeler:

E-posta listesinden çık

onIdTokenChanged(auth, nextOrObserver, error, completed)

Oturum açmış kullanıcının kimlik jetonunda yapılan değişiklikler için bir gözlemci ekler.

Buna oturum açma, oturumu kapatma ve jeton yenileme etkinlikleri dahildir. Bu, kimlik jetonunun süresi dolduktan sonra otomatik olarak tetiklenmez. Kimlik jetonunu yenilemek için User.getIdToken() işlevini kullanın.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
nextOrObserver NextOrObserver<Kullanıcı> geri arama tetiklendi.
hata ErrorFn Kullanımdan kaldırıldı. Bu geri çağırma hiçbir zaman tetiklenmez. Oturum açma/kapatma sırasındaki hatalar, oturum açma/oturum kapatma işlevlerinden döndürülen sözlerde yakalanabilir.
tamamlandı CompleteFn Kullanımdan kaldırıldı. Bu geri çağırma hiçbir zaman tetiklenmez.

İadeler:

E-posta listesinden çık

revokeAccessToken(auth, token)

Verilen erişim jetonunu iptal eder. Şu anda yalnızca Apple OAuth erişim jetonları desteklenmektedir.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
token dize Apple OAuth erişim jetonu.

İadeler:

Promise<void>

sendPasswordResetEmail(auth, email, actionCodeSettings)

Belirtilen e-posta adresine bir şifre sıfırlama e-postası gönderir. Belirtilen e-posta adresine sahip bir kullanıcı hesabı yoksa ve [E-posta Sıralama Koruması](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) etkinse bu yöntem hata bildirmez.

Şifre sıfırlama işlemini tamamlamak için kullanıcıya gönderilen e-postadaki kodla ve kullanıcı tarafından belirlenen yeni şifreyle confirmPasswordReset() işlevini çağırın.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
e-posta dize Kullanıcının e-posta adresi.
actionCodeSettings ActionCodeSettings ActionCodeSettings.

İadeler:

Promise<void>

Örnek

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)

Belirtilen e-posta adresiyle kullanıcıya bir oturum açma e-posta bağlantısı gönderir.

Bant dışı e-posta işlemlerinin (şifre sıfırlama ve e-posta doğrulamaları) aksine oturum açma işleminin her zaman uygulamada tamamlanması gerekir. Bunun nedeni, akışın sonunda kullanıcının oturum açmış olması ve Yetkilendirme durumunun uygulama içinde devam etmesinin beklenmesidir.

Oturum açma işlemini e-posta bağlantısıyla tamamlamak için, kullanıcıya gönderilen e-postada verilen e-posta adresini ve e-posta bağlantısını kullanarak signInWithEmailLink() yöntemini çağırın.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth
e-posta dize Kullanıcının e-posta adresi.
actionCodeSettings ActionCodeSettings ActionCodeSettings.

İadeler:

Promise<void>

Örnek

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)

Kayıtlı durumdaki Auth oturumu için Auth örneğindeki kalıcılık türünü değiştirir ve bu tür kalıcılığı gelecekteki oturum açma isteklerine (yönlendirme istekleriyle oturum açma dahil) uygular.

Bu, oturum açan bir kullanıcının, oturumunun hatırlanıp hatırlanmayacağını belirlemesini kolaylaştırır. Ayrıca diğer kullanıcılar tarafından paylaşılan veya hassas veriler içeren uygulamalar için Auth durumunun hiçbir zaman korunmasını da kolaylaştırır.

Bu yöntem Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örnekleri ile çalışmaz.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
kalıcılık Karar Kullanılacak Kalıcılık.

İadeler:

Promise<void>

Kalıcılık değişikliği tamamlandığında çözümlenen Promise

Örnek

setPersistence(auth, browserSessionPersistence);

signInAnonymously(auth)

Zaman uyumsuz şekilde anonim kullanıcı olarak oturum açar.

Halihazırda oturum açmış anonim bir kullanıcı varsa bu kullanıcı döndürülür. Aksi takdirde, yeni bir anonim kullanıcı kimliği oluşturulup döndürülür.

Bu yöntem, bir FirebaseServerApp ile oluşturulan Auth örnekleri tarafından desteklenmez.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.

İadeler:

Promise<UserCredential>

signInWithCredential(auth, credential)

Belirtilen kimlik bilgileriyle eşzamansız olarak oturum açılır.

Kimlik bilgisini oluşturmak için bir AuthProvider kullanılabilir.

Bu yöntem, bir FirebaseServerApp ile oluşturulan Auth örnekleri tarafından desteklenmez.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
giriş bilgisi AuthCredential Kimlik doğrulama kimlik bilgisi.

İadeler:

Promise<UserCredential>

signInWithCustomToken(auth, customToken)

Özel jeton kullanarak eşzamansız olarak oturum açar.

Özel jetonlar, Firebase Auth'u mevcut kimlik doğrulama sistemleriyle entegre etmek için kullanılır ve Admin SDK'daki createCustomToken yöntemi kullanılarak bir kimlik doğrulama arka ucu tarafından oluşturulmalıdır .

Jeton geçersizse, süresi dolmuşsa veya Firebase Auth hizmeti tarafından kabul edilmemişse hata verir.

Bu yöntem, bir FirebaseServerApp ile oluşturulan Auth örnekleri tarafından desteklenmez.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
customToken dize Oturum açmak için kullanılacak özel jeton.

İadeler:

Promise<UserCredential>

signInWithEmailAndPassword(auth, email, password)

E-posta ve şifre kullanarak zaman uyumsuz şekilde oturum açıyor.

E-posta adresi ve şifre eşleşmezse hatayla başarısız olur. [E-posta Numaralandırma Koruması](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) etkinleştirildiğinde bu yöntem geçersiz bir e-posta/şifre olması durumunda "auth/invalid-credential" ile başarısız olur.

Bu yöntem, bir FirebaseServerApp ile oluşturulan Auth örneklerinde desteklenmez.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
e-posta dize Kullanıcının e-posta adresi.
şifre dize Kullanıcının şifresi.

İadeler:

Promise<UserCredential>

E-posta ve oturum açma e-posta bağlantısı kullanarak eşzamansız olarak oturum açıyor.

Herhangi bir bağlantı iletilmezse bağlantı, mevcut URL'den belirlenir.

E-posta adresi geçersizse veya e-posta bağlantısındaki OTP'nin süresi dolarsa hata mesajı verir.

Bu yöntem, bir FirebaseServerApp ile oluşturulan Auth örnekleri tarafından desteklenmez.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
e-posta dize Kullanıcının e-posta adresi.
emailLink dize Kullanıcının e-posta adresine gönderilen bağlantı.

İadeler:

Promise<UserCredential>

Örnek

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)

Telefon numarası kullanarak eşzamansız olarak oturum açıyorsa.

Bu yöntem, belirtilen telefon numarasına SMS yoluyla bir kod gönderir ve ConfirmationResult döndürür. Kullanıcı, telefonuna gönderilen kodu sağladıktan sonra kullanıcının oturum açmasını sağlayacak kodla birlikte ConfirmationResult.confirm() işlevini çağırın.

Kötüye kullanımı önlemek için bu yöntemde ayrıca bir ApplicationVerifier gerekir. Bu SDK, reCAPTCHA tabanlı bir uygulama olan RecaptchaVerifier'ı içerir. Bu işlev, RecaptchaVerifier'ı desteklemeyen diğer platformlarda (ör. React Native) çalışabilir ancak üçüncü taraf ApplicationVerifier uygulaması kullanmanız gerekir.

Bu yöntem Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örnekleri ile çalışmaz.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
phoneNumber dize Kullanıcının E.164 biçimindeki telefon numarası (ör. +16505550101).
appVerifier ApplicationVerifier ApplicationVerifier.

İadeler:

Promise<ConfirmationResult>

Örnek

// '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)

Pop-up tabanlı bir OAuth kimlik doğrulama akışı kullanarak Firebase istemcisinin kimliğini doğrular.

Başarılı olursa, oturum açmış kullanıcıyı sağlayıcının kimlik bilgileriyle birlikte döndürür. Oturum açma başarısız olduysa hatayla ilgili ek bilgileri içeren bir hata nesnesi döndürür.

Bu yöntem Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örnekleri ile çalışmaz.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
provider AuthProvider Kimliği doğrulanacak sağlayıcı. Sağlayıcı bir OAuthProvider olmalıdır. EmailAuthProvider gibi OAuth kullanmayan sağlayıcılar hata verir.
çözümleyici PopupRedirectResolver initializeAuth() işlevine zaten sağlanmışsa veya getAuth() tarafından sağlanmışsa isteğe bağlı bir PopupRedirectResolver örneği.

İadeler:

Promise<UserCredential>

Örnek

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

Tam sayfa yönlendirme akışı kullanarak Firebase istemcisinin kimliğini doğrular.

Bu işlemin sonuçlarını ve hatalarını işlemek için getRedirectResult() öğesini inceleyin. signInWithRedirect() yöntemini kullanırken en iyi uygulamaları uygulayın.

Bu yöntem Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örnekleri ile çalışmaz.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
provider AuthProvider Kimliği doğrulanacak sağlayıcı. Sağlayıcı bir OAuthProvider olmalıdır. EmailAuthProvider gibi OAuth kullanmayan sağlayıcılar hata verir.
çözümleyici PopupRedirectResolver initializeAuth() işlevine zaten sağlanmışsa veya getAuth() tarafından sağlanmışsa isteğe bağlı bir PopupRedirectResolver örneği.

İadeler:

Söz verme<hiçbir zaman>

Örnek

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

Geçerli kullanıcının oturumu kapatılır.

Bu yöntem, bir FirebaseServerApp ile oluşturulan Auth örnekleri tarafından desteklenmez.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.

İadeler:

Promise<void>

updateCurrentUser(auth, user)

Sağlanan kullanıcıyı, Auth örneğinde eşzamansız olarak Auth.currentUser olarak ayarlar.

Sağlanan kullanıcının yeni bir kopyası oluşturulur ve currentUser olarak ayarlanır.

Bu, diğer oturum açma yöntemleri gibi onAuthStateChanged() ve onIdTokenChanged() işleyicilerini tetikler.

Güncellenecek kullanıcı farklı bir Firebase projesine aitse işlem bir hatayla başarısız olur.

Bu yöntem, bir FirebaseServerApp ile oluşturulan Auth örnekleri tarafından desteklenmez.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
kullanıcı Kullanıcı | null Yeni Kullanıcı.

İadeler:

Promise<void>

useDeviceLanguage(auth)

Geçerli dili varsayılan cihaz/tarayıcı tercihine ayarlar.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.

İadeler:

void

validatePassword(auth, password)

Şifreyi, proje veya kiracı için yapılandırılan şifre politikasına göre doğrular.

Auth örneğinde kiracı kimliği ayarlanmamışsa bu yöntem, proje için yapılandırılmış şifre politikasını kullanır. Aksi takdirde, bu yöntem kiracı için yapılandırılan politikayı kullanır. Bir şifre politikası yapılandırılmadıysa tüm projeler için yapılandırılmış varsayılan politika kullanılır.

Gönderilen bir şifre, şifre politikası gereksinimlerini karşılamadığı ve bu yöntem daha önce çağrıldığı için kimlik doğrulama akışı başarısız olursa bu yöntem tekrar çağrıldığında mevcut en son politikayı kullanır.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
şifre dize Doğrulanacak şifre.

İadeler:

Promise<PasswordValidationStatus>

Örnek

validatePassword(auth, 'some-password');

verifyPasswordResetCode(auth, code)

Kullanıcıya e-postayla veya bant dışı başka bir mekanizma ile gönderilen şifre sıfırlama kodunu kontrol eder.

İmza:

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

Parametreler

Parametre Tür Açıklama
auth Auth Auth örneği.
kod dize Kullanıcıya gönderilen doğrulama kodu.

İadeler:

Söz<dize>

geçerliyse, kullanıcının e-posta adresini

parseActionCodeURL(bağlantı)

E-posta işlemi bağlantı dizesini ayrıştırır ve bağlantı geçerliyse bir ActionCodeURL döndürür, aksi takdirde boş döndürür.

İmza:

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

Parametreler

Parametre Tür Açıklama
bağlantı dize

İadeler:

ActionCodeURL | null

Functions(kullanıcı; ...)

deleteUser(user)

Kullanıcıyı siler ve kullanıcının oturumunu kapatır.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.

İadeler:

Promise<void>

getIdToken(user, forceRefresh)

Kullanıcıyı Firebase hizmetine tanımlamak için kullanılan JSON Web Jetonu (JWT) döndürür.

Geçerli jetonun süresi dolmamışsa veya sonraki beş dakika içinde süresi dolmayacaksa geçerli jetonu döndürür. Aksi takdirde, jeton yenilenir ve yeni bir jeton döndürülür.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.
forceRefresh boolean Jetonun son kullanma tarihi ne olursa olsun yenilemeye zorla.

İadeler:

Söz<dize>

getIdTokenResult(user, forceRefresh)

Kullanıcıyı Firebase hizmetine tanımlamak için kullanılan, seri durumdan çıkarılmış JSON Web Token (JWT) döndürür.

Geçerli jetonun süresi dolmamışsa veya sonraki beş dakika içinde süresi dolmayacaksa geçerli jetonu döndürür. Aksi takdirde, jeton yenilenir ve yeni bir jeton döndürülür.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.
forceRefresh boolean Jetonun son kullanma tarihi ne olursa olsun yenilemeye zorla.

İadeler:

Promise<IdTokenResult>

linkWithCredential(user, credential)

Kullanıcı hesabını verilen kimlik bilgilerine bağlar.

Kimlik bilgisini oluşturmak için bir AuthProvider kullanılabilir.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.
giriş bilgisi AuthCredential Kimlik doğrulama kimlik bilgisi.

İadeler:

Promise<UserCredential>

linkWithPhoneNumber(user, phoneNumber, appVerifier)

Kullanıcı hesabını verilen telefon numarasına bağlar.

Bu yöntem Node.js ortamında çalışmaz.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.
phoneNumber dize Kullanıcının E.164 biçimindeki telefon numarası (ör. +16505550101).
appVerifier ApplicationVerifier ApplicationVerifier.

İadeler:

Promise<ConfirmationResult>

linkWithPopup(user, provider, resolver)

Pop-up tabanlı bir OAuth akışı kullanarak kimliği doğrulanmış sağlayıcıyı kullanıcı hesabına bağlar.

Bağlantı başarılı olursa döndürülen sonuçta kullanıcı ve sağlayıcının kimlik bilgileri yer alır.

Bu yöntem Node.js ortamında çalışmaz.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.
provider AuthProvider Kimliği doğrulanacak sağlayıcı. Sağlayıcı bir OAuthProvider olmalıdır. EmailAuthProvider gibi OAuth kullanmayan sağlayıcılar hata verir.
çözümleyici PopupRedirectResolver initializeAuth() işlevine zaten sağlanmışsa veya getAuth() tarafından sağlanmışsa isteğe bağlı bir PopupRedirectResolver örneği.

İadeler:

Promise<UserCredential>

Örnek

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

Tam sayfa yönlendirme akışı kullanarak OAuthProvider'ı kullanıcı hesabına bağlar.

Bu işlemin sonuçlarını ve hatalarını işlemek için getRedirectResult() öğesini kullanın. linkWithRedirect() yöntemini kullanırken en iyi uygulamaları izleyin.

Bu yöntem Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örnekleri ile çalışmaz.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.
provider AuthProvider Kimliği doğrulanacak sağlayıcı. Sağlayıcı bir OAuthProvider olmalıdır. EmailAuthProvider gibi OAuth kullanmayan sağlayıcılar hata verir.
çözümleyici PopupRedirectResolver initializeAuth() işlevine zaten sağlanmışsa veya getAuth() tarafından sağlanmışsa isteğe bağlı bir PopupRedirectResolver örneği.

İadeler:

Söz verme<hiçbir zaman>

Örnek

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

Kullanıcıya karşılık gelen MultiFactorUser.

Bu, kullanıcıyla ilgili tüm çok öğeli özelliklere ve işlemlere erişmek için kullanılır.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.

İadeler:

MultiFactorUser

reauthenticateWithCredential(user, credential)

Yeni bir kimlik bilgisi kullanarak kullanıcının kimliğini yeniden doğrular.

Son oturum açma denemelerinde jeton gerektiren updatePassword() gibi işlemlerden önce kullanın. Bu yöntem, bir CREDENTIAL_TOO_OLD_LOGIN_AGAIN veya TOKEN_EXPIRED hatasından kurtulmak için kullanılabilir.

Bu yöntem, FirebaseServerApp ile oluşturulan Auth örnekleri tarafından oturum açmış hiçbir Kullanıcı için desteklenmez.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.
giriş bilgisi AuthCredential Kimlik doğrulama kimlik bilgisi.

İadeler:

Promise<UserCredential>

reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier)

Yeni bir telefon kimlik bilgisi kullanarak kullanıcının kimliğini yeniden doğrular.

Son oturum açma denemelerinde jeton gerektiren updatePassword() gibi işlemlerden önce kullanın.

Bu yöntem, Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örnekleri tarafından oturum açılmış herhangi bir Kullanıcı üzerinde çalışmaz.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.
phoneNumber dize Kullanıcının E.164 biçimindeki telefon numarası (ör. +16505550101).
appVerifier ApplicationVerifier ApplicationVerifier.

İadeler:

Promise<ConfirmationResult>

reauthenticateWithPopup(user, provider, resolver)

Pop-up tabanlı bir OAuth akışı kullanarak, belirtilen OAuthProvider ile geçerli kullanıcının kimliğini yeniden doğrular.

Yeniden kimlik doğrulama başarılı olursa döndürülen sonuçta kullanıcı ve sağlayıcının kimlik bilgileri yer alır.

Bu yöntem, Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örnekleri tarafından oturum açılmış herhangi bir Kullanıcı üzerinde çalışmaz.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.
provider AuthProvider Kimliği doğrulanacak sağlayıcı. Sağlayıcı bir OAuthProvider olmalıdır. EmailAuthProvider gibi OAuth kullanmayan sağlayıcılar hata verir.
çözümleyici PopupRedirectResolver initializeAuth() işlevine zaten sağlanmışsa veya getAuth() tarafından sağlanmışsa isteğe bağlı bir PopupRedirectResolver örneği.

İadeler:

Promise<UserCredential>

Örnek

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

Tam sayfa yönlendirme akışı kullanarak, belirtilen OAuthProvider ile geçerli kullanıcının kimliğini yeniden doğrular.

Bu işlemin sonuçlarını ve hatalarını işlemek için getRedirectResult() öğesini kullanın. reauthenticateWithRedirect() yöntemini kullanırken en iyi uygulamaları uygulayın.

Bu yöntem Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örnekleri ile çalışmaz.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.
provider AuthProvider Kimliği doğrulanacak sağlayıcı. Sağlayıcı bir OAuthProvider olmalıdır. EmailAuthProvider gibi OAuth kullanmayan sağlayıcılar hata verir.
çözümleyici PopupRedirectResolver initializeAuth() işlevine zaten sağlanmışsa veya getAuth() tarafından sağlanmışsa isteğe bağlı bir PopupRedirectResolver örneği.

İadeler:

Söz verme<hiçbir zaman>

Örnek

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

yeniden yükle(kullanıcı)

Oturum açılmışsa kullanıcı hesabı verilerini yeniden yükler.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.

İadeler:

Promise<void>

sendEmailVerification(user, actionCodeSettings)

Kullanıcıya doğrulama e-postası gönderir.

Doğrulama işlemi, applyActionCode() çağrısı yapılarak tamamlanır.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.
actionCodeSettings ActionCodeSettings | null ActionCodeSettings.

İadeler:

Promise<void>

Örnek

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

Sağlayıcının kullanıcı hesabıyla olan bağlantısını kaldırır.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.
providerId dize Bağlantısı kaldırılacak sağlayıcı.

İadeler:

Söz<Kullanıcı>

updateEmail(user, newEmail)

Kullanıcının e-posta adresini günceller.

Orijinal e-posta adresine (ayarlanmışsa) bir e-posta gönderilir. Bu e-posta, hesabın ele geçirilmesini önlemek için e-posta adresi değişikliğini iptal etmeye olanak tanır.

Bu yöntem, FirebaseServerApp ile oluşturulan Auth örnekleri tarafından oturum açmış hiçbir Kullanıcı için desteklenmez.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.
newEmail dize Yeni e-posta adresi.[E-posta Sıralama Koruması](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) etkinleştirildiğinde "auth/operation-not-allowed" hatası verir. Kullanımdan kaldırıldı - Bunun yerine verifyBeforeUpdateEmail() öğesini kullanın.

İadeler:

Promise<void>

updatePassword(user, newPassword)

Kullanıcının şifresini günceller.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.
newPassword dize Yeni şifre.

İadeler:

Promise<void>

updatePhoneNumber(user, credential)

Kullanıcının telefon numarasını günceller.

Bu yöntem, Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örnekleri tarafından oturum açılmış herhangi bir Kullanıcı üzerinde çalışmaz.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.
giriş bilgisi PhoneAuthCredential Yeni telefon numarasını doğrulayan kimlik bilgisi.

İadeler:

Promise<void>

Örnek

// '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 })

Kullanıcının profil verilerini günceller.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.
{ displayName, photoURL: photoUrl } { displayName?: string | null; photoURL?: string | null; }

İadeler:

Promise<void>

verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings)

Yeni e-posta adresine bir doğrulama e-postası gönderir.

Kullanıcının e-posta adresi doğrulandıktan sonra yenisiyle güncellenir.

Özel e-posta işlem işleyiciniz varsa applyActionCode() yöntemini çağırarak doğrulama işlemini tamamlayabilirsiniz.

İmza:

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

Parametreler

Parametre Tür Açıklama
kullanıcı Kullanıcı Kullanıcı.
newEmail dize Güncellemeden önce doğrulanacak yeni e-posta adresi.
actionCodeSettings ActionCodeSettings | null ActionCodeSettings.

İadeler:

Promise<void>

Örnek

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

function(userCredential, ...)

getAdditionalUserInfo(userCredential)

Belirtilen kimlik bilgisi için sağlayıcıya özgü AdditionalUserInfo öğesini ayıklar.

İmza:

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

Parametreler

Parametre Tür Açıklama
userCredential UserCredential Kullanıcı kimlik bilgisi.

İadeler:

AdditionalUserInfo | null

ActionCodeOperation

Olası e-posta işlemi türlerinin listesi.

İmza:

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

SDK tarafından oluşturulan hatalarla daha kolay karşılaştırma yapılabilmesi için olası Auth hata kodlarının haritası.

Haritadaki anahtarları tek tek sallayamazsınız, bu nedenle haritayı kullanarak paketinizin boyutunu önemli ölçüde artırabilirsiniz.

İmza:

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

Temel depolama alanı için localStorage kullanılarak LOCAL türünde Kalıcılık uygulaması.

İmza:

browserLocalPersistence: Persistence

browserPopupRedirectResolver

Tarayıcı tabanlı uygulamalar için uygun bir PopupRedirectResolver uygulaması.

Bu yöntem Node.js ortamında çalışmaz.

İmza:

browserPopupRedirectResolver: PopupRedirectResolver

browserSessionPersistence

Temel depolama alanı için sessionStorage kullanılarak SESSION uygulamasının Kalıcılığı uygulanması.

İmza:

browserSessionPersistence: Persistence

cordovaPopupRedirectResolver

Cordova tabanlı uygulamalara uygun bir PopupRedirectResolver uygulaması.

İmza:

cordovaPopupRedirectResolver: PopupRedirectResolver

debugErrorMap

Çoğu hata kodu için ayrıntılı açıklamalar içeren bir ayrıntılı hata haritası.

Tartışmaya AuthErrorMap'te bakın

İmza:

debugErrorMap: AuthErrorMap

FactorId

Çok öğeli kimlik doğrulaması için kullanılabilecek faktörlerin bir listesi.

İmza:

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

indexedDBLocalPersistence

Temel depolama alanı için indexedDB kullanılarak LOCAL türünde Kalıcılık uygulaması.

İmza:

indexedDBLocalPersistence: Persistence

inMemoryPersistence

"HİÇBİRİ" türünde Kalıcılık uygulaması.

İmza:

inMemoryPersistence: Persistence

OperationType

Desteklenen işlem türlerinin listesi.

İmza:

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

prodErrorMap

Tüm ayrıntılı hata mesajlarının kaldırıldığı minimum hata haritası.

Tartışmaya AuthErrorMap'te bakın

İmza:

prodErrorMap: AuthErrorMap

ProviderId

Desteklenen sağlayıcıların listesi.

İmza:

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

SignInMethod

Desteklenen oturum açma yöntemlerinin listesi.

İmza:

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

OAuth Özel Parametreleri eşlemesi.

İmza:

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

NextOrObserver

Etkinlik geri çağırma işlevinin tür tanımı.

İmza:

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

PhoneInfoOptions

Telefon numarasının sahipliğini doğrulamak için gereken bilgiler.

Gerekli bilgiler; tek öğeli oturum açma mı, çok öğeli kayıt veya çok öğeli oturum açma mı yaptığınıza bağlıdır.

İmza:

export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;

UserProfile

AdditionalUserInfo özelliğinde kullanılan kullanıcı profili.

İmza:

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