Firebase Uygulaması
Bu paket, farklı Firebase bileşenleri arasındaki iletişimi koordine eder
İşlevler
İşlev | Açıklama |
---|---|
fonksiyon(uygulama, ...) | |
deleteApp(app) | Bu uygulamayı kullanılamaz hale getirir ve ilişkili tüm hizmetlerin kaynaklarını serbest bırakır. |
fonksiyon() | |
getApps() | Başlatılan tüm uygulamaları içeren bir (salt okunur) dizisi. |
initializeApp() | Bir FirebaseApp örneği oluşturur ve ilk kullanıma hazırlar. |
function(libraryKeyOrName, ...) | |
registerVersion(libraryKeyOrName, sürüm, varyasyon) | Platform günlük kaydı amacıyla bir kitaplığın adını ve sürümünü kaydeder. |
function(logCallback, ...) | |
onLog(logCallback, options) | Tüm Firebase SDK'ları için günlük işleyiciyi ayarlar. |
function(logLevel, ...) | |
setLogLevel(logLevel) | Tüm Firebase SDK'larının günlük düzeyini ayarlar.Geçerli günlük düzeyinin üzerindeki tüm günlük türleri yakalanır (günlük düzeyini info olarak ayarlarsanız hatalar günlüğe kaydedilir, ancak debug ve verbose günlükleri kaydedilmez). |
fonksiyon(ad, ...) | |
getApp(ad) | 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 o ada karşılık gelen uygulama döndürülür.Alınan uygulama henüz başlatılmadıysa istisna oluşur. |
fonksiyon(seçenekler, ...) | |
initializeApp(options, ad) | Bir FirebaseApp örneği oluşturur ve başlatır.Ayrıntılı belgeler için Firebase'i uygulamanıza ekleme ve Birden çok projeyi başlatma başlıklı makaleleri inceleyin. |
initializeApp(options, config) | Bir FirebaseApp örneği oluşturur ve ilk kullanıma hazırlar. |
initializeServerApp(seçenekler, yapılandırma) | FirebaseServerApp örneği oluşturur ve başlatır.FirebaseServerApp , FirebaseApp ile benzerdir ancak yalnızca sunucu tarafı oluşturma ortamlarında yürütülmek üzere tasarlanmıştır. Tarayıcı ortamından çağrı yapılırsa başlatma başarısız olur.Ayrıntılı belgeler için Firebase'i uygulamanıza ekleme ve Birden fazla proje başlatma başlıklı makaleleri inceleyin. |
Arayüzler
Arayüz | Açıklama |
---|---|
FirebaseUygulaması | 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çin verilen yapılandırma seçenekleri |
FirebaseOptions | Firebase yapılandırma nesnesi. Firebase sunucu API'leriyle başarılı bir iletişim kurmak ve istemci verilerini Firebase projeniz ve Firebase uygulamanızla ilişkilendirmek için hizmetlerin ihtiyaç duyduğu parametreleri içerir. Genellikle bu nesne, 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 dizi hizmet için 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ü. |
function(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 | FirebaseUygulaması |
Şunu döndürür:
Taahhüt<void>
Örnek
deleteApp(app)
.then(function() {
console.log("App deleted successfully");
})
.catch(function(error) {
console.log("Error deleting app:", error);
});
fonksiyon()
getApps()
Başlatılan tüm uygulamaları içeren bir (salt okunur) dizisi.
İmza:
export declare function getApps(): FirebaseApp[];
Şunu döndürür:
initializeApp()
Bir FirebaseApp örneği oluşturur ve ilk kullanıma hazırlar.
İmza:
export declare function initializeApp(): FirebaseApp;
Şunu döndürür:
function(libraryKeyOrName; ...)
registerVersion(libraryKeyOrName, sürüm, varyant)
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 |
---|---|---|
kitaplıkAnahtarıVeyaAdı | dize | |
sürüm | dize | Bu kitaplığın geçerli sürümü. |
variant | dize | Paket varyantı, ör. düğüm, rn vb. |
Şunu döndürür:
geçersiz
function(logCallback, ...)
onLog(logCallback, options)
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 | LogCallback | boş | Firebase SDK'sı her günlük kaydı çağrısı yaptığında kullanıcı kodunu yürüten isteğe bağlı bir özel günlük işleyici. |
seçenekler | Günlük Seçenekleri |
Şunu döndürür:
geçersiz
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 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 | Günlük DüzeyiDizesi |
Şunu döndürür:
geçersiz
function(ad; ...)
getApp(ad)
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 değer "[DEFAULT]" olur. |
Şunu döndürür:
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");
function(seçenekler; ...)
startizeApp(seçenekler; ad)
Bir FirebaseApp örneği oluşturur ve örneği başlatır.
Ayrıntılı belgeler için Firebase'i uygulamanıza ekleme ve Birden fazla projeyi başlatma bölümlerine göz atın.
İ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 değer "[DEFAULT]" olur. |
Şunu döndürür:
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");
startizeApp(seçenekler, yapılandırma)
Bir FirebaseApp örneği oluşturur ve ilk kullanıma hazırlar.
İ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. |
yapılandırma | FirebaseAppSettings | FirebaseApp Yapılandırması |
Şunu döndürür:
startizeServerApp(seçenekler; yapılandırma)
Bir FirebaseServerApp örneği oluşturur ve örneği başlatır.
FirebaseServerApp
, FirebaseApp
özelliğine benzer ancak yalnızca sunucu tarafı oluşturma ortamlarında çalıştırılmak üzere 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 Firebase'i uygulamanıza ekleme ve Birden fazla projeyi başlatma bölümlerine göz atın.
İmza:
export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
seçenekler | FirebaseOptions | Firebase Uygulaması | Uygulamanın hizmetlerini yapılandırmak için Firebase.AppOptions veya içinde AppOptions öğesini içeren bir FirebaseApp örneği. |
yapılandırma | FirebaseServerAppSettings | FirebaseServerApp yapılandırması. |
Şunu döndürür:
FirebaseServerApp
başlatıldı.
Ö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