API com namespace do Firebase (legada).
Funções
| Função | Descrição |
|---|---|
| app(nome) | |
| appCheck(link em inglês) | Recebe o serviço AppCheck do app padrão ou de um determinado app.admin.appCheck() pode ser chamado sem argumentos para acessar o serviço AppCheck do app padrão ou como admin.appCheck(app) para acessar o serviço AppCheck associado a um app específico. |
| auth(app) | Recebe o serviço Auth do app padrão ou de um determinado app.admin.auth() pode ser chamado sem argumentos para acessar o serviço Auth do app padrão ou como admin.auth(app) para acessar o serviço Auth associado a um app específico. |
| banco de dados(app) | Recebe o serviço Database do app padrão ou de um determinado app.admin.database() pode ser chamado sem argumentos para acessar o serviço Database do app padrão ou como admin.database(app) para acessar o serviço Database associado a um app específico.admin.database também é um namespace que pode ser usado para acessar constantes e métodos globais associados ao serviço Database. |
| firestore(app) | |
| InitializeApp(options, name) | |
| instalações(app) | Recebe o serviço Instalações do app padrão ou de um determinado app.admin.installations() pode ser chamado sem argumentos para acessar o serviço Instalações do app padrão ou como admin.installations(app) para acessar o serviço Instalações associado a um app específico. |
| instanceId(app). | Recebe o serviço InstanceId do app padrão ou de um determinado app.admin.instanceId() pode ser chamado sem argumentos para acessar o serviço InstanceId do app padrão ou como admin.instanceId(app) para acessar o serviço InstanceId associado a um app específico. |
| machineLearning(app) | Recebe o serviço MachineLearning para o app padrão ou um determinado app.admin.machineLearning() pode ser chamado sem argumentos para acessar o serviço MachineLearning do app padrão ou como admin.machineLearning(app) para acessar o serviço MachineLearning associado a um app específico. |
| mensagens(app) | Recebe o serviço Messaging do app padrão ou de um determinado app.admin.messaging() pode ser chamado sem argumentos para acessar o serviço Messaging do app padrão ou como admin.messaging(app) para acessar o serviço Messaging associado a um app específico. |
| projectManagement(app) (link em inglês) | Recebe o serviço ProjectManagement para o app padrão ou um determinado app.admin.projectManagement() pode ser chamado sem argumentos para acessar o serviço ProjectManagement do app padrão ou como admin.projectManagement(app) para acessar o serviço ProjectManagement associado a um app específico. |
| remoteConfig(app) (em inglês) | Recebe o serviço RemoteConfig do app padrão ou de um determinado app.admin.remoteConfig() pode ser chamado sem argumentos para acessar o serviço RemoteConfig do app padrão ou como admin.remoteConfig(app) para acessar o serviço RemoteConfig associado a um app específico. |
| securityRules(app) | Recebe o serviço SecurityRules do app padrão ou de um determinado app.admin.securityRules() pode ser chamado sem argumentos para acessar o serviço SecurityRules do app padrão ou como admin.securityRules(app) para acessar o serviço SecurityRules associado a um app específico. |
| storage(app) | Recebe o serviço de Armazenamento do app padrão ou de um determinado app.admin.storage() pode ser chamado sem argumentos para acessar o serviço Storage do app padrão ou como admin.storage(app) para acessar o serviço Storage associado a um app específico. |
Interfaces
| Interface | Descrição |
|---|---|
| Opções de aplicativos | Opções disponíveis para transmitir para InitializeApp(). |
| FirebaseArrayIndexError (link em inglês) | Tipo composto que inclui um objeto FirebaseError e um índice que pode ser usado para receber o item com erro. |
| FirebaseError (em inglês) | FirebaseError é uma subclasse do objeto Error JavaScript padrão. Além de uma string de mensagem e um stack trace, ela contém um código de string. |
| GoogleOAuthAccessToken (em inglês) | Interface para tokens de acesso do Google OAuth 2.0. |
| Conta de serviço |
Namespaces
| Namespace | Descrição |
|---|---|
| app | |
| AppCheck (link em inglês) | |
| autenticação | |
| credencial | |
| database | |
| firestore (em inglês) | |
| instalações | |
| instanceId (em inglês). | |
| Aprendizado de máquina | |
| mensagens | |
| gerenciamento de projetos | |
| remoteConfig (em inglês) | |
| securityRules (link em inglês) | |
| armazenamento |
Variáveis
| Variável | Descrição |
|---|---|
| Apps | |
| SDK_VERSION (link em inglês) |
app(nome)
Assinatura:
export declare function app(name?: string): app.App;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| name | string |
Retorna:
app.App (link em inglês)
AppCheck(app)
Recebe o serviço AppCheck para o app padrão ou um determinado app.
admin.appCheck() pode ser chamado sem argumentos para acessar o serviço AppCheck do app padrão ou como admin.appCheck(app) para acessar o serviço AppCheck associado a um app específico.
Assinatura:
export declare function appCheck(app?: App): appCheck.AppCheck;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | App | App opcional para retornar o serviço AppCheck. Caso não seja fornecido, o serviço AppCheck padrão será retornado. |
Retorna:
appCheck.AppCheck (link em inglês)
O serviço AppCheck padrão, se nenhum app for fornecido, ou o serviço AppCheck associado ao app fornecido.
Exemplo 1
// Get the `AppCheck` service for the default app
var defaultAppCheck = admin.appCheck();
Exemplo 2
// Get the `AppCheck` service for a given app
var otherAppCheck = admin.appCheck(otherApp);
auth(app)
Recebe o serviço Auth para o app padrão ou um determinado app.
admin.auth() pode ser chamado sem argumentos para acessar o serviço Auth do app padrão ou como admin.auth(app) para acessar o serviço Auth associado a um app específico.
Assinatura:
export declare function auth(app?: App): auth.Auth;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | App |
Retorna:
auth.Auth (em inglês)
Exemplo 1
// Get the Auth service for the default app
var defaultAuth = admin.auth();
Exemplo 2
// Get the Auth service for a given app
var otherAuth = admin.auth(otherApp);
banco de dados(app)
Recebe o serviço Database para o app padrão ou um determinado app.
admin.database() pode ser chamado sem argumentos para acessar o serviço Database do app padrão ou como admin.database(app) para acessar o serviço Database associado a um app específico.
O admin.database também é um namespace que pode ser usado para acessar constantes e métodos globais associados ao serviço Database.
Assinatura:
export declare function database(app?: App): database.Database;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | App |
Retorna:
database.Database (link em inglês)
O serviço Database padrão, se nenhum app for fornecido, ou o serviço Database associado ao app fornecido.
Exemplo 1
// Get the Database service for the default app
var defaultDatabase = admin.database();
Exemplo 2
// Get the Database service for a specific app
var otherDatabase = admin.database(app);
firestore(app)
Assinatura:
export declare function firestore(app?: App): _firestore.Firestore;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | App |
Retorna:
_firestore.Firestore
startupApp(options, nome)
Assinatura:
export declare function initializeApp(options?: AppOptions, name?: string): app.App;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| do modelo. | Opções de aplicativos | |
| name | string |
Retorna:
app.App (link em inglês)
instalações(app)
Recebe o serviço Instalações para o app padrão ou um determinado app.
O admin.installations() pode ser chamado sem argumentos para acessar o serviço Instalações do app padrão ou como admin.installations(app) para acessar o serviço Instalações associado a um app específico.
Assinatura:
export declare function installations(app?: App): installations.Installations;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | App | App opcional cujo serviço Installations será retornado. Caso não seja fornecido, o serviço Installations padrão será retornado. |
Retorna:
O serviço Installations padrão, se nenhum app for fornecido, ou o serviço Installations associado ao app fornecido.
Exemplo 1
// Get the Installations service for the default app
var defaultInstallations = admin.installations();
Exemplo 2
// Get the Installations service for a given app
var otherInstallations = admin.installations(otherApp);
instanceId(app)
Recebe o serviço InstanceId do app padrão ou de um determinado app.
admin.instanceId() pode ser chamado sem argumentos para acessar o serviço InstanceId do app padrão ou como admin.instanceId(app) para acessar o serviço InstanceId associado a um app específico.
Assinatura:
export declare function instanceId(app?: App): instanceId.InstanceId;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | App | App opcional cujo serviço InstanceId será retornado. Caso não seja fornecido, o serviço InstanceId padrão será retornado. |
Retorna:
instanceId.InstanceId (em inglês)
O serviço InstanceId padrão, se nenhum app for fornecido, ou o serviço InstanceId associado ao app fornecido.
Exemplo 1
// Get the Instance ID service for the default app
var defaultInstanceId = admin.instanceId();
Exemplo 2
// Get the Instance ID service for a given app
var otherInstanceId = admin.instanceId(otherApp);
machineLearning(app)
Recebe o serviço MachineLearning para o app padrão ou um determinado app.
admin.machineLearning() pode ser chamado sem argumentos para acessar o serviço MachineLearning do app padrão ou como admin.machineLearning(app) para acessar o serviço MachineLearning associado a um app específico.
Assinatura:
export declare function machineLearning(app?: App): machineLearning.MachineLearning;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | App | App opcional cujo serviço MachineLearning será retornado. Caso não seja fornecido, o serviço MachineLearning padrão será retornado. |
Retorna:
machineLearning.MachineLearning
O serviço MachineLearning padrão, se nenhum app for fornecido, ou o serviço MachineLearning associado ao app fornecido.
Exemplo 1
// Get the MachineLearning service for the default app
var defaultMachineLearning = admin.machineLearning();
Exemplo 2
// Get the MachineLearning service for a given app
var otherMachineLearning = admin.machineLearning(otherApp);
mensagens(app)
Recebe o serviço Messaging para o app padrão ou um determinado app.
admin.messaging() pode ser chamado sem argumentos para acessar o serviço Messaging do app padrão ou como admin.messaging(app) para acessar o serviço Messaging associado a um app específico.
Assinatura:
export declare function messaging(app?: App): messaging.Messaging;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | App | App opcional cujo serviço Messaging será retornado. Caso não seja fornecido, o serviço Messaging padrão será retornado. |
Retorna:
O serviço Messaging padrão, se nenhum app for fornecido, ou o serviço Messaging associado ao app fornecido.
Exemplo 1
// Get the Messaging service for the default app
var defaultMessaging = admin.messaging();
Exemplo 2
// Get the Messaging service for a given app
var otherMessaging = admin.messaging(otherApp);
ProjectManagement(app)
Recebe o serviço ProjectManagement para o app padrão ou um determinado app.
O admin.projectManagement() pode ser chamado sem argumentos para acessar o serviço ProjectManagement do app padrão ou como admin.projectManagement(app) para acessar o serviço ProjectManagement associado a um app específico.
Assinatura:
export declare function projectManagement(app?: App): projectManagement.ProjectManagement;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | App | App opcional cujo serviço ProjectManagement será retornado. Caso não seja fornecido, o serviço ProjectManagement padrão será retornado. * |
Retorna:
projectManagement.ProjectManagement (em inglês)
O serviço ProjectManagement padrão, se nenhum app for fornecido, ou o serviço ProjectManagement associado ao app fornecido.
Exemplo 1
// Get the ProjectManagement service for the default app
var defaultProjectManagement = admin.projectManagement();
Exemplo 2
// Get the ProjectManagement service for a given app
var otherProjectManagement = admin.projectManagement(otherApp);
RemoteConfig(app)
Recebe o serviço RemoteConfig para o app padrão ou um determinado app.
admin.remoteConfig() pode ser chamado sem argumentos para acessar o serviço RemoteConfig do app padrão ou como admin.remoteConfig(app) para acessar o serviço RemoteConfig associado a um app específico.
Assinatura:
export declare function remoteConfig(app?: App): remoteConfig.RemoteConfig;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | App | App opcional para retornar o serviço RemoteConfig. Caso não seja fornecido, o serviço RemoteConfig padrão será retornado. |
Retorna:
remoteConfig.RemoteConfig (em inglês)
O serviço RemoteConfig padrão, se nenhum app for fornecido, ou o serviço RemoteConfig associado ao app fornecido.
Exemplo 1
// Get the `RemoteConfig` service for the default app
var defaultRemoteConfig = admin.remoteConfig();
Exemplo 2
// Get the `RemoteConfig` service for a given app
var otherRemoteConfig = admin.remoteConfig(otherApp);
securityRules(app)
Recebe o serviço SecurityRules para o app padrão ou um determinado app.
admin.securityRules() pode ser chamado sem argumentos para acessar o serviço SecurityRules do app padrão ou como admin.securityRules(app) para acessar o serviço SecurityRules associado a um app específico.
Assinatura:
export declare function securityRules(app?: App): securityRules.SecurityRules;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | App | App opcional para o qual o serviço SecurityRules será retornado. Caso não seja fornecido, o serviço SecurityRules padrão será retornado. |
Retorna:
securityRules.SecurityRules (link em inglês)
O serviço SecurityRules padrão, se nenhum app for fornecido, ou o serviço SecurityRules associado ao app fornecido.
Exemplo 1
// Get the SecurityRules service for the default app
var defaultSecurityRules = admin.securityRules();
Exemplo 2
// Get the SecurityRules service for a given app
var otherSecurityRules = admin.securityRules(otherApp);
armazenamento(app)
Recebe o serviço de Armazenamento para o app padrão ou um determinado app.
admin.storage() pode ser chamado sem argumentos para acessar o serviço Storage do app padrão ou como admin.storage(app) para acessar o serviço Storage associado a um app específico.
Assinatura:
export declare function storage(app?: App): storage.Storage;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| app | App |
Retorna:
storage.Storage (em inglês)
Exemplo 1
// Get the Storage service for the default app
var defaultStorage = admin.storage();
Exemplo 2
// Get the Storage service for a given app
var otherStorage = admin.storage(otherApp);
apps
Assinatura:
apps: (app.App | null)[]
SDK_VERSION
Assinatura:
SDK_VERSION: string