workflow-core/com.squareup.workflow1/StatelessWorkflow/RenderContext

RenderContext

inner class RenderContext : BaseRenderContext<PropsT, Nothing, OutputT> (source)

Properties

open override val actionSink: Sink<WorkflowAction<@UnsafeVariance PropsT, Nothing, @UnsafeVariance OutputT>>

Accepts a single WorkflowAction, invokes that action by calling WorkflowAction.apply to update the current state, and optionally emits the returned output value if it is non-null.

Functions

eventHandler

open override fun <E1, E2, E3, E4, E5, E6, E7, E8, E9> eventHandler(name: () -> String, update: WorkflowAction.Updater<@UnsafeVariance PropsT, Nothing, @UnsafeVariance OutputT>.(E1, E2, E3, E4, E5, E6, E7, E8, E9) -> Unit): (E1, E2, E3, E4, E5, E6, E7, E8, E9) -> Unit

open override fun <E1, E2, E3, E4, E5, E6, E7, E8, E9, E10> eventHandler(name: () -> String, update: WorkflowAction.Updater<@UnsafeVariance PropsT, Nothing, @UnsafeVariance OutputT>.(E1, E2, E3, E4, E5, E6, E7, E8, E9, E10) -> Unit): (E1, E2, E3, E4, E5, E6, E7, E8, E9, E10) -> Unit

open override fun <EventT> eventHandler(name: () -> String, update: WorkflowAction.Updater<@UnsafeVariance PropsT, Nothing, @UnsafeVariance OutputT>.(EventT) -> Unit): (EventT) -> Unit

open override fun <E1, E2> eventHandler(name: () -> String, update: WorkflowAction.Updater<@UnsafeVariance PropsT, Nothing, @UnsafeVariance OutputT>.(E1, E2) -> Unit): (E1, E2) -> Unit

open override fun <E1, E2, E3> eventHandler(name: () -> String, update: WorkflowAction.Updater<@UnsafeVariance PropsT, Nothing, @UnsafeVariance OutputT>.(E1, E2, E3) -> Unit): (E1, E2, E3) -> Unit

open override fun <E1, E2, E3, E4> eventHandler(name: () -> String, update: WorkflowAction.Updater<@UnsafeVariance PropsT, Nothing, @UnsafeVariance OutputT>.(E1, E2, E3, E4) -> Unit): (E1, E2, E3, E4) -> Unit

open override fun <E1, E2, E3, E4, E5> eventHandler(name: () -> String, update: WorkflowAction.Updater<@UnsafeVariance PropsT, Nothing, @UnsafeVariance OutputT>.(E1, E2, E3, E4, E5) -> Unit): (E1, E2, E3, E4, E5) -> Unit

open override fun <E1, E2, E3, E4, E5, E6> eventHandler(name: () -> String, update: WorkflowAction.Updater<@UnsafeVariance PropsT, Nothing, @UnsafeVariance OutputT>.(E1, E2, E3, E4, E5, E6) -> Unit): (E1, E2, E3, E4, E5, E6) -> Unit

open override fun <E1, E2, E3, E4, E5, E6, E7> eventHandler(name: () -> String, update: WorkflowAction.Updater<@UnsafeVariance PropsT, Nothing, @UnsafeVariance OutputT>.(E1, E2, E3, E4, E5, E6, E7) -> Unit): (E1, E2, E3, E4, E5, E6, E7) -> Unit

open override fun <E1, E2, E3, E4, E5, E6, E7, E8> eventHandler(name: () -> String, update: WorkflowAction.Updater<@UnsafeVariance PropsT, Nothing, @UnsafeVariance OutputT>.(E1, E2, E3, E4, E5, E6, E7, E8) -> Unit): (E1, E2, E3, E4, E5, E6, E7, E8) -> Unit

open override fun eventHandler(name: () -> String, update: WorkflowAction.Updater<@UnsafeVariance PropsT, Nothing, @UnsafeVariance OutputT>.() -> Unit): () -> Unit

Creates a function which builds a WorkflowAction from the given update function, and immediately passes it to actionSink. Handy for attaching event handlers to renderings.

renderChild

open override fun <ChildPropsT, ChildOutputT, ChildRenderingT> renderChild(child: Workflow<ChildPropsT, ChildOutputT, ChildRenderingT>, props: ChildPropsT, key: String, handler: (ChildOutputT) -> WorkflowAction<@UnsafeVariance PropsT, Nothing, @UnsafeVariance OutputT>): ChildRenderingT

Ensures child is running as a child of this workflow, and returns the result of its render method.

renderChild

fun <PropsT, StateT, OutputT, ChildRenderingT> BaseRenderContext<PropsT, StateT, OutputT>.renderChild(child: Workflow<Unit, Nothing, ChildRenderingT>, key: String = ""): ChildRenderingT

Convenience alias of BaseRenderContext.renderChild for children that don't take props or emit output.

fun <PropsT, ChildPropsT, StateT, OutputT, ChildRenderingT> BaseRenderContext<PropsT, StateT, OutputT>.renderChild(child: Workflow<ChildPropsT, Nothing, ChildRenderingT>, props: ChildPropsT, key: String = ""): ChildRenderingT

Convenience alias of BaseRenderContext.renderChild for workflows that don't emit output.

fun <PropsT, StateT, OutputT, ChildOutputT, ChildRenderingT> BaseRenderContext<PropsT, StateT, OutputT>.renderChild(child: Workflow<Unit, ChildOutputT, ChildRenderingT>, key: String = "", handler: (ChildOutputT) -> WorkflowAction<PropsT, StateT, OutputT>): ChildRenderingT

Convenience alias of BaseRenderContext.renderChild for workflows that don't take props.

runningSideEffect

open override fun runningSideEffect(key: String, sideEffect: suspend CoroutineScope.() -> Unit)

Ensures sideEffect is running with the given key.

runningWorker

inline fun <W : LifecycleWorker, PropsT, StateT, OutputT> BaseRenderContext<PropsT, StateT, OutputT>.runningWorker(worker: W, key: String = "")

Ensures a LifecycleWorker is running. Since worker can't emit anything, it can't trigger any WorkflowActions.

inline fun <T, W : Worker<T>, PropsT, StateT, OutputT> BaseRenderContext<PropsT, StateT, OutputT>.runningWorker(worker: W, key: String = "", noinline handler: (T) -> WorkflowAction<PropsT, StateT, OutputT>)

Ensures worker is running. When the Worker emits an output, handler is called to determine the WorkflowAction to take. When the worker finishes, nothing happens (although another render pass may be triggered).