このドキュメントはAIによって翻訳されました。不正確な情報については、英語版をご参照ください
EventDefinition は、特定のイベントトリガーに応答するために、フロー内のイベント処理ロジックを定義します。イベントは、フローの実行をトリガーする上で、フローエンジンにとって重要なメカニズムです。
EventDefinition は、実際には ActionDefinition のエイリアスであるため、同じプロパティとメソッドを持ちます。
型: string
必須: はい
説明: イベントの一意な識別子です。
フロー内で on プロパティを使ってイベントを参照する際に使用します。
例:
型: string
必須: いいえ
説明: イベントの表示タイトルです。
UI 表示やデバッグに使用されます。
例:
型: (ctx: TCtx, params: any) => Promise<any> | any
必須: はい
説明: イベントのハンドラー関数です。
イベントのコアロジックであり、コンテキストとパラメーターを受け取り、処理結果を返します。
例:
型: Record<string, any> | ((ctx: TCtx) => Record<string, any> | Promise<Record<string, any>>)
必須: いいえ
説明: イベントのデフォルトパラメーターです。
イベントがトリガーされた際に、パラメーターにデフォルト値を設定します。
例:
型: Record<string, ISchema> | ((ctx: TCtx) => Record<string, ISchema> | Promise<Record<string, ISchema>>)
必須: いいえ
説明: イベントの UI 設定スキーマです。
UI におけるイベントの表示方法やフォーム設定を定義します。
例:
型: (ctx: FlowSettingsContext<TModel>, params: any, previousParams: any) => void | Promise<void>
必須: いいえ
説明: パラメーター保存前のフック関数です。
イベントパラメーターが保存される前に実行され、パラメーターの検証や変換に使用できます。
例:
型: (ctx: FlowSettingsContext<TModel>, params: any, previousParams: any) => void | Promise<void>
必須: いいえ
説明: パラメーター保存後のフック関数です。
イベントパラメーターが保存された後に実行され、他の操作をトリガーするために使用できます。
例:
型: StepUIMode | ((ctx: FlowRuntimeContext<TModel>) => StepUIMode | Promise<StepUIMode>)
必須: いいえ
説明: イベントの UI 表示モードです。
UI におけるイベントの表示方法を制御します。
サポートされているモード:
'dialog' - ダイアログモード'drawer' - ドロワーモード'embed' - 埋め込みモード例:
フローエンジンには、以下の一般的なイベントタイプが組み込まれています。
'click' - クリックイベント'submit' - 送信イベント'reset' - リセットイベント'remove' - 削除イベント'openView' - ビューを開くイベント'dropdownOpen' - ドロップダウンオープンイベント'popupScroll' - ポップアップスクロールイベント'search' - 検索イベント'customRequest' - カスタムリクエストイベント'collapseToggle' - 折りたたみ切り替えイベント