ランタイムは、拡張機能インスタンスのランタイム データを変更するメソッドを提供します。
署名:
export declare class Runtime
メソッド
| メソッド | 修飾キー | 説明 |
|---|---|---|
| setFatalError(errorMessage) | ライフサイクル イベント ハンドラの実行中に致命的なエラーが報告されます。 | |
| setProcessingState(state, detailMessage) | 拡張機能インスタンスの処理状態を設定します。 |
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>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| state | SettableProcessingState | インスタンスに設定する状態。 |
| detailMessage | 文字列 | ライフサイクル関数の結果を説明するメッセージ。 |
戻り値:
約束 <void>