ランタイムは、拡張機能インスタンスのランタイム データを変更するメソッドを提供します。
サイン:
export declare class Runtime
メソッド
方法 | 修飾子 | 説明 |
---|---|---|
setFatalError(errorMessage) | ライフサイクル イベント ハンドラーの実行中に致命的なエラーを報告します。 | |
setProcessingState(状態, 詳細メッセージ) | 拡張機能インスタンスの処理状態を設定します。 |
Runtime.setFatalError()
ライフサイクル イベント ハンドラーの実行中に致命的なエラーを報告します。
ライフサイクル イベント ハンドラーが失敗してインスタンスが動作不能になった場合に、このメソッドを呼び出します。ライフサイクル イベントが失敗してもインスタンスが期待どおりに動作する場合は、代わりに「PROCESSING_WARNING」または「PROCESSING_FAILED」状態を指定してsetProcessingState
を呼び出します。
サイン:
setFatalError(errorMessage: string): Promise<void>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
エラーメッセージ | 弦 | 問題の内容とその修正方法を説明するメッセージ。 |
戻り値:
約束<無効>
Runtime.setProcessingState()
拡張機能インスタンスの処理状態を設定します。
このメソッドを使用して、ライフサイクル イベント ハンドラーの結果を報告します。
ライフサイクル イベントが失敗し、拡張機能インスタンスが正しく動作しなくなる場合は、代わりにRuntime.setFatalError()を使用してください。
ライフサイクル イベント ハンドラー以外の関数呼び出しのステータスをレポートするには、 console.log
または Cloud Functions ロガー SDK を使用します。
サイン:
setProcessingState(state: SettableProcessingState, detailMessage: string): Promise<void>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
州 | 設定可能な処理状態 | インスタンスを設定する状態。 |
詳細メッセージ | 弦 | ライフサイクル関数の結果を説明するメッセージ。 |
戻り値:
約束<無効>