Runtime class

Runtime fornece métodos para modificar os dados de tempo de execução de uma instância de extensão.

Assinatura:

export declare class Runtime 

Métodos

Método Modificadores Descrição
setFatalError(mensagem de erro) Relata um erro fatal ao executar um manipulador de eventos de ciclo de vida.
setProcessingState(estado, detalheMensagem) Define o estado de processamento de uma instância de extensão.

Runtime.setFatalError()

Relata um erro fatal ao executar um manipulador de eventos de ciclo de vida.

Chame esse método quando um manipulador de eventos de ciclo de vida falhar de uma maneira que torne a instância inoperável. Se o evento de ciclo de vida falhou, mas a instância ainda funcionará conforme o esperado, chame setProcessingState com o estado "PROCESSING_WARNING" ou "PROCESSING_FAILED".

Assinatura:

setFatalError(errorMessage: string): Promise<void>;

Parâmetros

Parâmetro Modelo Descrição
mensagem de erro corda Uma mensagem explicando o que deu errado e como corrigi-lo.

Retorna:

Promessa<void>

Runtime.setProcessingState()

Define o estado de processamento de uma instância de extensão.

Use este método para relatar os resultados de um manipulador de eventos de ciclo de vida.

Se o evento de ciclo de vida falhou e a instância de extensão não funcionará mais corretamente, use Runtime.setFatalError() em vez disso.

Para relatar o status de chamadas de função que não sejam manipuladores de eventos de ciclo de vida, use console.log ou o SDK do logger do Cloud Functions.

Assinatura:

setProcessingState(state: SettableProcessingState, detailMessage: string): Promise<void>;

Parâmetros

Parâmetro Modelo Descrição
Estado SettableProcessingState O estado para o qual definir a instância.
detalheMensagem corda Uma mensagem explicando os resultados da função de ciclo de vida.

Retorna:

Promessa<void>