API de Firebase con espacio de nombres (heredada).
Funciones
| Función | Descripción |
|---|---|
| app(nombre) | |
| AppCheck(aplicación) | Obtiene el servicio AppCheck para la app predeterminada o una app determinada.Se puede llamar a admin.appCheck() sin argumentos para acceder al servicio AppCheck de la app predeterminada o como admin.appCheck(app) para acceder al servicio AppCheck asociado con una app específica. |
| auth(app) | Obtiene el servicio de Auth para la app predeterminada o una app determinada.Se puede llamar a admin.auth() sin argumentos para acceder al servicio Auth de la app predeterminada o como admin.auth(app) para acceder al servicio de Auth asociado con una app específica. |
| base_de_datos(aplicación) | Obtiene el servicio Database para la app predeterminada o una app determinada.Se puede llamar a admin.database() sin argumentos para acceder al servicio Database de la app predeterminada o como admin.database(app) para acceder al servicio Database asociado con una app específica.admin.database también es un espacio de nombres que se puede usar para acceder a constantes y métodos globales asociados con el servicio Database. |
| firestore(app) | |
| inicializaApp(opciones, nombre) | |
| instalaciones(app) | Obtiene el servicio Installations para la app predeterminada o una app determinada.Se puede llamar a admin.installations() sin argumentos para acceder al servicio Installations de la app predeterminada o como admin.installations(app) para acceder al servicio Installations asociado con una app específica. |
| instanceId(aplicación) | Obtiene el servicio InstanceId para la app predeterminada o una app determinada.Se puede llamar a admin.instanceId() sin argumentos para acceder al servicio InstanceId de la app predeterminada o como admin.instanceId(app) para acceder al servicio InstanceId asociado con una app específica. |
| Aprendizaje automático(aplicación) | Obtiene el servicio MachineLearning de la app predeterminada o una app determinada.Se puede llamar a admin.machineLearning() sin argumentos para acceder al servicio MachineLearning de la app predeterminada o como admin.machineLearning(app) para acceder al servicio MachineLearning asociado con una app específica. |
| mensajería(app) | Obtiene el servicio de Messaging para la app predeterminada o una app determinada.Se puede llamar a admin.messaging() sin argumentos para acceder al servicio Messaging de la app predeterminada o como admin.messaging(app) para acceder al servicio Messaging asociado con una app específica. |
| projectManagement(app) | Obtiene el servicio ProjectManagement para la app predeterminada o una app determinada.Se puede llamar a admin.projectManagement() sin argumentos para acceder al servicio ProjectManagement de la app predeterminada, o como admin.projectManagement(app) para acceder al servicio ProjectManagement asociado con una app específica. |
| remoteConfig(app) | Obtiene el servicio RemoteConfig para la app predeterminada o una app determinada.Se puede llamar a admin.remoteConfig() sin argumentos para acceder al servicio RemoteConfig de la app predeterminada o como admin.remoteConfig(app) para acceder al servicio RemoteConfig asociado con una app específica. |
| securityRules(app) | Obtiene el servicio SecurityRules para la app predeterminada o una app determinada.Se puede llamar a admin.securityRules() sin argumentos para acceder al servicio SecurityRules de la app predeterminada, o como admin.securityRules(app) para acceder al servicio SecurityRules asociado con una app específica. |
| almacenamiento(app) | Obtiene el servicio de Storage para la app predeterminada o una app determinada.Se puede llamar a admin.storage() sin argumentos para acceder al servicio Storage de la app predeterminada o como admin.storage(app) para acceder al servicio Storage asociado con una app específica. |
Interfaces
| Interfaz | Descripción |
|---|---|
| Opciones de aplicación | Opciones disponibles para pasar a InitializeApp(). |
| FirebaseArrayIndexError. | Tipo compuesto que incluye un objeto FirebaseError y un índice que se puede usar para obtener el elemento con error. |
| FirebaseError. | FirebaseError es una subclase del objeto Error estándar de JavaScript. Además de una cadena de mensaje y un seguimiento de pila, contiene un código de cadena. |
| GoogleOAuthAccessToken | Interfaz para tokens de acceso de Google OAuth 2.0. |
| Cuenta de servicio |
Espacios de nombres
Variables
| Variable | Descripción |
|---|---|
| apps | |
| SDK_VERSION |
app(nombre)
Firma:
export declare function app(name?: string): app.App;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| nombre | string |
Muestra:
appCheck(aplicación)
Obtiene el servicio AppCheck para la app predeterminada o una app determinada.
Se puede llamar a admin.appCheck() sin argumentos para acceder al servicio AppCheck de la app predeterminada o como admin.appCheck(app) para acceder al servicio AppCheck asociado con una app específica.
Firma:
export declare function appCheck(app?: App): appCheck.AppCheck;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| app | App | App opcional para la que se muestra el servicio AppCheck. Si no se proporciona, se muestra el servicio AppCheck predeterminado. |
Muestra:
El servicio AppCheck predeterminado si no se proporciona ninguna app, o bien el servicio AppCheck asociado con la app 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);
aut.(aplicación)
Obtiene el servicio de Auth para la app predeterminada o una app determinada.
Se puede llamar a admin.auth() sin argumentos para acceder al servicio de Auth de la app predeterminada o como admin.auth(app) para acceder al servicio de Auth asociado con una app específica.
Firma:
export declare function auth(app?: App): auth.Auth;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| app | App |
Muestra:
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(aplicación)
Obtiene el servicio Database para la app predeterminada o una app determinada.
Se puede llamar a admin.database() sin argumentos para acceder al servicio Database de la app predeterminada o como admin.database(app) para acceder al servicio Database asociado con una app específica.
admin.database también es un espacio de nombres que se puede usar 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 |
|---|---|---|
| app | App |
Muestra:
El servicio Database predeterminado si no se proporciona ninguna app, o bien el servicio Database asociado con la app 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);
Firestore(app)
Firma:
export declare function firestore(app?: App): _firestore.Firestore;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| app | App |
Muestra:
_Firestore.Firestore
inicializarApp(opciones, nombre)
Firma:
export declare function initializeApp(options?: AppOptions, name?: string): app.App;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| opciones | Opciones de aplicación | |
| nombre | string |
Muestra:
instalaciones(app)
Obtiene el servicio de instalaciones para la app predeterminada o una app determinada.
Se puede llamar a admin.installations() sin argumentos para acceder al servicio de instalaciones de la app predeterminada o como admin.installations(app) para acceder al servicio de Instalaciones asociado con una app específica.
Firma:
export declare function installations(app?: App): installations.Installations;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| app | App | App opcional cuyo servicio Installations se debe mostrar. Si no se proporciona, se muestra el servicio Installations predeterminado. |
Muestra:
El servicio Installations predeterminado si no se proporciona ninguna app, o bien el servicio Installations asociado con la app 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);
IDdeinstancia(aplicación)
Obtiene el servicio InstanceId para la app predeterminada o una app determinada.
Se puede llamar a admin.instanceId() sin argumentos para acceder al servicio InstanceId de la app predeterminada o como admin.instanceId(app) para acceder al servicio InstanceId asociado con una app específica.
Firma:
export declare function instanceId(app?: App): instanceId.InstanceId;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| app | App | App opcional cuyo servicio InstanceId se debe mostrar. Si no se proporciona, se mostrará el servicio InstanceId predeterminado. |
Muestra:
El servicio InstanceId predeterminado si no se proporciona ninguna app, o bien el servicio InstanceId asociado con la app 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(aplicación)
Obtiene el servicio MachineLearning de la app predeterminada o una app determinada.
Se puede llamar a admin.machineLearning() sin argumentos para acceder al servicio MachineLearning de la app predeterminada o como admin.machineLearning(app) para acceder al servicio MachineLearning asociado con una app específica.
Firma:
export declare function machineLearning(app?: App): machineLearning.MachineLearning;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| app | App | App opcional cuyo servicio MachineLearning se debe mostrar. Si no se proporciona, se mostrará el servicio MachineLearning predeterminado. |
Muestra:
machineLearning.MachineLearning
El servicio MachineLearning predeterminado si no se proporciona ninguna app, o bien el servicio MachineLearning asociado con la app 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(aplicación)
Obtiene el servicio de Messaging para la app predeterminada o una app determinada.
Se puede llamar a admin.messaging() sin argumentos para acceder al servicio Messaging de la app predeterminada o como admin.messaging(app) para acceder al servicio Messaging asociado con una app específica.
Firma:
export declare function messaging(app?: App): messaging.Messaging;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| app | App | App opcional cuyo servicio Messaging se debe mostrar. Si no se proporciona, se mostrará el servicio Messaging predeterminado. |
Muestra:
El servicio Messaging predeterminado si no se proporciona ninguna app, o bien el servicio Messaging asociado con la app 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);
Administración de proyectos(aplicación)
Obtiene el servicio ProjectManagement para la app predeterminada o una app determinada.
Se puede llamar a admin.projectManagement() sin argumentos para acceder al servicio ProjectManagement de la app predeterminada, o como admin.projectManagement(app) para acceder al servicio ProjectManagement asociado con una app específica.
Firma:
export declare function projectManagement(app?: App): projectManagement.ProjectManagement;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| app | App | App opcional cuyo servicio ProjectManagement se debe mostrar. Si no se proporciona, se mostrará el servicio ProjectManagement predeterminado. * |
Muestra:
projectManagement.ProjectManagement
El servicio ProjectManagement predeterminado si no se proporciona ninguna app, o bien el servicio ProjectManagement asociado con la app 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);
remoteConfig(aplicación)
Obtiene el servicio RemoteConfig para la app predeterminada o una app determinada.
Se puede llamar a admin.remoteConfig() sin argumentos para acceder al servicio RemoteConfig de la app predeterminada o como admin.remoteConfig(app) para acceder al servicio RemoteConfig asociado con una app específica.
Firma:
export declare function remoteConfig(app?: App): remoteConfig.RemoteConfig;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| app | App | App opcional para la que se muestra el servicio RemoteConfig. Si no se proporciona, se muestra el servicio RemoteConfig predeterminado. |
Muestra:
El servicio RemoteConfig predeterminado si no se proporciona ninguna app, o bien el servicio RemoteConfig asociado con la app 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(aplicación)
Obtiene el servicio SecurityRules para la app predeterminada o una app determinada.
Se puede llamar a admin.securityRules() sin argumentos para acceder al servicio SecurityRules de la app predeterminada o como admin.securityRules(app) para acceder al servicio SecurityRules asociado con una app específica.
Firma:
export declare function securityRules(app?: App): securityRules.SecurityRules;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| app | App | App opcional para la que se muestra el servicio SecurityRules. Si no se proporciona, se muestra el servicio SecurityRules predeterminado. |
Muestra:
El servicio SecurityRules predeterminado si no se proporciona ninguna app, o bien el servicio SecurityRules asociado con la app 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(aplicación)
Obtiene el servicio de Storage para la app predeterminada o una app determinada.
Se puede llamar a admin.storage() sin argumentos para acceder al servicio Storage de la app predeterminada o como admin.storage(app) para acceder al servicio Storage asociado con una app específica.
Firma:
export declare function storage(app?: App): storage.Storage;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| app | App |
Muestra:
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);
de Google Chat
Firma:
apps: (app.App | null)[]
SDK_VERSION
Firma:
SDK_VERSION: string