firebase-admin.app package

Inicjowanie aplikacji Firebase i pakietu SDK.

Funkcje

Funkcja Opis
applicationDefault(httpAgent) Zwraca dane logowania utworzone na podstawie domyślnych danych logowania aplikacji Google, które przyznają dostęp administracyjny do usług Firebase. Tych danych można użyć w wywołaniu funkcji initializeApp().Domyślne dane logowania aplikacji Google są dostępne w dowolnej infrastrukturze Google, takiej jak Google App Engine czy Google Compute Engine.Więcej informacji znajdziesz w artykule Inicjowanie pakietu SDK.
cert(serviceAccountPathOrObject, httpAgent) Zwraca dane logowania utworzone z podanego konta usługi, które przyznają dostęp administracyjny do usług Firebase. Tych danych logowania można użyć w wywołaniu funkcji initializeApp().Więcej informacji znajdziesz w sekcji Inicjowanie pakietu SDK.
deleteApp(aplikacja) Renderuje dane App i uwalnia zasoby wszystkich powiązanych usług (chociaż *nie* czyści zasobów backendu). W przypadku lokalnego uruchamiania pakietu SDK ta metoda musi być wywołana, aby zapewnić płynne zakończenie procesu.
getApp(nazwa_aplikacji)
getApps()
initializeApp(options, appName)
refreshToken(refreshTokenPathOrObject, httpAgent). Zwraca dane logowania utworzone na podstawie podanego tokena odświeżania, który przyznaje dostęp administracyjny do usług Firebase. Tych danych logowania można użyć w wywołaniu funkcji initializeApp().Więcej informacji znajdziesz w sekcji Inicjowanie pakietu SDK.

Zajęcia

Klasa Opis
Kody błędów aplikacji Kody błędów klienta aplikacji i ich komunikaty domyślne.
FirebaseAppError Struktura kodu błędu aplikacji Firebase. Rozszerza ten błąd PrefixedFirebaseError.

Interfejsy

Interfejs Opis
Aplikacja Aplikacja Firebase przechowuje informacje o inicjowaniu kolekcji usług.
Opcje AppOptions Dostępne opcje przekazywania do initializeApp().
Dane logowania Interfejs udostępniający tokeny dostępu Google OAuth2 używane do uwierzytelniania w usługach Firebase.W większości przypadków nie trzeba wdrażać tego samodzielnie i można skorzystać z domyślnych implementacji udostępnianych przez moduł firebase-admin/app.
FirebaseTrackIndexError Typ złożony, który zawiera zarówno obiekt FirebaseError, jak i indeks, którego można użyć do pobrania elementu z błędem.
Błąd Firebase FirebaseError to podklasa standardowego obiektu JavaScript Error. Oprócz ciągu tekstowego komunikatu i zrzutu stosu zawiera on ciąg znaków.
GoogleOAuthAccessToken Interfejs tokenów dostępu Google OAuth 2.0.
Konto usługi

Zmienne

Zmienna Opis
SDK_VERSION

applicationDefault(httpAgent)

Zwraca dane logowania utworzone na podstawie domyślnych danych logowania aplikacji Google, które przyznają dostęp administracyjny do usług Firebase. Tych danych można użyć w wywołaniu initializeApp().

Domyślne uwierzytelniające dane aplikacji Google są dostępne w dowolnej infrastrukturze Google, takiej jak Google App Engine czy Google Compute Engine.

Więcej informacji znajdziesz w artykule Inicjowanie pakietu SDK.

Podpis:

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

Parametry

Parametr Typ Opis
http://Pracownik obsługi klienta Agent Opcjonalny agent HTTP używany przy pobieraniu tokenów dostępu z serwerów tokenów Google.

Zwroty:

Dane logowania

Dane logowania uwierzytelnione za pomocą domyślnych danych logowania aplikacji Google, których można użyć do zainicjowania aplikacji.

Przykład

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

cert(serviceAccountPathOrObject, httpAgent)

Zwraca dane logowania utworzone z podanego konta usługi, które przyznają dostęp administracyjny do usług Firebase. Tych danych można użyć w wywołaniu initializeApp().

Więcej informacji znajdziesz w artykule Inicjowanie pakietu SDK.

Podpis:

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

Parametry

Parametr Typ Opis
Ścieżka_konta_usługi_lubobiekt ciąg znaków | Konto usługi Ścieżka do pliku JSON klucza konta usługi lub obiektu reprezentującego klucz konta usługi.
http://Pracownik obsługi klienta Agent Opcjonalny agent HTTP używany przy pobieraniu tokenów dostępu z serwerów tokenów Google.

Zwroty:

Dane logowania

Dane logowania uwierzytelnione za pomocą podanego konta usługi, których można użyć do zainicjowania aplikacji.

Przykład 1

// 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"
});

Przykład 2

// 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(aplikacja)

Renderuje dane App i uwalnia zasoby wszystkich powiązanych usług (chociaż *nie* czyści zasobów backendu). W przypadku lokalnego uruchamiania pakietu SDK ta metoda musi być wywołana, aby zapewnić płynne zakończenie procesu.

Podpis:

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

Parametry

Parametr Typ Opis
aplikacja Aplikacja

Zwroty:

Obietnica<void>

Przykład

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

getApp(nazwaaplikacji)

Podpis:

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

Parametry

Parametr Typ Opis
Nazwa_aplikacji ciąg znaków

Zwroty:

Aplikacja

getApps()

Podpis:

export declare function getApps(): App[];

Zwroty:

Aplikacja[]

inicjujApp(opcje, nazwa_aplikacji)

Podpis:

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

Parametry

Parametr Typ Opis
opcje Opcje AppOptions
Nazwa_aplikacji ciąg znaków

Zwroty:

Aplikacja

OdświeżToken(refreshTokenPathOrObject, httpAgent)

Zwraca dane logowania utworzone na podstawie podanego tokena odświeżania, który przyznaje dostęp administracyjny do usług Firebase. Tych danych można użyć w wywołaniu initializeApp().

Więcej informacji znajdziesz w artykule Inicjowanie pakietu SDK.

Podpis:

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

Parametry

Parametr Typ Opis
OdświeżTokenPathOrObject ciąg znaków | obiekt Ścieżka do pliku JSON tokena odświeżania Google OAuth2 lub obiektu reprezentującego token odświeżania Google OAuth2.
http://Pracownik obsługi klienta Agent Opcjonalny agent HTTP używany podczas pobierania tokenów dostępu z serwerów tokenów Google.

Zwroty:

Dane logowania

Dane logowania uwierzytelnione za pomocą podanego konta usługi, których można użyć do zainicjowania aplikacji.

Przykład

// 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

Podpis:

SDK_VERSION: string