These v19 docs are archived 🔒.
Go to the
latest docs home
or try if
this exact page is available
in the latest docs.
Class WorkflowStepCodeArguments
Arguments for WorkflowStepCode. Will be passed to your code and should also be returned by your code. This also allows cancelling further execution.
Package: Api.Js.SxcJs
Properties
cancel
If the workflow should be cancelled. Can be set by any workflow step. If set to true, following steps / workflows will not run.
Declaration
cancel: boolean
Property Value
Type | Description |
---|---|
boolean |
command
Name this workflow is running for
Declaration
command: string
Property Value
Type | Description |
---|---|
string |
context
Context of the current command / step being run
Declaration
context: ContextComplete
Property Value
Type | Description |
---|---|
ContextComplete |
phase
The phase it's in (before, after, etc.)
Declaration
phase: WorkflowPhases
Property Value
Type | Description |
---|---|
WorkflowPhases |
result
Result in after-phases of the workflow BETA - never really tested this
Declaration
result: unknown
Property Value
Type | Description |
---|---|
unknown |