firebase-admin.app package

Inizializzazione dell'app Firebase e dell'SDK.

Funzioni

Funzione Descrizione
applicazioneDefault(httpAgent) Restituisce una credenziale creata dalle credenziali predefinite dell'applicazione Google che concede l'accesso amministrativo ai servizi Firebase. Questa credenziale può essere utilizzata nella chiamata a inizializzareApp() . Le credenziali predefinite dell'applicazione Google sono disponibili su qualsiasi infrastruttura Google, come Google App Engine e Google Compute Engine. Vedi Inizializzare l'SDK per ulteriori dettagli.
cert(serviceAccountPathOrObject, httpAgent) Restituisce una credenziale creata dall'account di servizio fornito che concede l'accesso amministrativo ai servizi Firebase. Questa credenziale può essere utilizzata nella chiamata a inizializzareApp() . Vedi Inizializzare l'SDK per ulteriori dettagli.
eliminaApp(app) Rende inutilizzabile questa determinata App e libera le risorse di tutti i servizi associati (sebbene *non* pulisca le risorse di backend). Quando si esegue l'SDK localmente, questo metodo deve essere chiamato per garantire la normale conclusione del processo.
getApp(nomeapp)
getApps()
inizializzaApp(opzioni, nomeapp)
refreshToken(refreshTokenPathOrObject, httpAgent) Restituisce una credenziale creata dal token di aggiornamento fornito che concede l'accesso amministrativo ai servizi Firebase. Questa credenziale può essere utilizzata nella chiamata a inizializzareApp() . Vedi Inizializzare l'SDK per ulteriori dettagli.

Interfacce

Interfaccia Descrizione
App Un'app Firebase contiene le informazioni di inizializzazione per una raccolta di servizi.
Opzioniapp Opzioni disponibili da passare a inizializzareApp() .
Credenziali Interfaccia che fornisce token di accesso Google OAuth2 utilizzati per l'autenticazione con i servizi Firebase. Nella maggior parte dei casi, non avrai bisogno di implementarlo tu stesso e potrai invece utilizzare le implementazioni predefinite fornite dal modulo firebase-admin/app .
Errore FirebaseArrayIndex Tipo composito che include sia un oggetto FirebaseError che un indice che può essere utilizzato per ottenere l'elemento con errori.
Errore Firebase FirebaseError è una sottoclasse dell'oggetto JavaScript Error standard. Oltre a una stringa di messaggio e all'analisi dello stack, contiene un codice di stringa.
Token di accesso GoogleOAuth Interfaccia per token di accesso Google OAuth 2.0.
Account di servizio

Variabili

Variabile Descrizione
SDK_VERSIONE

applicazioneDefault()

Restituisce una credenziale creata dalle credenziali predefinite dell'applicazione Google che concede l'accesso amministrativo ai servizi Firebase. Questa credenziale può essere utilizzata nella chiamata a inizializzareApp() .

Le credenziali predefinite dell'applicazione Google sono disponibili su qualsiasi infrastruttura Google, come Google App Engine e Google Compute Engine.

Vedi Inizializzare l'SDK per ulteriori dettagli.

Firma:

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

Parametri

Parametro Tipo Descrizione
httpAgent Agente Agente HTTP facoltativo da utilizzare durante il recupero dei token di accesso dai server di token Google.

Ritorna:

Credenziali

Una credenziale autenticata tramite le credenziali predefinite dell'applicazione Google che può essere utilizzata per inizializzare un'app.

Esempio

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

certificato()

Restituisce una credenziale creata dall'account di servizio fornito che concede l'accesso amministrativo ai servizi Firebase. Questa credenziale può essere utilizzata nella chiamata a inizializzareApp() .

Vedi Inizializzare l'SDK per ulteriori dettagli.

Firma:

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

Parametri

Parametro Tipo Descrizione
serviceAccountPathOrObject stringa | Account di servizio Il percorso di un file JSON della chiave dell'account di servizio o di un oggetto che rappresenta una chiave dell'account di servizio.
httpAgent Agente Agente HTTP facoltativo da utilizzare durante il recupero dei token di accesso dai server di token Google.

Ritorna:

Credenziali

Una credenziale autenticata tramite l'account di servizio fornito che può essere utilizzata per inizializzare un'app.

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

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

Rende inutilizzabile questa determinata App e libera le risorse di tutti i servizi associati (sebbene *non* pulisca le risorse di backend). Quando si esegue l'SDK localmente, questo metodo deve essere chiamato per garantire la normale conclusione del processo.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App

Ritorna:

Promesso<vuoto>

Esempio

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

ottieni l'applicazione()

Firma:

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

Parametri

Parametro Tipo Descrizione
nome dell'applicazione corda

Ritorna:

App

getApps()

Firma:

export declare function getApps(): App[];

Ritorna:

App []

inizializzaApp()

Firma:

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

Parametri

Parametro Tipo Descrizione
opzioni Opzioniapp
nome dell'applicazione corda

Ritorna:

App

token di aggiornamento()

Restituisce una credenziale creata dal token di aggiornamento fornito che concede l'accesso amministrativo ai servizi Firebase. Questa credenziale può essere utilizzata nella chiamata a inizializzareApp() .

Vedi Inizializzare l'SDK per ulteriori dettagli.

Firma:

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

Parametri

Parametro Tipo Descrizione
aggiornaTokenPathOrObject stringa | oggetto Il percorso di un file JSON del token di aggiornamento Google OAuth2 o di un oggetto che rappresenta un token di aggiornamento Google OAuth2.
httpAgent Agente Agente HTTP facoltativo da utilizzare durante il recupero dei token di accesso dai server di token Google.

Ritorna:

Credenziali

Una credenziale autenticata tramite l'account di servizio fornito che può essere utilizzata per inizializzare un'app.

Esempio

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

Firma:

SDK_VERSION: string