firebase-admin package

Firebase-Namespace-API (Legacy).

Funktionen

Funktion Beschreibung
App Name)
appCheck(app) Ruft den AppCheck- Dienst für die Standard-App oder eine bestimmte App ab. admin.appCheck() kann ohne Argumente aufgerufen werden, um auf den AppCheck Dienst der Standard-App zuzugreifen, oder als admin.appCheck(app) um auf den AppCheck Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.
auth(app) Ruft den Authentifizierungsdienst für die Standard-App oder eine bestimmte App ab. admin.auth() kann ohne Argumente aufgerufen werden, um auf den Auth- Dienst der Standard-App zuzugreifen, oder als admin.auth(app) um auf den Auth- Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.
Datenbank(App) Ruft den Datenbankdienst für die Standard-App oder eine bestimmte App ab. admin.database() kann ohne Argumente aufgerufen werden, um auf den Database der Standard-App zuzugreifen, oder als admin.database(app) um auf den Database zuzugreifen, der einer bestimmten App zugeordnet ist. admin.database ist auch ein Namespace, der für den Zugriff auf globale Konstanten und Methoden verwendet werden kann, die dem Database zugeordnet sind.
Firestore (App)
initializeApp(Optionen, Name)
Installationen (App) Ruft den Installationsdienst für die Standard-App oder eine bestimmte App ab. admin.installations() kann ohne Argumente aufgerufen werden, um auf den Installationsdienst der Standard-App zuzugreifen, oder als admin.installations(app) um auf den Installationsdienst zuzugreifen, der einer bestimmten App zugeordnet ist.
Instanz-ID(App) Ruft den InstanceId- Dienst für die Standard-App oder eine bestimmte App ab. admin.instanceId() kann ohne Argumente aufgerufen werden, um auf den InstanceId Dienst der Standard-App zuzugreifen, oder als admin.instanceId(app) um auf den InstanceId Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.
maschinelles Lernen (App) Ruft den MachineLearning- Dienst für die Standard-App oder eine bestimmte App ab. admin.machineLearning() kann ohne Argumente aufgerufen werden, um auf den MachineLearning Dienst der Standard-App zuzugreifen, oder als admin.machineLearning(app) um auf den MachineLearning Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.
Messaging (App) Ruft den Messaging- Dienst für die Standard-App oder eine bestimmte App ab. admin.messaging() kann ohne Argumente aufgerufen werden, um auf den Messaging Dienst der Standard-App zuzugreifen, oder als admin.messaging(app) um auf den Messaging Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.
Projektmanagement(App) Ruft den ProjectManagement- Dienst für die Standard-App oder eine bestimmte App ab. admin.projectManagement() kann ohne Argumente aufgerufen werden, um auf den ProjectManagement Dienst der Standard-App zuzugreifen, oder als admin.projectManagement(app) um auf den ProjectManagement Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.
remoteConfig(app) Ruft den RemoteConfig- Dienst für die Standard-App oder eine bestimmte App ab. admin.remoteConfig() kann ohne Argumente aufgerufen werden, um auf den RemoteConfig Dienst der Standard-App zuzugreifen, oder als admin.remoteConfig(app) , um auf den RemoteConfig Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.
securityRules(app) Ruft den SecurityRules- Dienst für die Standard-App oder eine bestimmte App ab. admin.securityRules() kann ohne Argumente aufgerufen werden, um auf den SecurityRules- Dienst der Standard-App zuzugreifen, oder als admin.securityRules(app) um auf den SecurityRules- Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.
Speicher (App) Ruft den Speicherdienst für die Standard-App oder eine bestimmte App ab. admin.storage() kann ohne Argumente aufgerufen werden, um auf den Storage der Standard-App zuzugreifen, oder als admin.storage(app) um auf den Storage zuzugreifen, der einer bestimmten App zugeordnet ist.

Schnittstellen

Schnittstelle Beschreibung
AppOptions Verfügbare Optionen zur Übergabe an initializeApp() .
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

Namensräume

Namensraum Beschreibung
App
appCheck
Autor
Berechtigung
Datenbank
Feuerladen
Installationen
Instanz-ID
maschinelles Lernen
Nachrichtenübermittlung
Projektmanagement
remoteConfig
Sicherheitsregeln
Lagerung

Variablen

Variable Beschreibung
Apps
SDK_VERSION

app()

Unterschrift:

export declare function app(name?: string): app.App;

Parameter

Parameter Typ Beschreibung
Name Zeichenfolge

Kehrt zurück:

app.App

appCheck()

Ruft den AppCheck- Dienst für die Standard-App oder eine bestimmte App ab.

admin.appCheck() kann ohne Argumente aufgerufen werden, um auf den AppCheck Dienst der Standard-App zuzugreifen, oder als admin.appCheck(app) um auf den AppCheck Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.

Unterschrift:

export declare function appCheck(app?: App): appCheck.AppCheck;

Parameter

Parameter Typ Beschreibung
App App Optionale App, für die der AppCheck Dienst zurückgegeben werden soll. Wenn nicht angegeben, wird der Standard- AppCheck Dienst zurückgegeben.

Kehrt zurück:

appCheck.AppCheck

Der Standard- AppCheck Dienst, wenn keine App bereitgestellt wird, oder der AppCheck Dienst, der der bereitgestellten App zugeordnet ist.

Beispiel 1

// Get the `AppCheck` service for the default app
var defaultAppCheck = admin.appCheck();

Beispiel 2

// Get the `AppCheck` service for a given app
var otherAppCheck = admin.appCheck(otherApp);

auth()

Ruft den Authentifizierungsdienst für die Standard-App oder eine bestimmte App ab.

admin.auth() kann ohne Argumente aufgerufen werden, um auf den Auth- Dienst der Standard-App zuzugreifen, oder als admin.auth(app) um auf den Auth- Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.

Unterschrift:

export declare function auth(app?: App): auth.Auth;

Parameter

Parameter Typ Beschreibung
App App

Kehrt zurück:

auth.Auth

Beispiel 1

// Get the Auth service for the default app
var defaultAuth = admin.auth();

Beispiel 2

// Get the Auth service for a given app
var otherAuth = admin.auth(otherApp);

Datenbank()

Ruft den Datenbankdienst für die Standard-App oder eine bestimmte App ab.

admin.database() kann ohne Argumente aufgerufen werden, um auf den Database der Standard-App zuzugreifen, oder als admin.database(app) um auf den Database zuzugreifen, der einer bestimmten App zugeordnet ist.

admin.database ist auch ein Namespace, der für den Zugriff auf globale Konstanten und Methoden verwendet werden kann, die dem Database zugeordnet sind.

Unterschrift:

export declare function database(app?: App): database.Database;

Parameter

Parameter Typ Beschreibung
App App

Kehrt zurück:

Datenbank.Datenbank

Der Standard- Database , wenn keine App bereitgestellt wird, oder der Database , der mit der bereitgestellten App verknüpft ist.

Beispiel 1

// Get the Database service for the default app
var defaultDatabase = admin.database();

Beispiel 2

// Get the Database service for a specific app
var otherDatabase = admin.database(app);

Firestore()

Unterschrift:

export declare function firestore(app?: App): _firestore.Firestore;

Parameter

Parameter Typ Beschreibung
App App

Kehrt zurück:

_firestore.Firestore

initializeApp()

Unterschrift:

export declare function initializeApp(options?: AppOptions, name?: string): app.App;

Parameter

Parameter Typ Beschreibung
Optionen AppOptions
Name Zeichenfolge

Kehrt zurück:

app.App

Installationen()

Ruft den Installationsdienst für die Standard-App oder eine bestimmte App ab.

admin.installations() kann ohne Argumente aufgerufen werden, um auf den Installationsdienst der Standard-App zuzugreifen, oder als admin.installations(app) um auf den Installationsdienst zuzugreifen, der einer bestimmten App zugeordnet ist.

Unterschrift:

export declare function installations(app?: App): installations.Installations;

Parameter

Parameter Typ Beschreibung
App App Optionale App, deren Installations zurückgegeben werden soll. Wenn nicht angegeben, wird der Installations zurückgegeben.

Kehrt zurück:

Installationen.Installationen

Der Installations , wenn keine App bereitgestellt wird, oder der Installations , der mit der bereitgestellten App verknüpft ist.

Beispiel 1

// Get the Installations service for the default app
var defaultInstallations = admin.installations();

Beispiel 2

// Get the Installations service for a given app
var otherInstallations = admin.installations(otherApp);

Instanz-ID()

Ruft den InstanceId- Dienst für die Standard-App oder eine bestimmte App ab.

admin.instanceId() kann ohne Argumente aufgerufen werden, um auf den InstanceId Dienst der Standard-App zuzugreifen, oder als admin.instanceId(app) um auf den InstanceId Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.

Unterschrift:

export declare function instanceId(app?: App): instanceId.InstanceId;

Parameter

Parameter Typ Beschreibung
App App Optionale App, deren InstanceId Dienst zurückgegeben werden soll. Wenn nicht angegeben, wird der Standard- InstanceId Dienst zurückgegeben.

Kehrt zurück:

Instanz-ID.Instanz-ID

Der Standard- InstanceId Dienst, wenn keine App bereitgestellt wird, oder der InstanceId Dienst, der der bereitgestellten App zugeordnet ist.

Beispiel 1

// Get the Instance ID service for the default app
var defaultInstanceId = admin.instanceId();

Beispiel 2

// Get the Instance ID service for a given app
var otherInstanceId = admin.instanceId(otherApp);

maschinelles Lernen()

Ruft den MachineLearning- Dienst für die Standard-App oder eine bestimmte App ab.

admin.machineLearning() kann ohne Argumente aufgerufen werden, um auf den MachineLearning Dienst der Standard-App zuzugreifen, oder als admin.machineLearning(app) um auf den MachineLearning Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.

Unterschrift:

export declare function machineLearning(app?: App): machineLearning.MachineLearning;

Parameter

Parameter Typ Beschreibung
App App Optionale App, deren MachineLearning Dienst zurückgegeben werden soll. Wenn nicht angegeben, wird der standardmäßige MachineLearning Dienst zurückgegeben.

Kehrt zurück:

machineLearning.MachineLearning

Der standardmäßige MachineLearning Dienst, wenn keine App bereitgestellt wird, oder der MachineLearning Dienst, der der bereitgestellten App zugeordnet ist.

Beispiel 1

// Get the MachineLearning service for the default app
var defaultMachineLearning = admin.machineLearning();

Beispiel 2

// Get the MachineLearning service for a given app
var otherMachineLearning = admin.machineLearning(otherApp);

Messaging()

Ruft den Messaging- Dienst für die Standard-App oder eine bestimmte App ab.

admin.messaging() kann ohne Argumente aufgerufen werden, um auf den Messaging Dienst der Standard-App zuzugreifen, oder als admin.messaging(app) um auf den Messaging Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.

Unterschrift:

export declare function messaging(app?: App): messaging.Messaging;

Parameter

Parameter Typ Beschreibung
App App Optionale App, deren Messaging Dienst zurückgegeben werden soll. Wenn nicht angegeben, wird der Standard- Messaging Dienst zurückgegeben.

Kehrt zurück:

Messaging.Messaging

Der Standard- Messaging Dienst, wenn keine App bereitgestellt wird, oder der Messaging Dienst, der mit der bereitgestellten App verknüpft ist.

Beispiel 1

// Get the Messaging service for the default app
var defaultMessaging = admin.messaging();

Beispiel 2

// Get the Messaging service for a given app
var otherMessaging = admin.messaging(otherApp);

Projektmanagement()

Ruft den ProjectManagement- Dienst für die Standard-App oder eine bestimmte App ab.

admin.projectManagement() kann ohne Argumente aufgerufen werden, um auf den ProjectManagement Dienst der Standard-App zuzugreifen, oder als admin.projectManagement(app) um auf den ProjectManagement Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.

Unterschrift:

export declare function projectManagement(app?: App): projectManagement.ProjectManagement;

Parameter

Parameter Typ Beschreibung
App App Optionale App, deren ProjectManagement Dienst zurückgegeben werden soll. Wenn nicht angegeben, wird der standardmäßige ProjectManagement Dienst zurückgegeben. *

Kehrt zurück:

projectManagement.ProjectManagement

Der standardmäßige ProjectManagement Dienst, wenn keine App bereitgestellt wird, oder der ProjectManagement Dienst, der der bereitgestellten App zugeordnet ist.

Beispiel 1

// Get the ProjectManagement service for the default app
var defaultProjectManagement = admin.projectManagement();

Beispiel 2

// Get the ProjectManagement service for a given app
var otherProjectManagement = admin.projectManagement(otherApp);

remoteConfig()

Ruft den RemoteConfig- Dienst für die Standard-App oder eine bestimmte App ab.

admin.remoteConfig() kann ohne Argumente aufgerufen werden, um auf den RemoteConfig Dienst der Standard-App zuzugreifen, oder als admin.remoteConfig(app) , um auf den RemoteConfig Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.

Unterschrift:

export declare function remoteConfig(app?: App): remoteConfig.RemoteConfig;

Parameter

Parameter Typ Beschreibung
App App Optionale App, für die der RemoteConfig Dienst zurückgegeben werden soll. Wenn nicht angegeben, wird der Standard RemoteConfig Dienst zurückgegeben.

Kehrt zurück:

remoteConfig.RemoteConfig

Der Standard- RemoteConfig Dienst, wenn keine App bereitgestellt wird, oder der RemoteConfig Dienst, der der bereitgestellten App zugeordnet ist.

Beispiel 1

// Get the `RemoteConfig` service for the default app
var defaultRemoteConfig = admin.remoteConfig();

Beispiel 2

// Get the `RemoteConfig` service for a given app
var otherRemoteConfig = admin.remoteConfig(otherApp);

securityRules()

Ruft den SecurityRules- Dienst für die Standard-App oder eine bestimmte App ab.

admin.securityRules() kann ohne Argumente aufgerufen werden, um auf den SecurityRules- Dienst der Standard-App zuzugreifen, oder als admin.securityRules(app) um auf den SecurityRules- Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.

Unterschrift:

export declare function securityRules(app?: App): securityRules.SecurityRules;

Parameter

Parameter Typ Beschreibung
App App Optionale App, für die der SecurityRules Dienst zurückgegeben werden soll. Wenn nicht angegeben, wird der standardmäßige SecurityRules Dienst zurückgegeben.

Kehrt zurück:

securityRules.SecurityRules

Der standardmäßige SecurityRules Dienst, wenn keine App bereitgestellt wird, oder der SecurityRules Dienst, der der bereitgestellten App zugeordnet ist.

Beispiel 1

// Get the SecurityRules service for the default app
var defaultSecurityRules = admin.securityRules();

Beispiel 2

// Get the SecurityRules service for a given app
var otherSecurityRules = admin.securityRules(otherApp);

Lagerung()

Ruft den Speicherdienst für die Standard-App oder eine bestimmte App ab.

admin.storage() kann ohne Argumente aufgerufen werden, um auf den Storage der Standard-App zuzugreifen, oder als admin.storage(app) um auf den Storage zuzugreifen, der einer bestimmten App zugeordnet ist.

Unterschrift:

export declare function storage(app?: App): storage.Storage;

Parameter

Parameter Typ Beschreibung
App App

Kehrt zurück:

Lagerung. Lagerung

Beispiel 1

// Get the Storage service for the default app
var defaultStorage = admin.storage();

Beispiel 2

// Get the Storage service for a given app
var otherStorage = admin.storage(otherApp);

Apps

Unterschrift:

apps: (app.App | null)[]

SDK_VERSION

Unterschrift:

SDK_VERSION: string