Runtime class

O ambiente de execução fornece métodos para modificar os dados do ambiente de execução de uma instância de extensão.

Assinatura:

export declare class Runtime 

Métodos

Método Modificadores Descrição
setFatalError(errorMessage) (em inglês) Informa um erro fatal ao executar um manipulador de eventos do ciclo de vida.
setProcessingState(state, detailsMessage) Define o estado de processamento de uma instância de extensão.

Runtime.setFatalError()

Informa um erro fatal ao executar um manipulador de eventos do ciclo de vida.

Chame esse método quando um manipulador de eventos do ciclo de vida falhar de forma a tornar a instância inoperável. Se o evento de ciclo de vida falhar, mas a instância ainda funcionar conforme esperado, chame setProcessingState com o comando "PROCESSING_WARNING" ou "PROCESSING_FAILED" estado em vez disso.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
errorMessage string 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 esse método para relatar os resultados de um manipulador de eventos do ciclo de vida.

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

Para informar o status de chamadas de função que não sejam os 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 Tipo Descrição
estado SettableProcessingState (em inglês) O estado para definir a instância.
DetailsMessage string Uma mensagem explicando os resultados da função do ciclo de vida.

Retorna:

Promessa<void>