firebase-admin package

API avec espace de noms Firebase (héritée).

Les fonctions

Fonction	Description
nom de l'application)
appCheck(application)	Obtient le service AppCheck pour l’application par défaut ou une application donnée. admin.appCheck() peut être appelé sans argument pour accéder au service AppCheck de l'application par défaut ou en tant que admin.appCheck(app) pour accéder au service AppCheck associé à une application spécifique.
auth (application)	Obtient le service Auth pour l’application par défaut ou une application donnée. admin.auth() peut être appelé sans argument pour accéder au service Auth de l'application par défaut ou en tant que admin.auth(app) pour accéder au service Auth associé à une application spécifique.
base de données (application)	Obtient le service de base de données pour l’application par défaut ou une application donnée. admin.database() peut être appelé sans argument pour accéder au service Database de l'application par défaut ou en tant que admin.database(app) pour accéder au service Database associé à une application spécifique. admin.database est également un espace de noms qui peut être utilisé pour accéder aux constantes globales et aux méthodes associées au service Database .
Firestore (application)
initializeApp (options, nom)
installations (application)	Obtient le service Installations pour l’application par défaut ou une application donnée. admin.installations() peut être appelé sans argument pour accéder au service d'installations de l'application par défaut ou en tant que admin.installations(app) pour accéder au service d'installations associé à une application spécifique.
ID d'instance (application)	Obtient le service InstanceId pour l'application par défaut ou une application donnée. admin.instanceId() peut être appelé sans argument pour accéder au service InstanceId de l'application par défaut ou en tant que admin.instanceId(app) pour accéder au service InstanceId associé à une application spécifique.
Apprentissage automatique (application)	Obtient le service MachineLearning pour l’application par défaut ou une application donnée. admin.machineLearning() peut être appelé sans argument pour accéder au service MachineLearning de l'application par défaut ou en tant que admin.machineLearning(app) pour accéder au service MachineLearning associé à une application spécifique.
messagerie (application)	Obtient le service de messagerie pour l’application par défaut ou une application donnée. admin.messaging() peut être appelé sans argument pour accéder au service Messaging de l'application par défaut ou en tant que admin.messaging(app) pour accéder au service Messaging associé à une application spécifique.
gestion de projet (application)	Obtient le service ProjectManagement pour l’application par défaut ou une application donnée. admin.projectManagement() peut être appelé sans argument pour accéder au service ProjectManagement de l'application par défaut, ou en tant que admin.projectManagement(app) pour accéder au service ProjectManagement associé à une application spécifique.
configuration à distance (application)	Obtient le service RemoteConfig pour l'application par défaut ou une application donnée. admin.remoteConfig() peut être appelé sans argument pour accéder au service RemoteConfig de l'application par défaut ou en tant que admin.remoteConfig(app) pour accéder au service RemoteConfig associé à une application spécifique.
règles de sécurité (application)	Obtient le service SecurityRules pour l’application par défaut ou une application donnée. admin.securityRules() peut être appelé sans argument pour accéder au service SecurityRules de l'application par défaut, ou en tant que admin.securityRules(app) pour accéder au service SecurityRules associé à une application spécifique.
stockage (application)	Obtient le service de stockage pour l'application par défaut ou une application donnée. admin.storage() peut être appelé sans argument pour accéder au service Storage de l'application par défaut ou en tant que admin.storage(app) pour accéder au service Storage associé à une application spécifique.

Interfaces

Interface	Description
Options d'application	Options disponibles à transmettre à initializeApp() .
Erreur FirebaseArrayIndex	Type composite qui comprend à la fois un objet FirebaseError et un index qui peut être utilisé pour obtenir l'élément erroné.
Erreur Firebase	FirebaseError est une sous-classe de l'objet JavaScript Error standard. En plus d'une chaîne de message et d'une trace de pile, il contient un code de chaîne.
GoogleOAuthAccessToken	Interface pour les jetons d'accès Google OAuth 2.0.
Compte de service

Espaces de noms

Espace de noms	Description
application
appCheck
authentification
informations d'identification
base de données
magasin de feu
installation
ID d'instance
machineApprentissage
Messagerie
gestion de projet
configuration à distance
règles de sécurité
stockage

Variables

Variable	Description
applications
SDK_VERSION

application()

Signature:

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

Paramètres

Paramètre	Taper	Description
nom	chaîne

Retour:

app.App

appCheck()

Obtient le service AppCheck pour l’application par défaut ou une application donnée.

admin.appCheck() peut être appelé sans argument pour accéder au service AppCheck de l'application par défaut ou en tant que admin.appCheck(app) pour accéder au service AppCheck associé à une application spécifique.

Signature:

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

Paramètres

Paramètre	Taper	Description
application	Application	Application facultative pour laquelle renvoyer le service AppCheck . S’il n’est pas fourni, le service AppCheck par défaut est renvoyé.

Retour:

appCheck.AppCheck

Le service AppCheck par défaut si aucune application n'est fournie, ou le service AppCheck associé à l'application fournie.

Exemple 1

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

Exemple 2

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

auth()

Obtient le service Auth pour l’application par défaut ou une application donnée.

admin.auth() peut être appelé sans argument pour accéder au service Auth de l'application par défaut ou en tant que admin.auth(app) pour accéder au service Auth associé à une application spécifique.

Signature:

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

Paramètres

Paramètre	Taper	Description
application	Application

Retour:

auth.Auth

Exemple 1

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

Exemple 2

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

base de données()

Obtient le service de base de données pour l'application par défaut ou une application donnée.

admin.database() peut être appelé sans argument pour accéder au service Database de l'application par défaut ou en tant que admin.database(app) pour accéder au service Database associé à une application spécifique.

admin.database est également un espace de noms qui peut être utilisé pour accéder aux constantes globales et aux méthodes associées au service Database .

Signature:

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

Paramètres

Paramètre	Taper	Description
application	Application

Retour:

base de données.Base de données

Le service Database par défaut si aucune application n'est fournie ou le service Database associé à l'application fournie.

Exemple 1

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

Exemple 2

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

magasin de feu()

Signature:

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

Paramètres

Paramètre	Taper	Description
application	Application

Retour:

_firestore.Firestore

initialiserApp()

Signature:

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

Paramètres

Paramètre	Taper	Description
choix	Options d'application
nom	chaîne

Retour:

app.App

installation()

Obtient le service Installations pour l’application par défaut ou une application donnée.

admin.installations() peut être appelé sans argument pour accéder au service d'installations de l'application par défaut ou en tant que admin.installations(app) pour accéder au service d'installations associé à une application spécifique.

Signature:

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

Paramètres

Paramètre	Taper	Description
application	Application	Application facultative dont le service Installations doit être renvoyé. S’il n’est pas fourni, le service Installations par défaut est renvoyé.

Retour:

installations.Installations

Le service Installations par défaut si aucune application n'est fournie ou le service Installations associé à l'application fournie.

Exemple 1

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

Exemple 2

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

instanceId()

Obtient le service InstanceId pour l'application par défaut ou une application donnée.

admin.instanceId() peut être appelé sans argument pour accéder au service InstanceId de l'application par défaut ou en tant que admin.instanceId(app) pour accéder au service InstanceId associé à une application spécifique.

Signature:

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

Paramètres

Paramètre	Taper	Description
application	Application	Application facultative dont le service InstanceId doit être renvoyé. S’il n’est pas fourni, le service InstanceId par défaut sera renvoyé.

Retour:

instanceId.InstanceId

Le service InstanceId par défaut si aucune application n'est fournie ou le service InstanceId associé à l'application fournie.

Exemple 1

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

Exemple 2

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

Apprentissage automatique()

Obtient le service MachineLearning pour l’application par défaut ou une application donnée.

admin.machineLearning() peut être appelé sans argument pour accéder au service MachineLearning de l'application par défaut ou en tant que admin.machineLearning(app) pour accéder au service MachineLearning associé à une application spécifique.

Signature:

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

Paramètres

Paramètre	Taper	Description
application	Application	Application facultative dont le service MachineLearning doit être renvoyé. S’il n’est pas fourni, le service MachineLearning par défaut sera renvoyé.

Retour:

machineLearning.MachineLearning

Le service MachineLearning par défaut si aucune application n'est fournie ou le service MachineLearning associé à l'application fournie.

Exemple 1

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

Exemple 2

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

Messagerie()

Obtient le service de messagerie pour l’application par défaut ou une application donnée.

admin.messaging() peut être appelé sans argument pour accéder au service Messaging de l'application par défaut ou en tant que admin.messaging(app) pour accéder au service Messaging associé à une application spécifique.

Signature:

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

Paramètres

Paramètre	Taper	Description
application	Application	Application facultative dont le service Messaging doit être renvoyé. S’il n’est pas fourni, le service Messaging par défaut sera renvoyé.

Retour:

messagerie.Messagerie

Le service Messaging par défaut si aucune application n'est fournie ou le service Messaging associé à l'application fournie.

Exemple 1

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

Exemple 2

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

gestion de projet()

Obtient le service ProjectManagement pour l’application par défaut ou une application donnée.

admin.projectManagement() peut être appelé sans argument pour accéder au service ProjectManagement de l'application par défaut, ou en tant que admin.projectManagement(app) pour accéder au service ProjectManagement associé à une application spécifique.

Signature:

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

Paramètres

Paramètre	Taper	Description
application	Application	Application facultative dont le service ProjectManagement doit être renvoyé. S’il n’est pas fourni, le service ProjectManagement par défaut sera renvoyé. *

Retour:

projectManagement.ProjectManagement

Le service ProjectManagement par défaut si aucune application n'est fournie ou le service ProjectManagement associé à l'application fournie.

Exemple 1

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

Exemple 2

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

configuration à distance()

Obtient le service RemoteConfig pour l'application par défaut ou une application donnée.

admin.remoteConfig() peut être appelé sans argument pour accéder au service RemoteConfig de l'application par défaut ou en tant que admin.remoteConfig(app) pour accéder au service RemoteConfig associé à une application spécifique.

Signature:

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

Paramètres

Paramètre	Taper	Description
application	Application	Application facultative pour laquelle renvoyer le service RemoteConfig . S’il n’est pas fourni, le service RemoteConfig par défaut est renvoyé.

Retour:

remoteConfig.RemoteConfig

Le service RemoteConfig par défaut si aucune application n'est fournie, ou le service RemoteConfig associé à l'application fournie.

Exemple 1

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

Exemple 2

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

règles de sécurité()

Obtient le service SecurityRules pour l’application par défaut ou une application donnée.

admin.securityRules() peut être appelé sans argument pour accéder au service SecurityRules de l'application par défaut, ou en tant que admin.securityRules(app) pour accéder au service SecurityRules associé à une application spécifique.

Signature:

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

Paramètres

Paramètre	Taper	Description
application	Application	Application facultative pour laquelle renvoyer le service SecurityRules . S’il n’est pas fourni, le service SecurityRules par défaut est renvoyé.

Retour:

securityRules.SecurityRules

Le service SecurityRules par défaut si aucune application n'est fournie, ou le service SecurityRules associé à l'application fournie.

Exemple 1

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

Exemple 2

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

stockage()

Obtient le service de stockage pour l'application par défaut ou une application donnée.

admin.storage() peut être appelé sans argument pour accéder au service Storage de l'application par défaut ou en tant que admin.storage(app) pour accéder au service Storage associé à une application spécifique.

Signature:

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

Paramètres

Paramètre	Taper	Description
application	Application

Retour:

stockage.Stockage

Exemple 1

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

Exemple 2

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

applications

Signature:

apps: (app.App | null)[]

SDK_VERSION

Signature:

SDK_VERSION: string