Aplicativo Firebase
Este pacote coordena a comunicação entre os diferentes componentes do Firebase
Funções
Função | Descrição |
---|---|
função (aplicativo, ...) | |
excluirAplicativo(aplicativo) | Torna este aplicativo inutilizável e libera os recursos de todos os serviços associados. |
função() | |
getApps() | Uma matriz (somente leitura) de todos os aplicativos inicializados. |
inicializarApp() | Cria e inicializa uma instância do FirebaseApp. |
função(bibliotecaKeyOrName, ...) | |
RegisterVersion(libraryKeyOrName, versão, variante) | Registra o nome e a versão de uma biblioteca para fins de log da plataforma. |
função(logCallback, ...) | |
onLog(logCallback, opções) | Define o gerenciador de registros para todos os SDKs do Firebase. |
função(nívellog, ...) | |
setLogLevel(logLevel) | Define o nível de registro para todos os SDKs do Firebase. Todos os tipos de log acima do nível de log atual são capturados (ou seja, se você definir o nível de log como info , os erros serão registrados, mas os logs debug e verbose não). |
função(nome, ...) | |
getApp(nome) | Recupera uma instância do FirebaseApp . Quando chamado sem argumentos, o aplicativo padrão é retornado. Quando um nome de aplicativo é fornecido, o aplicativo correspondente a esse nome é retornado. Uma exceção será lançada se o aplicativo que está sendo recuperado ainda não tiver sido inicializado. |
função(opções, ...) | |
inicializarApp(opções, nome) | Cria e inicializa uma instância do FirebaseApp . Consulte Adicionar o Firebase ao seu aplicativo e inicializar vários projetos para obter documentação detalhada. |
inicializarApp(opções, configuração) | Cria e inicializa uma instância do FirebaseApp. |
Interfaces
Interface | Descrição |
---|---|
Aplicativo Firebase | Um FirebaseApp contém as informações de inicialização de uma coleção de serviços. Não chame esse construtor diretamente. Em vez disso, use inicializeApp() para criar um aplicativo. |
Configurações do FirebaseApp | Opções de configuração fornecidas para inicializarApp() |
Opções do Firebase | Objeto de configuração do Firebase. Contém um conjunto de parâmetros exigidos pelos serviços para se comunicarem com êxito com as APIs do servidor Firebase e para associar dados do cliente ao seu projeto e aplicativo do Firebase. Normalmente, esse objeto é preenchido pelo console do Firebase na configuração do projeto. Veja também: Saiba mais sobre o objeto de configuração do Firebase . |
Variáveis
Variável | Descrição |
---|---|
SDK_VERSION | A versão atual do SDK. |
função (aplicativo, ...)
excluirAplicativo(aplicativo)
Torna este aplicativo inutilizável e libera os recursos de todos os serviços associados.
Assinatura:
export declare function deleteApp(app: FirebaseApp): Promise<void>;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
aplicativo | Aplicativo Firebase |
Retorna:
Promessa<void>
Exemplo
deleteApp(app)
.then(function() {
console.log("App deleted successfully");
})
.catch(function(error) {
console.log("Error deleting app:", error);
});
função()
getApps()
Uma matriz (somente leitura) de todos os aplicativos inicializados.
Assinatura:
export declare function getApps(): FirebaseApp[];
Retorna:
inicializarApp()
Cria e inicializa uma instância do FirebaseApp.
Assinatura:
export declare function initializeApp(): FirebaseApp;
Retorna:
função(bibliotecaKeyOrName, ...)
RegisterVersion(libraryKeyOrName, versão, variante)
Registra o nome e a versão de uma biblioteca para fins de log da plataforma.
Assinatura:
export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
bibliotecaKeyOrName | corda | |
versão | corda | Versão atual dessa biblioteca. |
variante | corda | Variante do pacote, por exemplo, node, rn, etc. |
Retorna:
vazio
função(logCallback, ...)
onLog(logCallback, opções)
Define o gerenciador de registros para todos os SDKs do Firebase.
Assinatura:
export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
logCallback | LogCallback | nulo | Um gerenciador de registros personalizado opcional que executa o código do usuário sempre que o SDK do Firebase faz uma chamada de registro. |
opções | Opções de registro |
Retorna:
vazio
função(nívellog, ...)
setLogLevel(logLevel)
Define o nível de registro para todos os SDKs do Firebase.
Todos os tipos de log acima do nível de log atual são capturados (ou seja, se você definir o nível de log como info
, os erros são registrados, mas os logs debug
e verbose
não).
Assinatura:
export declare function setLogLevel(logLevel: LogLevelString): void;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
nível de registro | LogLevelString |
Retorna:
vazio
função(nome, ...)
getApp(nome)
Recupera uma instância do FirebaseApp .
Quando chamado sem argumentos, o aplicativo padrão é retornado. Quando um nome de aplicativo é fornecido, o aplicativo correspondente a esse nome é retornado.
Uma exceção será lançada se o aplicativo que está sendo recuperado ainda não tiver sido inicializado.
Assinatura:
export declare function getApp(name?: string): FirebaseApp;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
nome | corda | Nome opcional do aplicativo a ser retornado. Se nenhum nome for fornecido, o padrão será "[DEFAULT]" . |
Retorna:
O aplicativo correspondente ao nome do aplicativo fornecido. Se nenhum nome de aplicativo for fornecido, o aplicativo padrão será retornado.
Exemplo 1
// Return the default app
const app = getApp();
Exemplo 2
// Return a named app
const otherApp = getApp("otherApp");
função(opções, ...)
inicializarApp(opções, nome)
Cria e inicializa uma instância do FirebaseApp .
Consulte Adicionar o Firebase ao seu aplicativo e inicializar vários projetos para obter documentação detalhada.
Assinatura:
export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
opções | Opções do Firebase | Opções para configurar os serviços do aplicativo. |
nome | corda | Nome opcional do aplicativo a ser inicializado. Se nenhum nome for fornecido, o padrão será "[DEFAULT]" . |
Retorna:
O aplicativo inicializado.
Exemplo 1
// Initialize default app
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeApp({
apiKey: "AIza....", // Auth / General Use
authDomain: "YOUR_APP.firebaseapp.com", // Auth with popup/redirect
databaseURL: "https://YOUR_APP.firebaseio.com", // Realtime Database
storageBucket: "YOUR_APP.appspot.com", // Storage
messagingSenderId: "123456789" // Cloud Messaging
});
Exemplo 2
// Initialize another app
const otherApp = initializeApp({
databaseURL: "https://<OTHER_DATABASE_NAME>.firebaseio.com",
storageBucket: "<OTHER_STORAGE_BUCKET>.appspot.com"
}, "otherApp");
inicializarApp(opções, configuração)
Cria e inicializa uma instância do FirebaseApp.
Assinatura:
export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
Parâmetros
Parâmetro | Tipo | Descrição |
---|---|---|
opções | Opções do Firebase | Opções para configurar os serviços do aplicativo. |
configuração | Configurações do FirebaseApp | Configuração do FirebaseApp |
Retorna:
SDK_VERSION
A versão atual do SDK.
Assinatura:
SDK_VERSION: string