Dit document is vertaald door AI. Voor onnauwkeurigheden, raadpleeg de Engelse versie
Een EventDefinition definieert de logica voor gebeurtenisafhandeling binnen een workflow. Het wordt gebruikt om te reageren op specifieke gebeurtenistriggers. Gebeurtenissen zijn een belangrijk mechanisme in de FlowEngine voor het activeren van de uitvoering van workflows.
Een EventDefinition is eigenlijk een alias voor een ActionDefinition en heeft daarom dezelfde eigenschappen en methoden.
Type: string
Verplicht: Ja
Beschrijving: De unieke identificatie voor de gebeurtenis.
Gebruikt om de gebeurtenis in een workflow te verwijzen via de on-eigenschap.
Voorbeeld:
Type: string
Verplicht: Nee
Beschrijving: De weergavetitel voor de gebeurtenis.
Gebruikt voor weergave in de gebruikersinterface en voor debugging.
Voorbeeld:
Type: (ctx: TCtx, params: any) => Promise<any> | any
Verplicht: Ja
Beschrijving: De handler-functie voor de gebeurtenis.
Dit is de kernlogica van de gebeurtenis, die de context en parameters ontvangt en het verwerkingsresultaat retourneert.
Voorbeeld:
Type: Record<string, any> | ((ctx: TCtx) => Record<string, any> | Promise<Record<string, any>>)
Verplicht: Nee
Beschrijving: De standaardparameters voor de gebeurtenis.
Vult parameters met standaardwaarden wanneer de gebeurtenis wordt geactiveerd.
Voorbeeld:
Type: Record<string, ISchema> | ((ctx: TCtx) => Record<string, ISchema> | Promise<Record<string, ISchema>>)
Verplicht: Nee
Beschrijving: Het UI-configuratieschema voor de gebeurtenis.
Definieert de weergavemethode en formulierconfiguratie voor de gebeurtenis in de gebruikersinterface.
Voorbeeld:
Type: (ctx: FlowSettingsContext<TModel>, params: any, previousParams: any) => void | Promise<void>
Verplicht: Nee
Beschrijving: Hook-functie die wordt uitgevoerd voordat parameters worden opgeslagen.
Deze functie wordt uitgevoerd voordat gebeurtenisparameters worden opgeslagen en kan worden gebruikt voor parametervalidatie of -transformatie.
Voorbeeld:
Type: (ctx: FlowSettingsContext<TModel>, params: any, previousParams: any) => void | Promise<void>
Verplicht: Nee
Beschrijving: Hook-functie die wordt uitgevoerd nadat parameters zijn opgeslagen.
Deze functie wordt uitgevoerd nadat gebeurtenisparameters zijn opgeslagen en kan worden gebruikt om andere acties te activeren.
Voorbeeld:
Type: StepUIMode | ((ctx: FlowRuntimeContext<TModel>) => StepUIMode | Promise<StepUIMode>)
Verplicht: Nee
Beschrijving: De UI-weergavemodus voor de gebeurtenis.
Bepaalt hoe de gebeurtenis wordt weergegeven in de gebruikersinterface.
Ondersteunde modi:
'dialog' - Dialoogvenstermodus'drawer' - Lade-modus'embed' - Ingesloten modusVoorbeeld:
De FlowEngine heeft de volgende veelvoorkomende gebeurtenistypen ingebouwd:
'click' - Klikgebeurtenis'submit' - Indienen-gebeurtenis'reset' - Reset-gebeurtenis'remove' - Verwijder-gebeurtenis'openView' - Open-weergave-gebeurtenis'dropdownOpen' - Dropdown-open-gebeurtenis'popupScroll' - Pop-up-scroll-gebeurtenis'search' - Zoek-gebeurtenis'customRequest' - Aangepaste-aanvraag-gebeurtenis'collapseToggle' - Inklap-toggle-gebeurtenis