firebase-admin package

API con spazio dei nomi Firebase (legacy).

Funzioni

Funzione Descrizione
nome dell'applicazione)
appCheck(app) Ottiene il servizio AppCheck per l'app predefinita o per una determinata app. admin.appCheck() può essere chiamato senza argomenti per accedere al servizio AppCheck dell'app predefinita o come admin.appCheck(app) per accedere al servizio AppCheck associato a un'app specifica.
autenticazione(app) Ottiene il servizio di autenticazione per l'app predefinita o per una determinata app. admin.auth() può essere chiamato senza argomenti per accedere al servizio di autenticazione dell'app predefinita o come admin.auth(app) per accedere al servizio di autenticazione associato a un'app specifica.
banca dati (applicazione) Ottiene il servizio Database per l'app predefinita o per una determinata app. admin.database() può essere chiamato senza argomenti per accedere al servizio Database dell'app predefinita o come admin.database(app) per accedere al servizio Database associato a un'app specifica. admin.database è anche uno spazio dei nomi che può essere utilizzato per accedere a costanti e metodi globali associati al servizio Database .
Firestore (app)
inizializzaApp(opzioni, nome)
installazioni (app) Ottiene il servizio Installazioni per l'app predefinita o per una determinata app. admin.installations() può essere chiamato senza argomenti per accedere al servizio di installazioni dell'app predefinita o come admin.installations(app) per accedere al servizio di installazioni associato a un'app specifica.
ID istanza(app) Ottiene il servizio InstanceId per l'app predefinita o per una determinata app. admin.instanceId() può essere chiamato senza argomenti per accedere al servizio InstanceId dell'app predefinita o come admin.instanceId(app) per accedere al servizio InstanceId associato a un'app specifica.
machineLearning(app) Ottiene il servizio MachineLearning per l'app predefinita o per una determinata app. admin.machineLearning() può essere chiamato senza argomenti per accedere al servizio MachineLearning dell'app predefinita o come admin.machineLearning(app) per accedere al servizio MachineLearning associato a un'app specifica.
messaggistica (app) Ottiene il servizio di messaggistica per l'app predefinita o per una determinata app. admin.messaging() può essere chiamato senza argomenti per accedere al servizio Messaging dell'app predefinita o come admin.messaging(app) per accedere al servizio Messaging associato a un'app specifica.
gestione del progetto(app) Ottiene il servizio ProjectManagement per l'app predefinita o per una determinata app. admin.projectManagement() può essere chiamato senza argomenti per accedere al servizio ProjectManagement dell'app predefinita o come admin.projectManagement(app) per accedere al servizio ProjectManagement associato a un'app specifica.
configurazione remota(app) Ottiene il servizio RemoteConfig per l'app predefinita o una determinata app. admin.remoteConfig() può essere chiamato senza argomenti per accedere al servizio RemoteConfig dell'app predefinita o come admin.remoteConfig(app) per accedere al servizio RemoteConfig associato a un'app specifica.
regole di sicurezza(app) Ottiene il servizio SecurityRules per l'app predefinita o per una determinata app. admin.securityRules() può essere chiamato senza argomenti per accedere al servizio SecurityRules dell'app predefinita o come admin.securityRules(app) per accedere al servizio SecurityRules associato a un'app specifica.
archiviazione (app) Ottiene il servizio di archiviazione per l'app predefinita o per una determinata app. admin.storage() può essere chiamato senza argomenti per accedere al servizio Storage dell'app predefinita o come admin.storage(app) per accedere al servizio Storage associato a un'app specifica.

Interfacce

Interfaccia Descrizione
Opzioni dell'app Opzioni disponibili da passare a inizializzareApp() .
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

Spazi dei nomi

Spazio dei nomi Descrizione
app
appCheck
aut
credenziali
Banca dati
fuoco
installazioni
ID istanza
machineLearning
messaggistica
gestione del progetto
remoteConfig
regole di sicurezza
magazzinaggio

Variabili

Variabile Descrizione
app
SDK_VERSIONE

app()

Firma:

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

Parametri

Parametro Tipo Descrizione
nome corda

Ritorna:

app.App

appCheck()

Ottiene il servizio AppCheck per l'app predefinita o per una determinata app.

admin.appCheck() può essere chiamato senza argomenti per accedere al servizio AppCheck dell'app predefinita o come admin.appCheck(app) per accedere al servizio AppCheck associato a un'app specifica.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App App facoltativa per la quale restituire il servizio AppCheck . Se non fornito, viene restituito il servizio AppCheck predefinito.

Ritorna:

appCheck.AppCheck

Il servizio AppCheck predefinito se non viene fornita alcuna app oppure il servizio AppCheck associato all'app fornita.

Esempio 1

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

Esempio 2

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

autenticazione()

Ottiene il servizio di autenticazione per l'app predefinita o per una determinata app.

admin.auth() può essere chiamato senza argomenti per accedere al servizio di autenticazione dell'app predefinita o come admin.auth(app) per accedere al servizio di autenticazione associato a un'app specifica.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App

Ritorna:

aut.Aut

Esempio 1

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

Esempio 2

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

Banca dati()

Ottiene il servizio Database per l'app predefinita o per una determinata app.

admin.database() può essere chiamato senza argomenti per accedere al servizio Database dell'app predefinita o come admin.database(app) per accedere al servizio Database associato a un'app specifica.

admin.database è anche uno spazio dei nomi che può essere utilizzato per accedere a costanti e metodi globali associati al servizio Database .

Firma:

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

Parametri

Parametro Tipo Descrizione
app App

Ritorna:

database.Database

Il servizio Database predefinito se non viene fornita alcuna app o il servizio Database associato all'app fornita.

Esempio 1

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

Esempio 2

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

fuoco()

Firma:

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

Parametri

Parametro Tipo Descrizione
app App

Ritorna:

_firestore.Firestore

inizializzaApp()

Firma:

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

Parametri

Parametro Tipo Descrizione
opzioni Opzioni dell'app
nome corda

Ritorna:

app.App

installazioni()

Ottiene il servizio Installazioni per l'app predefinita o per una determinata app.

admin.installations() può essere chiamato senza argomenti per accedere al servizio di installazioni dell'app predefinita o come admin.installations(app) per accedere al servizio di installazioni associato a un'app specifica.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App App opzionale di cui restituire il servizio Installations . Se non fornito, viene restituito il servizio Installations predefinito.

Ritorna:

installazioni.Installazioni

Il servizio Installations predefinito se non viene fornita alcuna app o il servizio Installations associato all'app fornita.

Esempio 1

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

Esempio 2

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

IDistanza()

Ottiene il servizio InstanceId per l'app predefinita o per una determinata app.

admin.instanceId() può essere chiamato senza argomenti per accedere al servizio InstanceId dell'app predefinita o come admin.instanceId(app) per accedere al servizio InstanceId associato a un'app specifica.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App App facoltativa di cui restituire il servizio InstanceId . Se non fornito, verrà restituito il servizio InstanceId predefinito.

Ritorna:

IDistanza.IDistanza

Il servizio InstanceId predefinito se non viene fornita alcuna app o il servizio InstanceId associato all'app fornita.

Esempio 1

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

Esempio 2

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

macchinaApprendimento()

Ottiene il servizio MachineLearning per l'app predefinita o per una determinata app.

admin.machineLearning() può essere chiamato senza argomenti per accedere al servizio MachineLearning dell'app predefinita o come admin.machineLearning(app) per accedere al servizio MachineLearning associato a un'app specifica.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App App facoltativa di cui restituire il servizio MachineLearning . Se non fornito, verrà restituito il servizio MachineLearning predefinito.

Ritorna:

machineLearning.MachineLearning

Il servizio MachineLearning predefinito se non viene fornita alcuna app oppure il servizio MachineLearning associato all'app fornita.

Esempio 1

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

Esempio 2

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

messaggistica()

Ottiene il servizio di messaggistica per l'app predefinita o per una determinata app.

admin.messaging() può essere chiamato senza argomenti per accedere al servizio Messaging dell'app predefinita o come admin.messaging(app) per accedere al servizio Messaging associato a un'app specifica.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App App opzionale di cui restituire il servizio Messaging . Se non fornito, verrà restituito il servizio Messaging predefinito.

Ritorna:

messaggistica.Messaging

Il servizio Messaging predefinito se non viene fornita alcuna app o il servizio Messaging associato all'app fornita.

Esempio 1

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

Esempio 2

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

gestione del progetto()

Ottiene il servizio ProjectManagement per l'app predefinita o per una determinata app.

admin.projectManagement() può essere chiamato senza argomenti per accedere al servizio ProjectManagement dell'app predefinita o come admin.projectManagement(app) per accedere al servizio ProjectManagement associato a un'app specifica.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App App opzionale di cui restituire il servizio ProjectManagement . Se non fornito, verrà restituito il servizio ProjectManagement predefinito. *

Ritorna:

progettoManagement.ProjectManagement

Il servizio ProjectManagement predefinito se non viene fornita alcuna app oppure il servizio ProjectManagement associato all'app fornita.

Esempio 1

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

Esempio 2

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

configurazione remota()

Ottiene il servizio RemoteConfig per l'app predefinita o una determinata app.

admin.remoteConfig() può essere chiamato senza argomenti per accedere al servizio RemoteConfig dell'app predefinita o come admin.remoteConfig(app) per accedere al servizio RemoteConfig associato a un'app specifica.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App App facoltativa per la quale restituire il servizio RemoteConfig . Se non fornito, viene restituito il servizio RemoteConfig predefinito.

Ritorna:

remoteConfig.RemoteConfig

Il servizio RemoteConfig predefinito se non viene fornita alcuna app o il servizio RemoteConfig associato all'app fornita.

Esempio 1

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

Esempio 2

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

regole di sicurezza()

Ottiene il servizio SecurityRules per l'app predefinita o per una determinata app.

admin.securityRules() può essere chiamato senza argomenti per accedere al servizio SecurityRules dell'app predefinita o come admin.securityRules(app) per accedere al servizio SecurityRules associato a un'app specifica.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App App facoltativa per cui restituire il servizio SecurityRules . Se non fornito, viene restituito il servizio SecurityRules predefinito.

Ritorna:

securityRules.SecurityRules

Il servizio SecurityRules predefinito se non viene fornita alcuna app oppure il servizio SecurityRules associato all'app fornita.

Esempio 1

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

Esempio 2

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

magazzinaggio()

Ottiene il servizio di archiviazione per l'app predefinita o per una determinata app.

admin.storage() può essere chiamato senza argomenti per accedere al servizio Storage dell'app predefinita o come admin.storage(app) per accedere al servizio Storage associato a un'app specifica.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App

Ritorna:

stoccaggio.Stoccaggio

Esempio 1

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

Esempio 2

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

app

Firma:

apps: (app.App | null)[]

SDK_VERSIONE

Firma:

SDK_VERSION: string