Detta dokument har översatts av AI. För eventuella felaktigheter, se den engelska versionen
EventDefinition definierar logiken för händelsehantering i ett arbetsflöde, som används för att svara på specifika händelsetriggers. Händelser är en viktig mekanism i FlowEngine för att trigga arbetsflödesexekvering.
EventDefinition är egentligen ett alias för ActionDefinition och har därför samma egenskaper och metoder.
nameTyp: string
Obligatorisk: Ja
Beskrivning: Den unika identifieraren för händelsen.
Används för att referera till händelsen i ett arbetsflöde via egenskapen on.
Exempel:
titleTyp: string
Obligatorisk: Nej
Beskrivning: Visningsrubriken för händelsen.
Används för visning i användargränssnittet och för felsökning.
Exempel:
handlerTyp: (ctx: TCtx, params: any) => Promise<any> | any
Obligatorisk: Ja
Beskrivning: Händelsens hanteringsfunktion.
Händelsens kärnlogik, som tar emot kontext och parametrar och returnerar bearbetningsresultatet.
Exempel:
defaultParamsTyp: Record<string, any> | ((ctx: TCtx) => Record<string, any> | Promise<Record<string, any>>)
Obligatorisk: Nej
Beskrivning: Händelsens standardparametrar.
Fyller i parametrar med standardvärden när händelsen triggas.
Exempel:
uiSchemaTyp: Record<string, ISchema> | ((ctx: TCtx) => Record<string, ISchema> | Promise<Record<string, ISchema>>)
Obligatorisk: Nej
Beskrivning: Händelsens UI-konfigurationsschema.
Definierar hur händelsen visas i användargränssnittet och dess formulärkonfiguration.
Exempel:
beforeParamsSaveTyp: (ctx: FlowSettingsContext<TModel>, params: any, previousParams: any) => void | Promise<void>
Obligatorisk: Nej
Beskrivning: En hook-funktion som körs innan parametrar sparas.
Utförs innan händelseparametrar sparas och kan användas för parameterverifiering eller -omvandling.
Exempel:
afterParamsSaveTyp: (ctx: FlowSettingsContext<TModel>, params: any, previousParams: any) => void | Promise<void>
Obligatorisk: Nej
Beskrivning: En hook-funktion som körs efter att parametrar har sparats.
Utförs efter att händelseparametrar har sparats och kan användas för att trigga andra åtgärder.
Exempel:
uiModeTyp: StepUIMode | ((ctx: FlowRuntimeContext<TModel>) => StepUIMode | Promise<StepUIMode>)
Obligatorisk: Nej
Beskrivning: Händelsens UI-visningsläge.
Styr hur händelsen visas i användargränssnittet.
Lägen som stöds:
'dialog' - Dialogläge'drawer' - Sidopanelsläge (drawer)'embed' - Inbäddat lägeExempel:
FlowEngine har följande vanliga inbyggda händelsetyper:
'click' - Klickhändelse'submit' - Skicka-händelse'reset' - Återställ-händelse'remove' - Ta bort-händelse'openView' - Öppna vy-händelse'dropdownOpen' - Öppna rullgardinsmeny-händelse'popupScroll' - Scrollhändelse för popup'search' - Sökhändelse'customRequest' - Anpassad förfrågan-händelse'collapseToggle' - Växla kollaps-händelse