firebase-admin.extensions package

serviço Extensões do Firebase.

Funções

Função	Descrição
getExtensions(app) (link em inglês)	Recebe o serviço Extensões para o app padrão ou para um determinado app.getExtensions() pode ser chamado sem argumentos para acessar o serviço Extensions do app padrão ou como getExtensions(app) para acessar o serviço Extensions associado a um app específico.

Classes

Turma	Descrição
Extensões	A interface de serviço Extensions do Firebase.
Ambiente de execução	O ambiente de execução fornece métodos para modificar os dados do ambiente de execução de uma instância de extensão.

Aliases de tipos

Alias de tipo	Descrição
SettableProcessingState (em inglês)	SettableProcessingState representa todos os estados de processamento que podem ser definidos nos dados do ambiente de execução de uma instância de extensão.

getExtensions(app)

Recebe o serviço Extensions para o app padrão ou um determinado app.

O getExtensions() pode ser chamado sem argumentos para acessar o serviço Extensions do app padrão ou como getExtensions(app) para acessar o serviço Extensions associado a um app específico.

Assinatura:

export declare function getExtensions(app?: App): Extensions;

Parâmetros

Parâmetro	Tipo	Descrição
app	App	App opcional para retornar o serviço Extensions. Se não for informado, o serviço Extensions padrão será retornado.

Retorna:

Extensões

O serviço Extensions padrão, se nenhum app for fornecido, ou o serviço Extensions associado ao app fornecido.

Exemplo 1

// Get the `Extensions` service for the default app
const defaultExtensions = getExtensions();

Exemplo 2

// Get the `Extensions` service for a given app
const otherExtensions = getExtensions(otherApp);

SettableProcessingState

SettableProcessingState representa todos os estados de processamento que podem ser definidos nos dados do ambiente de execução de uma instância de extensão.

É possível definir os seguintes estados:

• NONE: nenhum trabalho relevante no evento de ciclo de vida foi feito. Defina essa opção para limpar os status antigos.

• PROCESSING_COMPLETE: trabalho do evento de ciclo de vida concluído sem erros.

• PROCESSING_WARNING: o trabalho do evento de ciclo de vida foi bem-sucedido parcialmente ou algo aconteceu e o usuário precisa ser alertado.

• PROCESSING_FAILED: o trabalho do evento de ciclo de vida falhou completamente, mas a instância ainda funcionará corretamente daqui para frente.

Se a instância de extensão estiver em um estado corrompido devido a erros, chame Runtime.setFatalError().

A etapa é definido automaticamente quando um manipulador de eventos de ciclo de vida é iniciado. não é possível defini-la explicitamente. Para informar o status contínuo da função de uma extensão, use console.log ou o SDK do logger do Cloud Functions.

Assinatura:

export type SettableProcessingState = 'NONE' | 'PROCESSING_COMPLETE' | 'PROCESSING_WARNING' | 'PROCESSING_FAILED';