firebase-admin.app package

Initialisation de l'application Firebase et du SDK.

Les fonctions

Fonction	Description
applicationDefault (httpAgent)	Renvoie un identifiant créé à partir des identifiants par défaut de l'application Google qui accorde un accès administrateur aux services Firebase. Ces informations d'identification peuvent être utilisées dans l'appel à initializeApp() . Les informations d'identification par défaut des applications Google sont disponibles sur n'importe quelle infrastructure Google, telle que Google App Engine et Google Compute Engine. Voir Initialiser le SDK pour plus de détails.
cert (serviceAccountPathOrObject, httpAgent)	Renvoie un identifiant créé à partir du compte de service fourni qui accorde un accès administrateur aux services Firebase. Ces informations d'identification peuvent être utilisées dans l'appel à initializeApp() . Voir Initialiser le SDK pour plus de détails.
supprimer l'application (application)	Rend cette App donnée inutilisable et libère les ressources de tous les services associés (bien qu'elle ne nettoie *pas* les ressources backend). Lors de l’exécution locale du SDK, cette méthode doit être appelée pour garantir une fin en douceur du processus.
getApp (nom de l'application)
getApps()
initializeApp (options, nom de l'application)
rafraîchirToken(refreshTokenPathOrObject, httpAgent)	Renvoie un identifiant créé à partir du jeton d'actualisation fourni qui accorde un accès administrateur aux services Firebase. Ces informations d'identification peuvent être utilisées dans l'appel à initializeApp() . Voir Initialiser le SDK pour plus de détails.

Interfaces

Interface	Description
Application	Une application Firebase contient les informations d'initialisation d'un ensemble de services.
Options d'application	Options disponibles à transmettre à initializeApp() .
Informations d'identification	Interface qui fournit des jetons d'accès Google OAuth2 utilisés pour s'authentifier auprès des services Firebase. Dans la plupart des cas, vous n'aurez pas besoin de l'implémenter vous-même et pourrez plutôt utiliser les implémentations par défaut fournies par le module firebase-admin/app .
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

Variables

Variable	Description
SDK_VERSION

applicationDefault()

Renvoie un identifiant créé à partir des identifiants par défaut de l'application Google qui accorde un accès administrateur aux services Firebase. Ces informations d'identification peuvent être utilisées dans l'appel à initializeApp() .

Les informations d'identification par défaut des applications Google sont disponibles sur n'importe quelle infrastructure Google, telle que Google App Engine et Google Compute Engine.

Voir Initialiser le SDK pour plus de détails.

Signature:

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

Paramètres

Paramètre	Taper	Description
httpAgent	Agent	Agent HTTP facultatif à utiliser lors de la récupération des jetons d'accès à partir des serveurs de jetons Google.

Retour:

Informations d'identification

Un identifiant authentifié via les identifiants par défaut de l'application Google qui peut être utilisé pour initialiser une application.

Exemple

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

certificat()

Renvoie un identifiant créé à partir du compte de service fourni qui accorde un accès administrateur aux services Firebase. Ces informations d'identification peuvent être utilisées dans l'appel à initializeApp() .

Voir Initialiser le SDK pour plus de détails.

Signature:

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

Paramètres

Paramètre	Taper	Description
serviceAccountPathOrObject	chaîne | Compte de service	Chemin d'accès à un fichier JSON de clé de compte de service ou à un objet représentant une clé de compte de service.
httpAgent	Agent	Agent HTTP facultatif à utiliser lors de la récupération des jetons d'accès à partir des serveurs de jetons Google.

Retour:

Informations d'identification

Un identifiant authentifié via le compte de service fourni qui peut être utilisé pour initialiser une application.

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

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

supprimerApp()

Rend cette App donnée inutilisable et libère les ressources de tous les services associés (bien qu'elle ne nettoie *pas* les ressources backend). Lors de l’exécution locale du SDK, cette méthode doit être appelée pour garantir une fin en douceur du processus.

Signature:

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

Paramètres

Paramètre	Taper	Description
application	Application

Retour:

Promesse<vide>

Exemple

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

obtenir l'application()

Signature:

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

Paramètres

Paramètre	Taper	Description
nom de l'application	chaîne

Retour:

Application

getApps()

Signature:

export declare function getApps(): App[];

Retour:

Application []

initialiserApp()

Signature:

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

Paramètres

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

Retour:

Application

rafraîchirToken()

Renvoie un identifiant créé à partir du jeton d'actualisation fourni qui accorde un accès administrateur aux services Firebase. Ces informations d'identification peuvent être utilisées dans l'appel à initializeApp() .

Voir Initialiser le SDK pour plus de détails.

Signature:

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

Paramètres

Paramètre	Taper	Description
rafraîchirTokenPathOrObject	chaîne | objet	Chemin d'accès à un fichier JSON de jeton d'actualisation Google OAuth2 ou à un objet représentant un jeton d'actualisation Google OAuth2.
httpAgent	Agent	Agent HTTP facultatif à utiliser lors de la récupération des jetons d'accès à partir des serveurs de jetons Google.

Retour:

Informations d'identification

Un identifiant authentifié via le compte de service fourni qui peut être utilisé pour initialiser une application.

Exemple

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

Signature:

SDK_VERSION: string