Skip to main content

Action

@prismatic-io/spectral"types/server-types"Action

Configuration of an Action.

Hierarchy#

  • Action

Index#

Properties#

Properties#

Optional allowsBranching#

allowsBranching? : undefined | false | true

Defined in types/server-types.ts:52

Determines whether an Action will allow Conditional Branching.


display#

display: ActionDisplayDefinition

Defined in types/server-types.ts:44

Defines how the Action is displayed in the Prismatic interface.


Optional dynamicBranchInput#

dynamicBranchInput? : undefined | string

Defined in types/server-types.ts:56

The Input associated with Dynamic Branching.


Optional examplePayload#

examplePayload? : ServerPerformDataStructureReturn | ServerPerformBranchingDataStructureReturn

Defined in types/server-types.ts:58

An example of the payload outputted by an Action


inputs#

inputs: InputField[]

Defined in types/server-types.ts:48

InputFields to present in the Prismatic interface for configuration of this Action.


key#

key: string

Defined in types/server-types.ts:42

Key used for the Actions map and to uniquely identify this Component in your tenant.


perform#

perform: ActionPerformFunction

Defined in types/server-types.ts:46

Function to perform when this Action is used and invoked.


Optional staticBranchNames#

staticBranchNames? : string[]

Defined in types/server-types.ts:54

Static Branch names associated with an Action.


Optional terminateExecution#

terminateExecution? : undefined | false | true

Defined in types/server-types.ts:50

Optional attribute that specifies whether an Action will terminate execution.