Firebase Uygulaması
Bu paket, farklı Firebase bileşenleri arasındaki iletişimi koordine eder
İşlevler
İşlev | Açıklama |
---|---|
function(uygulama; ...) | |
deleteApp(uygulama) | Bu uygulamayı kullanılamaz hale getirir ve ilişkili tüm hizmetlerin kaynaklarını serbest bırakır. |
function() | |
getApps() | Başlatılmış tüm uygulamaları içeren bir (salt okunur) dizi. |
initializeApp() | Bir FirebaseApp örneği oluşturup başlatır. |
function(libraryKeyOrName, ...) | |
registerVersion(libraryKeyOrName, version, variant) | Platform günlük kaydı amacıyla bir kitaplığın adını ve sürümünü kaydeder. |
function(logCallback, ...) | |
onLog(logCallback, seçenekler) | Tüm Firebase SDK'ları için günlük işleyiciyi ayarlar. |
function(logLevel, ...) | |
setLogLevel(logLevel) | Tüm Firebase SDK'ları için günlük düzeyini ayarlar.Geçerli günlük düzeyinin üzerindeki tüm günlük türleri yakalanır (ör. günlük düzeyini info olarak ayarlarsanız hatalar kaydedilir ancak debug ve verbose günlükleri kaydedilmez). |
function(ad, ...) | |
getApp(ad) | Bir FirebaseApp örneği alır.Bağımsız değişken olmadan çağrıldığında, varsayılan uygulama döndürülür. Bir uygulama adı sağlandığında, bu ada karşılık gelen uygulama döndürülür.Alınan uygulama henüz başlatılmadıysa bir istisna oluşturulur. |
function(options, ...) | |
initializeApp(seçenekler, ad) | Bir FirebaseApp örneği oluşturup başlatır.Ayrıntılı belgeler için Firebase'i uygulamanıza ekleme ve Birden fazla projeyi başlatma konularına bakın. |
initializeApp(seçenekler, yapılandırma) | Bir FirebaseApp örneği oluşturup başlatır. |
initializeServerApp(seçenekler, yapılandırma) | Bir FirebaseServerApp örneği oluşturup başlatır.FirebaseServerApp , FirebaseApp özelliğine benzer ancak yalnızca sunucu tarafı oluşturma ortamlarında yürütmeye yöneliktir. Tarayıcı ortamından çağrılırsa başlatma başarısız olur.Ayrıntılı belgeler için Firebase'i uygulamanıza ekleme ve Birden çok projeyi başlatma başlıklı makaleleri inceleyin. |
Arayüzler
Arayüz | Açıklama |
---|---|
FirebaseApp | FirebaseApp, bir hizmet koleksiyonu için başlatma bilgilerini içerir.Bu oluşturucuyu doğrudan çağırmayın. Bunun yerine, bir uygulama oluşturmak için initializeApp() işlevini kullanın. |
FirebaseAppSettings | initializeApp() işlevi için verilen yapılandırma seçenekleri |
FirebaseOptions | Firebase yapılandırma nesnesi. Firebase sunucu API'leriyle başarılı bir şekilde iletişim kurmak, istemci verilerini Firebase projeniz ve Firebase uygulamanızla ilişkilendirmek için hizmetlerin gerektirdiği bir dizi parametreyi içerir. Bu nesne genellikle proje kurulumu sırasında Firebase konsolu tarafından doldurulur. Ayrıca bkz. Firebase yapılandırma nesnesi hakkında bilgi. |
FirebaseServerApp | FirebaseServerApp, sunucu ortamlarında çalışan bir hizmet koleksiyonuna ait başlatma bilgilerini içerir.Bu oluşturucuyu doğrudan çağırmayın. Bunun yerine, bir uygulama oluşturmak için initializeServerApp() işlevini kullanın. |
FirebaseServerAppSettings | initializeServerApp() için verilen yapılandırma seçenekleri |
Değişkenler
Değişken | Açıklama |
---|---|
SDK_VERSION | Mevcut SDK sürümü. |
Functions(uygulama; ...)
deleteApp(uygulama)
Bu uygulamayı kullanılamaz hale getirir ve ilişkili tüm hizmetlerin kaynaklarını serbest bırakır.
İmza:
export declare function deleteApp(app: FirebaseApp): Promise<void>;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
uygulama | FirebaseApp |
İadeler:
Promise<void>
Örnek
deleteApp(app)
.then(function() {
console.log("App deleted successfully");
})
.catch(function(error) {
console.log("Error deleting app:", error);
});
fonksiyon
getApps()
Başlatılmış tüm uygulamaları içeren bir (salt okunur) dizi.
İmza:
export declare function getApps(): FirebaseApp[];
İadeler:
initializeApp()
Bir FirebaseApp örneği oluşturup başlatır.
İmza:
export declare function initializeApp(): FirebaseApp;
İadeler:
function(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, version, variant)
Platform günlük kaydı amacıyla bir kitaplığın adını ve sürümünü kaydeder.
İmza:
export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
libraryKeyOrName | dize | |
sürüm | dize | Kitaplığın geçerli sürümü. |
variant | dize | Paket varyantı, ör. düğüm, rn vb. |
İadeler:
void
function(logCallback, ...)
onLog(logCallback, seçenekler)
Tüm Firebase SDK'ları için günlük işleyiciyi ayarlar.
İmza:
export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
logCallback | Geri Çağırma | null | Firebase SDK'sı günlük kaydı çağrısı yaptığında, kullanıcı kodunu yürüten isteğe bağlı özel bir günlük işleyicisi. |
seçenekler | LogOptions |
İadeler:
void
Functions(logLevel, ...)
setLogLevel(logLevel)
Tüm Firebase SDK'ları için günlük düzeyini ayarlar.
Geçerli günlük düzeyinin üzerindeki tüm günlük türleri yakalanır (ör. günlük düzeyini info
olarak ayarlarsanız hatalar günlüğe kaydedilir ancak debug
ve verbose
günlükleri kaydedilmez).
İmza:
export declare function setLogLevel(logLevel: LogLevelString): void;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
logLevel | LogLevelString |
İadeler:
void
işlev(ad; ...)
getApp(ad)
Bir FirebaseApp örneğini alır.
Bağımsız değişken olmadan çağrıldığında, varsayılan uygulama döndürülür. Bir uygulama adı sağlandığında, bu ada karşılık gelen uygulama döndürülür.
Alınan uygulama henüz başlatılmadıysa bir istisna oluşur.
İmza:
export declare function getApp(name?: string): FirebaseApp;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
ad | dize | Döndürülecek uygulamanın isteğe bağlı adı. Herhangi bir ad sağlanmazsa varsayılan olarak "[DEFAULT]" kullanılır. |
İadeler:
Sağlanan uygulama adına karşılık gelen uygulama. Uygulama adı sağlanmazsa varsayılan uygulama döndürülür.
1. Örnek
// Return the default app
const app = getApp();
2. Örnek
// Return a named app
const otherApp = getApp("otherApp");
Functions(seçenekler, ...)
initializeApp(seçenekler; ad)
Bir FirebaseApp örneği oluşturup başlatır.
Ayrıntılı belgeler için Uygulamanıza Firebase'i ekleme ve Birden çok projeyi başlatma başlıklı makaleleri inceleyin.
İmza:
export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
seçenekler | FirebaseOptions | Uygulamanın hizmetlerini yapılandırma seçenekleri. |
ad | dize | Başlatılacak uygulamanın isteğe bağlı adı. Herhangi bir ad sağlanmazsa varsayılan olarak "[DEFAULT]" kullanılır. |
İadeler:
Başlatılan uygulama.
1. Örnek
// Initialize default app
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeApp({
apiKey: "AIza....", // Auth / General Use
authDomain: "YOUR_APP.firebaseapp.com", // Auth with popup/redirect
databaseURL: "https://YOUR_APP.firebaseio.com", // Realtime Database
storageBucket: "YOUR_APP.appspot.com", // Storage
messagingSenderId: "123456789" // Cloud Messaging
});
2. Örnek
// Initialize another app
const otherApp = initializeApp({
databaseURL: "https://<OTHER_DATABASE_NAME>.firebaseio.com",
storageBucket: "<OTHER_STORAGE_BUCKET>.appspot.com"
}, "otherApp");
initializeApp(seçenekler, yapılandırma)
Bir FirebaseApp örneği oluşturup başlatır.
İmza:
export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
seçenekler | FirebaseOptions | Uygulamanın hizmetlerini yapılandırma seçenekleri. |
config | FirebaseAppSettings | FirebaseApp Yapılandırması |
İadeler:
initializeServerApp(seçenekler, yapılandırma)
Bir FirebaseServerApp örneği oluşturup başlatır.
FirebaseServerApp
, FirebaseApp
ile benzerlik taşır ancak yalnızca sunucu tarafı oluşturma ortamlarında yürütme amacıyla tasarlanmıştır. Bir tarayıcı ortamından çağrılırsa başlatma başarısız olur.
Ayrıntılı belgeler için Uygulamanıza Firebase'i ekleme ve Birden çok projeyi başlatma başlıklı makaleleri inceleyin.
İmza:
export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
seçenekler | FirebaseOptions | FirebaseApp | Uygulamanın hizmetlerini yapılandırmak için Firebase.AppOptions veya içindeki AppOptions öğesini içeren bir FirebaseApp örneği. |
config | FirebaseServerAppSettings | FirebaseServerApp yapılandırması. |
İadeler:
Başlatıldı FirebaseServerApp
.
Örnek
// Initialize an instance of `FirebaseServerApp`.
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeServerApp({
apiKey: "AIza....", // Auth / General Use
authDomain: "YOUR_APP.firebaseapp.com", // Auth with popup/redirect
databaseURL: "https://YOUR_APP.firebaseio.com", // Realtime Database
storageBucket: "YOUR_APP.appspot.com", // Storage
messagingSenderId: "123456789" // Cloud Messaging
},
{
authIdToken: "Your Auth ID Token"
});
SDK_VERSION
Mevcut SDK sürümü.
İmza:
SDK_VERSION: string