Tento dokument byl přeložen umělou inteligencí. V případě nepřesností se prosím obraťte na anglickou verzi
EventDefinition definuje logiku zpracování událostí v rámci pracovního postupu, která slouží k reakci na konkrétní spouštěče událostí. Události jsou v FlowEngine důležitým mechanismem pro spouštění provedení pracovních postupů.
EventDefinition je ve skutečnosti alias pro ActionDefinition, a proto má stejné vlastnosti a metody.
Typ: string
Povinné: Ano
Popis: Jedinečný identifikátor události.
Používá se k odkazování na událost v pracovním postupu prostřednictvím vlastnosti on.
Příklad:
Typ: string
Povinné: Ne
Popis: Zobrazovaný název události.
Používá se pro zobrazení v uživatelském rozhraní a pro ladění.
Příklad:
Typ: (ctx: TCtx, params: any) => Promise<any> | any
Povinné: Ano
Popis: Obslužná funkce události.
Hlavní logika události, která přijímá kontext a parametry a vrací výsledek zpracování.
Příklad:
Typ: Record<string, any> | ((ctx: TCtx) => Record<string, any> | Promise<Record<string, any>>)
Povinné: Ne
Popis: Výchozí parametry události.
Při spuštění události se parametry vyplní výchozími hodnotami.
Příklad:
Typ: Record<string, ISchema> | ((ctx: TCtx) => Record<string, ISchema> | Promise<Record<string, ISchema>>)
Povinné: Ne
Popis: Schéma konfigurace uživatelského rozhraní (UI) pro událost.
Definuje způsob zobrazení a konfiguraci formuláře pro událost v uživatelském rozhraní.
Příklad:
Typ: (ctx: FlowSettingsContext<TModel>, params: any, previousParams: any) => void | Promise<void>
Povinné: Ne
Popis: Funkce háčku spuštěná před uložením parametrů.
Spustí se před uložením parametrů události a lze ji použít pro validaci nebo transformaci parametrů.
Příklad:
Typ: (ctx: FlowSettingsContext<TModel>, params: any, previousParams: any) => void | Promise<void>
Povinné: Ne
Popis: Funkce háčku spuštěná po uložení parametrů.
Spustí se po uložení parametrů události a lze ji použít k vyvolání dalších akcí.
Příklad:
Typ: StepUIMode | ((ctx: FlowRuntimeContext<TModel>) => StepUIMode | Promise<StepUIMode>)
Povinné: Ne
Popis: Režim zobrazení uživatelského rozhraní (UI) pro událost.
Řídí, jak se událost zobrazuje v uživatelském rozhraní.
Podporované režimy:
'dialog' – Režim dialogu'drawer' – Režim vysouvacího panelu'embed' – Režim vloženíPříklad:
FlowEngine má vestavěné následující běžné typy událostí:
'click' – Událost kliknutí'submit' – Událost odeslání'reset' – Událost resetování'remove' – Událost odstranění'openView' – Událost otevření zobrazení'dropdownOpen' – Událost otevření rozbalovacího seznamu'popupScroll' – Událost posouvání vyskakovacího okna'search' – Událost vyhledávání'customRequest' – Událost vlastního požadavku'collapseToggle' – Událost přepnutí sbalení