firebase-admin.extensions package

o serviço de Extensões do Firebase.

Funções

Função Descrição
getExtensions(app) (em inglês) Recebe o serviço Extensions para o app padrão ou 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.

Aulas

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

Aliases de tipos

Tipo de alias Descrição
SettableProcessState (link em inglês) SettableProcessingState representa todos os estados de processamento que podem ser definidos nos dados de 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.

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. Caso não seja fornecido, 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);

SettableProcessState

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

É possível definir os seguintes estados:

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

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

  • PROCESSING_WARNING: o evento de ciclo de vida foi concluído parcialmente ou ocorreu um aviso sobre o qual o usuário precisa ser avisado.

  • 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 da extensão estiver corrompida devido a erros, chame Runtime.setFatalError().

O estado "processamento" é definido automaticamente quando um manipulador de eventos do ciclo de vida é iniciado. Não é possível defini-lo explicitamente. Para relatar 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';