firebase-admin package

API com namespace do Firebase (herdada).

Funções

Função Descrição
nome do aplicativo)
appCheck(aplicativo) Obtém o serviço AppCheck para o aplicativo padrão ou um determinado aplicativo. admin.appCheck() pode ser chamado sem argumentos para acessar o serviço AppCheck do aplicativo padrão ou como admin.appCheck(app) para acessar o serviço AppCheck associado a um aplicativo específico.
autenticação (aplicativo) Obtém o serviço Auth para o aplicativo padrão ou um determinado aplicativo. admin.auth() pode ser chamado sem argumentos para acessar o serviço Auth do aplicativo padrão ou como admin.auth(app) para acessar o serviço Auth associado a um aplicativo específico.
banco de dados (aplicativo) Obtém o serviço de banco de dados do aplicativo padrão ou de um determinado aplicativo. admin.database() pode ser chamado sem argumentos para acessar o serviço Database do aplicativo padrão ou como admin.database(app) para acessar o serviço Database associado a um aplicativo específico. admin.database também é um namespace que pode ser usado para acessar constantes globais e métodos associados ao serviço Database .
firestore (aplicativo)
inicializarApp(opções, nome)
instalações (aplicativo) Obtém o serviço de instalações do aplicativo padrão ou de um determinado aplicativo. admin.installations() pode ser chamado sem argumentos para acessar o serviço de instalações do aplicativo padrão ou como admin.installations(app) para acessar o serviço de instalações associado a um aplicativo específico.
instanceId(aplicativo) Obtém o serviço InstanceId para o aplicativo padrão ou um determinado aplicativo. admin.instanceId() pode ser chamado sem argumentos para acessar o serviço InstanceId do aplicativo padrão ou como admin.instanceId(app) para acessar o serviço InstanceId associado a um aplicativo específico.
aprendizado de máquina (aplicativo) Obtém o serviço MachineLearning para o aplicativo padrão ou um determinado aplicativo. admin.machineLearning() pode ser chamado sem argumentos para acessar o serviço MachineLearning do aplicativo padrão ou como admin.machineLearning(app) para acessar o serviço MachineLearning associado a um aplicativo específico.
mensagens (aplicativo) Obtém o serviço de mensagens do aplicativo padrão ou de um determinado aplicativo. admin.messaging() pode ser chamado sem argumentos para acessar o serviço Messaging do aplicativo padrão ou como admin.messaging(app) para acessar o serviço Messaging associado a um aplicativo específico.
gerenciamento de projetos (aplicativo) Obtém o serviço ProjectManagement para o aplicativo padrão ou um determinado aplicativo. admin.projectManagement() pode ser chamado sem argumentos para acessar o serviço ProjectManagement do aplicativo padrão ou como admin.projectManagement(app) para acessar o serviço ProjectManagement associado a um aplicativo específico.
configuração remota (aplicativo) Obtém o serviço RemoteConfig para o aplicativo padrão ou um determinado aplicativo. admin.remoteConfig() pode ser chamado sem argumentos para acessar o serviço RemoteConfig do aplicativo padrão ou como admin.remoteConfig(app) para acessar o serviço RemoteConfig associado a um aplicativo específico.
regras de segurança (aplicativo) Obtém o serviço SecurityRules para o aplicativo padrão ou um determinado aplicativo. admin.securityRules() pode ser chamado sem argumentos para acessar o serviço SecurityRules do aplicativo padrão ou como admin.securityRules(app) para acessar o serviço SecurityRules associado a um aplicativo específico.
armazenamento (aplicativo) Obtém o serviço de armazenamento do aplicativo padrão ou de um determinado aplicativo. admin.storage() pode ser chamado sem argumentos para acessar o serviço Storage do aplicativo padrão ou como admin.storage(app) para acessar o serviço Storage associado a um aplicativo específico.

Interfaces

Interface Descrição
Opções de aplicativos Opções disponíveis para passar para inicializarApp() .
FirebaseArrayIndexError Tipo composto que inclui um objeto FirebaseError e um índice que pode ser usado para obter o item com erro.
Erro do Firebase FirebaseError é uma subclasse do objeto JavaScript Error padrão. Além de uma sequência de mensagens e rastreamento de pilha, ele contém um código de sequência.
GoogleOAuthAccessToken Interface para tokens de acesso Google OAuth 2.0.
Conta de serviço

Espaços para nome

Espaço para nome Descrição
aplicativo
appCheck
autenticação
credencial
base de dados
firestore
instalações
ID da instância
aprendizado de máquina
Mensagens
gerenciamento de projetos
configuração remota
regras de segurança
armazenar

Variáveis

Variável Descrição
aplicativos
SDK_VERSION

aplicativo()

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
nome corda

Retorna:

aplicativo.App

appCheck()

Obtém o serviço AppCheck para o aplicativo padrão ou um determinado aplicativo.

admin.appCheck() pode ser chamado sem argumentos para acessar o serviço AppCheck do aplicativo padrão ou como admin.appCheck(app) para acessar o serviço AppCheck associado a um aplicativo específico.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo Aplicativo opcional para o qual retornar o serviço AppCheck . Se não for fornecido, o serviço AppCheck padrão será retornado.

Retorna:

appCheck.AppCheck

O serviço AppCheck padrão se nenhum aplicativo for fornecido ou o serviço AppCheck associado ao aplicativo 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);

autenticação()

Obtém o serviço Auth para o aplicativo padrão ou um determinado aplicativo.

admin.auth() pode ser chamado sem argumentos para acessar o serviço Auth do aplicativo padrão ou como admin.auth(app) para acessar o serviço Auth associado a um aplicativo específico.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo

Retorna:

autenticação.Auth

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);

base de dados()

Obtém o serviço de banco de dados do aplicativo padrão ou de um determinado aplicativo.

admin.database() pode ser chamado sem argumentos para acessar o serviço Database do aplicativo padrão ou como admin.database(app) para acessar o serviço Database associado a um aplicativo específico.

admin.database também é um namespace que pode ser usado para acessar constantes globais e métodos associados ao serviço Database .

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo

Retorna:

banco de dados.banco de dados

O serviço Database padrão se nenhum aplicativo for fornecido ou o serviço Database associado ao aplicativo 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()

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo

Retorna:

_firestore.Firestore

inicializarApp()

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
opções Opções de aplicativos
nome corda

Retorna:

aplicativo.App

instalações()

Obtém o serviço de instalações do aplicativo padrão ou de um determinado aplicativo.

admin.installations() pode ser chamado sem argumentos para acessar o serviço de instalações do aplicativo padrão ou como admin.installations(app) para acessar o serviço de instalações associado a um aplicativo específico.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo Aplicativo opcional cujo serviço Installations será devolvido. Se não for fornecido, o serviço Installations padrão será retornado.

Retorna:

instalações.Instalações

O serviço Installations padrão se nenhum aplicativo for fornecido ou o serviço Installations associado ao aplicativo 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);

instânciaId()

Obtém o serviço InstanceId para o aplicativo padrão ou um determinado aplicativo.

admin.instanceId() pode ser chamado sem argumentos para acessar o serviço InstanceId do aplicativo padrão ou como admin.instanceId(app) para acessar o serviço InstanceId associado a um aplicativo específico.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo Aplicativo opcional cujo serviço InstanceId será retornado. Se não for fornecido, o serviço InstanceId padrão será retornado.

Retorna:

instânciaId.InstanceId

O serviço InstanceId padrão se nenhum aplicativo for fornecido ou o serviço InstanceId associado ao aplicativo 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);

aprendizado de máquina()

Obtém o serviço MachineLearning para o aplicativo padrão ou um determinado aplicativo.

admin.machineLearning() pode ser chamado sem argumentos para acessar o serviço MachineLearning do aplicativo padrão ou como admin.machineLearning(app) para acessar o serviço MachineLearning associado a um aplicativo específico.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo Aplicativo opcional cujo serviço MachineLearning será retornado. Se não for fornecido, o serviço MachineLearning padrão será retornado.

Retorna:

machineLearning.MachineLearning

O serviço MachineLearning padrão se nenhum aplicativo for fornecido ou o serviço MachineLearning associado ao aplicativo 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()

Obtém o serviço de mensagens do aplicativo padrão ou de um determinado aplicativo.

admin.messaging() pode ser chamado sem argumentos para acessar o serviço Messaging do aplicativo padrão ou como admin.messaging(app) para acessar o serviço Messaging associado a um aplicativo específico.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo Aplicativo opcional cujo serviço Messaging será retornado. Se não for fornecido, o serviço Messaging padrão será retornado.

Retorna:

mensagens. Mensagens

O serviço Messaging padrão se nenhum aplicativo for fornecido ou o serviço Messaging associado ao aplicativo 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);

gerenciamento de projetos()

Obtém o serviço ProjectManagement para o aplicativo padrão ou um determinado aplicativo.

admin.projectManagement() pode ser chamado sem argumentos para acessar o serviço ProjectManagement do aplicativo padrão ou como admin.projectManagement(app) para acessar o serviço ProjectManagement associado a um aplicativo específico.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo Aplicativo opcional cujo serviço ProjectManagement será retornado. Se não for fornecido, o serviço ProjectManagement padrão será retornado. *

Retorna:

projectManagement.ProjectManagement

O serviço ProjectManagement padrão se nenhum aplicativo for fornecido ou o serviço ProjectManagement associado ao aplicativo 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);

configuração remota()

Obtém o serviço RemoteConfig para o aplicativo padrão ou um determinado aplicativo.

admin.remoteConfig() pode ser chamado sem argumentos para acessar o serviço RemoteConfig do aplicativo padrão ou como admin.remoteConfig(app) para acessar o serviço RemoteConfig associado a um aplicativo específico.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo Aplicativo opcional para o qual retornar o serviço RemoteConfig . Se não for fornecido, o serviço RemoteConfig padrão será retornado.

Retorna:

remoteConfig.RemoteConfig

O serviço RemoteConfig padrão se nenhum aplicativo for fornecido ou o serviço RemoteConfig associado ao aplicativo 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);

regras de segurança()

Obtém o serviço SecurityRules para o aplicativo padrão ou um determinado aplicativo.

admin.securityRules() pode ser chamado sem argumentos para acessar o serviço SecurityRules do aplicativo padrão ou como admin.securityRules(app) para acessar o serviço SecurityRules associado a um aplicativo específico.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo Aplicativo opcional para o qual retornar o serviço SecurityRules . Se não for fornecido, o serviço SecurityRules padrão será retornado.

Retorna:

securityRules.SecurityRules

O serviço SecurityRules padrão se nenhum aplicativo for fornecido ou o serviço SecurityRules associado ao aplicativo 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);

armazenar()

Obtém o serviço de armazenamento do aplicativo padrão ou de um determinado aplicativo.

admin.storage() pode ser chamado sem argumentos para acessar o serviço Storage do aplicativo padrão ou como admin.storage(app) para acessar o serviço Storage associado a um aplicativo específico.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo

Retorna:

armazenamento.Armazenamento

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);

aplicativos

Assinatura:

apps: (app.App | null)[]

SDK_VERSION

Assinatura:

SDK_VERSION: string