运行时提供了修改扩展程序实例的运行时数据的方法。
签名:
export declare class Runtime
方法
方法 | 修饰符 | 说明 |
---|---|---|
setFatalError(errorMessage) | 报告运行生命周期事件处理脚本时出现的严重错误。 | |
setProcessingState(state, detailsMessage) | 设置扩展程序实例的处理状态。 |
Runtime.setFatalError()
报告运行生命周期事件处理脚本时出现的严重错误。
当生命周期事件处理脚本因导致实例无法操作而失败时,请调用此方法。如果生命周期事件失败,但实例仍会按预期运行,请使用“PROCESSING_WARNING”调用 setProcessingState
或“PROCESSING_FAILED”状态。
签名:
setFatalError(errorMessage: string): Promise<void>;
参数
参数 | 类型 | 说明 |
---|---|---|
错误消息 | 字符串 | 说明问题所在及解决方法的消息。 |
返回:
承诺<void>
Runtime.setProcessingState()
设置扩展程序实例的处理状态。
使用此方法可报告生命周期事件处理脚本的结果。
如果生命周期事件失败,扩展程序实例无法再正常运行,请改用 Runtime.setFatalError()。
如需报告生命周期事件处理脚本以外的函数调用的状态,请使用 console.log
或 Cloud Functions logger SDK。
签名:
setProcessingState(state: SettableProcessingState, detailMessage: string): Promise<void>;
参数
参数 | 类型 | 说明 |
---|---|---|
州 | SettableProcessingState | 要为实例设置的状态。 |
详细信息消息 | 字符串 | 说明生命周期函数结果的消息。 |
返回:
承诺<void>