firebase-admin.app package

Firebase-App und SDK-Initialisierung.

Funktionen

Funktion Beschreibung
applicationDefault(httpAgent) Gibt Anmeldeinformationen zurück, die aus den Standardanmeldeinformationen der Google-Anwendung erstellt wurden und Administratorzugriff auf Firebase-Dienste gewähren. Diese Anmeldeinformationen können im Aufruf von initializeApp() verwendet werden. . Standardanmeldeinformationen für Google-Anwendungen sind in jeder Google-Infrastruktur verfügbar, z. B. Google App Engine und Google Compute Engine. Weitere Einzelheiten finden Sie unter SDK initialisieren .
cert(serviceAccountPathOrObject, httpAgent) Gibt Anmeldeinformationen zurück, die aus dem bereitgestellten Dienstkonto erstellt wurden und Administratorzugriff auf Firebase-Dienste gewähren. Diese Anmeldeinformationen können im Aufruf von initializeApp() verwendet werden. . Weitere Einzelheiten finden Sie unter SDK initialisieren .
deleteApp(app) Macht diese bestimmte App unbrauchbar und gibt die Ressourcen aller zugehörigen Dienste frei (obwohl *keine* Backend-Ressourcen bereinigt werden). Wenn das SDK lokal ausgeführt wird, muss diese Methode aufgerufen werden, um eine ordnungsgemäße Beendigung des Prozesses sicherzustellen.
getApp(appName)
getApps()
initializeApp(Optionen, AppName)
erfrischendToken(refreshTokenPathOrObject, httpAgent) Gibt Anmeldeinformationen zurück, die aus dem bereitgestellten Aktualisierungstoken erstellt wurden und Administratorzugriff auf Firebase-Dienste gewähren. Diese Anmeldeinformationen können im Aufruf von initializeApp() verwendet werden. . Weitere Einzelheiten finden Sie unter SDK initialisieren .

Schnittstellen

Schnittstelle Beschreibung
App Eine Firebase-App enthält die Initialisierungsinformationen für eine Sammlung von Diensten.
AppOptions Verfügbare Optionen zur Übergabe an initializeApp() .
Ausweis Schnittstelle, die Google OAuth2-Zugriffstoken bereitstellt, die zur Authentifizierung bei Firebase-Diensten verwendet werden. In den meisten Fällen müssen Sie dies nicht selbst implementieren und können stattdessen die vom Modul firebase-admin/app bereitgestellten Standardimplementierungen verwenden.
FirebaseArrayIndexError Zusammengesetzter Typ, der sowohl ein FirebaseError Objekt als auch einen Index enthält, der zum Abrufen des fehlerhaften Elements verwendet werden kann.
FirebaseError FirebaseError ist eine Unterklasse des Standard-JavaScript- Error Objekts. Zusätzlich zu einer Nachrichtenzeichenfolge und einem Stack-Trace enthält es einen Zeichenfolgencode.
GoogleOAuthAccessToken Schnittstelle für Google OAuth 2.0-Zugriffstokens.
ServiceAccount

Variablen

Variable Beschreibung
SDK_VERSION

applicationDefault()

Gibt Anmeldeinformationen zurück, die aus den Standardanmeldeinformationen der Google-Anwendung erstellt wurden und Administratorzugriff auf Firebase-Dienste gewähren. Diese Anmeldeinformationen können im Aufruf von initializeApp() verwendet werden. .

Standardanmeldeinformationen für Google-Anwendungen sind in jeder Google-Infrastruktur verfügbar, z. B. Google App Engine und Google Compute Engine.

Weitere Einzelheiten finden Sie unter SDK initialisieren .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
httpAgent Agent Optionaler HTTP-Agent, der beim Abrufen von Zugriffstokens von Google-Tokenservern verwendet wird.

Kehrt zurück:

Ausweis

Eine über Google Application Default Credentials authentifizierte Anmeldeinformation, die zum Initialisieren einer App verwendet werden kann.

Beispiel

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

Zertifikat()

Gibt Anmeldeinformationen zurück, die aus dem bereitgestellten Dienstkonto erstellt wurden und Administratorzugriff auf Firebase-Dienste gewähren. Diese Anmeldeinformationen können im Aufruf von initializeApp() verwendet werden. .

Weitere Einzelheiten finden Sie unter SDK initialisieren .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
serviceAccountPathOrObject Zeichenfolge | ServiceAccount Der Pfad zu einer JSON-Datei mit einem Dienstkontoschlüssel oder einem Objekt, das einen Dienstkontoschlüssel darstellt.
httpAgent Agent Optionaler HTTP-Agent, der beim Abrufen von Zugriffstokens von Google-Tokenservern verwendet wird.

Kehrt zurück:

Ausweis

Eine über das bereitgestellte Dienstkonto authentifizierte Anmeldeinformation, die zum Initialisieren einer App verwendet werden kann.

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

Beispiel 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()

Macht diese bestimmte App unbrauchbar und gibt die Ressourcen aller zugehörigen Dienste frei (obwohl *keine* Backend-Ressourcen bereinigt werden). Wenn das SDK lokal ausgeführt wird, muss diese Methode aufgerufen werden, um eine ordnungsgemäße Beendigung des Prozesses sicherzustellen.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
App App

Kehrt zurück:

Versprechen<void>

Beispiel

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

die App holen()

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
App Name Zeichenfolge

Kehrt zurück:

App

getApps()

Unterschrift:

export declare function getApps(): App[];

Kehrt zurück:

App []

initializeApp()

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Optionen AppOptions
App Name Zeichenfolge

Kehrt zurück:

App

erfrischendToken()

Gibt Anmeldeinformationen zurück, die aus dem bereitgestellten Aktualisierungstoken erstellt wurden und Administratorzugriff auf Firebase-Dienste gewähren. Diese Anmeldeinformationen können im Aufruf von initializeApp() verwendet werden. .

Weitere Einzelheiten finden Sie unter SDK initialisieren .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
refreshTokenPathOrObject Zeichenfolge | Objekt Der Pfad zu einer JSON-Datei mit einem Google OAuth2-Aktualisierungstoken oder einem Objekt, das ein Google OAuth2-Aktualisierungstoken darstellt.
httpAgent Agent Optionaler HTTP-Agent, der beim Abrufen von Zugriffstokens von Google-Tokenservern verwendet wird.

Kehrt zurück:

Ausweis

Eine über das bereitgestellte Dienstkonto authentifizierte Anmeldeinformation, die zum Initialisieren einer App verwendet werden kann.

Beispiel

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

Unterschrift:

SDK_VERSION: string