CustomFunctions.CancelableInvocation interface

パッケージ:

custom-functions-runtime

取り消し可能なカスタム関数の呼び出しに関する情報を提供します。 取り消し可能なカスタム関数は、onCanceled イベントのハンドラーを提供できます。

関数が取り消し可能であることを示すには、メタデータ JSON ファイルで関数オプションで次を指定する必要があります。 { "cancelable": true }

JSDoc コメントからメタデータ JSON ファイルが生成されている場合は、タグ @cancelableを含めます。

Extends

CustomFunctions.Invocation

イベント

onCanceled

カスタム関数が取り消されたときに呼び出されるイベント ハンドラー。

イベントの詳細

onCanceled

カスタム関数が取り消されたときに呼び出されるイベント ハンドラー。

onCanceled?: () => void;

イベントの種類

() => void

注釈

[ API セット: CustomFunctionsRuntime 1.1 ]