Firebase Auth hizmetini temsil eden arayüz.
Firebase Auth hizmetinin nasıl kullanılacağına ilişkin eksiksiz bir kılavuz için Firebase Authentication'a bakın.
İmza:
export interface Auth
Özellikler
Özellik | Tür | Açıklama |
---|---|---|
uygulama | FirebaseApp | Auth hizmet örneğiyle ilişkili FirebaseApp. |
yapılandırma | Yapılandırma | Bu örneği ilk kullanıma hazırlamak için kullanılan Config. |
currentUser | Kullanıcı | null | Şu anda oturum açmış (veya boş) kullanıcı. |
emulatorConfig | EmulatorConfig | null | Geçerli emülatör yapılandırması (veya boş). |
languageCode | dize | null | Auth örneğinin dil kodu. |
name | dize | Auth hizmet örneğiyle ilişkilendirilen uygulamanın adı. |
ayarlar | AuthSettings | Auth örneğinin ayarları. |
tenantId | dize | null | Auth örneğinin kiracı kimliği. |
Yöntemler
Yöntem | Açıklama |
---|---|
authStateReady() | başlangıçtaki yetkilendirme durumu düzeltildiğinde hemen çözümlenen bir vaat döndürür. Sözü yerine getirildiğinde mevcut kullanıcı geçerli bir kullanıcı veya kullanıcı oturumunu kapattıysa null olabilir. |
beforeAuthStateChanged(callback, onAbort) | Bir yetkilendirme durumu değişikliği yeni bir kullanıcıyı ayarlamadan önce çalışan bir engelleme geri çağırması ekler. |
onAuthStateChanged(nextOrObserver, error, completed) | Kullanıcının oturum açma durumundaki değişiklikler için bir gözlemci ekler. |
onIdTokenChanged(nextOrObserver, error, completed) | Oturum açmış kullanıcının kimlik jetonunda yapılan değişiklikler için bir gözlemci ekler. |
setPersistence(persistence) | Auth örneğindeki kalıcılık türünü değiştirir. |
signOut() | Geçerli kullanıcının oturumu kapatılır. Bu işlem kullanıcının kimlik jetonunu otomatik olarak iptal etmez. |
updateCurrentUser(user) | Sağlanan kullanıcıyı, Auth örneğinde eşzamansız olarak Auth.currentUser olarak ayarlar. |
useDeviceLanguage() | Geçerli dili varsayılan cihaz/tarayıcı tercihine ayarlar. |
Auth.app
Auth
hizmet örneğiyle ilişkili FirebaseApp.
İmza:
readonly app: FirebaseApp;
Auth.config
Bu örneği ilk kullanıma hazırlamak için kullanılan Config.
İmza:
readonly config: Config;
Auth.currentUser
Şu anda oturum açmış (veya boş) kullanıcı.
İmza:
readonly currentUser: User | null;
Auth.emulatorConfig
Geçerli emülatör yapılandırması (veya boş).
İmza:
readonly emulatorConfig: EmulatorConfig | null;
Auth.languageCode
Auth örneğinin dil kodu.
Bu, okunabilir/yazılabilir bir özelliktir. Boş değerine ayarlandığında, varsayılan Firebase Konsolu dil ayarı uygulanır. Dil kodu, belirtilen sağlayıcıların belirtilen dil koduyla yerelleştirmeyi desteklemesi koşuluyla, e-posta işlem şablonlarına (şifre sıfırlama, e-posta doğrulaması ve e-posta değişikliği iptali), telefonla kimlik doğrulama için SMS şablonlarına, reCAPTCHA doğrulayıcısı ve OAuth pop-up/yönlendirme işlemlerine uygulanır.
İmza:
languageCode: string | null;
Auth.name
Auth
hizmet örneğiyle ilişkilendirilen uygulamanın adı.
İmza:
readonly name: string;
Auth.settings
Auth örneğinin ayarları.
Bu, telefonla kimlik doğrulama için uygulama doğrulama modu gibi yapılandırmayla ilgili seçenekleri düzenlemek/okumak için kullanılır.
İmza:
readonly settings: AuthSettings;
Auth.tenantId
Auth örneğinin kiracı kimliği.
Bu, okunabilir/yazılabilir bir özelliktir. Bir Auth örneğinin kiracı kimliğini ayarladığınızda, gelecekteki tüm oturum açma/kaydolma işlemleri bu kiracı kimliğini iletir ve belirtilen kiracı projede kullanıcıların oturumunu açar veya kaydeder. Null değerine ayarlanırsa kullanıcılar üst projede oturum açar.
İmza:
tenantId: string | null;
Örnek
// Set the tenant ID on Auth instance.
auth.tenantId = 'TENANT_PROJECT_ID';
// All future sign-in request now include tenant ID.
const result = await signInWithEmailAndPassword(auth, email, password);
// result.user.tenantId should be 'TENANT_PROJECT_ID'.
Auth.authStateReady()
başlangıçtaki yetkilendirme durumu düzeltildiğinde hemen çözümlenen bir vaat döndürür. Sözü yerine getirildiğinde mevcut kullanıcı geçerli bir kullanıcı veya kullanıcı oturumunu kapattıysa null
olabilir.
İmza:
authStateReady(): Promise<void>;
İadeler:
Promise<void>
Auth.beforeAuthStateChanged()
Bir yetkilendirme durumu değişikliği yeni bir kullanıcıyı ayarlamadan önce çalışan bir engelleme geri çağırması ekler.
İmza:
beforeAuthStateChanged(callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
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:
Auth.onAuthStateChanged()
Kullanıcının oturum açma durumundaki değişiklikler için bir gözlemci ekler.
Eski davranışı korumak için Auth.onIdTokenChanged() yöntemini inceleyin.
İmza:
onAuthStateChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
nextOrObserver | NextOrObserver<User | null> | 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:
Auth.onIdTokenChanged()
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.
İmza:
onIdTokenChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
nextOrObserver | NextOrObserver<User | null> | 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:
Auth.setPersistence()
Auth
örneğindeki kalıcılık türünü değiştirir.
Bu işlem, mevcut durumda kayıtlı olan Auth oturumunu etkiler ve yönlendirme istekleriyle oturum açma da dahil olmak üzere gelecekteki oturum açma isteklerine bu tür kalıcılığı 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 Kimlik Doğrulama durumunu hiçbir zaman korumayı kolaylaştırır.
Bu yöntem Node.js ortamında çalışmaz.
İmza:
setPersistence(persistence: Persistence): Promise<void>;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
kalıcılık | Karar | Kullanılacak Kalıcılık. |
İadeler:
Promise<void>
Örnek
auth.setPersistence(browserSessionPersistence);
Auth.signOut()
Geçerli kullanıcının oturumu kapatılır. Bu işlem kullanıcının kimlik jetonunu otomatik olarak iptal etmez.
Bu yöntem, bir FirebaseServerApp ile oluşturulan Auth örnekleri tarafından desteklenmez.
İmza:
signOut(): Promise<void>;
İadeler:
Promise<void>
Auth.updateCurrentUser()
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 Auth.onAuthStateChanged() ve Auth.onIdTokenChanged() işleyicilerini tetikler.
Güncellenecek kullanıcı farklı bir Firebase projesine aitse işlem bir hatayla başarısız olur.
İmza:
updateCurrentUser(user: User | null): Promise<void>;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
kullanıcı | Kullanıcı | null | Yeni Kullanıcı. |
İadeler:
Promise<void>
Auth.useDeviceLanguage()
Geçerli dili varsayılan cihaz/tarayıcı tercihine ayarlar.
İmza:
useDeviceLanguage(): void;
İadeler:
void