firebase-admin.app package

Firebase uygulaması ve SDK'yı başlatma.

İşlevler

İşlev Açıklama
applicationDefault(httpAgent) Google Uygulaması Varsayılan Kimlik Bilgileri'nden oluşturulan ve Firebase hizmetlerine yönetici erişimi veren kimlik bilgisini döndürür. Bu kimlik bilgisi initializeApp() çağrısında kullanılabilir.Google Uygulaması Varsayılan Kimlik Bilgileri, Google App Engine ve Google Compute Engine gibi tüm Google altyapılarında kullanılabilir.Daha fazla bilgi için SDK'yı başlatma bölümüne bakın.
cert(serviceAccountPathOrObject, httpAgent) Sağlanan hizmet hesabından oluşturulan ve Firebase hizmetlerine yönetici erişimi veren kimlik bilgisini döndürür. Bu kimlik bilgisi initializeApp() çağrısında kullanılabilir.Daha ayrıntılı bilgi için SDK'yı başlatma bölümüne bakın.
deleteApp(app) Belirtilen App öğesini kullanılamaz hale getirir ve ilişkili tüm hizmetlerin kaynaklarını serbest bırakır (ancak arka uç kaynaklarını temizlemez*). SDK yerel olarak çalıştırılırken işlemin uygun şekilde sonlandırılması için bu yöntem çağrılmalıdır.
getApp(appName)
getApps()
initializeApp(options, appName)
refreshToken(refreshTokenPathOrObject, httpAgent) Sağlanan yenileme jetonundan oluşturulan ve Firebase hizmetlerine yönetici erişimi veren kimlik bilgisini döndürür. Bu kimlik bilgisi initializeApp() çağrısında kullanılabilir.Daha ayrıntılı bilgi için SDK'yı başlatma bölümüne bakın.

Sınıflar

Sınıf Açıklama
AppErrorCode Uygulama istemcisi hata kodları ve varsayılan mesajları.
FirebaseAppError Firebase uygulaması hata kodu yapısı. Bu, PrefixedFirebaseError uzantısını genişletir.

Arayüzler

Arayüz Açıklama
Uygulama Firebase uygulamaları, bir hizmet koleksiyonunun başlatma bilgilerini saklar.
Uygulama Seçenekleri initializeApp() işlevine iletmek için kullanılabilecek seçenekler.
Kimlik bilgisi Firebase hizmetleriyle kimlik doğrulamak için kullanılan, Google OAuth2 erişim jetonlarını sağlayan arayüzdür.Çoğu durumda bunu sizin uygulamanız gerekmez. Bunun yerine, firebase-admin/app modülü tarafından sağlanan varsayılan uygulamaları kullanabilirsiniz.
FirebaseArrayIndexError Hatalı öğeyi almak için kullanılabilecek bir FirebaseError nesnesi ve bir dizin içeren birleşik tür.
Firebase Hatası FirebaseError, standart JavaScript Error nesnesinin alt sınıfıdır. Mesaj dizesi ve yığın izlemeye ek olarak, dize kodu da içerir.
GoogleOAuthAccessToken Google OAuth 2.0 erişim jetonları arayüzü.
HizmetHesabı

Değişkenler

Değişken Açıklama
SDK_VERSION

applicationDefault(httpAracı)

Google Uygulaması Varsayılan Kimlik Bilgileri'nden oluşturulan ve Firebase hizmetlerine yönetici erişimi veren kimlik bilgisini döndürür. Bu kimlik bilgisi initializeApp() çağrısında kullanılabilir.

Google Uygulaması Varsayılan Kimlik Bilgileri, Google App Engine ve Google Compute Engine gibi her Google altyapısında kullanılabilir.

Daha fazla bilgi için SDK'yı başlatma bölümüne bakın.

İmza:

export declare function applicationDefault(httpAgent?: Agent): Credential;

Parametreler

Parametre Tür Açıklama
httpTemsilci Aracı Google jeton sunucularından erişim jetonları alınırken kullanılacak isteğe bağlı HTTP Aracısı.

Şunu döndürür:

Kimlik bilgisi

Bir uygulamayı başlatmak için kullanılabilecek, Google Uygulaması Varsayılan Kimlik Bilgileri aracılığıyla doğrulanan bir kimlik bilgisi.

Örnek

initializeApp({
  credential: applicationDefault(),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

cert(serviceAccountPathOrObject, httpAgent)

Sağlanan hizmet hesabından oluşturulan ve Firebase hizmetlerine yönetici erişimi veren kimlik bilgisini döndürür. Bu kimlik bilgisi initializeApp() çağrısında kullanılabilir.

Daha fazla bilgi için SDK'yı başlatma bölümüne bakın.

İmza:

export declare function cert(serviceAccountPathOrObject: string | ServiceAccount, httpAgent?: Agent): Credential;

Parametreler

Parametre Tür Açıklama
hizmetHesabıYoluVeyaNesnesi dize | HizmetHesabı Hizmet hesabı anahtarı JSON dosyasına veya hizmet hesabı anahtarını temsil eden bir nesnenin yolu.
httpTemsilci Aracı Google jeton sunucularından erişim jetonları alınırken kullanılacak isteğe bağlı HTTP Aracısı.

Şunu döndürür:

Kimlik bilgisi

Bir uygulamayı başlatmak için kullanılabilecek, sağlanan hizmet hesabı tarafından kimliği doğrulanan kimlik bilgisi.

1. örnek

// Providing a path to a service account key JSON file
const serviceAccount = require("path/to/serviceAccountKey.json");
initializeApp({
  credential: cert(serviceAccount),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

2. örnek

// Providing a service account object inline
initializeApp({
  credential: cert({
    projectId: "<PROJECT_ID>",
    clientEmail: "foo@<PROJECT_ID>.iam.gserviceaccount.com",
    privateKey: "-----BEGIN PRIVATE KEY-----<KEY>-----END PRIVATE KEY-----\n"
  }),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

deleteApp(uygulama)

Belirtilen App öğesini kullanılamaz hale getirir ve ilişkili tüm hizmetlerin kaynaklarını serbest bırakır (ancak arka uç kaynaklarını temizlemez*). SDK yerel olarak çalıştırılırken işlemin uygun şekilde sonlandırılması için bu yöntem çağrılmalıdır.

İmza:

export declare function deleteApp(app: App): Promise<void>;

Parametreler

Parametre Tür Açıklama
uygulama Uygulama

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

getApp(appName)

İmza:

export declare function getApp(appName?: string): App;

Parametreler

Parametre Tür Açıklama
uygulamaAdı dize

Şunu döndürür:

Uygulama

getApps()

İmza:

export declare function getApps(): App[];

Şunu döndürür:

Uygulama[]

startizeApp(options, appName)

İmza:

export declare function initializeApp(options?: AppOptions, appName?: string): App;

Parametreler

Parametre Tür Açıklama
seçenekler Uygulama Seçenekleri
uygulamaAdı dize

Şunu döndürür:

Uygulama

RenewToken(refreshTokenPathOrObject, httpAgent)

Sağlanan yenileme jetonundan oluşturulan ve Firebase hizmetlerine yönetici erişimi veren kimlik bilgisini döndürür. Bu kimlik bilgisi initializeApp() çağrısında kullanılabilir.

Daha fazla bilgi için SDK'yı başlatma bölümüne bakın.

İmza:

export declare function refreshToken(refreshTokenPathOrObject: string | object, httpAgent?: Agent): Credential;

Parametreler

Parametre Tür Açıklama
YenilemeTokenYoluVeyaNesnesi dize | nesne Google OAuth2 yenileme jetonu JSON dosyasına veya Google OAuth2 yenileme jetonunu temsil eden bir nesneye giden yol.
httpTemsilci Aracı Google jeton sunucularından erişim jetonları alınırken kullanılacak isteğe bağlı HTTP Aracısı.

Şunu döndürür:

Kimlik bilgisi

Bir uygulamayı başlatmak için kullanılabilecek, sağlanan hizmet hesabı tarafından kimliği doğrulanan kimlik bilgisi.

Örnek

// Providing a path to a refresh token JSON file
const refreshToken = require("path/to/refreshToken.json");
initializeApp({
  credential: refreshToken(refreshToken),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

SDK_VERSION

İmza:

SDK_VERSION: string