firebase-admin.extensions package

Serviço de extensões do Firebase.

Funções

Função Descrição
getExtensions(aplicativo) Obtém o serviço de extensões para o aplicativo padrão ou para um determinado aplicativo. getExtensions() pode ser chamado sem argumentos para acessar o serviço Extensions do aplicativo padrão ou como getExtensions(app) para acessar o serviço Extensions associado a um aplicativo específico.

Aulas

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

Aliases de tipo

Digite Alias Descrição
Estado de processamento ajustável SettableProcessingState representa todos os estados de processamento que podem ser definidos nos dados de tempo de execução de uma instância de extensão.

getExtensões()

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

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

Assinatura:

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

Parâmetros

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

Retorna:

Extensões

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

Estado de processamento ajustável

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

Você pode definir os seguintes estados:

  • NONE : Nenhum trabalho relevante de evento de ciclo de vida foi realizado. Defina isto para limpar status antigos.

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

  • PROCESSING_WARNING : o trabalho do evento de ciclo de vida foi parcialmente bem-sucedido ou aconteceu algo sobre o qual o usuário deveria 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 quebrada devido a erros, chame Runtime.setFatalError() .

O estado de "processamento" é definido automaticamente quando um manipulador de eventos de ciclo de vida é iniciado; você não pode defini-lo explicitamente. Para relatar o status contínuo da função de uma extensão, use console.log ou o SDK do agente de log do Cloud Functions.

Assinatura:

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