API con espacio de nombres de Firebase (heredada).
Funciones
| Función | Descripción |
|---|---|
| nombre de la aplicación) | |
| aplicaciónCheck(aplicación) | Obtiene el servicio AppCheck para la aplicación predeterminada o una aplicación determinada. Se puede llamar a admin.appCheck() sin argumentos para acceder al servicio AppCheck de la aplicación predeterminada o como admin.appCheck(app) para acceder al servicio AppCheck asociado con una aplicación específica. |
| autenticación (aplicación) | Obtiene el servicio de autenticación para la aplicación predeterminada o una aplicación determinada. Se puede llamar admin.auth() sin argumentos para acceder al servicio de autenticación de la aplicación predeterminada o como admin.auth(app) para acceder al servicio de autenticación asociado con una aplicación específica. |
| base de datos (aplicación) | Obtiene el servicio de base de datos para la aplicación predeterminada o una aplicación determinada. Se puede llamar admin.database() sin argumentos para acceder al servicio Database de la aplicación predeterminada o como admin.database(app) para acceder al servicio Database asociado con una aplicación específica. admin.database también es un espacio de nombres que se puede utilizar para acceder a constantes y métodos globales asociados con el servicio Database . |
| tienda de fuego (aplicación) | |
| inicializarApp(opciones, nombre) | |
| instalaciones (aplicación) | Obtiene el servicio de instalaciones para la aplicación predeterminada o una aplicación determinada. Se puede llamar a admin.installations() sin argumentos para acceder al servicio de instalaciones de la aplicación predeterminada o como admin.installations(app) para acceder al servicio de instalaciones asociado con una aplicación específica. |
| ID de instancia (aplicación) | Obtiene el servicio InstanceId para la aplicación predeterminada o una aplicación determinada. Se puede llamar admin.instanceId() sin argumentos para acceder al servicio InstanceId de la aplicación predeterminada o como admin.instanceId(app) para acceder al servicio InstanceId asociado con una aplicación específica. |
| aprendizaje automático (aplicación) | Obtiene el servicio MachineLearning para la aplicación predeterminada o una aplicación determinada. Se puede llamar admin.machineLearning() sin argumentos para acceder al servicio MachineLearning de la aplicación predeterminada o como admin.machineLearning(app) para acceder al servicio MachineLearning asociado con una aplicación específica. |
| mensajería (aplicación) | Obtiene el servicio de mensajería para la aplicación predeterminada o una aplicación determinada. Se puede llamar a admin.messaging() sin argumentos para acceder al servicio Messaging de la aplicación predeterminada o como admin.messaging(app) para acceder al servicio Messaging asociado con una aplicación específica. |
| gestión de proyectos (aplicación) | Obtiene el servicio ProjectManagement para la aplicación predeterminada o una aplicación determinada. Se puede llamar admin.projectManagement() sin argumentos para acceder al servicio ProjectManagement de la aplicación predeterminada, o como admin.projectManagement(app) para acceder al servicio ProjectManagement asociado con una aplicación específica. |
| configuración remota (aplicación) | Obtiene el servicio RemoteConfig para la aplicación predeterminada o una aplicación determinada. Se puede llamar admin.remoteConfig() sin argumentos para acceder al servicio RemoteConfig de la aplicación predeterminada o como admin.remoteConfig(app) para acceder al servicio RemoteConfig asociado con una aplicación específica. |
| reglas de seguridad (aplicación) | Obtiene el servicio SecurityRules para la aplicación predeterminada o una aplicación determinada. Se puede llamar admin.securityRules() sin argumentos para acceder al servicio SecurityRules de la aplicación predeterminada, o como admin.securityRules(app) para acceder al servicio SecurityRules asociado con una aplicación específica. |
| almacenamiento (aplicación) | Obtiene el servicio de almacenamiento para la aplicación predeterminada o una aplicación determinada. Se puede llamar admin.storage() sin argumentos para acceder al servicio Storage de la aplicación predeterminada o como admin.storage(app) para acceder al servicio Storage asociado con una aplicación específica. |
Interfaces
| Interfaz | Descripción |
|---|---|
| Opciones de aplicación | Opciones disponibles para pasar a inicializarApp() . |
| Error de índice de matriz de Firebase | Tipo compuesto que incluye un objeto FirebaseError y un índice que se puede usar para obtener el elemento con error. |
| Error de base de fuego | FirebaseError es una subclase del objeto Error de JavaScript estándar. Además de una cadena de mensaje y un seguimiento de la pila, contiene un código de cadena. |
| Token de acceso de GoogleOAuth | Interfaz para tokens de acceso de Google OAuth 2.0. |
| Cuenta de servicio |
Espacios de nombres
variables
| Variable | Descripción |
|---|---|
| aplicaciones | |
| SDK_VERSION |
aplicación()
Firma:
export declare function app(name?: string): app.App;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| nombre | cadena |
Devoluciones:
aplicaciónCheck()
Obtiene el servicio AppCheck para la aplicación predeterminada o una aplicación determinada.
Se puede llamar a admin.appCheck() sin argumentos para acceder al servicio AppCheck de la aplicación predeterminada o como admin.appCheck(app) para acceder al servicio AppCheck asociado con una aplicación específica.
Firma:
export declare function appCheck(app?: App): appCheck.AppCheck;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| aplicación | Aplicación | Aplicación opcional para devolver el servicio AppCheck . Si no se proporciona, se devuelve el servicio AppCheck predeterminado. |
Devoluciones:
El servicio AppCheck predeterminado si no se proporciona ninguna aplicación, o el servicio AppCheck asociado con la aplicación proporcionada.
Ejemplo 1
// Get the `AppCheck` service for the default app
var defaultAppCheck = admin.appCheck();
Ejemplo 2
// Get the `AppCheck` service for a given app
var otherAppCheck = admin.appCheck(otherApp);
autenticación()
Obtiene el servicio de autenticación para la aplicación predeterminada o una aplicación determinada.
Se puede llamar admin.auth() sin argumentos para acceder al servicio de autenticación de la aplicación predeterminada o como admin.auth(app) para acceder al servicio de autenticación asociado con una aplicación específica.
Firma:
export declare function auth(app?: App): auth.Auth;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| aplicación | Aplicación |
Devoluciones:
Ejemplo 1
// Get the Auth service for the default app
var defaultAuth = admin.auth();
Ejemplo 2
// Get the Auth service for a given app
var otherAuth = admin.auth(otherApp);
base de datos()
Obtiene el servicio de base de datos para la aplicación predeterminada o una aplicación determinada.
Se puede llamar admin.database() sin argumentos para acceder al servicio Database de la aplicación predeterminada o como admin.database(app) para acceder al servicio Database asociado con una aplicación específica.
admin.database también es un espacio de nombres que se puede utilizar para acceder a constantes y métodos globales asociados con el servicio Database .
Firma:
export declare function database(app?: App): database.Database;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| aplicación | Aplicación |
Devoluciones:
El servicio Database predeterminado si no se proporciona ninguna aplicación o el servicio Database asociado con la aplicación proporcionada.
Ejemplo 1
// Get the Database service for the default app
var defaultDatabase = admin.database();
Ejemplo 2
// Get the Database service for a specific app
var otherDatabase = admin.database(app);
almacén de fuego()
Firma:
export declare function firestore(app?: App): _firestore.Firestore;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| aplicación | Aplicación |
Devoluciones:
_firestore.Firestore
inicializar aplicación()
Firma:
export declare function initializeApp(options?: AppOptions, name?: string): app.App;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| opciones | Opciones de aplicación | |
| nombre | cadena |
Devoluciones:
instalaciones()
Obtiene el servicio de instalaciones para la aplicación predeterminada o una aplicación determinada.
Se puede llamar a admin.installations() sin argumentos para acceder al servicio de instalaciones de la aplicación predeterminada o como admin.installations(app) para acceder al servicio de instalaciones asociado con una aplicación específica.
Firma:
export declare function installations(app?: App): installations.Installations;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| aplicación | Aplicación | App opcional cuyo servicio Installations desea devolver. Si no se proporciona, se devuelve el servicio Installations predeterminado. |
Devoluciones:
El servicio Installations predeterminado si no se proporciona ninguna aplicación o el servicio Installations asociado con la aplicación proporcionada.
Ejemplo 1
// Get the Installations service for the default app
var defaultInstallations = admin.installations();
Ejemplo 2
// Get the Installations service for a given app
var otherInstallations = admin.installations(otherApp);
ID de instancia()
Obtiene el servicio InstanceId para la aplicación predeterminada o una aplicación determinada.
Se puede llamar admin.instanceId() sin argumentos para acceder al servicio InstanceId de la aplicación predeterminada o como admin.instanceId(app) para acceder al servicio InstanceId asociado con una aplicación específica.
Firma:
export declare function instanceId(app?: App): instanceId.InstanceId;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| aplicación | Aplicación | Aplicación opcional cuyo servicio InstanceId se devolverá. Si no se proporciona, se devolverá el servicio InstanceId predeterminado. |
Devoluciones:
ID de instancia.Id de instancia
El servicio InstanceId predeterminado si no se proporciona ninguna aplicación o el servicio InstanceId asociado con la aplicación proporcionada.
Ejemplo 1
// Get the Instance ID service for the default app
var defaultInstanceId = admin.instanceId();
Ejemplo 2
// Get the Instance ID service for a given app
var otherInstanceId = admin.instanceId(otherApp);
aprendizaje automático()
Obtiene el servicio MachineLearning para la aplicación predeterminada o una aplicación determinada.
Se puede llamar admin.machineLearning() sin argumentos para acceder al servicio MachineLearning de la aplicación predeterminada o como admin.machineLearning(app) para acceder al servicio MachineLearning asociado con una aplicación específica.
Firma:
export declare function machineLearning(app?: App): machineLearning.MachineLearning;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| aplicación | Aplicación | Aplicación opcional cuyo servicio MachineLearning devolverá. Si no se proporciona, se devolverá el servicio MachineLearning predeterminado. |
Devoluciones:
machineLearning.MachineLearning
El servicio MachineLearning predeterminado si no se proporciona ninguna aplicación o el servicio MachineLearning asociado con la aplicación proporcionada.
Ejemplo 1
// Get the MachineLearning service for the default app
var defaultMachineLearning = admin.machineLearning();
Ejemplo 2
// Get the MachineLearning service for a given app
var otherMachineLearning = admin.machineLearning(otherApp);
mensajería()
Obtiene el servicio de mensajería para la aplicación predeterminada o una aplicación determinada.
Se puede llamar a admin.messaging() sin argumentos para acceder al servicio Messaging de la aplicación predeterminada o como admin.messaging(app) para acceder al servicio Messaging asociado con una aplicación específica.
Firma:
export declare function messaging(app?: App): messaging.Messaging;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| aplicación | Aplicación | Aplicación opcional cuyo servicio Messaging devolverá. Si no se proporciona, se devolverá el servicio Messaging predeterminado. |
Devoluciones:
El servicio Messaging predeterminado si no se proporciona ninguna aplicación o el servicio Messaging asociado con la aplicación proporcionada.
Ejemplo 1
// Get the Messaging service for the default app
var defaultMessaging = admin.messaging();
Ejemplo 2
// Get the Messaging service for a given app
var otherMessaging = admin.messaging(otherApp);
gestión de proyectos()
Obtiene el servicio ProjectManagement para la aplicación predeterminada o una aplicación determinada.
Se puede llamar admin.projectManagement() sin argumentos para acceder al servicio ProjectManagement de la aplicación predeterminada, o como admin.projectManagement(app) para acceder al servicio ProjectManagement asociado con una aplicación específica.
Firma:
export declare function projectManagement(app?: App): projectManagement.ProjectManagement;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| aplicación | Aplicación | Aplicación opcional cuyo servicio ProjectManagement devolverá. Si no se proporciona, se devolverá el servicio ProjectManagement predeterminado. * |
Devoluciones:
ProjectManagement.ProjectManagement
El servicio ProjectManagement predeterminado si no se proporciona ninguna aplicación o el servicio ProjectManagement asociado con la aplicación proporcionada.
Ejemplo 1
// Get the ProjectManagement service for the default app
var defaultProjectManagement = admin.projectManagement();
Ejemplo 2
// Get the ProjectManagement service for a given app
var otherProjectManagement = admin.projectManagement(otherApp);
configuración remota()
Obtiene el servicio RemoteConfig para la aplicación predeterminada o una aplicación determinada.
Se puede llamar admin.remoteConfig() sin argumentos para acceder al servicio RemoteConfig de la aplicación predeterminada o como admin.remoteConfig(app) para acceder al servicio RemoteConfig asociado con una aplicación específica.
Firma:
export declare function remoteConfig(app?: App): remoteConfig.RemoteConfig;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| aplicación | Aplicación | Aplicación opcional para devolver el servicio RemoteConfig . Si no se proporciona, se devuelve el servicio RemoteConfig predeterminado. |
Devoluciones:
El servicio RemoteConfig predeterminado si no se proporciona ninguna aplicación, o el servicio RemoteConfig asociado con la aplicación proporcionada.
Ejemplo 1
// Get the `RemoteConfig` service for the default app
var defaultRemoteConfig = admin.remoteConfig();
Ejemplo 2
// Get the `RemoteConfig` service for a given app
var otherRemoteConfig = admin.remoteConfig(otherApp);
reglas de seguridad()
Obtiene el servicio SecurityRules para la aplicación predeterminada o una aplicación determinada.
Se puede llamar admin.securityRules() sin argumentos para acceder al servicio SecurityRules de la aplicación predeterminada, o como admin.securityRules(app) para acceder al servicio SecurityRules asociado con una aplicación específica.
Firma:
export declare function securityRules(app?: App): securityRules.SecurityRules;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| aplicación | Aplicación | Aplicación opcional para devolver el servicio SecurityRules . Si no se proporciona, se devuelve el servicio SecurityRules predeterminado. |
Devoluciones:
reglas de seguridad.Rules de seguridad
El servicio SecurityRules predeterminado si no se proporciona ninguna aplicación, o el servicio SecurityRules asociado con la aplicación proporcionada.
Ejemplo 1
// Get the SecurityRules service for the default app
var defaultSecurityRules = admin.securityRules();
Ejemplo 2
// Get the SecurityRules service for a given app
var otherSecurityRules = admin.securityRules(otherApp);
almacenamiento()
Obtiene el servicio de almacenamiento para la aplicación predeterminada o una aplicación determinada.
Se puede llamar admin.storage() sin argumentos para acceder al servicio Storage de la aplicación predeterminada o como admin.storage(app) para acceder al servicio Storage asociado con una aplicación específica.
Firma:
export declare function storage(app?: App): storage.Storage;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| aplicación | Aplicación |
Devoluciones:
Ejemplo 1
// Get the Storage service for the default app
var defaultStorage = admin.storage();
Ejemplo 2
// Get the Storage service for a given app
var otherStorage = admin.storage(otherApp);
aplicaciones
Firma:
apps: (app.App | null)[]
SDK_VERSION
Firma:
SDK_VERSION: string