ActionDefinition
@prismatic-io/spectral › "types" › ActionDefinition
Configuration of an Action.
#
Hierarchy- ActionDefinition
#
Index#
Properties- allowsBranching
- display
- dynamicBranchInput
- examplePayload
- inputs
- key
- perform
- staticBranchNames
- terminateExecution
#
PropertiesOptional
allowsBranching#
• allowsBranching? : undefined | false | true
Determines whether an Action will allow Conditional Branching.
#
display• display: ActionDisplayDefinition
Defines how the Action is displayed in the Prismatic interface.
Optional
dynamicBranchInput#
• dynamicBranchInput? : undefined | string
The Input associated with Dynamic Branching.
Optional
examplePayload#
• examplePayload? : PerformDataStructureReturn | PerformBranchingDataStructureReturn
An example of the payload outputted by an Action
#
inputs• inputs: InputFieldDefinition[]
InputFields to present in the Prismatic interface for configuration of this Action.
#
key• key: string
Key used for the Actions map and to uniquely identify this Component in your tenant.
#
perform• perform: ActionPerformFunction
Function to perform when this Action is used and invoked.
Optional
staticBranchNames#
• staticBranchNames? : string[]
Static Branch names associated with an Action.
Optional
terminateExecution#
• terminateExecution? : undefined | false | true
Optional attribute that specifies whether an Action will terminate execution.