Runtime class

執行階段提供了修改擴充功能執行個體執行階段資料的方法。

簽名:

export declare class Runtime 

方法

方法 修飾符 說明
setFatalError(errorMessage) 回報執行生命週期事件處理常式時出現的嚴重錯誤。
setProcessingState(state, detailsMessage) 設定擴充功能執行個體的處理狀態。

Runtime.setFatalError()

回報執行生命週期事件處理常式時出現的嚴重錯誤。

當生命週期事件處理常式因該執行個體無法運作而失敗時,請呼叫這個方法。如果生命週期事件失敗,但執行個體仍會正常運作,請以「PROCESSING_WARNING」呼叫 setProcessingState或「PROCESSING_FAILED」狀態。

簽名:

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

參數

參數 類型 說明
errorMessage 字串 說明問題原因及修正方式的訊息。

傳回:

承諾<void>

Runtime.setProcessingState()

設定擴充功能執行個體的處理狀態。

使用這個方法可回報生命週期事件處理常式的結果。

如果生命週期事件失敗,且擴充功能執行個體將無法再正常運作,請改用 Runtime.setFatalError()

如要回報生命週期事件處理常式以外的函式呼叫狀態,請使用 console.log 或 Cloud Functions 記錄器 SDK。

簽名:

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

參數

參數 類型 說明
SettableProcessingState 要設定執行個體的狀態。
詳細資料訊息 字串 說明生命週期函式結果的訊息。

傳回:

承諾<void>