Skip to content

//workflow/com.squareup.workflow1/WorkflowAction

WorkflowAction

[jvm] abstract class WorkflowActionPropsT, StateT, out OutputT>

An atomic operation that updates the state of a Workflow, and also optionally emits an output.

Constructors

WorkflowAction [jvm] fun WorkflowAction()

Types

Name Summary
Companion [jvm]
Content
object Companion


Updater [jvm]
Content
inner class Updater(props: @UnsafeVariance()PropsT, state: StateT)
More info
The context for calls to WorkflowAction.apply.


Functions

Name Summary
apply [jvm]
Content
abstract fun WorkflowAction.Updater<PropsT, StateT, OutputT>.apply()
More info
Executes the logic for this action, including any side effects, updating state, and setting the OutputT to emit.


Extensions

Name Summary
applyTo [jvm]
Content
fun <PropsT, StateT, OutputT> WorkflowAction<PropsT, StateT, OutputT>.applyTo(props: PropsT, state: StateT): Pair<StateT, WorkflowOutput<OutputT>?>
More info
Applies this WorkflowAction to state.