firebase-admin.app package

Firebase Uygulama ve SDK başlatma.

İşlevler

İşlev Açıklama
applicationDefault(httpAgent) Google Uygulaması Varsayılan Kimlik Bilgileri'nden oluşturulan ve Firebase hizmetlerine yönetici erişimi sağlayan bir kimlik bilgisi 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 herhangi bir Google altyapısında kullanılabilir.Daha fazla ayrıntı 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 bir kimlik bilgisi 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.
deleteApp(uygulama) Bu 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'yı yerel olarak çalıştırırken, sürecin sorunsuz bir şekilde sonlandırılmasını sağlamak için bu yöntem çağrılmalıdır.
getApp(uygulamaAdı)
getApps()
initializeApp(options, appName)
refreshToken(refreshTokenPathOrObject, httpAgent) Sağlanan yenileme jetonundan oluşturulan ve Firebase hizmetlerine yönetici erişimi sağlayan bir kimlik bilgisi 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.

Arayüzler

Arayüz Açıklama
Uygulama Firebase uygulamaları, bir dizi hizmete ait başlatma bilgilerini barındırır.
Uygulama Seçenekleri initializeApp() parametresine iletilebilecek 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 kendiniz 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 dizin içeren bileşik tür.
FirebaseError FirebaseError, standart JavaScript Error nesnesinin bir alt sınıfıdır. Mesaj dizesi ve yığın izlemeye ek olarak bir dize kodu da içerir.
GoogleOAuthAccessToken Google OAuth 2.0 erişim jetonları arayüzü.
Hizmet Hesabı

Değişkenler

Değişken Açıklama
SDK_VERSION

applicationDefault(httpAgent)

Google Uygulaması Varsayılan Kimlik Bilgileri'nden oluşturulan ve Firebase hizmetlerine yönetici erişimi sağlayan bir kimlik bilgisi 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 herhangi bir 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
httpAracı Agent Google jeton sunucularından erişim jetonları alırken kullanılacak isteğe bağlı HTTP Aracısı.

İadeler:

Kimlik bilgisi

Google Uygulaması Varsayılan Kimlik Bilgileri aracılığıyla kimliği doğrulanmış ve uygulamayı ilk kullanıma hazırlamak için kullanılabilecek 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 bir kimlik bilgisi 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 | ServiceAccount Hizmet hesabı anahtarı JSON dosyasının veya hizmet hesabı anahtarını temsil eden nesnenin yolu.
httpAracı Agent Google jeton sunucularından erişim jetonları alırken kullanılacak isteğe bağlı HTTP Aracısı.

İadeler:

Kimlik bilgisi

Bir uygulamayı ilk kullanıma hazırlamak için kullanılabilecek, sağlanan hizmet hesabı aracılığıyla kimliği doğrulanmış 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)

Bu 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'yı yerel olarak çalıştırırken, sürecin sorunsuz bir şekilde sonlandırılmasını sağlamak 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

İadeler:

Taahhüt<void>

Örnek

deleteApp(app)
  .then(function() {
    console.log("App deleted successfully");
  })
  .catch(function(error) {
    console.log("Error deleting app:", error);
  });

getApp(uygulamaAdı)

İmza:

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

Parametreler

Parametre Tür Açıklama
uygulamaAdı dize

İadeler:

Uygulama

getApps()

İmza:

export declare function getApps(): App[];

İadeler:

Uygulama[]

initializeApp(seçenekler, uygulamaAdı)

İmza:

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

Parametreler

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

İadeler:

Uygulama

yenilemeToken(refreshTokenPathOrObject, httpAgent)

Sağlanan yenileme jetonundan oluşturulan ve Firebase hizmetlerine yönetici erişimi sağlayan bir kimlik bilgisi 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
YenilemeTokenYolVeNesnesi dize | nesne Google OAuth2 yenileme jetonu JSON dosyasının veya Google OAuth2 yenileme jetonunu temsil eden bir nesnenin yolu.
httpAracı Agent Google jeton sunucularından erişim jetonları alırken kullanılacak isteğe bağlı HTTP Aracısı.

İadeler:

Kimlik bilgisi

Bir uygulamayı ilk kullanıma hazırlamak için kullanılabilecek, sağlanan hizmet hesabı aracılığıyla kimliği doğrulanmış 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