firebase-admin.app package

Firebase-App und SDK-Initialisierung.

Funktionen

Schnittstellen

Variablen

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

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

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

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

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

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

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