diff --git a/kotlin/api/htmlMultiModule/navigation.html b/kotlin/api/htmlMultiModule/navigation.html index a43cec461..af51da572 100644 --- a/kotlin/api/htmlMultiModule/navigation.html +++ b/kotlin/api/htmlMultiModule/navigation.html @@ -777,29 +777,29 @@
com.squareup.workflow1.ui.compose
-
+
- asMutableState() + asComposableFactory()
-
+ -
+ -
+ - -
+ + + + + + + -
+
WorkflowRendering()
@@ -832,7 +867,7 @@
com.squareup.workflow1.ui.compose.tooling
-
+
Preview()
@@ -887,97 +922,102 @@ renderWorkflowIn()
-
+ + -
+ -
+
- ScreenViewFactory + ScreenViewFactory
- -
+
- ScreenViewFactoryFinder + ScreenViewFactoryFinder
- -
+
- ScreenViewHolder + ScreenViewHolder
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
WorkflowViewStub
@@ -1197,92 +1237,102 @@ EnvironmentScreen
-
+ -
+
+
+ getFactoryFor() +
+
+ -
+ -
+ -
+ -
+ -
+ -
+
- ViewEnvironment + ViewEnvironment
- -
+ -
+
- ViewRegistry + ViewRegistry
-
+ -
+ +
+
+ Key +
+
-
+ -
+ -
+ -
+ -
+
Wrapper
diff --git a/kotlin/api/htmlMultiModule/scripts/pages.json b/kotlin/api/htmlMultiModule/scripts/pages.json index 23957aa6d..9f989708b 100644 --- a/kotlin/api/htmlMultiModule/scripts/pages.json +++ b/kotlin/api/htmlMultiModule/scripts/pages.json @@ -1 +1 @@ -[{"name":"CONFLATE_STALE_RENDERINGS","description":"com.squareup.workflow1.RuntimeConfigOptions.CONFLATE_STALE_RENDERINGS","location":"workflow-runtime/com.squareup.workflow1/-runtime-config-options/-c-o-n-f-l-a-t-e_-s-t-a-l-e_-r-e-n-d-e-r-i-n-g-s/index.html","searchKeys":["CONFLATE_STALE_RENDERINGS","CONFLATE_STALE_RENDERINGS","com.squareup.workflow1.RuntimeConfigOptions.CONFLATE_STALE_RENDERINGS"]},{"name":"RENDER_ONLY_WHEN_STATE_CHANGES","description":"com.squareup.workflow1.RuntimeConfigOptions.RENDER_ONLY_WHEN_STATE_CHANGES","location":"workflow-runtime/com.squareup.workflow1/-runtime-config-options/-r-e-n-d-e-r_-o-n-l-y_-w-h-e-n_-s-t-a-t-e_-c-h-a-n-g-e-s/index.html","searchKeys":["RENDER_ONLY_WHEN_STATE_CHANGES","RENDER_ONLY_WHEN_STATE_CHANGES","com.squareup.workflow1.RuntimeConfigOptions.RENDER_ONLY_WHEN_STATE_CHANGES"]},{"name":"abstract val identifier: WorkflowIdentifier","description":"com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.identifier","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-workflow-session/identifier.html","searchKeys":["identifier","abstract val identifier: WorkflowIdentifier","com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.identifier"]},{"name":"abstract val parent: WorkflowInterceptor.WorkflowSession?","description":"com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.parent","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-workflow-session/parent.html","searchKeys":["parent","abstract val parent: WorkflowInterceptor.WorkflowSession?","com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.parent"]},{"name":"abstract val renderKey: String","description":"com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.renderKey","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-workflow-session/render-key.html","searchKeys":["renderKey","abstract val renderKey: String","com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.renderKey"]},{"name":"abstract val runtimeConfig: RuntimeConfig","description":"com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.runtimeConfig","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-workflow-session/runtime-config.html","searchKeys":["runtimeConfig","abstract val runtimeConfig: RuntimeConfig","com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.runtimeConfig"]},{"name":"abstract val sessionId: Long","description":"com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.sessionId","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-workflow-session/session-id.html","searchKeys":["sessionId","abstract val sessionId: Long","com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.sessionId"]},{"name":"annotation class WorkflowExperimentalRuntime","description":"com.squareup.workflow1.WorkflowExperimentalRuntime","location":"workflow-runtime/com.squareup.workflow1/-workflow-experimental-runtime/index.html","searchKeys":["WorkflowExperimentalRuntime","annotation class WorkflowExperimentalRuntime","com.squareup.workflow1.WorkflowExperimentalRuntime"]},{"name":"class RenderingAndSnapshot(val rendering: RenderingT, val snapshot: TreeSnapshot)","description":"com.squareup.workflow1.RenderingAndSnapshot","location":"workflow-runtime/com.squareup.workflow1/-rendering-and-snapshot/index.html","searchKeys":["RenderingAndSnapshot","class RenderingAndSnapshot(val rendering: RenderingT, val snapshot: TreeSnapshot)","com.squareup.workflow1.RenderingAndSnapshot"]},{"name":"class TreeSnapshot","description":"com.squareup.workflow1.TreeSnapshot","location":"workflow-runtime/com.squareup.workflow1/-tree-snapshot/index.html","searchKeys":["TreeSnapshot","class TreeSnapshot","com.squareup.workflow1.TreeSnapshot"]},{"name":"constructor()","description":"com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.SimpleLoggingWorkflowInterceptor","location":"workflow-runtime/com.squareup.workflow1/-simple-logging-workflow-interceptor/-simple-logging-workflow-interceptor.html","searchKeys":["SimpleLoggingWorkflowInterceptor","constructor()","com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.SimpleLoggingWorkflowInterceptor"]},{"name":"constructor(rendering: RenderingT, snapshot: TreeSnapshot)","description":"com.squareup.workflow1.RenderingAndSnapshot.RenderingAndSnapshot","location":"workflow-runtime/com.squareup.workflow1/-rendering-and-snapshot/-rendering-and-snapshot.html","searchKeys":["RenderingAndSnapshot","constructor(rendering: RenderingT, snapshot: TreeSnapshot)","com.squareup.workflow1.RenderingAndSnapshot.RenderingAndSnapshot"]},{"name":"enum RuntimeConfigOptions : Enum ","description":"com.squareup.workflow1.RuntimeConfigOptions","location":"workflow-runtime/com.squareup.workflow1/-runtime-config-options/index.html","searchKeys":["RuntimeConfigOptions","enum RuntimeConfigOptions : Enum ","com.squareup.workflow1.RuntimeConfigOptions"]},{"name":"fun renderWorkflowIn(workflow: Workflow, scope: CoroutineScope, props: StateFlow, initialSnapshot: TreeSnapshot? = null, interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit): StateFlow>","description":"com.squareup.workflow1.renderWorkflowIn","location":"workflow-runtime/com.squareup.workflow1/render-workflow-in.html","searchKeys":["renderWorkflowIn","fun renderWorkflowIn(workflow: Workflow, scope: CoroutineScope, props: StateFlow, initialSnapshot: TreeSnapshot? = null, interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit): StateFlow>","com.squareup.workflow1.renderWorkflowIn"]},{"name":"fun forRootOnly(rootSnapshot: Snapshot?): TreeSnapshot","description":"com.squareup.workflow1.TreeSnapshot.Companion.forRootOnly","location":"workflow-runtime/com.squareup.workflow1/-tree-snapshot/-companion/for-root-only.html","searchKeys":["forRootOnly","fun forRootOnly(rootSnapshot: Snapshot?): TreeSnapshot","com.squareup.workflow1.TreeSnapshot.Companion.forRootOnly"]},{"name":"fun parse(bytes: ByteString): TreeSnapshot","description":"com.squareup.workflow1.TreeSnapshot.Companion.parse","location":"workflow-runtime/com.squareup.workflow1/-tree-snapshot/-companion/parse.html","searchKeys":["parse","fun parse(bytes: ByteString): TreeSnapshot","com.squareup.workflow1.TreeSnapshot.Companion.parse"]},{"name":"fun toByteString(): ByteString","description":"com.squareup.workflow1.TreeSnapshot.toByteString","location":"workflow-runtime/com.squareup.workflow1/-tree-snapshot/to-byte-string.html","searchKeys":["toByteString","fun toByteString(): ByteString","com.squareup.workflow1.TreeSnapshot.toByteString"]},{"name":"fun valueOf(value: String): RuntimeConfigOptions","description":"com.squareup.workflow1.RuntimeConfigOptions.valueOf","location":"workflow-runtime/com.squareup.workflow1/-runtime-config-options/value-of.html","searchKeys":["valueOf","fun valueOf(value: String): RuntimeConfigOptions","com.squareup.workflow1.RuntimeConfigOptions.valueOf"]},{"name":"fun values(): Array","description":"com.squareup.workflow1.RuntimeConfigOptions.values","location":"workflow-runtime/com.squareup.workflow1/-runtime-config-options/values.html","searchKeys":["values","fun values(): Array","com.squareup.workflow1.RuntimeConfigOptions.values"]},{"name":"interface RenderContextInterceptor","description":"com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-render-context-interceptor/index.html","searchKeys":["RenderContextInterceptor","interface RenderContextInterceptor","com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor"]},{"name":"interface WorkflowInterceptor","description":"com.squareup.workflow1.WorkflowInterceptor","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/index.html","searchKeys":["WorkflowInterceptor","interface WorkflowInterceptor","com.squareup.workflow1.WorkflowInterceptor"]},{"name":"interface WorkflowSession","description":"com.squareup.workflow1.WorkflowInterceptor.WorkflowSession","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-workflow-session/index.html","searchKeys":["WorkflowSession","interface WorkflowSession","com.squareup.workflow1.WorkflowInterceptor.WorkflowSession"]},{"name":"object Companion","description":"com.squareup.workflow1.RuntimeConfigOptions.Companion","location":"workflow-runtime/com.squareup.workflow1/-runtime-config-options/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.RuntimeConfigOptions.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.TreeSnapshot.Companion","location":"workflow-runtime/com.squareup.workflow1/-tree-snapshot/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.TreeSnapshot.Companion"]},{"name":"object NoopWorkflowInterceptor : WorkflowInterceptor","description":"com.squareup.workflow1.NoopWorkflowInterceptor","location":"workflow-runtime/com.squareup.workflow1/-noop-workflow-interceptor/index.html","searchKeys":["NoopWorkflowInterceptor","object NoopWorkflowInterceptor : WorkflowInterceptor","com.squareup.workflow1.NoopWorkflowInterceptor"]},{"name":"open class SimpleLoggingWorkflowInterceptor : WorkflowInterceptor","description":"com.squareup.workflow1.SimpleLoggingWorkflowInterceptor","location":"workflow-runtime/com.squareup.workflow1/-simple-logging-workflow-interceptor/index.html","searchKeys":["SimpleLoggingWorkflowInterceptor","open class SimpleLoggingWorkflowInterceptor : WorkflowInterceptor","com.squareup.workflow1.SimpleLoggingWorkflowInterceptor"]},{"name":"open fun onRenderChild(child: Workflow, childProps: CP, key: String, handler: (CO) -> WorkflowAction, proceed: (child: Workflow, childProps: CP, key: String, handler: (CO) -> WorkflowAction) -> CR): CR","description":"com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor.onRenderChild","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-render-context-interceptor/on-render-child.html","searchKeys":["onRenderChild","open fun onRenderChild(child: Workflow, childProps: CP, key: String, handler: (CO) -> WorkflowAction, proceed: (child: Workflow, childProps: CP, key: String, handler: (CO) -> WorkflowAction) -> CR): CR","com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor.onRenderChild"]},{"name":"open fun onRenderAndSnapshot(renderProps: P, proceed: (P) -> RenderingAndSnapshot, session: WorkflowInterceptor.WorkflowSession): RenderingAndSnapshot","description":"com.squareup.workflow1.WorkflowInterceptor.onRenderAndSnapshot","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/on-render-and-snapshot.html","searchKeys":["onRenderAndSnapshot","open fun onRenderAndSnapshot(renderProps: P, proceed: (P) -> RenderingAndSnapshot, session: WorkflowInterceptor.WorkflowSession): RenderingAndSnapshot","com.squareup.workflow1.WorkflowInterceptor.onRenderAndSnapshot"]},{"name":"open fun onRender(renderProps: P, renderState: S, context: BaseRenderContext, proceed: (P, S, WorkflowInterceptor.RenderContextInterceptor?) -> R, session: WorkflowInterceptor.WorkflowSession): R","description":"com.squareup.workflow1.WorkflowInterceptor.onRender","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/on-render.html","searchKeys":["onRender","open fun onRender(renderProps: P, renderState: S, context: BaseRenderContext, proceed: (P, S, WorkflowInterceptor.RenderContextInterceptor?) -> R, session: WorkflowInterceptor.WorkflowSession): R","com.squareup.workflow1.WorkflowInterceptor.onRender"]},{"name":"open fun onInitialState(props: P, snapshot: Snapshot?, workflowScope: CoroutineScope, proceed: (P, Snapshot?, CoroutineScope) -> S, session: WorkflowInterceptor.WorkflowSession): S","description":"com.squareup.workflow1.WorkflowInterceptor.onInitialState","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/on-initial-state.html","searchKeys":["onInitialState","open fun onInitialState(props: P, snapshot: Snapshot?, workflowScope: CoroutineScope, proceed: (P, Snapshot?, CoroutineScope) -> S, session: WorkflowInterceptor.WorkflowSession): S","com.squareup.workflow1.WorkflowInterceptor.onInitialState"]},{"name":"open fun onPropsChanged(old: P, new: P, state: S, proceed: (P, P, S) -> S, session: WorkflowInterceptor.WorkflowSession): S","description":"com.squareup.workflow1.WorkflowInterceptor.onPropsChanged","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/on-props-changed.html","searchKeys":["onPropsChanged","open fun onPropsChanged(old: P, new: P, state: S, proceed: (P, P, S) -> S, session: WorkflowInterceptor.WorkflowSession): S","com.squareup.workflow1.WorkflowInterceptor.onPropsChanged"]},{"name":"open fun onSnapshotState(state: S, proceed: (S) -> Snapshot?, session: WorkflowInterceptor.WorkflowSession): Snapshot?","description":"com.squareup.workflow1.WorkflowInterceptor.onSnapshotState","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/on-snapshot-state.html","searchKeys":["onSnapshotState","open fun onSnapshotState(state: S, proceed: (S) -> Snapshot?, session: WorkflowInterceptor.WorkflowSession): Snapshot?","com.squareup.workflow1.WorkflowInterceptor.onSnapshotState"]},{"name":"open fun onActionSent(action: WorkflowAction, proceed: (WorkflowAction) -> Unit)","description":"com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor.onActionSent","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-render-context-interceptor/on-action-sent.html","searchKeys":["onActionSent","open fun onActionSent(action: WorkflowAction, proceed: (WorkflowAction) -> Unit)","com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor.onActionSent"]},{"name":"open fun onRunningSideEffect(key: String, sideEffect: suspend () -> Unit, proceed: (key: String, sideEffect: suspend () -> Unit) -> Unit)","description":"com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor.onRunningSideEffect","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-render-context-interceptor/on-running-side-effect.html","searchKeys":["onRunningSideEffect","open fun onRunningSideEffect(key: String, sideEffect: suspend () -> Unit, proceed: (key: String, sideEffect: suspend () -> Unit) -> Unit)","com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor.onRunningSideEffect"]},{"name":"open fun onSessionStarted(workflowScope: CoroutineScope, session: WorkflowInterceptor.WorkflowSession)","description":"com.squareup.workflow1.WorkflowInterceptor.onSessionStarted","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/on-session-started.html","searchKeys":["onSessionStarted","open fun onSessionStarted(workflowScope: CoroutineScope, session: WorkflowInterceptor.WorkflowSession)","com.squareup.workflow1.WorkflowInterceptor.onSessionStarted"]},{"name":"open fun onSnapshotStateWithChildren(proceed: () -> TreeSnapshot, session: WorkflowInterceptor.WorkflowSession): TreeSnapshot","description":"com.squareup.workflow1.WorkflowInterceptor.onSnapshotStateWithChildren","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/on-snapshot-state-with-children.html","searchKeys":["onSnapshotStateWithChildren","open fun onSnapshotStateWithChildren(proceed: () -> TreeSnapshot, session: WorkflowInterceptor.WorkflowSession): TreeSnapshot","com.squareup.workflow1.WorkflowInterceptor.onSnapshotStateWithChildren"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.TreeSnapshot.equals","location":"workflow-runtime/com.squareup.workflow1/-tree-snapshot/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.TreeSnapshot.equals"]},{"name":"open override fun onRender(renderProps: P, renderState: S, context: BaseRenderContext, proceed: (P, S, WorkflowInterceptor.RenderContextInterceptor?) -> R, session: WorkflowInterceptor.WorkflowSession): R","description":"com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onRender","location":"workflow-runtime/com.squareup.workflow1/-simple-logging-workflow-interceptor/on-render.html","searchKeys":["onRender","open override fun onRender(renderProps: P, renderState: S, context: BaseRenderContext, proceed: (P, S, WorkflowInterceptor.RenderContextInterceptor?) -> R, session: WorkflowInterceptor.WorkflowSession): R","com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onRender"]},{"name":"open override fun onInitialState(props: P, snapshot: Snapshot?, workflowScope: CoroutineScope, proceed: (P, Snapshot?, CoroutineScope) -> S, session: WorkflowInterceptor.WorkflowSession): S","description":"com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onInitialState","location":"workflow-runtime/com.squareup.workflow1/-simple-logging-workflow-interceptor/on-initial-state.html","searchKeys":["onInitialState","open override fun onInitialState(props: P, snapshot: Snapshot?, workflowScope: CoroutineScope, proceed: (P, Snapshot?, CoroutineScope) -> S, session: WorkflowInterceptor.WorkflowSession): S","com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onInitialState"]},{"name":"open override fun onPropsChanged(old: P, new: P, state: S, proceed: (P, P, S) -> S, session: WorkflowInterceptor.WorkflowSession): S","description":"com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onPropsChanged","location":"workflow-runtime/com.squareup.workflow1/-simple-logging-workflow-interceptor/on-props-changed.html","searchKeys":["onPropsChanged","open override fun onPropsChanged(old: P, new: P, state: S, proceed: (P, P, S) -> S, session: WorkflowInterceptor.WorkflowSession): S","com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onPropsChanged"]},{"name":"open override fun onSnapshotState(state: S, proceed: (S) -> Snapshot?, session: WorkflowInterceptor.WorkflowSession): Snapshot?","description":"com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onSnapshotState","location":"workflow-runtime/com.squareup.workflow1/-simple-logging-workflow-interceptor/on-snapshot-state.html","searchKeys":["onSnapshotState","open override fun onSnapshotState(state: S, proceed: (S) -> Snapshot?, session: WorkflowInterceptor.WorkflowSession): Snapshot?","com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onSnapshotState"]},{"name":"open override fun hashCode(): Int","description":"com.squareup.workflow1.TreeSnapshot.hashCode","location":"workflow-runtime/com.squareup.workflow1/-tree-snapshot/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","com.squareup.workflow1.TreeSnapshot.hashCode"]},{"name":"open override fun onSessionStarted(workflowScope: CoroutineScope, session: WorkflowInterceptor.WorkflowSession)","description":"com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onSessionStarted","location":"workflow-runtime/com.squareup.workflow1/-simple-logging-workflow-interceptor/on-session-started.html","searchKeys":["onSessionStarted","open override fun onSessionStarted(workflowScope: CoroutineScope, session: WorkflowInterceptor.WorkflowSession)","com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onSessionStarted"]},{"name":"operator fun component1(): RenderingT","description":"com.squareup.workflow1.RenderingAndSnapshot.component1","location":"workflow-runtime/com.squareup.workflow1/-rendering-and-snapshot/component1.html","searchKeys":["component1","operator fun component1(): RenderingT","com.squareup.workflow1.RenderingAndSnapshot.component1"]},{"name":"operator fun component2(): TreeSnapshot","description":"com.squareup.workflow1.RenderingAndSnapshot.component2","location":"workflow-runtime/com.squareup.workflow1/-rendering-and-snapshot/component2.html","searchKeys":["component2","operator fun component2(): TreeSnapshot","com.squareup.workflow1.RenderingAndSnapshot.component2"]},{"name":"typealias RuntimeConfig = Set","description":"com.squareup.workflow1.RuntimeConfig","location":"workflow-runtime/com.squareup.workflow1/-runtime-config/index.html","searchKeys":["RuntimeConfig","typealias RuntimeConfig = Set","com.squareup.workflow1.RuntimeConfig"]},{"name":"val DEFAULT_CONFIG: RuntimeConfig","description":"com.squareup.workflow1.RuntimeConfigOptions.Companion.DEFAULT_CONFIG","location":"workflow-runtime/com.squareup.workflow1/-runtime-config-options/-companion/-d-e-f-a-u-l-t_-c-o-n-f-i-g.html","searchKeys":["DEFAULT_CONFIG","val DEFAULT_CONFIG: RuntimeConfig","com.squareup.workflow1.RuntimeConfigOptions.Companion.DEFAULT_CONFIG"]},{"name":"val RENDER_PER_ACTION: RuntimeConfig","description":"com.squareup.workflow1.RuntimeConfigOptions.Companion.RENDER_PER_ACTION","location":"workflow-runtime/com.squareup.workflow1/-runtime-config-options/-companion/-r-e-n-d-e-r_-p-e-r_-a-c-t-i-o-n.html","searchKeys":["RENDER_PER_ACTION","val RENDER_PER_ACTION: RuntimeConfig","com.squareup.workflow1.RuntimeConfigOptions.Companion.RENDER_PER_ACTION"]},{"name":"val entries: EnumEntries","description":"com.squareup.workflow1.RuntimeConfigOptions.entries","location":"workflow-runtime/com.squareup.workflow1/-runtime-config-options/entries.html","searchKeys":["entries","val entries: EnumEntries","com.squareup.workflow1.RuntimeConfigOptions.entries"]},{"name":"val rendering: RenderingT","description":"com.squareup.workflow1.RenderingAndSnapshot.rendering","location":"workflow-runtime/com.squareup.workflow1/-rendering-and-snapshot/rendering.html","searchKeys":["rendering","val rendering: RenderingT","com.squareup.workflow1.RenderingAndSnapshot.rendering"]},{"name":"val snapshot: TreeSnapshot","description":"com.squareup.workflow1.RenderingAndSnapshot.snapshot","location":"workflow-runtime/com.squareup.workflow1/-rendering-and-snapshot/snapshot.html","searchKeys":["snapshot","val snapshot: TreeSnapshot","com.squareup.workflow1.RenderingAndSnapshot.snapshot"]},{"name":"abstract class ComposeScreenViewFactory : ScreenViewFactory ","description":"com.squareup.workflow1.ui.compose.ComposeScreenViewFactory","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-compose-screen-view-factory/index.html","searchKeys":["ComposeScreenViewFactory","abstract class ComposeScreenViewFactory : ScreenViewFactory ","com.squareup.workflow1.ui.compose.ComposeScreenViewFactory"]},{"name":"abstract fun Content(rendering: RenderingT, viewEnvironment: ViewEnvironment)","description":"com.squareup.workflow1.ui.compose.ComposeScreenViewFactory.Content","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-compose-screen-view-factory/-content.html","searchKeys":["Content","abstract fun Content(rendering: RenderingT, viewEnvironment: ViewEnvironment)","com.squareup.workflow1.ui.compose.ComposeScreenViewFactory.Content"]},{"name":"abstract fun Content(viewEnvironment: ViewEnvironment)","description":"com.squareup.workflow1.ui.compose.ComposeScreen.Content","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-compose-screen/-content.html","searchKeys":["Content","abstract fun Content(viewEnvironment: ViewEnvironment)","com.squareup.workflow1.ui.compose.ComposeScreen.Content"]},{"name":"constructor()","description":"com.squareup.workflow1.ui.compose.ComposeScreenViewFactory.ComposeScreenViewFactory","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-compose-screen-view-factory/-compose-screen-view-factory.html","searchKeys":["ComposeScreenViewFactory","constructor()","com.squareup.workflow1.ui.compose.ComposeScreenViewFactory.ComposeScreenViewFactory"]},{"name":"fun Workflow.renderAsState(props: PropsT, interceptors: List = emptyList(), scope: CoroutineScope = rememberCoroutineScope(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit): State","description":"com.squareup.workflow1.ui.compose.renderAsState","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/render-as-state.html","searchKeys":["renderAsState","fun Workflow.renderAsState(props: PropsT, interceptors: List = emptyList(), scope: CoroutineScope = rememberCoroutineScope(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit): State","com.squareup.workflow1.ui.compose.renderAsState"]},{"name":"fun ScreenViewFactoryFinder.withCompositionRoot(root: CompositionRoot): ScreenViewFactoryFinder","description":"com.squareup.workflow1.ui.compose.withCompositionRoot","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/with-composition-root.html","searchKeys":["withCompositionRoot","fun ScreenViewFactoryFinder.withCompositionRoot(root: CompositionRoot): ScreenViewFactoryFinder","com.squareup.workflow1.ui.compose.withCompositionRoot"]},{"name":"fun TextController.asMutableState(): MutableState","description":"com.squareup.workflow1.ui.compose.asMutableState","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/as-mutable-state.html","searchKeys":["asMutableState","fun TextController.asMutableState(): MutableState","com.squareup.workflow1.ui.compose.asMutableState"]},{"name":"fun ViewEnvironment.withCompositionRoot(root: CompositionRoot): ViewEnvironment","description":"com.squareup.workflow1.ui.compose.withCompositionRoot","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/with-composition-root.html","searchKeys":["withCompositionRoot","fun ViewEnvironment.withCompositionRoot(root: CompositionRoot): ViewEnvironment","com.squareup.workflow1.ui.compose.withCompositionRoot"]},{"name":"fun WorkflowRendering(rendering: Screen, viewEnvironment: ViewEnvironment, modifier: Modifier = Modifier)","description":"com.squareup.workflow1.ui.compose.WorkflowRendering","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-workflow-rendering.html","searchKeys":["WorkflowRendering","fun WorkflowRendering(rendering: Screen, viewEnvironment: ViewEnvironment, modifier: Modifier = Modifier)","com.squareup.workflow1.ui.compose.WorkflowRendering"]},{"name":"inline fun composeScreenViewFactory(noinline content: (rendering: RenderingT, environment: ViewEnvironment) -> Unit): ScreenViewFactory","description":"com.squareup.workflow1.ui.compose.composeScreenViewFactory","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/compose-screen-view-factory.html","searchKeys":["composeScreenViewFactory","inline fun composeScreenViewFactory(noinline content: (rendering: RenderingT, environment: ViewEnvironment) -> Unit): ScreenViewFactory","com.squareup.workflow1.ui.compose.composeScreenViewFactory"]},{"name":"inline fun ComposeScreen(crossinline content: (ViewEnvironment) -> Unit): ComposeScreen","description":"com.squareup.workflow1.ui.compose.ComposeScreen","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-compose-screen.html","searchKeys":["ComposeScreen","inline fun ComposeScreen(crossinline content: (ViewEnvironment) -> Unit): ComposeScreen","com.squareup.workflow1.ui.compose.ComposeScreen"]},{"name":"interface ComposeScreen : AndroidScreen ","description":"com.squareup.workflow1.ui.compose.ComposeScreen","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-compose-screen/index.html","searchKeys":["ComposeScreen","interface ComposeScreen : AndroidScreen ","com.squareup.workflow1.ui.compose.ComposeScreen"]},{"name":"open override val viewFactory: ScreenViewFactory","description":"com.squareup.workflow1.ui.compose.ComposeScreen.viewFactory","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-compose-screen/view-factory.html","searchKeys":["viewFactory","open override val viewFactory: ScreenViewFactory","com.squareup.workflow1.ui.compose.ComposeScreen.viewFactory"]},{"name":"override fun buildView(initialRendering: RenderingT, initialEnvironment: ViewEnvironment, context: Context, container: ViewGroup?): ScreenViewHolder","description":"com.squareup.workflow1.ui.compose.ComposeScreenViewFactory.buildView","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-compose-screen-view-factory/build-view.html","searchKeys":["buildView","override fun buildView(initialRendering: RenderingT, initialEnvironment: ViewEnvironment, context: Context, container: ViewGroup?): ScreenViewHolder","com.squareup.workflow1.ui.compose.ComposeScreenViewFactory.buildView"]},{"name":"typealias CompositionRoot = (content: () -> Unit) -> Unit","description":"com.squareup.workflow1.ui.compose.CompositionRoot","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-composition-root/index.html","searchKeys":["CompositionRoot","typealias CompositionRoot = (content: () -> Unit) -> Unit","com.squareup.workflow1.ui.compose.CompositionRoot"]},{"name":"abstract class LifecycleWorker : Worker ","description":"com.squareup.workflow1.LifecycleWorker","location":"workflow-core/com.squareup.workflow1/-lifecycle-worker/index.html","searchKeys":["LifecycleWorker","abstract class LifecycleWorker : Worker ","com.squareup.workflow1.LifecycleWorker"]},{"name":"abstract class SessionWorkflow : StatefulWorkflow ","description":"com.squareup.workflow1.SessionWorkflow","location":"workflow-core/com.squareup.workflow1/-session-workflow/index.html","searchKeys":["SessionWorkflow","abstract class SessionWorkflow : StatefulWorkflow ","com.squareup.workflow1.SessionWorkflow"]},{"name":"abstract class StatefulWorkflow : Workflow , IdCacheable","description":"com.squareup.workflow1.StatefulWorkflow","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/index.html","searchKeys":["StatefulWorkflow","abstract class StatefulWorkflow : Workflow , IdCacheable","com.squareup.workflow1.StatefulWorkflow"]},{"name":"abstract class StatelessWorkflow : Workflow , IdCacheable","description":"com.squareup.workflow1.StatelessWorkflow","location":"workflow-core/com.squareup.workflow1/-stateless-workflow/index.html","searchKeys":["StatelessWorkflow","abstract class StatelessWorkflow : Workflow , IdCacheable","com.squareup.workflow1.StatelessWorkflow"]},{"name":"abstract class WorkflowAction","description":"com.squareup.workflow1.WorkflowAction","location":"workflow-core/com.squareup.workflow1/-workflow-action/index.html","searchKeys":["WorkflowAction","abstract class WorkflowAction","com.squareup.workflow1.WorkflowAction"]},{"name":"abstract fun renderChild(child: Workflow, props: ChildPropsT, key: String = \"\", handler: (ChildOutputT) -> WorkflowAction): ChildRenderingT","description":"com.squareup.workflow1.BaseRenderContext.renderChild","location":"workflow-core/com.squareup.workflow1/-base-render-context/render-child.html","searchKeys":["renderChild","abstract fun renderChild(child: Workflow, props: ChildPropsT, key: String = \"\", handler: (ChildOutputT) -> WorkflowAction): ChildRenderingT","com.squareup.workflow1.BaseRenderContext.renderChild"]},{"name":"abstract fun WorkflowAction.Updater.apply()","description":"com.squareup.workflow1.WorkflowAction.apply","location":"workflow-core/com.squareup.workflow1/-workflow-action/apply.html","searchKeys":["apply","abstract fun WorkflowAction.Updater.apply()","com.squareup.workflow1.WorkflowAction.apply"]},{"name":"abstract fun asStatefulWorkflow(): StatefulWorkflow","description":"com.squareup.workflow1.Workflow.asStatefulWorkflow","location":"workflow-core/com.squareup.workflow1/-workflow/as-stateful-workflow.html","searchKeys":["asStatefulWorkflow","abstract fun asStatefulWorkflow(): StatefulWorkflow","com.squareup.workflow1.Workflow.asStatefulWorkflow"]},{"name":"abstract fun initialState(props: PropsT, snapshot: Snapshot?): StateT","description":"com.squareup.workflow1.StatefulWorkflow.initialState","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/initial-state.html","searchKeys":["initialState","abstract fun initialState(props: PropsT, snapshot: Snapshot?): StateT","com.squareup.workflow1.StatefulWorkflow.initialState"]},{"name":"abstract fun render(renderProps: PropsT, context: StatelessWorkflow.RenderContext): RenderingT","description":"com.squareup.workflow1.StatelessWorkflow.render","location":"workflow-core/com.squareup.workflow1/-stateless-workflow/render.html","searchKeys":["render","abstract fun render(renderProps: PropsT, context: StatelessWorkflow.RenderContext): RenderingT","com.squareup.workflow1.StatelessWorkflow.render"]},{"name":"abstract fun render(renderProps: PropsT, renderState: StateT, context: StatefulWorkflow.RenderContext): RenderingT","description":"com.squareup.workflow1.StatefulWorkflow.render","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/render.html","searchKeys":["render","abstract fun render(renderProps: PropsT, renderState: StateT, context: StatefulWorkflow.RenderContext): RenderingT","com.squareup.workflow1.StatefulWorkflow.render"]},{"name":"abstract fun run(): Flow","description":"com.squareup.workflow1.Worker.run","location":"workflow-core/com.squareup.workflow1/-worker/run.html","searchKeys":["run","abstract fun run(): Flow","com.squareup.workflow1.Worker.run"]},{"name":"abstract fun runningSideEffect(key: String, sideEffect: suspend CoroutineScope.() -> Unit)","description":"com.squareup.workflow1.BaseRenderContext.runningSideEffect","location":"workflow-core/com.squareup.workflow1/-base-render-context/running-side-effect.html","searchKeys":["runningSideEffect","abstract fun runningSideEffect(key: String, sideEffect: suspend CoroutineScope.() -> Unit)","com.squareup.workflow1.BaseRenderContext.runningSideEffect"]},{"name":"abstract fun send(value: T)","description":"com.squareup.workflow1.Sink.send","location":"workflow-core/com.squareup.workflow1/-sink/send.html","searchKeys":["send","abstract fun send(value: T)","com.squareup.workflow1.Sink.send"]},{"name":"abstract fun snapshotState(state: StateT): Snapshot?","description":"com.squareup.workflow1.StatefulWorkflow.snapshotState","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/snapshot-state.html","searchKeys":["snapshotState","abstract fun snapshotState(state: StateT): Snapshot?","com.squareup.workflow1.StatefulWorkflow.snapshotState"]},{"name":"abstract override fun initialState(props: PropsT, snapshot: Snapshot?, workflowScope: CoroutineScope): StateT","description":"com.squareup.workflow1.SessionWorkflow.initialState","location":"workflow-core/com.squareup.workflow1/-session-workflow/initial-state.html","searchKeys":["initialState","abstract override fun initialState(props: PropsT, snapshot: Snapshot?, workflowScope: CoroutineScope): StateT","com.squareup.workflow1.SessionWorkflow.initialState"]},{"name":"abstract val actionSink: Sink>","description":"com.squareup.workflow1.BaseRenderContext.actionSink","location":"workflow-core/com.squareup.workflow1/-base-render-context/action-sink.html","searchKeys":["actionSink","abstract val actionSink: Sink>","com.squareup.workflow1.BaseRenderContext.actionSink"]},{"name":"abstract val realIdentifier: WorkflowIdentifier","description":"com.squareup.workflow1.ImpostorWorkflow.realIdentifier","location":"workflow-core/com.squareup.workflow1/-impostor-workflow/real-identifier.html","searchKeys":["realIdentifier","abstract val realIdentifier: WorkflowIdentifier","com.squareup.workflow1.ImpostorWorkflow.realIdentifier"]},{"name":"abstract val typeName: String","description":"com.squareup.workflow1.WorkflowIdentifierType.typeName","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/type-name.html","searchKeys":["typeName","abstract val typeName: String","com.squareup.workflow1.WorkflowIdentifierType.typeName"]},{"name":"abstract var cachedIdentifier: WorkflowIdentifier?","description":"com.squareup.workflow1.IdCacheable.cachedIdentifier","location":"workflow-core/com.squareup.workflow1/-id-cacheable/cached-identifier.html","searchKeys":["cachedIdentifier","abstract var cachedIdentifier: WorkflowIdentifier?","com.squareup.workflow1.IdCacheable.cachedIdentifier"]},{"name":"annotation class WorkflowExperimentalApi","description":"com.squareup.workflow1.WorkflowExperimentalApi","location":"workflow-core/com.squareup.workflow1/-workflow-experimental-api/index.html","searchKeys":["WorkflowExperimentalApi","annotation class WorkflowExperimentalApi","com.squareup.workflow1.WorkflowExperimentalApi"]},{"name":"class ActionApplied constructor(val output: WorkflowOutput?, val stateChanged: Boolean = false) : ActionProcessingResult","description":"com.squareup.workflow1.ActionApplied","location":"workflow-core/com.squareup.workflow1/-action-applied/index.html","searchKeys":["ActionApplied","class ActionApplied constructor(val output: WorkflowOutput?, val stateChanged: Boolean = false) : ActionProcessingResult","com.squareup.workflow1.ActionApplied"]},{"name":"class Snapshot","description":"com.squareup.workflow1.Snapshot","location":"workflow-core/com.squareup.workflow1/-snapshot/index.html","searchKeys":["Snapshot","class Snapshot","com.squareup.workflow1.Snapshot"]},{"name":"class WorkflowIdentifier","description":"com.squareup.workflow1.WorkflowIdentifier","location":"workflow-core/com.squareup.workflow1/-workflow-identifier/index.html","searchKeys":["WorkflowIdentifier","class WorkflowIdentifier","com.squareup.workflow1.WorkflowIdentifier"]},{"name":"class WorkflowOutput(val value: OutputT)","description":"com.squareup.workflow1.WorkflowOutput","location":"workflow-core/com.squareup.workflow1/-workflow-output/index.html","searchKeys":["WorkflowOutput","class WorkflowOutput(val value: OutputT)","com.squareup.workflow1.WorkflowOutput"]},{"name":"constructor()","description":"com.squareup.workflow1.LifecycleWorker.LifecycleWorker","location":"workflow-core/com.squareup.workflow1/-lifecycle-worker/-lifecycle-worker.html","searchKeys":["LifecycleWorker","constructor()","com.squareup.workflow1.LifecycleWorker.LifecycleWorker"]},{"name":"constructor()","description":"com.squareup.workflow1.SessionWorkflow.SessionWorkflow","location":"workflow-core/com.squareup.workflow1/-session-workflow/-session-workflow.html","searchKeys":["SessionWorkflow","constructor()","com.squareup.workflow1.SessionWorkflow.SessionWorkflow"]},{"name":"constructor()","description":"com.squareup.workflow1.StatefulWorkflow.StatefulWorkflow","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/-stateful-workflow.html","searchKeys":["StatefulWorkflow","constructor()","com.squareup.workflow1.StatefulWorkflow.StatefulWorkflow"]},{"name":"constructor()","description":"com.squareup.workflow1.StatelessWorkflow.StatelessWorkflow","location":"workflow-core/com.squareup.workflow1/-stateless-workflow/-stateless-workflow.html","searchKeys":["StatelessWorkflow","constructor()","com.squareup.workflow1.StatelessWorkflow.StatelessWorkflow"]},{"name":"constructor()","description":"com.squareup.workflow1.WorkflowAction.WorkflowAction","location":"workflow-core/com.squareup.workflow1/-workflow-action/-workflow-action.html","searchKeys":["WorkflowAction","constructor()","com.squareup.workflow1.WorkflowAction.WorkflowAction"]},{"name":"constructor(kClass: KClass<*>)","description":"com.squareup.workflow1.WorkflowIdentifierType.Snapshottable.Snapshottable","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/-snapshottable/-snapshottable.html","searchKeys":["Snapshottable","constructor(kClass: KClass<*>)","com.squareup.workflow1.WorkflowIdentifierType.Snapshottable.Snapshottable"]},{"name":"constructor(kType: KType)","description":"com.squareup.workflow1.WorkflowIdentifierType.Unsnapshottable.Unsnapshottable","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/-unsnapshottable/-unsnapshottable.html","searchKeys":["Unsnapshottable","constructor(kType: KType)","com.squareup.workflow1.WorkflowIdentifierType.Unsnapshottable.Unsnapshottable"]},{"name":"constructor(output: WorkflowOutput?, stateChanged: Boolean = false)","description":"com.squareup.workflow1.ActionApplied.ActionApplied","location":"workflow-core/com.squareup.workflow1/-action-applied/-action-applied.html","searchKeys":["ActionApplied","constructor(output: WorkflowOutput?, stateChanged: Boolean = false)","com.squareup.workflow1.ActionApplied.ActionApplied"]},{"name":"constructor(props: PropsT, state: StateT)","description":"com.squareup.workflow1.WorkflowAction.Updater.Updater","location":"workflow-core/com.squareup.workflow1/-workflow-action/-updater/-updater.html","searchKeys":["Updater","constructor(props: PropsT, state: StateT)","com.squareup.workflow1.WorkflowAction.Updater.Updater"]},{"name":"constructor(typeName: String, kClass: KClass<*>? = null)","description":"com.squareup.workflow1.WorkflowIdentifierType.Snapshottable.Snapshottable","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/-snapshottable/-snapshottable.html","searchKeys":["Snapshottable","constructor(typeName: String, kClass: KClass<*>? = null)","com.squareup.workflow1.WorkflowIdentifierType.Snapshottable.Snapshottable"]},{"name":"constructor(value: OutputT)","description":"com.squareup.workflow1.WorkflowOutput.WorkflowOutput","location":"workflow-core/com.squareup.workflow1/-workflow-output/-workflow-output.html","searchKeys":["WorkflowOutput","constructor(value: OutputT)","com.squareup.workflow1.WorkflowOutput.WorkflowOutput"]},{"name":"data class Snapshottable(val typeName: String, val kClass: KClass<*>? = null) : WorkflowIdentifierType","description":"com.squareup.workflow1.WorkflowIdentifierType.Snapshottable","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/-snapshottable/index.html","searchKeys":["Snapshottable","data class Snapshottable(val typeName: String, val kClass: KClass<*>? = null) : WorkflowIdentifierType","com.squareup.workflow1.WorkflowIdentifierType.Snapshottable"]},{"name":"data class Unsnapshottable(val kType: KType) : WorkflowIdentifierType","description":"com.squareup.workflow1.WorkflowIdentifierType.Unsnapshottable","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/-unsnapshottable/index.html","searchKeys":["Unsnapshottable","data class Unsnapshottable(val kType: KType) : WorkflowIdentifierType","com.squareup.workflow1.WorkflowIdentifierType.Unsnapshottable"]},{"name":"fun BaseRenderContext.renderChild(child: Workflow, props: ChildPropsT, key: String = \"\"): ChildRenderingT","description":"com.squareup.workflow1.renderChild","location":"workflow-core/com.squareup.workflow1/render-child.html","searchKeys":["renderChild","fun BaseRenderContext.renderChild(child: Workflow, props: ChildPropsT, key: String = \"\"): ChildRenderingT","com.squareup.workflow1.renderChild"]},{"name":"fun Workflow.mapRendering(transform: (FromRenderingT) -> ToRenderingT): Workflow","description":"com.squareup.workflow1.mapRendering","location":"workflow-core/com.squareup.workflow1/map-rendering.html","searchKeys":["mapRendering","fun Workflow.mapRendering(transform: (FromRenderingT) -> ToRenderingT): Workflow","com.squareup.workflow1.mapRendering"]},{"name":"fun RenderContext(baseContext: BaseRenderContext, workflow: StatelessWorkflow): StatelessWorkflow.RenderContext","description":"com.squareup.workflow1.RenderContext","location":"workflow-core/com.squareup.workflow1/-render-context.html","searchKeys":["RenderContext","fun RenderContext(baseContext: BaseRenderContext, workflow: StatelessWorkflow): StatelessWorkflow.RenderContext","com.squareup.workflow1.RenderContext"]},{"name":"fun StatelessWorkflow.action(name: () -> String, update: WorkflowAction.Updater.() -> Unit): WorkflowAction","description":"com.squareup.workflow1.action","location":"workflow-core/com.squareup.workflow1/action.html","searchKeys":["action","fun StatelessWorkflow.action(name: () -> String, update: WorkflowAction.Updater.() -> Unit): WorkflowAction","com.squareup.workflow1.action"]},{"name":"fun StatelessWorkflow.action(name: String = \"\", update: WorkflowAction.Updater.() -> Unit): WorkflowAction","description":"com.squareup.workflow1.action","location":"workflow-core/com.squareup.workflow1/action.html","searchKeys":["action","fun StatelessWorkflow.action(name: String = \"\", update: WorkflowAction.Updater.() -> Unit): WorkflowAction","com.squareup.workflow1.action"]},{"name":"fun BaseRenderContext.renderChild(child: Workflow, key: String = \"\", handler: (ChildOutputT) -> WorkflowAction): ChildRenderingT","description":"com.squareup.workflow1.renderChild","location":"workflow-core/com.squareup.workflow1/render-child.html","searchKeys":["renderChild","fun BaseRenderContext.renderChild(child: Workflow, key: String = \"\", handler: (ChildOutputT) -> WorkflowAction): ChildRenderingT","com.squareup.workflow1.renderChild"]},{"name":"fun BaseRenderContext.renderChild(child: Workflow, key: String = \"\"): ChildRenderingT","description":"com.squareup.workflow1.renderChild","location":"workflow-core/com.squareup.workflow1/render-child.html","searchKeys":["renderChild","fun BaseRenderContext.renderChild(child: Workflow, key: String = \"\"): ChildRenderingT","com.squareup.workflow1.renderChild"]},{"name":"fun RenderContext(baseContext: BaseRenderContext, workflow: StatefulWorkflow): StatefulWorkflow.RenderContext","description":"com.squareup.workflow1.RenderContext","location":"workflow-core/com.squareup.workflow1/-render-context.html","searchKeys":["RenderContext","fun RenderContext(baseContext: BaseRenderContext, workflow: StatefulWorkflow): StatefulWorkflow.RenderContext","com.squareup.workflow1.RenderContext"]},{"name":"fun StatefulWorkflow.action(name: () -> String, update: WorkflowAction.Updater.() -> Unit): WorkflowAction","description":"com.squareup.workflow1.action","location":"workflow-core/com.squareup.workflow1/action.html","searchKeys":["action","fun StatefulWorkflow.action(name: () -> String, update: WorkflowAction.Updater.() -> Unit): WorkflowAction","com.squareup.workflow1.action"]},{"name":"fun StatefulWorkflow.action(name: String = \"\", update: WorkflowAction.Updater.() -> Unit): WorkflowAction","description":"com.squareup.workflow1.action","location":"workflow-core/com.squareup.workflow1/action.html","searchKeys":["action","fun StatefulWorkflow.action(name: String = \"\", update: WorkflowAction.Updater.() -> Unit): WorkflowAction","com.squareup.workflow1.action"]},{"name":"fun WorkflowAction.applyTo(props: PropsT, state: StateT): Pair>","description":"com.squareup.workflow1.applyTo","location":"workflow-core/com.squareup.workflow1/apply-to.html","searchKeys":["applyTo","fun WorkflowAction.applyTo(props: PropsT, state: StateT): Pair>","com.squareup.workflow1.applyTo"]},{"name":"fun action(name: () -> String, apply: WorkflowAction.Updater.() -> Unit): WorkflowAction","description":"com.squareup.workflow1.action","location":"workflow-core/com.squareup.workflow1/action.html","searchKeys":["action","fun action(name: () -> String, apply: WorkflowAction.Updater.() -> Unit): WorkflowAction","com.squareup.workflow1.action"]},{"name":"fun action(name: String = \"\", apply: WorkflowAction.Updater.() -> Unit): WorkflowAction","description":"com.squareup.workflow1.action","location":"workflow-core/com.squareup.workflow1/action.html","searchKeys":["action","fun action(name: String = \"\", apply: WorkflowAction.Updater.() -> Unit): WorkflowAction","com.squareup.workflow1.action"]},{"name":"fun noAction(): WorkflowAction","description":"com.squareup.workflow1.WorkflowAction.Companion.noAction","location":"workflow-core/com.squareup.workflow1/-workflow-action/-companion/no-action.html","searchKeys":["noAction","fun noAction(): WorkflowAction","com.squareup.workflow1.WorkflowAction.Companion.noAction"]},{"name":"fun Workflow.Companion.rendering(rendering: RenderingT): Workflow","description":"com.squareup.workflow1.rendering","location":"workflow-core/com.squareup.workflow1/rendering.html","searchKeys":["rendering","fun Workflow.Companion.rendering(rendering: RenderingT): Workflow","com.squareup.workflow1.rendering"]},{"name":"fun BufferedSink.writeNullable(obj: T?, writer: BufferedSink.(T) -> Unit): BufferedSink","description":"com.squareup.workflow1.writeNullable","location":"workflow-core/com.squareup.workflow1/write-nullable.html","searchKeys":["writeNullable","fun BufferedSink.writeNullable(obj: T?, writer: BufferedSink.(T) -> Unit): BufferedSink","com.squareup.workflow1.writeNullable"]},{"name":"fun BufferedSource.readNullable(reader: BufferedSource.() -> T): T?","description":"com.squareup.workflow1.readNullable","location":"workflow-core/com.squareup.workflow1/read-nullable.html","searchKeys":["readNullable","fun BufferedSource.readNullable(reader: BufferedSource.() -> T): T?","com.squareup.workflow1.readNullable"]},{"name":"fun > BufferedSink.writeEnumByOrdinal(enumVal: T): BufferedSink","description":"com.squareup.workflow1.writeEnumByOrdinal","location":"workflow-core/com.squareup.workflow1/write-enum-by-ordinal.html","searchKeys":["writeEnumByOrdinal","fun > BufferedSink.writeEnumByOrdinal(enumVal: T): BufferedSink","com.squareup.workflow1.writeEnumByOrdinal"]},{"name":"fun > BufferedSink.writeOptionalEnumByOrdinal(enumVal: T?): BufferedSink","description":"com.squareup.workflow1.writeOptionalEnumByOrdinal","location":"workflow-core/com.squareup.workflow1/write-optional-enum-by-ordinal.html","searchKeys":["writeOptionalEnumByOrdinal","fun > BufferedSink.writeOptionalEnumByOrdinal(enumVal: T?): BufferedSink","com.squareup.workflow1.writeOptionalEnumByOrdinal"]},{"name":"fun Worker.transform(transform: (Flow) -> Flow): Worker","description":"com.squareup.workflow1.transform","location":"workflow-core/com.squareup.workflow1/transform.html","searchKeys":["transform","fun Worker.transform(transform: (Flow) -> Flow): Worker","com.squareup.workflow1.transform"]},{"name":"fun Sink.contraMap(transform: (T2) -> T1): Sink","description":"com.squareup.workflow1.contraMap","location":"workflow-core/com.squareup.workflow1/contra-map.html","searchKeys":["contraMap","fun Sink.contraMap(transform: (T2) -> T1): Sink","com.squareup.workflow1.contraMap"]},{"name":"fun finished(): Worker","description":"com.squareup.workflow1.Worker.Companion.finished","location":"workflow-core/com.squareup.workflow1/-worker/-companion/finished.html","searchKeys":["finished","fun finished(): Worker","com.squareup.workflow1.Worker.Companion.finished"]},{"name":"fun BufferedSink.writeBooleanAsInt(bool: Boolean): BufferedSink","description":"com.squareup.workflow1.writeBooleanAsInt","location":"workflow-core/com.squareup.workflow1/write-boolean-as-int.html","searchKeys":["writeBooleanAsInt","fun BufferedSink.writeBooleanAsInt(bool: Boolean): BufferedSink","com.squareup.workflow1.writeBooleanAsInt"]},{"name":"fun BufferedSink.writeByteStringWithLength(bytes: ByteString): BufferedSink","description":"com.squareup.workflow1.writeByteStringWithLength","location":"workflow-core/com.squareup.workflow1/write-byte-string-with-length.html","searchKeys":["writeByteStringWithLength","fun BufferedSink.writeByteStringWithLength(bytes: ByteString): BufferedSink","com.squareup.workflow1.writeByteStringWithLength"]},{"name":"fun BufferedSink.writeFloat(float: Float): BufferedSink","description":"com.squareup.workflow1.writeFloat","location":"workflow-core/com.squareup.workflow1/write-float.html","searchKeys":["writeFloat","fun BufferedSink.writeFloat(float: Float): BufferedSink","com.squareup.workflow1.writeFloat"]},{"name":"fun BufferedSink.writeOptionalUtf8WithLength(str: String?): BufferedSink","description":"com.squareup.workflow1.writeOptionalUtf8WithLength","location":"workflow-core/com.squareup.workflow1/write-optional-utf8-with-length.html","searchKeys":["writeOptionalUtf8WithLength","fun BufferedSink.writeOptionalUtf8WithLength(str: String?): BufferedSink","com.squareup.workflow1.writeOptionalUtf8WithLength"]},{"name":"fun BufferedSink.writeUtf8WithLength(str: String): BufferedSink","description":"com.squareup.workflow1.writeUtf8WithLength","location":"workflow-core/com.squareup.workflow1/write-utf8-with-length.html","searchKeys":["writeUtf8WithLength","fun BufferedSink.writeUtf8WithLength(str: String): BufferedSink","com.squareup.workflow1.writeUtf8WithLength"]},{"name":"fun BufferedSource.readBooleanFromInt(): Boolean","description":"com.squareup.workflow1.readBooleanFromInt","location":"workflow-core/com.squareup.workflow1/read-boolean-from-int.html","searchKeys":["readBooleanFromInt","fun BufferedSource.readBooleanFromInt(): Boolean","com.squareup.workflow1.readBooleanFromInt"]},{"name":"fun BufferedSource.readByteStringWithLength(): ByteString","description":"com.squareup.workflow1.readByteStringWithLength","location":"workflow-core/com.squareup.workflow1/read-byte-string-with-length.html","searchKeys":["readByteStringWithLength","fun BufferedSource.readByteStringWithLength(): ByteString","com.squareup.workflow1.readByteStringWithLength"]},{"name":"fun BufferedSource.readFloat(): Float","description":"com.squareup.workflow1.readFloat","location":"workflow-core/com.squareup.workflow1/read-float.html","searchKeys":["readFloat","fun BufferedSource.readFloat(): Float","com.squareup.workflow1.readFloat"]},{"name":"fun BufferedSource.readOptionalUtf8WithLength(): String?","description":"com.squareup.workflow1.readOptionalUtf8WithLength","location":"workflow-core/com.squareup.workflow1/read-optional-utf8-with-length.html","searchKeys":["readOptionalUtf8WithLength","fun BufferedSource.readOptionalUtf8WithLength(): String?","com.squareup.workflow1.readOptionalUtf8WithLength"]},{"name":"fun BufferedSource.readUtf8WithLength(): String","description":"com.squareup.workflow1.readUtf8WithLength","location":"workflow-core/com.squareup.workflow1/read-utf8-with-length.html","searchKeys":["readUtf8WithLength","fun BufferedSource.readUtf8WithLength(): String","com.squareup.workflow1.readUtf8WithLength"]},{"name":"fun component1(): WorkflowOutput?","description":"com.squareup.workflow1.ActionApplied.component1","location":"workflow-core/com.squareup.workflow1/-action-applied/component1.html","searchKeys":["component1","fun component1(): WorkflowOutput?","com.squareup.workflow1.ActionApplied.component1"]},{"name":"fun component2(): Boolean","description":"com.squareup.workflow1.ActionApplied.component2","location":"workflow-core/com.squareup.workflow1/-action-applied/component2.html","searchKeys":["component2","fun component2(): Boolean","com.squareup.workflow1.ActionApplied.component2"]},{"name":"fun copy(output: WorkflowOutput? = this.output, stateChanged: Boolean = this.stateChanged): ActionApplied","description":"com.squareup.workflow1.ActionApplied.copy","location":"workflow-core/com.squareup.workflow1/-action-applied/copy.html","searchKeys":["copy","fun copy(output: WorkflowOutput? = this.output, stateChanged: Boolean = this.stateChanged): ActionApplied","com.squareup.workflow1.ActionApplied.copy"]},{"name":"fun getRealIdentifierType(): WorkflowIdentifierType","description":"com.squareup.workflow1.WorkflowIdentifier.getRealIdentifierType","location":"workflow-core/com.squareup.workflow1/-workflow-identifier/get-real-identifier-type.html","searchKeys":["getRealIdentifierType","fun getRealIdentifierType(): WorkflowIdentifierType","com.squareup.workflow1.WorkflowIdentifier.getRealIdentifierType"]},{"name":"fun interface Sink","description":"com.squareup.workflow1.Sink","location":"workflow-core/com.squareup.workflow1/-sink/index.html","searchKeys":["Sink","fun interface Sink","com.squareup.workflow1.Sink"]},{"name":"fun of(byteString: ByteString): Snapshot","description":"com.squareup.workflow1.Snapshot.Companion.of","location":"workflow-core/com.squareup.workflow1/-snapshot/-companion/of.html","searchKeys":["of","fun of(byteString: ByteString): Snapshot","com.squareup.workflow1.Snapshot.Companion.of"]},{"name":"fun of(integer: Int): Snapshot","description":"com.squareup.workflow1.Snapshot.Companion.of","location":"workflow-core/com.squareup.workflow1/-snapshot/-companion/of.html","searchKeys":["of","fun of(integer: Int): Snapshot","com.squareup.workflow1.Snapshot.Companion.of"]},{"name":"fun of(lazy: () -> ByteString): Snapshot","description":"com.squareup.workflow1.Snapshot.Companion.of","location":"workflow-core/com.squareup.workflow1/-snapshot/-companion/of.html","searchKeys":["of","fun of(lazy: () -> ByteString): Snapshot","com.squareup.workflow1.Snapshot.Companion.of"]},{"name":"fun of(string: String): Snapshot","description":"com.squareup.workflow1.Snapshot.Companion.of","location":"workflow-core/com.squareup.workflow1/-snapshot/-companion/of.html","searchKeys":["of","fun of(string: String): Snapshot","com.squareup.workflow1.Snapshot.Companion.of"]},{"name":"fun parse(bytes: ByteString): WorkflowIdentifier","description":"com.squareup.workflow1.WorkflowIdentifier.Companion.parse","location":"workflow-core/com.squareup.workflow1/-workflow-identifier/-companion/parse.html","searchKeys":["parse","fun parse(bytes: ByteString): WorkflowIdentifier","com.squareup.workflow1.WorkflowIdentifier.Companion.parse"]},{"name":"fun setOutput(output: OutputT)","description":"com.squareup.workflow1.WorkflowAction.Updater.setOutput","location":"workflow-core/com.squareup.workflow1/-workflow-action/-updater/set-output.html","searchKeys":["setOutput","fun setOutput(output: OutputT)","com.squareup.workflow1.WorkflowAction.Updater.setOutput"]},{"name":"fun timer(delayMs: Long, key: String = \"\"): Worker","description":"com.squareup.workflow1.Worker.Companion.timer","location":"workflow-core/com.squareup.workflow1/-worker/-companion/timer.html","searchKeys":["timer","fun timer(delayMs: Long, key: String = \"\"): Worker","com.squareup.workflow1.Worker.Companion.timer"]},{"name":"fun toByteStringOrNull(): ByteString?","description":"com.squareup.workflow1.WorkflowIdentifier.toByteStringOrNull","location":"workflow-core/com.squareup.workflow1/-workflow-identifier/to-byte-string-or-null.html","searchKeys":["toByteStringOrNull","fun toByteStringOrNull(): ByteString?","com.squareup.workflow1.WorkflowIdentifier.toByteStringOrNull"]},{"name":"fun unsnapshottableIdentifier(type: KType): WorkflowIdentifier","description":"com.squareup.workflow1.unsnapshottableIdentifier","location":"workflow-core/com.squareup.workflow1/unsnapshottable-identifier.html","searchKeys":["unsnapshottableIdentifier","fun unsnapshottableIdentifier(type: KType): WorkflowIdentifier","com.squareup.workflow1.unsnapshottableIdentifier"]},{"name":"fun write(lazy: (BufferedSink) -> Unit): Snapshot","description":"com.squareup.workflow1.Snapshot.Companion.write","location":"workflow-core/com.squareup.workflow1/-snapshot/-companion/write.html","searchKeys":["write","fun write(lazy: (BufferedSink) -> Unit): Snapshot","com.squareup.workflow1.Snapshot.Companion.write"]},{"name":"inline fun Flow.asWorker(): Worker","description":"com.squareup.workflow1.asWorker","location":"workflow-core/com.squareup.workflow1/as-worker.html","searchKeys":["asWorker","inline fun Flow.asWorker(): Worker","com.squareup.workflow1.asWorker"]},{"name":"inline fun create(noinline block: suspend FlowCollector.() -> Unit): Worker","description":"com.squareup.workflow1.Worker.Companion.create","location":"workflow-core/com.squareup.workflow1/-worker/-companion/create.html","searchKeys":["create","inline fun create(noinline block: suspend FlowCollector.() -> Unit): Worker","com.squareup.workflow1.Worker.Companion.create"]},{"name":"inline fun from(noinline block: suspend () -> OutputT): Worker","description":"com.squareup.workflow1.Worker.Companion.from","location":"workflow-core/com.squareup.workflow1/-worker/-companion/from.html","searchKeys":["from","inline fun from(noinline block: suspend () -> OutputT): Worker","com.squareup.workflow1.Worker.Companion.from"]},{"name":"inline fun fromNullable(noinline block: suspend () -> OutputT?): Worker","description":"com.squareup.workflow1.Worker.Companion.fromNullable","location":"workflow-core/com.squareup.workflow1/-worker/-companion/from-nullable.html","searchKeys":["fromNullable","inline fun fromNullable(noinline block: suspend () -> OutputT?): Worker","com.squareup.workflow1.Worker.Companion.fromNullable"]},{"name":"inline fun Workflow.Companion.stateless(crossinline render: BaseRenderContext.(props: PropsT) -> RenderingT): Workflow","description":"com.squareup.workflow1.stateless","location":"workflow-core/com.squareup.workflow1/stateless.html","searchKeys":["stateless","inline fun Workflow.Companion.stateless(crossinline render: BaseRenderContext.(props: PropsT) -> RenderingT): Workflow","com.squareup.workflow1.stateless"]},{"name":"inline fun Workflow.Companion.sessionWorkflow(crossinline initialState: (PropsT, CoroutineScope) -> StateT, crossinline render: BaseRenderContext.(props: PropsT, state: StateT) -> RenderingT, crossinline onPropsChanged: (old: PropsT, new: PropsT, state: StateT) -> StateT = { _, _, state -> state }): SessionWorkflow","description":"com.squareup.workflow1.sessionWorkflow","location":"workflow-core/com.squareup.workflow1/session-workflow.html","searchKeys":["sessionWorkflow","inline fun Workflow.Companion.sessionWorkflow(crossinline initialState: (PropsT, CoroutineScope) -> StateT, crossinline render: BaseRenderContext.(props: PropsT, state: StateT) -> RenderingT, crossinline onPropsChanged: (old: PropsT, new: PropsT, state: StateT) -> StateT = { _, _, state -> state }): SessionWorkflow","com.squareup.workflow1.sessionWorkflow"]},{"name":"inline fun Workflow.Companion.sessionWorkflow(crossinline initialState: (PropsT, Snapshot?, CoroutineScope) -> StateT, crossinline render: BaseRenderContext.(props: PropsT, state: StateT) -> RenderingT, crossinline snapshot: (StateT) -> Snapshot?, crossinline onPropsChanged: (old: PropsT, new: PropsT, state: StateT) -> StateT = { _, _, state -> state }): SessionWorkflow","description":"com.squareup.workflow1.sessionWorkflow","location":"workflow-core/com.squareup.workflow1/session-workflow.html","searchKeys":["sessionWorkflow","inline fun Workflow.Companion.sessionWorkflow(crossinline initialState: (PropsT, Snapshot?, CoroutineScope) -> StateT, crossinline render: BaseRenderContext.(props: PropsT, state: StateT) -> RenderingT, crossinline snapshot: (StateT) -> Snapshot?, crossinline onPropsChanged: (old: PropsT, new: PropsT, state: StateT) -> StateT = { _, _, state -> state }): SessionWorkflow","com.squareup.workflow1.sessionWorkflow"]},{"name":"inline fun Workflow.Companion.stateful(crossinline initialState: (PropsT) -> StateT, crossinline render: BaseRenderContext.(props: PropsT, state: StateT) -> RenderingT, crossinline onPropsChanged: (old: PropsT, new: PropsT, state: StateT) -> StateT = { _, _, state -> state }): StatefulWorkflow","description":"com.squareup.workflow1.stateful","location":"workflow-core/com.squareup.workflow1/stateful.html","searchKeys":["stateful","inline fun Workflow.Companion.stateful(crossinline initialState: (PropsT) -> StateT, crossinline render: BaseRenderContext.(props: PropsT, state: StateT) -> RenderingT, crossinline onPropsChanged: (old: PropsT, new: PropsT, state: StateT) -> StateT = { _, _, state -> state }): StatefulWorkflow","com.squareup.workflow1.stateful"]},{"name":"inline fun Workflow.Companion.stateful(crossinline initialState: (PropsT, Snapshot?) -> StateT, crossinline render: BaseRenderContext.(props: PropsT, state: StateT) -> RenderingT, crossinline snapshot: (StateT) -> Snapshot?, crossinline onPropsChanged: (old: PropsT, new: PropsT, state: StateT) -> StateT = { _, _, state -> state }): StatefulWorkflow","description":"com.squareup.workflow1.stateful","location":"workflow-core/com.squareup.workflow1/stateful.html","searchKeys":["stateful","inline fun Workflow.Companion.stateful(crossinline initialState: (PropsT, Snapshot?) -> StateT, crossinline render: BaseRenderContext.(props: PropsT, state: StateT) -> RenderingT, crossinline snapshot: (StateT) -> Snapshot?, crossinline onPropsChanged: (old: PropsT, new: PropsT, state: StateT) -> StateT = { _, _, state -> state }): StatefulWorkflow","com.squareup.workflow1.stateful"]},{"name":"inline fun Workflow.Companion.sessionWorkflow(crossinline initialState: (CoroutineScope) -> StateT, crossinline render: BaseRenderContext.(state: StateT) -> RenderingT): SessionWorkflow","description":"com.squareup.workflow1.sessionWorkflow","location":"workflow-core/com.squareup.workflow1/session-workflow.html","searchKeys":["sessionWorkflow","inline fun Workflow.Companion.sessionWorkflow(crossinline initialState: (CoroutineScope) -> StateT, crossinline render: BaseRenderContext.(state: StateT) -> RenderingT): SessionWorkflow","com.squareup.workflow1.sessionWorkflow"]},{"name":"inline fun Workflow.Companion.sessionWorkflow(crossinline initialState: (Snapshot?, CoroutineScope) -> StateT, crossinline render: BaseRenderContext.(state: StateT) -> RenderingT, crossinline snapshot: (StateT) -> Snapshot?): SessionWorkflow","description":"com.squareup.workflow1.sessionWorkflow","location":"workflow-core/com.squareup.workflow1/session-workflow.html","searchKeys":["sessionWorkflow","inline fun Workflow.Companion.sessionWorkflow(crossinline initialState: (Snapshot?, CoroutineScope) -> StateT, crossinline render: BaseRenderContext.(state: StateT) -> RenderingT, crossinline snapshot: (StateT) -> Snapshot?): SessionWorkflow","com.squareup.workflow1.sessionWorkflow"]},{"name":"inline fun Workflow.Companion.stateful(crossinline initialState: (Snapshot?) -> StateT, crossinline render: BaseRenderContext.(state: StateT) -> RenderingT, crossinline snapshot: (StateT) -> Snapshot?): StatefulWorkflow","description":"com.squareup.workflow1.stateful","location":"workflow-core/com.squareup.workflow1/stateful.html","searchKeys":["stateful","inline fun Workflow.Companion.stateful(crossinline initialState: (Snapshot?) -> StateT, crossinline render: BaseRenderContext.(state: StateT) -> RenderingT, crossinline snapshot: (StateT) -> Snapshot?): StatefulWorkflow","com.squareup.workflow1.stateful"]},{"name":"inline fun Workflow.Companion.stateful(initialState: StateT, crossinline render: BaseRenderContext.(state: StateT) -> RenderingT): StatefulWorkflow","description":"com.squareup.workflow1.stateful","location":"workflow-core/com.squareup.workflow1/stateful.html","searchKeys":["stateful","inline fun Workflow.Companion.stateful(initialState: StateT, crossinline render: BaseRenderContext.(state: StateT) -> RenderingT): StatefulWorkflow","com.squareup.workflow1.stateful"]},{"name":"inline fun > BufferedSource.readEnumByOrdinal(): T","description":"com.squareup.workflow1.readEnumByOrdinal","location":"workflow-core/com.squareup.workflow1/read-enum-by-ordinal.html","searchKeys":["readEnumByOrdinal","inline fun > BufferedSource.readEnumByOrdinal(): T","com.squareup.workflow1.readEnumByOrdinal"]},{"name":"inline fun > BufferedSource.readOptionalEnumByOrdinal(): T?","description":"com.squareup.workflow1.readOptionalEnumByOrdinal","location":"workflow-core/com.squareup.workflow1/read-optional-enum-by-ordinal.html","searchKeys":["readOptionalEnumByOrdinal","inline fun > BufferedSource.readOptionalEnumByOrdinal(): T?","com.squareup.workflow1.readOptionalEnumByOrdinal"]},{"name":"inline fun , PropsT, StateT, OutputT> BaseRenderContext.runningWorker(worker: W, key: String = \"\", noinline handler: (T) -> WorkflowAction)","description":"com.squareup.workflow1.runningWorker","location":"workflow-core/com.squareup.workflow1/running-worker.html","searchKeys":["runningWorker","inline fun , PropsT, StateT, OutputT> BaseRenderContext.runningWorker(worker: W, key: String = \"\", noinline handler: (T) -> WorkflowAction)","com.squareup.workflow1.runningWorker"]},{"name":"inline fun BufferedSink.writeList(values: List, writer: BufferedSink.(T) -> Unit): BufferedSink","description":"com.squareup.workflow1.writeList","location":"workflow-core/com.squareup.workflow1/write-list.html","searchKeys":["writeList","inline fun BufferedSink.writeList(values: List, writer: BufferedSink.(T) -> Unit): BufferedSink","com.squareup.workflow1.writeList"]},{"name":"inline fun BufferedSource.readList(reader: BufferedSource.() -> T): List","description":"com.squareup.workflow1.readList","location":"workflow-core/com.squareup.workflow1/read-list.html","searchKeys":["readList","inline fun BufferedSource.readList(reader: BufferedSource.() -> T): List","com.squareup.workflow1.readList"]},{"name":"inline fun ByteString.parse(block: (BufferedSource) -> T): T","description":"com.squareup.workflow1.parse","location":"workflow-core/com.squareup.workflow1/parse.html","searchKeys":["parse","inline fun ByteString.parse(block: (BufferedSource) -> T): T","com.squareup.workflow1.parse"]},{"name":"inline fun BaseRenderContext.runningWorker(worker: W, key: String = \"\")","description":"com.squareup.workflow1.runningWorker","location":"workflow-core/com.squareup.workflow1/running-worker.html","searchKeys":["runningWorker","inline fun BaseRenderContext.runningWorker(worker: W, key: String = \"\")","com.squareup.workflow1.runningWorker"]},{"name":"inner class RenderContext : BaseRenderContext ","description":"com.squareup.workflow1.StatelessWorkflow.RenderContext","location":"workflow-core/com.squareup.workflow1/-stateless-workflow/-render-context/index.html","searchKeys":["RenderContext","inner class RenderContext : BaseRenderContext ","com.squareup.workflow1.StatelessWorkflow.RenderContext"]},{"name":"inner class RenderContext : BaseRenderContext ","description":"com.squareup.workflow1.StatefulWorkflow.RenderContext","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/-render-context/index.html","searchKeys":["RenderContext","inner class RenderContext : BaseRenderContext ","com.squareup.workflow1.StatefulWorkflow.RenderContext"]},{"name":"inner class Updater(val props: PropsT, var state: StateT)","description":"com.squareup.workflow1.WorkflowAction.Updater","location":"workflow-core/com.squareup.workflow1/-workflow-action/-updater/index.html","searchKeys":["Updater","inner class Updater(val props: PropsT, var state: StateT)","com.squareup.workflow1.WorkflowAction.Updater"]},{"name":"interface ActionProcessingResult","description":"com.squareup.workflow1.ActionProcessingResult","location":"workflow-core/com.squareup.workflow1/-action-processing-result/index.html","searchKeys":["ActionProcessingResult","interface ActionProcessingResult","com.squareup.workflow1.ActionProcessingResult"]},{"name":"interface BaseRenderContext","description":"com.squareup.workflow1.BaseRenderContext","location":"workflow-core/com.squareup.workflow1/-base-render-context/index.html","searchKeys":["BaseRenderContext","interface BaseRenderContext","com.squareup.workflow1.BaseRenderContext"]},{"name":"interface IdCacheable","description":"com.squareup.workflow1.IdCacheable","location":"workflow-core/com.squareup.workflow1/-id-cacheable/index.html","searchKeys":["IdCacheable","interface IdCacheable","com.squareup.workflow1.IdCacheable"]},{"name":"interface ImpostorWorkflow","description":"com.squareup.workflow1.ImpostorWorkflow","location":"workflow-core/com.squareup.workflow1/-impostor-workflow/index.html","searchKeys":["ImpostorWorkflow","interface ImpostorWorkflow","com.squareup.workflow1.ImpostorWorkflow"]},{"name":"interface Worker","description":"com.squareup.workflow1.Worker","location":"workflow-core/com.squareup.workflow1/-worker/index.html","searchKeys":["Worker","interface Worker","com.squareup.workflow1.Worker"]},{"name":"interface Workflow","description":"com.squareup.workflow1.Workflow","location":"workflow-core/com.squareup.workflow1/-workflow/index.html","searchKeys":["Workflow","interface Workflow","com.squareup.workflow1.Workflow"]},{"name":"object ActionsExhausted : ActionProcessingResult","description":"com.squareup.workflow1.ActionsExhausted","location":"workflow-core/com.squareup.workflow1/-actions-exhausted/index.html","searchKeys":["ActionsExhausted","object ActionsExhausted : ActionProcessingResult","com.squareup.workflow1.ActionsExhausted"]},{"name":"object Companion","description":"com.squareup.workflow1.Snapshot.Companion","location":"workflow-core/com.squareup.workflow1/-snapshot/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.Snapshot.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.Worker.Companion","location":"workflow-core/com.squareup.workflow1/-worker/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.Worker.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.Workflow.Companion","location":"workflow-core/com.squareup.workflow1/-workflow/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.Workflow.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.WorkflowAction.Companion","location":"workflow-core/com.squareup.workflow1/-workflow-action/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.WorkflowAction.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.WorkflowIdentifier.Companion","location":"workflow-core/com.squareup.workflow1/-workflow-identifier/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.WorkflowIdentifier.Companion"]},{"name":"object PropsUpdated : ActionProcessingResult","description":"com.squareup.workflow1.PropsUpdated","location":"workflow-core/com.squareup.workflow1/-props-updated/index.html","searchKeys":["PropsUpdated","object PropsUpdated : ActionProcessingResult","com.squareup.workflow1.PropsUpdated"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6, E7, E8, E9, E10) -> Unit): (E1, E2, E3, E4, E5, E6, E7, E8, E9, E10) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6, E7, E8, E9, E10) -> Unit): (E1, E2, E3, E4, E5, E6, E7, E8, E9, E10) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6, E7, E8, E9) -> Unit): (E1, E2, E3, E4, E5, E6, E7, E8, E9) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6, E7, E8, E9) -> Unit): (E1, E2, E3, E4, E5, E6, E7, E8, E9) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6, E7, E8) -> Unit): (E1, E2, E3, E4, E5, E6, E7, E8) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6, E7, E8) -> Unit): (E1, E2, E3, E4, E5, E6, E7, E8) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6, E7) -> Unit): (E1, E2, E3, E4, E5, E6, E7) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6, E7) -> Unit): (E1, E2, E3, E4, E5, E6, E7) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6) -> Unit): (E1, E2, E3, E4, E5, E6) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6) -> Unit): (E1, E2, E3, E4, E5, E6) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5) -> Unit): (E1, E2, E3, E4, E5) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5) -> Unit): (E1, E2, E3, E4, E5) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4) -> Unit): (E1, E2, E3, E4) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4) -> Unit): (E1, E2, E3, E4) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3) -> Unit): (E1, E2, E3) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3) -> Unit): (E1, E2, E3) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2) -> Unit): (E1, E2) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2) -> Unit): (E1, E2) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(EventT) -> Unit): (EventT) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(EventT) -> Unit): (EventT) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun describeRealIdentifier(): String?","description":"com.squareup.workflow1.ImpostorWorkflow.describeRealIdentifier","location":"workflow-core/com.squareup.workflow1/-impostor-workflow/describe-real-identifier.html","searchKeys":["describeRealIdentifier","open fun describeRealIdentifier(): String?","com.squareup.workflow1.ImpostorWorkflow.describeRealIdentifier"]},{"name":"open fun doesSameWorkAs(otherWorker: Worker<*>): Boolean","description":"com.squareup.workflow1.Worker.doesSameWorkAs","location":"workflow-core/com.squareup.workflow1/-worker/does-same-work-as.html","searchKeys":["doesSameWorkAs","open fun doesSameWorkAs(otherWorker: Worker<*>): Boolean","com.squareup.workflow1.Worker.doesSameWorkAs"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.() -> Unit): () -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.() -> Unit): () -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun initialState(props: PropsT, snapshot: Snapshot?, workflowScope: CoroutineScope): StateT","description":"com.squareup.workflow1.StatefulWorkflow.initialState","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/initial-state.html","searchKeys":["initialState","open fun initialState(props: PropsT, snapshot: Snapshot?, workflowScope: CoroutineScope): StateT","com.squareup.workflow1.StatefulWorkflow.initialState"]},{"name":"open fun onPropsChanged(old: PropsT, new: PropsT, state: StateT): StateT","description":"com.squareup.workflow1.StatefulWorkflow.onPropsChanged","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/on-props-changed.html","searchKeys":["onPropsChanged","open fun onPropsChanged(old: PropsT, new: PropsT, state: StateT): StateT","com.squareup.workflow1.StatefulWorkflow.onPropsChanged"]},{"name":"open fun onStarted()","description":"com.squareup.workflow1.LifecycleWorker.onStarted","location":"workflow-core/com.squareup.workflow1/-lifecycle-worker/on-started.html","searchKeys":["onStarted","open fun onStarted()","com.squareup.workflow1.LifecycleWorker.onStarted"]},{"name":"open fun onStopped()","description":"com.squareup.workflow1.LifecycleWorker.onStopped","location":"workflow-core/com.squareup.workflow1/-lifecycle-worker/on-stopped.html","searchKeys":["onStopped","open fun onStopped()","com.squareup.workflow1.LifecycleWorker.onStopped"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.ActionApplied.equals","location":"workflow-core/com.squareup.workflow1/-action-applied/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.ActionApplied.equals"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.Snapshot.equals","location":"workflow-core/com.squareup.workflow1/-snapshot/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.Snapshot.equals"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.WorkflowIdentifier.equals","location":"workflow-core/com.squareup.workflow1/-workflow-identifier/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.WorkflowIdentifier.equals"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.WorkflowOutput.equals","location":"workflow-core/com.squareup.workflow1/-workflow-output/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.WorkflowOutput.equals"]},{"name":"open override fun doesSameWorkAs(otherWorker: Worker<*>): Boolean","description":"com.squareup.workflow1.LifecycleWorker.doesSameWorkAs","location":"workflow-core/com.squareup.workflow1/-lifecycle-worker/does-same-work-as.html","searchKeys":["doesSameWorkAs","open override fun doesSameWorkAs(otherWorker: Worker<*>): Boolean","com.squareup.workflow1.LifecycleWorker.doesSameWorkAs"]},{"name":"open override fun hashCode(): Int","description":"com.squareup.workflow1.ActionApplied.hashCode","location":"workflow-core/com.squareup.workflow1/-action-applied/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","com.squareup.workflow1.ActionApplied.hashCode"]},{"name":"open override fun hashCode(): Int","description":"com.squareup.workflow1.Snapshot.hashCode","location":"workflow-core/com.squareup.workflow1/-snapshot/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","com.squareup.workflow1.Snapshot.hashCode"]},{"name":"open override fun hashCode(): Int","description":"com.squareup.workflow1.WorkflowIdentifier.hashCode","location":"workflow-core/com.squareup.workflow1/-workflow-identifier/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","com.squareup.workflow1.WorkflowIdentifier.hashCode"]},{"name":"open override fun hashCode(): Int","description":"com.squareup.workflow1.WorkflowOutput.hashCode","location":"workflow-core/com.squareup.workflow1/-workflow-output/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","com.squareup.workflow1.WorkflowOutput.hashCode"]},{"name":"open override fun toString(): String","description":"com.squareup.workflow1.ActionApplied.toString","location":"workflow-core/com.squareup.workflow1/-action-applied/to-string.html","searchKeys":["toString","open override fun toString(): String","com.squareup.workflow1.ActionApplied.toString"]},{"name":"open override fun toString(): String","description":"com.squareup.workflow1.Snapshot.toString","location":"workflow-core/com.squareup.workflow1/-snapshot/to-string.html","searchKeys":["toString","open override fun toString(): String","com.squareup.workflow1.Snapshot.toString"]},{"name":"open override fun toString(): String","description":"com.squareup.workflow1.WorkflowIdentifier.toString","location":"workflow-core/com.squareup.workflow1/-workflow-identifier/to-string.html","searchKeys":["toString","open override fun toString(): String","com.squareup.workflow1.WorkflowIdentifier.toString"]},{"name":"open override fun toString(): String","description":"com.squareup.workflow1.WorkflowOutput.toString","location":"workflow-core/com.squareup.workflow1/-workflow-output/to-string.html","searchKeys":["toString","open override fun toString(): String","com.squareup.workflow1.WorkflowOutput.toString"]},{"name":"open override val typeName: String","description":"com.squareup.workflow1.WorkflowIdentifierType.Snapshottable.typeName","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/-snapshottable/type-name.html","searchKeys":["typeName","open override val typeName: String","com.squareup.workflow1.WorkflowIdentifierType.Snapshottable.typeName"]},{"name":"open override val typeName: String","description":"com.squareup.workflow1.WorkflowIdentifierType.Unsnapshottable.typeName","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/-unsnapshottable/type-name.html","searchKeys":["typeName","open override val typeName: String","com.squareup.workflow1.WorkflowIdentifierType.Unsnapshottable.typeName"]},{"name":"open override var cachedIdentifier: WorkflowIdentifier?","description":"com.squareup.workflow1.StatefulWorkflow.cachedIdentifier","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/cached-identifier.html","searchKeys":["cachedIdentifier","open override var cachedIdentifier: WorkflowIdentifier?","com.squareup.workflow1.StatefulWorkflow.cachedIdentifier"]},{"name":"open override var cachedIdentifier: WorkflowIdentifier?","description":"com.squareup.workflow1.StatelessWorkflow.cachedIdentifier","location":"workflow-core/com.squareup.workflow1/-stateless-workflow/cached-identifier.html","searchKeys":["cachedIdentifier","open override var cachedIdentifier: WorkflowIdentifier?","com.squareup.workflow1.StatelessWorkflow.cachedIdentifier"]},{"name":"override fun asStatefulWorkflow(): StatefulWorkflow","description":"com.squareup.workflow1.StatelessWorkflow.asStatefulWorkflow","location":"workflow-core/com.squareup.workflow1/-stateless-workflow/as-stateful-workflow.html","searchKeys":["asStatefulWorkflow","override fun asStatefulWorkflow(): StatefulWorkflow","com.squareup.workflow1.StatelessWorkflow.asStatefulWorkflow"]},{"name":"override fun asStatefulWorkflow(): StatefulWorkflow","description":"com.squareup.workflow1.StatefulWorkflow.asStatefulWorkflow","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/as-stateful-workflow.html","searchKeys":["asStatefulWorkflow","override fun asStatefulWorkflow(): StatefulWorkflow","com.squareup.workflow1.StatefulWorkflow.asStatefulWorkflow"]},{"name":"override fun initialState(props: PropsT, snapshot: Snapshot?): StateT","description":"com.squareup.workflow1.SessionWorkflow.initialState","location":"workflow-core/com.squareup.workflow1/-session-workflow/initial-state.html","searchKeys":["initialState","override fun initialState(props: PropsT, snapshot: Snapshot?): StateT","com.squareup.workflow1.SessionWorkflow.initialState"]},{"name":"override fun run(): Flow","description":"com.squareup.workflow1.LifecycleWorker.run","location":"workflow-core/com.squareup.workflow1/-lifecycle-worker/run.html","searchKeys":["run","override fun run(): Flow","com.squareup.workflow1.LifecycleWorker.run"]},{"name":"sealed class WorkflowIdentifierType","description":"com.squareup.workflow1.WorkflowIdentifierType","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/index.html","searchKeys":["WorkflowIdentifierType","sealed class WorkflowIdentifierType","com.squareup.workflow1.WorkflowIdentifierType"]},{"name":"val KClass>.workflowIdentifier: WorkflowIdentifier","description":"com.squareup.workflow1.workflowIdentifier","location":"workflow-core/com.squareup.workflow1/workflow-identifier.html","searchKeys":["workflowIdentifier","val KClass>.workflowIdentifier: WorkflowIdentifier","com.squareup.workflow1.workflowIdentifier"]},{"name":"val Workflow<*, *, *>.computedIdentifier: WorkflowIdentifier","description":"com.squareup.workflow1.computedIdentifier","location":"workflow-core/com.squareup.workflow1/computed-identifier.html","searchKeys":["computedIdentifier","val Workflow<*, *, *>.computedIdentifier: WorkflowIdentifier","com.squareup.workflow1.computedIdentifier"]},{"name":"val Workflow<*, *, *>.identifier: WorkflowIdentifier","description":"com.squareup.workflow1.identifier","location":"workflow-core/com.squareup.workflow1/identifier.html","searchKeys":["identifier","val Workflow<*, *, *>.identifier: WorkflowIdentifier","com.squareup.workflow1.identifier"]},{"name":"val bytes: ByteString","description":"com.squareup.workflow1.Snapshot.bytes","location":"workflow-core/com.squareup.workflow1/-snapshot/bytes.html","searchKeys":["bytes","val bytes: ByteString","com.squareup.workflow1.Snapshot.bytes"]},{"name":"val kClass: KClass<*>? = null","description":"com.squareup.workflow1.WorkflowIdentifierType.Snapshottable.kClass","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/-snapshottable/k-class.html","searchKeys":["kClass","val kClass: KClass<*>? = null","com.squareup.workflow1.WorkflowIdentifierType.Snapshottable.kClass"]},{"name":"val kType: KType","description":"com.squareup.workflow1.WorkflowIdentifierType.Unsnapshottable.kType","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/-unsnapshottable/k-type.html","searchKeys":["kType","val kType: KType","com.squareup.workflow1.WorkflowIdentifierType.Unsnapshottable.kType"]},{"name":"val output: WorkflowOutput?","description":"com.squareup.workflow1.ActionApplied.output","location":"workflow-core/com.squareup.workflow1/-action-applied/output.html","searchKeys":["output","val output: WorkflowOutput?","com.squareup.workflow1.ActionApplied.output"]},{"name":"val props: PropsT","description":"com.squareup.workflow1.WorkflowAction.Updater.props","location":"workflow-core/com.squareup.workflow1/-workflow-action/-updater/props.html","searchKeys":["props","val props: PropsT","com.squareup.workflow1.WorkflowAction.Updater.props"]},{"name":"val stateChanged: Boolean = false","description":"com.squareup.workflow1.ActionApplied.stateChanged","location":"workflow-core/com.squareup.workflow1/-action-applied/state-changed.html","searchKeys":["stateChanged","val stateChanged: Boolean = false","com.squareup.workflow1.ActionApplied.stateChanged"]},{"name":"val value: OutputT","description":"com.squareup.workflow1.WorkflowOutput.value","location":"workflow-core/com.squareup.workflow1/-workflow-output/value.html","searchKeys":["value","val value: OutputT","com.squareup.workflow1.WorkflowOutput.value"]},{"name":"var state: StateT","description":"com.squareup.workflow1.WorkflowAction.Updater.state","location":"workflow-core/com.squareup.workflow1/-workflow-action/-updater/state.html","searchKeys":["state","var state: StateT","com.squareup.workflow1.WorkflowAction.Updater.state"]},{"name":"First","description":"com.squareup.workflow1.ui.navigation.BackStackConfig.First","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-config/-first/index.html","searchKeys":["First","First","com.squareup.workflow1.ui.navigation.BackStackConfig.First"]},{"name":"NEGATIVE","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Button.NEGATIVE","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-button/-n-e-g-a-t-i-v-e/index.html","searchKeys":["NEGATIVE","NEGATIVE","com.squareup.workflow1.ui.navigation.AlertOverlay.Button.NEGATIVE"]},{"name":"NEUTRAL","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Button.NEUTRAL","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-button/-n-e-u-t-r-a-l/index.html","searchKeys":["NEUTRAL","NEUTRAL","com.squareup.workflow1.ui.navigation.AlertOverlay.Button.NEUTRAL"]},{"name":"None","description":"com.squareup.workflow1.ui.navigation.BackStackConfig.None","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-config/-none/index.html","searchKeys":["None","None","com.squareup.workflow1.ui.navigation.BackStackConfig.None"]},{"name":"Other","description":"com.squareup.workflow1.ui.navigation.BackStackConfig.Other","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-config/-other/index.html","searchKeys":["Other","Other","com.squareup.workflow1.ui.navigation.BackStackConfig.Other"]},{"name":"POSITIVE","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Button.POSITIVE","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-button/-p-o-s-i-t-i-v-e/index.html","searchKeys":["POSITIVE","POSITIVE","com.squareup.workflow1.ui.navigation.AlertOverlay.Button.POSITIVE"]},{"name":"abstract class ViewEnvironmentKey","description":"com.squareup.workflow1.ui.ViewEnvironmentKey","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment-key/index.html","searchKeys":["ViewEnvironmentKey","abstract class ViewEnvironmentKey","com.squareup.workflow1.ui.ViewEnvironmentKey"]},{"name":"abstract fun map(transform: (C) -> D): Container","description":"com.squareup.workflow1.ui.Container.map","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-container/map.html","searchKeys":["map","abstract fun map(transform: (C) -> D): Container","com.squareup.workflow1.ui.Container.map"]},{"name":"abstract fun getEntryFor(renderingType: KClass): ViewRegistry.Entry?","description":"com.squareup.workflow1.ui.ViewRegistry.getEntryFor","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/get-entry-for.html","searchKeys":["getEntryFor","abstract fun getEntryFor(renderingType: KClass): ViewRegistry.Entry?","com.squareup.workflow1.ui.ViewRegistry.getEntryFor"]},{"name":"abstract fun asSequence(): Sequence","description":"com.squareup.workflow1.ui.Container.asSequence","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-container/as-sequence.html","searchKeys":["asSequence","abstract fun asSequence(): Sequence","com.squareup.workflow1.ui.Container.asSequence"]},{"name":"abstract override fun map(transform: (ContentT) -> ContentU): ScreenOverlay","description":"com.squareup.workflow1.ui.navigation.ScreenOverlay.map","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-screen-overlay/map.html","searchKeys":["map","abstract override fun map(transform: (ContentT) -> ContentU): ScreenOverlay","com.squareup.workflow1.ui.navigation.ScreenOverlay.map"]},{"name":"abstract override fun map(transform: (C) -> D): Wrapper","description":"com.squareup.workflow1.ui.Wrapper.map","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-wrapper/map.html","searchKeys":["map","abstract override fun map(transform: (C) -> D): Wrapper","com.squareup.workflow1.ui.Wrapper.map"]},{"name":"abstract override val content: ContentT","description":"com.squareup.workflow1.ui.navigation.ScreenOverlay.content","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-screen-overlay/content.html","searchKeys":["content","abstract override val content: ContentT","com.squareup.workflow1.ui.navigation.ScreenOverlay.content"]},{"name":"abstract val compatibilityKey: String","description":"com.squareup.workflow1.ui.Compatible.compatibilityKey","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-compatible/compatibility-key.html","searchKeys":["compatibilityKey","abstract val compatibilityKey: String","com.squareup.workflow1.ui.Compatible.compatibilityKey"]},{"name":"abstract val content: C","description":"com.squareup.workflow1.ui.Wrapper.content","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-wrapper/content.html","searchKeys":["content","abstract val content: C","com.squareup.workflow1.ui.Wrapper.content"]},{"name":"abstract val default: T","description":"com.squareup.workflow1.ui.ViewEnvironmentKey.default","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment-key/default.html","searchKeys":["default","abstract val default: T","com.squareup.workflow1.ui.ViewEnvironmentKey.default"]},{"name":"abstract val keys: Set>","description":"com.squareup.workflow1.ui.ViewRegistry.keys","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/keys.html","searchKeys":["keys","abstract val keys: Set>","com.squareup.workflow1.ui.ViewRegistry.keys"]},{"name":"abstract val onTextChanged: Flow","description":"com.squareup.workflow1.ui.TextController.onTextChanged","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-text-controller/on-text-changed.html","searchKeys":["onTextChanged","abstract val onTextChanged: Flow","com.squareup.workflow1.ui.TextController.onTextChanged"]},{"name":"abstract val type: KClass","description":"com.squareup.workflow1.ui.ViewRegistry.Entry.type","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-entry/type.html","searchKeys":["type","abstract val type: KClass","com.squareup.workflow1.ui.ViewRegistry.Entry.type"]},{"name":"abstract var textValue: String","description":"com.squareup.workflow1.ui.TextController.textValue","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-text-controller/text-value.html","searchKeys":["textValue","abstract var textValue: String","com.squareup.workflow1.ui.TextController.textValue"]},{"name":"annotation class WorkflowUiExperimentalApi","description":"com.squareup.workflow1.ui.WorkflowUiExperimentalApi","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-workflow-ui-experimental-api/index.html","searchKeys":["WorkflowUiExperimentalApi","annotation class WorkflowUiExperimentalApi","com.squareup.workflow1.ui.WorkflowUiExperimentalApi"]},{"name":"class BackStackScreen : Screen, Container ","description":"com.squareup.workflow1.ui.navigation.BackStackScreen","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/index.html","searchKeys":["BackStackScreen","class BackStackScreen : Screen, Container ","com.squareup.workflow1.ui.navigation.BackStackScreen"]},{"name":"class BodyAndOverlaysScreen(val body: B, val overlays: List = emptyList(), val name: String = \"\") : Screen, Compatible","description":"com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/index.html","searchKeys":["BodyAndOverlaysScreen","class BodyAndOverlaysScreen(val body: B, val overlays: List = emptyList(), val name: String = \"\") : Screen, Compatible","com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen"]},{"name":"class EnvironmentScreen(val content: C, val environment: ViewEnvironment = ViewEnvironment.EMPTY) : Wrapper , Screen","description":"com.squareup.workflow1.ui.EnvironmentScreen","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-environment-screen/index.html","searchKeys":["EnvironmentScreen","class EnvironmentScreen(val content: C, val environment: ViewEnvironment = ViewEnvironment.EMPTY) : Wrapper , Screen","com.squareup.workflow1.ui.EnvironmentScreen"]},{"name":"class FullScreenModal(val content: C) : ScreenOverlay , ModalOverlay","description":"com.squareup.workflow1.ui.navigation.FullScreenModal","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-full-screen-modal/index.html","searchKeys":["FullScreenModal","class FullScreenModal(val content: C) : ScreenOverlay , ModalOverlay","com.squareup.workflow1.ui.navigation.FullScreenModal"]},{"name":"class ViewEnvironment","description":"com.squareup.workflow1.ui.ViewEnvironment","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/index.html","searchKeys":["ViewEnvironment","class ViewEnvironment","com.squareup.workflow1.ui.ViewEnvironment"]},{"name":"constructor()","description":"com.squareup.workflow1.ui.ViewEnvironmentKey.ViewEnvironmentKey","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment-key/-view-environment-key.html","searchKeys":["ViewEnvironmentKey","constructor()","com.squareup.workflow1.ui.ViewEnvironmentKey.ViewEnvironmentKey"]},{"name":"constructor(body: B, overlays: List = emptyList(), name: String = \"\")","description":"com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.BodyAndOverlaysScreen","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/-body-and-overlays-screen.html","searchKeys":["BodyAndOverlaysScreen","constructor(body: B, overlays: List = emptyList(), name: String = \"\")","com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.BodyAndOverlaysScreen"]},{"name":"constructor(bottom: StackedT, vararg rest: StackedT)","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.BackStackScreen","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/-back-stack-screen.html","searchKeys":["BackStackScreen","constructor(bottom: StackedT, vararg rest: StackedT)","com.squareup.workflow1.ui.navigation.BackStackScreen.BackStackScreen"]},{"name":"constructor(button: AlertOverlay.Button)","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Event.ButtonClicked.ButtonClicked","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-event/-button-clicked/-button-clicked.html","searchKeys":["ButtonClicked","constructor(button: AlertOverlay.Button)","com.squareup.workflow1.ui.navigation.AlertOverlay.Event.ButtonClicked.ButtonClicked"]},{"name":"constructor(buttons: Map = emptyMap(), message: String = \"\", title: String = \"\", cancelable: Boolean = true, onEvent: (AlertOverlay.Event) -> Unit)","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.AlertOverlay","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-alert-overlay.html","searchKeys":["AlertOverlay","constructor(buttons: Map = emptyMap(), message: String = \"\", title: String = \"\", cancelable: Boolean = true, onEvent: (AlertOverlay.Event) -> Unit)","com.squareup.workflow1.ui.navigation.AlertOverlay.AlertOverlay"]},{"name":"constructor(content: C)","description":"com.squareup.workflow1.ui.navigation.FullScreenModal.FullScreenModal","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-full-screen-modal/-full-screen-modal.html","searchKeys":["FullScreenModal","constructor(content: C)","com.squareup.workflow1.ui.navigation.FullScreenModal.FullScreenModal"]},{"name":"constructor(content: C, environment: ViewEnvironment = ViewEnvironment.EMPTY)","description":"com.squareup.workflow1.ui.EnvironmentScreen.EnvironmentScreen","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-environment-screen/-environment-screen.html","searchKeys":["EnvironmentScreen","constructor(content: C, environment: ViewEnvironment = ViewEnvironment.EMPTY)","com.squareup.workflow1.ui.EnvironmentScreen.EnvironmentScreen"]},{"name":"constructor(content: C, name: String)","description":"com.squareup.workflow1.ui.NamedScreen.NamedScreen","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-named-screen/-named-screen.html","searchKeys":["NamedScreen","constructor(content: C, name: String)","com.squareup.workflow1.ui.NamedScreen.NamedScreen"]},{"name":"data class AlertOverlay(val buttons: Map = emptyMap(), val message: String = \"\", val title: String = \"\", val cancelable: Boolean = true, val onEvent: (AlertOverlay.Event) -> Unit) : ModalOverlay","description":"com.squareup.workflow1.ui.navigation.AlertOverlay","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/index.html","searchKeys":["AlertOverlay","data class AlertOverlay(val buttons: Map = emptyMap(), val message: String = \"\", val title: String = \"\", val cancelable: Boolean = true, val onEvent: (AlertOverlay.Event) -> Unit) : ModalOverlay","com.squareup.workflow1.ui.navigation.AlertOverlay"]},{"name":"data class ButtonClicked(val button: AlertOverlay.Button) : AlertOverlay.Event","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Event.ButtonClicked","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-event/-button-clicked/index.html","searchKeys":["ButtonClicked","data class ButtonClicked(val button: AlertOverlay.Button) : AlertOverlay.Event","com.squareup.workflow1.ui.navigation.AlertOverlay.Event.ButtonClicked"]},{"name":"data class NamedScreen(val content: C, val name: String) : Screen, Wrapper ","description":"com.squareup.workflow1.ui.NamedScreen","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-named-screen/index.html","searchKeys":["NamedScreen","data class NamedScreen(val content: C, val name: String) : Screen, Wrapper ","com.squareup.workflow1.ui.NamedScreen"]},{"name":"enum BackStackConfig : Enum ","description":"com.squareup.workflow1.ui.navigation.BackStackConfig","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-config/index.html","searchKeys":["BackStackConfig","enum BackStackConfig : Enum ","com.squareup.workflow1.ui.navigation.BackStackConfig"]},{"name":"enum Button : Enum ","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Button","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-button/index.html","searchKeys":["Button","enum Button : Enum ","com.squareup.workflow1.ui.navigation.AlertOverlay.Button"]},{"name":"fun mapOverlays(transform: (O) -> N): BodyAndOverlaysScreen","description":"com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.mapOverlays","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/map-overlays.html","searchKeys":["mapOverlays","fun mapOverlays(transform: (O) -> N): BodyAndOverlaysScreen","com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.mapOverlays"]},{"name":"fun mapIndexed(transform: (index: Int, StackedT) -> R): BackStackScreen","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.mapIndexed","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/map-indexed.html","searchKeys":["mapIndexed","fun mapIndexed(transform: (index: Int, StackedT) -> R): BackStackScreen","com.squareup.workflow1.ui.navigation.BackStackScreen.mapIndexed"]},{"name":"fun mapBody(transform: (B) -> S): BodyAndOverlaysScreen","description":"com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.mapBody","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/map-body.html","searchKeys":["mapBody","fun mapBody(transform: (B) -> S): BodyAndOverlaysScreen","com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.mapBody"]},{"name":"fun List.toBackStackScreen(): BackStackScreen","description":"com.squareup.workflow1.ui.navigation.toBackStackScreen","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/to-back-stack-screen.html","searchKeys":["toBackStackScreen","fun List.toBackStackScreen(): BackStackScreen","com.squareup.workflow1.ui.navigation.toBackStackScreen"]},{"name":"fun List.toBackStackScreenOrNull(): BackStackScreen?","description":"com.squareup.workflow1.ui.navigation.toBackStackScreenOrNull","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/to-back-stack-screen-or-null.html","searchKeys":["toBackStackScreenOrNull","fun List.toBackStackScreenOrNull(): BackStackScreen?","com.squareup.workflow1.ui.navigation.toBackStackScreenOrNull"]},{"name":"fun fromList(frames: List): BackStackScreen","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.Companion.fromList","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/-companion/from-list.html","searchKeys":["fromList","fun fromList(frames: List): BackStackScreen","com.squareup.workflow1.ui.navigation.BackStackScreen.Companion.fromList"]},{"name":"fun fromListOrNull(frames: List): BackStackScreen?","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.Companion.fromListOrNull","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/-companion/from-list-or-null.html","searchKeys":["fromListOrNull","fun fromListOrNull(frames: List): BackStackScreen?","com.squareup.workflow1.ui.navigation.BackStackScreen.Companion.fromListOrNull"]},{"name":"fun Screen.withEnvironment(environment: ViewEnvironment = ViewEnvironment.EMPTY): EnvironmentScreen<*>","description":"com.squareup.workflow1.ui.withEnvironment","location":"workflow-ui/core-common/com.squareup.workflow1.ui/with-environment.html","searchKeys":["withEnvironment","fun Screen.withEnvironment(environment: ViewEnvironment = ViewEnvironment.EMPTY): EnvironmentScreen<*>","com.squareup.workflow1.ui.withEnvironment"]},{"name":"fun Screen.withRegistry(viewRegistry: ViewRegistry): EnvironmentScreen<*>","description":"com.squareup.workflow1.ui.withRegistry","location":"workflow-ui/core-common/com.squareup.workflow1.ui/with-registry.html","searchKeys":["withRegistry","fun Screen.withRegistry(viewRegistry: ViewRegistry): EnvironmentScreen<*>","com.squareup.workflow1.ui.withRegistry"]},{"name":"fun TextController(initialValue: String = \"\"): TextController","description":"com.squareup.workflow1.ui.TextController","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-text-controller.html","searchKeys":["TextController","fun TextController(initialValue: String = \"\"): TextController","com.squareup.workflow1.ui.TextController"]},{"name":"fun ViewRegistry(): ViewRegistry","description":"com.squareup.workflow1.ui.ViewRegistry","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry.html","searchKeys":["ViewRegistry","fun ViewRegistry(): ViewRegistry","com.squareup.workflow1.ui.ViewRegistry"]},{"name":"fun ViewRegistry(vararg bindings: ViewRegistry.Entry<*>): ViewRegistry","description":"com.squareup.workflow1.ui.ViewRegistry","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry.html","searchKeys":["ViewRegistry","fun ViewRegistry(vararg bindings: ViewRegistry.Entry<*>): ViewRegistry","com.squareup.workflow1.ui.ViewRegistry"]},{"name":"fun compatible(me: Any, you: Any): Boolean","description":"com.squareup.workflow1.ui.compatible","location":"workflow-ui/core-common/com.squareup.workflow1.ui/compatible.html","searchKeys":["compatible","fun compatible(me: Any, you: Any): Boolean","com.squareup.workflow1.ui.compatible"]},{"name":"fun keyFor(value: Any, name: String = \"\"): String","description":"com.squareup.workflow1.ui.Compatible.Companion.keyFor","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-compatible/-companion/key-for.html","searchKeys":["keyFor","fun keyFor(value: Any, name: String = \"\"): String","com.squareup.workflow1.ui.Compatible.Companion.keyFor"]},{"name":"fun valueOf(value: String): AlertOverlay.Button","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Button.valueOf","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-button/value-of.html","searchKeys":["valueOf","fun valueOf(value: String): AlertOverlay.Button","com.squareup.workflow1.ui.navigation.AlertOverlay.Button.valueOf"]},{"name":"fun valueOf(value: String): BackStackConfig","description":"com.squareup.workflow1.ui.navigation.BackStackConfig.valueOf","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-config/value-of.html","searchKeys":["valueOf","fun valueOf(value: String): BackStackConfig","com.squareup.workflow1.ui.navigation.BackStackConfig.valueOf"]},{"name":"fun values(): Array","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Button.values","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-button/values.html","searchKeys":["values","fun values(): Array","com.squareup.workflow1.ui.navigation.AlertOverlay.Button.values"]},{"name":"fun values(): Array","description":"com.squareup.workflow1.ui.navigation.BackStackConfig.values","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-config/values.html","searchKeys":["values","fun values(): Array","com.squareup.workflow1.ui.navigation.BackStackConfig.values"]},{"name":"infix fun ViewRegistry.merge(other: ViewRegistry): ViewRegistry","description":"com.squareup.workflow1.ui.merge","location":"workflow-ui/core-common/com.squareup.workflow1.ui/merge.html","searchKeys":["merge","infix fun ViewRegistry.merge(other: ViewRegistry): ViewRegistry","com.squareup.workflow1.ui.merge"]},{"name":"inline operator fun ViewRegistry.get(renderingType: KClass): ViewRegistry.Entry?","description":"com.squareup.workflow1.ui.get","location":"workflow-ui/core-common/com.squareup.workflow1.ui/get.html","searchKeys":["get","inline operator fun ViewRegistry.get(renderingType: KClass): ViewRegistry.Entry?","com.squareup.workflow1.ui.get"]},{"name":"interface Compatible","description":"com.squareup.workflow1.ui.Compatible","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-compatible/index.html","searchKeys":["Compatible","interface Compatible","com.squareup.workflow1.ui.Compatible"]},{"name":"interface Container","description":"com.squareup.workflow1.ui.Container","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-container/index.html","searchKeys":["Container","interface Container","com.squareup.workflow1.ui.Container"]},{"name":"interface Entry","description":"com.squareup.workflow1.ui.ViewRegistry.Entry","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-entry/index.html","searchKeys":["Entry","interface Entry","com.squareup.workflow1.ui.ViewRegistry.Entry"]},{"name":"interface ModalOverlay : Overlay","description":"com.squareup.workflow1.ui.navigation.ModalOverlay","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-modal-overlay/index.html","searchKeys":["ModalOverlay","interface ModalOverlay : Overlay","com.squareup.workflow1.ui.navigation.ModalOverlay"]},{"name":"interface Overlay","description":"com.squareup.workflow1.ui.navigation.Overlay","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-overlay/index.html","searchKeys":["Overlay","interface Overlay","com.squareup.workflow1.ui.navigation.Overlay"]},{"name":"interface Screen","description":"com.squareup.workflow1.ui.Screen","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-screen/index.html","searchKeys":["Screen","interface Screen","com.squareup.workflow1.ui.Screen"]},{"name":"interface ScreenOverlay : Overlay, Wrapper ","description":"com.squareup.workflow1.ui.navigation.ScreenOverlay","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-screen-overlay/index.html","searchKeys":["ScreenOverlay","interface ScreenOverlay : Overlay, Wrapper ","com.squareup.workflow1.ui.navigation.ScreenOverlay"]},{"name":"interface TextController","description":"com.squareup.workflow1.ui.TextController","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-text-controller/index.html","searchKeys":["TextController","interface TextController","com.squareup.workflow1.ui.TextController"]},{"name":"interface ViewRegistry","description":"com.squareup.workflow1.ui.ViewRegistry","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/index.html","searchKeys":["ViewRegistry","interface ViewRegistry","com.squareup.workflow1.ui.ViewRegistry"]},{"name":"interface Wrapper : Container , Compatible","description":"com.squareup.workflow1.ui.Wrapper","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-wrapper/index.html","searchKeys":["Wrapper","interface Wrapper : Container , Compatible","com.squareup.workflow1.ui.Wrapper"]},{"name":"object Canceled : AlertOverlay.Event","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Event.Canceled","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-event/-canceled/index.html","searchKeys":["Canceled","object Canceled : AlertOverlay.Event","com.squareup.workflow1.ui.navigation.AlertOverlay.Event.Canceled"]},{"name":"object Companion","description":"com.squareup.workflow1.ui.Compatible.Companion","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-compatible/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.ui.Compatible.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.ui.ViewEnvironment.Companion","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.ui.ViewEnvironment.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.Companion","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.ui.navigation.BackStackScreen.Companion"]},{"name":"object Companion : ViewEnvironmentKey ","description":"com.squareup.workflow1.ui.navigation.BackStackConfig.Companion","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-config/-companion/index.html","searchKeys":["Companion","object Companion : ViewEnvironmentKey ","com.squareup.workflow1.ui.navigation.BackStackConfig.Companion"]},{"name":"object Companion : ViewEnvironmentKey ","description":"com.squareup.workflow1.ui.ViewRegistry.Companion","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-companion/index.html","searchKeys":["Companion","object Companion : ViewEnvironmentKey ","com.squareup.workflow1.ui.ViewRegistry.Companion"]},{"name":"open fun combine(left: T, right: T): T","description":"com.squareup.workflow1.ui.ViewEnvironmentKey.combine","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment-key/combine.html","searchKeys":["combine","open fun combine(left: T, right: T): T","com.squareup.workflow1.ui.ViewEnvironmentKey.combine"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.ui.ViewEnvironment.equals","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.ui.ViewEnvironment.equals"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.equals","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.ui.navigation.AlertOverlay.equals"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.equals","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.ui.navigation.BackStackScreen.equals"]},{"name":"open override fun map(transform: (C) -> D): EnvironmentScreen","description":"com.squareup.workflow1.ui.EnvironmentScreen.map","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-environment-screen/map.html","searchKeys":["map","open override fun map(transform: (C) -> D): EnvironmentScreen","com.squareup.workflow1.ui.EnvironmentScreen.map"]},{"name":"open override fun map(transform: (C) -> D): FullScreenModal","description":"com.squareup.workflow1.ui.navigation.FullScreenModal.map","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-full-screen-modal/map.html","searchKeys":["map","open override fun map(transform: (C) -> D): FullScreenModal","com.squareup.workflow1.ui.navigation.FullScreenModal.map"]},{"name":"open override fun map(transform: (C) -> D): NamedScreen","description":"com.squareup.workflow1.ui.NamedScreen.map","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-named-screen/map.html","searchKeys":["map","open override fun map(transform: (C) -> D): NamedScreen","com.squareup.workflow1.ui.NamedScreen.map"]},{"name":"open override fun map(transform: (StackedT) -> StackedU): BackStackScreen","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.map","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/map.html","searchKeys":["map","open override fun map(transform: (StackedT) -> StackedU): BackStackScreen","com.squareup.workflow1.ui.navigation.BackStackScreen.map"]},{"name":"open override fun asSequence(): Sequence","description":"com.squareup.workflow1.ui.Wrapper.asSequence","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-wrapper/as-sequence.html","searchKeys":["asSequence","open override fun asSequence(): Sequence","com.squareup.workflow1.ui.Wrapper.asSequence"]},{"name":"open override fun asSequence(): Sequence","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.asSequence","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/as-sequence.html","searchKeys":["asSequence","open override fun asSequence(): Sequence","com.squareup.workflow1.ui.navigation.BackStackScreen.asSequence"]},{"name":"open override fun combine(left: ViewRegistry, right: ViewRegistry): ViewRegistry","description":"com.squareup.workflow1.ui.ViewRegistry.Companion.combine","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-companion/combine.html","searchKeys":["combine","open override fun combine(left: ViewRegistry, right: ViewRegistry): ViewRegistry","com.squareup.workflow1.ui.ViewRegistry.Companion.combine"]},{"name":"open override fun hashCode(): Int","description":"com.squareup.workflow1.ui.ViewEnvironment.hashCode","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","com.squareup.workflow1.ui.ViewEnvironment.hashCode"]},{"name":"open override fun hashCode(): Int","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.hashCode","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","com.squareup.workflow1.ui.navigation.AlertOverlay.hashCode"]},{"name":"open override fun hashCode(): Int","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.hashCode","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","com.squareup.workflow1.ui.navigation.BackStackScreen.hashCode"]},{"name":"open override fun toString(): String","description":"com.squareup.workflow1.ui.NamedScreen.toString","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-named-screen/to-string.html","searchKeys":["toString","open override fun toString(): String","com.squareup.workflow1.ui.NamedScreen.toString"]},{"name":"open override fun toString(): String","description":"com.squareup.workflow1.ui.ViewEnvironment.toString","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/to-string.html","searchKeys":["toString","open override fun toString(): String","com.squareup.workflow1.ui.ViewEnvironment.toString"]},{"name":"open override fun toString(): String","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.toString","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/to-string.html","searchKeys":["toString","open override fun toString(): String","com.squareup.workflow1.ui.navigation.BackStackScreen.toString"]},{"name":"open override val compatibilityKey: String","description":"com.squareup.workflow1.ui.NamedScreen.compatibilityKey","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-named-screen/compatibility-key.html","searchKeys":["compatibilityKey","open override val compatibilityKey: String","com.squareup.workflow1.ui.NamedScreen.compatibilityKey"]},{"name":"open override val compatibilityKey: String","description":"com.squareup.workflow1.ui.Wrapper.compatibilityKey","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-wrapper/compatibility-key.html","searchKeys":["compatibilityKey","open override val compatibilityKey: String","com.squareup.workflow1.ui.Wrapper.compatibilityKey"]},{"name":"open override val compatibilityKey: String","description":"com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.compatibilityKey","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/compatibility-key.html","searchKeys":["compatibilityKey","open override val compatibilityKey: String","com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.compatibilityKey"]},{"name":"open override val content: C","description":"com.squareup.workflow1.ui.EnvironmentScreen.content","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-environment-screen/content.html","searchKeys":["content","open override val content: C","com.squareup.workflow1.ui.EnvironmentScreen.content"]},{"name":"open override val content: C","description":"com.squareup.workflow1.ui.NamedScreen.content","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-named-screen/content.html","searchKeys":["content","open override val content: C","com.squareup.workflow1.ui.NamedScreen.content"]},{"name":"open override val content: C","description":"com.squareup.workflow1.ui.navigation.FullScreenModal.content","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-full-screen-modal/content.html","searchKeys":["content","open override val content: C","com.squareup.workflow1.ui.navigation.FullScreenModal.content"]},{"name":"open override val default: BackStackConfig","description":"com.squareup.workflow1.ui.navigation.BackStackConfig.Companion.default","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-config/-companion/default.html","searchKeys":["default","open override val default: BackStackConfig","com.squareup.workflow1.ui.navigation.BackStackConfig.Companion.default"]},{"name":"open override val default: ViewRegistry","description":"com.squareup.workflow1.ui.ViewRegistry.Companion.default","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-companion/default.html","searchKeys":["default","open override val default: ViewRegistry","com.squareup.workflow1.ui.ViewRegistry.Companion.default"]},{"name":"operator fun get(key: ViewEnvironmentKey): T","description":"com.squareup.workflow1.ui.ViewEnvironment.get","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/get.html","searchKeys":["get","operator fun get(key: ViewEnvironmentKey): T","com.squareup.workflow1.ui.ViewEnvironment.get"]},{"name":"operator fun plus(pair: Pair, T>): ViewEnvironment","description":"com.squareup.workflow1.ui.ViewEnvironment.plus","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/plus.html","searchKeys":["plus","operator fun plus(pair: Pair, T>): ViewEnvironment","com.squareup.workflow1.ui.ViewEnvironment.plus"]},{"name":"operator fun BackStackScreen.plus(other: BackStackScreen?): BackStackScreen","description":"com.squareup.workflow1.ui.navigation.plus","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/plus.html","searchKeys":["plus","operator fun BackStackScreen.plus(other: BackStackScreen?): BackStackScreen","com.squareup.workflow1.ui.navigation.plus"]},{"name":"operator fun ViewEnvironment.plus(config: BackStackConfig): ViewEnvironment","description":"com.squareup.workflow1.ui.navigation.plus","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/plus.html","searchKeys":["plus","operator fun ViewEnvironment.plus(config: BackStackConfig): ViewEnvironment","com.squareup.workflow1.ui.navigation.plus"]},{"name":"operator fun ViewEnvironment.plus(registry: ViewRegistry): ViewEnvironment","description":"com.squareup.workflow1.ui.plus","location":"workflow-ui/core-common/com.squareup.workflow1.ui/plus.html","searchKeys":["plus","operator fun ViewEnvironment.plus(registry: ViewRegistry): ViewEnvironment","com.squareup.workflow1.ui.plus"]},{"name":"operator fun ViewRegistry.plus(entry: ViewRegistry.Entry<*>): ViewRegistry","description":"com.squareup.workflow1.ui.plus","location":"workflow-ui/core-common/com.squareup.workflow1.ui/plus.html","searchKeys":["plus","operator fun ViewRegistry.plus(entry: ViewRegistry.Entry<*>): ViewRegistry","com.squareup.workflow1.ui.plus"]},{"name":"operator fun ViewRegistry.plus(other: ViewRegistry): ViewRegistry","description":"com.squareup.workflow1.ui.plus","location":"workflow-ui/core-common/com.squareup.workflow1.ui/plus.html","searchKeys":["plus","operator fun ViewRegistry.plus(other: ViewRegistry): ViewRegistry","com.squareup.workflow1.ui.plus"]},{"name":"operator fun get(index: Int): StackedT","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.get","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/get.html","searchKeys":["get","operator fun get(index: Int): StackedT","com.squareup.workflow1.ui.navigation.BackStackScreen.get"]},{"name":"operator fun plus(other: ViewEnvironment): ViewEnvironment","description":"com.squareup.workflow1.ui.ViewEnvironment.plus","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/plus.html","searchKeys":["plus","operator fun plus(other: ViewEnvironment): ViewEnvironment","com.squareup.workflow1.ui.ViewEnvironment.plus"]},{"name":"operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.ui.ViewEnvironmentKey.equals","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment-key/equals.html","searchKeys":["equals","operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.ui.ViewEnvironmentKey.equals"]},{"name":"override fun hashCode(): Int","description":"com.squareup.workflow1.ui.ViewEnvironmentKey.hashCode","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment-key/hash-code.html","searchKeys":["hashCode","override fun hashCode(): Int","com.squareup.workflow1.ui.ViewEnvironmentKey.hashCode"]},{"name":"sealed class Event","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Event","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-event/index.html","searchKeys":["Event","sealed class Event","com.squareup.workflow1.ui.navigation.AlertOverlay.Event"]},{"name":"val EMPTY: ViewEnvironment","description":"com.squareup.workflow1.ui.ViewEnvironment.Companion.EMPTY","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/-companion/-e-m-p-t-y.html","searchKeys":["EMPTY","val EMPTY: ViewEnvironment","com.squareup.workflow1.ui.ViewEnvironment.Companion.EMPTY"]},{"name":"val backStack: List","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.backStack","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/back-stack.html","searchKeys":["backStack","val backStack: List","com.squareup.workflow1.ui.navigation.BackStackScreen.backStack"]},{"name":"val body: B","description":"com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.body","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/body.html","searchKeys":["body","val body: B","com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.body"]},{"name":"val button: AlertOverlay.Button","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Event.ButtonClicked.button","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-event/-button-clicked/button.html","searchKeys":["button","val button: AlertOverlay.Button","com.squareup.workflow1.ui.navigation.AlertOverlay.Event.ButtonClicked.button"]},{"name":"val buttons: Map","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.buttons","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/buttons.html","searchKeys":["buttons","val buttons: Map","com.squareup.workflow1.ui.navigation.AlertOverlay.buttons"]},{"name":"val cancelable: Boolean = true","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.cancelable","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/cancelable.html","searchKeys":["cancelable","val cancelable: Boolean = true","com.squareup.workflow1.ui.navigation.AlertOverlay.cancelable"]},{"name":"val entries: EnumEntries","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Button.entries","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-button/entries.html","searchKeys":["entries","val entries: EnumEntries","com.squareup.workflow1.ui.navigation.AlertOverlay.Button.entries"]},{"name":"val entries: EnumEntries","description":"com.squareup.workflow1.ui.navigation.BackStackConfig.entries","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-config/entries.html","searchKeys":["entries","val entries: EnumEntries","com.squareup.workflow1.ui.navigation.BackStackConfig.entries"]},{"name":"val environment: ViewEnvironment","description":"com.squareup.workflow1.ui.EnvironmentScreen.environment","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-environment-screen/environment.html","searchKeys":["environment","val environment: ViewEnvironment","com.squareup.workflow1.ui.EnvironmentScreen.environment"]},{"name":"val frames: List","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.frames","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/frames.html","searchKeys":["frames","val frames: List","com.squareup.workflow1.ui.navigation.BackStackScreen.frames"]},{"name":"val map: Map, Any>","description":"com.squareup.workflow1.ui.ViewEnvironment.map","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/map.html","searchKeys":["map","val map: Map, Any>","com.squareup.workflow1.ui.ViewEnvironment.map"]},{"name":"val message: String","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.message","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/message.html","searchKeys":["message","val message: String","com.squareup.workflow1.ui.navigation.AlertOverlay.message"]},{"name":"val name: String","description":"com.squareup.workflow1.ui.NamedScreen.name","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-named-screen/name.html","searchKeys":["name","val name: String","com.squareup.workflow1.ui.NamedScreen.name"]},{"name":"val name: String","description":"com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.name","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/name.html","searchKeys":["name","val name: String","com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.name"]},{"name":"val onEvent: (AlertOverlay.Event) -> Unit","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.onEvent","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/on-event.html","searchKeys":["onEvent","val onEvent: (AlertOverlay.Event) -> Unit","com.squareup.workflow1.ui.navigation.AlertOverlay.onEvent"]},{"name":"val overlays: List","description":"com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.overlays","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/overlays.html","searchKeys":["overlays","val overlays: List","com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.overlays"]},{"name":"val title: String","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.title","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/title.html","searchKeys":["title","val title: String","com.squareup.workflow1.ui.navigation.AlertOverlay.title"]},{"name":"val top: StackedT","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.top","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/top.html","searchKeys":["top","val top: StackedT","com.squareup.workflow1.ui.navigation.BackStackScreen.top"]},{"name":"abstract fun buildDialog(initialRendering: OverlayT, initialEnvironment: ViewEnvironment, context: Context): OverlayDialogHolder","description":"com.squareup.workflow1.ui.navigation.OverlayDialogFactory.buildDialog","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/build-dialog.html","searchKeys":["buildDialog","abstract fun buildDialog(initialRendering: OverlayT, initialEnvironment: ViewEnvironment, context: Context): OverlayDialogHolder","com.squareup.workflow1.ui.navigation.OverlayDialogFactory.buildDialog"]},{"name":"abstract fun buildView(initialRendering: ScreenT, initialEnvironment: ViewEnvironment, context: Context, container: ViewGroup? = null): ScreenViewHolder","description":"com.squareup.workflow1.ui.ScreenViewFactory.buildView","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/build-view.html","searchKeys":["buildView","abstract fun buildView(initialRendering: ScreenT, initialEnvironment: ViewEnvironment, context: Context, container: ViewGroup? = null): ScreenViewHolder","com.squareup.workflow1.ui.ScreenViewFactory.buildView"]},{"name":"abstract fun destroyOnDetach()","description":"com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner.destroyOnDetach","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-lifecycle-owner/destroy-on-detach.html","searchKeys":["destroyOnDetach","abstract fun destroyOnDetach()","com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner.destroyOnDetach"]},{"name":"abstract fun showRendering(rendering: ScreenT, environment: ViewEnvironment)","description":"com.squareup.workflow1.ui.ScreenViewRunner.showRendering","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-runner/show-rendering.html","searchKeys":["showRendering","abstract fun showRendering(rendering: ScreenT, environment: ViewEnvironment)","com.squareup.workflow1.ui.ScreenViewRunner.showRendering"]},{"name":"abstract fun startView(view: View, doStart: () -> Unit)","description":"com.squareup.workflow1.ui.ViewStarter.startView","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-view-starter/start-view.html","searchKeys":["startView","abstract fun startView(view: View, doStart: () -> Unit)","com.squareup.workflow1.ui.ViewStarter.startView"]},{"name":"abstract val dialog: Dialog","description":"com.squareup.workflow1.ui.navigation.OverlayDialogHolder.dialog","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-holder/dialog.html","searchKeys":["dialog","abstract val dialog: Dialog","com.squareup.workflow1.ui.navigation.OverlayDialogHolder.dialog"]},{"name":"abstract val dialogFactory: OverlayDialogFactory","description":"com.squareup.workflow1.ui.navigation.AndroidOverlay.dialogFactory","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-android-overlay/dialog-factory.html","searchKeys":["dialogFactory","abstract val dialogFactory: OverlayDialogFactory","com.squareup.workflow1.ui.navigation.AndroidOverlay.dialogFactory"]},{"name":"abstract val environment: ViewEnvironment","description":"com.squareup.workflow1.ui.ScreenViewHolder.environment","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-holder/environment.html","searchKeys":["environment","abstract val environment: ViewEnvironment","com.squareup.workflow1.ui.ScreenViewHolder.environment"]},{"name":"abstract val environment: ViewEnvironment","description":"com.squareup.workflow1.ui.navigation.OverlayDialogHolder.environment","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-holder/environment.html","searchKeys":["environment","abstract val environment: ViewEnvironment","com.squareup.workflow1.ui.navigation.OverlayDialogHolder.environment"]},{"name":"abstract val onUpdateBounds: (Rect) -> Unit?","description":"com.squareup.workflow1.ui.navigation.OverlayDialogHolder.onUpdateBounds","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-holder/on-update-bounds.html","searchKeys":["onUpdateBounds","abstract val onUpdateBounds: (Rect) -> Unit?","com.squareup.workflow1.ui.navigation.OverlayDialogHolder.onUpdateBounds"]},{"name":"abstract val runner: (rendering: OverlayT, environment: ViewEnvironment) -> Unit","description":"com.squareup.workflow1.ui.navigation.OverlayDialogHolder.runner","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-holder/runner.html","searchKeys":["runner","abstract val runner: (rendering: OverlayT, environment: ViewEnvironment) -> Unit","com.squareup.workflow1.ui.navigation.OverlayDialogHolder.runner"]},{"name":"abstract val runner: ScreenViewRunner","description":"com.squareup.workflow1.ui.ScreenViewHolder.runner","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-holder/runner.html","searchKeys":["runner","abstract val runner: ScreenViewRunner","com.squareup.workflow1.ui.ScreenViewHolder.runner"]},{"name":"abstract val view: View","description":"com.squareup.workflow1.ui.ScreenViewHolder.view","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-holder/view.html","searchKeys":["view","abstract val view: View","com.squareup.workflow1.ui.ScreenViewHolder.view"]},{"name":"abstract val viewFactory: ScreenViewFactory","description":"com.squareup.workflow1.ui.AndroidScreen.viewFactory","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-android-screen/view-factory.html","searchKeys":["viewFactory","abstract val viewFactory: ScreenViewFactory","com.squareup.workflow1.ui.AndroidScreen.viewFactory"]},{"name":"class BackButtonScreen(val content: C, val shadow: Boolean = false, val onBackPressed: () -> Unit? = null) : Wrapper , AndroidScreen> ","description":"com.squareup.workflow1.ui.navigation.BackButtonScreen","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-button-screen/index.html","searchKeys":["BackButtonScreen","class BackButtonScreen(val content: C, val shadow: Boolean = false, val onBackPressed: () -> Unit? = null) : Wrapper , AndroidScreen> ","com.squareup.workflow1.ui.navigation.BackButtonScreen"]},{"name":"class LayeredDialogSessions","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/index.html","searchKeys":["LayeredDialogSessions","class LayeredDialogSessions","com.squareup.workflow1.ui.navigation.LayeredDialogSessions"]},{"name":"class ParcelableTextController : TextController, Parcelable","description":"com.squareup.workflow1.ui.ParcelableTextController","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-parcelable-text-controller/index.html","searchKeys":["ParcelableTextController","class ParcelableTextController : TextController, Parcelable","com.squareup.workflow1.ui.ParcelableTextController"]},{"name":"class Saved : Parcelable","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.Saved","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/-saved/index.html","searchKeys":["Saved","class Saved : Parcelable","com.squareup.workflow1.ui.navigation.ViewStateCache.Saved"]},{"name":"class SavedState : Parcelable","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/-saved-state/index.html","searchKeys":["SavedState","class SavedState : Parcelable","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState"]},{"name":"class SavedState : View.BaseSavedState","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/-saved-state/index.html","searchKeys":["SavedState","class SavedState : View.BaseSavedState","com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState"]},{"name":"class ViewStateCache","description":"com.squareup.workflow1.ui.navigation.ViewStateCache","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/index.html","searchKeys":["ViewStateCache","class ViewStateCache","com.squareup.workflow1.ui.navigation.ViewStateCache"]},{"name":"class WorkflowLayout(context: Context, attributeSet: AttributeSet? = null) : FrameLayout","description":"com.squareup.workflow1.ui.WorkflowLayout","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-layout/index.html","searchKeys":["WorkflowLayout","class WorkflowLayout(context: Context, attributeSet: AttributeSet? = null) : FrameLayout","com.squareup.workflow1.ui.WorkflowLayout"]},{"name":"class WorkflowSavedStateRegistryAggregator","description":"com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-saved-state-registry-aggregator/index.html","searchKeys":["WorkflowSavedStateRegistryAggregator","class WorkflowSavedStateRegistryAggregator","com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator"]},{"name":"class WorkflowViewStub constructor(context: Context, attributeSet: AttributeSet? = null, defStyle: Int = 0, defStyleRes: Int = 0) : View","description":"com.squareup.workflow1.ui.WorkflowViewStub","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/index.html","searchKeys":["WorkflowViewStub","class WorkflowViewStub constructor(context: Context, attributeSet: AttributeSet? = null, defStyle: Int = 0, defStyleRes: Int = 0) : View","com.squareup.workflow1.ui.WorkflowViewStub"]},{"name":"constructor()","description":"com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.WorkflowSavedStateRegistryAggregator","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-saved-state-registry-aggregator/-workflow-saved-state-registry-aggregator.html","searchKeys":["WorkflowSavedStateRegistryAggregator","constructor()","com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.WorkflowSavedStateRegistryAggregator"]},{"name":"constructor()","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.ViewStateCache","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/-view-state-cache.html","searchKeys":["ViewStateCache","constructor()","com.squareup.workflow1.ui.navigation.ViewStateCache.ViewStateCache"]},{"name":"constructor(content: C, shadow: Boolean = false, onBackPressed: () -> Unit? = null)","description":"com.squareup.workflow1.ui.navigation.BackButtonScreen.BackButtonScreen","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-button-screen/-back-button-screen.html","searchKeys":["BackButtonScreen","constructor(content: C, shadow: Boolean = false, onBackPressed: () -> Unit? = null)","com.squareup.workflow1.ui.navigation.BackButtonScreen.BackButtonScreen"]},{"name":"constructor(context: Context, attributeSet: AttributeSet? = null)","description":"com.squareup.workflow1.ui.WorkflowLayout.WorkflowLayout","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-layout/-workflow-layout.html","searchKeys":["WorkflowLayout","constructor(context: Context, attributeSet: AttributeSet? = null)","com.squareup.workflow1.ui.WorkflowLayout.WorkflowLayout"]},{"name":"constructor(context: Context, attributeSet: AttributeSet? = null, defStyle: Int = 0, defStyleRes: Int = 0)","description":"com.squareup.workflow1.ui.WorkflowViewStub.WorkflowViewStub","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/-workflow-view-stub.html","searchKeys":["WorkflowViewStub","constructor(context: Context, attributeSet: AttributeSet? = null, defStyle: Int = 0, defStyleRes: Int = 0)","com.squareup.workflow1.ui.WorkflowViewStub.WorkflowViewStub"]},{"name":"constructor(context: Context, attributeSet: AttributeSet? = null, defStyle: Int = 0, defStyleRes: Int = 0)","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.BackStackContainer","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/-back-stack-container.html","searchKeys":["BackStackContainer","constructor(context: Context, attributeSet: AttributeSet? = null, defStyle: Int = 0, defStyleRes: Int = 0)","com.squareup.workflow1.ui.navigation.BackStackContainer.BackStackContainer"]},{"name":"constructor(initialValue: String = \"\")","description":"com.squareup.workflow1.ui.ParcelableTextController.ParcelableTextController","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-parcelable-text-controller/-parcelable-text-controller.html","searchKeys":["ParcelableTextController","constructor(initialValue: String = \"\")","com.squareup.workflow1.ui.ParcelableTextController.ParcelableTextController"]},{"name":"constructor(source: Parcel)","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.SavedState","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/-saved-state/-saved-state.html","searchKeys":["SavedState","constructor(source: Parcel)","com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.SavedState"]},{"name":"constructor(source: Parcel)","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.SavedState","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/-saved-state/-saved-state.html","searchKeys":["SavedState","constructor(source: Parcel)","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.SavedState"]},{"name":"constructor(source: Parcel)","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.Saved","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/-saved/-saved.html","searchKeys":["Saved","constructor(source: Parcel)","com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.Saved"]},{"name":"constructor(superState: Parcelable, savedViewState: ViewStateCache.Saved)","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.SavedState","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/-saved-state/-saved-state.html","searchKeys":["SavedState","constructor(superState: Parcelable, savedViewState: ViewStateCache.Saved)","com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.SavedState"]},{"name":"fun > ComponentDialog.asDialogHolderWithContent(overlay: O, environment: ViewEnvironment, setContent: (ScreenViewHolder) -> Unit = { contentViewHolder ->\n setContentView(contentViewHolder.view)\n fixBackgroundAndDimming()\n }): OverlayDialogHolder","description":"com.squareup.workflow1.ui.navigation.asDialogHolderWithContent","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/as-dialog-holder-with-content.html","searchKeys":["asDialogHolderWithContent","fun > ComponentDialog.asDialogHolderWithContent(overlay: O, environment: ViewEnvironment, setContent: (ScreenViewHolder) -> Unit = { contentViewHolder ->\n setContentView(contentViewHolder.view)\n fixBackgroundAndDimming()\n }): OverlayDialogHolder","com.squareup.workflow1.ui.navigation.asDialogHolderWithContent"]},{"name":"fun renderWorkflowIn(workflow: Workflow, scope: CoroutineScope, savedStateHandle: SavedStateHandle? = null, interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}): StateFlow","description":"com.squareup.workflow1.ui.renderWorkflowIn","location":"workflow-ui/core-android/com.squareup.workflow1.ui/render-workflow-in.html","searchKeys":["renderWorkflowIn","fun renderWorkflowIn(workflow: Workflow, scope: CoroutineScope, savedStateHandle: SavedStateHandle? = null, interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}): StateFlow","com.squareup.workflow1.ui.renderWorkflowIn"]},{"name":"fun OverlayDialogHolder.show(overlay: OverlayT, environment: ViewEnvironment)","description":"com.squareup.workflow1.ui.navigation.show","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/show.html","searchKeys":["show","fun OverlayDialogHolder.show(overlay: OverlayT, environment: ViewEnvironment)","com.squareup.workflow1.ui.navigation.show"]},{"name":"fun renderWorkflowIn(workflow: Workflow, scope: CoroutineScope, prop: PropsT, savedStateHandle: SavedStateHandle? = null, interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}): StateFlow","description":"com.squareup.workflow1.ui.renderWorkflowIn","location":"workflow-ui/core-android/com.squareup.workflow1.ui/render-workflow-in.html","searchKeys":["renderWorkflowIn","fun renderWorkflowIn(workflow: Workflow, scope: CoroutineScope, prop: PropsT, savedStateHandle: SavedStateHandle? = null, interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}): StateFlow","com.squareup.workflow1.ui.renderWorkflowIn"]},{"name":"fun renderWorkflowIn(workflow: Workflow, scope: CoroutineScope, props: StateFlow, savedStateHandle: SavedStateHandle? = null, interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}): StateFlow","description":"com.squareup.workflow1.ui.renderWorkflowIn","location":"workflow-ui/core-android/com.squareup.workflow1.ui/render-workflow-in.html","searchKeys":["renderWorkflowIn","fun renderWorkflowIn(workflow: Workflow, scope: CoroutineScope, props: StateFlow, savedStateHandle: SavedStateHandle? = null, interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}): StateFlow","com.squareup.workflow1.ui.renderWorkflowIn"]},{"name":"fun ScreenT.toViewFactory(environment: ViewEnvironment): ScreenViewFactory","description":"com.squareup.workflow1.ui.toViewFactory","location":"workflow-ui/core-android/com.squareup.workflow1.ui/to-view-factory.html","searchKeys":["toViewFactory","fun ScreenT.toViewFactory(environment: ViewEnvironment): ScreenViewFactory","com.squareup.workflow1.ui.toViewFactory"]},{"name":"fun ScreenViewFactory.startShowing(initialRendering: ScreenT, initialEnvironment: ViewEnvironment, contextForNewView: Context, container: ViewGroup? = null, viewStarter: ViewStarter? = null): ScreenViewHolder","description":"com.squareup.workflow1.ui.startShowing","location":"workflow-ui/core-android/com.squareup.workflow1.ui/start-showing.html","searchKeys":["startShowing","fun ScreenViewFactory.startShowing(initialRendering: ScreenT, initialEnvironment: ViewEnvironment, contextForNewView: Context, container: ViewGroup? = null, viewStarter: ViewStarter? = null): ScreenViewHolder","com.squareup.workflow1.ui.startShowing"]},{"name":"fun ScreenViewHolder.show(screen: ScreenT, environment: ViewEnvironment)","description":"com.squareup.workflow1.ui.show","location":"workflow-ui/core-android/com.squareup.workflow1.ui/show.html","searchKeys":["show","fun ScreenViewHolder.show(screen: ScreenT, environment: ViewEnvironment)","com.squareup.workflow1.ui.show"]},{"name":"fun ScreenViewHolder.startShowing(initialRendering: ScreenT, initialEnvironment: ViewEnvironment, viewStarter: ViewStarter?)","description":"com.squareup.workflow1.ui.startShowing","location":"workflow-ui/core-android/com.squareup.workflow1.ui/start-showing.html","searchKeys":["startShowing","fun ScreenViewHolder.startShowing(initialRendering: ScreenT, initialEnvironment: ViewEnvironment, viewStarter: ViewStarter?)","com.squareup.workflow1.ui.startShowing"]},{"name":"fun T.toDialogFactory(environment: ViewEnvironment): OverlayDialogFactory","description":"com.squareup.workflow1.ui.navigation.toDialogFactory","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/to-dialog-factory.html","searchKeys":["toDialogFactory","fun T.toDialogFactory(environment: ViewEnvironment): OverlayDialogFactory","com.squareup.workflow1.ui.navigation.toDialogFactory"]},{"name":"fun AlertDialog.toDialogHolder(initialEnvironment: ViewEnvironment): OverlayDialogHolder","description":"com.squareup.workflow1.ui.navigation.toDialogHolder","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/to-dialog-holder.html","searchKeys":["toDialogHolder","fun AlertDialog.toDialogHolder(initialEnvironment: ViewEnvironment): OverlayDialogHolder","com.squareup.workflow1.ui.navigation.toDialogHolder"]},{"name":"fun Dialog.fixBackgroundAndDimming()","description":"com.squareup.workflow1.ui.navigation.fixBackgroundAndDimming","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/fix-background-and-dimming.html","searchKeys":["fixBackgroundAndDimming","fun Dialog.fixBackgroundAndDimming()","com.squareup.workflow1.ui.navigation.fixBackgroundAndDimming"]},{"name":"fun Dialog.setBounds(bounds: Rect)","description":"com.squareup.workflow1.ui.navigation.setBounds","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/set-bounds.html","searchKeys":["setBounds","fun Dialog.setBounds(bounds: Rect)","com.squareup.workflow1.ui.navigation.setBounds"]},{"name":"fun OverlayDialogHolder<*>.canShow(overlay: Overlay): Boolean","description":"com.squareup.workflow1.ui.navigation.canShow","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/can-show.html","searchKeys":["canShow","fun OverlayDialogHolder<*>.canShow(overlay: Overlay): Boolean","com.squareup.workflow1.ui.navigation.canShow"]},{"name":"fun Parcelable.toSnapshot(): Snapshot","description":"com.squareup.workflow1.ui.toSnapshot","location":"workflow-ui/core-android/com.squareup.workflow1.ui/to-snapshot.html","searchKeys":["toSnapshot","fun Parcelable.toSnapshot(): Snapshot","com.squareup.workflow1.ui.toSnapshot"]},{"name":"fun ScreenViewHolder<*>.canShow(screen: Screen): Boolean","description":"com.squareup.workflow1.ui.canShow","location":"workflow-ui/core-android/com.squareup.workflow1.ui/can-show.html","searchKeys":["canShow","fun ScreenViewHolder<*>.canShow(screen: Screen): Boolean","com.squareup.workflow1.ui.canShow"]},{"name":"fun TextController.control(view: EditText)","description":"com.squareup.workflow1.ui.control","location":"workflow-ui/core-android/com.squareup.workflow1.ui/control.html","searchKeys":["control","fun TextController.control(view: EditText)","com.squareup.workflow1.ui.control"]},{"name":"fun View.getScreenRect(rect: Rect)","description":"com.squareup.workflow1.ui.navigation.getScreenRect","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/get-screen-rect.html","searchKeys":["getScreenRect","fun View.getScreenRect(rect: Rect)","com.squareup.workflow1.ui.navigation.getScreenRect"]},{"name":"fun View.onBackPressedDispatcherOwnerOrNull(): OnBackPressedDispatcherOwner?","description":"com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.onBackPressedDispatcherOwnerOrNull","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-android-x-support/on-back-pressed-dispatcher-owner-or-null.html","searchKeys":["onBackPressedDispatcherOwnerOrNull","fun View.onBackPressedDispatcherOwnerOrNull(): OnBackPressedDispatcherOwner?","com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.onBackPressedDispatcherOwnerOrNull"]},{"name":"fun View.setBackHandler(enabled: Boolean = true, onBack: () -> Unit)","description":"com.squareup.workflow1.ui.navigation.setBackHandler","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/set-back-handler.html","searchKeys":["setBackHandler","fun View.setBackHandler(enabled: Boolean = true, onBack: () -> Unit)","com.squareup.workflow1.ui.navigation.setBackHandler"]},{"name":"fun View.setBackHandler(onBack: () -> Unit?)","description":"com.squareup.workflow1.ui.navigation.setBackHandler","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/set-back-handler.html","searchKeys":["setBackHandler","fun View.setBackHandler(onBack: () -> Unit?)","com.squareup.workflow1.ui.navigation.setBackHandler"]},{"name":"fun ViewEnvironment.onBackPressedDispatcherOwner(container: View): OnBackPressedDispatcherOwner","description":"com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.onBackPressedDispatcherOwner","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-android-x-support/on-back-pressed-dispatcher-owner.html","searchKeys":["onBackPressedDispatcherOwner","fun ViewEnvironment.onBackPressedDispatcherOwner(container: View): OnBackPressedDispatcherOwner","com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.onBackPressedDispatcherOwner"]},{"name":"fun attachToParentRegistry(key: String, parentOwner: SavedStateRegistryOwner)","description":"com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.attachToParentRegistry","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-saved-state-registry-aggregator/attach-to-parent-registry.html","searchKeys":["attachToParentRegistry","fun attachToParentRegistry(key: String, parentOwner: SavedStateRegistryOwner)","com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.attachToParentRegistry"]},{"name":"fun attachToParentRegistryOwner(key: String, parentOwner: SavedStateRegistryOwner)","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.attachToParentRegistryOwner","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/attach-to-parent-registry-owner.html","searchKeys":["attachToParentRegistryOwner","fun attachToParentRegistryOwner(key: String, parentOwner: SavedStateRegistryOwner)","com.squareup.workflow1.ui.navigation.ViewStateCache.attachToParentRegistryOwner"]},{"name":"fun detachFromParentRegistry()","description":"com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.detachFromParentRegistry","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-saved-state-registry-aggregator/detach-from-parent-registry.html","searchKeys":["detachFromParentRegistry","fun detachFromParentRegistry()","com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.detachFromParentRegistry"]},{"name":"fun detachFromParentRegistry()","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.detachFromParentRegistry","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/detach-from-parent-registry.html","searchKeys":["detachFromParentRegistry","fun detachFromParentRegistry()","com.squareup.workflow1.ui.navigation.ViewStateCache.detachFromParentRegistry"]},{"name":"fun forView(view: View, superDispatchTouchEvent: (MotionEvent) -> Unit): LayeredDialogSessions","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.Companion.forView","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/-companion/for-view.html","searchKeys":["forView","fun forView(view: View, superDispatchTouchEvent: (MotionEvent) -> Unit): LayeredDialogSessions","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.Companion.forView"]},{"name":"fun get(view: View): WorkflowLifecycleOwner?","description":"com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner.Companion.get","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-lifecycle-owner/-companion/get.html","searchKeys":["get","fun get(view: View): WorkflowLifecycleOwner?","com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner.Companion.get"]},{"name":"fun installChildRegistryOwnerOn(view: View, key: String, force: Boolean = false)","description":"com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.installChildRegistryOwnerOn","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-saved-state-registry-aggregator/install-child-registry-owner-on.html","searchKeys":["installChildRegistryOwnerOn","fun installChildRegistryOwnerOn(view: View, key: String, force: Boolean = false)","com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.installChildRegistryOwnerOn"]},{"name":"fun installOn(view: View, onBackPressedDispatcherOwner: OnBackPressedDispatcherOwner, findParentLifecycle: (View) -> Lifecycle = this::findParentViewTreeLifecycle)","description":"com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner.Companion.installOn","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-lifecycle-owner/-companion/install-on.html","searchKeys":["installOn","fun installOn(view: View, onBackPressedDispatcherOwner: OnBackPressedDispatcherOwner, findParentLifecycle: (View) -> Lifecycle = this::findParentViewTreeLifecycle)","com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner.Companion.installOn"]},{"name":"fun interface ScreenViewRunner","description":"com.squareup.workflow1.ui.ScreenViewRunner","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-runner/index.html","searchKeys":["ScreenViewRunner","fun interface ScreenViewRunner","com.squareup.workflow1.ui.ScreenViewRunner"]},{"name":"fun interface ViewStarter","description":"com.squareup.workflow1.ui.ViewStarter","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-view-starter/index.html","searchKeys":["ViewStarter","fun interface ViewStarter","com.squareup.workflow1.ui.ViewStarter"]},{"name":"fun lifecycleOwnerFromContext(context: Context): LifecycleOwner","description":"com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.lifecycleOwnerFromContext","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-android-x-support/lifecycle-owner-from-context.html","searchKeys":["lifecycleOwnerFromContext","fun lifecycleOwnerFromContext(context: Context): LifecycleOwner","com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.lifecycleOwnerFromContext"]},{"name":"fun lifecycleOwnerFromViewTreeOrContextOrNull(view: View): LifecycleOwner?","description":"com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.lifecycleOwnerFromViewTreeOrContextOrNull","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-android-x-support/lifecycle-owner-from-view-tree-or-context-or-null.html","searchKeys":["lifecycleOwnerFromViewTreeOrContextOrNull","fun lifecycleOwnerFromViewTreeOrContextOrNull(view: View): LifecycleOwner?","com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.lifecycleOwnerFromViewTreeOrContextOrNull"]},{"name":"fun onAttachedToWindow(savedStateParentKey: String, view: View)","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.onAttachedToWindow","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/on-attached-to-window.html","searchKeys":["onAttachedToWindow","fun onAttachedToWindow(savedStateParentKey: String, view: View)","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.onAttachedToWindow"]},{"name":"fun onDetachedFromWindow()","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.onDetachedFromWindow","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/on-detached-from-window.html","searchKeys":["onDetachedFromWindow","fun onDetachedFromWindow()","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.onDetachedFromWindow"]},{"name":"fun onRestoreInstanceState(state: LayeredDialogSessions.SavedState)","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.onRestoreInstanceState","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/on-restore-instance-state.html","searchKeys":["onRestoreInstanceState","fun onRestoreInstanceState(state: LayeredDialogSessions.SavedState)","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.onRestoreInstanceState"]},{"name":"fun onSaveInstanceState(): LayeredDialogSessions.SavedState","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.onSaveInstanceState","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/on-save-instance-state.html","searchKeys":["onSaveInstanceState","fun onSaveInstanceState(): LayeredDialogSessions.SavedState","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.onSaveInstanceState"]},{"name":"fun prune(retaining: Collection>)","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.prune","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/prune.html","searchKeys":["prune","fun prune(retaining: Collection>)","com.squareup.workflow1.ui.navigation.ViewStateCache.prune"]},{"name":"fun pruneAllChildRegistryOwnersExcept(keysToKeep: Collection = emptyList())","description":"com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.pruneAllChildRegistryOwnersExcept","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-saved-state-registry-aggregator/prune-all-child-registry-owners-except.html","searchKeys":["pruneAllChildRegistryOwnersExcept","fun pruneAllChildRegistryOwnersExcept(keysToKeep: Collection = emptyList())","com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.pruneAllChildRegistryOwnersExcept"]},{"name":"fun restore(from: ViewStateCache.Saved)","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.restore","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/restore.html","searchKeys":["restore","fun restore(from: ViewStateCache.Saved)","com.squareup.workflow1.ui.navigation.ViewStateCache.restore"]},{"name":"fun save(): ViewStateCache.Saved","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.save","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/save.html","searchKeys":["save","fun save(): ViewStateCache.Saved","com.squareup.workflow1.ui.navigation.ViewStateCache.save"]},{"name":"fun saveAndPruneChildRegistryOwner(key: String)","description":"com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.saveAndPruneChildRegistryOwner","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-saved-state-registry-aggregator/save-and-prune-child-registry-owner.html","searchKeys":["saveAndPruneChildRegistryOwner","fun saveAndPruneChildRegistryOwner(key: String)","com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.saveAndPruneChildRegistryOwner"]},{"name":"fun show(rendering: Screen, viewEnvironment: ViewEnvironment)","description":"com.squareup.workflow1.ui.WorkflowViewStub.show","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/show.html","searchKeys":["show","fun show(rendering: Screen, viewEnvironment: ViewEnvironment)","com.squareup.workflow1.ui.WorkflowViewStub.show"]},{"name":"fun show(rootScreen: Screen, environment: ViewEnvironment = ViewEnvironment.EMPTY)","description":"com.squareup.workflow1.ui.WorkflowLayout.show","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-layout/show.html","searchKeys":["show","fun show(rootScreen: Screen, environment: ViewEnvironment = ViewEnvironment.EMPTY)","com.squareup.workflow1.ui.WorkflowLayout.show"]},{"name":"fun stateRegistryOwnerFromViewTreeOrContext(view: View): SavedStateRegistryOwner","description":"com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.stateRegistryOwnerFromViewTreeOrContext","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-android-x-support/state-registry-owner-from-view-tree-or-context.html","searchKeys":["stateRegistryOwnerFromViewTreeOrContext","fun stateRegistryOwnerFromViewTreeOrContext(view: View): SavedStateRegistryOwner","com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.stateRegistryOwnerFromViewTreeOrContext"]},{"name":"fun take(lifecycle: Lifecycle, renderings: Flow, repeatOnLifecycle: Lifecycle.State = STARTED, collectionContext: CoroutineContext = EmptyCoroutineContext)","description":"com.squareup.workflow1.ui.WorkflowLayout.take","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-layout/take.html","searchKeys":["take","fun take(lifecycle: Lifecycle, renderings: Flow, repeatOnLifecycle: Lifecycle.State = STARTED, collectionContext: CoroutineContext = EmptyCoroutineContext)","com.squareup.workflow1.ui.WorkflowLayout.take"]},{"name":"fun update(newRendering: BackStackScreen<*>, newViewEnvironment: ViewEnvironment)","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.update","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/update.html","searchKeys":["update","fun update(newRendering: BackStackScreen<*>, newViewEnvironment: ViewEnvironment)","com.squareup.workflow1.ui.navigation.BackStackContainer.update"]},{"name":"fun update(overlays: List, viewEnvironment: ViewEnvironment, updateBody: (environment: ViewEnvironment) -> Unit)","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.update","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/update.html","searchKeys":["update","fun update(overlays: List, viewEnvironment: ViewEnvironment, updateBody: (environment: ViewEnvironment) -> Unit)","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.update"]},{"name":"fun update(retainedRenderings: Collection>, oldHolderMaybe: ScreenViewHolder>?, newHolder: ScreenViewHolder>)","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.update","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/update.html","searchKeys":["update","fun update(retainedRenderings: Collection>, oldHolderMaybe: ScreenViewHolder>?, newHolder: ScreenViewHolder>)","com.squareup.workflow1.ui.navigation.ViewStateCache.update"]},{"name":"inline fun fromViewBinding(noinline bindingInflater: ViewBindingInflater, crossinline showRendering: BindingT.(ScreenT, ViewEnvironment) -> Unit): ScreenViewFactory","description":"com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromViewBinding","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/-companion/from-view-binding.html","searchKeys":["fromViewBinding","inline fun fromViewBinding(noinline bindingInflater: ViewBindingInflater, crossinline showRendering: BindingT.(ScreenT, ViewEnvironment) -> Unit): ScreenViewFactory","com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromViewBinding"]},{"name":"inline fun fromViewBinding(noinline bindingInflater: ViewBindingInflater, noinline constructor: (BindingT) -> ScreenViewRunner): ScreenViewFactory","description":"com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromViewBinding","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/-companion/from-view-binding.html","searchKeys":["fromViewBinding","inline fun fromViewBinding(noinline bindingInflater: ViewBindingInflater, noinline constructor: (BindingT) -> ScreenViewRunner): ScreenViewFactory","com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromViewBinding"]},{"name":"inline fun fromCode(crossinline buildView: (initialRendering: ScreenT, initialEnvironment: ViewEnvironment, context: Context, container: ViewGroup?) -> ScreenViewHolder): ScreenViewFactory","description":"com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromCode","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/-companion/from-code.html","searchKeys":["fromCode","inline fun fromCode(crossinline buildView: (initialRendering: ScreenT, initialEnvironment: ViewEnvironment, context: Context, container: ViewGroup?) -> ScreenViewHolder): ScreenViewFactory","com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromCode"]},{"name":"inline fun fromLayout(layoutId: Int, noinline constructor: (View) -> ScreenViewRunner): ScreenViewFactory","description":"com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromLayout","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/-companion/from-layout.html","searchKeys":["fromLayout","inline fun fromLayout(layoutId: Int, noinline constructor: (View) -> ScreenViewRunner): ScreenViewFactory","com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromLayout"]},{"name":"inline fun fromStaticLayout(layoutId: Int): ScreenViewFactory","description":"com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromStaticLayout","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/-companion/from-static-layout.html","searchKeys":["fromStaticLayout","inline fun fromStaticLayout(layoutId: Int): ScreenViewFactory","com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromStaticLayout"]},{"name":"inline fun ScreenViewFactory.map(noinline transform: (wrapperScreen: SourceT) -> TransformedT, crossinline prepEnvironment: (environment: ViewEnvironment) -> ViewEnvironment = { e -> e }, crossinline prepContext: (environment: ViewEnvironment, context: Context) -> Context = { _, c -> c }, crossinline showSource: (view: View, source: SourceT, transform: (wrapperScreen: SourceT) -> TransformedT, environment: ViewEnvironment, showTransformed: (TransformedT, ViewEnvironment) -> Unit) -> Unit = { _, src, xform, e, showTransformed -> showTransformed(xform(src), e) }): ScreenViewFactory","description":"com.squareup.workflow1.ui.map","location":"workflow-ui/core-android/com.squareup.workflow1.ui/map.html","searchKeys":["map","inline fun ScreenViewFactory.map(noinline transform: (wrapperScreen: SourceT) -> TransformedT, crossinline prepEnvironment: (environment: ViewEnvironment) -> ViewEnvironment = { e -> e }, crossinline prepContext: (environment: ViewEnvironment, context: Context) -> Context = { _, c -> c }, crossinline showSource: (view: View, source: SourceT, transform: (wrapperScreen: SourceT) -> TransformedT, environment: ViewEnvironment, showTransformed: (TransformedT, ViewEnvironment) -> Unit) -> Unit = { _, src, xform, e, showTransformed -> showTransformed(xform(src), e) }): ScreenViewFactory","com.squareup.workflow1.ui.map"]},{"name":"inline fun map(crossinline prepEnvironment: (environment: ViewEnvironment) -> ViewEnvironment = { it }, crossinline prepContext: (environment: ViewEnvironment, context: Context) -> Context = { _, c -> c }, crossinline beforeShowing: (viewHolder: ScreenViewHolder) -> Unit = {}, crossinline showSource: (view: View, source: SourceT, transformer: (source: SourceT) -> TransformedT, environment: ViewEnvironment, showTransformed: (TransformedT, ViewEnvironment) -> Unit) -> Unit = { _, src, xform, e, show -> show(xform(src), e) }, noinline transform: (source: SourceT) -> TransformedT): ScreenViewFactory","description":"com.squareup.workflow1.ui.ScreenViewFactory.Companion.map","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/-companion/map.html","searchKeys":["map","inline fun map(crossinline prepEnvironment: (environment: ViewEnvironment) -> ViewEnvironment = { it }, crossinline prepContext: (environment: ViewEnvironment, context: Context) -> Context = { _, c -> c }, crossinline beforeShowing: (viewHolder: ScreenViewHolder) -> Unit = {}, crossinline showSource: (view: View, source: SourceT, transformer: (source: SourceT) -> TransformedT, environment: ViewEnvironment, showTransformed: (TransformedT, ViewEnvironment) -> Unit) -> Unit = { _, src, xform, e, show -> show(xform(src), e) }, noinline transform: (source: SourceT) -> TransformedT): ScreenViewFactory","com.squareup.workflow1.ui.ScreenViewFactory.Companion.map"]},{"name":"inline fun ByteString.toParcelable(): T","description":"com.squareup.workflow1.ui.toParcelable","location":"workflow-ui/core-android/com.squareup.workflow1.ui/to-parcelable.html","searchKeys":["toParcelable","inline fun ByteString.toParcelable(): T","com.squareup.workflow1.ui.toParcelable"]},{"name":"inline fun Snapshot.toParcelable(): T?","description":"com.squareup.workflow1.ui.toParcelable","location":"workflow-ui/core-android/com.squareup.workflow1.ui/to-parcelable.html","searchKeys":["toParcelable","inline fun Snapshot.toParcelable(): T?","com.squareup.workflow1.ui.toParcelable"]},{"name":"inline fun , ContentT : Screen> forWrapper(crossinline prepEnvironment: (environment: ViewEnvironment) -> ViewEnvironment = { it }, crossinline prepContext: (environment: ViewEnvironment, context: Context) -> Context = { _, c -> c }, crossinline beforeShowing: (viewHolder: ScreenViewHolder) -> Unit = {}, crossinline showWrapper: (view: View, wrapper: WrapperT, environment: ViewEnvironment, showContent: (ContentT, ViewEnvironment) -> Unit) -> Unit = { _, src, e, show -> show(src.content, e) }): ScreenViewFactory","description":"com.squareup.workflow1.ui.ScreenViewFactory.Companion.forWrapper","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/-companion/for-wrapper.html","searchKeys":["forWrapper","inline fun , ContentT : Screen> forWrapper(crossinline prepEnvironment: (environment: ViewEnvironment) -> ViewEnvironment = { it }, crossinline prepContext: (environment: ViewEnvironment, context: Context) -> Context = { _, c -> c }, crossinline beforeShowing: (viewHolder: ScreenViewHolder) -> Unit = {}, crossinline showWrapper: (view: View, wrapper: WrapperT, environment: ViewEnvironment, showContent: (ContentT, ViewEnvironment) -> Unit) -> Unit = { _, src, e, show -> show(src.content, e) }): ScreenViewFactory","com.squareup.workflow1.ui.ScreenViewFactory.Companion.forWrapper"]},{"name":"inline operator fun invoke(crossinline buildDialog: (initialRendering: OverlayT, initialEnvironment: ViewEnvironment, context: Context) -> OverlayDialogHolder): OverlayDialogFactory","description":"com.squareup.workflow1.ui.navigation.OverlayDialogFactory.Companion.invoke","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/-companion/invoke.html","searchKeys":["invoke","inline operator fun invoke(crossinline buildDialog: (initialRendering: OverlayT, initialEnvironment: ViewEnvironment, context: Context) -> OverlayDialogHolder): OverlayDialogFactory","com.squareup.workflow1.ui.navigation.OverlayDialogFactory.Companion.invoke"]},{"name":"interface AndroidOverlay> : Overlay","description":"com.squareup.workflow1.ui.navigation.AndroidOverlay","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-android-overlay/index.html","searchKeys":["AndroidOverlay","interface AndroidOverlay> : Overlay","com.squareup.workflow1.ui.navigation.AndroidOverlay"]},{"name":"interface AndroidScreen> : Screen","description":"com.squareup.workflow1.ui.AndroidScreen","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-android-screen/index.html","searchKeys":["AndroidScreen","interface AndroidScreen> : Screen","com.squareup.workflow1.ui.AndroidScreen"]},{"name":"interface OverlayDialogFactory : ViewRegistry.Entry ","description":"com.squareup.workflow1.ui.navigation.OverlayDialogFactory","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/index.html","searchKeys":["OverlayDialogFactory","interface OverlayDialogFactory : ViewRegistry.Entry ","com.squareup.workflow1.ui.navigation.OverlayDialogFactory"]},{"name":"interface OverlayDialogFactoryFinder","description":"com.squareup.workflow1.ui.navigation.OverlayDialogFactoryFinder","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory-finder/index.html","searchKeys":["OverlayDialogFactoryFinder","interface OverlayDialogFactoryFinder","com.squareup.workflow1.ui.navigation.OverlayDialogFactoryFinder"]},{"name":"interface OverlayDialogHolder","description":"com.squareup.workflow1.ui.navigation.OverlayDialogHolder","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-holder/index.html","searchKeys":["OverlayDialogHolder","interface OverlayDialogHolder","com.squareup.workflow1.ui.navigation.OverlayDialogHolder"]},{"name":"interface ScreenViewFactory : ViewRegistry.Entry ","description":"com.squareup.workflow1.ui.ScreenViewFactory","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/index.html","searchKeys":["ScreenViewFactory","interface ScreenViewFactory : ViewRegistry.Entry ","com.squareup.workflow1.ui.ScreenViewFactory"]},{"name":"interface ScreenViewFactoryFinder","description":"com.squareup.workflow1.ui.ScreenViewFactoryFinder","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory-finder/index.html","searchKeys":["ScreenViewFactoryFinder","interface ScreenViewFactoryFinder","com.squareup.workflow1.ui.ScreenViewFactoryFinder"]},{"name":"interface ScreenViewHolder","description":"com.squareup.workflow1.ui.ScreenViewHolder","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-holder/index.html","searchKeys":["ScreenViewHolder","interface ScreenViewHolder","com.squareup.workflow1.ui.ScreenViewHolder"]},{"name":"interface WorkflowLifecycleOwner : LifecycleOwner","description":"com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-lifecycle-owner/index.html","searchKeys":["WorkflowLifecycleOwner","interface WorkflowLifecycleOwner : LifecycleOwner","com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner"]},{"name":"object AlertDialogThemeResId : ViewEnvironmentKey ","description":"com.squareup.workflow1.ui.navigation.AlertDialogThemeResId","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-alert-dialog-theme-res-id/index.html","searchKeys":["AlertDialogThemeResId","object AlertDialogThemeResId : ViewEnvironmentKey ","com.squareup.workflow1.ui.navigation.AlertDialogThemeResId"]},{"name":"object CREATOR : Parcelable.Creator ","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.CREATOR","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/-saved-state/-c-r-e-a-t-o-r/index.html","searchKeys":["CREATOR","object CREATOR : Parcelable.Creator ","com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.CREATOR"]},{"name":"object CREATOR : Parcelable.Creator ","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.CREATOR","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/-saved-state/-c-r-e-a-t-o-r/index.html","searchKeys":["CREATOR","object CREATOR : Parcelable.Creator ","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.CREATOR"]},{"name":"object CREATOR : Parcelable.Creator ","description":"com.squareup.workflow1.ui.ParcelableTextController.CREATOR","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-parcelable-text-controller/-c-r-e-a-t-o-r/index.html","searchKeys":["CREATOR","object CREATOR : Parcelable.Creator ","com.squareup.workflow1.ui.ParcelableTextController.CREATOR"]},{"name":"object CREATOR : Parcelable.Creator ","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.CREATOR","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/-saved/-c-r-e-a-t-o-r/index.html","searchKeys":["CREATOR","object CREATOR : Parcelable.Creator ","com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.CREATOR"]},{"name":"object Companion","description":"com.squareup.workflow1.ui.ScreenViewFactory.Companion","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.ui.ScreenViewFactory.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.ui.ScreenViewHolder.Companion","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-holder/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.ui.ScreenViewHolder.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner.Companion","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-lifecycle-owner/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.Companion","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.ui.navigation.OverlayDialogFactory.Companion","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.ui.navigation.OverlayDialogFactory.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.ui.navigation.OverlayDialogHolder.Companion","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-holder/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.ui.navigation.OverlayDialogHolder.Companion"]},{"name":"object Companion : ViewEnvironmentKey ","description":"com.squareup.workflow1.ui.navigation.OverlayDialogFactoryFinder.Companion","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory-finder/-companion/index.html","searchKeys":["Companion","object Companion : ViewEnvironmentKey ","com.squareup.workflow1.ui.navigation.OverlayDialogFactoryFinder.Companion"]},{"name":"object Companion : ViewEnvironmentKey ","description":"com.squareup.workflow1.ui.ScreenViewFactoryFinder.Companion","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory-finder/-companion/index.html","searchKeys":["Companion","object Companion : ViewEnvironmentKey ","com.squareup.workflow1.ui.ScreenViewFactoryFinder.Companion"]},{"name":"object OnBackPressedDispatcherOwnerKey : ViewEnvironmentKey ","description":"com.squareup.workflow1.ui.androidx.OnBackPressedDispatcherOwnerKey","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-on-back-pressed-dispatcher-owner-key/index.html","searchKeys":["OnBackPressedDispatcherOwnerKey","object OnBackPressedDispatcherOwnerKey : ViewEnvironmentKey ","com.squareup.workflow1.ui.androidx.OnBackPressedDispatcherOwnerKey"]},{"name":"object WorkflowAndroidXSupport","description":"com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-android-x-support/index.html","searchKeys":["WorkflowAndroidXSupport","object WorkflowAndroidXSupport","com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport"]},{"name":"open class BackStackContainer constructor(context: Context, attributeSet: AttributeSet? = null, defStyle: Int = 0, defStyleRes: Int = 0) : FrameLayout","description":"com.squareup.workflow1.ui.navigation.BackStackContainer","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/index.html","searchKeys":["BackStackContainer","open class BackStackContainer constructor(context: Context, attributeSet: AttributeSet? = null, defStyle: Int = 0, defStyleRes: Int = 0) : FrameLayout","com.squareup.workflow1.ui.navigation.BackStackContainer"]},{"name":"open fun getDialogFactoryForRendering(environment: ViewEnvironment, rendering: OverlayT): OverlayDialogFactory","description":"com.squareup.workflow1.ui.navigation.OverlayDialogFactoryFinder.getDialogFactoryForRendering","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory-finder/get-dialog-factory-for-rendering.html","searchKeys":["getDialogFactoryForRendering","open fun getDialogFactoryForRendering(environment: ViewEnvironment, rendering: OverlayT): OverlayDialogFactory","com.squareup.workflow1.ui.navigation.OverlayDialogFactoryFinder.getDialogFactoryForRendering"]},{"name":"open fun getViewFactoryForRendering(environment: ViewEnvironment, rendering: ScreenT): ScreenViewFactory","description":"com.squareup.workflow1.ui.ScreenViewFactoryFinder.getViewFactoryForRendering","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory-finder/get-view-factory-for-rendering.html","searchKeys":["getViewFactoryForRendering","open fun getViewFactoryForRendering(environment: ViewEnvironment, rendering: ScreenT): ScreenViewFactory","com.squareup.workflow1.ui.ScreenViewFactoryFinder.getViewFactoryForRendering"]},{"name":"open override fun map(transform: (C) -> D): BackButtonScreen","description":"com.squareup.workflow1.ui.navigation.BackButtonScreen.map","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-button-screen/map.html","searchKeys":["map","open override fun map(transform: (C) -> D): BackButtonScreen","com.squareup.workflow1.ui.navigation.BackButtonScreen.map"]},{"name":"open override fun createFromParcel(source: Parcel): BackStackContainer.SavedState","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.CREATOR.createFromParcel","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/-saved-state/-c-r-e-a-t-o-r/create-from-parcel.html","searchKeys":["createFromParcel","open override fun createFromParcel(source: Parcel): BackStackContainer.SavedState","com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.CREATOR.createFromParcel"]},{"name":"open override fun createFromParcel(source: Parcel): LayeredDialogSessions.SavedState","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.CREATOR.createFromParcel","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/-saved-state/-c-r-e-a-t-o-r/create-from-parcel.html","searchKeys":["createFromParcel","open override fun createFromParcel(source: Parcel): LayeredDialogSessions.SavedState","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.CREATOR.createFromParcel"]},{"name":"open override fun createFromParcel(source: Parcel): ParcelableTextController","description":"com.squareup.workflow1.ui.ParcelableTextController.CREATOR.createFromParcel","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-parcelable-text-controller/-c-r-e-a-t-o-r/create-from-parcel.html","searchKeys":["createFromParcel","open override fun createFromParcel(source: Parcel): ParcelableTextController","com.squareup.workflow1.ui.ParcelableTextController.CREATOR.createFromParcel"]},{"name":"open override fun createFromParcel(source: Parcel): ViewStateCache.Saved","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.CREATOR.createFromParcel","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/-saved/-c-r-e-a-t-o-r/create-from-parcel.html","searchKeys":["createFromParcel","open override fun createFromParcel(source: Parcel): ViewStateCache.Saved","com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.CREATOR.createFromParcel"]},{"name":"open override fun describeContents(): Int","description":"com.squareup.workflow1.ui.ParcelableTextController.describeContents","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-parcelable-text-controller/describe-contents.html","searchKeys":["describeContents","open override fun describeContents(): Int","com.squareup.workflow1.ui.ParcelableTextController.describeContents"]},{"name":"open override fun describeContents(): Int","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.describeContents","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/-saved-state/describe-contents.html","searchKeys":["describeContents","open override fun describeContents(): Int","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.describeContents"]},{"name":"open override fun describeContents(): Int","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.describeContents","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/-saved/describe-contents.html","searchKeys":["describeContents","open override fun describeContents(): Int","com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.describeContents"]},{"name":"open override fun getVisibility(): Int","description":"com.squareup.workflow1.ui.WorkflowViewStub.getVisibility","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/get-visibility.html","searchKeys":["getVisibility","open override fun getVisibility(): Int","com.squareup.workflow1.ui.WorkflowViewStub.getVisibility"]},{"name":"open override fun newArray(size: Int): Array","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.CREATOR.newArray","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/-saved-state/-c-r-e-a-t-o-r/new-array.html","searchKeys":["newArray","open override fun newArray(size: Int): Array","com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.CREATOR.newArray"]},{"name":"open override fun newArray(size: Int): Array","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.CREATOR.newArray","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/-saved-state/-c-r-e-a-t-o-r/new-array.html","searchKeys":["newArray","open override fun newArray(size: Int): Array","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.CREATOR.newArray"]},{"name":"open override fun newArray(size: Int): Array","description":"com.squareup.workflow1.ui.ParcelableTextController.CREATOR.newArray","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-parcelable-text-controller/-c-r-e-a-t-o-r/new-array.html","searchKeys":["newArray","open override fun newArray(size: Int): Array","com.squareup.workflow1.ui.ParcelableTextController.CREATOR.newArray"]},{"name":"open override fun newArray(size: Int): Array","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.CREATOR.newArray","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/-saved/-c-r-e-a-t-o-r/new-array.html","searchKeys":["newArray","open override fun newArray(size: Int): Array","com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.CREATOR.newArray"]},{"name":"open override fun setBackground(background: Drawable?)","description":"com.squareup.workflow1.ui.WorkflowViewStub.setBackground","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/set-background.html","searchKeys":["setBackground","open override fun setBackground(background: Drawable?)","com.squareup.workflow1.ui.WorkflowViewStub.setBackground"]},{"name":"open override fun setId(id: Int)","description":"com.squareup.workflow1.ui.WorkflowViewStub.setId","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/set-id.html","searchKeys":["setId","open override fun setId(id: Int)","com.squareup.workflow1.ui.WorkflowViewStub.setId"]},{"name":"open override fun setVisibility(visibility: Int)","description":"com.squareup.workflow1.ui.WorkflowViewStub.setVisibility","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/set-visibility.html","searchKeys":["setVisibility","open override fun setVisibility(visibility: Int)","com.squareup.workflow1.ui.WorkflowViewStub.setVisibility"]},{"name":"open override fun writeToParcel(out: Parcel, flags: Int)","description":"com.squareup.workflow1.ui.ParcelableTextController.writeToParcel","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-parcelable-text-controller/write-to-parcel.html","searchKeys":["writeToParcel","open override fun writeToParcel(out: Parcel, flags: Int)","com.squareup.workflow1.ui.ParcelableTextController.writeToParcel"]},{"name":"open override fun writeToParcel(out: Parcel, flags: Int)","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.writeToParcel","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/-saved-state/write-to-parcel.html","searchKeys":["writeToParcel","open override fun writeToParcel(out: Parcel, flags: Int)","com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.writeToParcel"]},{"name":"open override fun writeToParcel(out: Parcel, flags: Int)","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.writeToParcel","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/-saved-state/write-to-parcel.html","searchKeys":["writeToParcel","open override fun writeToParcel(out: Parcel, flags: Int)","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.writeToParcel"]},{"name":"open override fun writeToParcel(out: Parcel, flags: Int)","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.writeToParcel","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/-saved/write-to-parcel.html","searchKeys":["writeToParcel","open override fun writeToParcel(out: Parcel, flags: Int)","com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.writeToParcel"]},{"name":"open override val compatibilityKey: String","description":"com.squareup.workflow1.ui.navigation.BackButtonScreen.compatibilityKey","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-button-screen/compatibility-key.html","searchKeys":["compatibilityKey","open override val compatibilityKey: String","com.squareup.workflow1.ui.navigation.BackButtonScreen.compatibilityKey"]},{"name":"open override val content: C","description":"com.squareup.workflow1.ui.navigation.BackButtonScreen.content","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-button-screen/content.html","searchKeys":["content","open override val content: C","com.squareup.workflow1.ui.navigation.BackButtonScreen.content"]},{"name":"open override val default: Int = 0","description":"com.squareup.workflow1.ui.navigation.AlertDialogThemeResId.default","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-alert-dialog-theme-res-id/default.html","searchKeys":["default","open override val default: Int = 0","com.squareup.workflow1.ui.navigation.AlertDialogThemeResId.default"]},{"name":"open override val default: OnBackPressedDispatcherOwner","description":"com.squareup.workflow1.ui.androidx.OnBackPressedDispatcherOwnerKey.default","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-on-back-pressed-dispatcher-owner-key/default.html","searchKeys":["default","open override val default: OnBackPressedDispatcherOwner","com.squareup.workflow1.ui.androidx.OnBackPressedDispatcherOwnerKey.default"]},{"name":"open override val default: OverlayDialogFactoryFinder","description":"com.squareup.workflow1.ui.navigation.OverlayDialogFactoryFinder.Companion.default","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory-finder/-companion/default.html","searchKeys":["default","open override val default: OverlayDialogFactoryFinder","com.squareup.workflow1.ui.navigation.OverlayDialogFactoryFinder.Companion.default"]},{"name":"open override val default: ScreenViewFactoryFinder","description":"com.squareup.workflow1.ui.ScreenViewFactoryFinder.Companion.default","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory-finder/-companion/default.html","searchKeys":["default","open override val default: ScreenViewFactoryFinder","com.squareup.workflow1.ui.ScreenViewFactoryFinder.Companion.default"]},{"name":"open override val viewFactory: ScreenViewFactory>","description":"com.squareup.workflow1.ui.navigation.BackButtonScreen.viewFactory","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-button-screen/view-factory.html","searchKeys":["viewFactory","open override val viewFactory: ScreenViewFactory>","com.squareup.workflow1.ui.navigation.BackButtonScreen.viewFactory"]},{"name":"operator fun invoke(initialEnvironment: ViewEnvironment, dialog: Dialog, onUpdateBounds: (Rect) -> Unit? = { dialog.setBounds(it) }, runner: (rendering: OverlayT, environment: ViewEnvironment) -> Unit): OverlayDialogHolder","description":"com.squareup.workflow1.ui.navigation.OverlayDialogHolder.Companion.invoke","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-holder/-companion/invoke.html","searchKeys":["invoke","operator fun invoke(initialEnvironment: ViewEnvironment, dialog: Dialog, onUpdateBounds: (Rect) -> Unit? = { dialog.setBounds(it) }, runner: (rendering: OverlayT, environment: ViewEnvironment) -> Unit): OverlayDialogHolder","com.squareup.workflow1.ui.navigation.OverlayDialogHolder.Companion.invoke"]},{"name":"operator fun invoke(initialEnvironment: ViewEnvironment, view: View, viewRunner: ScreenViewRunner): ScreenViewHolder","description":"com.squareup.workflow1.ui.ScreenViewHolder.Companion.invoke","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-holder/-companion/invoke.html","searchKeys":["invoke","operator fun invoke(initialEnvironment: ViewEnvironment, view: View, viewRunner: ScreenViewRunner): ScreenViewHolder","com.squareup.workflow1.ui.ScreenViewHolder.Companion.invoke"]},{"name":"typealias ViewBindingInflater = (LayoutInflater, ViewGroup?, Boolean) -> BindingT","description":"com.squareup.workflow1.ui.ViewBindingInflater","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-view-binding-inflater/index.html","searchKeys":["ViewBindingInflater","typealias ViewBindingInflater = (LayoutInflater, ViewGroup?, Boolean) -> BindingT","com.squareup.workflow1.ui.ViewBindingInflater"]},{"name":"val OverlayDialogHolder<*>.showing: Overlay","description":"com.squareup.workflow1.ui.navigation.showing","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/showing.html","searchKeys":["showing","val OverlayDialogHolder<*>.showing: Overlay","com.squareup.workflow1.ui.navigation.showing"]},{"name":"val ScreenViewHolder<*>.showing: Screen","description":"com.squareup.workflow1.ui.showing","location":"workflow-ui/core-android/com.squareup.workflow1.ui/showing.html","searchKeys":["showing","val ScreenViewHolder<*>.showing: Screen","com.squareup.workflow1.ui.showing"]},{"name":"val View.environmentOrNull: ViewEnvironment?","description":"com.squareup.workflow1.ui.environmentOrNull","location":"workflow-ui/core-android/com.squareup.workflow1.ui/environment-or-null.html","searchKeys":["environmentOrNull","val View.environmentOrNull: ViewEnvironment?","com.squareup.workflow1.ui.environmentOrNull"]},{"name":"val View.screenOrNull: Screen?","description":"com.squareup.workflow1.ui.screenOrNull","location":"workflow-ui/core-android/com.squareup.workflow1.ui/screen-or-null.html","searchKeys":["screenOrNull","val View.screenOrNull: Screen?","com.squareup.workflow1.ui.screenOrNull"]},{"name":"val actual: View","description":"com.squareup.workflow1.ui.WorkflowViewStub.actual","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/actual.html","searchKeys":["actual","val actual: View","com.squareup.workflow1.ui.WorkflowViewStub.actual"]},{"name":"val onBackPressed: () -> Unit? = null","description":"com.squareup.workflow1.ui.navigation.BackButtonScreen.onBackPressed","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-button-screen/on-back-pressed.html","searchKeys":["onBackPressed","val onBackPressed: () -> Unit? = null","com.squareup.workflow1.ui.navigation.BackButtonScreen.onBackPressed"]},{"name":"val savedViewState: ViewStateCache.Saved","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.savedViewState","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/-saved-state/saved-view-state.html","searchKeys":["savedViewState","val savedViewState: ViewStateCache.Saved","com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.savedViewState"]},{"name":"val shadow: Boolean = false","description":"com.squareup.workflow1.ui.navigation.BackButtonScreen.shadow","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-button-screen/shadow.html","searchKeys":["shadow","val shadow: Boolean = false","com.squareup.workflow1.ui.navigation.BackButtonScreen.shadow"]},{"name":"var View.screen: Screen","description":"com.squareup.workflow1.ui.screen","location":"workflow-ui/core-android/com.squareup.workflow1.ui/screen.html","searchKeys":["screen","var View.screen: Screen","com.squareup.workflow1.ui.screen"]},{"name":"var allowBodyEvents: Boolean","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.allowBodyEvents","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/allow-body-events.html","searchKeys":["allowBodyEvents","var allowBodyEvents: Boolean","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.allowBodyEvents"]},{"name":"var inflatedId: Int","description":"com.squareup.workflow1.ui.WorkflowViewStub.inflatedId","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/inflated-id.html","searchKeys":["inflatedId","var inflatedId: Int","com.squareup.workflow1.ui.WorkflowViewStub.inflatedId"]},{"name":"var propagatesLayoutParams: Boolean","description":"com.squareup.workflow1.ui.WorkflowViewStub.propagatesLayoutParams","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/propagates-layout-params.html","searchKeys":["propagatesLayoutParams","var propagatesLayoutParams: Boolean","com.squareup.workflow1.ui.WorkflowViewStub.propagatesLayoutParams"]},{"name":"var replaceOldViewInParent: (parent: ViewGroup, newView: View, layoutParams: ViewGroup.LayoutParams?) -> Unit","description":"com.squareup.workflow1.ui.WorkflowViewStub.replaceOldViewInParent","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/replace-old-view-in-parent.html","searchKeys":["replaceOldViewInParent","var replaceOldViewInParent: (parent: ViewGroup, newView: View, layoutParams: ViewGroup.LayoutParams?) -> Unit","com.squareup.workflow1.ui.WorkflowViewStub.replaceOldViewInParent"]},{"name":"var updatesVisibility: Boolean","description":"com.squareup.workflow1.ui.WorkflowViewStub.updatesVisibility","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/updates-visibility.html","searchKeys":["updatesVisibility","var updatesVisibility: Boolean","com.squareup.workflow1.ui.WorkflowViewStub.updatesVisibility"]},{"name":"class JvmTestRuntimeConfigTools","description":"com.squareup.workflow1.config.JvmTestRuntimeConfigTools","location":"workflow-config/config-jvm/com.squareup.workflow1.config/-jvm-test-runtime-config-tools/index.html","searchKeys":["JvmTestRuntimeConfigTools","class JvmTestRuntimeConfigTools","com.squareup.workflow1.config.JvmTestRuntimeConfigTools"]},{"name":"constructor()","description":"com.squareup.workflow1.config.JvmTestRuntimeConfigTools.JvmTestRuntimeConfigTools","location":"workflow-config/config-jvm/com.squareup.workflow1.config/-jvm-test-runtime-config-tools/-jvm-test-runtime-config-tools.html","searchKeys":["JvmTestRuntimeConfigTools","constructor()","com.squareup.workflow1.config.JvmTestRuntimeConfigTools.JvmTestRuntimeConfigTools"]},{"name":"fun getTestRuntimeConfig(): RuntimeConfig","description":"com.squareup.workflow1.config.JvmTestRuntimeConfigTools.Companion.getTestRuntimeConfig","location":"workflow-config/config-jvm/com.squareup.workflow1.config/-jvm-test-runtime-config-tools/-companion/get-test-runtime-config.html","searchKeys":["getTestRuntimeConfig","fun getTestRuntimeConfig(): RuntimeConfig","com.squareup.workflow1.config.JvmTestRuntimeConfigTools.Companion.getTestRuntimeConfig"]},{"name":"object Companion","description":"com.squareup.workflow1.config.JvmTestRuntimeConfigTools.Companion","location":"workflow-config/config-jvm/com.squareup.workflow1.config/-jvm-test-runtime-config-tools/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.config.JvmTestRuntimeConfigTools.Companion"]},{"name":"abstract class PublisherWorker : Worker ","description":"com.squareup.workflow1.rx2.PublisherWorker","location":"workflow-rx2/com.squareup.workflow1.rx2/-publisher-worker/index.html","searchKeys":["PublisherWorker","abstract class PublisherWorker : Worker ","com.squareup.workflow1.rx2.PublisherWorker"]},{"name":"abstract fun runPublisher(): Publisher","description":"com.squareup.workflow1.rx2.PublisherWorker.runPublisher","location":"workflow-rx2/com.squareup.workflow1.rx2/-publisher-worker/run-publisher.html","searchKeys":["runPublisher","abstract fun runPublisher(): Publisher","com.squareup.workflow1.rx2.PublisherWorker.runPublisher"]},{"name":"constructor()","description":"com.squareup.workflow1.rx2.PublisherWorker.PublisherWorker","location":"workflow-rx2/com.squareup.workflow1.rx2/-publisher-worker/-publisher-worker.html","searchKeys":["PublisherWorker","constructor()","com.squareup.workflow1.rx2.PublisherWorker.PublisherWorker"]},{"name":"fun Completable.asWorker(): Worker","description":"com.squareup.workflow1.rx2.asWorker","location":"workflow-rx2/com.squareup.workflow1.rx2/as-worker.html","searchKeys":["asWorker","fun Completable.asWorker(): Worker","com.squareup.workflow1.rx2.asWorker"]},{"name":"inline fun Maybe.asWorker(): Worker","description":"com.squareup.workflow1.rx2.asWorker","location":"workflow-rx2/com.squareup.workflow1.rx2/as-worker.html","searchKeys":["asWorker","inline fun Maybe.asWorker(): Worker","com.squareup.workflow1.rx2.asWorker"]},{"name":"inline fun Observable.asWorker(): Worker","description":"com.squareup.workflow1.rx2.asWorker","location":"workflow-rx2/com.squareup.workflow1.rx2/as-worker.html","searchKeys":["asWorker","inline fun Observable.asWorker(): Worker","com.squareup.workflow1.rx2.asWorker"]},{"name":"inline fun Publisher.asWorker(): Worker","description":"com.squareup.workflow1.rx2.asWorker","location":"workflow-rx2/com.squareup.workflow1.rx2/as-worker.html","searchKeys":["asWorker","inline fun Publisher.asWorker(): Worker","com.squareup.workflow1.rx2.asWorker"]},{"name":"inline fun Single.asWorker(): Worker","description":"com.squareup.workflow1.rx2.asWorker","location":"workflow-rx2/com.squareup.workflow1.rx2/as-worker.html","searchKeys":["asWorker","inline fun Single.asWorker(): Worker","com.squareup.workflow1.rx2.asWorker"]},{"name":"override fun run(): Flow","description":"com.squareup.workflow1.rx2.PublisherWorker.run","location":"workflow-rx2/com.squareup.workflow1.rx2/-publisher-worker/run.html","searchKeys":["run","override fun run(): Flow","com.squareup.workflow1.rx2.PublisherWorker.run"]},{"name":"class AndroidRuntimeConfigTools","description":"com.squareup.workflow1.config.AndroidRuntimeConfigTools","location":"workflow-config/config-android/com.squareup.workflow1.config/-android-runtime-config-tools/index.html","searchKeys":["AndroidRuntimeConfigTools","class AndroidRuntimeConfigTools","com.squareup.workflow1.config.AndroidRuntimeConfigTools"]},{"name":"constructor()","description":"com.squareup.workflow1.config.AndroidRuntimeConfigTools.AndroidRuntimeConfigTools","location":"workflow-config/config-android/com.squareup.workflow1.config/-android-runtime-config-tools/-android-runtime-config-tools.html","searchKeys":["AndroidRuntimeConfigTools","constructor()","com.squareup.workflow1.config.AndroidRuntimeConfigTools.AndroidRuntimeConfigTools"]},{"name":"fun getAppWorkflowRuntimeConfig(): RuntimeConfig","description":"com.squareup.workflow1.config.AndroidRuntimeConfigTools.Companion.getAppWorkflowRuntimeConfig","location":"workflow-config/config-android/com.squareup.workflow1.config/-android-runtime-config-tools/-companion/get-app-workflow-runtime-config.html","searchKeys":["getAppWorkflowRuntimeConfig","fun getAppWorkflowRuntimeConfig(): RuntimeConfig","com.squareup.workflow1.config.AndroidRuntimeConfigTools.Companion.getAppWorkflowRuntimeConfig"]},{"name":"object Companion","description":"com.squareup.workflow1.config.AndroidRuntimeConfigTools.Companion","location":"workflow-config/config-android/com.squareup.workflow1.config/-android-runtime-config-tools/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.config.AndroidRuntimeConfigTools.Companion"]},{"name":"abstract class RenderTester","description":"com.squareup.workflow1.testing.RenderTester","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/index.html","searchKeys":["RenderTester","abstract class RenderTester","com.squareup.workflow1.testing.RenderTester"]},{"name":"abstract fun assertNoOutput()","description":"com.squareup.workflow1.testing.WorkerTester.assertNoOutput","location":"workflow-testing/com.squareup.workflow1.testing/-worker-tester/assert-no-output.html","searchKeys":["assertNoOutput","abstract fun assertNoOutput()","com.squareup.workflow1.testing.WorkerTester.assertNoOutput"]},{"name":"abstract fun assertNotFinished()","description":"com.squareup.workflow1.testing.WorkerTester.assertNotFinished","location":"workflow-testing/com.squareup.workflow1.testing/-worker-tester/assert-not-finished.html","searchKeys":["assertNotFinished","abstract fun assertNotFinished()","com.squareup.workflow1.testing.WorkerTester.assertNotFinished"]},{"name":"abstract fun expectSideEffect(description: String, exactMatch: Boolean = true, matcher: (key: String) -> Boolean): RenderTester","description":"com.squareup.workflow1.testing.RenderTester.expectSideEffect","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/expect-side-effect.html","searchKeys":["expectSideEffect","abstract fun expectSideEffect(description: String, exactMatch: Boolean = true, matcher: (key: String) -> Boolean): RenderTester","com.squareup.workflow1.testing.RenderTester.expectSideEffect"]},{"name":"abstract fun render(block: (rendering: RenderingT) -> Unit = {}): RenderTestResult","description":"com.squareup.workflow1.testing.RenderTester.render","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/render.html","searchKeys":["render","abstract fun render(block: (rendering: RenderingT) -> Unit = {}): RenderTestResult","com.squareup.workflow1.testing.RenderTester.render"]},{"name":"abstract fun requireExplicitSideEffectExpectations(): RenderTester","description":"com.squareup.workflow1.testing.RenderTester.requireExplicitSideEffectExpectations","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/require-explicit-side-effect-expectations.html","searchKeys":["requireExplicitSideEffectExpectations","abstract fun requireExplicitSideEffectExpectations(): RenderTester","com.squareup.workflow1.testing.RenderTester.requireExplicitSideEffectExpectations"]},{"name":"abstract fun requireExplicitWorkerExpectations(): RenderTester","description":"com.squareup.workflow1.testing.RenderTester.requireExplicitWorkerExpectations","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/require-explicit-worker-expectations.html","searchKeys":["requireExplicitWorkerExpectations","abstract fun requireExplicitWorkerExpectations(): RenderTester","com.squareup.workflow1.testing.RenderTester.requireExplicitWorkerExpectations"]},{"name":"abstract fun testNextRender(): RenderTester","description":"com.squareup.workflow1.testing.RenderTestResult.testNextRender","location":"workflow-testing/com.squareup.workflow1.testing/-render-test-result/test-next-render.html","searchKeys":["testNextRender","abstract fun testNextRender(): RenderTester","com.squareup.workflow1.testing.RenderTestResult.testNextRender"]},{"name":"abstract fun testNextRenderWithProps(newProps: PropsT): RenderTester","description":"com.squareup.workflow1.testing.RenderTestResult.testNextRenderWithProps","location":"workflow-testing/com.squareup.workflow1.testing/-render-test-result/test-next-render-with-props.html","searchKeys":["testNextRenderWithProps","abstract fun testNextRenderWithProps(newProps: PropsT): RenderTester","com.squareup.workflow1.testing.RenderTestResult.testNextRenderWithProps"]},{"name":"abstract fun verifyAction(block: (WorkflowAction) -> Unit): RenderTestResult","description":"com.squareup.workflow1.testing.RenderTestResult.verifyAction","location":"workflow-testing/com.squareup.workflow1.testing/-render-test-result/verify-action.html","searchKeys":["verifyAction","abstract fun verifyAction(block: (WorkflowAction) -> Unit): RenderTestResult","com.squareup.workflow1.testing.RenderTestResult.verifyAction"]},{"name":"abstract fun verifyActionResult(block: (newState: StateT, appliedResult: WorkflowOutput?) -> Unit): RenderTestResult","description":"com.squareup.workflow1.testing.RenderTestResult.verifyActionResult","location":"workflow-testing/com.squareup.workflow1.testing/-render-test-result/verify-action-result.html","searchKeys":["verifyActionResult","abstract fun verifyActionResult(block: (newState: StateT, appliedResult: WorkflowOutput?) -> Unit): RenderTestResult","com.squareup.workflow1.testing.RenderTestResult.verifyActionResult"]},{"name":"abstract suspend fun assertFinished()","description":"com.squareup.workflow1.testing.WorkerTester.assertFinished","location":"workflow-testing/com.squareup.workflow1.testing/-worker-tester/assert-finished.html","searchKeys":["assertFinished","abstract suspend fun assertFinished()","com.squareup.workflow1.testing.WorkerTester.assertFinished"]},{"name":"abstract suspend fun cancelWorker()","description":"com.squareup.workflow1.testing.WorkerTester.cancelWorker","location":"workflow-testing/com.squareup.workflow1.testing/-worker-tester/cancel-worker.html","searchKeys":["cancelWorker","abstract suspend fun cancelWorker()","com.squareup.workflow1.testing.WorkerTester.cancelWorker"]},{"name":"abstract suspend fun getException(): Throwable","description":"com.squareup.workflow1.testing.WorkerTester.getException","location":"workflow-testing/com.squareup.workflow1.testing/-worker-tester/get-exception.html","searchKeys":["getException","abstract suspend fun getException(): Throwable","com.squareup.workflow1.testing.WorkerTester.getException"]},{"name":"abstract suspend fun nextOutput(): T","description":"com.squareup.workflow1.testing.WorkerTester.nextOutput","location":"workflow-testing/com.squareup.workflow1.testing/-worker-tester/next-output.html","searchKeys":["nextOutput","abstract suspend fun nextOutput(): T","com.squareup.workflow1.testing.WorkerTester.nextOutput"]},{"name":"abstract val testCoroutineScheduler: TestCoroutineScheduler","description":"com.squareup.workflow1.testing.WorkerTester.testCoroutineScheduler","location":"workflow-testing/com.squareup.workflow1.testing/-worker-tester/test-coroutine-scheduler.html","searchKeys":["testCoroutineScheduler","abstract val testCoroutineScheduler: TestCoroutineScheduler","com.squareup.workflow1.testing.WorkerTester.testCoroutineScheduler"]},{"name":"class Matched(val childRendering: Any?, val output: WorkflowOutput? = null) : RenderTester.ChildWorkflowMatch","description":"com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.Matched","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-child-workflow-match/-matched/index.html","searchKeys":["Matched","class Matched(val childRendering: Any?, val output: WorkflowOutput? = null) : RenderTester.ChildWorkflowMatch","com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.Matched"]},{"name":"class RenderChildInvocation(val workflow: Workflow<*, *, *>, val props: Any?, val outputType: KTypeProjection, val renderingType: KTypeProjection, val renderKey: String)","description":"com.squareup.workflow1.testing.RenderTester.RenderChildInvocation","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-render-child-invocation/index.html","searchKeys":["RenderChildInvocation","class RenderChildInvocation(val workflow: Workflow<*, *, *>, val props: Any?, val outputType: KTypeProjection, val renderingType: KTypeProjection, val renderKey: String)","com.squareup.workflow1.testing.RenderTester.RenderChildInvocation"]},{"name":"class StartFromCompleteSnapshot(val snapshot: TreeSnapshot) : WorkflowTestParams.StartMode ","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromCompleteSnapshot","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-from-complete-snapshot/index.html","searchKeys":["StartFromCompleteSnapshot","class StartFromCompleteSnapshot(val snapshot: TreeSnapshot) : WorkflowTestParams.StartMode ","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromCompleteSnapshot"]},{"name":"class StartFromState(val state: StateT) : WorkflowTestParams.StartMode ","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromState","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-from-state/index.html","searchKeys":["StartFromState","class StartFromState(val state: StateT) : WorkflowTestParams.StartMode ","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromState"]},{"name":"class StartFromWorkflowSnapshot(val snapshot: Snapshot) : WorkflowTestParams.StartMode ","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromWorkflowSnapshot","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-from-workflow-snapshot/index.html","searchKeys":["StartFromWorkflowSnapshot","class StartFromWorkflowSnapshot(val snapshot: Snapshot) : WorkflowTestParams.StartMode ","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromWorkflowSnapshot"]},{"name":"class WorkerSink(name: String, type: KClass<*>) : Worker ","description":"com.squareup.workflow1.testing.WorkerSink","location":"workflow-testing/com.squareup.workflow1.testing/-worker-sink/index.html","searchKeys":["WorkerSink","class WorkerSink(name: String, type: KClass<*>) : Worker ","com.squareup.workflow1.testing.WorkerSink"]},{"name":"class WorkflowTestParams(val startFrom: WorkflowTestParams.StartMode = StartFresh, val checkRenderIdempotence: Boolean = true)","description":"com.squareup.workflow1.testing.WorkflowTestParams","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/index.html","searchKeys":["WorkflowTestParams","class WorkflowTestParams(val startFrom: WorkflowTestParams.StartMode = StartFresh, val checkRenderIdempotence: Boolean = true)","com.squareup.workflow1.testing.WorkflowTestParams"]},{"name":"class WorkflowTestRuntime","description":"com.squareup.workflow1.testing.WorkflowTestRuntime","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/index.html","searchKeys":["WorkflowTestRuntime","class WorkflowTestRuntime","com.squareup.workflow1.testing.WorkflowTestRuntime"]},{"name":"class WorkflowTurbine(val firstRendering: RenderingT, receiveTurbine: ReceiveTurbine)","description":"com.squareup.workflow1.testing.WorkflowTurbine","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-turbine/index.html","searchKeys":["WorkflowTurbine","class WorkflowTurbine(val firstRendering: RenderingT, receiveTurbine: ReceiveTurbine)","com.squareup.workflow1.testing.WorkflowTurbine"]},{"name":"const val DEFAULT_TIMEOUT_MS: Long = 500","description":"com.squareup.workflow1.testing.WorkflowTestRuntime.Companion.DEFAULT_TIMEOUT_MS","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/-companion/-d-e-f-a-u-l-t_-t-i-m-e-o-u-t_-m-s.html","searchKeys":["DEFAULT_TIMEOUT_MS","const val DEFAULT_TIMEOUT_MS: Long = 500","com.squareup.workflow1.testing.WorkflowTestRuntime.Companion.DEFAULT_TIMEOUT_MS"]},{"name":"const val WORKFLOW_TEST_DEFAULT_TIMEOUT_MS: Long","description":"com.squareup.workflow1.testing.WorkflowTurbine.Companion.WORKFLOW_TEST_DEFAULT_TIMEOUT_MS","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-turbine/-companion/-w-o-r-k-f-l-o-w_-t-e-s-t_-d-e-f-a-u-l-t_-t-i-m-e-o-u-t_-m-s.html","searchKeys":["WORKFLOW_TEST_DEFAULT_TIMEOUT_MS","const val WORKFLOW_TEST_DEFAULT_TIMEOUT_MS: Long","com.squareup.workflow1.testing.WorkflowTurbine.Companion.WORKFLOW_TEST_DEFAULT_TIMEOUT_MS"]},{"name":"constructor()","description":"com.squareup.workflow1.testing.RenderTester.RenderTester","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-render-tester.html","searchKeys":["RenderTester","constructor()","com.squareup.workflow1.testing.RenderTester.RenderTester"]},{"name":"constructor(childRendering: Any?, output: WorkflowOutput? = null)","description":"com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.Matched.Matched","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-child-workflow-match/-matched/-matched.html","searchKeys":["Matched","constructor(childRendering: Any?, output: WorkflowOutput? = null)","com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.Matched.Matched"]},{"name":"constructor(firstRendering: RenderingT, receiveTurbine: ReceiveTurbine)","description":"com.squareup.workflow1.testing.WorkflowTurbine.WorkflowTurbine","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-turbine/-workflow-turbine.html","searchKeys":["WorkflowTurbine","constructor(firstRendering: RenderingT, receiveTurbine: ReceiveTurbine)","com.squareup.workflow1.testing.WorkflowTurbine.WorkflowTurbine"]},{"name":"constructor(name: String, type: KClass<*>)","description":"com.squareup.workflow1.testing.WorkerSink.WorkerSink","location":"workflow-testing/com.squareup.workflow1.testing/-worker-sink/-worker-sink.html","searchKeys":["WorkerSink","constructor(name: String, type: KClass<*>)","com.squareup.workflow1.testing.WorkerSink.WorkerSink"]},{"name":"constructor(snapshot: Snapshot)","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromWorkflowSnapshot.StartFromWorkflowSnapshot","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-from-workflow-snapshot/-start-from-workflow-snapshot.html","searchKeys":["StartFromWorkflowSnapshot","constructor(snapshot: Snapshot)","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromWorkflowSnapshot.StartFromWorkflowSnapshot"]},{"name":"constructor(snapshot: TreeSnapshot)","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromCompleteSnapshot.StartFromCompleteSnapshot","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-from-complete-snapshot/-start-from-complete-snapshot.html","searchKeys":["StartFromCompleteSnapshot","constructor(snapshot: TreeSnapshot)","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromCompleteSnapshot.StartFromCompleteSnapshot"]},{"name":"constructor(startFrom: WorkflowTestParams.StartMode = StartFresh, checkRenderIdempotence: Boolean = true)","description":"com.squareup.workflow1.testing.WorkflowTestParams.WorkflowTestParams","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-workflow-test-params.html","searchKeys":["WorkflowTestParams","constructor(startFrom: WorkflowTestParams.StartMode = StartFresh, checkRenderIdempotence: Boolean = true)","com.squareup.workflow1.testing.WorkflowTestParams.WorkflowTestParams"]},{"name":"constructor(state: StateT)","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromState.StartFromState","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-from-state/-start-from-state.html","searchKeys":["StartFromState","constructor(state: StateT)","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromState.StartFromState"]},{"name":"constructor(workflow: Workflow<*, *, *>, props: Any?, outputType: KTypeProjection, renderingType: KTypeProjection, renderKey: String)","description":"com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.RenderChildInvocation","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-render-child-invocation/-render-child-invocation.html","searchKeys":["RenderChildInvocation","constructor(workflow: Workflow<*, *, *>, props: Any?, outputType: KTypeProjection, renderingType: KTypeProjection, renderKey: String)","com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.RenderChildInvocation"]},{"name":"fun RenderTester.expectWorkflow(identifier: WorkflowIdentifier, rendering: ChildRenderingT, output: WorkflowOutput?, key: String = \"\", description: String = \"\", assertProps: (props: Any?) -> Unit = {}): RenderTester","description":"com.squareup.workflow1.testing.expectWorkflow","location":"workflow-testing/com.squareup.workflow1.testing/expect-workflow.html","searchKeys":["expectWorkflow","fun RenderTester.expectWorkflow(identifier: WorkflowIdentifier, rendering: ChildRenderingT, output: WorkflowOutput?, key: String = \"\", description: String = \"\", assertProps: (props: Any?) -> Unit = {}): RenderTester","com.squareup.workflow1.testing.expectWorkflow"]},{"name":"fun Workflow.headlessIntegrationTest(coroutineContext: CoroutineContext = UnconfinedTestDispatcher(), interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}, testTimeout: Long = WORKFLOW_TEST_DEFAULT_TIMEOUT_MS, testCase: suspend WorkflowTurbine.() -> Unit)","description":"com.squareup.workflow1.testing.headlessIntegrationTest","location":"workflow-testing/com.squareup.workflow1.testing/headless-integration-test.html","searchKeys":["headlessIntegrationTest","fun Workflow.headlessIntegrationTest(coroutineContext: CoroutineContext = UnconfinedTestDispatcher(), interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}, testTimeout: Long = WORKFLOW_TEST_DEFAULT_TIMEOUT_MS, testCase: suspend WorkflowTurbine.() -> Unit)","com.squareup.workflow1.testing.headlessIntegrationTest"]},{"name":"fun SessionWorkflow.testRender(props: PropsT, workflowScope: CoroutineScope): RenderTester","description":"com.squareup.workflow1.testing.testRender","location":"workflow-testing/com.squareup.workflow1.testing/test-render.html","searchKeys":["testRender","fun SessionWorkflow.testRender(props: PropsT, workflowScope: CoroutineScope): RenderTester","com.squareup.workflow1.testing.testRender"]},{"name":"fun Workflow.headlessIntegrationTest(props: StateFlow, coroutineContext: CoroutineContext = UnconfinedTestDispatcher(), interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}, testTimeout: Long = WORKFLOW_TEST_DEFAULT_TIMEOUT_MS, testCase: suspend WorkflowTurbine.() -> Unit)","description":"com.squareup.workflow1.testing.headlessIntegrationTest","location":"workflow-testing/com.squareup.workflow1.testing/headless-integration-test.html","searchKeys":["headlessIntegrationTest","fun Workflow.headlessIntegrationTest(props: StateFlow, coroutineContext: CoroutineContext = UnconfinedTestDispatcher(), interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}, testTimeout: Long = WORKFLOW_TEST_DEFAULT_TIMEOUT_MS, testCase: suspend WorkflowTurbine.() -> Unit)","com.squareup.workflow1.testing.headlessIntegrationTest"]},{"name":"fun Workflow.testRender(props: PropsT): RenderTester","description":"com.squareup.workflow1.testing.testRender","location":"workflow-testing/com.squareup.workflow1.testing/test-render.html","searchKeys":["testRender","fun Workflow.testRender(props: PropsT): RenderTester","com.squareup.workflow1.testing.testRender"]},{"name":"fun RenderTester.expectSideEffect(key: String): RenderTester","description":"com.squareup.workflow1.testing.expectSideEffect","location":"workflow-testing/com.squareup.workflow1.testing/expect-side-effect.html","searchKeys":["expectSideEffect","fun RenderTester.expectSideEffect(key: String): RenderTester","com.squareup.workflow1.testing.expectSideEffect"]},{"name":"fun RenderTester.expectWorker(workerType: KType, key: String = \"\", assertWorker: (Worker<*>) -> Unit = {}, output: WorkflowOutput<*>? = null, description: String = \"\"): RenderTester","description":"com.squareup.workflow1.testing.expectWorker","location":"workflow-testing/com.squareup.workflow1.testing/expect-worker.html","searchKeys":["expectWorker","fun RenderTester.expectWorker(workerType: KType, key: String = \"\", assertWorker: (Worker<*>) -> Unit = {}, output: WorkflowOutput<*>? = null, description: String = \"\"): RenderTester","com.squareup.workflow1.testing.expectWorker"]},{"name":"fun StatefulWorkflow.testRender(props: PropsT, initialState: StateT): RenderTester","description":"com.squareup.workflow1.testing.testRender","location":"workflow-testing/com.squareup.workflow1.testing/test-render.html","searchKeys":["testRender","fun StatefulWorkflow.testRender(props: PropsT, initialState: StateT): RenderTester","com.squareup.workflow1.testing.testRender"]},{"name":"fun StatefulWorkflow.launchForTestingFromStateWith(initialState: StateT, context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> Unit)","description":"com.squareup.workflow1.testing.launchForTestingFromStateWith","location":"workflow-testing/com.squareup.workflow1.testing/launch-for-testing-from-state-with.html","searchKeys":["launchForTestingFromStateWith","fun StatefulWorkflow.launchForTestingFromStateWith(initialState: StateT, context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> Unit)","com.squareup.workflow1.testing.launchForTestingFromStateWith"]},{"name":"fun Workflow.launchForTestingFromStartWith(testParams: WorkflowTestParams = WorkflowTestParams(), context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> T): T","description":"com.squareup.workflow1.testing.launchForTestingFromStartWith","location":"workflow-testing/com.squareup.workflow1.testing/launch-for-testing-from-start-with.html","searchKeys":["launchForTestingFromStartWith","fun Workflow.launchForTestingFromStartWith(testParams: WorkflowTestParams = WorkflowTestParams(), context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> T): T","com.squareup.workflow1.testing.launchForTestingFromStartWith"]},{"name":"fun Workflow.launchForTestingFromStartWith(props: PropsT, testParams: WorkflowTestParams = WorkflowTestParams(), context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> T): T","description":"com.squareup.workflow1.testing.launchForTestingFromStartWith","location":"workflow-testing/com.squareup.workflow1.testing/launch-for-testing-from-start-with.html","searchKeys":["launchForTestingFromStartWith","fun Workflow.launchForTestingFromStartWith(props: PropsT, testParams: WorkflowTestParams = WorkflowTestParams(), context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> T): T","com.squareup.workflow1.testing.launchForTestingFromStartWith"]},{"name":"fun StatefulWorkflow.launchForTestingFromStateWith(props: PropsT, initialState: StateT, context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> T): T","description":"com.squareup.workflow1.testing.launchForTestingFromStateWith","location":"workflow-testing/com.squareup.workflow1.testing/launch-for-testing-from-state-with.html","searchKeys":["launchForTestingFromStateWith","fun StatefulWorkflow.launchForTestingFromStateWith(props: PropsT, initialState: StateT, context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> T): T","com.squareup.workflow1.testing.launchForTestingFromStateWith"]},{"name":"fun StatefulWorkflow.launchForTestingWith(props: PropsT, testParams: WorkflowTestParams = WorkflowTestParams(), context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> T): T","description":"com.squareup.workflow1.testing.launchForTestingWith","location":"workflow-testing/com.squareup.workflow1.testing/launch-for-testing-with.html","searchKeys":["launchForTestingWith","fun StatefulWorkflow.launchForTestingWith(props: PropsT, testParams: WorkflowTestParams = WorkflowTestParams(), context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> T): T","com.squareup.workflow1.testing.launchForTestingWith"]},{"name":"fun Worker.test(timeoutMs: Long = DEFAULT_TIMEOUT_MS, block: suspend WorkerTester.() -> Unit)","description":"com.squareup.workflow1.testing.test","location":"workflow-testing/com.squareup.workflow1.testing/test.html","searchKeys":["test","fun Worker.test(timeoutMs: Long = DEFAULT_TIMEOUT_MS, block: suspend WorkerTester.() -> Unit)","com.squareup.workflow1.testing.test"]},{"name":"fun awaitNextOutput(timeoutMs: Long? = null): OutputT","description":"com.squareup.workflow1.testing.WorkflowTestRuntime.awaitNextOutput","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/await-next-output.html","searchKeys":["awaitNextOutput","fun awaitNextOutput(timeoutMs: Long? = null): OutputT","com.squareup.workflow1.testing.WorkflowTestRuntime.awaitNextOutput"]},{"name":"fun awaitNextRendering(timeoutMs: Long? = null, skipIntermediate: Boolean = true): RenderingT","description":"com.squareup.workflow1.testing.WorkflowTestRuntime.awaitNextRendering","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/await-next-rendering.html","searchKeys":["awaitNextRendering","fun awaitNextRendering(timeoutMs: Long? = null, skipIntermediate: Boolean = true): RenderingT","com.squareup.workflow1.testing.WorkflowTestRuntime.awaitNextRendering"]},{"name":"fun awaitNextSnapshot(timeoutMs: Long? = null, skipIntermediate: Boolean = true): TreeSnapshot","description":"com.squareup.workflow1.testing.WorkflowTestRuntime.awaitNextSnapshot","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/await-next-snapshot.html","searchKeys":["awaitNextSnapshot","fun awaitNextSnapshot(timeoutMs: Long? = null, skipIntermediate: Boolean = true): TreeSnapshot","com.squareup.workflow1.testing.WorkflowTestRuntime.awaitNextSnapshot"]},{"name":"fun send(value: T)","description":"com.squareup.workflow1.testing.WorkerSink.send","location":"workflow-testing/com.squareup.workflow1.testing/-worker-sink/send.html","searchKeys":["send","fun send(value: T)","com.squareup.workflow1.testing.WorkerSink.send"]},{"name":"fun sendProps(input: PropsT)","description":"com.squareup.workflow1.testing.WorkflowTestRuntime.sendProps","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/send-props.html","searchKeys":["sendProps","fun sendProps(input: PropsT)","com.squareup.workflow1.testing.WorkflowTestRuntime.sendProps"]},{"name":"inline fun RenderTester.expectWorkflow(workflowType: KClass>, rendering: ChildRenderingT, key: String = \"\", crossinline assertProps: (props: ChildPropsT) -> Unit = {}, output: WorkflowOutput? = null, description: String = \"\"): RenderTester","description":"com.squareup.workflow1.testing.expectWorkflow","location":"workflow-testing/com.squareup.workflow1.testing/expect-workflow.html","searchKeys":["expectWorkflow","inline fun RenderTester.expectWorkflow(workflowType: KClass>, rendering: ChildRenderingT, key: String = \"\", crossinline assertProps: (props: ChildPropsT) -> Unit = {}, output: WorkflowOutput? = null, description: String = \"\"): RenderTester","com.squareup.workflow1.testing.expectWorkflow"]},{"name":"inline fun RenderTester.expectWorkflow(identifier: WorkflowIdentifier, rendering: ChildRenderingT, key: String = \"\", description: String = \"\", noinline assertProps: (props: Any?) -> Unit = {}): RenderTester","description":"com.squareup.workflow1.testing.expectWorkflow","location":"workflow-testing/com.squareup.workflow1.testing/expect-workflow.html","searchKeys":["expectWorkflow","inline fun RenderTester.expectWorkflow(identifier: WorkflowIdentifier, rendering: ChildRenderingT, key: String = \"\", description: String = \"\", noinline assertProps: (props: Any?) -> Unit = {}): RenderTester","com.squareup.workflow1.testing.expectWorkflow"]},{"name":"inline fun > RenderTester.expectWorker(expected: WorkerT, key: String = \"\", output: WorkflowOutput? = null, description: String = \"\"): RenderTester","description":"com.squareup.workflow1.testing.expectWorker","location":"workflow-testing/com.squareup.workflow1.testing/expect-worker.html","searchKeys":["expectWorker","inline fun > RenderTester.expectWorker(expected: WorkerT, key: String = \"\", output: WorkflowOutput? = null, description: String = \"\"): RenderTester","com.squareup.workflow1.testing.expectWorker"]},{"name":"inline fun > RenderTester.expectWorker(workerClass: KClass, key: String = \"\", crossinline assertWorker: (WorkerT) -> Unit = {}, output: WorkflowOutput? = null, description: String = \"\"): RenderTester","description":"com.squareup.workflow1.testing.expectWorker","location":"workflow-testing/com.squareup.workflow1.testing/expect-worker.html","searchKeys":["expectWorker","inline fun > RenderTester.expectWorker(workerClass: KClass, key: String = \"\", crossinline assertWorker: (WorkerT) -> Unit = {}, output: WorkflowOutput? = null, description: String = \"\"): RenderTester","com.squareup.workflow1.testing.expectWorker"]},{"name":"inline fun RenderTester.expectWorkerOutputting(outputType: KType, key: String = \"\", crossinline assertWorker: (Worker<*>) -> Unit = {}, output: WorkflowOutput<*>? = null, description: String = \"\"): RenderTester","description":"com.squareup.workflow1.testing.expectWorkerOutputting","location":"workflow-testing/com.squareup.workflow1.testing/expect-worker-outputting.html","searchKeys":["expectWorkerOutputting","inline fun RenderTester.expectWorkerOutputting(outputType: KType, key: String = \"\", crossinline assertWorker: (Worker<*>) -> Unit = {}, output: WorkflowOutput<*>? = null, description: String = \"\"): RenderTester","com.squareup.workflow1.testing.expectWorkerOutputting"]},{"name":"inline fun WorkerSink(name: String): WorkerSink","description":"com.squareup.workflow1.testing.WorkerSink","location":"workflow-testing/com.squareup.workflow1.testing/-worker-sink.html","searchKeys":["WorkerSink","inline fun WorkerSink(name: String): WorkerSink","com.squareup.workflow1.testing.WorkerSink"]},{"name":"interface RenderTestResult","description":"com.squareup.workflow1.testing.RenderTestResult","location":"workflow-testing/com.squareup.workflow1.testing/-render-test-result/index.html","searchKeys":["RenderTestResult","interface RenderTestResult","com.squareup.workflow1.testing.RenderTestResult"]},{"name":"interface WorkerTester","description":"com.squareup.workflow1.testing.WorkerTester","location":"workflow-testing/com.squareup.workflow1.testing/-worker-tester/index.html","searchKeys":["WorkerTester","interface WorkerTester","com.squareup.workflow1.testing.WorkerTester"]},{"name":"object Companion","description":"com.squareup.workflow1.testing.WorkflowTestRuntime.Companion","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.testing.WorkflowTestRuntime.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.testing.WorkflowTurbine.Companion","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-turbine/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.testing.WorkflowTurbine.Companion"]},{"name":"object NotMatched : RenderTester.ChildWorkflowMatch","description":"com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.NotMatched","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-child-workflow-match/-not-matched/index.html","searchKeys":["NotMatched","object NotMatched : RenderTester.ChildWorkflowMatch","com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.NotMatched"]},{"name":"object RenderIdempotencyChecker : WorkflowInterceptor","description":"com.squareup.workflow1.testing.RenderIdempotencyChecker","location":"workflow-testing/com.squareup.workflow1.testing/-render-idempotency-checker/index.html","searchKeys":["RenderIdempotencyChecker","object RenderIdempotencyChecker : WorkflowInterceptor","com.squareup.workflow1.testing.RenderIdempotencyChecker"]},{"name":"object StartFresh : WorkflowTestParams.StartMode ","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFresh","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-fresh/index.html","searchKeys":["StartFresh","object StartFresh : WorkflowTestParams.StartMode ","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFresh"]},{"name":"open override fun onRender(renderProps: P, renderState: S, context: BaseRenderContext, proceed: (P, S, WorkflowInterceptor.RenderContextInterceptor?) -> R, session: WorkflowInterceptor.WorkflowSession): R","description":"com.squareup.workflow1.testing.RenderIdempotencyChecker.onRender","location":"workflow-testing/com.squareup.workflow1.testing/-render-idempotency-checker/on-render.html","searchKeys":["onRender","open override fun onRender(renderProps: P, renderState: S, context: BaseRenderContext, proceed: (P, S, WorkflowInterceptor.RenderContextInterceptor?) -> R, session: WorkflowInterceptor.WorkflowSession): R","com.squareup.workflow1.testing.RenderIdempotencyChecker.onRender"]},{"name":"open override fun doesSameWorkAs(otherWorker: Worker<*>): Boolean","description":"com.squareup.workflow1.testing.WorkerSink.doesSameWorkAs","location":"workflow-testing/com.squareup.workflow1.testing/-worker-sink/does-same-work-as.html","searchKeys":["doesSameWorkAs","open override fun doesSameWorkAs(otherWorker: Worker<*>): Boolean","com.squareup.workflow1.testing.WorkerSink.doesSameWorkAs"]},{"name":"open override fun run(): Flow","description":"com.squareup.workflow1.testing.WorkerSink.run","location":"workflow-testing/com.squareup.workflow1.testing/-worker-sink/run.html","searchKeys":["run","open override fun run(): Flow","com.squareup.workflow1.testing.WorkerSink.run"]},{"name":"open override fun toString(): String","description":"com.squareup.workflow1.testing.WorkerSink.toString","location":"workflow-testing/com.squareup.workflow1.testing/-worker-sink/to-string.html","searchKeys":["toString","open override fun toString(): String","com.squareup.workflow1.testing.WorkerSink.toString"]},{"name":"sealed class ChildWorkflowMatch","description":"com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-child-workflow-match/index.html","searchKeys":["ChildWorkflowMatch","sealed class ChildWorkflowMatch","com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch"]},{"name":"sealed class StartMode","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/index.html","searchKeys":["StartMode","sealed class StartMode","com.squareup.workflow1.testing.WorkflowTestParams.StartMode"]},{"name":"suspend fun awaitNext(precondition: (RenderingT) -> Boolean = { true }, map: (RenderingT) -> T, satisfying: T.() -> Boolean = { true }): T","description":"com.squareup.workflow1.testing.WorkflowTurbine.awaitNext","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-turbine/await-next.html","searchKeys":["awaitNext","suspend fun awaitNext(precondition: (RenderingT) -> Boolean = { true }, map: (RenderingT) -> T, satisfying: T.() -> Boolean = { true }): T","com.squareup.workflow1.testing.WorkflowTurbine.awaitNext"]},{"name":"suspend fun awaitNextRendering(): RenderingT","description":"com.squareup.workflow1.testing.WorkflowTurbine.awaitNextRendering","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-turbine/await-next-rendering.html","searchKeys":["awaitNextRendering","suspend fun awaitNextRendering(): RenderingT","com.squareup.workflow1.testing.WorkflowTurbine.awaitNextRendering"]},{"name":"suspend fun awaitNextRenderingSatisfying(predicate: (RenderingT) -> Boolean): RenderingT","description":"com.squareup.workflow1.testing.WorkflowTurbine.awaitNextRenderingSatisfying","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-turbine/await-next-rendering-satisfying.html","searchKeys":["awaitNextRenderingSatisfying","suspend fun awaitNextRenderingSatisfying(predicate: (RenderingT) -> Boolean): RenderingT","com.squareup.workflow1.testing.WorkflowTurbine.awaitNextRenderingSatisfying"]},{"name":"suspend fun skipRenderings(count: Int)","description":"com.squareup.workflow1.testing.WorkflowTurbine.skipRenderings","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-turbine/skip-renderings.html","searchKeys":["skipRenderings","suspend fun skipRenderings(count: Int)","com.squareup.workflow1.testing.WorkflowTurbine.skipRenderings"]},{"name":"val checkRenderIdempotence: Boolean = true","description":"com.squareup.workflow1.testing.WorkflowTestParams.checkRenderIdempotence","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/check-render-idempotence.html","searchKeys":["checkRenderIdempotence","val checkRenderIdempotence: Boolean = true","com.squareup.workflow1.testing.WorkflowTestParams.checkRenderIdempotence"]},{"name":"val childRendering: Any?","description":"com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.Matched.childRendering","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-child-workflow-match/-matched/child-rendering.html","searchKeys":["childRendering","val childRendering: Any?","com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.Matched.childRendering"]},{"name":"val firstRendering: RenderingT","description":"com.squareup.workflow1.testing.WorkflowTurbine.firstRendering","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-turbine/first-rendering.html","searchKeys":["firstRendering","val firstRendering: RenderingT","com.squareup.workflow1.testing.WorkflowTurbine.firstRendering"]},{"name":"val hasOutput: Boolean","description":"com.squareup.workflow1.testing.WorkflowTestRuntime.hasOutput","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/has-output.html","searchKeys":["hasOutput","val hasOutput: Boolean","com.squareup.workflow1.testing.WorkflowTestRuntime.hasOutput"]},{"name":"val hasRendering: Boolean","description":"com.squareup.workflow1.testing.WorkflowTestRuntime.hasRendering","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/has-rendering.html","searchKeys":["hasRendering","val hasRendering: Boolean","com.squareup.workflow1.testing.WorkflowTestRuntime.hasRendering"]},{"name":"val hasSnapshot: Boolean","description":"com.squareup.workflow1.testing.WorkflowTestRuntime.hasSnapshot","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/has-snapshot.html","searchKeys":["hasSnapshot","val hasSnapshot: Boolean","com.squareup.workflow1.testing.WorkflowTestRuntime.hasSnapshot"]},{"name":"val output: WorkflowOutput? = null","description":"com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.Matched.output","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-child-workflow-match/-matched/output.html","searchKeys":["output","val output: WorkflowOutput? = null","com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.Matched.output"]},{"name":"val outputType: KTypeProjection","description":"com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.outputType","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-render-child-invocation/output-type.html","searchKeys":["outputType","val outputType: KTypeProjection","com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.outputType"]},{"name":"val props: Any?","description":"com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.props","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-render-child-invocation/props.html","searchKeys":["props","val props: Any?","com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.props"]},{"name":"val renderKey: String","description":"com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.renderKey","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-render-child-invocation/render-key.html","searchKeys":["renderKey","val renderKey: String","com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.renderKey"]},{"name":"val renderingType: KTypeProjection","description":"com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.renderingType","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-render-child-invocation/rendering-type.html","searchKeys":["renderingType","val renderingType: KTypeProjection","com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.renderingType"]},{"name":"val snapshot: Snapshot","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromWorkflowSnapshot.snapshot","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-from-workflow-snapshot/snapshot.html","searchKeys":["snapshot","val snapshot: Snapshot","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromWorkflowSnapshot.snapshot"]},{"name":"val snapshot: TreeSnapshot","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromCompleteSnapshot.snapshot","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-from-complete-snapshot/snapshot.html","searchKeys":["snapshot","val snapshot: TreeSnapshot","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromCompleteSnapshot.snapshot"]},{"name":"val startFrom: WorkflowTestParams.StartMode","description":"com.squareup.workflow1.testing.WorkflowTestParams.startFrom","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/start-from.html","searchKeys":["startFrom","val startFrom: WorkflowTestParams.StartMode","com.squareup.workflow1.testing.WorkflowTestParams.startFrom"]},{"name":"val state: StateT","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromState.state","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-from-state/state.html","searchKeys":["state","val state: StateT","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromState.state"]},{"name":"val workflow: Workflow<*, *, *>","description":"com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.workflow","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-render-child-invocation/workflow.html","searchKeys":["workflow","val workflow: Workflow<*, *, *>","com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.workflow"]},{"name":"abstract fun freeMemory(): Long","description":"com.squareup.workflow1.diagnostic.tracing.MemoryStats.freeMemory","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-memory-stats/free-memory.html","searchKeys":["freeMemory","abstract fun freeMemory(): Long","com.squareup.workflow1.diagnostic.tracing.MemoryStats.freeMemory"]},{"name":"abstract fun totalMemory(): Long","description":"com.squareup.workflow1.diagnostic.tracing.MemoryStats.totalMemory","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-memory-stats/total-memory.html","searchKeys":["totalMemory","abstract fun totalMemory(): Long","com.squareup.workflow1.diagnostic.tracing.MemoryStats.totalMemory"]},{"name":"class TracingWorkflowInterceptor : WorkflowInterceptor","description":"com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-tracing-workflow-interceptor/index.html","searchKeys":["TracingWorkflowInterceptor","class TracingWorkflowInterceptor : WorkflowInterceptor","com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor"]},{"name":"constructor(memoryStats: MemoryStats = RuntimeMemoryStats, loggerProvider: (workflowScope: CoroutineScope, workflowType: String) -> TraceLogger)","description":"com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.TracingWorkflowInterceptor","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-tracing-workflow-interceptor/-tracing-workflow-interceptor.html","searchKeys":["TracingWorkflowInterceptor","constructor(memoryStats: MemoryStats = RuntimeMemoryStats, loggerProvider: (workflowScope: CoroutineScope, workflowType: String) -> TraceLogger)","com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.TracingWorkflowInterceptor"]},{"name":"fun TracingWorkflowInterceptor(file: File, name: String = \"\"): TracingWorkflowInterceptor","description":"com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-tracing-workflow-interceptor.html","searchKeys":["TracingWorkflowInterceptor","fun TracingWorkflowInterceptor(file: File, name: String = \"\"): TracingWorkflowInterceptor","com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor"]},{"name":"fun TracingWorkflowInterceptor(name: String = \"\", memoryStats: MemoryStats = RuntimeMemoryStats, encoderProvider: (workflowScope: CoroutineScope) -> TraceEncoder): TracingWorkflowInterceptor","description":"com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-tracing-workflow-interceptor.html","searchKeys":["TracingWorkflowInterceptor","fun TracingWorkflowInterceptor(name: String = \"\", memoryStats: MemoryStats = RuntimeMemoryStats, encoderProvider: (workflowScope: CoroutineScope) -> TraceEncoder): TracingWorkflowInterceptor","com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor"]},{"name":"interface MemoryStats","description":"com.squareup.workflow1.diagnostic.tracing.MemoryStats","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-memory-stats/index.html","searchKeys":["MemoryStats","interface MemoryStats","com.squareup.workflow1.diagnostic.tracing.MemoryStats"]},{"name":"object RuntimeMemoryStats : MemoryStats","description":"com.squareup.workflow1.diagnostic.tracing.RuntimeMemoryStats","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-runtime-memory-stats/index.html","searchKeys":["RuntimeMemoryStats","object RuntimeMemoryStats : MemoryStats","com.squareup.workflow1.diagnostic.tracing.RuntimeMemoryStats"]},{"name":"open override fun onRender(renderProps: P, renderState: S, context: BaseRenderContext, proceed: (P, S, WorkflowInterceptor.RenderContextInterceptor?) -> R, session: WorkflowInterceptor.WorkflowSession): R","description":"com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onRender","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-tracing-workflow-interceptor/on-render.html","searchKeys":["onRender","open override fun onRender(renderProps: P, renderState: S, context: BaseRenderContext, proceed: (P, S, WorkflowInterceptor.RenderContextInterceptor?) -> R, session: WorkflowInterceptor.WorkflowSession): R","com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onRender"]},{"name":"open override fun onInitialState(props: P, snapshot: Snapshot?, workflowScope: CoroutineScope, proceed: (P, Snapshot?, CoroutineScope) -> S, session: WorkflowInterceptor.WorkflowSession): S","description":"com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onInitialState","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-tracing-workflow-interceptor/on-initial-state.html","searchKeys":["onInitialState","open override fun onInitialState(props: P, snapshot: Snapshot?, workflowScope: CoroutineScope, proceed: (P, Snapshot?, CoroutineScope) -> S, session: WorkflowInterceptor.WorkflowSession): S","com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onInitialState"]},{"name":"open override fun onPropsChanged(old: P, new: P, state: S, proceed: (P, P, S) -> S, session: WorkflowInterceptor.WorkflowSession): S","description":"com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onPropsChanged","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-tracing-workflow-interceptor/on-props-changed.html","searchKeys":["onPropsChanged","open override fun onPropsChanged(old: P, new: P, state: S, proceed: (P, P, S) -> S, session: WorkflowInterceptor.WorkflowSession): S","com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onPropsChanged"]},{"name":"open override fun onSnapshotState(state: S, proceed: (S) -> Snapshot?, session: WorkflowInterceptor.WorkflowSession): Snapshot?","description":"com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onSnapshotState","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-tracing-workflow-interceptor/on-snapshot-state.html","searchKeys":["onSnapshotState","open override fun onSnapshotState(state: S, proceed: (S) -> Snapshot?, session: WorkflowInterceptor.WorkflowSession): Snapshot?","com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onSnapshotState"]},{"name":"open override fun freeMemory(): Long","description":"com.squareup.workflow1.diagnostic.tracing.RuntimeMemoryStats.freeMemory","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-runtime-memory-stats/free-memory.html","searchKeys":["freeMemory","open override fun freeMemory(): Long","com.squareup.workflow1.diagnostic.tracing.RuntimeMemoryStats.freeMemory"]},{"name":"open override fun onSessionStarted(workflowScope: CoroutineScope, session: WorkflowInterceptor.WorkflowSession)","description":"com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onSessionStarted","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-tracing-workflow-interceptor/on-session-started.html","searchKeys":["onSessionStarted","open override fun onSessionStarted(workflowScope: CoroutineScope, session: WorkflowInterceptor.WorkflowSession)","com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onSessionStarted"]},{"name":"open override fun totalMemory(): Long","description":"com.squareup.workflow1.diagnostic.tracing.RuntimeMemoryStats.totalMemory","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-runtime-memory-stats/total-memory.html","searchKeys":["totalMemory","open override fun totalMemory(): Long","com.squareup.workflow1.diagnostic.tracing.RuntimeMemoryStats.totalMemory"]},{"name":"fun ScreenViewFactory.Preview(rendering: RenderingT, modifier: Modifier = Modifier, placeholderModifier: Modifier = Modifier, viewEnvironmentUpdater: (ViewEnvironment) -> ViewEnvironment? = null)","description":"com.squareup.workflow1.ui.compose.tooling.Preview","location":"workflow-ui/compose-tooling/com.squareup.workflow1.ui.compose.tooling/-preview.html","searchKeys":["Preview","fun ScreenViewFactory.Preview(rendering: RenderingT, modifier: Modifier = Modifier, placeholderModifier: Modifier = Modifier, viewEnvironmentUpdater: (ViewEnvironment) -> ViewEnvironment? = null)","com.squareup.workflow1.ui.compose.tooling.Preview"]},{"name":"GLOBAL","description":"com.squareup.tracing.TraceEvent.Instant.InstantScope.GLOBAL","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/-instant-scope/-g-l-o-b-a-l/index.html","searchKeys":["GLOBAL","GLOBAL","com.squareup.tracing.TraceEvent.Instant.InstantScope.GLOBAL"]},{"name":"PROCESS","description":"com.squareup.tracing.TraceEvent.Instant.InstantScope.PROCESS","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/-instant-scope/-p-r-o-c-e-s-s/index.html","searchKeys":["PROCESS","PROCESS","com.squareup.tracing.TraceEvent.Instant.InstantScope.PROCESS"]},{"name":"THREAD","description":"com.squareup.tracing.TraceEvent.Instant.InstantScope.THREAD","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/-instant-scope/-t-h-r-e-a-d/index.html","searchKeys":["THREAD","THREAD","com.squareup.tracing.TraceEvent.Instant.InstantScope.THREAD"]},{"name":"abstract fun log(event: TraceEvent)","description":"com.squareup.tracing.TraceLogger.log","location":"trace-encoder/com.squareup.tracing/-trace-logger/log.html","searchKeys":["log","abstract fun log(event: TraceEvent)","com.squareup.tracing.TraceLogger.log"]},{"name":"abstract fun log(eventBatch: List)","description":"com.squareup.tracing.TraceLogger.log","location":"trace-encoder/com.squareup.tracing/-trace-logger/log.html","searchKeys":["log","abstract fun log(eventBatch: List)","com.squareup.tracing.TraceLogger.log"]},{"name":"abstract val elapsedNow: Long","description":"com.squareup.tracing.TimeMark.elapsedNow","location":"trace-encoder/com.squareup.tracing/-time-mark/elapsed-now.html","searchKeys":["elapsedNow","abstract val elapsedNow: Long","com.squareup.tracing.TimeMark.elapsedNow"]},{"name":"class TraceEncoder(scope: CoroutineScope, start: TimeMark = TraceEncoderTimeMark, ioDispatcher: CoroutineDispatcher = IO, sinkProvider: () -> BufferedSink) : Closeable","description":"com.squareup.tracing.TraceEncoder","location":"trace-encoder/com.squareup.tracing/-trace-encoder/index.html","searchKeys":["TraceEncoder","class TraceEncoder(scope: CoroutineScope, start: TimeMark = TraceEncoderTimeMark, ioDispatcher: CoroutineDispatcher = IO, sinkProvider: () -> BufferedSink) : Closeable","com.squareup.tracing.TraceEncoder"]},{"name":"constructor(id: Any, name: String, args: Map = emptyMap(), category: String? = null)","description":"com.squareup.tracing.TraceEvent.AsyncDurationBegin.AsyncDurationBegin","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-begin/-async-duration-begin.html","searchKeys":["AsyncDurationBegin","constructor(id: Any, name: String, args: Map = emptyMap(), category: String? = null)","com.squareup.tracing.TraceEvent.AsyncDurationBegin.AsyncDurationBegin"]},{"name":"constructor(id: Any, name: String, args: Map = emptyMap(), category: String? = null)","description":"com.squareup.tracing.TraceEvent.AsyncDurationEnd.AsyncDurationEnd","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-end/-async-duration-end.html","searchKeys":["AsyncDurationEnd","constructor(id: Any, name: String, args: Map = emptyMap(), category: String? = null)","com.squareup.tracing.TraceEvent.AsyncDurationEnd.AsyncDurationEnd"]},{"name":"constructor(id: Long, objectType: String)","description":"com.squareup.tracing.TraceEvent.ObjectCreated.ObjectCreated","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-created/-object-created.html","searchKeys":["ObjectCreated","constructor(id: Long, objectType: String)","com.squareup.tracing.TraceEvent.ObjectCreated.ObjectCreated"]},{"name":"constructor(id: Long, objectType: String)","description":"com.squareup.tracing.TraceEvent.ObjectDestroyed.ObjectDestroyed","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-destroyed/-object-destroyed.html","searchKeys":["ObjectDestroyed","constructor(id: Long, objectType: String)","com.squareup.tracing.TraceEvent.ObjectDestroyed.ObjectDestroyed"]},{"name":"constructor(id: Long, objectType: String, snapshot: Any)","description":"com.squareup.tracing.TraceEvent.ObjectSnapshot.ObjectSnapshot","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-snapshot/-object-snapshot.html","searchKeys":["ObjectSnapshot","constructor(id: Long, objectType: String, snapshot: Any)","com.squareup.tracing.TraceEvent.ObjectSnapshot.ObjectSnapshot"]},{"name":"constructor(name: String, args: Map = emptyMap(), category: String? = null)","description":"com.squareup.tracing.TraceEvent.DurationBegin.DurationBegin","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-begin/-duration-begin.html","searchKeys":["DurationBegin","constructor(name: String, args: Map = emptyMap(), category: String? = null)","com.squareup.tracing.TraceEvent.DurationBegin.DurationBegin"]},{"name":"constructor(name: String, args: Map = emptyMap(), category: String? = null)","description":"com.squareup.tracing.TraceEvent.DurationEnd.DurationEnd","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-end/-duration-end.html","searchKeys":["DurationEnd","constructor(name: String, args: Map = emptyMap(), category: String? = null)","com.squareup.tracing.TraceEvent.DurationEnd.DurationEnd"]},{"name":"constructor(name: String, args: Map = emptyMap(), scope: TraceEvent.Instant.InstantScope = THREAD, category: String? = null)","description":"com.squareup.tracing.TraceEvent.Instant.Instant","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/-instant.html","searchKeys":["Instant","constructor(name: String, args: Map = emptyMap(), scope: TraceEvent.Instant.InstantScope = THREAD, category: String? = null)","com.squareup.tracing.TraceEvent.Instant.Instant"]},{"name":"constructor(name: String, series: Map, id: Long? = null)","description":"com.squareup.tracing.TraceEvent.Counter.Counter","location":"trace-encoder/com.squareup.tracing/-trace-event/-counter/-counter.html","searchKeys":["Counter","constructor(name: String, series: Map, id: Long? = null)","com.squareup.tracing.TraceEvent.Counter.Counter"]},{"name":"constructor(scope: CoroutineScope, start: TimeMark = TraceEncoderTimeMark, ioDispatcher: CoroutineDispatcher = IO, sinkProvider: () -> BufferedSink)","description":"com.squareup.tracing.TraceEncoder.TraceEncoder","location":"trace-encoder/com.squareup.tracing/-trace-encoder/-trace-encoder.html","searchKeys":["TraceEncoder","constructor(scope: CoroutineScope, start: TimeMark = TraceEncoderTimeMark, ioDispatcher: CoroutineDispatcher = IO, sinkProvider: () -> BufferedSink)","com.squareup.tracing.TraceEncoder.TraceEncoder"]},{"name":"data class AsyncDurationBegin(val id: Any, val name: String, val args: Map = emptyMap(), val category: String? = null) : TraceEvent","description":"com.squareup.tracing.TraceEvent.AsyncDurationBegin","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-begin/index.html","searchKeys":["AsyncDurationBegin","data class AsyncDurationBegin(val id: Any, val name: String, val args: Map = emptyMap(), val category: String? = null) : TraceEvent","com.squareup.tracing.TraceEvent.AsyncDurationBegin"]},{"name":"data class AsyncDurationEnd(val id: Any, val name: String, val args: Map = emptyMap(), val category: String? = null) : TraceEvent","description":"com.squareup.tracing.TraceEvent.AsyncDurationEnd","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-end/index.html","searchKeys":["AsyncDurationEnd","data class AsyncDurationEnd(val id: Any, val name: String, val args: Map = emptyMap(), val category: String? = null) : TraceEvent","com.squareup.tracing.TraceEvent.AsyncDurationEnd"]},{"name":"data class Counter(val name: String, val series: Map, val id: Long? = null) : TraceEvent","description":"com.squareup.tracing.TraceEvent.Counter","location":"trace-encoder/com.squareup.tracing/-trace-event/-counter/index.html","searchKeys":["Counter","data class Counter(val name: String, val series: Map, val id: Long? = null) : TraceEvent","com.squareup.tracing.TraceEvent.Counter"]},{"name":"data class DurationBegin(val name: String, val args: Map = emptyMap(), val category: String? = null) : TraceEvent","description":"com.squareup.tracing.TraceEvent.DurationBegin","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-begin/index.html","searchKeys":["DurationBegin","data class DurationBegin(val name: String, val args: Map = emptyMap(), val category: String? = null) : TraceEvent","com.squareup.tracing.TraceEvent.DurationBegin"]},{"name":"data class DurationEnd(val name: String, val args: Map = emptyMap(), val category: String? = null) : TraceEvent","description":"com.squareup.tracing.TraceEvent.DurationEnd","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-end/index.html","searchKeys":["DurationEnd","data class DurationEnd(val name: String, val args: Map = emptyMap(), val category: String? = null) : TraceEvent","com.squareup.tracing.TraceEvent.DurationEnd"]},{"name":"data class Instant(val name: String, val args: Map = emptyMap(), val scope: TraceEvent.Instant.InstantScope = THREAD, val category: String? = null) : TraceEvent","description":"com.squareup.tracing.TraceEvent.Instant","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/index.html","searchKeys":["Instant","data class Instant(val name: String, val args: Map = emptyMap(), val scope: TraceEvent.Instant.InstantScope = THREAD, val category: String? = null) : TraceEvent","com.squareup.tracing.TraceEvent.Instant"]},{"name":"data class ObjectCreated(val id: Long, val objectType: String) : TraceEvent","description":"com.squareup.tracing.TraceEvent.ObjectCreated","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-created/index.html","searchKeys":["ObjectCreated","data class ObjectCreated(val id: Long, val objectType: String) : TraceEvent","com.squareup.tracing.TraceEvent.ObjectCreated"]},{"name":"data class ObjectDestroyed(val id: Long, val objectType: String) : TraceEvent","description":"com.squareup.tracing.TraceEvent.ObjectDestroyed","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-destroyed/index.html","searchKeys":["ObjectDestroyed","data class ObjectDestroyed(val id: Long, val objectType: String) : TraceEvent","com.squareup.tracing.TraceEvent.ObjectDestroyed"]},{"name":"data class ObjectSnapshot(val id: Long, val objectType: String, val snapshot: Any) : TraceEvent","description":"com.squareup.tracing.TraceEvent.ObjectSnapshot","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-snapshot/index.html","searchKeys":["ObjectSnapshot","data class ObjectSnapshot(val id: Long, val objectType: String, val snapshot: Any) : TraceEvent","com.squareup.tracing.TraceEvent.ObjectSnapshot"]},{"name":"enum InstantScope : Enum ","description":"com.squareup.tracing.TraceEvent.Instant.InstantScope","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/-instant-scope/index.html","searchKeys":["InstantScope","enum InstantScope : Enum ","com.squareup.tracing.TraceEvent.Instant.InstantScope"]},{"name":"fun createLogger(processName: String = \"\", threadName: String = \"\"): TraceLogger","description":"com.squareup.tracing.TraceEncoder.createLogger","location":"trace-encoder/com.squareup.tracing/-trace-encoder/create-logger.html","searchKeys":["createLogger","fun createLogger(processName: String = \"\", threadName: String = \"\"): TraceLogger","com.squareup.tracing.TraceEncoder.createLogger"]},{"name":"fun valueOf(value: String): TraceEvent.Instant.InstantScope","description":"com.squareup.tracing.TraceEvent.Instant.InstantScope.valueOf","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/-instant-scope/value-of.html","searchKeys":["valueOf","fun valueOf(value: String): TraceEvent.Instant.InstantScope","com.squareup.tracing.TraceEvent.Instant.InstantScope.valueOf"]},{"name":"fun values(): Array","description":"com.squareup.tracing.TraceEvent.Instant.InstantScope.values","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/-instant-scope/values.html","searchKeys":["values","fun values(): Array","com.squareup.tracing.TraceEvent.Instant.InstantScope.values"]},{"name":"interface TimeMark","description":"com.squareup.tracing.TimeMark","location":"trace-encoder/com.squareup.tracing/-time-mark/index.html","searchKeys":["TimeMark","interface TimeMark","com.squareup.tracing.TimeMark"]},{"name":"interface TraceLogger","description":"com.squareup.tracing.TraceLogger","location":"trace-encoder/com.squareup.tracing/-trace-logger/index.html","searchKeys":["TraceLogger","interface TraceLogger","com.squareup.tracing.TraceLogger"]},{"name":"open override fun close()","description":"com.squareup.tracing.TraceEncoder.close","location":"trace-encoder/com.squareup.tracing/-trace-encoder/close.html","searchKeys":["close","open override fun close()","com.squareup.tracing.TraceEncoder.close"]},{"name":"open override val category: String? = null","description":"com.squareup.tracing.TraceEvent.AsyncDurationBegin.category","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-begin/category.html","searchKeys":["category","open override val category: String? = null","com.squareup.tracing.TraceEvent.AsyncDurationBegin.category"]},{"name":"open override val category: String? = null","description":"com.squareup.tracing.TraceEvent.AsyncDurationEnd.category","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-end/category.html","searchKeys":["category","open override val category: String? = null","com.squareup.tracing.TraceEvent.AsyncDurationEnd.category"]},{"name":"open override val category: String? = null","description":"com.squareup.tracing.TraceEvent.DurationBegin.category","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-begin/category.html","searchKeys":["category","open override val category: String? = null","com.squareup.tracing.TraceEvent.DurationBegin.category"]},{"name":"open override val category: String? = null","description":"com.squareup.tracing.TraceEvent.DurationEnd.category","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-end/category.html","searchKeys":["category","open override val category: String? = null","com.squareup.tracing.TraceEvent.DurationEnd.category"]},{"name":"open override val category: String? = null","description":"com.squareup.tracing.TraceEvent.Instant.category","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/category.html","searchKeys":["category","open override val category: String? = null","com.squareup.tracing.TraceEvent.Instant.category"]},{"name":"open val category: String?","description":"com.squareup.tracing.TraceEvent.category","location":"trace-encoder/com.squareup.tracing/-trace-event/category.html","searchKeys":["category","open val category: String?","com.squareup.tracing.TraceEvent.category"]},{"name":"sealed class TraceEvent","description":"com.squareup.tracing.TraceEvent","location":"trace-encoder/com.squareup.tracing/-trace-event/index.html","searchKeys":["TraceEvent","sealed class TraceEvent","com.squareup.tracing.TraceEvent"]},{"name":"val args: Map","description":"com.squareup.tracing.TraceEvent.AsyncDurationBegin.args","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-begin/args.html","searchKeys":["args","val args: Map","com.squareup.tracing.TraceEvent.AsyncDurationBegin.args"]},{"name":"val args: Map","description":"com.squareup.tracing.TraceEvent.AsyncDurationEnd.args","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-end/args.html","searchKeys":["args","val args: Map","com.squareup.tracing.TraceEvent.AsyncDurationEnd.args"]},{"name":"val args: Map","description":"com.squareup.tracing.TraceEvent.DurationBegin.args","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-begin/args.html","searchKeys":["args","val args: Map","com.squareup.tracing.TraceEvent.DurationBegin.args"]},{"name":"val args: Map","description":"com.squareup.tracing.TraceEvent.DurationEnd.args","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-end/args.html","searchKeys":["args","val args: Map","com.squareup.tracing.TraceEvent.DurationEnd.args"]},{"name":"val args: Map","description":"com.squareup.tracing.TraceEvent.Instant.args","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/args.html","searchKeys":["args","val args: Map","com.squareup.tracing.TraceEvent.Instant.args"]},{"name":"val entries: EnumEntries","description":"com.squareup.tracing.TraceEvent.Instant.InstantScope.entries","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/-instant-scope/entries.html","searchKeys":["entries","val entries: EnumEntries","com.squareup.tracing.TraceEvent.Instant.InstantScope.entries"]},{"name":"val id: Any","description":"com.squareup.tracing.TraceEvent.AsyncDurationBegin.id","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-begin/id.html","searchKeys":["id","val id: Any","com.squareup.tracing.TraceEvent.AsyncDurationBegin.id"]},{"name":"val id: Any","description":"com.squareup.tracing.TraceEvent.AsyncDurationEnd.id","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-end/id.html","searchKeys":["id","val id: Any","com.squareup.tracing.TraceEvent.AsyncDurationEnd.id"]},{"name":"val id: Long","description":"com.squareup.tracing.TraceEvent.ObjectCreated.id","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-created/id.html","searchKeys":["id","val id: Long","com.squareup.tracing.TraceEvent.ObjectCreated.id"]},{"name":"val id: Long","description":"com.squareup.tracing.TraceEvent.ObjectDestroyed.id","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-destroyed/id.html","searchKeys":["id","val id: Long","com.squareup.tracing.TraceEvent.ObjectDestroyed.id"]},{"name":"val id: Long","description":"com.squareup.tracing.TraceEvent.ObjectSnapshot.id","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-snapshot/id.html","searchKeys":["id","val id: Long","com.squareup.tracing.TraceEvent.ObjectSnapshot.id"]},{"name":"val id: Long? = null","description":"com.squareup.tracing.TraceEvent.Counter.id","location":"trace-encoder/com.squareup.tracing/-trace-event/-counter/id.html","searchKeys":["id","val id: Long? = null","com.squareup.tracing.TraceEvent.Counter.id"]},{"name":"val name: String","description":"com.squareup.tracing.TraceEvent.AsyncDurationBegin.name","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-begin/name.html","searchKeys":["name","val name: String","com.squareup.tracing.TraceEvent.AsyncDurationBegin.name"]},{"name":"val name: String","description":"com.squareup.tracing.TraceEvent.AsyncDurationEnd.name","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-end/name.html","searchKeys":["name","val name: String","com.squareup.tracing.TraceEvent.AsyncDurationEnd.name"]},{"name":"val name: String","description":"com.squareup.tracing.TraceEvent.Counter.name","location":"trace-encoder/com.squareup.tracing/-trace-event/-counter/name.html","searchKeys":["name","val name: String","com.squareup.tracing.TraceEvent.Counter.name"]},{"name":"val name: String","description":"com.squareup.tracing.TraceEvent.DurationBegin.name","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-begin/name.html","searchKeys":["name","val name: String","com.squareup.tracing.TraceEvent.DurationBegin.name"]},{"name":"val name: String","description":"com.squareup.tracing.TraceEvent.DurationEnd.name","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-end/name.html","searchKeys":["name","val name: String","com.squareup.tracing.TraceEvent.DurationEnd.name"]},{"name":"val name: String","description":"com.squareup.tracing.TraceEvent.Instant.name","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/name.html","searchKeys":["name","val name: String","com.squareup.tracing.TraceEvent.Instant.name"]},{"name":"val objectType: String","description":"com.squareup.tracing.TraceEvent.ObjectCreated.objectType","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-created/object-type.html","searchKeys":["objectType","val objectType: String","com.squareup.tracing.TraceEvent.ObjectCreated.objectType"]},{"name":"val objectType: String","description":"com.squareup.tracing.TraceEvent.ObjectDestroyed.objectType","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-destroyed/object-type.html","searchKeys":["objectType","val objectType: String","com.squareup.tracing.TraceEvent.ObjectDestroyed.objectType"]},{"name":"val objectType: String","description":"com.squareup.tracing.TraceEvent.ObjectSnapshot.objectType","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-snapshot/object-type.html","searchKeys":["objectType","val objectType: String","com.squareup.tracing.TraceEvent.ObjectSnapshot.objectType"]},{"name":"val scope: TraceEvent.Instant.InstantScope","description":"com.squareup.tracing.TraceEvent.Instant.scope","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/scope.html","searchKeys":["scope","val scope: TraceEvent.Instant.InstantScope","com.squareup.tracing.TraceEvent.Instant.scope"]},{"name":"val series: Map","description":"com.squareup.tracing.TraceEvent.Counter.series","location":"trace-encoder/com.squareup.tracing/-trace-event/-counter/series.html","searchKeys":["series","val series: Map","com.squareup.tracing.TraceEvent.Counter.series"]},{"name":"val snapshot: Any","description":"com.squareup.tracing.TraceEvent.ObjectSnapshot.snapshot","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-snapshot/snapshot.html","searchKeys":["snapshot","val snapshot: Any","com.squareup.tracing.TraceEvent.ObjectSnapshot.snapshot"]},{"name":"val WorkflowViewStateRenderer: ViewStateRenderer","description":"com.squareup.workflow1.ui.radiography.WorkflowViewStateRenderer","location":"workflow-ui/radiography/com.squareup.workflow1.ui.radiography/-workflow-view-state-renderer.html","searchKeys":["WorkflowViewStateRenderer","val WorkflowViewStateRenderer: ViewStateRenderer","com.squareup.workflow1.ui.radiography.WorkflowViewStateRenderer"]}] \ No newline at end of file +[{"name":"CONFLATE_STALE_RENDERINGS","description":"com.squareup.workflow1.RuntimeConfigOptions.CONFLATE_STALE_RENDERINGS","location":"workflow-runtime/com.squareup.workflow1/-runtime-config-options/-c-o-n-f-l-a-t-e_-s-t-a-l-e_-r-e-n-d-e-r-i-n-g-s/index.html","searchKeys":["CONFLATE_STALE_RENDERINGS","CONFLATE_STALE_RENDERINGS","com.squareup.workflow1.RuntimeConfigOptions.CONFLATE_STALE_RENDERINGS"]},{"name":"RENDER_ONLY_WHEN_STATE_CHANGES","description":"com.squareup.workflow1.RuntimeConfigOptions.RENDER_ONLY_WHEN_STATE_CHANGES","location":"workflow-runtime/com.squareup.workflow1/-runtime-config-options/-r-e-n-d-e-r_-o-n-l-y_-w-h-e-n_-s-t-a-t-e_-c-h-a-n-g-e-s/index.html","searchKeys":["RENDER_ONLY_WHEN_STATE_CHANGES","RENDER_ONLY_WHEN_STATE_CHANGES","com.squareup.workflow1.RuntimeConfigOptions.RENDER_ONLY_WHEN_STATE_CHANGES"]},{"name":"abstract val identifier: WorkflowIdentifier","description":"com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.identifier","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-workflow-session/identifier.html","searchKeys":["identifier","abstract val identifier: WorkflowIdentifier","com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.identifier"]},{"name":"abstract val parent: WorkflowInterceptor.WorkflowSession?","description":"com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.parent","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-workflow-session/parent.html","searchKeys":["parent","abstract val parent: WorkflowInterceptor.WorkflowSession?","com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.parent"]},{"name":"abstract val renderKey: String","description":"com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.renderKey","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-workflow-session/render-key.html","searchKeys":["renderKey","abstract val renderKey: String","com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.renderKey"]},{"name":"abstract val runtimeConfig: RuntimeConfig","description":"com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.runtimeConfig","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-workflow-session/runtime-config.html","searchKeys":["runtimeConfig","abstract val runtimeConfig: RuntimeConfig","com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.runtimeConfig"]},{"name":"abstract val sessionId: Long","description":"com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.sessionId","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-workflow-session/session-id.html","searchKeys":["sessionId","abstract val sessionId: Long","com.squareup.workflow1.WorkflowInterceptor.WorkflowSession.sessionId"]},{"name":"annotation class WorkflowExperimentalRuntime","description":"com.squareup.workflow1.WorkflowExperimentalRuntime","location":"workflow-runtime/com.squareup.workflow1/-workflow-experimental-runtime/index.html","searchKeys":["WorkflowExperimentalRuntime","annotation class WorkflowExperimentalRuntime","com.squareup.workflow1.WorkflowExperimentalRuntime"]},{"name":"class RenderingAndSnapshot(val rendering: RenderingT, val snapshot: TreeSnapshot)","description":"com.squareup.workflow1.RenderingAndSnapshot","location":"workflow-runtime/com.squareup.workflow1/-rendering-and-snapshot/index.html","searchKeys":["RenderingAndSnapshot","class RenderingAndSnapshot(val rendering: RenderingT, val snapshot: TreeSnapshot)","com.squareup.workflow1.RenderingAndSnapshot"]},{"name":"class TreeSnapshot","description":"com.squareup.workflow1.TreeSnapshot","location":"workflow-runtime/com.squareup.workflow1/-tree-snapshot/index.html","searchKeys":["TreeSnapshot","class TreeSnapshot","com.squareup.workflow1.TreeSnapshot"]},{"name":"constructor()","description":"com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.SimpleLoggingWorkflowInterceptor","location":"workflow-runtime/com.squareup.workflow1/-simple-logging-workflow-interceptor/-simple-logging-workflow-interceptor.html","searchKeys":["SimpleLoggingWorkflowInterceptor","constructor()","com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.SimpleLoggingWorkflowInterceptor"]},{"name":"constructor(rendering: RenderingT, snapshot: TreeSnapshot)","description":"com.squareup.workflow1.RenderingAndSnapshot.RenderingAndSnapshot","location":"workflow-runtime/com.squareup.workflow1/-rendering-and-snapshot/-rendering-and-snapshot.html","searchKeys":["RenderingAndSnapshot","constructor(rendering: RenderingT, snapshot: TreeSnapshot)","com.squareup.workflow1.RenderingAndSnapshot.RenderingAndSnapshot"]},{"name":"enum RuntimeConfigOptions : Enum ","description":"com.squareup.workflow1.RuntimeConfigOptions","location":"workflow-runtime/com.squareup.workflow1/-runtime-config-options/index.html","searchKeys":["RuntimeConfigOptions","enum RuntimeConfigOptions : Enum ","com.squareup.workflow1.RuntimeConfigOptions"]},{"name":"fun renderWorkflowIn(workflow: Workflow, scope: CoroutineScope, props: StateFlow, initialSnapshot: TreeSnapshot? = null, interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit): StateFlow>","description":"com.squareup.workflow1.renderWorkflowIn","location":"workflow-runtime/com.squareup.workflow1/render-workflow-in.html","searchKeys":["renderWorkflowIn","fun renderWorkflowIn(workflow: Workflow, scope: CoroutineScope, props: StateFlow, initialSnapshot: TreeSnapshot? = null, interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit): StateFlow>","com.squareup.workflow1.renderWorkflowIn"]},{"name":"fun forRootOnly(rootSnapshot: Snapshot?): TreeSnapshot","description":"com.squareup.workflow1.TreeSnapshot.Companion.forRootOnly","location":"workflow-runtime/com.squareup.workflow1/-tree-snapshot/-companion/for-root-only.html","searchKeys":["forRootOnly","fun forRootOnly(rootSnapshot: Snapshot?): TreeSnapshot","com.squareup.workflow1.TreeSnapshot.Companion.forRootOnly"]},{"name":"fun parse(bytes: ByteString): TreeSnapshot","description":"com.squareup.workflow1.TreeSnapshot.Companion.parse","location":"workflow-runtime/com.squareup.workflow1/-tree-snapshot/-companion/parse.html","searchKeys":["parse","fun parse(bytes: ByteString): TreeSnapshot","com.squareup.workflow1.TreeSnapshot.Companion.parse"]},{"name":"fun toByteString(): ByteString","description":"com.squareup.workflow1.TreeSnapshot.toByteString","location":"workflow-runtime/com.squareup.workflow1/-tree-snapshot/to-byte-string.html","searchKeys":["toByteString","fun toByteString(): ByteString","com.squareup.workflow1.TreeSnapshot.toByteString"]},{"name":"fun valueOf(value: String): RuntimeConfigOptions","description":"com.squareup.workflow1.RuntimeConfigOptions.valueOf","location":"workflow-runtime/com.squareup.workflow1/-runtime-config-options/value-of.html","searchKeys":["valueOf","fun valueOf(value: String): RuntimeConfigOptions","com.squareup.workflow1.RuntimeConfigOptions.valueOf"]},{"name":"fun values(): Array","description":"com.squareup.workflow1.RuntimeConfigOptions.values","location":"workflow-runtime/com.squareup.workflow1/-runtime-config-options/values.html","searchKeys":["values","fun values(): Array","com.squareup.workflow1.RuntimeConfigOptions.values"]},{"name":"interface RenderContextInterceptor","description":"com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-render-context-interceptor/index.html","searchKeys":["RenderContextInterceptor","interface RenderContextInterceptor","com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor"]},{"name":"interface WorkflowInterceptor","description":"com.squareup.workflow1.WorkflowInterceptor","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/index.html","searchKeys":["WorkflowInterceptor","interface WorkflowInterceptor","com.squareup.workflow1.WorkflowInterceptor"]},{"name":"interface WorkflowSession","description":"com.squareup.workflow1.WorkflowInterceptor.WorkflowSession","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-workflow-session/index.html","searchKeys":["WorkflowSession","interface WorkflowSession","com.squareup.workflow1.WorkflowInterceptor.WorkflowSession"]},{"name":"object Companion","description":"com.squareup.workflow1.RuntimeConfigOptions.Companion","location":"workflow-runtime/com.squareup.workflow1/-runtime-config-options/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.RuntimeConfigOptions.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.TreeSnapshot.Companion","location":"workflow-runtime/com.squareup.workflow1/-tree-snapshot/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.TreeSnapshot.Companion"]},{"name":"object NoopWorkflowInterceptor : WorkflowInterceptor","description":"com.squareup.workflow1.NoopWorkflowInterceptor","location":"workflow-runtime/com.squareup.workflow1/-noop-workflow-interceptor/index.html","searchKeys":["NoopWorkflowInterceptor","object NoopWorkflowInterceptor : WorkflowInterceptor","com.squareup.workflow1.NoopWorkflowInterceptor"]},{"name":"open class SimpleLoggingWorkflowInterceptor : WorkflowInterceptor","description":"com.squareup.workflow1.SimpleLoggingWorkflowInterceptor","location":"workflow-runtime/com.squareup.workflow1/-simple-logging-workflow-interceptor/index.html","searchKeys":["SimpleLoggingWorkflowInterceptor","open class SimpleLoggingWorkflowInterceptor : WorkflowInterceptor","com.squareup.workflow1.SimpleLoggingWorkflowInterceptor"]},{"name":"open fun onRenderChild(child: Workflow, childProps: CP, key: String, handler: (CO) -> WorkflowAction, proceed: (child: Workflow, childProps: CP, key: String, handler: (CO) -> WorkflowAction) -> CR): CR","description":"com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor.onRenderChild","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-render-context-interceptor/on-render-child.html","searchKeys":["onRenderChild","open fun onRenderChild(child: Workflow, childProps: CP, key: String, handler: (CO) -> WorkflowAction, proceed: (child: Workflow, childProps: CP, key: String, handler: (CO) -> WorkflowAction) -> CR): CR","com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor.onRenderChild"]},{"name":"open fun onRenderAndSnapshot(renderProps: P, proceed: (P) -> RenderingAndSnapshot, session: WorkflowInterceptor.WorkflowSession): RenderingAndSnapshot","description":"com.squareup.workflow1.WorkflowInterceptor.onRenderAndSnapshot","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/on-render-and-snapshot.html","searchKeys":["onRenderAndSnapshot","open fun onRenderAndSnapshot(renderProps: P, proceed: (P) -> RenderingAndSnapshot, session: WorkflowInterceptor.WorkflowSession): RenderingAndSnapshot","com.squareup.workflow1.WorkflowInterceptor.onRenderAndSnapshot"]},{"name":"open fun onRender(renderProps: P, renderState: S, context: BaseRenderContext, proceed: (P, S, WorkflowInterceptor.RenderContextInterceptor?) -> R, session: WorkflowInterceptor.WorkflowSession): R","description":"com.squareup.workflow1.WorkflowInterceptor.onRender","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/on-render.html","searchKeys":["onRender","open fun onRender(renderProps: P, renderState: S, context: BaseRenderContext, proceed: (P, S, WorkflowInterceptor.RenderContextInterceptor?) -> R, session: WorkflowInterceptor.WorkflowSession): R","com.squareup.workflow1.WorkflowInterceptor.onRender"]},{"name":"open fun onInitialState(props: P, snapshot: Snapshot?, workflowScope: CoroutineScope, proceed: (P, Snapshot?, CoroutineScope) -> S, session: WorkflowInterceptor.WorkflowSession): S","description":"com.squareup.workflow1.WorkflowInterceptor.onInitialState","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/on-initial-state.html","searchKeys":["onInitialState","open fun onInitialState(props: P, snapshot: Snapshot?, workflowScope: CoroutineScope, proceed: (P, Snapshot?, CoroutineScope) -> S, session: WorkflowInterceptor.WorkflowSession): S","com.squareup.workflow1.WorkflowInterceptor.onInitialState"]},{"name":"open fun onPropsChanged(old: P, new: P, state: S, proceed: (P, P, S) -> S, session: WorkflowInterceptor.WorkflowSession): S","description":"com.squareup.workflow1.WorkflowInterceptor.onPropsChanged","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/on-props-changed.html","searchKeys":["onPropsChanged","open fun onPropsChanged(old: P, new: P, state: S, proceed: (P, P, S) -> S, session: WorkflowInterceptor.WorkflowSession): S","com.squareup.workflow1.WorkflowInterceptor.onPropsChanged"]},{"name":"open fun onSnapshotState(state: S, proceed: (S) -> Snapshot?, session: WorkflowInterceptor.WorkflowSession): Snapshot?","description":"com.squareup.workflow1.WorkflowInterceptor.onSnapshotState","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/on-snapshot-state.html","searchKeys":["onSnapshotState","open fun onSnapshotState(state: S, proceed: (S) -> Snapshot?, session: WorkflowInterceptor.WorkflowSession): Snapshot?","com.squareup.workflow1.WorkflowInterceptor.onSnapshotState"]},{"name":"open fun onActionSent(action: WorkflowAction, proceed: (WorkflowAction) -> Unit)","description":"com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor.onActionSent","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-render-context-interceptor/on-action-sent.html","searchKeys":["onActionSent","open fun onActionSent(action: WorkflowAction, proceed: (WorkflowAction) -> Unit)","com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor.onActionSent"]},{"name":"open fun onRunningSideEffect(key: String, sideEffect: suspend () -> Unit, proceed: (key: String, sideEffect: suspend () -> Unit) -> Unit)","description":"com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor.onRunningSideEffect","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/-render-context-interceptor/on-running-side-effect.html","searchKeys":["onRunningSideEffect","open fun onRunningSideEffect(key: String, sideEffect: suspend () -> Unit, proceed: (key: String, sideEffect: suspend () -> Unit) -> Unit)","com.squareup.workflow1.WorkflowInterceptor.RenderContextInterceptor.onRunningSideEffect"]},{"name":"open fun onSessionStarted(workflowScope: CoroutineScope, session: WorkflowInterceptor.WorkflowSession)","description":"com.squareup.workflow1.WorkflowInterceptor.onSessionStarted","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/on-session-started.html","searchKeys":["onSessionStarted","open fun onSessionStarted(workflowScope: CoroutineScope, session: WorkflowInterceptor.WorkflowSession)","com.squareup.workflow1.WorkflowInterceptor.onSessionStarted"]},{"name":"open fun onSnapshotStateWithChildren(proceed: () -> TreeSnapshot, session: WorkflowInterceptor.WorkflowSession): TreeSnapshot","description":"com.squareup.workflow1.WorkflowInterceptor.onSnapshotStateWithChildren","location":"workflow-runtime/com.squareup.workflow1/-workflow-interceptor/on-snapshot-state-with-children.html","searchKeys":["onSnapshotStateWithChildren","open fun onSnapshotStateWithChildren(proceed: () -> TreeSnapshot, session: WorkflowInterceptor.WorkflowSession): TreeSnapshot","com.squareup.workflow1.WorkflowInterceptor.onSnapshotStateWithChildren"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.TreeSnapshot.equals","location":"workflow-runtime/com.squareup.workflow1/-tree-snapshot/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.TreeSnapshot.equals"]},{"name":"open override fun onRender(renderProps: P, renderState: S, context: BaseRenderContext, proceed: (P, S, WorkflowInterceptor.RenderContextInterceptor?) -> R, session: WorkflowInterceptor.WorkflowSession): R","description":"com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onRender","location":"workflow-runtime/com.squareup.workflow1/-simple-logging-workflow-interceptor/on-render.html","searchKeys":["onRender","open override fun onRender(renderProps: P, renderState: S, context: BaseRenderContext, proceed: (P, S, WorkflowInterceptor.RenderContextInterceptor?) -> R, session: WorkflowInterceptor.WorkflowSession): R","com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onRender"]},{"name":"open override fun onInitialState(props: P, snapshot: Snapshot?, workflowScope: CoroutineScope, proceed: (P, Snapshot?, CoroutineScope) -> S, session: WorkflowInterceptor.WorkflowSession): S","description":"com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onInitialState","location":"workflow-runtime/com.squareup.workflow1/-simple-logging-workflow-interceptor/on-initial-state.html","searchKeys":["onInitialState","open override fun onInitialState(props: P, snapshot: Snapshot?, workflowScope: CoroutineScope, proceed: (P, Snapshot?, CoroutineScope) -> S, session: WorkflowInterceptor.WorkflowSession): S","com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onInitialState"]},{"name":"open override fun onPropsChanged(old: P, new: P, state: S, proceed: (P, P, S) -> S, session: WorkflowInterceptor.WorkflowSession): S","description":"com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onPropsChanged","location":"workflow-runtime/com.squareup.workflow1/-simple-logging-workflow-interceptor/on-props-changed.html","searchKeys":["onPropsChanged","open override fun onPropsChanged(old: P, new: P, state: S, proceed: (P, P, S) -> S, session: WorkflowInterceptor.WorkflowSession): S","com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onPropsChanged"]},{"name":"open override fun onSnapshotState(state: S, proceed: (S) -> Snapshot?, session: WorkflowInterceptor.WorkflowSession): Snapshot?","description":"com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onSnapshotState","location":"workflow-runtime/com.squareup.workflow1/-simple-logging-workflow-interceptor/on-snapshot-state.html","searchKeys":["onSnapshotState","open override fun onSnapshotState(state: S, proceed: (S) -> Snapshot?, session: WorkflowInterceptor.WorkflowSession): Snapshot?","com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onSnapshotState"]},{"name":"open override fun hashCode(): Int","description":"com.squareup.workflow1.TreeSnapshot.hashCode","location":"workflow-runtime/com.squareup.workflow1/-tree-snapshot/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","com.squareup.workflow1.TreeSnapshot.hashCode"]},{"name":"open override fun onSessionStarted(workflowScope: CoroutineScope, session: WorkflowInterceptor.WorkflowSession)","description":"com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onSessionStarted","location":"workflow-runtime/com.squareup.workflow1/-simple-logging-workflow-interceptor/on-session-started.html","searchKeys":["onSessionStarted","open override fun onSessionStarted(workflowScope: CoroutineScope, session: WorkflowInterceptor.WorkflowSession)","com.squareup.workflow1.SimpleLoggingWorkflowInterceptor.onSessionStarted"]},{"name":"operator fun component1(): RenderingT","description":"com.squareup.workflow1.RenderingAndSnapshot.component1","location":"workflow-runtime/com.squareup.workflow1/-rendering-and-snapshot/component1.html","searchKeys":["component1","operator fun component1(): RenderingT","com.squareup.workflow1.RenderingAndSnapshot.component1"]},{"name":"operator fun component2(): TreeSnapshot","description":"com.squareup.workflow1.RenderingAndSnapshot.component2","location":"workflow-runtime/com.squareup.workflow1/-rendering-and-snapshot/component2.html","searchKeys":["component2","operator fun component2(): TreeSnapshot","com.squareup.workflow1.RenderingAndSnapshot.component2"]},{"name":"typealias RuntimeConfig = Set","description":"com.squareup.workflow1.RuntimeConfig","location":"workflow-runtime/com.squareup.workflow1/-runtime-config/index.html","searchKeys":["RuntimeConfig","typealias RuntimeConfig = Set","com.squareup.workflow1.RuntimeConfig"]},{"name":"val DEFAULT_CONFIG: RuntimeConfig","description":"com.squareup.workflow1.RuntimeConfigOptions.Companion.DEFAULT_CONFIG","location":"workflow-runtime/com.squareup.workflow1/-runtime-config-options/-companion/-d-e-f-a-u-l-t_-c-o-n-f-i-g.html","searchKeys":["DEFAULT_CONFIG","val DEFAULT_CONFIG: RuntimeConfig","com.squareup.workflow1.RuntimeConfigOptions.Companion.DEFAULT_CONFIG"]},{"name":"val RENDER_PER_ACTION: RuntimeConfig","description":"com.squareup.workflow1.RuntimeConfigOptions.Companion.RENDER_PER_ACTION","location":"workflow-runtime/com.squareup.workflow1/-runtime-config-options/-companion/-r-e-n-d-e-r_-p-e-r_-a-c-t-i-o-n.html","searchKeys":["RENDER_PER_ACTION","val RENDER_PER_ACTION: RuntimeConfig","com.squareup.workflow1.RuntimeConfigOptions.Companion.RENDER_PER_ACTION"]},{"name":"val entries: EnumEntries","description":"com.squareup.workflow1.RuntimeConfigOptions.entries","location":"workflow-runtime/com.squareup.workflow1/-runtime-config-options/entries.html","searchKeys":["entries","val entries: EnumEntries","com.squareup.workflow1.RuntimeConfigOptions.entries"]},{"name":"val rendering: RenderingT","description":"com.squareup.workflow1.RenderingAndSnapshot.rendering","location":"workflow-runtime/com.squareup.workflow1/-rendering-and-snapshot/rendering.html","searchKeys":["rendering","val rendering: RenderingT","com.squareup.workflow1.RenderingAndSnapshot.rendering"]},{"name":"val snapshot: TreeSnapshot","description":"com.squareup.workflow1.RenderingAndSnapshot.snapshot","location":"workflow-runtime/com.squareup.workflow1/-rendering-and-snapshot/snapshot.html","searchKeys":["snapshot","val snapshot: TreeSnapshot","com.squareup.workflow1.RenderingAndSnapshot.snapshot"]},{"name":"abstract fun Content(rendering: ScreenT, environment: ViewEnvironment)","description":"com.squareup.workflow1.ui.compose.ScreenComposableFactory.Content","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory/-content.html","searchKeys":["Content","abstract fun Content(rendering: ScreenT, environment: ViewEnvironment)","com.squareup.workflow1.ui.compose.ScreenComposableFactory.Content"]},{"name":"abstract fun Content(viewEnvironment: ViewEnvironment)","description":"com.squareup.workflow1.ui.compose.ComposeScreen.Content","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-compose-screen/-content.html","searchKeys":["Content","abstract fun Content(viewEnvironment: ViewEnvironment)","com.squareup.workflow1.ui.compose.ComposeScreen.Content"]},{"name":"abstract val type: KClass","description":"com.squareup.workflow1.ui.compose.ScreenComposableFactory.type","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory/type.html","searchKeys":["type","abstract val type: KClass","com.squareup.workflow1.ui.compose.ScreenComposableFactory.type"]},{"name":"fun Workflow.renderAsState(props: PropsT, interceptors: List = emptyList(), scope: CoroutineScope = rememberCoroutineScope(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit): State","description":"com.squareup.workflow1.ui.compose.renderAsState","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/render-as-state.html","searchKeys":["renderAsState","fun Workflow.renderAsState(props: PropsT, interceptors: List = emptyList(), scope: CoroutineScope = rememberCoroutineScope(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit): State","com.squareup.workflow1.ui.compose.renderAsState"]},{"name":"fun ScreenComposableFactory.asViewFactory(): ScreenViewFactory","description":"com.squareup.workflow1.ui.compose.asViewFactory","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/as-view-factory.html","searchKeys":["asViewFactory","fun ScreenComposableFactory.asViewFactory(): ScreenViewFactory","com.squareup.workflow1.ui.compose.asViewFactory"]},{"name":"fun ScreenComposableFactoryFinder.requireComposableFactoryForRendering(environment: ViewEnvironment, rendering: ScreenT): ScreenComposableFactory","description":"com.squareup.workflow1.ui.compose.requireComposableFactoryForRendering","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/require-composable-factory-for-rendering.html","searchKeys":["requireComposableFactoryForRendering","fun ScreenComposableFactoryFinder.requireComposableFactoryForRendering(environment: ViewEnvironment, rendering: ScreenT): ScreenComposableFactory","com.squareup.workflow1.ui.compose.requireComposableFactoryForRendering"]},{"name":"fun ScreenT.toComposableFactory(environment: ViewEnvironment): ScreenComposableFactory","description":"com.squareup.workflow1.ui.compose.toComposableFactory","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/to-composable-factory.html","searchKeys":["toComposableFactory","fun ScreenT.toComposableFactory(environment: ViewEnvironment): ScreenComposableFactory","com.squareup.workflow1.ui.compose.toComposableFactory"]},{"name":"fun ScreenViewFactory.asComposableFactory(): ScreenComposableFactory","description":"com.squareup.workflow1.ui.compose.asComposableFactory","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/as-composable-factory.html","searchKeys":["asComposableFactory","fun ScreenViewFactory.asComposableFactory(): ScreenComposableFactory","com.squareup.workflow1.ui.compose.asComposableFactory"]},{"name":"fun ScreenComposableFactoryFinder.withCompositionRoot(root: CompositionRoot): ScreenComposableFactoryFinder","description":"com.squareup.workflow1.ui.compose.withCompositionRoot","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/with-composition-root.html","searchKeys":["withCompositionRoot","fun ScreenComposableFactoryFinder.withCompositionRoot(root: CompositionRoot): ScreenComposableFactoryFinder","com.squareup.workflow1.ui.compose.withCompositionRoot"]},{"name":"fun TextController.asMutableState(): MutableState","description":"com.squareup.workflow1.ui.compose.asMutableState","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/as-mutable-state.html","searchKeys":["asMutableState","fun TextController.asMutableState(): MutableState","com.squareup.workflow1.ui.compose.asMutableState"]},{"name":"fun ViewEnvironment.withComposeInteropSupport(): ViewEnvironment","description":"com.squareup.workflow1.ui.compose.withComposeInteropSupport","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/with-compose-interop-support.html","searchKeys":["withComposeInteropSupport","fun ViewEnvironment.withComposeInteropSupport(): ViewEnvironment","com.squareup.workflow1.ui.compose.withComposeInteropSupport"]},{"name":"fun ViewEnvironment.withCompositionRoot(root: CompositionRoot): ViewEnvironment","description":"com.squareup.workflow1.ui.compose.withCompositionRoot","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/with-composition-root.html","searchKeys":["withCompositionRoot","fun ViewEnvironment.withCompositionRoot(root: CompositionRoot): ViewEnvironment","com.squareup.workflow1.ui.compose.withCompositionRoot"]},{"name":"fun WorkflowRendering(rendering: Screen, viewEnvironment: ViewEnvironment, modifier: Modifier = Modifier)","description":"com.squareup.workflow1.ui.compose.WorkflowRendering","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-workflow-rendering.html","searchKeys":["WorkflowRendering","fun WorkflowRendering(rendering: Screen, viewEnvironment: ViewEnvironment, modifier: Modifier = Modifier)","com.squareup.workflow1.ui.compose.WorkflowRendering"]},{"name":"inline fun ScreenComposableFactory(noinline content: (rendering: ScreenT, environment: ViewEnvironment) -> Unit): ScreenComposableFactory","description":"com.squareup.workflow1.ui.compose.ScreenComposableFactory","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory.html","searchKeys":["ScreenComposableFactory","inline fun ScreenComposableFactory(noinline content: (rendering: ScreenT, environment: ViewEnvironment) -> Unit): ScreenComposableFactory","com.squareup.workflow1.ui.compose.ScreenComposableFactory"]},{"name":"inline fun ComposeScreen(crossinline content: (ViewEnvironment) -> Unit): ComposeScreen","description":"com.squareup.workflow1.ui.compose.ComposeScreen","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-compose-screen.html","searchKeys":["ComposeScreen","inline fun ComposeScreen(crossinline content: (ViewEnvironment) -> Unit): ComposeScreen","com.squareup.workflow1.ui.compose.ComposeScreen"]},{"name":"interface ComposeScreen : Screen","description":"com.squareup.workflow1.ui.compose.ComposeScreen","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-compose-screen/index.html","searchKeys":["ComposeScreen","interface ComposeScreen : Screen","com.squareup.workflow1.ui.compose.ComposeScreen"]},{"name":"interface ScreenComposableFactory : ViewRegistry.Entry ","description":"com.squareup.workflow1.ui.compose.ScreenComposableFactory","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory/index.html","searchKeys":["ScreenComposableFactory","interface ScreenComposableFactory : ViewRegistry.Entry ","com.squareup.workflow1.ui.compose.ScreenComposableFactory"]},{"name":"interface ScreenComposableFactoryFinder","description":"com.squareup.workflow1.ui.compose.ScreenComposableFactoryFinder","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory-finder/index.html","searchKeys":["ScreenComposableFactoryFinder","interface ScreenComposableFactoryFinder","com.squareup.workflow1.ui.compose.ScreenComposableFactoryFinder"]},{"name":"object Companion : ViewEnvironmentKey ","description":"com.squareup.workflow1.ui.compose.ScreenComposableFactoryFinder.Companion","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory-finder/-companion/index.html","searchKeys":["Companion","object Companion : ViewEnvironmentKey ","com.squareup.workflow1.ui.compose.ScreenComposableFactoryFinder.Companion"]},{"name":"open fun getComposableFactoryForRendering(environment: ViewEnvironment, rendering: ScreenT): ScreenComposableFactory?","description":"com.squareup.workflow1.ui.compose.ScreenComposableFactoryFinder.getComposableFactoryForRendering","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory-finder/get-composable-factory-for-rendering.html","searchKeys":["getComposableFactoryForRendering","open fun getComposableFactoryForRendering(environment: ViewEnvironment, rendering: ScreenT): ScreenComposableFactory?","com.squareup.workflow1.ui.compose.ScreenComposableFactoryFinder.getComposableFactoryForRendering"]},{"name":"open override val default: ScreenComposableFactoryFinder","description":"com.squareup.workflow1.ui.compose.ScreenComposableFactoryFinder.Companion.default","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory-finder/-companion/default.html","searchKeys":["default","open override val default: ScreenComposableFactoryFinder","com.squareup.workflow1.ui.compose.ScreenComposableFactoryFinder.Companion.default"]},{"name":"open override val key: ViewRegistry.Key>","description":"com.squareup.workflow1.ui.compose.ScreenComposableFactory.key","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory/key.html","searchKeys":["key","open override val key: ViewRegistry.Key>","com.squareup.workflow1.ui.compose.ScreenComposableFactory.key"]},{"name":"typealias CompositionRoot = (content: () -> Unit) -> Unit","description":"com.squareup.workflow1.ui.compose.CompositionRoot","location":"workflow-ui/compose/com.squareup.workflow1.ui.compose/-composition-root/index.html","searchKeys":["CompositionRoot","typealias CompositionRoot = (content: () -> Unit) -> Unit","com.squareup.workflow1.ui.compose.CompositionRoot"]},{"name":"abstract class LifecycleWorker : Worker ","description":"com.squareup.workflow1.LifecycleWorker","location":"workflow-core/com.squareup.workflow1/-lifecycle-worker/index.html","searchKeys":["LifecycleWorker","abstract class LifecycleWorker : Worker ","com.squareup.workflow1.LifecycleWorker"]},{"name":"abstract class SessionWorkflow : StatefulWorkflow ","description":"com.squareup.workflow1.SessionWorkflow","location":"workflow-core/com.squareup.workflow1/-session-workflow/index.html","searchKeys":["SessionWorkflow","abstract class SessionWorkflow : StatefulWorkflow ","com.squareup.workflow1.SessionWorkflow"]},{"name":"abstract class StatefulWorkflow : Workflow , IdCacheable","description":"com.squareup.workflow1.StatefulWorkflow","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/index.html","searchKeys":["StatefulWorkflow","abstract class StatefulWorkflow : Workflow , IdCacheable","com.squareup.workflow1.StatefulWorkflow"]},{"name":"abstract class StatelessWorkflow : Workflow , IdCacheable","description":"com.squareup.workflow1.StatelessWorkflow","location":"workflow-core/com.squareup.workflow1/-stateless-workflow/index.html","searchKeys":["StatelessWorkflow","abstract class StatelessWorkflow : Workflow , IdCacheable","com.squareup.workflow1.StatelessWorkflow"]},{"name":"abstract class WorkflowAction","description":"com.squareup.workflow1.WorkflowAction","location":"workflow-core/com.squareup.workflow1/-workflow-action/index.html","searchKeys":["WorkflowAction","abstract class WorkflowAction","com.squareup.workflow1.WorkflowAction"]},{"name":"abstract fun renderChild(child: Workflow, props: ChildPropsT, key: String = \"\", handler: (ChildOutputT) -> WorkflowAction): ChildRenderingT","description":"com.squareup.workflow1.BaseRenderContext.renderChild","location":"workflow-core/com.squareup.workflow1/-base-render-context/render-child.html","searchKeys":["renderChild","abstract fun renderChild(child: Workflow, props: ChildPropsT, key: String = \"\", handler: (ChildOutputT) -> WorkflowAction): ChildRenderingT","com.squareup.workflow1.BaseRenderContext.renderChild"]},{"name":"abstract fun WorkflowAction.Updater.apply()","description":"com.squareup.workflow1.WorkflowAction.apply","location":"workflow-core/com.squareup.workflow1/-workflow-action/apply.html","searchKeys":["apply","abstract fun WorkflowAction.Updater.apply()","com.squareup.workflow1.WorkflowAction.apply"]},{"name":"abstract fun asStatefulWorkflow(): StatefulWorkflow","description":"com.squareup.workflow1.Workflow.asStatefulWorkflow","location":"workflow-core/com.squareup.workflow1/-workflow/as-stateful-workflow.html","searchKeys":["asStatefulWorkflow","abstract fun asStatefulWorkflow(): StatefulWorkflow","com.squareup.workflow1.Workflow.asStatefulWorkflow"]},{"name":"abstract fun initialState(props: PropsT, snapshot: Snapshot?): StateT","description":"com.squareup.workflow1.StatefulWorkflow.initialState","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/initial-state.html","searchKeys":["initialState","abstract fun initialState(props: PropsT, snapshot: Snapshot?): StateT","com.squareup.workflow1.StatefulWorkflow.initialState"]},{"name":"abstract fun render(renderProps: PropsT, context: StatelessWorkflow.RenderContext): RenderingT","description":"com.squareup.workflow1.StatelessWorkflow.render","location":"workflow-core/com.squareup.workflow1/-stateless-workflow/render.html","searchKeys":["render","abstract fun render(renderProps: PropsT, context: StatelessWorkflow.RenderContext): RenderingT","com.squareup.workflow1.StatelessWorkflow.render"]},{"name":"abstract fun render(renderProps: PropsT, renderState: StateT, context: StatefulWorkflow.RenderContext): RenderingT","description":"com.squareup.workflow1.StatefulWorkflow.render","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/render.html","searchKeys":["render","abstract fun render(renderProps: PropsT, renderState: StateT, context: StatefulWorkflow.RenderContext): RenderingT","com.squareup.workflow1.StatefulWorkflow.render"]},{"name":"abstract fun run(): Flow","description":"com.squareup.workflow1.Worker.run","location":"workflow-core/com.squareup.workflow1/-worker/run.html","searchKeys":["run","abstract fun run(): Flow","com.squareup.workflow1.Worker.run"]},{"name":"abstract fun runningSideEffect(key: String, sideEffect: suspend CoroutineScope.() -> Unit)","description":"com.squareup.workflow1.BaseRenderContext.runningSideEffect","location":"workflow-core/com.squareup.workflow1/-base-render-context/running-side-effect.html","searchKeys":["runningSideEffect","abstract fun runningSideEffect(key: String, sideEffect: suspend CoroutineScope.() -> Unit)","com.squareup.workflow1.BaseRenderContext.runningSideEffect"]},{"name":"abstract fun send(value: T)","description":"com.squareup.workflow1.Sink.send","location":"workflow-core/com.squareup.workflow1/-sink/send.html","searchKeys":["send","abstract fun send(value: T)","com.squareup.workflow1.Sink.send"]},{"name":"abstract fun snapshotState(state: StateT): Snapshot?","description":"com.squareup.workflow1.StatefulWorkflow.snapshotState","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/snapshot-state.html","searchKeys":["snapshotState","abstract fun snapshotState(state: StateT): Snapshot?","com.squareup.workflow1.StatefulWorkflow.snapshotState"]},{"name":"abstract override fun initialState(props: PropsT, snapshot: Snapshot?, workflowScope: CoroutineScope): StateT","description":"com.squareup.workflow1.SessionWorkflow.initialState","location":"workflow-core/com.squareup.workflow1/-session-workflow/initial-state.html","searchKeys":["initialState","abstract override fun initialState(props: PropsT, snapshot: Snapshot?, workflowScope: CoroutineScope): StateT","com.squareup.workflow1.SessionWorkflow.initialState"]},{"name":"abstract val actionSink: Sink>","description":"com.squareup.workflow1.BaseRenderContext.actionSink","location":"workflow-core/com.squareup.workflow1/-base-render-context/action-sink.html","searchKeys":["actionSink","abstract val actionSink: Sink>","com.squareup.workflow1.BaseRenderContext.actionSink"]},{"name":"abstract val realIdentifier: WorkflowIdentifier","description":"com.squareup.workflow1.ImpostorWorkflow.realIdentifier","location":"workflow-core/com.squareup.workflow1/-impostor-workflow/real-identifier.html","searchKeys":["realIdentifier","abstract val realIdentifier: WorkflowIdentifier","com.squareup.workflow1.ImpostorWorkflow.realIdentifier"]},{"name":"abstract val typeName: String","description":"com.squareup.workflow1.WorkflowIdentifierType.typeName","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/type-name.html","searchKeys":["typeName","abstract val typeName: String","com.squareup.workflow1.WorkflowIdentifierType.typeName"]},{"name":"abstract var cachedIdentifier: WorkflowIdentifier?","description":"com.squareup.workflow1.IdCacheable.cachedIdentifier","location":"workflow-core/com.squareup.workflow1/-id-cacheable/cached-identifier.html","searchKeys":["cachedIdentifier","abstract var cachedIdentifier: WorkflowIdentifier?","com.squareup.workflow1.IdCacheable.cachedIdentifier"]},{"name":"annotation class WorkflowExperimentalApi","description":"com.squareup.workflow1.WorkflowExperimentalApi","location":"workflow-core/com.squareup.workflow1/-workflow-experimental-api/index.html","searchKeys":["WorkflowExperimentalApi","annotation class WorkflowExperimentalApi","com.squareup.workflow1.WorkflowExperimentalApi"]},{"name":"class ActionApplied constructor(val output: WorkflowOutput?, val stateChanged: Boolean = false) : ActionProcessingResult","description":"com.squareup.workflow1.ActionApplied","location":"workflow-core/com.squareup.workflow1/-action-applied/index.html","searchKeys":["ActionApplied","class ActionApplied constructor(val output: WorkflowOutput?, val stateChanged: Boolean = false) : ActionProcessingResult","com.squareup.workflow1.ActionApplied"]},{"name":"class Snapshot","description":"com.squareup.workflow1.Snapshot","location":"workflow-core/com.squareup.workflow1/-snapshot/index.html","searchKeys":["Snapshot","class Snapshot","com.squareup.workflow1.Snapshot"]},{"name":"class WorkflowIdentifier","description":"com.squareup.workflow1.WorkflowIdentifier","location":"workflow-core/com.squareup.workflow1/-workflow-identifier/index.html","searchKeys":["WorkflowIdentifier","class WorkflowIdentifier","com.squareup.workflow1.WorkflowIdentifier"]},{"name":"class WorkflowOutput(val value: OutputT)","description":"com.squareup.workflow1.WorkflowOutput","location":"workflow-core/com.squareup.workflow1/-workflow-output/index.html","searchKeys":["WorkflowOutput","class WorkflowOutput(val value: OutputT)","com.squareup.workflow1.WorkflowOutput"]},{"name":"constructor()","description":"com.squareup.workflow1.LifecycleWorker.LifecycleWorker","location":"workflow-core/com.squareup.workflow1/-lifecycle-worker/-lifecycle-worker.html","searchKeys":["LifecycleWorker","constructor()","com.squareup.workflow1.LifecycleWorker.LifecycleWorker"]},{"name":"constructor()","description":"com.squareup.workflow1.SessionWorkflow.SessionWorkflow","location":"workflow-core/com.squareup.workflow1/-session-workflow/-session-workflow.html","searchKeys":["SessionWorkflow","constructor()","com.squareup.workflow1.SessionWorkflow.SessionWorkflow"]},{"name":"constructor()","description":"com.squareup.workflow1.StatefulWorkflow.StatefulWorkflow","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/-stateful-workflow.html","searchKeys":["StatefulWorkflow","constructor()","com.squareup.workflow1.StatefulWorkflow.StatefulWorkflow"]},{"name":"constructor()","description":"com.squareup.workflow1.StatelessWorkflow.StatelessWorkflow","location":"workflow-core/com.squareup.workflow1/-stateless-workflow/-stateless-workflow.html","searchKeys":["StatelessWorkflow","constructor()","com.squareup.workflow1.StatelessWorkflow.StatelessWorkflow"]},{"name":"constructor()","description":"com.squareup.workflow1.WorkflowAction.WorkflowAction","location":"workflow-core/com.squareup.workflow1/-workflow-action/-workflow-action.html","searchKeys":["WorkflowAction","constructor()","com.squareup.workflow1.WorkflowAction.WorkflowAction"]},{"name":"constructor(kClass: KClass<*>)","description":"com.squareup.workflow1.WorkflowIdentifierType.Snapshottable.Snapshottable","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/-snapshottable/-snapshottable.html","searchKeys":["Snapshottable","constructor(kClass: KClass<*>)","com.squareup.workflow1.WorkflowIdentifierType.Snapshottable.Snapshottable"]},{"name":"constructor(kType: KType)","description":"com.squareup.workflow1.WorkflowIdentifierType.Unsnapshottable.Unsnapshottable","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/-unsnapshottable/-unsnapshottable.html","searchKeys":["Unsnapshottable","constructor(kType: KType)","com.squareup.workflow1.WorkflowIdentifierType.Unsnapshottable.Unsnapshottable"]},{"name":"constructor(output: WorkflowOutput?, stateChanged: Boolean = false)","description":"com.squareup.workflow1.ActionApplied.ActionApplied","location":"workflow-core/com.squareup.workflow1/-action-applied/-action-applied.html","searchKeys":["ActionApplied","constructor(output: WorkflowOutput?, stateChanged: Boolean = false)","com.squareup.workflow1.ActionApplied.ActionApplied"]},{"name":"constructor(props: PropsT, state: StateT)","description":"com.squareup.workflow1.WorkflowAction.Updater.Updater","location":"workflow-core/com.squareup.workflow1/-workflow-action/-updater/-updater.html","searchKeys":["Updater","constructor(props: PropsT, state: StateT)","com.squareup.workflow1.WorkflowAction.Updater.Updater"]},{"name":"constructor(typeName: String, kClass: KClass<*>? = null)","description":"com.squareup.workflow1.WorkflowIdentifierType.Snapshottable.Snapshottable","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/-snapshottable/-snapshottable.html","searchKeys":["Snapshottable","constructor(typeName: String, kClass: KClass<*>? = null)","com.squareup.workflow1.WorkflowIdentifierType.Snapshottable.Snapshottable"]},{"name":"constructor(value: OutputT)","description":"com.squareup.workflow1.WorkflowOutput.WorkflowOutput","location":"workflow-core/com.squareup.workflow1/-workflow-output/-workflow-output.html","searchKeys":["WorkflowOutput","constructor(value: OutputT)","com.squareup.workflow1.WorkflowOutput.WorkflowOutput"]},{"name":"data class Snapshottable(val typeName: String, val kClass: KClass<*>? = null) : WorkflowIdentifierType","description":"com.squareup.workflow1.WorkflowIdentifierType.Snapshottable","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/-snapshottable/index.html","searchKeys":["Snapshottable","data class Snapshottable(val typeName: String, val kClass: KClass<*>? = null) : WorkflowIdentifierType","com.squareup.workflow1.WorkflowIdentifierType.Snapshottable"]},{"name":"data class Unsnapshottable(val kType: KType) : WorkflowIdentifierType","description":"com.squareup.workflow1.WorkflowIdentifierType.Unsnapshottable","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/-unsnapshottable/index.html","searchKeys":["Unsnapshottable","data class Unsnapshottable(val kType: KType) : WorkflowIdentifierType","com.squareup.workflow1.WorkflowIdentifierType.Unsnapshottable"]},{"name":"fun BaseRenderContext.renderChild(child: Workflow, props: ChildPropsT, key: String = \"\"): ChildRenderingT","description":"com.squareup.workflow1.renderChild","location":"workflow-core/com.squareup.workflow1/render-child.html","searchKeys":["renderChild","fun BaseRenderContext.renderChild(child: Workflow, props: ChildPropsT, key: String = \"\"): ChildRenderingT","com.squareup.workflow1.renderChild"]},{"name":"fun Workflow.mapRendering(transform: (FromRenderingT) -> ToRenderingT): Workflow","description":"com.squareup.workflow1.mapRendering","location":"workflow-core/com.squareup.workflow1/map-rendering.html","searchKeys":["mapRendering","fun Workflow.mapRendering(transform: (FromRenderingT) -> ToRenderingT): Workflow","com.squareup.workflow1.mapRendering"]},{"name":"fun RenderContext(baseContext: BaseRenderContext, workflow: StatelessWorkflow): StatelessWorkflow.RenderContext","description":"com.squareup.workflow1.RenderContext","location":"workflow-core/com.squareup.workflow1/-render-context.html","searchKeys":["RenderContext","fun RenderContext(baseContext: BaseRenderContext, workflow: StatelessWorkflow): StatelessWorkflow.RenderContext","com.squareup.workflow1.RenderContext"]},{"name":"fun StatelessWorkflow.action(name: () -> String, update: WorkflowAction.Updater.() -> Unit): WorkflowAction","description":"com.squareup.workflow1.action","location":"workflow-core/com.squareup.workflow1/action.html","searchKeys":["action","fun StatelessWorkflow.action(name: () -> String, update: WorkflowAction.Updater.() -> Unit): WorkflowAction","com.squareup.workflow1.action"]},{"name":"fun StatelessWorkflow.action(name: String = \"\", update: WorkflowAction.Updater.() -> Unit): WorkflowAction","description":"com.squareup.workflow1.action","location":"workflow-core/com.squareup.workflow1/action.html","searchKeys":["action","fun StatelessWorkflow.action(name: String = \"\", update: WorkflowAction.Updater.() -> Unit): WorkflowAction","com.squareup.workflow1.action"]},{"name":"fun BaseRenderContext.renderChild(child: Workflow, key: String = \"\", handler: (ChildOutputT) -> WorkflowAction): ChildRenderingT","description":"com.squareup.workflow1.renderChild","location":"workflow-core/com.squareup.workflow1/render-child.html","searchKeys":["renderChild","fun BaseRenderContext.renderChild(child: Workflow, key: String = \"\", handler: (ChildOutputT) -> WorkflowAction): ChildRenderingT","com.squareup.workflow1.renderChild"]},{"name":"fun BaseRenderContext.renderChild(child: Workflow, key: String = \"\"): ChildRenderingT","description":"com.squareup.workflow1.renderChild","location":"workflow-core/com.squareup.workflow1/render-child.html","searchKeys":["renderChild","fun BaseRenderContext.renderChild(child: Workflow, key: String = \"\"): ChildRenderingT","com.squareup.workflow1.renderChild"]},{"name":"fun RenderContext(baseContext: BaseRenderContext, workflow: StatefulWorkflow): StatefulWorkflow.RenderContext","description":"com.squareup.workflow1.RenderContext","location":"workflow-core/com.squareup.workflow1/-render-context.html","searchKeys":["RenderContext","fun RenderContext(baseContext: BaseRenderContext, workflow: StatefulWorkflow): StatefulWorkflow.RenderContext","com.squareup.workflow1.RenderContext"]},{"name":"fun StatefulWorkflow.action(name: () -> String, update: WorkflowAction.Updater.() -> Unit): WorkflowAction","description":"com.squareup.workflow1.action","location":"workflow-core/com.squareup.workflow1/action.html","searchKeys":["action","fun StatefulWorkflow.action(name: () -> String, update: WorkflowAction.Updater.() -> Unit): WorkflowAction","com.squareup.workflow1.action"]},{"name":"fun StatefulWorkflow.action(name: String = \"\", update: WorkflowAction.Updater.() -> Unit): WorkflowAction","description":"com.squareup.workflow1.action","location":"workflow-core/com.squareup.workflow1/action.html","searchKeys":["action","fun StatefulWorkflow.action(name: String = \"\", update: WorkflowAction.Updater.() -> Unit): WorkflowAction","com.squareup.workflow1.action"]},{"name":"fun WorkflowAction.applyTo(props: PropsT, state: StateT): Pair>","description":"com.squareup.workflow1.applyTo","location":"workflow-core/com.squareup.workflow1/apply-to.html","searchKeys":["applyTo","fun WorkflowAction.applyTo(props: PropsT, state: StateT): Pair>","com.squareup.workflow1.applyTo"]},{"name":"fun action(name: () -> String, apply: WorkflowAction.Updater.() -> Unit): WorkflowAction","description":"com.squareup.workflow1.action","location":"workflow-core/com.squareup.workflow1/action.html","searchKeys":["action","fun action(name: () -> String, apply: WorkflowAction.Updater.() -> Unit): WorkflowAction","com.squareup.workflow1.action"]},{"name":"fun action(name: String = \"\", apply: WorkflowAction.Updater.() -> Unit): WorkflowAction","description":"com.squareup.workflow1.action","location":"workflow-core/com.squareup.workflow1/action.html","searchKeys":["action","fun action(name: String = \"\", apply: WorkflowAction.Updater.() -> Unit): WorkflowAction","com.squareup.workflow1.action"]},{"name":"fun noAction(): WorkflowAction","description":"com.squareup.workflow1.WorkflowAction.Companion.noAction","location":"workflow-core/com.squareup.workflow1/-workflow-action/-companion/no-action.html","searchKeys":["noAction","fun noAction(): WorkflowAction","com.squareup.workflow1.WorkflowAction.Companion.noAction"]},{"name":"fun Workflow.Companion.rendering(rendering: RenderingT): Workflow","description":"com.squareup.workflow1.rendering","location":"workflow-core/com.squareup.workflow1/rendering.html","searchKeys":["rendering","fun Workflow.Companion.rendering(rendering: RenderingT): Workflow","com.squareup.workflow1.rendering"]},{"name":"fun BufferedSink.writeNullable(obj: T?, writer: BufferedSink.(T) -> Unit): BufferedSink","description":"com.squareup.workflow1.writeNullable","location":"workflow-core/com.squareup.workflow1/write-nullable.html","searchKeys":["writeNullable","fun BufferedSink.writeNullable(obj: T?, writer: BufferedSink.(T) -> Unit): BufferedSink","com.squareup.workflow1.writeNullable"]},{"name":"fun BufferedSource.readNullable(reader: BufferedSource.() -> T): T?","description":"com.squareup.workflow1.readNullable","location":"workflow-core/com.squareup.workflow1/read-nullable.html","searchKeys":["readNullable","fun BufferedSource.readNullable(reader: BufferedSource.() -> T): T?","com.squareup.workflow1.readNullable"]},{"name":"fun > BufferedSink.writeEnumByOrdinal(enumVal: T): BufferedSink","description":"com.squareup.workflow1.writeEnumByOrdinal","location":"workflow-core/com.squareup.workflow1/write-enum-by-ordinal.html","searchKeys":["writeEnumByOrdinal","fun > BufferedSink.writeEnumByOrdinal(enumVal: T): BufferedSink","com.squareup.workflow1.writeEnumByOrdinal"]},{"name":"fun > BufferedSink.writeOptionalEnumByOrdinal(enumVal: T?): BufferedSink","description":"com.squareup.workflow1.writeOptionalEnumByOrdinal","location":"workflow-core/com.squareup.workflow1/write-optional-enum-by-ordinal.html","searchKeys":["writeOptionalEnumByOrdinal","fun > BufferedSink.writeOptionalEnumByOrdinal(enumVal: T?): BufferedSink","com.squareup.workflow1.writeOptionalEnumByOrdinal"]},{"name":"fun Worker.transform(transform: (Flow) -> Flow): Worker","description":"com.squareup.workflow1.transform","location":"workflow-core/com.squareup.workflow1/transform.html","searchKeys":["transform","fun Worker.transform(transform: (Flow) -> Flow): Worker","com.squareup.workflow1.transform"]},{"name":"fun Sink.contraMap(transform: (T2) -> T1): Sink","description":"com.squareup.workflow1.contraMap","location":"workflow-core/com.squareup.workflow1/contra-map.html","searchKeys":["contraMap","fun Sink.contraMap(transform: (T2) -> T1): Sink","com.squareup.workflow1.contraMap"]},{"name":"fun finished(): Worker","description":"com.squareup.workflow1.Worker.Companion.finished","location":"workflow-core/com.squareup.workflow1/-worker/-companion/finished.html","searchKeys":["finished","fun finished(): Worker","com.squareup.workflow1.Worker.Companion.finished"]},{"name":"fun BufferedSink.writeBooleanAsInt(bool: Boolean): BufferedSink","description":"com.squareup.workflow1.writeBooleanAsInt","location":"workflow-core/com.squareup.workflow1/write-boolean-as-int.html","searchKeys":["writeBooleanAsInt","fun BufferedSink.writeBooleanAsInt(bool: Boolean): BufferedSink","com.squareup.workflow1.writeBooleanAsInt"]},{"name":"fun BufferedSink.writeByteStringWithLength(bytes: ByteString): BufferedSink","description":"com.squareup.workflow1.writeByteStringWithLength","location":"workflow-core/com.squareup.workflow1/write-byte-string-with-length.html","searchKeys":["writeByteStringWithLength","fun BufferedSink.writeByteStringWithLength(bytes: ByteString): BufferedSink","com.squareup.workflow1.writeByteStringWithLength"]},{"name":"fun BufferedSink.writeFloat(float: Float): BufferedSink","description":"com.squareup.workflow1.writeFloat","location":"workflow-core/com.squareup.workflow1/write-float.html","searchKeys":["writeFloat","fun BufferedSink.writeFloat(float: Float): BufferedSink","com.squareup.workflow1.writeFloat"]},{"name":"fun BufferedSink.writeOptionalUtf8WithLength(str: String?): BufferedSink","description":"com.squareup.workflow1.writeOptionalUtf8WithLength","location":"workflow-core/com.squareup.workflow1/write-optional-utf8-with-length.html","searchKeys":["writeOptionalUtf8WithLength","fun BufferedSink.writeOptionalUtf8WithLength(str: String?): BufferedSink","com.squareup.workflow1.writeOptionalUtf8WithLength"]},{"name":"fun BufferedSink.writeUtf8WithLength(str: String): BufferedSink","description":"com.squareup.workflow1.writeUtf8WithLength","location":"workflow-core/com.squareup.workflow1/write-utf8-with-length.html","searchKeys":["writeUtf8WithLength","fun BufferedSink.writeUtf8WithLength(str: String): BufferedSink","com.squareup.workflow1.writeUtf8WithLength"]},{"name":"fun BufferedSource.readBooleanFromInt(): Boolean","description":"com.squareup.workflow1.readBooleanFromInt","location":"workflow-core/com.squareup.workflow1/read-boolean-from-int.html","searchKeys":["readBooleanFromInt","fun BufferedSource.readBooleanFromInt(): Boolean","com.squareup.workflow1.readBooleanFromInt"]},{"name":"fun BufferedSource.readByteStringWithLength(): ByteString","description":"com.squareup.workflow1.readByteStringWithLength","location":"workflow-core/com.squareup.workflow1/read-byte-string-with-length.html","searchKeys":["readByteStringWithLength","fun BufferedSource.readByteStringWithLength(): ByteString","com.squareup.workflow1.readByteStringWithLength"]},{"name":"fun BufferedSource.readFloat(): Float","description":"com.squareup.workflow1.readFloat","location":"workflow-core/com.squareup.workflow1/read-float.html","searchKeys":["readFloat","fun BufferedSource.readFloat(): Float","com.squareup.workflow1.readFloat"]},{"name":"fun BufferedSource.readOptionalUtf8WithLength(): String?","description":"com.squareup.workflow1.readOptionalUtf8WithLength","location":"workflow-core/com.squareup.workflow1/read-optional-utf8-with-length.html","searchKeys":["readOptionalUtf8WithLength","fun BufferedSource.readOptionalUtf8WithLength(): String?","com.squareup.workflow1.readOptionalUtf8WithLength"]},{"name":"fun BufferedSource.readUtf8WithLength(): String","description":"com.squareup.workflow1.readUtf8WithLength","location":"workflow-core/com.squareup.workflow1/read-utf8-with-length.html","searchKeys":["readUtf8WithLength","fun BufferedSource.readUtf8WithLength(): String","com.squareup.workflow1.readUtf8WithLength"]},{"name":"fun component1(): WorkflowOutput?","description":"com.squareup.workflow1.ActionApplied.component1","location":"workflow-core/com.squareup.workflow1/-action-applied/component1.html","searchKeys":["component1","fun component1(): WorkflowOutput?","com.squareup.workflow1.ActionApplied.component1"]},{"name":"fun component2(): Boolean","description":"com.squareup.workflow1.ActionApplied.component2","location":"workflow-core/com.squareup.workflow1/-action-applied/component2.html","searchKeys":["component2","fun component2(): Boolean","com.squareup.workflow1.ActionApplied.component2"]},{"name":"fun copy(output: WorkflowOutput? = this.output, stateChanged: Boolean = this.stateChanged): ActionApplied","description":"com.squareup.workflow1.ActionApplied.copy","location":"workflow-core/com.squareup.workflow1/-action-applied/copy.html","searchKeys":["copy","fun copy(output: WorkflowOutput? = this.output, stateChanged: Boolean = this.stateChanged): ActionApplied","com.squareup.workflow1.ActionApplied.copy"]},{"name":"fun getRealIdentifierType(): WorkflowIdentifierType","description":"com.squareup.workflow1.WorkflowIdentifier.getRealIdentifierType","location":"workflow-core/com.squareup.workflow1/-workflow-identifier/get-real-identifier-type.html","searchKeys":["getRealIdentifierType","fun getRealIdentifierType(): WorkflowIdentifierType","com.squareup.workflow1.WorkflowIdentifier.getRealIdentifierType"]},{"name":"fun interface Sink","description":"com.squareup.workflow1.Sink","location":"workflow-core/com.squareup.workflow1/-sink/index.html","searchKeys":["Sink","fun interface Sink","com.squareup.workflow1.Sink"]},{"name":"fun of(byteString: ByteString): Snapshot","description":"com.squareup.workflow1.Snapshot.Companion.of","location":"workflow-core/com.squareup.workflow1/-snapshot/-companion/of.html","searchKeys":["of","fun of(byteString: ByteString): Snapshot","com.squareup.workflow1.Snapshot.Companion.of"]},{"name":"fun of(integer: Int): Snapshot","description":"com.squareup.workflow1.Snapshot.Companion.of","location":"workflow-core/com.squareup.workflow1/-snapshot/-companion/of.html","searchKeys":["of","fun of(integer: Int): Snapshot","com.squareup.workflow1.Snapshot.Companion.of"]},{"name":"fun of(lazy: () -> ByteString): Snapshot","description":"com.squareup.workflow1.Snapshot.Companion.of","location":"workflow-core/com.squareup.workflow1/-snapshot/-companion/of.html","searchKeys":["of","fun of(lazy: () -> ByteString): Snapshot","com.squareup.workflow1.Snapshot.Companion.of"]},{"name":"fun of(string: String): Snapshot","description":"com.squareup.workflow1.Snapshot.Companion.of","location":"workflow-core/com.squareup.workflow1/-snapshot/-companion/of.html","searchKeys":["of","fun of(string: String): Snapshot","com.squareup.workflow1.Snapshot.Companion.of"]},{"name":"fun parse(bytes: ByteString): WorkflowIdentifier","description":"com.squareup.workflow1.WorkflowIdentifier.Companion.parse","location":"workflow-core/com.squareup.workflow1/-workflow-identifier/-companion/parse.html","searchKeys":["parse","fun parse(bytes: ByteString): WorkflowIdentifier","com.squareup.workflow1.WorkflowIdentifier.Companion.parse"]},{"name":"fun setOutput(output: OutputT)","description":"com.squareup.workflow1.WorkflowAction.Updater.setOutput","location":"workflow-core/com.squareup.workflow1/-workflow-action/-updater/set-output.html","searchKeys":["setOutput","fun setOutput(output: OutputT)","com.squareup.workflow1.WorkflowAction.Updater.setOutput"]},{"name":"fun timer(delayMs: Long, key: String = \"\"): Worker","description":"com.squareup.workflow1.Worker.Companion.timer","location":"workflow-core/com.squareup.workflow1/-worker/-companion/timer.html","searchKeys":["timer","fun timer(delayMs: Long, key: String = \"\"): Worker","com.squareup.workflow1.Worker.Companion.timer"]},{"name":"fun toByteStringOrNull(): ByteString?","description":"com.squareup.workflow1.WorkflowIdentifier.toByteStringOrNull","location":"workflow-core/com.squareup.workflow1/-workflow-identifier/to-byte-string-or-null.html","searchKeys":["toByteStringOrNull","fun toByteStringOrNull(): ByteString?","com.squareup.workflow1.WorkflowIdentifier.toByteStringOrNull"]},{"name":"fun unsnapshottableIdentifier(type: KType): WorkflowIdentifier","description":"com.squareup.workflow1.unsnapshottableIdentifier","location":"workflow-core/com.squareup.workflow1/unsnapshottable-identifier.html","searchKeys":["unsnapshottableIdentifier","fun unsnapshottableIdentifier(type: KType): WorkflowIdentifier","com.squareup.workflow1.unsnapshottableIdentifier"]},{"name":"fun write(lazy: (BufferedSink) -> Unit): Snapshot","description":"com.squareup.workflow1.Snapshot.Companion.write","location":"workflow-core/com.squareup.workflow1/-snapshot/-companion/write.html","searchKeys":["write","fun write(lazy: (BufferedSink) -> Unit): Snapshot","com.squareup.workflow1.Snapshot.Companion.write"]},{"name":"inline fun Flow.asWorker(): Worker","description":"com.squareup.workflow1.asWorker","location":"workflow-core/com.squareup.workflow1/as-worker.html","searchKeys":["asWorker","inline fun Flow.asWorker(): Worker","com.squareup.workflow1.asWorker"]},{"name":"inline fun create(noinline block: suspend FlowCollector.() -> Unit): Worker","description":"com.squareup.workflow1.Worker.Companion.create","location":"workflow-core/com.squareup.workflow1/-worker/-companion/create.html","searchKeys":["create","inline fun create(noinline block: suspend FlowCollector.() -> Unit): Worker","com.squareup.workflow1.Worker.Companion.create"]},{"name":"inline fun from(noinline block: suspend () -> OutputT): Worker","description":"com.squareup.workflow1.Worker.Companion.from","location":"workflow-core/com.squareup.workflow1/-worker/-companion/from.html","searchKeys":["from","inline fun from(noinline block: suspend () -> OutputT): Worker","com.squareup.workflow1.Worker.Companion.from"]},{"name":"inline fun fromNullable(noinline block: suspend () -> OutputT?): Worker","description":"com.squareup.workflow1.Worker.Companion.fromNullable","location":"workflow-core/com.squareup.workflow1/-worker/-companion/from-nullable.html","searchKeys":["fromNullable","inline fun fromNullable(noinline block: suspend () -> OutputT?): Worker","com.squareup.workflow1.Worker.Companion.fromNullable"]},{"name":"inline fun Workflow.Companion.stateless(crossinline render: BaseRenderContext.(props: PropsT) -> RenderingT): Workflow","description":"com.squareup.workflow1.stateless","location":"workflow-core/com.squareup.workflow1/stateless.html","searchKeys":["stateless","inline fun Workflow.Companion.stateless(crossinline render: BaseRenderContext.(props: PropsT) -> RenderingT): Workflow","com.squareup.workflow1.stateless"]},{"name":"inline fun Workflow.Companion.sessionWorkflow(crossinline initialState: (PropsT, CoroutineScope) -> StateT, crossinline render: BaseRenderContext.(props: PropsT, state: StateT) -> RenderingT, crossinline onPropsChanged: (old: PropsT, new: PropsT, state: StateT) -> StateT = { _, _, state -> state }): SessionWorkflow","description":"com.squareup.workflow1.sessionWorkflow","location":"workflow-core/com.squareup.workflow1/session-workflow.html","searchKeys":["sessionWorkflow","inline fun Workflow.Companion.sessionWorkflow(crossinline initialState: (PropsT, CoroutineScope) -> StateT, crossinline render: BaseRenderContext.(props: PropsT, state: StateT) -> RenderingT, crossinline onPropsChanged: (old: PropsT, new: PropsT, state: StateT) -> StateT = { _, _, state -> state }): SessionWorkflow","com.squareup.workflow1.sessionWorkflow"]},{"name":"inline fun Workflow.Companion.sessionWorkflow(crossinline initialState: (PropsT, Snapshot?, CoroutineScope) -> StateT, crossinline render: BaseRenderContext.(props: PropsT, state: StateT) -> RenderingT, crossinline snapshot: (StateT) -> Snapshot?, crossinline onPropsChanged: (old: PropsT, new: PropsT, state: StateT) -> StateT = { _, _, state -> state }): SessionWorkflow","description":"com.squareup.workflow1.sessionWorkflow","location":"workflow-core/com.squareup.workflow1/session-workflow.html","searchKeys":["sessionWorkflow","inline fun Workflow.Companion.sessionWorkflow(crossinline initialState: (PropsT, Snapshot?, CoroutineScope) -> StateT, crossinline render: BaseRenderContext.(props: PropsT, state: StateT) -> RenderingT, crossinline snapshot: (StateT) -> Snapshot?, crossinline onPropsChanged: (old: PropsT, new: PropsT, state: StateT) -> StateT = { _, _, state -> state }): SessionWorkflow","com.squareup.workflow1.sessionWorkflow"]},{"name":"inline fun Workflow.Companion.stateful(crossinline initialState: (PropsT) -> StateT, crossinline render: BaseRenderContext.(props: PropsT, state: StateT) -> RenderingT, crossinline onPropsChanged: (old: PropsT, new: PropsT, state: StateT) -> StateT = { _, _, state -> state }): StatefulWorkflow","description":"com.squareup.workflow1.stateful","location":"workflow-core/com.squareup.workflow1/stateful.html","searchKeys":["stateful","inline fun Workflow.Companion.stateful(crossinline initialState: (PropsT) -> StateT, crossinline render: BaseRenderContext.(props: PropsT, state: StateT) -> RenderingT, crossinline onPropsChanged: (old: PropsT, new: PropsT, state: StateT) -> StateT = { _, _, state -> state }): StatefulWorkflow","com.squareup.workflow1.stateful"]},{"name":"inline fun Workflow.Companion.stateful(crossinline initialState: (PropsT, Snapshot?) -> StateT, crossinline render: BaseRenderContext.(props: PropsT, state: StateT) -> RenderingT, crossinline snapshot: (StateT) -> Snapshot?, crossinline onPropsChanged: (old: PropsT, new: PropsT, state: StateT) -> StateT = { _, _, state -> state }): StatefulWorkflow","description":"com.squareup.workflow1.stateful","location":"workflow-core/com.squareup.workflow1/stateful.html","searchKeys":["stateful","inline fun Workflow.Companion.stateful(crossinline initialState: (PropsT, Snapshot?) -> StateT, crossinline render: BaseRenderContext.(props: PropsT, state: StateT) -> RenderingT, crossinline snapshot: (StateT) -> Snapshot?, crossinline onPropsChanged: (old: PropsT, new: PropsT, state: StateT) -> StateT = { _, _, state -> state }): StatefulWorkflow","com.squareup.workflow1.stateful"]},{"name":"inline fun Workflow.Companion.sessionWorkflow(crossinline initialState: (CoroutineScope) -> StateT, crossinline render: BaseRenderContext.(state: StateT) -> RenderingT): SessionWorkflow","description":"com.squareup.workflow1.sessionWorkflow","location":"workflow-core/com.squareup.workflow1/session-workflow.html","searchKeys":["sessionWorkflow","inline fun Workflow.Companion.sessionWorkflow(crossinline initialState: (CoroutineScope) -> StateT, crossinline render: BaseRenderContext.(state: StateT) -> RenderingT): SessionWorkflow","com.squareup.workflow1.sessionWorkflow"]},{"name":"inline fun Workflow.Companion.sessionWorkflow(crossinline initialState: (Snapshot?, CoroutineScope) -> StateT, crossinline render: BaseRenderContext.(state: StateT) -> RenderingT, crossinline snapshot: (StateT) -> Snapshot?): SessionWorkflow","description":"com.squareup.workflow1.sessionWorkflow","location":"workflow-core/com.squareup.workflow1/session-workflow.html","searchKeys":["sessionWorkflow","inline fun Workflow.Companion.sessionWorkflow(crossinline initialState: (Snapshot?, CoroutineScope) -> StateT, crossinline render: BaseRenderContext.(state: StateT) -> RenderingT, crossinline snapshot: (StateT) -> Snapshot?): SessionWorkflow","com.squareup.workflow1.sessionWorkflow"]},{"name":"inline fun Workflow.Companion.stateful(crossinline initialState: (Snapshot?) -> StateT, crossinline render: BaseRenderContext.(state: StateT) -> RenderingT, crossinline snapshot: (StateT) -> Snapshot?): StatefulWorkflow","description":"com.squareup.workflow1.stateful","location":"workflow-core/com.squareup.workflow1/stateful.html","searchKeys":["stateful","inline fun Workflow.Companion.stateful(crossinline initialState: (Snapshot?) -> StateT, crossinline render: BaseRenderContext.(state: StateT) -> RenderingT, crossinline snapshot: (StateT) -> Snapshot?): StatefulWorkflow","com.squareup.workflow1.stateful"]},{"name":"inline fun Workflow.Companion.stateful(initialState: StateT, crossinline render: BaseRenderContext.(state: StateT) -> RenderingT): StatefulWorkflow","description":"com.squareup.workflow1.stateful","location":"workflow-core/com.squareup.workflow1/stateful.html","searchKeys":["stateful","inline fun Workflow.Companion.stateful(initialState: StateT, crossinline render: BaseRenderContext.(state: StateT) -> RenderingT): StatefulWorkflow","com.squareup.workflow1.stateful"]},{"name":"inline fun > BufferedSource.readEnumByOrdinal(): T","description":"com.squareup.workflow1.readEnumByOrdinal","location":"workflow-core/com.squareup.workflow1/read-enum-by-ordinal.html","searchKeys":["readEnumByOrdinal","inline fun > BufferedSource.readEnumByOrdinal(): T","com.squareup.workflow1.readEnumByOrdinal"]},{"name":"inline fun > BufferedSource.readOptionalEnumByOrdinal(): T?","description":"com.squareup.workflow1.readOptionalEnumByOrdinal","location":"workflow-core/com.squareup.workflow1/read-optional-enum-by-ordinal.html","searchKeys":["readOptionalEnumByOrdinal","inline fun > BufferedSource.readOptionalEnumByOrdinal(): T?","com.squareup.workflow1.readOptionalEnumByOrdinal"]},{"name":"inline fun , PropsT, StateT, OutputT> BaseRenderContext.runningWorker(worker: W, key: String = \"\", noinline handler: (T) -> WorkflowAction)","description":"com.squareup.workflow1.runningWorker","location":"workflow-core/com.squareup.workflow1/running-worker.html","searchKeys":["runningWorker","inline fun , PropsT, StateT, OutputT> BaseRenderContext.runningWorker(worker: W, key: String = \"\", noinline handler: (T) -> WorkflowAction)","com.squareup.workflow1.runningWorker"]},{"name":"inline fun BufferedSink.writeList(values: List, writer: BufferedSink.(T) -> Unit): BufferedSink","description":"com.squareup.workflow1.writeList","location":"workflow-core/com.squareup.workflow1/write-list.html","searchKeys":["writeList","inline fun BufferedSink.writeList(values: List, writer: BufferedSink.(T) -> Unit): BufferedSink","com.squareup.workflow1.writeList"]},{"name":"inline fun BufferedSource.readList(reader: BufferedSource.() -> T): List","description":"com.squareup.workflow1.readList","location":"workflow-core/com.squareup.workflow1/read-list.html","searchKeys":["readList","inline fun BufferedSource.readList(reader: BufferedSource.() -> T): List","com.squareup.workflow1.readList"]},{"name":"inline fun ByteString.parse(block: (BufferedSource) -> T): T","description":"com.squareup.workflow1.parse","location":"workflow-core/com.squareup.workflow1/parse.html","searchKeys":["parse","inline fun ByteString.parse(block: (BufferedSource) -> T): T","com.squareup.workflow1.parse"]},{"name":"inline fun BaseRenderContext.runningWorker(worker: W, key: String = \"\")","description":"com.squareup.workflow1.runningWorker","location":"workflow-core/com.squareup.workflow1/running-worker.html","searchKeys":["runningWorker","inline fun BaseRenderContext.runningWorker(worker: W, key: String = \"\")","com.squareup.workflow1.runningWorker"]},{"name":"inner class RenderContext : BaseRenderContext ","description":"com.squareup.workflow1.StatelessWorkflow.RenderContext","location":"workflow-core/com.squareup.workflow1/-stateless-workflow/-render-context/index.html","searchKeys":["RenderContext","inner class RenderContext : BaseRenderContext ","com.squareup.workflow1.StatelessWorkflow.RenderContext"]},{"name":"inner class RenderContext : BaseRenderContext ","description":"com.squareup.workflow1.StatefulWorkflow.RenderContext","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/-render-context/index.html","searchKeys":["RenderContext","inner class RenderContext : BaseRenderContext ","com.squareup.workflow1.StatefulWorkflow.RenderContext"]},{"name":"inner class Updater(val props: PropsT, var state: StateT)","description":"com.squareup.workflow1.WorkflowAction.Updater","location":"workflow-core/com.squareup.workflow1/-workflow-action/-updater/index.html","searchKeys":["Updater","inner class Updater(val props: PropsT, var state: StateT)","com.squareup.workflow1.WorkflowAction.Updater"]},{"name":"interface ActionProcessingResult","description":"com.squareup.workflow1.ActionProcessingResult","location":"workflow-core/com.squareup.workflow1/-action-processing-result/index.html","searchKeys":["ActionProcessingResult","interface ActionProcessingResult","com.squareup.workflow1.ActionProcessingResult"]},{"name":"interface BaseRenderContext","description":"com.squareup.workflow1.BaseRenderContext","location":"workflow-core/com.squareup.workflow1/-base-render-context/index.html","searchKeys":["BaseRenderContext","interface BaseRenderContext","com.squareup.workflow1.BaseRenderContext"]},{"name":"interface IdCacheable","description":"com.squareup.workflow1.IdCacheable","location":"workflow-core/com.squareup.workflow1/-id-cacheable/index.html","searchKeys":["IdCacheable","interface IdCacheable","com.squareup.workflow1.IdCacheable"]},{"name":"interface ImpostorWorkflow","description":"com.squareup.workflow1.ImpostorWorkflow","location":"workflow-core/com.squareup.workflow1/-impostor-workflow/index.html","searchKeys":["ImpostorWorkflow","interface ImpostorWorkflow","com.squareup.workflow1.ImpostorWorkflow"]},{"name":"interface Worker","description":"com.squareup.workflow1.Worker","location":"workflow-core/com.squareup.workflow1/-worker/index.html","searchKeys":["Worker","interface Worker","com.squareup.workflow1.Worker"]},{"name":"interface Workflow","description":"com.squareup.workflow1.Workflow","location":"workflow-core/com.squareup.workflow1/-workflow/index.html","searchKeys":["Workflow","interface Workflow","com.squareup.workflow1.Workflow"]},{"name":"object ActionsExhausted : ActionProcessingResult","description":"com.squareup.workflow1.ActionsExhausted","location":"workflow-core/com.squareup.workflow1/-actions-exhausted/index.html","searchKeys":["ActionsExhausted","object ActionsExhausted : ActionProcessingResult","com.squareup.workflow1.ActionsExhausted"]},{"name":"object Companion","description":"com.squareup.workflow1.Snapshot.Companion","location":"workflow-core/com.squareup.workflow1/-snapshot/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.Snapshot.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.Worker.Companion","location":"workflow-core/com.squareup.workflow1/-worker/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.Worker.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.Workflow.Companion","location":"workflow-core/com.squareup.workflow1/-workflow/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.Workflow.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.WorkflowAction.Companion","location":"workflow-core/com.squareup.workflow1/-workflow-action/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.WorkflowAction.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.WorkflowIdentifier.Companion","location":"workflow-core/com.squareup.workflow1/-workflow-identifier/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.WorkflowIdentifier.Companion"]},{"name":"object PropsUpdated : ActionProcessingResult","description":"com.squareup.workflow1.PropsUpdated","location":"workflow-core/com.squareup.workflow1/-props-updated/index.html","searchKeys":["PropsUpdated","object PropsUpdated : ActionProcessingResult","com.squareup.workflow1.PropsUpdated"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6, E7, E8, E9, E10) -> Unit): (E1, E2, E3, E4, E5, E6, E7, E8, E9, E10) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6, E7, E8, E9, E10) -> Unit): (E1, E2, E3, E4, E5, E6, E7, E8, E9, E10) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6, E7, E8, E9) -> Unit): (E1, E2, E3, E4, E5, E6, E7, E8, E9) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6, E7, E8, E9) -> Unit): (E1, E2, E3, E4, E5, E6, E7, E8, E9) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6, E7, E8) -> Unit): (E1, E2, E3, E4, E5, E6, E7, E8) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6, E7, E8) -> Unit): (E1, E2, E3, E4, E5, E6, E7, E8) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6, E7) -> Unit): (E1, E2, E3, E4, E5, E6, E7) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6, E7) -> Unit): (E1, E2, E3, E4, E5, E6, E7) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6) -> Unit): (E1, E2, E3, E4, E5, E6) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5, E6) -> Unit): (E1, E2, E3, E4, E5, E6) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5) -> Unit): (E1, E2, E3, E4, E5) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4, E5) -> Unit): (E1, E2, E3, E4, E5) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4) -> Unit): (E1, E2, E3, E4) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3, E4) -> Unit): (E1, E2, E3, E4) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3) -> Unit): (E1, E2, E3) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2, E3) -> Unit): (E1, E2, E3) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2) -> Unit): (E1, E2) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(E1, E2) -> Unit): (E1, E2) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(EventT) -> Unit): (EventT) -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.(EventT) -> Unit): (EventT) -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun describeRealIdentifier(): String?","description":"com.squareup.workflow1.ImpostorWorkflow.describeRealIdentifier","location":"workflow-core/com.squareup.workflow1/-impostor-workflow/describe-real-identifier.html","searchKeys":["describeRealIdentifier","open fun describeRealIdentifier(): String?","com.squareup.workflow1.ImpostorWorkflow.describeRealIdentifier"]},{"name":"open fun doesSameWorkAs(otherWorker: Worker<*>): Boolean","description":"com.squareup.workflow1.Worker.doesSameWorkAs","location":"workflow-core/com.squareup.workflow1/-worker/does-same-work-as.html","searchKeys":["doesSameWorkAs","open fun doesSameWorkAs(otherWorker: Worker<*>): Boolean","com.squareup.workflow1.Worker.doesSameWorkAs"]},{"name":"open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.() -> Unit): () -> Unit","description":"com.squareup.workflow1.BaseRenderContext.eventHandler","location":"workflow-core/com.squareup.workflow1/-base-render-context/event-handler.html","searchKeys":["eventHandler","open fun eventHandler(name: () -> String = { \"eventHandler\" }, update: WorkflowAction.Updater.() -> Unit): () -> Unit","com.squareup.workflow1.BaseRenderContext.eventHandler"]},{"name":"open fun initialState(props: PropsT, snapshot: Snapshot?, workflowScope: CoroutineScope): StateT","description":"com.squareup.workflow1.StatefulWorkflow.initialState","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/initial-state.html","searchKeys":["initialState","open fun initialState(props: PropsT, snapshot: Snapshot?, workflowScope: CoroutineScope): StateT","com.squareup.workflow1.StatefulWorkflow.initialState"]},{"name":"open fun onPropsChanged(old: PropsT, new: PropsT, state: StateT): StateT","description":"com.squareup.workflow1.StatefulWorkflow.onPropsChanged","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/on-props-changed.html","searchKeys":["onPropsChanged","open fun onPropsChanged(old: PropsT, new: PropsT, state: StateT): StateT","com.squareup.workflow1.StatefulWorkflow.onPropsChanged"]},{"name":"open fun onStarted()","description":"com.squareup.workflow1.LifecycleWorker.onStarted","location":"workflow-core/com.squareup.workflow1/-lifecycle-worker/on-started.html","searchKeys":["onStarted","open fun onStarted()","com.squareup.workflow1.LifecycleWorker.onStarted"]},{"name":"open fun onStopped()","description":"com.squareup.workflow1.LifecycleWorker.onStopped","location":"workflow-core/com.squareup.workflow1/-lifecycle-worker/on-stopped.html","searchKeys":["onStopped","open fun onStopped()","com.squareup.workflow1.LifecycleWorker.onStopped"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.ActionApplied.equals","location":"workflow-core/com.squareup.workflow1/-action-applied/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.ActionApplied.equals"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.Snapshot.equals","location":"workflow-core/com.squareup.workflow1/-snapshot/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.Snapshot.equals"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.WorkflowIdentifier.equals","location":"workflow-core/com.squareup.workflow1/-workflow-identifier/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.WorkflowIdentifier.equals"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.WorkflowOutput.equals","location":"workflow-core/com.squareup.workflow1/-workflow-output/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.WorkflowOutput.equals"]},{"name":"open override fun doesSameWorkAs(otherWorker: Worker<*>): Boolean","description":"com.squareup.workflow1.LifecycleWorker.doesSameWorkAs","location":"workflow-core/com.squareup.workflow1/-lifecycle-worker/does-same-work-as.html","searchKeys":["doesSameWorkAs","open override fun doesSameWorkAs(otherWorker: Worker<*>): Boolean","com.squareup.workflow1.LifecycleWorker.doesSameWorkAs"]},{"name":"open override fun hashCode(): Int","description":"com.squareup.workflow1.ActionApplied.hashCode","location":"workflow-core/com.squareup.workflow1/-action-applied/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","com.squareup.workflow1.ActionApplied.hashCode"]},{"name":"open override fun hashCode(): Int","description":"com.squareup.workflow1.Snapshot.hashCode","location":"workflow-core/com.squareup.workflow1/-snapshot/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","com.squareup.workflow1.Snapshot.hashCode"]},{"name":"open override fun hashCode(): Int","description":"com.squareup.workflow1.WorkflowIdentifier.hashCode","location":"workflow-core/com.squareup.workflow1/-workflow-identifier/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","com.squareup.workflow1.WorkflowIdentifier.hashCode"]},{"name":"open override fun hashCode(): Int","description":"com.squareup.workflow1.WorkflowOutput.hashCode","location":"workflow-core/com.squareup.workflow1/-workflow-output/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","com.squareup.workflow1.WorkflowOutput.hashCode"]},{"name":"open override fun toString(): String","description":"com.squareup.workflow1.ActionApplied.toString","location":"workflow-core/com.squareup.workflow1/-action-applied/to-string.html","searchKeys":["toString","open override fun toString(): String","com.squareup.workflow1.ActionApplied.toString"]},{"name":"open override fun toString(): String","description":"com.squareup.workflow1.Snapshot.toString","location":"workflow-core/com.squareup.workflow1/-snapshot/to-string.html","searchKeys":["toString","open override fun toString(): String","com.squareup.workflow1.Snapshot.toString"]},{"name":"open override fun toString(): String","description":"com.squareup.workflow1.WorkflowIdentifier.toString","location":"workflow-core/com.squareup.workflow1/-workflow-identifier/to-string.html","searchKeys":["toString","open override fun toString(): String","com.squareup.workflow1.WorkflowIdentifier.toString"]},{"name":"open override fun toString(): String","description":"com.squareup.workflow1.WorkflowOutput.toString","location":"workflow-core/com.squareup.workflow1/-workflow-output/to-string.html","searchKeys":["toString","open override fun toString(): String","com.squareup.workflow1.WorkflowOutput.toString"]},{"name":"open override val typeName: String","description":"com.squareup.workflow1.WorkflowIdentifierType.Snapshottable.typeName","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/-snapshottable/type-name.html","searchKeys":["typeName","open override val typeName: String","com.squareup.workflow1.WorkflowIdentifierType.Snapshottable.typeName"]},{"name":"open override val typeName: String","description":"com.squareup.workflow1.WorkflowIdentifierType.Unsnapshottable.typeName","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/-unsnapshottable/type-name.html","searchKeys":["typeName","open override val typeName: String","com.squareup.workflow1.WorkflowIdentifierType.Unsnapshottable.typeName"]},{"name":"open override var cachedIdentifier: WorkflowIdentifier?","description":"com.squareup.workflow1.StatefulWorkflow.cachedIdentifier","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/cached-identifier.html","searchKeys":["cachedIdentifier","open override var cachedIdentifier: WorkflowIdentifier?","com.squareup.workflow1.StatefulWorkflow.cachedIdentifier"]},{"name":"open override var cachedIdentifier: WorkflowIdentifier?","description":"com.squareup.workflow1.StatelessWorkflow.cachedIdentifier","location":"workflow-core/com.squareup.workflow1/-stateless-workflow/cached-identifier.html","searchKeys":["cachedIdentifier","open override var cachedIdentifier: WorkflowIdentifier?","com.squareup.workflow1.StatelessWorkflow.cachedIdentifier"]},{"name":"override fun asStatefulWorkflow(): StatefulWorkflow","description":"com.squareup.workflow1.StatelessWorkflow.asStatefulWorkflow","location":"workflow-core/com.squareup.workflow1/-stateless-workflow/as-stateful-workflow.html","searchKeys":["asStatefulWorkflow","override fun asStatefulWorkflow(): StatefulWorkflow","com.squareup.workflow1.StatelessWorkflow.asStatefulWorkflow"]},{"name":"override fun asStatefulWorkflow(): StatefulWorkflow","description":"com.squareup.workflow1.StatefulWorkflow.asStatefulWorkflow","location":"workflow-core/com.squareup.workflow1/-stateful-workflow/as-stateful-workflow.html","searchKeys":["asStatefulWorkflow","override fun asStatefulWorkflow(): StatefulWorkflow","com.squareup.workflow1.StatefulWorkflow.asStatefulWorkflow"]},{"name":"override fun initialState(props: PropsT, snapshot: Snapshot?): StateT","description":"com.squareup.workflow1.SessionWorkflow.initialState","location":"workflow-core/com.squareup.workflow1/-session-workflow/initial-state.html","searchKeys":["initialState","override fun initialState(props: PropsT, snapshot: Snapshot?): StateT","com.squareup.workflow1.SessionWorkflow.initialState"]},{"name":"override fun run(): Flow","description":"com.squareup.workflow1.LifecycleWorker.run","location":"workflow-core/com.squareup.workflow1/-lifecycle-worker/run.html","searchKeys":["run","override fun run(): Flow","com.squareup.workflow1.LifecycleWorker.run"]},{"name":"sealed class WorkflowIdentifierType","description":"com.squareup.workflow1.WorkflowIdentifierType","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/index.html","searchKeys":["WorkflowIdentifierType","sealed class WorkflowIdentifierType","com.squareup.workflow1.WorkflowIdentifierType"]},{"name":"val KClass>.workflowIdentifier: WorkflowIdentifier","description":"com.squareup.workflow1.workflowIdentifier","location":"workflow-core/com.squareup.workflow1/workflow-identifier.html","searchKeys":["workflowIdentifier","val KClass>.workflowIdentifier: WorkflowIdentifier","com.squareup.workflow1.workflowIdentifier"]},{"name":"val Workflow<*, *, *>.computedIdentifier: WorkflowIdentifier","description":"com.squareup.workflow1.computedIdentifier","location":"workflow-core/com.squareup.workflow1/computed-identifier.html","searchKeys":["computedIdentifier","val Workflow<*, *, *>.computedIdentifier: WorkflowIdentifier","com.squareup.workflow1.computedIdentifier"]},{"name":"val Workflow<*, *, *>.identifier: WorkflowIdentifier","description":"com.squareup.workflow1.identifier","location":"workflow-core/com.squareup.workflow1/identifier.html","searchKeys":["identifier","val Workflow<*, *, *>.identifier: WorkflowIdentifier","com.squareup.workflow1.identifier"]},{"name":"val bytes: ByteString","description":"com.squareup.workflow1.Snapshot.bytes","location":"workflow-core/com.squareup.workflow1/-snapshot/bytes.html","searchKeys":["bytes","val bytes: ByteString","com.squareup.workflow1.Snapshot.bytes"]},{"name":"val kClass: KClass<*>? = null","description":"com.squareup.workflow1.WorkflowIdentifierType.Snapshottable.kClass","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/-snapshottable/k-class.html","searchKeys":["kClass","val kClass: KClass<*>? = null","com.squareup.workflow1.WorkflowIdentifierType.Snapshottable.kClass"]},{"name":"val kType: KType","description":"com.squareup.workflow1.WorkflowIdentifierType.Unsnapshottable.kType","location":"workflow-core/com.squareup.workflow1/-workflow-identifier-type/-unsnapshottable/k-type.html","searchKeys":["kType","val kType: KType","com.squareup.workflow1.WorkflowIdentifierType.Unsnapshottable.kType"]},{"name":"val output: WorkflowOutput?","description":"com.squareup.workflow1.ActionApplied.output","location":"workflow-core/com.squareup.workflow1/-action-applied/output.html","searchKeys":["output","val output: WorkflowOutput?","com.squareup.workflow1.ActionApplied.output"]},{"name":"val props: PropsT","description":"com.squareup.workflow1.WorkflowAction.Updater.props","location":"workflow-core/com.squareup.workflow1/-workflow-action/-updater/props.html","searchKeys":["props","val props: PropsT","com.squareup.workflow1.WorkflowAction.Updater.props"]},{"name":"val stateChanged: Boolean = false","description":"com.squareup.workflow1.ActionApplied.stateChanged","location":"workflow-core/com.squareup.workflow1/-action-applied/state-changed.html","searchKeys":["stateChanged","val stateChanged: Boolean = false","com.squareup.workflow1.ActionApplied.stateChanged"]},{"name":"val value: OutputT","description":"com.squareup.workflow1.WorkflowOutput.value","location":"workflow-core/com.squareup.workflow1/-workflow-output/value.html","searchKeys":["value","val value: OutputT","com.squareup.workflow1.WorkflowOutput.value"]},{"name":"var state: StateT","description":"com.squareup.workflow1.WorkflowAction.Updater.state","location":"workflow-core/com.squareup.workflow1/-workflow-action/-updater/state.html","searchKeys":["state","var state: StateT","com.squareup.workflow1.WorkflowAction.Updater.state"]},{"name":"First","description":"com.squareup.workflow1.ui.navigation.BackStackConfig.First","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-config/-first/index.html","searchKeys":["First","First","com.squareup.workflow1.ui.navigation.BackStackConfig.First"]},{"name":"NEGATIVE","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Button.NEGATIVE","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-button/-n-e-g-a-t-i-v-e/index.html","searchKeys":["NEGATIVE","NEGATIVE","com.squareup.workflow1.ui.navigation.AlertOverlay.Button.NEGATIVE"]},{"name":"NEUTRAL","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Button.NEUTRAL","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-button/-n-e-u-t-r-a-l/index.html","searchKeys":["NEUTRAL","NEUTRAL","com.squareup.workflow1.ui.navigation.AlertOverlay.Button.NEUTRAL"]},{"name":"None","description":"com.squareup.workflow1.ui.navigation.BackStackConfig.None","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-config/-none/index.html","searchKeys":["None","None","com.squareup.workflow1.ui.navigation.BackStackConfig.None"]},{"name":"Other","description":"com.squareup.workflow1.ui.navigation.BackStackConfig.Other","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-config/-other/index.html","searchKeys":["Other","Other","com.squareup.workflow1.ui.navigation.BackStackConfig.Other"]},{"name":"POSITIVE","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Button.POSITIVE","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-button/-p-o-s-i-t-i-v-e/index.html","searchKeys":["POSITIVE","POSITIVE","com.squareup.workflow1.ui.navigation.AlertOverlay.Button.POSITIVE"]},{"name":"abstract class ViewEnvironmentKey","description":"com.squareup.workflow1.ui.ViewEnvironmentKey","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment-key/index.html","searchKeys":["ViewEnvironmentKey","abstract class ViewEnvironmentKey","com.squareup.workflow1.ui.ViewEnvironmentKey"]},{"name":"abstract fun map(transform: (C) -> D): Container","description":"com.squareup.workflow1.ui.Container.map","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-container/map.html","searchKeys":["map","abstract fun map(transform: (C) -> D): Container","com.squareup.workflow1.ui.Container.map"]},{"name":"abstract fun getEntryFor(key: ViewRegistry.Key): ViewRegistry.Entry?","description":"com.squareup.workflow1.ui.ViewRegistry.getEntryFor","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/get-entry-for.html","searchKeys":["getEntryFor","abstract fun getEntryFor(key: ViewRegistry.Key): ViewRegistry.Entry?","com.squareup.workflow1.ui.ViewRegistry.getEntryFor"]},{"name":"abstract fun asSequence(): Sequence","description":"com.squareup.workflow1.ui.Container.asSequence","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-container/as-sequence.html","searchKeys":["asSequence","abstract fun asSequence(): Sequence","com.squareup.workflow1.ui.Container.asSequence"]},{"name":"abstract override fun map(transform: (ContentT) -> ContentU): ScreenOverlay","description":"com.squareup.workflow1.ui.navigation.ScreenOverlay.map","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-screen-overlay/map.html","searchKeys":["map","abstract override fun map(transform: (ContentT) -> ContentU): ScreenOverlay","com.squareup.workflow1.ui.navigation.ScreenOverlay.map"]},{"name":"abstract override fun map(transform: (C) -> D): Wrapper","description":"com.squareup.workflow1.ui.Wrapper.map","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-wrapper/map.html","searchKeys":["map","abstract override fun map(transform: (C) -> D): Wrapper","com.squareup.workflow1.ui.Wrapper.map"]},{"name":"abstract override val content: ContentT","description":"com.squareup.workflow1.ui.navigation.ScreenOverlay.content","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-screen-overlay/content.html","searchKeys":["content","abstract override val content: ContentT","com.squareup.workflow1.ui.navigation.ScreenOverlay.content"]},{"name":"abstract val compatibilityKey: String","description":"com.squareup.workflow1.ui.Compatible.compatibilityKey","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-compatible/compatibility-key.html","searchKeys":["compatibilityKey","abstract val compatibilityKey: String","com.squareup.workflow1.ui.Compatible.compatibilityKey"]},{"name":"abstract val content: C","description":"com.squareup.workflow1.ui.Wrapper.content","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-wrapper/content.html","searchKeys":["content","abstract val content: C","com.squareup.workflow1.ui.Wrapper.content"]},{"name":"abstract val default: T","description":"com.squareup.workflow1.ui.ViewEnvironmentKey.default","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment-key/default.html","searchKeys":["default","abstract val default: T","com.squareup.workflow1.ui.ViewEnvironmentKey.default"]},{"name":"abstract val key: ViewRegistry.Key","description":"com.squareup.workflow1.ui.ViewRegistry.Entry.key","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-entry/key.html","searchKeys":["key","abstract val key: ViewRegistry.Key","com.squareup.workflow1.ui.ViewRegistry.Entry.key"]},{"name":"abstract val keys: Set>","description":"com.squareup.workflow1.ui.ViewRegistry.keys","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/keys.html","searchKeys":["keys","abstract val keys: Set>","com.squareup.workflow1.ui.ViewRegistry.keys"]},{"name":"abstract val onTextChanged: Flow","description":"com.squareup.workflow1.ui.TextController.onTextChanged","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-text-controller/on-text-changed.html","searchKeys":["onTextChanged","abstract val onTextChanged: Flow","com.squareup.workflow1.ui.TextController.onTextChanged"]},{"name":"abstract var textValue: String","description":"com.squareup.workflow1.ui.TextController.textValue","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-text-controller/text-value.html","searchKeys":["textValue","abstract var textValue: String","com.squareup.workflow1.ui.TextController.textValue"]},{"name":"annotation class WorkflowUiExperimentalApi","description":"com.squareup.workflow1.ui.WorkflowUiExperimentalApi","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-workflow-ui-experimental-api/index.html","searchKeys":["WorkflowUiExperimentalApi","annotation class WorkflowUiExperimentalApi","com.squareup.workflow1.ui.WorkflowUiExperimentalApi"]},{"name":"class BackStackScreen : Screen, Container ","description":"com.squareup.workflow1.ui.navigation.BackStackScreen","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/index.html","searchKeys":["BackStackScreen","class BackStackScreen : Screen, Container ","com.squareup.workflow1.ui.navigation.BackStackScreen"]},{"name":"class BodyAndOverlaysScreen(val body: B, val overlays: List = emptyList(), val name: String = \"\") : Screen, Compatible","description":"com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/index.html","searchKeys":["BodyAndOverlaysScreen","class BodyAndOverlaysScreen(val body: B, val overlays: List = emptyList(), val name: String = \"\") : Screen, Compatible","com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen"]},{"name":"class EnvironmentScreen(val content: C, val environment: ViewEnvironment = ViewEnvironment.EMPTY) : Wrapper , Screen","description":"com.squareup.workflow1.ui.EnvironmentScreen","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-environment-screen/index.html","searchKeys":["EnvironmentScreen","class EnvironmentScreen(val content: C, val environment: ViewEnvironment = ViewEnvironment.EMPTY) : Wrapper , Screen","com.squareup.workflow1.ui.EnvironmentScreen"]},{"name":"class FullScreenModal(val content: C) : ScreenOverlay , ModalOverlay","description":"com.squareup.workflow1.ui.navigation.FullScreenModal","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-full-screen-modal/index.html","searchKeys":["FullScreenModal","class FullScreenModal(val content: C) : ScreenOverlay , ModalOverlay","com.squareup.workflow1.ui.navigation.FullScreenModal"]},{"name":"class Key(val renderingType: KClass, val factoryType: KClass)","description":"com.squareup.workflow1.ui.ViewRegistry.Key","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/index.html","searchKeys":["Key","class Key(val renderingType: KClass, val factoryType: KClass)","com.squareup.workflow1.ui.ViewRegistry.Key"]},{"name":"class ViewEnvironment","description":"com.squareup.workflow1.ui.ViewEnvironment","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/index.html","searchKeys":["ViewEnvironment","class ViewEnvironment","com.squareup.workflow1.ui.ViewEnvironment"]},{"name":"constructor()","description":"com.squareup.workflow1.ui.ViewEnvironmentKey.ViewEnvironmentKey","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment-key/-view-environment-key.html","searchKeys":["ViewEnvironmentKey","constructor()","com.squareup.workflow1.ui.ViewEnvironmentKey.ViewEnvironmentKey"]},{"name":"constructor(body: B, overlays: List = emptyList(), name: String = \"\")","description":"com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.BodyAndOverlaysScreen","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/-body-and-overlays-screen.html","searchKeys":["BodyAndOverlaysScreen","constructor(body: B, overlays: List = emptyList(), name: String = \"\")","com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.BodyAndOverlaysScreen"]},{"name":"constructor(bottom: StackedT, vararg rest: StackedT)","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.BackStackScreen","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/-back-stack-screen.html","searchKeys":["BackStackScreen","constructor(bottom: StackedT, vararg rest: StackedT)","com.squareup.workflow1.ui.navigation.BackStackScreen.BackStackScreen"]},{"name":"constructor(button: AlertOverlay.Button)","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Event.ButtonClicked.ButtonClicked","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-event/-button-clicked/-button-clicked.html","searchKeys":["ButtonClicked","constructor(button: AlertOverlay.Button)","com.squareup.workflow1.ui.navigation.AlertOverlay.Event.ButtonClicked.ButtonClicked"]},{"name":"constructor(buttons: Map = emptyMap(), message: String = \"\", title: String = \"\", cancelable: Boolean = true, onEvent: (AlertOverlay.Event) -> Unit)","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.AlertOverlay","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-alert-overlay.html","searchKeys":["AlertOverlay","constructor(buttons: Map = emptyMap(), message: String = \"\", title: String = \"\", cancelable: Boolean = true, onEvent: (AlertOverlay.Event) -> Unit)","com.squareup.workflow1.ui.navigation.AlertOverlay.AlertOverlay"]},{"name":"constructor(content: C)","description":"com.squareup.workflow1.ui.navigation.FullScreenModal.FullScreenModal","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-full-screen-modal/-full-screen-modal.html","searchKeys":["FullScreenModal","constructor(content: C)","com.squareup.workflow1.ui.navigation.FullScreenModal.FullScreenModal"]},{"name":"constructor(content: C, environment: ViewEnvironment = ViewEnvironment.EMPTY)","description":"com.squareup.workflow1.ui.EnvironmentScreen.EnvironmentScreen","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-environment-screen/-environment-screen.html","searchKeys":["EnvironmentScreen","constructor(content: C, environment: ViewEnvironment = ViewEnvironment.EMPTY)","com.squareup.workflow1.ui.EnvironmentScreen.EnvironmentScreen"]},{"name":"constructor(content: C, name: String)","description":"com.squareup.workflow1.ui.NamedScreen.NamedScreen","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-named-screen/-named-screen.html","searchKeys":["NamedScreen","constructor(content: C, name: String)","com.squareup.workflow1.ui.NamedScreen.NamedScreen"]},{"name":"constructor(renderingType: KClass, factoryType: KClass)","description":"com.squareup.workflow1.ui.ViewRegistry.Key.Key","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/-key.html","searchKeys":["Key","constructor(renderingType: KClass, factoryType: KClass)","com.squareup.workflow1.ui.ViewRegistry.Key.Key"]},{"name":"data class AlertOverlay(val buttons: Map = emptyMap(), val message: String = \"\", val title: String = \"\", val cancelable: Boolean = true, val onEvent: (AlertOverlay.Event) -> Unit) : ModalOverlay","description":"com.squareup.workflow1.ui.navigation.AlertOverlay","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/index.html","searchKeys":["AlertOverlay","data class AlertOverlay(val buttons: Map = emptyMap(), val message: String = \"\", val title: String = \"\", val cancelable: Boolean = true, val onEvent: (AlertOverlay.Event) -> Unit) : ModalOverlay","com.squareup.workflow1.ui.navigation.AlertOverlay"]},{"name":"data class ButtonClicked(val button: AlertOverlay.Button) : AlertOverlay.Event","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Event.ButtonClicked","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-event/-button-clicked/index.html","searchKeys":["ButtonClicked","data class ButtonClicked(val button: AlertOverlay.Button) : AlertOverlay.Event","com.squareup.workflow1.ui.navigation.AlertOverlay.Event.ButtonClicked"]},{"name":"data class NamedScreen(val content: C, val name: String) : Screen, Wrapper ","description":"com.squareup.workflow1.ui.NamedScreen","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-named-screen/index.html","searchKeys":["NamedScreen","data class NamedScreen(val content: C, val name: String) : Screen, Wrapper ","com.squareup.workflow1.ui.NamedScreen"]},{"name":"enum BackStackConfig : Enum ","description":"com.squareup.workflow1.ui.navigation.BackStackConfig","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-config/index.html","searchKeys":["BackStackConfig","enum BackStackConfig : Enum ","com.squareup.workflow1.ui.navigation.BackStackConfig"]},{"name":"enum Button : Enum ","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Button","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-button/index.html","searchKeys":["Button","enum Button : Enum ","com.squareup.workflow1.ui.navigation.AlertOverlay.Button"]},{"name":"fun mapOverlays(transform: (O) -> N): BodyAndOverlaysScreen","description":"com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.mapOverlays","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/map-overlays.html","searchKeys":["mapOverlays","fun mapOverlays(transform: (O) -> N): BodyAndOverlaysScreen","com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.mapOverlays"]},{"name":"fun mapIndexed(transform: (index: Int, StackedT) -> R): BackStackScreen","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.mapIndexed","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/map-indexed.html","searchKeys":["mapIndexed","fun mapIndexed(transform: (index: Int, StackedT) -> R): BackStackScreen","com.squareup.workflow1.ui.navigation.BackStackScreen.mapIndexed"]},{"name":"fun mapBody(transform: (B) -> S): BodyAndOverlaysScreen","description":"com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.mapBody","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/map-body.html","searchKeys":["mapBody","fun mapBody(transform: (B) -> S): BodyAndOverlaysScreen","com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.mapBody"]},{"name":"fun Screen.withEnvironment(entry: Pair, T>): EnvironmentScreen<*>","description":"com.squareup.workflow1.ui.withEnvironment","location":"workflow-ui/core-common/com.squareup.workflow1.ui/with-environment.html","searchKeys":["withEnvironment","fun Screen.withEnvironment(entry: Pair, T>): EnvironmentScreen<*>","com.squareup.workflow1.ui.withEnvironment"]},{"name":"fun List.toBackStackScreen(): BackStackScreen","description":"com.squareup.workflow1.ui.navigation.toBackStackScreen","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/to-back-stack-screen.html","searchKeys":["toBackStackScreen","fun List.toBackStackScreen(): BackStackScreen","com.squareup.workflow1.ui.navigation.toBackStackScreen"]},{"name":"fun List.toBackStackScreenOrNull(): BackStackScreen?","description":"com.squareup.workflow1.ui.navigation.toBackStackScreenOrNull","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/to-back-stack-screen-or-null.html","searchKeys":["toBackStackScreenOrNull","fun List.toBackStackScreenOrNull(): BackStackScreen?","com.squareup.workflow1.ui.navigation.toBackStackScreenOrNull"]},{"name":"fun fromList(frames: List): BackStackScreen","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.Companion.fromList","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/-companion/from-list.html","searchKeys":["fromList","fun fromList(frames: List): BackStackScreen","com.squareup.workflow1.ui.navigation.BackStackScreen.Companion.fromList"]},{"name":"fun fromListOrNull(frames: List): BackStackScreen?","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.Companion.fromListOrNull","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/-companion/from-list-or-null.html","searchKeys":["fromListOrNull","fun fromListOrNull(frames: List): BackStackScreen?","com.squareup.workflow1.ui.navigation.BackStackScreen.Companion.fromListOrNull"]},{"name":"fun Screen.withEnvironment(environment: ViewEnvironment = ViewEnvironment.EMPTY): EnvironmentScreen<*>","description":"com.squareup.workflow1.ui.withEnvironment","location":"workflow-ui/core-common/com.squareup.workflow1.ui/with-environment.html","searchKeys":["withEnvironment","fun Screen.withEnvironment(environment: ViewEnvironment = ViewEnvironment.EMPTY): EnvironmentScreen<*>","com.squareup.workflow1.ui.withEnvironment"]},{"name":"fun Screen.withRegistry(viewRegistry: ViewRegistry): EnvironmentScreen<*>","description":"com.squareup.workflow1.ui.withRegistry","location":"workflow-ui/core-common/com.squareup.workflow1.ui/with-registry.html","searchKeys":["withRegistry","fun Screen.withRegistry(viewRegistry: ViewRegistry): EnvironmentScreen<*>","com.squareup.workflow1.ui.withRegistry"]},{"name":"fun TextController(initialValue: String = \"\"): TextController","description":"com.squareup.workflow1.ui.TextController","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-text-controller.html","searchKeys":["TextController","fun TextController(initialValue: String = \"\"): TextController","com.squareup.workflow1.ui.TextController"]},{"name":"fun ViewRegistry(): ViewRegistry","description":"com.squareup.workflow1.ui.ViewRegistry","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry.html","searchKeys":["ViewRegistry","fun ViewRegistry(): ViewRegistry","com.squareup.workflow1.ui.ViewRegistry"]},{"name":"fun ViewRegistry(vararg bindings: ViewRegistry.Entry<*>): ViewRegistry","description":"com.squareup.workflow1.ui.ViewRegistry","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry.html","searchKeys":["ViewRegistry","fun ViewRegistry(vararg bindings: ViewRegistry.Entry<*>): ViewRegistry","com.squareup.workflow1.ui.ViewRegistry"]},{"name":"fun compatible(me: Any, you: Any): Boolean","description":"com.squareup.workflow1.ui.compatible","location":"workflow-ui/core-common/com.squareup.workflow1.ui/compatible.html","searchKeys":["compatible","fun compatible(me: Any, you: Any): Boolean","com.squareup.workflow1.ui.compatible"]},{"name":"fun keyFor(value: Any, name: String = \"\"): String","description":"com.squareup.workflow1.ui.Compatible.Companion.keyFor","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-compatible/-companion/key-for.html","searchKeys":["keyFor","fun keyFor(value: Any, name: String = \"\"): String","com.squareup.workflow1.ui.Compatible.Companion.keyFor"]},{"name":"fun valueOf(value: String): AlertOverlay.Button","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Button.valueOf","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-button/value-of.html","searchKeys":["valueOf","fun valueOf(value: String): AlertOverlay.Button","com.squareup.workflow1.ui.navigation.AlertOverlay.Button.valueOf"]},{"name":"fun valueOf(value: String): BackStackConfig","description":"com.squareup.workflow1.ui.navigation.BackStackConfig.valueOf","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-config/value-of.html","searchKeys":["valueOf","fun valueOf(value: String): BackStackConfig","com.squareup.workflow1.ui.navigation.BackStackConfig.valueOf"]},{"name":"fun values(): Array","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Button.values","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-button/values.html","searchKeys":["values","fun values(): Array","com.squareup.workflow1.ui.navigation.AlertOverlay.Button.values"]},{"name":"fun values(): Array","description":"com.squareup.workflow1.ui.navigation.BackStackConfig.values","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-config/values.html","searchKeys":["values","fun values(): Array","com.squareup.workflow1.ui.navigation.BackStackConfig.values"]},{"name":"infix fun ViewRegistry.merge(other: ViewRegistry): ViewRegistry","description":"com.squareup.workflow1.ui.merge","location":"workflow-ui/core-common/com.squareup.workflow1.ui/merge.html","searchKeys":["merge","infix fun ViewRegistry.merge(other: ViewRegistry): ViewRegistry","com.squareup.workflow1.ui.merge"]},{"name":"inline fun ViewRegistry.getFactoryFor(): FactoryT?","description":"com.squareup.workflow1.ui.getFactoryFor","location":"workflow-ui/core-common/com.squareup.workflow1.ui/get-factory-for.html","searchKeys":["getFactoryFor","inline fun ViewRegistry.getFactoryFor(): FactoryT?","com.squareup.workflow1.ui.getFactoryFor"]},{"name":"inline fun ViewRegistry.getFactoryFor(rendering: RenderingT): FactoryT?","description":"com.squareup.workflow1.ui.getFactoryFor","location":"workflow-ui/core-common/com.squareup.workflow1.ui/get-factory-for.html","searchKeys":["getFactoryFor","inline fun ViewRegistry.getFactoryFor(rendering: RenderingT): FactoryT?","com.squareup.workflow1.ui.getFactoryFor"]},{"name":"inline operator fun ViewRegistry.get(key: ViewRegistry.Key): FactoryT?","description":"com.squareup.workflow1.ui.get","location":"workflow-ui/core-common/com.squareup.workflow1.ui/get.html","searchKeys":["get","inline operator fun ViewRegistry.get(key: ViewRegistry.Key): FactoryT?","com.squareup.workflow1.ui.get"]},{"name":"interface Compatible","description":"com.squareup.workflow1.ui.Compatible","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-compatible/index.html","searchKeys":["Compatible","interface Compatible","com.squareup.workflow1.ui.Compatible"]},{"name":"interface Container","description":"com.squareup.workflow1.ui.Container","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-container/index.html","searchKeys":["Container","interface Container","com.squareup.workflow1.ui.Container"]},{"name":"interface Entry","description":"com.squareup.workflow1.ui.ViewRegistry.Entry","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-entry/index.html","searchKeys":["Entry","interface Entry","com.squareup.workflow1.ui.ViewRegistry.Entry"]},{"name":"interface ModalOverlay : Overlay","description":"com.squareup.workflow1.ui.navigation.ModalOverlay","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-modal-overlay/index.html","searchKeys":["ModalOverlay","interface ModalOverlay : Overlay","com.squareup.workflow1.ui.navigation.ModalOverlay"]},{"name":"interface Overlay","description":"com.squareup.workflow1.ui.navigation.Overlay","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-overlay/index.html","searchKeys":["Overlay","interface Overlay","com.squareup.workflow1.ui.navigation.Overlay"]},{"name":"interface Screen","description":"com.squareup.workflow1.ui.Screen","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-screen/index.html","searchKeys":["Screen","interface Screen","com.squareup.workflow1.ui.Screen"]},{"name":"interface ScreenOverlay : Overlay, Wrapper ","description":"com.squareup.workflow1.ui.navigation.ScreenOverlay","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-screen-overlay/index.html","searchKeys":["ScreenOverlay","interface ScreenOverlay : Overlay, Wrapper ","com.squareup.workflow1.ui.navigation.ScreenOverlay"]},{"name":"interface TextController","description":"com.squareup.workflow1.ui.TextController","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-text-controller/index.html","searchKeys":["TextController","interface TextController","com.squareup.workflow1.ui.TextController"]},{"name":"interface ViewRegistry","description":"com.squareup.workflow1.ui.ViewRegistry","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/index.html","searchKeys":["ViewRegistry","interface ViewRegistry","com.squareup.workflow1.ui.ViewRegistry"]},{"name":"interface Wrapper : Container , Compatible","description":"com.squareup.workflow1.ui.Wrapper","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-wrapper/index.html","searchKeys":["Wrapper","interface Wrapper : Container , Compatible","com.squareup.workflow1.ui.Wrapper"]},{"name":"object Canceled : AlertOverlay.Event","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Event.Canceled","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-event/-canceled/index.html","searchKeys":["Canceled","object Canceled : AlertOverlay.Event","com.squareup.workflow1.ui.navigation.AlertOverlay.Event.Canceled"]},{"name":"object Companion","description":"com.squareup.workflow1.ui.Compatible.Companion","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-compatible/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.ui.Compatible.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.ui.ViewEnvironment.Companion","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.ui.ViewEnvironment.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.Companion","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.ui.navigation.BackStackScreen.Companion"]},{"name":"object Companion : ViewEnvironmentKey ","description":"com.squareup.workflow1.ui.navigation.BackStackConfig.Companion","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-config/-companion/index.html","searchKeys":["Companion","object Companion : ViewEnvironmentKey ","com.squareup.workflow1.ui.navigation.BackStackConfig.Companion"]},{"name":"object Companion : ViewEnvironmentKey ","description":"com.squareup.workflow1.ui.ViewRegistry.Companion","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-companion/index.html","searchKeys":["Companion","object Companion : ViewEnvironmentKey ","com.squareup.workflow1.ui.ViewRegistry.Companion"]},{"name":"open fun combine(left: T, right: T): T","description":"com.squareup.workflow1.ui.ViewEnvironmentKey.combine","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment-key/combine.html","searchKeys":["combine","open fun combine(left: T, right: T): T","com.squareup.workflow1.ui.ViewEnvironmentKey.combine"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.ui.ViewEnvironment.equals","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.ui.ViewEnvironment.equals"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.ui.ViewRegistry.Key.equals","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.ui.ViewRegistry.Key.equals"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.equals","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.ui.navigation.AlertOverlay.equals"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.equals","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.ui.navigation.BackStackScreen.equals"]},{"name":"open override fun map(transform: (C) -> D): EnvironmentScreen","description":"com.squareup.workflow1.ui.EnvironmentScreen.map","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-environment-screen/map.html","searchKeys":["map","open override fun map(transform: (C) -> D): EnvironmentScreen","com.squareup.workflow1.ui.EnvironmentScreen.map"]},{"name":"open override fun map(transform: (C) -> D): FullScreenModal","description":"com.squareup.workflow1.ui.navigation.FullScreenModal.map","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-full-screen-modal/map.html","searchKeys":["map","open override fun map(transform: (C) -> D): FullScreenModal","com.squareup.workflow1.ui.navigation.FullScreenModal.map"]},{"name":"open override fun map(transform: (C) -> D): NamedScreen","description":"com.squareup.workflow1.ui.NamedScreen.map","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-named-screen/map.html","searchKeys":["map","open override fun map(transform: (C) -> D): NamedScreen","com.squareup.workflow1.ui.NamedScreen.map"]},{"name":"open override fun map(transform: (StackedT) -> StackedU): BackStackScreen","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.map","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/map.html","searchKeys":["map","open override fun map(transform: (StackedT) -> StackedU): BackStackScreen","com.squareup.workflow1.ui.navigation.BackStackScreen.map"]},{"name":"open override fun asSequence(): Sequence","description":"com.squareup.workflow1.ui.Wrapper.asSequence","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-wrapper/as-sequence.html","searchKeys":["asSequence","open override fun asSequence(): Sequence","com.squareup.workflow1.ui.Wrapper.asSequence"]},{"name":"open override fun asSequence(): Sequence","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.asSequence","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/as-sequence.html","searchKeys":["asSequence","open override fun asSequence(): Sequence","com.squareup.workflow1.ui.navigation.BackStackScreen.asSequence"]},{"name":"open override fun combine(left: ViewRegistry, right: ViewRegistry): ViewRegistry","description":"com.squareup.workflow1.ui.ViewRegistry.Companion.combine","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-companion/combine.html","searchKeys":["combine","open override fun combine(left: ViewRegistry, right: ViewRegistry): ViewRegistry","com.squareup.workflow1.ui.ViewRegistry.Companion.combine"]},{"name":"open override fun hashCode(): Int","description":"com.squareup.workflow1.ui.ViewEnvironment.hashCode","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","com.squareup.workflow1.ui.ViewEnvironment.hashCode"]},{"name":"open override fun hashCode(): Int","description":"com.squareup.workflow1.ui.ViewRegistry.Key.hashCode","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","com.squareup.workflow1.ui.ViewRegistry.Key.hashCode"]},{"name":"open override fun hashCode(): Int","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.hashCode","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","com.squareup.workflow1.ui.navigation.AlertOverlay.hashCode"]},{"name":"open override fun hashCode(): Int","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.hashCode","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","com.squareup.workflow1.ui.navigation.BackStackScreen.hashCode"]},{"name":"open override fun toString(): String","description":"com.squareup.workflow1.ui.NamedScreen.toString","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-named-screen/to-string.html","searchKeys":["toString","open override fun toString(): String","com.squareup.workflow1.ui.NamedScreen.toString"]},{"name":"open override fun toString(): String","description":"com.squareup.workflow1.ui.ViewEnvironment.toString","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/to-string.html","searchKeys":["toString","open override fun toString(): String","com.squareup.workflow1.ui.ViewEnvironment.toString"]},{"name":"open override fun toString(): String","description":"com.squareup.workflow1.ui.ViewRegistry.Key.toString","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/to-string.html","searchKeys":["toString","open override fun toString(): String","com.squareup.workflow1.ui.ViewRegistry.Key.toString"]},{"name":"open override fun toString(): String","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.toString","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/to-string.html","searchKeys":["toString","open override fun toString(): String","com.squareup.workflow1.ui.navigation.BackStackScreen.toString"]},{"name":"open override val compatibilityKey: String","description":"com.squareup.workflow1.ui.NamedScreen.compatibilityKey","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-named-screen/compatibility-key.html","searchKeys":["compatibilityKey","open override val compatibilityKey: String","com.squareup.workflow1.ui.NamedScreen.compatibilityKey"]},{"name":"open override val compatibilityKey: String","description":"com.squareup.workflow1.ui.Wrapper.compatibilityKey","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-wrapper/compatibility-key.html","searchKeys":["compatibilityKey","open override val compatibilityKey: String","com.squareup.workflow1.ui.Wrapper.compatibilityKey"]},{"name":"open override val compatibilityKey: String","description":"com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.compatibilityKey","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/compatibility-key.html","searchKeys":["compatibilityKey","open override val compatibilityKey: String","com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.compatibilityKey"]},{"name":"open override val content: C","description":"com.squareup.workflow1.ui.EnvironmentScreen.content","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-environment-screen/content.html","searchKeys":["content","open override val content: C","com.squareup.workflow1.ui.EnvironmentScreen.content"]},{"name":"open override val content: C","description":"com.squareup.workflow1.ui.NamedScreen.content","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-named-screen/content.html","searchKeys":["content","open override val content: C","com.squareup.workflow1.ui.NamedScreen.content"]},{"name":"open override val content: C","description":"com.squareup.workflow1.ui.navigation.FullScreenModal.content","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-full-screen-modal/content.html","searchKeys":["content","open override val content: C","com.squareup.workflow1.ui.navigation.FullScreenModal.content"]},{"name":"open override val default: BackStackConfig","description":"com.squareup.workflow1.ui.navigation.BackStackConfig.Companion.default","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-config/-companion/default.html","searchKeys":["default","open override val default: BackStackConfig","com.squareup.workflow1.ui.navigation.BackStackConfig.Companion.default"]},{"name":"open override val default: ViewRegistry","description":"com.squareup.workflow1.ui.ViewRegistry.Companion.default","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-companion/default.html","searchKeys":["default","open override val default: ViewRegistry","com.squareup.workflow1.ui.ViewRegistry.Companion.default"]},{"name":"operator fun get(key: ViewEnvironmentKey): T","description":"com.squareup.workflow1.ui.ViewEnvironment.get","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/get.html","searchKeys":["get","operator fun get(key: ViewEnvironmentKey): T","com.squareup.workflow1.ui.ViewEnvironment.get"]},{"name":"operator fun plus(pair: Pair, T>): ViewEnvironment","description":"com.squareup.workflow1.ui.ViewEnvironment.plus","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/plus.html","searchKeys":["plus","operator fun plus(pair: Pair, T>): ViewEnvironment","com.squareup.workflow1.ui.ViewEnvironment.plus"]},{"name":"operator fun BackStackScreen.plus(other: BackStackScreen?): BackStackScreen","description":"com.squareup.workflow1.ui.navigation.plus","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/plus.html","searchKeys":["plus","operator fun BackStackScreen.plus(other: BackStackScreen?): BackStackScreen","com.squareup.workflow1.ui.navigation.plus"]},{"name":"operator fun ViewEnvironment.plus(config: BackStackConfig): ViewEnvironment","description":"com.squareup.workflow1.ui.navigation.plus","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/plus.html","searchKeys":["plus","operator fun ViewEnvironment.plus(config: BackStackConfig): ViewEnvironment","com.squareup.workflow1.ui.navigation.plus"]},{"name":"operator fun ViewEnvironment.plus(registry: ViewRegistry): ViewEnvironment","description":"com.squareup.workflow1.ui.plus","location":"workflow-ui/core-common/com.squareup.workflow1.ui/plus.html","searchKeys":["plus","operator fun ViewEnvironment.plus(registry: ViewRegistry): ViewEnvironment","com.squareup.workflow1.ui.plus"]},{"name":"operator fun ViewRegistry.plus(entry: ViewRegistry.Entry<*>): ViewRegistry","description":"com.squareup.workflow1.ui.plus","location":"workflow-ui/core-common/com.squareup.workflow1.ui/plus.html","searchKeys":["plus","operator fun ViewRegistry.plus(entry: ViewRegistry.Entry<*>): ViewRegistry","com.squareup.workflow1.ui.plus"]},{"name":"operator fun ViewRegistry.plus(other: ViewRegistry): ViewRegistry","description":"com.squareup.workflow1.ui.plus","location":"workflow-ui/core-common/com.squareup.workflow1.ui/plus.html","searchKeys":["plus","operator fun ViewRegistry.plus(other: ViewRegistry): ViewRegistry","com.squareup.workflow1.ui.plus"]},{"name":"operator fun get(index: Int): StackedT","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.get","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/get.html","searchKeys":["get","operator fun get(index: Int): StackedT","com.squareup.workflow1.ui.navigation.BackStackScreen.get"]},{"name":"operator fun plus(other: ViewEnvironment): ViewEnvironment","description":"com.squareup.workflow1.ui.ViewEnvironment.plus","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/plus.html","searchKeys":["plus","operator fun plus(other: ViewEnvironment): ViewEnvironment","com.squareup.workflow1.ui.ViewEnvironment.plus"]},{"name":"operator override fun equals(other: Any?): Boolean","description":"com.squareup.workflow1.ui.ViewEnvironmentKey.equals","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment-key/equals.html","searchKeys":["equals","operator override fun equals(other: Any?): Boolean","com.squareup.workflow1.ui.ViewEnvironmentKey.equals"]},{"name":"override fun hashCode(): Int","description":"com.squareup.workflow1.ui.ViewEnvironmentKey.hashCode","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment-key/hash-code.html","searchKeys":["hashCode","override fun hashCode(): Int","com.squareup.workflow1.ui.ViewEnvironmentKey.hashCode"]},{"name":"sealed class Event","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Event","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-event/index.html","searchKeys":["Event","sealed class Event","com.squareup.workflow1.ui.navigation.AlertOverlay.Event"]},{"name":"val EMPTY: ViewEnvironment","description":"com.squareup.workflow1.ui.ViewEnvironment.Companion.EMPTY","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/-companion/-e-m-p-t-y.html","searchKeys":["EMPTY","val EMPTY: ViewEnvironment","com.squareup.workflow1.ui.ViewEnvironment.Companion.EMPTY"]},{"name":"val backStack: List","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.backStack","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/back-stack.html","searchKeys":["backStack","val backStack: List","com.squareup.workflow1.ui.navigation.BackStackScreen.backStack"]},{"name":"val body: B","description":"com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.body","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/body.html","searchKeys":["body","val body: B","com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.body"]},{"name":"val button: AlertOverlay.Button","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Event.ButtonClicked.button","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-event/-button-clicked/button.html","searchKeys":["button","val button: AlertOverlay.Button","com.squareup.workflow1.ui.navigation.AlertOverlay.Event.ButtonClicked.button"]},{"name":"val buttons: Map","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.buttons","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/buttons.html","searchKeys":["buttons","val buttons: Map","com.squareup.workflow1.ui.navigation.AlertOverlay.buttons"]},{"name":"val cancelable: Boolean = true","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.cancelable","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/cancelable.html","searchKeys":["cancelable","val cancelable: Boolean = true","com.squareup.workflow1.ui.navigation.AlertOverlay.cancelable"]},{"name":"val entries: EnumEntries","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.Button.entries","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/-button/entries.html","searchKeys":["entries","val entries: EnumEntries","com.squareup.workflow1.ui.navigation.AlertOverlay.Button.entries"]},{"name":"val entries: EnumEntries","description":"com.squareup.workflow1.ui.navigation.BackStackConfig.entries","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-config/entries.html","searchKeys":["entries","val entries: EnumEntries","com.squareup.workflow1.ui.navigation.BackStackConfig.entries"]},{"name":"val environment: ViewEnvironment","description":"com.squareup.workflow1.ui.EnvironmentScreen.environment","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-environment-screen/environment.html","searchKeys":["environment","val environment: ViewEnvironment","com.squareup.workflow1.ui.EnvironmentScreen.environment"]},{"name":"val factoryType: KClass","description":"com.squareup.workflow1.ui.ViewRegistry.Key.factoryType","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/factory-type.html","searchKeys":["factoryType","val factoryType: KClass","com.squareup.workflow1.ui.ViewRegistry.Key.factoryType"]},{"name":"val frames: List","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.frames","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/frames.html","searchKeys":["frames","val frames: List","com.squareup.workflow1.ui.navigation.BackStackScreen.frames"]},{"name":"val map: Map, Any>","description":"com.squareup.workflow1.ui.ViewEnvironment.map","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/map.html","searchKeys":["map","val map: Map, Any>","com.squareup.workflow1.ui.ViewEnvironment.map"]},{"name":"val message: String","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.message","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/message.html","searchKeys":["message","val message: String","com.squareup.workflow1.ui.navigation.AlertOverlay.message"]},{"name":"val name: String","description":"com.squareup.workflow1.ui.NamedScreen.name","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-named-screen/name.html","searchKeys":["name","val name: String","com.squareup.workflow1.ui.NamedScreen.name"]},{"name":"val name: String","description":"com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.name","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/name.html","searchKeys":["name","val name: String","com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.name"]},{"name":"val onEvent: (AlertOverlay.Event) -> Unit","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.onEvent","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/on-event.html","searchKeys":["onEvent","val onEvent: (AlertOverlay.Event) -> Unit","com.squareup.workflow1.ui.navigation.AlertOverlay.onEvent"]},{"name":"val overlays: List","description":"com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.overlays","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/overlays.html","searchKeys":["overlays","val overlays: List","com.squareup.workflow1.ui.navigation.BodyAndOverlaysScreen.overlays"]},{"name":"val renderingType: KClass","description":"com.squareup.workflow1.ui.ViewRegistry.Key.renderingType","location":"workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/rendering-type.html","searchKeys":["renderingType","val renderingType: KClass","com.squareup.workflow1.ui.ViewRegistry.Key.renderingType"]},{"name":"val title: String","description":"com.squareup.workflow1.ui.navigation.AlertOverlay.title","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-alert-overlay/title.html","searchKeys":["title","val title: String","com.squareup.workflow1.ui.navigation.AlertOverlay.title"]},{"name":"val top: StackedT","description":"com.squareup.workflow1.ui.navigation.BackStackScreen.top","location":"workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/top.html","searchKeys":["top","val top: StackedT","com.squareup.workflow1.ui.navigation.BackStackScreen.top"]},{"name":"abstract fun buildDialog(initialRendering: OverlayT, initialEnvironment: ViewEnvironment, context: Context): OverlayDialogHolder","description":"com.squareup.workflow1.ui.navigation.OverlayDialogFactory.buildDialog","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/build-dialog.html","searchKeys":["buildDialog","abstract fun buildDialog(initialRendering: OverlayT, initialEnvironment: ViewEnvironment, context: Context): OverlayDialogHolder","com.squareup.workflow1.ui.navigation.OverlayDialogFactory.buildDialog"]},{"name":"abstract fun buildView(initialRendering: ScreenT, initialEnvironment: ViewEnvironment, context: Context, container: ViewGroup? = null): ScreenViewHolder","description":"com.squareup.workflow1.ui.ScreenViewFactory.buildView","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/build-view.html","searchKeys":["buildView","abstract fun buildView(initialRendering: ScreenT, initialEnvironment: ViewEnvironment, context: Context, container: ViewGroup? = null): ScreenViewHolder","com.squareup.workflow1.ui.ScreenViewFactory.buildView"]},{"name":"abstract fun destroyOnDetach()","description":"com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner.destroyOnDetach","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-lifecycle-owner/destroy-on-detach.html","searchKeys":["destroyOnDetach","abstract fun destroyOnDetach()","com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner.destroyOnDetach"]},{"name":"abstract fun showRendering(rendering: ScreenT, environment: ViewEnvironment)","description":"com.squareup.workflow1.ui.ScreenViewRunner.showRendering","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-runner/show-rendering.html","searchKeys":["showRendering","abstract fun showRendering(rendering: ScreenT, environment: ViewEnvironment)","com.squareup.workflow1.ui.ScreenViewRunner.showRendering"]},{"name":"abstract fun startView(view: View, doStart: () -> Unit)","description":"com.squareup.workflow1.ui.ViewStarter.startView","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-view-starter/start-view.html","searchKeys":["startView","abstract fun startView(view: View, doStart: () -> Unit)","com.squareup.workflow1.ui.ViewStarter.startView"]},{"name":"abstract val dialog: Dialog","description":"com.squareup.workflow1.ui.navigation.OverlayDialogHolder.dialog","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-holder/dialog.html","searchKeys":["dialog","abstract val dialog: Dialog","com.squareup.workflow1.ui.navigation.OverlayDialogHolder.dialog"]},{"name":"abstract val dialogFactory: OverlayDialogFactory","description":"com.squareup.workflow1.ui.navigation.AndroidOverlay.dialogFactory","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-android-overlay/dialog-factory.html","searchKeys":["dialogFactory","abstract val dialogFactory: OverlayDialogFactory","com.squareup.workflow1.ui.navigation.AndroidOverlay.dialogFactory"]},{"name":"abstract val environment: ViewEnvironment","description":"com.squareup.workflow1.ui.ScreenViewHolder.environment","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-holder/environment.html","searchKeys":["environment","abstract val environment: ViewEnvironment","com.squareup.workflow1.ui.ScreenViewHolder.environment"]},{"name":"abstract val environment: ViewEnvironment","description":"com.squareup.workflow1.ui.navigation.OverlayDialogHolder.environment","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-holder/environment.html","searchKeys":["environment","abstract val environment: ViewEnvironment","com.squareup.workflow1.ui.navigation.OverlayDialogHolder.environment"]},{"name":"abstract val onUpdateBounds: (Rect) -> Unit?","description":"com.squareup.workflow1.ui.navigation.OverlayDialogHolder.onUpdateBounds","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-holder/on-update-bounds.html","searchKeys":["onUpdateBounds","abstract val onUpdateBounds: (Rect) -> Unit?","com.squareup.workflow1.ui.navigation.OverlayDialogHolder.onUpdateBounds"]},{"name":"abstract val runner: (rendering: OverlayT, environment: ViewEnvironment) -> Unit","description":"com.squareup.workflow1.ui.navigation.OverlayDialogHolder.runner","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-holder/runner.html","searchKeys":["runner","abstract val runner: (rendering: OverlayT, environment: ViewEnvironment) -> Unit","com.squareup.workflow1.ui.navigation.OverlayDialogHolder.runner"]},{"name":"abstract val runner: ScreenViewRunner","description":"com.squareup.workflow1.ui.ScreenViewHolder.runner","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-holder/runner.html","searchKeys":["runner","abstract val runner: ScreenViewRunner","com.squareup.workflow1.ui.ScreenViewHolder.runner"]},{"name":"abstract val type: KClass","description":"com.squareup.workflow1.ui.navigation.OverlayDialogFactory.type","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/type.html","searchKeys":["type","abstract val type: KClass","com.squareup.workflow1.ui.navigation.OverlayDialogFactory.type"]},{"name":"abstract val type: KClass","description":"com.squareup.workflow1.ui.ScreenViewFactory.type","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/type.html","searchKeys":["type","abstract val type: KClass","com.squareup.workflow1.ui.ScreenViewFactory.type"]},{"name":"abstract val view: View","description":"com.squareup.workflow1.ui.ScreenViewHolder.view","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-holder/view.html","searchKeys":["view","abstract val view: View","com.squareup.workflow1.ui.ScreenViewHolder.view"]},{"name":"abstract val viewFactory: ScreenViewFactory","description":"com.squareup.workflow1.ui.AndroidScreen.viewFactory","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-android-screen/view-factory.html","searchKeys":["viewFactory","abstract val viewFactory: ScreenViewFactory","com.squareup.workflow1.ui.AndroidScreen.viewFactory"]},{"name":"class BackButtonScreen(val content: C, val shadow: Boolean = false, val onBackPressed: () -> Unit? = null) : Wrapper , AndroidScreen> ","description":"com.squareup.workflow1.ui.navigation.BackButtonScreen","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-button-screen/index.html","searchKeys":["BackButtonScreen","class BackButtonScreen(val content: C, val shadow: Boolean = false, val onBackPressed: () -> Unit? = null) : Wrapper , AndroidScreen> ","com.squareup.workflow1.ui.navigation.BackButtonScreen"]},{"name":"class LayeredDialogSessions","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/index.html","searchKeys":["LayeredDialogSessions","class LayeredDialogSessions","com.squareup.workflow1.ui.navigation.LayeredDialogSessions"]},{"name":"class ParcelableTextController : TextController, Parcelable","description":"com.squareup.workflow1.ui.ParcelableTextController","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-parcelable-text-controller/index.html","searchKeys":["ParcelableTextController","class ParcelableTextController : TextController, Parcelable","com.squareup.workflow1.ui.ParcelableTextController"]},{"name":"class Saved : Parcelable","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.Saved","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/-saved/index.html","searchKeys":["Saved","class Saved : Parcelable","com.squareup.workflow1.ui.navigation.ViewStateCache.Saved"]},{"name":"class SavedState : Parcelable","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/-saved-state/index.html","searchKeys":["SavedState","class SavedState : Parcelable","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState"]},{"name":"class SavedState : View.BaseSavedState","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/-saved-state/index.html","searchKeys":["SavedState","class SavedState : View.BaseSavedState","com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState"]},{"name":"class ViewStateCache","description":"com.squareup.workflow1.ui.navigation.ViewStateCache","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/index.html","searchKeys":["ViewStateCache","class ViewStateCache","com.squareup.workflow1.ui.navigation.ViewStateCache"]},{"name":"class WorkflowLayout(context: Context, attributeSet: AttributeSet? = null) : FrameLayout","description":"com.squareup.workflow1.ui.WorkflowLayout","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-layout/index.html","searchKeys":["WorkflowLayout","class WorkflowLayout(context: Context, attributeSet: AttributeSet? = null) : FrameLayout","com.squareup.workflow1.ui.WorkflowLayout"]},{"name":"class WorkflowSavedStateRegistryAggregator","description":"com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-saved-state-registry-aggregator/index.html","searchKeys":["WorkflowSavedStateRegistryAggregator","class WorkflowSavedStateRegistryAggregator","com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator"]},{"name":"class WorkflowViewStub constructor(context: Context, attributeSet: AttributeSet? = null, defStyle: Int = 0, defStyleRes: Int = 0) : View","description":"com.squareup.workflow1.ui.WorkflowViewStub","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/index.html","searchKeys":["WorkflowViewStub","class WorkflowViewStub constructor(context: Context, attributeSet: AttributeSet? = null, defStyle: Int = 0, defStyleRes: Int = 0) : View","com.squareup.workflow1.ui.WorkflowViewStub"]},{"name":"constructor()","description":"com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.WorkflowSavedStateRegistryAggregator","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-saved-state-registry-aggregator/-workflow-saved-state-registry-aggregator.html","searchKeys":["WorkflowSavedStateRegistryAggregator","constructor()","com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.WorkflowSavedStateRegistryAggregator"]},{"name":"constructor()","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.ViewStateCache","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/-view-state-cache.html","searchKeys":["ViewStateCache","constructor()","com.squareup.workflow1.ui.navigation.ViewStateCache.ViewStateCache"]},{"name":"constructor(content: C, shadow: Boolean = false, onBackPressed: () -> Unit? = null)","description":"com.squareup.workflow1.ui.navigation.BackButtonScreen.BackButtonScreen","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-button-screen/-back-button-screen.html","searchKeys":["BackButtonScreen","constructor(content: C, shadow: Boolean = false, onBackPressed: () -> Unit? = null)","com.squareup.workflow1.ui.navigation.BackButtonScreen.BackButtonScreen"]},{"name":"constructor(context: Context, attributeSet: AttributeSet? = null)","description":"com.squareup.workflow1.ui.WorkflowLayout.WorkflowLayout","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-layout/-workflow-layout.html","searchKeys":["WorkflowLayout","constructor(context: Context, attributeSet: AttributeSet? = null)","com.squareup.workflow1.ui.WorkflowLayout.WorkflowLayout"]},{"name":"constructor(context: Context, attributeSet: AttributeSet? = null, defStyle: Int = 0, defStyleRes: Int = 0)","description":"com.squareup.workflow1.ui.WorkflowViewStub.WorkflowViewStub","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/-workflow-view-stub.html","searchKeys":["WorkflowViewStub","constructor(context: Context, attributeSet: AttributeSet? = null, defStyle: Int = 0, defStyleRes: Int = 0)","com.squareup.workflow1.ui.WorkflowViewStub.WorkflowViewStub"]},{"name":"constructor(context: Context, attributeSet: AttributeSet? = null, defStyle: Int = 0, defStyleRes: Int = 0)","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.BackStackContainer","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/-back-stack-container.html","searchKeys":["BackStackContainer","constructor(context: Context, attributeSet: AttributeSet? = null, defStyle: Int = 0, defStyleRes: Int = 0)","com.squareup.workflow1.ui.navigation.BackStackContainer.BackStackContainer"]},{"name":"constructor(initialValue: String = \"\")","description":"com.squareup.workflow1.ui.ParcelableTextController.ParcelableTextController","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-parcelable-text-controller/-parcelable-text-controller.html","searchKeys":["ParcelableTextController","constructor(initialValue: String = \"\")","com.squareup.workflow1.ui.ParcelableTextController.ParcelableTextController"]},{"name":"constructor(source: Parcel)","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.SavedState","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/-saved-state/-saved-state.html","searchKeys":["SavedState","constructor(source: Parcel)","com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.SavedState"]},{"name":"constructor(source: Parcel)","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.SavedState","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/-saved-state/-saved-state.html","searchKeys":["SavedState","constructor(source: Parcel)","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.SavedState"]},{"name":"constructor(source: Parcel)","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.Saved","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/-saved/-saved.html","searchKeys":["Saved","constructor(source: Parcel)","com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.Saved"]},{"name":"constructor(superState: Parcelable, savedViewState: ViewStateCache.Saved)","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.SavedState","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/-saved-state/-saved-state.html","searchKeys":["SavedState","constructor(superState: Parcelable, savedViewState: ViewStateCache.Saved)","com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.SavedState"]},{"name":"fun > ComponentDialog.asDialogHolderWithContent(overlay: O, environment: ViewEnvironment, setContent: (ScreenViewHolder) -> Unit = { contentViewHolder ->\n setContentView(contentViewHolder.view)\n fixBackgroundAndDimming()\n }): OverlayDialogHolder","description":"com.squareup.workflow1.ui.navigation.asDialogHolderWithContent","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/as-dialog-holder-with-content.html","searchKeys":["asDialogHolderWithContent","fun > ComponentDialog.asDialogHolderWithContent(overlay: O, environment: ViewEnvironment, setContent: (ScreenViewHolder) -> Unit = { contentViewHolder ->\n setContentView(contentViewHolder.view)\n fixBackgroundAndDimming()\n }): OverlayDialogHolder","com.squareup.workflow1.ui.navigation.asDialogHolderWithContent"]},{"name":"fun renderWorkflowIn(workflow: Workflow, scope: CoroutineScope, savedStateHandle: SavedStateHandle? = null, interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}): StateFlow","description":"com.squareup.workflow1.ui.renderWorkflowIn","location":"workflow-ui/core-android/com.squareup.workflow1.ui/render-workflow-in.html","searchKeys":["renderWorkflowIn","fun renderWorkflowIn(workflow: Workflow, scope: CoroutineScope, savedStateHandle: SavedStateHandle? = null, interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}): StateFlow","com.squareup.workflow1.ui.renderWorkflowIn"]},{"name":"fun OverlayDialogHolder.show(overlay: OverlayT, environment: ViewEnvironment)","description":"com.squareup.workflow1.ui.navigation.show","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/show.html","searchKeys":["show","fun OverlayDialogHolder.show(overlay: OverlayT, environment: ViewEnvironment)","com.squareup.workflow1.ui.navigation.show"]},{"name":"fun renderWorkflowIn(workflow: Workflow, scope: CoroutineScope, prop: PropsT, savedStateHandle: SavedStateHandle? = null, interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}): StateFlow","description":"com.squareup.workflow1.ui.renderWorkflowIn","location":"workflow-ui/core-android/com.squareup.workflow1.ui/render-workflow-in.html","searchKeys":["renderWorkflowIn","fun renderWorkflowIn(workflow: Workflow, scope: CoroutineScope, prop: PropsT, savedStateHandle: SavedStateHandle? = null, interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}): StateFlow","com.squareup.workflow1.ui.renderWorkflowIn"]},{"name":"fun renderWorkflowIn(workflow: Workflow, scope: CoroutineScope, props: StateFlow, savedStateHandle: SavedStateHandle? = null, interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}): StateFlow","description":"com.squareup.workflow1.ui.renderWorkflowIn","location":"workflow-ui/core-android/com.squareup.workflow1.ui/render-workflow-in.html","searchKeys":["renderWorkflowIn","fun renderWorkflowIn(workflow: Workflow, scope: CoroutineScope, props: StateFlow, savedStateHandle: SavedStateHandle? = null, interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}): StateFlow","com.squareup.workflow1.ui.renderWorkflowIn"]},{"name":"fun ScreenT.toViewFactory(environment: ViewEnvironment): ScreenViewFactory","description":"com.squareup.workflow1.ui.toViewFactory","location":"workflow-ui/core-android/com.squareup.workflow1.ui/to-view-factory.html","searchKeys":["toViewFactory","fun ScreenT.toViewFactory(environment: ViewEnvironment): ScreenViewFactory","com.squareup.workflow1.ui.toViewFactory"]},{"name":"fun ScreenViewFactory.startShowing(initialRendering: ScreenT, initialEnvironment: ViewEnvironment, contextForNewView: Context, container: ViewGroup? = null, viewStarter: ViewStarter? = null): ScreenViewHolder","description":"com.squareup.workflow1.ui.startShowing","location":"workflow-ui/core-android/com.squareup.workflow1.ui/start-showing.html","searchKeys":["startShowing","fun ScreenViewFactory.startShowing(initialRendering: ScreenT, initialEnvironment: ViewEnvironment, contextForNewView: Context, container: ViewGroup? = null, viewStarter: ViewStarter? = null): ScreenViewHolder","com.squareup.workflow1.ui.startShowing"]},{"name":"fun ScreenViewFactoryFinder.requireViewFactoryForRendering(environment: ViewEnvironment, rendering: ScreenT): ScreenViewFactory","description":"com.squareup.workflow1.ui.requireViewFactoryForRendering","location":"workflow-ui/core-android/com.squareup.workflow1.ui/require-view-factory-for-rendering.html","searchKeys":["requireViewFactoryForRendering","fun ScreenViewFactoryFinder.requireViewFactoryForRendering(environment: ViewEnvironment, rendering: ScreenT): ScreenViewFactory","com.squareup.workflow1.ui.requireViewFactoryForRendering"]},{"name":"fun ScreenViewHolder.show(screen: ScreenT, environment: ViewEnvironment)","description":"com.squareup.workflow1.ui.show","location":"workflow-ui/core-android/com.squareup.workflow1.ui/show.html","searchKeys":["show","fun ScreenViewHolder.show(screen: ScreenT, environment: ViewEnvironment)","com.squareup.workflow1.ui.show"]},{"name":"fun ScreenViewHolder.startShowing(initialRendering: ScreenT, initialEnvironment: ViewEnvironment, viewStarter: ViewStarter?)","description":"com.squareup.workflow1.ui.startShowing","location":"workflow-ui/core-android/com.squareup.workflow1.ui/start-showing.html","searchKeys":["startShowing","fun ScreenViewHolder.startShowing(initialRendering: ScreenT, initialEnvironment: ViewEnvironment, viewStarter: ViewStarter?)","com.squareup.workflow1.ui.startShowing"]},{"name":"fun T.toDialogFactory(environment: ViewEnvironment): OverlayDialogFactory","description":"com.squareup.workflow1.ui.navigation.toDialogFactory","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/to-dialog-factory.html","searchKeys":["toDialogFactory","fun T.toDialogFactory(environment: ViewEnvironment): OverlayDialogFactory","com.squareup.workflow1.ui.navigation.toDialogFactory"]},{"name":"fun AlertDialog.toDialogHolder(initialEnvironment: ViewEnvironment): OverlayDialogHolder","description":"com.squareup.workflow1.ui.navigation.toDialogHolder","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/to-dialog-holder.html","searchKeys":["toDialogHolder","fun AlertDialog.toDialogHolder(initialEnvironment: ViewEnvironment): OverlayDialogHolder","com.squareup.workflow1.ui.navigation.toDialogHolder"]},{"name":"fun Dialog.fixBackgroundAndDimming()","description":"com.squareup.workflow1.ui.navigation.fixBackgroundAndDimming","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/fix-background-and-dimming.html","searchKeys":["fixBackgroundAndDimming","fun Dialog.fixBackgroundAndDimming()","com.squareup.workflow1.ui.navigation.fixBackgroundAndDimming"]},{"name":"fun Dialog.setBounds(bounds: Rect)","description":"com.squareup.workflow1.ui.navigation.setBounds","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/set-bounds.html","searchKeys":["setBounds","fun Dialog.setBounds(bounds: Rect)","com.squareup.workflow1.ui.navigation.setBounds"]},{"name":"fun OverlayDialogHolder<*>.canShow(overlay: Overlay): Boolean","description":"com.squareup.workflow1.ui.navigation.canShow","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/can-show.html","searchKeys":["canShow","fun OverlayDialogHolder<*>.canShow(overlay: Overlay): Boolean","com.squareup.workflow1.ui.navigation.canShow"]},{"name":"fun Parcelable.toSnapshot(): Snapshot","description":"com.squareup.workflow1.ui.toSnapshot","location":"workflow-ui/core-android/com.squareup.workflow1.ui/to-snapshot.html","searchKeys":["toSnapshot","fun Parcelable.toSnapshot(): Snapshot","com.squareup.workflow1.ui.toSnapshot"]},{"name":"fun ScreenViewHolder<*>.canShow(screen: Screen): Boolean","description":"com.squareup.workflow1.ui.canShow","location":"workflow-ui/core-android/com.squareup.workflow1.ui/can-show.html","searchKeys":["canShow","fun ScreenViewHolder<*>.canShow(screen: Screen): Boolean","com.squareup.workflow1.ui.canShow"]},{"name":"fun TextController.control(view: EditText)","description":"com.squareup.workflow1.ui.control","location":"workflow-ui/core-android/com.squareup.workflow1.ui/control.html","searchKeys":["control","fun TextController.control(view: EditText)","com.squareup.workflow1.ui.control"]},{"name":"fun View.getScreenRect(rect: Rect)","description":"com.squareup.workflow1.ui.navigation.getScreenRect","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/get-screen-rect.html","searchKeys":["getScreenRect","fun View.getScreenRect(rect: Rect)","com.squareup.workflow1.ui.navigation.getScreenRect"]},{"name":"fun View.onBackPressedDispatcherOwnerOrNull(): OnBackPressedDispatcherOwner?","description":"com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.onBackPressedDispatcherOwnerOrNull","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-android-x-support/on-back-pressed-dispatcher-owner-or-null.html","searchKeys":["onBackPressedDispatcherOwnerOrNull","fun View.onBackPressedDispatcherOwnerOrNull(): OnBackPressedDispatcherOwner?","com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.onBackPressedDispatcherOwnerOrNull"]},{"name":"fun View.setBackHandler(enabled: Boolean = true, onBack: () -> Unit)","description":"com.squareup.workflow1.ui.navigation.setBackHandler","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/set-back-handler.html","searchKeys":["setBackHandler","fun View.setBackHandler(enabled: Boolean = true, onBack: () -> Unit)","com.squareup.workflow1.ui.navigation.setBackHandler"]},{"name":"fun View.setBackHandler(onBack: () -> Unit?)","description":"com.squareup.workflow1.ui.navigation.setBackHandler","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/set-back-handler.html","searchKeys":["setBackHandler","fun View.setBackHandler(onBack: () -> Unit?)","com.squareup.workflow1.ui.navigation.setBackHandler"]},{"name":"fun ViewEnvironment.onBackPressedDispatcherOwner(container: View): OnBackPressedDispatcherOwner","description":"com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.onBackPressedDispatcherOwner","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-android-x-support/on-back-pressed-dispatcher-owner.html","searchKeys":["onBackPressedDispatcherOwner","fun ViewEnvironment.onBackPressedDispatcherOwner(container: View): OnBackPressedDispatcherOwner","com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.onBackPressedDispatcherOwner"]},{"name":"fun attachToParentRegistry(key: String, parentOwner: SavedStateRegistryOwner)","description":"com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.attachToParentRegistry","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-saved-state-registry-aggregator/attach-to-parent-registry.html","searchKeys":["attachToParentRegistry","fun attachToParentRegistry(key: String, parentOwner: SavedStateRegistryOwner)","com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.attachToParentRegistry"]},{"name":"fun attachToParentRegistryOwner(key: String, parentOwner: SavedStateRegistryOwner)","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.attachToParentRegistryOwner","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/attach-to-parent-registry-owner.html","searchKeys":["attachToParentRegistryOwner","fun attachToParentRegistryOwner(key: String, parentOwner: SavedStateRegistryOwner)","com.squareup.workflow1.ui.navigation.ViewStateCache.attachToParentRegistryOwner"]},{"name":"fun detachFromParentRegistry()","description":"com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.detachFromParentRegistry","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-saved-state-registry-aggregator/detach-from-parent-registry.html","searchKeys":["detachFromParentRegistry","fun detachFromParentRegistry()","com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.detachFromParentRegistry"]},{"name":"fun detachFromParentRegistry()","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.detachFromParentRegistry","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/detach-from-parent-registry.html","searchKeys":["detachFromParentRegistry","fun detachFromParentRegistry()","com.squareup.workflow1.ui.navigation.ViewStateCache.detachFromParentRegistry"]},{"name":"fun forView(view: View, superDispatchTouchEvent: (MotionEvent) -> Unit): LayeredDialogSessions","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.Companion.forView","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/-companion/for-view.html","searchKeys":["forView","fun forView(view: View, superDispatchTouchEvent: (MotionEvent) -> Unit): LayeredDialogSessions","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.Companion.forView"]},{"name":"fun get(view: View): WorkflowLifecycleOwner?","description":"com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner.Companion.get","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-lifecycle-owner/-companion/get.html","searchKeys":["get","fun get(view: View): WorkflowLifecycleOwner?","com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner.Companion.get"]},{"name":"fun installChildRegistryOwnerOn(view: View, key: String, force: Boolean = false)","description":"com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.installChildRegistryOwnerOn","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-saved-state-registry-aggregator/install-child-registry-owner-on.html","searchKeys":["installChildRegistryOwnerOn","fun installChildRegistryOwnerOn(view: View, key: String, force: Boolean = false)","com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.installChildRegistryOwnerOn"]},{"name":"fun installOn(view: View, onBackPressedDispatcherOwner: OnBackPressedDispatcherOwner, findParentLifecycle: (View) -> Lifecycle = this::findParentViewTreeLifecycle)","description":"com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner.Companion.installOn","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-lifecycle-owner/-companion/install-on.html","searchKeys":["installOn","fun installOn(view: View, onBackPressedDispatcherOwner: OnBackPressedDispatcherOwner, findParentLifecycle: (View) -> Lifecycle = this::findParentViewTreeLifecycle)","com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner.Companion.installOn"]},{"name":"fun interface ScreenViewRunner","description":"com.squareup.workflow1.ui.ScreenViewRunner","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-runner/index.html","searchKeys":["ScreenViewRunner","fun interface ScreenViewRunner","com.squareup.workflow1.ui.ScreenViewRunner"]},{"name":"fun interface ViewStarter","description":"com.squareup.workflow1.ui.ViewStarter","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-view-starter/index.html","searchKeys":["ViewStarter","fun interface ViewStarter","com.squareup.workflow1.ui.ViewStarter"]},{"name":"fun lifecycleOwnerFromContext(context: Context): LifecycleOwner","description":"com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.lifecycleOwnerFromContext","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-android-x-support/lifecycle-owner-from-context.html","searchKeys":["lifecycleOwnerFromContext","fun lifecycleOwnerFromContext(context: Context): LifecycleOwner","com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.lifecycleOwnerFromContext"]},{"name":"fun lifecycleOwnerFromViewTreeOrContextOrNull(view: View): LifecycleOwner?","description":"com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.lifecycleOwnerFromViewTreeOrContextOrNull","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-android-x-support/lifecycle-owner-from-view-tree-or-context-or-null.html","searchKeys":["lifecycleOwnerFromViewTreeOrContextOrNull","fun lifecycleOwnerFromViewTreeOrContextOrNull(view: View): LifecycleOwner?","com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.lifecycleOwnerFromViewTreeOrContextOrNull"]},{"name":"fun onAttachedToWindow(savedStateParentKey: String, view: View)","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.onAttachedToWindow","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/on-attached-to-window.html","searchKeys":["onAttachedToWindow","fun onAttachedToWindow(savedStateParentKey: String, view: View)","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.onAttachedToWindow"]},{"name":"fun onDetachedFromWindow()","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.onDetachedFromWindow","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/on-detached-from-window.html","searchKeys":["onDetachedFromWindow","fun onDetachedFromWindow()","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.onDetachedFromWindow"]},{"name":"fun onRestoreInstanceState(state: LayeredDialogSessions.SavedState)","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.onRestoreInstanceState","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/on-restore-instance-state.html","searchKeys":["onRestoreInstanceState","fun onRestoreInstanceState(state: LayeredDialogSessions.SavedState)","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.onRestoreInstanceState"]},{"name":"fun onSaveInstanceState(): LayeredDialogSessions.SavedState","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.onSaveInstanceState","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/on-save-instance-state.html","searchKeys":["onSaveInstanceState","fun onSaveInstanceState(): LayeredDialogSessions.SavedState","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.onSaveInstanceState"]},{"name":"fun prune(retaining: Collection>)","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.prune","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/prune.html","searchKeys":["prune","fun prune(retaining: Collection>)","com.squareup.workflow1.ui.navigation.ViewStateCache.prune"]},{"name":"fun pruneAllChildRegistryOwnersExcept(keysToKeep: Collection = emptyList())","description":"com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.pruneAllChildRegistryOwnersExcept","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-saved-state-registry-aggregator/prune-all-child-registry-owners-except.html","searchKeys":["pruneAllChildRegistryOwnersExcept","fun pruneAllChildRegistryOwnersExcept(keysToKeep: Collection = emptyList())","com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.pruneAllChildRegistryOwnersExcept"]},{"name":"fun restore(from: ViewStateCache.Saved)","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.restore","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/restore.html","searchKeys":["restore","fun restore(from: ViewStateCache.Saved)","com.squareup.workflow1.ui.navigation.ViewStateCache.restore"]},{"name":"fun save(): ViewStateCache.Saved","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.save","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/save.html","searchKeys":["save","fun save(): ViewStateCache.Saved","com.squareup.workflow1.ui.navigation.ViewStateCache.save"]},{"name":"fun saveAndPruneChildRegistryOwner(key: String)","description":"com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.saveAndPruneChildRegistryOwner","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-saved-state-registry-aggregator/save-and-prune-child-registry-owner.html","searchKeys":["saveAndPruneChildRegistryOwner","fun saveAndPruneChildRegistryOwner(key: String)","com.squareup.workflow1.ui.androidx.WorkflowSavedStateRegistryAggregator.saveAndPruneChildRegistryOwner"]},{"name":"fun show(rendering: Screen, viewEnvironment: ViewEnvironment)","description":"com.squareup.workflow1.ui.WorkflowViewStub.show","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/show.html","searchKeys":["show","fun show(rendering: Screen, viewEnvironment: ViewEnvironment)","com.squareup.workflow1.ui.WorkflowViewStub.show"]},{"name":"fun show(rootScreen: Screen, environment: ViewEnvironment = ViewEnvironment.EMPTY)","description":"com.squareup.workflow1.ui.WorkflowLayout.show","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-layout/show.html","searchKeys":["show","fun show(rootScreen: Screen, environment: ViewEnvironment = ViewEnvironment.EMPTY)","com.squareup.workflow1.ui.WorkflowLayout.show"]},{"name":"fun stateRegistryOwnerFromViewTreeOrContext(view: View): SavedStateRegistryOwner","description":"com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.stateRegistryOwnerFromViewTreeOrContext","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-android-x-support/state-registry-owner-from-view-tree-or-context.html","searchKeys":["stateRegistryOwnerFromViewTreeOrContext","fun stateRegistryOwnerFromViewTreeOrContext(view: View): SavedStateRegistryOwner","com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport.stateRegistryOwnerFromViewTreeOrContext"]},{"name":"fun take(lifecycle: Lifecycle, renderings: Flow, repeatOnLifecycle: Lifecycle.State = STARTED, collectionContext: CoroutineContext = EmptyCoroutineContext)","description":"com.squareup.workflow1.ui.WorkflowLayout.take","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-layout/take.html","searchKeys":["take","fun take(lifecycle: Lifecycle, renderings: Flow, repeatOnLifecycle: Lifecycle.State = STARTED, collectionContext: CoroutineContext = EmptyCoroutineContext)","com.squareup.workflow1.ui.WorkflowLayout.take"]},{"name":"fun update(newRendering: BackStackScreen<*>, newViewEnvironment: ViewEnvironment)","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.update","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/update.html","searchKeys":["update","fun update(newRendering: BackStackScreen<*>, newViewEnvironment: ViewEnvironment)","com.squareup.workflow1.ui.navigation.BackStackContainer.update"]},{"name":"fun update(overlays: List, viewEnvironment: ViewEnvironment, updateBody: (environment: ViewEnvironment) -> Unit)","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.update","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/update.html","searchKeys":["update","fun update(overlays: List, viewEnvironment: ViewEnvironment, updateBody: (environment: ViewEnvironment) -> Unit)","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.update"]},{"name":"fun update(retainedRenderings: Collection>, oldHolderMaybe: ScreenViewHolder>?, newHolder: ScreenViewHolder>)","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.update","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/update.html","searchKeys":["update","fun update(retainedRenderings: Collection>, oldHolderMaybe: ScreenViewHolder>?, newHolder: ScreenViewHolder>)","com.squareup.workflow1.ui.navigation.ViewStateCache.update"]},{"name":"inline fun fromViewBinding(noinline bindingInflater: ViewBindingInflater, crossinline showRendering: BindingT.(ScreenT, ViewEnvironment) -> Unit): ScreenViewFactory","description":"com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromViewBinding","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/-companion/from-view-binding.html","searchKeys":["fromViewBinding","inline fun fromViewBinding(noinline bindingInflater: ViewBindingInflater, crossinline showRendering: BindingT.(ScreenT, ViewEnvironment) -> Unit): ScreenViewFactory","com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromViewBinding"]},{"name":"inline fun fromViewBinding(noinline bindingInflater: ViewBindingInflater, noinline constructor: (BindingT) -> ScreenViewRunner): ScreenViewFactory","description":"com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromViewBinding","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/-companion/from-view-binding.html","searchKeys":["fromViewBinding","inline fun fromViewBinding(noinline bindingInflater: ViewBindingInflater, noinline constructor: (BindingT) -> ScreenViewRunner): ScreenViewFactory","com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromViewBinding"]},{"name":"inline fun fromCode(crossinline buildView: (initialRendering: ScreenT, initialEnvironment: ViewEnvironment, context: Context, container: ViewGroup?) -> ScreenViewHolder): ScreenViewFactory","description":"com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromCode","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/-companion/from-code.html","searchKeys":["fromCode","inline fun fromCode(crossinline buildView: (initialRendering: ScreenT, initialEnvironment: ViewEnvironment, context: Context, container: ViewGroup?) -> ScreenViewHolder): ScreenViewFactory","com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromCode"]},{"name":"inline fun fromLayout(layoutId: Int, noinline constructor: (View) -> ScreenViewRunner): ScreenViewFactory","description":"com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromLayout","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/-companion/from-layout.html","searchKeys":["fromLayout","inline fun fromLayout(layoutId: Int, noinline constructor: (View) -> ScreenViewRunner): ScreenViewFactory","com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromLayout"]},{"name":"inline fun fromStaticLayout(layoutId: Int): ScreenViewFactory","description":"com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromStaticLayout","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/-companion/from-static-layout.html","searchKeys":["fromStaticLayout","inline fun fromStaticLayout(layoutId: Int): ScreenViewFactory","com.squareup.workflow1.ui.ScreenViewFactory.Companion.fromStaticLayout"]},{"name":"inline fun ScreenViewFactory.map(noinline transform: (wrapperScreen: SourceT) -> TransformedT, crossinline prepEnvironment: (environment: ViewEnvironment) -> ViewEnvironment = { e -> e }, crossinline prepContext: (environment: ViewEnvironment, context: Context) -> Context = { _, c -> c }, crossinline showSource: (view: View, source: SourceT, transform: (wrapperScreen: SourceT) -> TransformedT, environment: ViewEnvironment, showTransformed: (TransformedT, ViewEnvironment) -> Unit) -> Unit = { _, src, xform, e, showTransformed -> showTransformed(xform(src), e) }): ScreenViewFactory","description":"com.squareup.workflow1.ui.map","location":"workflow-ui/core-android/com.squareup.workflow1.ui/map.html","searchKeys":["map","inline fun ScreenViewFactory.map(noinline transform: (wrapperScreen: SourceT) -> TransformedT, crossinline prepEnvironment: (environment: ViewEnvironment) -> ViewEnvironment = { e -> e }, crossinline prepContext: (environment: ViewEnvironment, context: Context) -> Context = { _, c -> c }, crossinline showSource: (view: View, source: SourceT, transform: (wrapperScreen: SourceT) -> TransformedT, environment: ViewEnvironment, showTransformed: (TransformedT, ViewEnvironment) -> Unit) -> Unit = { _, src, xform, e, showTransformed -> showTransformed(xform(src), e) }): ScreenViewFactory","com.squareup.workflow1.ui.map"]},{"name":"inline fun map(crossinline prepEnvironment: (environment: ViewEnvironment) -> ViewEnvironment = { it }, crossinline prepContext: (environment: ViewEnvironment, context: Context) -> Context = { _, c -> c }, crossinline beforeShowing: (viewHolder: ScreenViewHolder) -> Unit = {}, crossinline showSource: (view: View, source: SourceT, transformer: (source: SourceT) -> TransformedT, environment: ViewEnvironment, showTransformed: (TransformedT, ViewEnvironment) -> Unit) -> Unit = { _, src, xform, e, show -> show(xform(src), e) }, noinline transform: (source: SourceT) -> TransformedT): ScreenViewFactory","description":"com.squareup.workflow1.ui.ScreenViewFactory.Companion.map","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/-companion/map.html","searchKeys":["map","inline fun map(crossinline prepEnvironment: (environment: ViewEnvironment) -> ViewEnvironment = { it }, crossinline prepContext: (environment: ViewEnvironment, context: Context) -> Context = { _, c -> c }, crossinline beforeShowing: (viewHolder: ScreenViewHolder) -> Unit = {}, crossinline showSource: (view: View, source: SourceT, transformer: (source: SourceT) -> TransformedT, environment: ViewEnvironment, showTransformed: (TransformedT, ViewEnvironment) -> Unit) -> Unit = { _, src, xform, e, show -> show(xform(src), e) }, noinline transform: (source: SourceT) -> TransformedT): ScreenViewFactory","com.squareup.workflow1.ui.ScreenViewFactory.Companion.map"]},{"name":"inline fun ByteString.toParcelable(): T","description":"com.squareup.workflow1.ui.toParcelable","location":"workflow-ui/core-android/com.squareup.workflow1.ui/to-parcelable.html","searchKeys":["toParcelable","inline fun ByteString.toParcelable(): T","com.squareup.workflow1.ui.toParcelable"]},{"name":"inline fun Snapshot.toParcelable(): T?","description":"com.squareup.workflow1.ui.toParcelable","location":"workflow-ui/core-android/com.squareup.workflow1.ui/to-parcelable.html","searchKeys":["toParcelable","inline fun Snapshot.toParcelable(): T?","com.squareup.workflow1.ui.toParcelable"]},{"name":"inline fun , ContentT : Screen> forWrapper(crossinline prepEnvironment: (environment: ViewEnvironment) -> ViewEnvironment = { it }, crossinline prepContext: (environment: ViewEnvironment, context: Context) -> Context = { _, c -> c }, crossinline beforeShowing: (viewHolder: ScreenViewHolder) -> Unit = {}, crossinline showWrapper: (view: View, wrapper: WrapperT, environment: ViewEnvironment, showContent: (ContentT, ViewEnvironment) -> Unit) -> Unit = { _, src, e, show -> show(src.content, e) }): ScreenViewFactory","description":"com.squareup.workflow1.ui.ScreenViewFactory.Companion.forWrapper","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/-companion/for-wrapper.html","searchKeys":["forWrapper","inline fun , ContentT : Screen> forWrapper(crossinline prepEnvironment: (environment: ViewEnvironment) -> ViewEnvironment = { it }, crossinline prepContext: (environment: ViewEnvironment, context: Context) -> Context = { _, c -> c }, crossinline beforeShowing: (viewHolder: ScreenViewHolder) -> Unit = {}, crossinline showWrapper: (view: View, wrapper: WrapperT, environment: ViewEnvironment, showContent: (ContentT, ViewEnvironment) -> Unit) -> Unit = { _, src, e, show -> show(src.content, e) }): ScreenViewFactory","com.squareup.workflow1.ui.ScreenViewFactory.Companion.forWrapper"]},{"name":"inline operator fun invoke(crossinline buildDialog: (initialRendering: OverlayT, initialEnvironment: ViewEnvironment, context: Context) -> OverlayDialogHolder): OverlayDialogFactory","description":"com.squareup.workflow1.ui.navigation.OverlayDialogFactory.Companion.invoke","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/-companion/invoke.html","searchKeys":["invoke","inline operator fun invoke(crossinline buildDialog: (initialRendering: OverlayT, initialEnvironment: ViewEnvironment, context: Context) -> OverlayDialogHolder): OverlayDialogFactory","com.squareup.workflow1.ui.navigation.OverlayDialogFactory.Companion.invoke"]},{"name":"interface AndroidOverlay> : Overlay","description":"com.squareup.workflow1.ui.navigation.AndroidOverlay","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-android-overlay/index.html","searchKeys":["AndroidOverlay","interface AndroidOverlay> : Overlay","com.squareup.workflow1.ui.navigation.AndroidOverlay"]},{"name":"interface AndroidScreen> : Screen","description":"com.squareup.workflow1.ui.AndroidScreen","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-android-screen/index.html","searchKeys":["AndroidScreen","interface AndroidScreen> : Screen","com.squareup.workflow1.ui.AndroidScreen"]},{"name":"interface OverlayDialogFactory : ViewRegistry.Entry ","description":"com.squareup.workflow1.ui.navigation.OverlayDialogFactory","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/index.html","searchKeys":["OverlayDialogFactory","interface OverlayDialogFactory : ViewRegistry.Entry ","com.squareup.workflow1.ui.navigation.OverlayDialogFactory"]},{"name":"interface OverlayDialogFactoryFinder","description":"com.squareup.workflow1.ui.navigation.OverlayDialogFactoryFinder","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory-finder/index.html","searchKeys":["OverlayDialogFactoryFinder","interface OverlayDialogFactoryFinder","com.squareup.workflow1.ui.navigation.OverlayDialogFactoryFinder"]},{"name":"interface OverlayDialogHolder","description":"com.squareup.workflow1.ui.navigation.OverlayDialogHolder","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-holder/index.html","searchKeys":["OverlayDialogHolder","interface OverlayDialogHolder","com.squareup.workflow1.ui.navigation.OverlayDialogHolder"]},{"name":"interface ScreenViewFactory : ViewRegistry.Entry ","description":"com.squareup.workflow1.ui.ScreenViewFactory","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/index.html","searchKeys":["ScreenViewFactory","interface ScreenViewFactory : ViewRegistry.Entry ","com.squareup.workflow1.ui.ScreenViewFactory"]},{"name":"interface ScreenViewFactoryFinder","description":"com.squareup.workflow1.ui.ScreenViewFactoryFinder","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory-finder/index.html","searchKeys":["ScreenViewFactoryFinder","interface ScreenViewFactoryFinder","com.squareup.workflow1.ui.ScreenViewFactoryFinder"]},{"name":"interface ScreenViewHolder","description":"com.squareup.workflow1.ui.ScreenViewHolder","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-holder/index.html","searchKeys":["ScreenViewHolder","interface ScreenViewHolder","com.squareup.workflow1.ui.ScreenViewHolder"]},{"name":"interface WorkflowLifecycleOwner : LifecycleOwner","description":"com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-lifecycle-owner/index.html","searchKeys":["WorkflowLifecycleOwner","interface WorkflowLifecycleOwner : LifecycleOwner","com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner"]},{"name":"object AlertDialogThemeResId : ViewEnvironmentKey ","description":"com.squareup.workflow1.ui.navigation.AlertDialogThemeResId","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-alert-dialog-theme-res-id/index.html","searchKeys":["AlertDialogThemeResId","object AlertDialogThemeResId : ViewEnvironmentKey ","com.squareup.workflow1.ui.navigation.AlertDialogThemeResId"]},{"name":"object CREATOR : Parcelable.Creator ","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.CREATOR","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/-saved-state/-c-r-e-a-t-o-r/index.html","searchKeys":["CREATOR","object CREATOR : Parcelable.Creator ","com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.CREATOR"]},{"name":"object CREATOR : Parcelable.Creator ","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.CREATOR","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/-saved-state/-c-r-e-a-t-o-r/index.html","searchKeys":["CREATOR","object CREATOR : Parcelable.Creator ","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.CREATOR"]},{"name":"object CREATOR : Parcelable.Creator ","description":"com.squareup.workflow1.ui.ParcelableTextController.CREATOR","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-parcelable-text-controller/-c-r-e-a-t-o-r/index.html","searchKeys":["CREATOR","object CREATOR : Parcelable.Creator ","com.squareup.workflow1.ui.ParcelableTextController.CREATOR"]},{"name":"object CREATOR : Parcelable.Creator ","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.CREATOR","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/-saved/-c-r-e-a-t-o-r/index.html","searchKeys":["CREATOR","object CREATOR : Parcelable.Creator ","com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.CREATOR"]},{"name":"object Companion","description":"com.squareup.workflow1.ui.ScreenViewFactory.Companion","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.ui.ScreenViewFactory.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.ui.ScreenViewHolder.Companion","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-holder/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.ui.ScreenViewHolder.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner.Companion","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-lifecycle-owner/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.Companion","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.ui.navigation.OverlayDialogFactory.Companion","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.ui.navigation.OverlayDialogFactory.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.ui.navigation.OverlayDialogHolder.Companion","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-holder/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.ui.navigation.OverlayDialogHolder.Companion"]},{"name":"object Companion : ViewEnvironmentKey ","description":"com.squareup.workflow1.ui.navigation.OverlayDialogFactoryFinder.Companion","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory-finder/-companion/index.html","searchKeys":["Companion","object Companion : ViewEnvironmentKey ","com.squareup.workflow1.ui.navigation.OverlayDialogFactoryFinder.Companion"]},{"name":"object Companion : ViewEnvironmentKey ","description":"com.squareup.workflow1.ui.ScreenViewFactoryFinder.Companion","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory-finder/-companion/index.html","searchKeys":["Companion","object Companion : ViewEnvironmentKey ","com.squareup.workflow1.ui.ScreenViewFactoryFinder.Companion"]},{"name":"object OnBackPressedDispatcherOwnerKey : ViewEnvironmentKey ","description":"com.squareup.workflow1.ui.androidx.OnBackPressedDispatcherOwnerKey","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-on-back-pressed-dispatcher-owner-key/index.html","searchKeys":["OnBackPressedDispatcherOwnerKey","object OnBackPressedDispatcherOwnerKey : ViewEnvironmentKey ","com.squareup.workflow1.ui.androidx.OnBackPressedDispatcherOwnerKey"]},{"name":"object WorkflowAndroidXSupport","description":"com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-workflow-android-x-support/index.html","searchKeys":["WorkflowAndroidXSupport","object WorkflowAndroidXSupport","com.squareup.workflow1.ui.androidx.WorkflowAndroidXSupport"]},{"name":"open class BackStackContainer constructor(context: Context, attributeSet: AttributeSet? = null, defStyle: Int = 0, defStyleRes: Int = 0) : FrameLayout","description":"com.squareup.workflow1.ui.navigation.BackStackContainer","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/index.html","searchKeys":["BackStackContainer","open class BackStackContainer constructor(context: Context, attributeSet: AttributeSet? = null, defStyle: Int = 0, defStyleRes: Int = 0) : FrameLayout","com.squareup.workflow1.ui.navigation.BackStackContainer"]},{"name":"open fun getDialogFactoryForRendering(environment: ViewEnvironment, rendering: OverlayT): OverlayDialogFactory","description":"com.squareup.workflow1.ui.navigation.OverlayDialogFactoryFinder.getDialogFactoryForRendering","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory-finder/get-dialog-factory-for-rendering.html","searchKeys":["getDialogFactoryForRendering","open fun getDialogFactoryForRendering(environment: ViewEnvironment, rendering: OverlayT): OverlayDialogFactory","com.squareup.workflow1.ui.navigation.OverlayDialogFactoryFinder.getDialogFactoryForRendering"]},{"name":"open fun getViewFactoryForRendering(environment: ViewEnvironment, rendering: ScreenT): ScreenViewFactory?","description":"com.squareup.workflow1.ui.ScreenViewFactoryFinder.getViewFactoryForRendering","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory-finder/get-view-factory-for-rendering.html","searchKeys":["getViewFactoryForRendering","open fun getViewFactoryForRendering(environment: ViewEnvironment, rendering: ScreenT): ScreenViewFactory?","com.squareup.workflow1.ui.ScreenViewFactoryFinder.getViewFactoryForRendering"]},{"name":"open override fun map(transform: (C) -> D): BackButtonScreen","description":"com.squareup.workflow1.ui.navigation.BackButtonScreen.map","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-button-screen/map.html","searchKeys":["map","open override fun map(transform: (C) -> D): BackButtonScreen","com.squareup.workflow1.ui.navigation.BackButtonScreen.map"]},{"name":"open override fun createFromParcel(source: Parcel): BackStackContainer.SavedState","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.CREATOR.createFromParcel","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/-saved-state/-c-r-e-a-t-o-r/create-from-parcel.html","searchKeys":["createFromParcel","open override fun createFromParcel(source: Parcel): BackStackContainer.SavedState","com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.CREATOR.createFromParcel"]},{"name":"open override fun createFromParcel(source: Parcel): LayeredDialogSessions.SavedState","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.CREATOR.createFromParcel","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/-saved-state/-c-r-e-a-t-o-r/create-from-parcel.html","searchKeys":["createFromParcel","open override fun createFromParcel(source: Parcel): LayeredDialogSessions.SavedState","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.CREATOR.createFromParcel"]},{"name":"open override fun createFromParcel(source: Parcel): ParcelableTextController","description":"com.squareup.workflow1.ui.ParcelableTextController.CREATOR.createFromParcel","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-parcelable-text-controller/-c-r-e-a-t-o-r/create-from-parcel.html","searchKeys":["createFromParcel","open override fun createFromParcel(source: Parcel): ParcelableTextController","com.squareup.workflow1.ui.ParcelableTextController.CREATOR.createFromParcel"]},{"name":"open override fun createFromParcel(source: Parcel): ViewStateCache.Saved","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.CREATOR.createFromParcel","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/-saved/-c-r-e-a-t-o-r/create-from-parcel.html","searchKeys":["createFromParcel","open override fun createFromParcel(source: Parcel): ViewStateCache.Saved","com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.CREATOR.createFromParcel"]},{"name":"open override fun describeContents(): Int","description":"com.squareup.workflow1.ui.ParcelableTextController.describeContents","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-parcelable-text-controller/describe-contents.html","searchKeys":["describeContents","open override fun describeContents(): Int","com.squareup.workflow1.ui.ParcelableTextController.describeContents"]},{"name":"open override fun describeContents(): Int","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.describeContents","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/-saved-state/describe-contents.html","searchKeys":["describeContents","open override fun describeContents(): Int","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.describeContents"]},{"name":"open override fun describeContents(): Int","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.describeContents","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/-saved/describe-contents.html","searchKeys":["describeContents","open override fun describeContents(): Int","com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.describeContents"]},{"name":"open override fun getVisibility(): Int","description":"com.squareup.workflow1.ui.WorkflowViewStub.getVisibility","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/get-visibility.html","searchKeys":["getVisibility","open override fun getVisibility(): Int","com.squareup.workflow1.ui.WorkflowViewStub.getVisibility"]},{"name":"open override fun newArray(size: Int): Array","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.CREATOR.newArray","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/-saved-state/-c-r-e-a-t-o-r/new-array.html","searchKeys":["newArray","open override fun newArray(size: Int): Array","com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.CREATOR.newArray"]},{"name":"open override fun newArray(size: Int): Array","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.CREATOR.newArray","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/-saved-state/-c-r-e-a-t-o-r/new-array.html","searchKeys":["newArray","open override fun newArray(size: Int): Array","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.CREATOR.newArray"]},{"name":"open override fun newArray(size: Int): Array","description":"com.squareup.workflow1.ui.ParcelableTextController.CREATOR.newArray","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-parcelable-text-controller/-c-r-e-a-t-o-r/new-array.html","searchKeys":["newArray","open override fun newArray(size: Int): Array","com.squareup.workflow1.ui.ParcelableTextController.CREATOR.newArray"]},{"name":"open override fun newArray(size: Int): Array","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.CREATOR.newArray","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/-saved/-c-r-e-a-t-o-r/new-array.html","searchKeys":["newArray","open override fun newArray(size: Int): Array","com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.CREATOR.newArray"]},{"name":"open override fun setBackground(background: Drawable?)","description":"com.squareup.workflow1.ui.WorkflowViewStub.setBackground","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/set-background.html","searchKeys":["setBackground","open override fun setBackground(background: Drawable?)","com.squareup.workflow1.ui.WorkflowViewStub.setBackground"]},{"name":"open override fun setId(id: Int)","description":"com.squareup.workflow1.ui.WorkflowViewStub.setId","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/set-id.html","searchKeys":["setId","open override fun setId(id: Int)","com.squareup.workflow1.ui.WorkflowViewStub.setId"]},{"name":"open override fun setVisibility(visibility: Int)","description":"com.squareup.workflow1.ui.WorkflowViewStub.setVisibility","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/set-visibility.html","searchKeys":["setVisibility","open override fun setVisibility(visibility: Int)","com.squareup.workflow1.ui.WorkflowViewStub.setVisibility"]},{"name":"open override fun writeToParcel(out: Parcel, flags: Int)","description":"com.squareup.workflow1.ui.ParcelableTextController.writeToParcel","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-parcelable-text-controller/write-to-parcel.html","searchKeys":["writeToParcel","open override fun writeToParcel(out: Parcel, flags: Int)","com.squareup.workflow1.ui.ParcelableTextController.writeToParcel"]},{"name":"open override fun writeToParcel(out: Parcel, flags: Int)","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.writeToParcel","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/-saved-state/write-to-parcel.html","searchKeys":["writeToParcel","open override fun writeToParcel(out: Parcel, flags: Int)","com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.writeToParcel"]},{"name":"open override fun writeToParcel(out: Parcel, flags: Int)","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.writeToParcel","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/-saved-state/write-to-parcel.html","searchKeys":["writeToParcel","open override fun writeToParcel(out: Parcel, flags: Int)","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.SavedState.writeToParcel"]},{"name":"open override fun writeToParcel(out: Parcel, flags: Int)","description":"com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.writeToParcel","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-view-state-cache/-saved/write-to-parcel.html","searchKeys":["writeToParcel","open override fun writeToParcel(out: Parcel, flags: Int)","com.squareup.workflow1.ui.navigation.ViewStateCache.Saved.writeToParcel"]},{"name":"open override val compatibilityKey: String","description":"com.squareup.workflow1.ui.navigation.BackButtonScreen.compatibilityKey","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-button-screen/compatibility-key.html","searchKeys":["compatibilityKey","open override val compatibilityKey: String","com.squareup.workflow1.ui.navigation.BackButtonScreen.compatibilityKey"]},{"name":"open override val content: C","description":"com.squareup.workflow1.ui.navigation.BackButtonScreen.content","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-button-screen/content.html","searchKeys":["content","open override val content: C","com.squareup.workflow1.ui.navigation.BackButtonScreen.content"]},{"name":"open override val default: Int = 0","description":"com.squareup.workflow1.ui.navigation.AlertDialogThemeResId.default","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-alert-dialog-theme-res-id/default.html","searchKeys":["default","open override val default: Int = 0","com.squareup.workflow1.ui.navigation.AlertDialogThemeResId.default"]},{"name":"open override val default: OnBackPressedDispatcherOwner","description":"com.squareup.workflow1.ui.androidx.OnBackPressedDispatcherOwnerKey.default","location":"workflow-ui/core-android/com.squareup.workflow1.ui.androidx/-on-back-pressed-dispatcher-owner-key/default.html","searchKeys":["default","open override val default: OnBackPressedDispatcherOwner","com.squareup.workflow1.ui.androidx.OnBackPressedDispatcherOwnerKey.default"]},{"name":"open override val default: OverlayDialogFactoryFinder","description":"com.squareup.workflow1.ui.navigation.OverlayDialogFactoryFinder.Companion.default","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory-finder/-companion/default.html","searchKeys":["default","open override val default: OverlayDialogFactoryFinder","com.squareup.workflow1.ui.navigation.OverlayDialogFactoryFinder.Companion.default"]},{"name":"open override val default: ScreenViewFactoryFinder","description":"com.squareup.workflow1.ui.ScreenViewFactoryFinder.Companion.default","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory-finder/-companion/default.html","searchKeys":["default","open override val default: ScreenViewFactoryFinder","com.squareup.workflow1.ui.ScreenViewFactoryFinder.Companion.default"]},{"name":"open override val key: ViewRegistry.Key","description":"com.squareup.workflow1.ui.navigation.OverlayDialogFactory.key","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/key.html","searchKeys":["key","open override val key: ViewRegistry.Key","com.squareup.workflow1.ui.navigation.OverlayDialogFactory.key"]},{"name":"open override val key: ViewRegistry.Key>","description":"com.squareup.workflow1.ui.ScreenViewFactory.key","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/key.html","searchKeys":["key","open override val key: ViewRegistry.Key>","com.squareup.workflow1.ui.ScreenViewFactory.key"]},{"name":"open override val viewFactory: ScreenViewFactory>","description":"com.squareup.workflow1.ui.navigation.BackButtonScreen.viewFactory","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-button-screen/view-factory.html","searchKeys":["viewFactory","open override val viewFactory: ScreenViewFactory>","com.squareup.workflow1.ui.navigation.BackButtonScreen.viewFactory"]},{"name":"operator fun invoke(initialEnvironment: ViewEnvironment, dialog: Dialog, onUpdateBounds: (Rect) -> Unit? = { dialog.setBounds(it) }, runner: (rendering: OverlayT, environment: ViewEnvironment) -> Unit): OverlayDialogHolder","description":"com.squareup.workflow1.ui.navigation.OverlayDialogHolder.Companion.invoke","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-holder/-companion/invoke.html","searchKeys":["invoke","operator fun invoke(initialEnvironment: ViewEnvironment, dialog: Dialog, onUpdateBounds: (Rect) -> Unit? = { dialog.setBounds(it) }, runner: (rendering: OverlayT, environment: ViewEnvironment) -> Unit): OverlayDialogHolder","com.squareup.workflow1.ui.navigation.OverlayDialogHolder.Companion.invoke"]},{"name":"operator fun invoke(initialEnvironment: ViewEnvironment, view: View, viewRunner: ScreenViewRunner): ScreenViewHolder","description":"com.squareup.workflow1.ui.ScreenViewHolder.Companion.invoke","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-holder/-companion/invoke.html","searchKeys":["invoke","operator fun invoke(initialEnvironment: ViewEnvironment, view: View, viewRunner: ScreenViewRunner): ScreenViewHolder","com.squareup.workflow1.ui.ScreenViewHolder.Companion.invoke"]},{"name":"typealias ViewBindingInflater = (LayoutInflater, ViewGroup?, Boolean) -> BindingT","description":"com.squareup.workflow1.ui.ViewBindingInflater","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-view-binding-inflater/index.html","searchKeys":["ViewBindingInflater","typealias ViewBindingInflater = (LayoutInflater, ViewGroup?, Boolean) -> BindingT","com.squareup.workflow1.ui.ViewBindingInflater"]},{"name":"val OverlayDialogHolder<*>.showing: Overlay","description":"com.squareup.workflow1.ui.navigation.showing","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/showing.html","searchKeys":["showing","val OverlayDialogHolder<*>.showing: Overlay","com.squareup.workflow1.ui.navigation.showing"]},{"name":"val ScreenViewHolder<*>.showing: Screen","description":"com.squareup.workflow1.ui.showing","location":"workflow-ui/core-android/com.squareup.workflow1.ui/showing.html","searchKeys":["showing","val ScreenViewHolder<*>.showing: Screen","com.squareup.workflow1.ui.showing"]},{"name":"val View.environmentOrNull: ViewEnvironment?","description":"com.squareup.workflow1.ui.environmentOrNull","location":"workflow-ui/core-android/com.squareup.workflow1.ui/environment-or-null.html","searchKeys":["environmentOrNull","val View.environmentOrNull: ViewEnvironment?","com.squareup.workflow1.ui.environmentOrNull"]},{"name":"val View.screenOrNull: Screen?","description":"com.squareup.workflow1.ui.screenOrNull","location":"workflow-ui/core-android/com.squareup.workflow1.ui/screen-or-null.html","searchKeys":["screenOrNull","val View.screenOrNull: Screen?","com.squareup.workflow1.ui.screenOrNull"]},{"name":"val actual: View","description":"com.squareup.workflow1.ui.WorkflowViewStub.actual","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/actual.html","searchKeys":["actual","val actual: View","com.squareup.workflow1.ui.WorkflowViewStub.actual"]},{"name":"val onBackPressed: () -> Unit? = null","description":"com.squareup.workflow1.ui.navigation.BackButtonScreen.onBackPressed","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-button-screen/on-back-pressed.html","searchKeys":["onBackPressed","val onBackPressed: () -> Unit? = null","com.squareup.workflow1.ui.navigation.BackButtonScreen.onBackPressed"]},{"name":"val savedViewState: ViewStateCache.Saved","description":"com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.savedViewState","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-stack-container/-saved-state/saved-view-state.html","searchKeys":["savedViewState","val savedViewState: ViewStateCache.Saved","com.squareup.workflow1.ui.navigation.BackStackContainer.SavedState.savedViewState"]},{"name":"val shadow: Boolean = false","description":"com.squareup.workflow1.ui.navigation.BackButtonScreen.shadow","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-back-button-screen/shadow.html","searchKeys":["shadow","val shadow: Boolean = false","com.squareup.workflow1.ui.navigation.BackButtonScreen.shadow"]},{"name":"var View.screen: Screen","description":"com.squareup.workflow1.ui.screen","location":"workflow-ui/core-android/com.squareup.workflow1.ui/screen.html","searchKeys":["screen","var View.screen: Screen","com.squareup.workflow1.ui.screen"]},{"name":"var allowBodyEvents: Boolean","description":"com.squareup.workflow1.ui.navigation.LayeredDialogSessions.allowBodyEvents","location":"workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-layered-dialog-sessions/allow-body-events.html","searchKeys":["allowBodyEvents","var allowBodyEvents: Boolean","com.squareup.workflow1.ui.navigation.LayeredDialogSessions.allowBodyEvents"]},{"name":"var inflatedId: Int","description":"com.squareup.workflow1.ui.WorkflowViewStub.inflatedId","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/inflated-id.html","searchKeys":["inflatedId","var inflatedId: Int","com.squareup.workflow1.ui.WorkflowViewStub.inflatedId"]},{"name":"var propagatesLayoutParams: Boolean","description":"com.squareup.workflow1.ui.WorkflowViewStub.propagatesLayoutParams","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/propagates-layout-params.html","searchKeys":["propagatesLayoutParams","var propagatesLayoutParams: Boolean","com.squareup.workflow1.ui.WorkflowViewStub.propagatesLayoutParams"]},{"name":"var replaceOldViewInParent: (parent: ViewGroup, newView: View, layoutParams: ViewGroup.LayoutParams?) -> Unit","description":"com.squareup.workflow1.ui.WorkflowViewStub.replaceOldViewInParent","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/replace-old-view-in-parent.html","searchKeys":["replaceOldViewInParent","var replaceOldViewInParent: (parent: ViewGroup, newView: View, layoutParams: ViewGroup.LayoutParams?) -> Unit","com.squareup.workflow1.ui.WorkflowViewStub.replaceOldViewInParent"]},{"name":"var updatesVisibility: Boolean","description":"com.squareup.workflow1.ui.WorkflowViewStub.updatesVisibility","location":"workflow-ui/core-android/com.squareup.workflow1.ui/-workflow-view-stub/updates-visibility.html","searchKeys":["updatesVisibility","var updatesVisibility: Boolean","com.squareup.workflow1.ui.WorkflowViewStub.updatesVisibility"]},{"name":"class JvmTestRuntimeConfigTools","description":"com.squareup.workflow1.config.JvmTestRuntimeConfigTools","location":"workflow-config/config-jvm/com.squareup.workflow1.config/-jvm-test-runtime-config-tools/index.html","searchKeys":["JvmTestRuntimeConfigTools","class JvmTestRuntimeConfigTools","com.squareup.workflow1.config.JvmTestRuntimeConfigTools"]},{"name":"constructor()","description":"com.squareup.workflow1.config.JvmTestRuntimeConfigTools.JvmTestRuntimeConfigTools","location":"workflow-config/config-jvm/com.squareup.workflow1.config/-jvm-test-runtime-config-tools/-jvm-test-runtime-config-tools.html","searchKeys":["JvmTestRuntimeConfigTools","constructor()","com.squareup.workflow1.config.JvmTestRuntimeConfigTools.JvmTestRuntimeConfigTools"]},{"name":"fun getTestRuntimeConfig(): RuntimeConfig","description":"com.squareup.workflow1.config.JvmTestRuntimeConfigTools.Companion.getTestRuntimeConfig","location":"workflow-config/config-jvm/com.squareup.workflow1.config/-jvm-test-runtime-config-tools/-companion/get-test-runtime-config.html","searchKeys":["getTestRuntimeConfig","fun getTestRuntimeConfig(): RuntimeConfig","com.squareup.workflow1.config.JvmTestRuntimeConfigTools.Companion.getTestRuntimeConfig"]},{"name":"object Companion","description":"com.squareup.workflow1.config.JvmTestRuntimeConfigTools.Companion","location":"workflow-config/config-jvm/com.squareup.workflow1.config/-jvm-test-runtime-config-tools/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.config.JvmTestRuntimeConfigTools.Companion"]},{"name":"abstract class PublisherWorker : Worker ","description":"com.squareup.workflow1.rx2.PublisherWorker","location":"workflow-rx2/com.squareup.workflow1.rx2/-publisher-worker/index.html","searchKeys":["PublisherWorker","abstract class PublisherWorker : Worker ","com.squareup.workflow1.rx2.PublisherWorker"]},{"name":"abstract fun runPublisher(): Publisher","description":"com.squareup.workflow1.rx2.PublisherWorker.runPublisher","location":"workflow-rx2/com.squareup.workflow1.rx2/-publisher-worker/run-publisher.html","searchKeys":["runPublisher","abstract fun runPublisher(): Publisher","com.squareup.workflow1.rx2.PublisherWorker.runPublisher"]},{"name":"constructor()","description":"com.squareup.workflow1.rx2.PublisherWorker.PublisherWorker","location":"workflow-rx2/com.squareup.workflow1.rx2/-publisher-worker/-publisher-worker.html","searchKeys":["PublisherWorker","constructor()","com.squareup.workflow1.rx2.PublisherWorker.PublisherWorker"]},{"name":"fun Completable.asWorker(): Worker","description":"com.squareup.workflow1.rx2.asWorker","location":"workflow-rx2/com.squareup.workflow1.rx2/as-worker.html","searchKeys":["asWorker","fun Completable.asWorker(): Worker","com.squareup.workflow1.rx2.asWorker"]},{"name":"inline fun Maybe.asWorker(): Worker","description":"com.squareup.workflow1.rx2.asWorker","location":"workflow-rx2/com.squareup.workflow1.rx2/as-worker.html","searchKeys":["asWorker","inline fun Maybe.asWorker(): Worker","com.squareup.workflow1.rx2.asWorker"]},{"name":"inline fun Observable.asWorker(): Worker","description":"com.squareup.workflow1.rx2.asWorker","location":"workflow-rx2/com.squareup.workflow1.rx2/as-worker.html","searchKeys":["asWorker","inline fun Observable.asWorker(): Worker","com.squareup.workflow1.rx2.asWorker"]},{"name":"inline fun Publisher.asWorker(): Worker","description":"com.squareup.workflow1.rx2.asWorker","location":"workflow-rx2/com.squareup.workflow1.rx2/as-worker.html","searchKeys":["asWorker","inline fun Publisher.asWorker(): Worker","com.squareup.workflow1.rx2.asWorker"]},{"name":"inline fun Single.asWorker(): Worker","description":"com.squareup.workflow1.rx2.asWorker","location":"workflow-rx2/com.squareup.workflow1.rx2/as-worker.html","searchKeys":["asWorker","inline fun Single.asWorker(): Worker","com.squareup.workflow1.rx2.asWorker"]},{"name":"override fun run(): Flow","description":"com.squareup.workflow1.rx2.PublisherWorker.run","location":"workflow-rx2/com.squareup.workflow1.rx2/-publisher-worker/run.html","searchKeys":["run","override fun run(): Flow","com.squareup.workflow1.rx2.PublisherWorker.run"]},{"name":"class AndroidRuntimeConfigTools","description":"com.squareup.workflow1.config.AndroidRuntimeConfigTools","location":"workflow-config/config-android/com.squareup.workflow1.config/-android-runtime-config-tools/index.html","searchKeys":["AndroidRuntimeConfigTools","class AndroidRuntimeConfigTools","com.squareup.workflow1.config.AndroidRuntimeConfigTools"]},{"name":"constructor()","description":"com.squareup.workflow1.config.AndroidRuntimeConfigTools.AndroidRuntimeConfigTools","location":"workflow-config/config-android/com.squareup.workflow1.config/-android-runtime-config-tools/-android-runtime-config-tools.html","searchKeys":["AndroidRuntimeConfigTools","constructor()","com.squareup.workflow1.config.AndroidRuntimeConfigTools.AndroidRuntimeConfigTools"]},{"name":"fun getAppWorkflowRuntimeConfig(): RuntimeConfig","description":"com.squareup.workflow1.config.AndroidRuntimeConfigTools.Companion.getAppWorkflowRuntimeConfig","location":"workflow-config/config-android/com.squareup.workflow1.config/-android-runtime-config-tools/-companion/get-app-workflow-runtime-config.html","searchKeys":["getAppWorkflowRuntimeConfig","fun getAppWorkflowRuntimeConfig(): RuntimeConfig","com.squareup.workflow1.config.AndroidRuntimeConfigTools.Companion.getAppWorkflowRuntimeConfig"]},{"name":"object Companion","description":"com.squareup.workflow1.config.AndroidRuntimeConfigTools.Companion","location":"workflow-config/config-android/com.squareup.workflow1.config/-android-runtime-config-tools/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.config.AndroidRuntimeConfigTools.Companion"]},{"name":"abstract class RenderTester","description":"com.squareup.workflow1.testing.RenderTester","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/index.html","searchKeys":["RenderTester","abstract class RenderTester","com.squareup.workflow1.testing.RenderTester"]},{"name":"abstract fun assertNoOutput()","description":"com.squareup.workflow1.testing.WorkerTester.assertNoOutput","location":"workflow-testing/com.squareup.workflow1.testing/-worker-tester/assert-no-output.html","searchKeys":["assertNoOutput","abstract fun assertNoOutput()","com.squareup.workflow1.testing.WorkerTester.assertNoOutput"]},{"name":"abstract fun assertNotFinished()","description":"com.squareup.workflow1.testing.WorkerTester.assertNotFinished","location":"workflow-testing/com.squareup.workflow1.testing/-worker-tester/assert-not-finished.html","searchKeys":["assertNotFinished","abstract fun assertNotFinished()","com.squareup.workflow1.testing.WorkerTester.assertNotFinished"]},{"name":"abstract fun expectSideEffect(description: String, exactMatch: Boolean = true, matcher: (key: String) -> Boolean): RenderTester","description":"com.squareup.workflow1.testing.RenderTester.expectSideEffect","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/expect-side-effect.html","searchKeys":["expectSideEffect","abstract fun expectSideEffect(description: String, exactMatch: Boolean = true, matcher: (key: String) -> Boolean): RenderTester","com.squareup.workflow1.testing.RenderTester.expectSideEffect"]},{"name":"abstract fun render(block: (rendering: RenderingT) -> Unit = {}): RenderTestResult","description":"com.squareup.workflow1.testing.RenderTester.render","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/render.html","searchKeys":["render","abstract fun render(block: (rendering: RenderingT) -> Unit = {}): RenderTestResult","com.squareup.workflow1.testing.RenderTester.render"]},{"name":"abstract fun requireExplicitSideEffectExpectations(): RenderTester","description":"com.squareup.workflow1.testing.RenderTester.requireExplicitSideEffectExpectations","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/require-explicit-side-effect-expectations.html","searchKeys":["requireExplicitSideEffectExpectations","abstract fun requireExplicitSideEffectExpectations(): RenderTester","com.squareup.workflow1.testing.RenderTester.requireExplicitSideEffectExpectations"]},{"name":"abstract fun requireExplicitWorkerExpectations(): RenderTester","description":"com.squareup.workflow1.testing.RenderTester.requireExplicitWorkerExpectations","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/require-explicit-worker-expectations.html","searchKeys":["requireExplicitWorkerExpectations","abstract fun requireExplicitWorkerExpectations(): RenderTester","com.squareup.workflow1.testing.RenderTester.requireExplicitWorkerExpectations"]},{"name":"abstract fun testNextRender(): RenderTester","description":"com.squareup.workflow1.testing.RenderTestResult.testNextRender","location":"workflow-testing/com.squareup.workflow1.testing/-render-test-result/test-next-render.html","searchKeys":["testNextRender","abstract fun testNextRender(): RenderTester","com.squareup.workflow1.testing.RenderTestResult.testNextRender"]},{"name":"abstract fun testNextRenderWithProps(newProps: PropsT): RenderTester","description":"com.squareup.workflow1.testing.RenderTestResult.testNextRenderWithProps","location":"workflow-testing/com.squareup.workflow1.testing/-render-test-result/test-next-render-with-props.html","searchKeys":["testNextRenderWithProps","abstract fun testNextRenderWithProps(newProps: PropsT): RenderTester","com.squareup.workflow1.testing.RenderTestResult.testNextRenderWithProps"]},{"name":"abstract fun verifyAction(block: (WorkflowAction) -> Unit): RenderTestResult","description":"com.squareup.workflow1.testing.RenderTestResult.verifyAction","location":"workflow-testing/com.squareup.workflow1.testing/-render-test-result/verify-action.html","searchKeys":["verifyAction","abstract fun verifyAction(block: (WorkflowAction) -> Unit): RenderTestResult","com.squareup.workflow1.testing.RenderTestResult.verifyAction"]},{"name":"abstract fun verifyActionResult(block: (newState: StateT, appliedResult: WorkflowOutput?) -> Unit): RenderTestResult","description":"com.squareup.workflow1.testing.RenderTestResult.verifyActionResult","location":"workflow-testing/com.squareup.workflow1.testing/-render-test-result/verify-action-result.html","searchKeys":["verifyActionResult","abstract fun verifyActionResult(block: (newState: StateT, appliedResult: WorkflowOutput?) -> Unit): RenderTestResult","com.squareup.workflow1.testing.RenderTestResult.verifyActionResult"]},{"name":"abstract suspend fun assertFinished()","description":"com.squareup.workflow1.testing.WorkerTester.assertFinished","location":"workflow-testing/com.squareup.workflow1.testing/-worker-tester/assert-finished.html","searchKeys":["assertFinished","abstract suspend fun assertFinished()","com.squareup.workflow1.testing.WorkerTester.assertFinished"]},{"name":"abstract suspend fun cancelWorker()","description":"com.squareup.workflow1.testing.WorkerTester.cancelWorker","location":"workflow-testing/com.squareup.workflow1.testing/-worker-tester/cancel-worker.html","searchKeys":["cancelWorker","abstract suspend fun cancelWorker()","com.squareup.workflow1.testing.WorkerTester.cancelWorker"]},{"name":"abstract suspend fun getException(): Throwable","description":"com.squareup.workflow1.testing.WorkerTester.getException","location":"workflow-testing/com.squareup.workflow1.testing/-worker-tester/get-exception.html","searchKeys":["getException","abstract suspend fun getException(): Throwable","com.squareup.workflow1.testing.WorkerTester.getException"]},{"name":"abstract suspend fun nextOutput(): T","description":"com.squareup.workflow1.testing.WorkerTester.nextOutput","location":"workflow-testing/com.squareup.workflow1.testing/-worker-tester/next-output.html","searchKeys":["nextOutput","abstract suspend fun nextOutput(): T","com.squareup.workflow1.testing.WorkerTester.nextOutput"]},{"name":"abstract val testCoroutineScheduler: TestCoroutineScheduler","description":"com.squareup.workflow1.testing.WorkerTester.testCoroutineScheduler","location":"workflow-testing/com.squareup.workflow1.testing/-worker-tester/test-coroutine-scheduler.html","searchKeys":["testCoroutineScheduler","abstract val testCoroutineScheduler: TestCoroutineScheduler","com.squareup.workflow1.testing.WorkerTester.testCoroutineScheduler"]},{"name":"class Matched(val childRendering: Any?, val output: WorkflowOutput? = null) : RenderTester.ChildWorkflowMatch","description":"com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.Matched","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-child-workflow-match/-matched/index.html","searchKeys":["Matched","class Matched(val childRendering: Any?, val output: WorkflowOutput? = null) : RenderTester.ChildWorkflowMatch","com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.Matched"]},{"name":"class RenderChildInvocation(val workflow: Workflow<*, *, *>, val props: Any?, val outputType: KTypeProjection, val renderingType: KTypeProjection, val renderKey: String)","description":"com.squareup.workflow1.testing.RenderTester.RenderChildInvocation","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-render-child-invocation/index.html","searchKeys":["RenderChildInvocation","class RenderChildInvocation(val workflow: Workflow<*, *, *>, val props: Any?, val outputType: KTypeProjection, val renderingType: KTypeProjection, val renderKey: String)","com.squareup.workflow1.testing.RenderTester.RenderChildInvocation"]},{"name":"class StartFromCompleteSnapshot(val snapshot: TreeSnapshot) : WorkflowTestParams.StartMode ","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromCompleteSnapshot","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-from-complete-snapshot/index.html","searchKeys":["StartFromCompleteSnapshot","class StartFromCompleteSnapshot(val snapshot: TreeSnapshot) : WorkflowTestParams.StartMode ","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromCompleteSnapshot"]},{"name":"class StartFromState(val state: StateT) : WorkflowTestParams.StartMode ","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromState","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-from-state/index.html","searchKeys":["StartFromState","class StartFromState(val state: StateT) : WorkflowTestParams.StartMode ","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromState"]},{"name":"class StartFromWorkflowSnapshot(val snapshot: Snapshot) : WorkflowTestParams.StartMode ","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromWorkflowSnapshot","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-from-workflow-snapshot/index.html","searchKeys":["StartFromWorkflowSnapshot","class StartFromWorkflowSnapshot(val snapshot: Snapshot) : WorkflowTestParams.StartMode ","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromWorkflowSnapshot"]},{"name":"class WorkerSink(name: String, type: KClass<*>) : Worker ","description":"com.squareup.workflow1.testing.WorkerSink","location":"workflow-testing/com.squareup.workflow1.testing/-worker-sink/index.html","searchKeys":["WorkerSink","class WorkerSink(name: String, type: KClass<*>) : Worker ","com.squareup.workflow1.testing.WorkerSink"]},{"name":"class WorkflowTestParams(val startFrom: WorkflowTestParams.StartMode = StartFresh, val checkRenderIdempotence: Boolean = true)","description":"com.squareup.workflow1.testing.WorkflowTestParams","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/index.html","searchKeys":["WorkflowTestParams","class WorkflowTestParams(val startFrom: WorkflowTestParams.StartMode = StartFresh, val checkRenderIdempotence: Boolean = true)","com.squareup.workflow1.testing.WorkflowTestParams"]},{"name":"class WorkflowTestRuntime","description":"com.squareup.workflow1.testing.WorkflowTestRuntime","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/index.html","searchKeys":["WorkflowTestRuntime","class WorkflowTestRuntime","com.squareup.workflow1.testing.WorkflowTestRuntime"]},{"name":"class WorkflowTurbine(val firstRendering: RenderingT, receiveTurbine: ReceiveTurbine)","description":"com.squareup.workflow1.testing.WorkflowTurbine","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-turbine/index.html","searchKeys":["WorkflowTurbine","class WorkflowTurbine(val firstRendering: RenderingT, receiveTurbine: ReceiveTurbine)","com.squareup.workflow1.testing.WorkflowTurbine"]},{"name":"const val DEFAULT_TIMEOUT_MS: Long = 500","description":"com.squareup.workflow1.testing.WorkflowTestRuntime.Companion.DEFAULT_TIMEOUT_MS","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/-companion/-d-e-f-a-u-l-t_-t-i-m-e-o-u-t_-m-s.html","searchKeys":["DEFAULT_TIMEOUT_MS","const val DEFAULT_TIMEOUT_MS: Long = 500","com.squareup.workflow1.testing.WorkflowTestRuntime.Companion.DEFAULT_TIMEOUT_MS"]},{"name":"const val WORKFLOW_TEST_DEFAULT_TIMEOUT_MS: Long","description":"com.squareup.workflow1.testing.WorkflowTurbine.Companion.WORKFLOW_TEST_DEFAULT_TIMEOUT_MS","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-turbine/-companion/-w-o-r-k-f-l-o-w_-t-e-s-t_-d-e-f-a-u-l-t_-t-i-m-e-o-u-t_-m-s.html","searchKeys":["WORKFLOW_TEST_DEFAULT_TIMEOUT_MS","const val WORKFLOW_TEST_DEFAULT_TIMEOUT_MS: Long","com.squareup.workflow1.testing.WorkflowTurbine.Companion.WORKFLOW_TEST_DEFAULT_TIMEOUT_MS"]},{"name":"constructor()","description":"com.squareup.workflow1.testing.RenderTester.RenderTester","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-render-tester.html","searchKeys":["RenderTester","constructor()","com.squareup.workflow1.testing.RenderTester.RenderTester"]},{"name":"constructor(childRendering: Any?, output: WorkflowOutput? = null)","description":"com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.Matched.Matched","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-child-workflow-match/-matched/-matched.html","searchKeys":["Matched","constructor(childRendering: Any?, output: WorkflowOutput? = null)","com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.Matched.Matched"]},{"name":"constructor(firstRendering: RenderingT, receiveTurbine: ReceiveTurbine)","description":"com.squareup.workflow1.testing.WorkflowTurbine.WorkflowTurbine","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-turbine/-workflow-turbine.html","searchKeys":["WorkflowTurbine","constructor(firstRendering: RenderingT, receiveTurbine: ReceiveTurbine)","com.squareup.workflow1.testing.WorkflowTurbine.WorkflowTurbine"]},{"name":"constructor(name: String, type: KClass<*>)","description":"com.squareup.workflow1.testing.WorkerSink.WorkerSink","location":"workflow-testing/com.squareup.workflow1.testing/-worker-sink/-worker-sink.html","searchKeys":["WorkerSink","constructor(name: String, type: KClass<*>)","com.squareup.workflow1.testing.WorkerSink.WorkerSink"]},{"name":"constructor(snapshot: Snapshot)","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromWorkflowSnapshot.StartFromWorkflowSnapshot","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-from-workflow-snapshot/-start-from-workflow-snapshot.html","searchKeys":["StartFromWorkflowSnapshot","constructor(snapshot: Snapshot)","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromWorkflowSnapshot.StartFromWorkflowSnapshot"]},{"name":"constructor(snapshot: TreeSnapshot)","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromCompleteSnapshot.StartFromCompleteSnapshot","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-from-complete-snapshot/-start-from-complete-snapshot.html","searchKeys":["StartFromCompleteSnapshot","constructor(snapshot: TreeSnapshot)","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromCompleteSnapshot.StartFromCompleteSnapshot"]},{"name":"constructor(startFrom: WorkflowTestParams.StartMode = StartFresh, checkRenderIdempotence: Boolean = true)","description":"com.squareup.workflow1.testing.WorkflowTestParams.WorkflowTestParams","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-workflow-test-params.html","searchKeys":["WorkflowTestParams","constructor(startFrom: WorkflowTestParams.StartMode = StartFresh, checkRenderIdempotence: Boolean = true)","com.squareup.workflow1.testing.WorkflowTestParams.WorkflowTestParams"]},{"name":"constructor(state: StateT)","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromState.StartFromState","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-from-state/-start-from-state.html","searchKeys":["StartFromState","constructor(state: StateT)","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromState.StartFromState"]},{"name":"constructor(workflow: Workflow<*, *, *>, props: Any?, outputType: KTypeProjection, renderingType: KTypeProjection, renderKey: String)","description":"com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.RenderChildInvocation","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-render-child-invocation/-render-child-invocation.html","searchKeys":["RenderChildInvocation","constructor(workflow: Workflow<*, *, *>, props: Any?, outputType: KTypeProjection, renderingType: KTypeProjection, renderKey: String)","com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.RenderChildInvocation"]},{"name":"fun RenderTester.expectWorkflow(identifier: WorkflowIdentifier, rendering: ChildRenderingT, output: WorkflowOutput?, key: String = \"\", description: String = \"\", assertProps: (props: Any?) -> Unit = {}): RenderTester","description":"com.squareup.workflow1.testing.expectWorkflow","location":"workflow-testing/com.squareup.workflow1.testing/expect-workflow.html","searchKeys":["expectWorkflow","fun RenderTester.expectWorkflow(identifier: WorkflowIdentifier, rendering: ChildRenderingT, output: WorkflowOutput?, key: String = \"\", description: String = \"\", assertProps: (props: Any?) -> Unit = {}): RenderTester","com.squareup.workflow1.testing.expectWorkflow"]},{"name":"fun Workflow.headlessIntegrationTest(coroutineContext: CoroutineContext = UnconfinedTestDispatcher(), interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}, testTimeout: Long = WORKFLOW_TEST_DEFAULT_TIMEOUT_MS, testCase: suspend WorkflowTurbine.() -> Unit)","description":"com.squareup.workflow1.testing.headlessIntegrationTest","location":"workflow-testing/com.squareup.workflow1.testing/headless-integration-test.html","searchKeys":["headlessIntegrationTest","fun Workflow.headlessIntegrationTest(coroutineContext: CoroutineContext = UnconfinedTestDispatcher(), interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}, testTimeout: Long = WORKFLOW_TEST_DEFAULT_TIMEOUT_MS, testCase: suspend WorkflowTurbine.() -> Unit)","com.squareup.workflow1.testing.headlessIntegrationTest"]},{"name":"fun SessionWorkflow.testRender(props: PropsT, workflowScope: CoroutineScope): RenderTester","description":"com.squareup.workflow1.testing.testRender","location":"workflow-testing/com.squareup.workflow1.testing/test-render.html","searchKeys":["testRender","fun SessionWorkflow.testRender(props: PropsT, workflowScope: CoroutineScope): RenderTester","com.squareup.workflow1.testing.testRender"]},{"name":"fun Workflow.headlessIntegrationTest(props: StateFlow, coroutineContext: CoroutineContext = UnconfinedTestDispatcher(), interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}, testTimeout: Long = WORKFLOW_TEST_DEFAULT_TIMEOUT_MS, testCase: suspend WorkflowTurbine.() -> Unit)","description":"com.squareup.workflow1.testing.headlessIntegrationTest","location":"workflow-testing/com.squareup.workflow1.testing/headless-integration-test.html","searchKeys":["headlessIntegrationTest","fun Workflow.headlessIntegrationTest(props: StateFlow, coroutineContext: CoroutineContext = UnconfinedTestDispatcher(), interceptors: List = emptyList(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit = {}, testTimeout: Long = WORKFLOW_TEST_DEFAULT_TIMEOUT_MS, testCase: suspend WorkflowTurbine.() -> Unit)","com.squareup.workflow1.testing.headlessIntegrationTest"]},{"name":"fun Workflow.testRender(props: PropsT): RenderTester","description":"com.squareup.workflow1.testing.testRender","location":"workflow-testing/com.squareup.workflow1.testing/test-render.html","searchKeys":["testRender","fun Workflow.testRender(props: PropsT): RenderTester","com.squareup.workflow1.testing.testRender"]},{"name":"fun RenderTester.expectSideEffect(key: String): RenderTester","description":"com.squareup.workflow1.testing.expectSideEffect","location":"workflow-testing/com.squareup.workflow1.testing/expect-side-effect.html","searchKeys":["expectSideEffect","fun RenderTester.expectSideEffect(key: String): RenderTester","com.squareup.workflow1.testing.expectSideEffect"]},{"name":"fun RenderTester.expectWorker(workerType: KType, key: String = \"\", assertWorker: (Worker<*>) -> Unit = {}, output: WorkflowOutput<*>? = null, description: String = \"\"): RenderTester","description":"com.squareup.workflow1.testing.expectWorker","location":"workflow-testing/com.squareup.workflow1.testing/expect-worker.html","searchKeys":["expectWorker","fun RenderTester.expectWorker(workerType: KType, key: String = \"\", assertWorker: (Worker<*>) -> Unit = {}, output: WorkflowOutput<*>? = null, description: String = \"\"): RenderTester","com.squareup.workflow1.testing.expectWorker"]},{"name":"fun StatefulWorkflow.testRender(props: PropsT, initialState: StateT): RenderTester","description":"com.squareup.workflow1.testing.testRender","location":"workflow-testing/com.squareup.workflow1.testing/test-render.html","searchKeys":["testRender","fun StatefulWorkflow.testRender(props: PropsT, initialState: StateT): RenderTester","com.squareup.workflow1.testing.testRender"]},{"name":"fun StatefulWorkflow.launchForTestingFromStateWith(initialState: StateT, context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> Unit)","description":"com.squareup.workflow1.testing.launchForTestingFromStateWith","location":"workflow-testing/com.squareup.workflow1.testing/launch-for-testing-from-state-with.html","searchKeys":["launchForTestingFromStateWith","fun StatefulWorkflow.launchForTestingFromStateWith(initialState: StateT, context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> Unit)","com.squareup.workflow1.testing.launchForTestingFromStateWith"]},{"name":"fun Workflow.launchForTestingFromStartWith(testParams: WorkflowTestParams = WorkflowTestParams(), context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> T): T","description":"com.squareup.workflow1.testing.launchForTestingFromStartWith","location":"workflow-testing/com.squareup.workflow1.testing/launch-for-testing-from-start-with.html","searchKeys":["launchForTestingFromStartWith","fun Workflow.launchForTestingFromStartWith(testParams: WorkflowTestParams = WorkflowTestParams(), context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> T): T","com.squareup.workflow1.testing.launchForTestingFromStartWith"]},{"name":"fun Workflow.launchForTestingFromStartWith(props: PropsT, testParams: WorkflowTestParams = WorkflowTestParams(), context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> T): T","description":"com.squareup.workflow1.testing.launchForTestingFromStartWith","location":"workflow-testing/com.squareup.workflow1.testing/launch-for-testing-from-start-with.html","searchKeys":["launchForTestingFromStartWith","fun Workflow.launchForTestingFromStartWith(props: PropsT, testParams: WorkflowTestParams = WorkflowTestParams(), context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> T): T","com.squareup.workflow1.testing.launchForTestingFromStartWith"]},{"name":"fun StatefulWorkflow.launchForTestingFromStateWith(props: PropsT, initialState: StateT, context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> T): T","description":"com.squareup.workflow1.testing.launchForTestingFromStateWith","location":"workflow-testing/com.squareup.workflow1.testing/launch-for-testing-from-state-with.html","searchKeys":["launchForTestingFromStateWith","fun StatefulWorkflow.launchForTestingFromStateWith(props: PropsT, initialState: StateT, context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> T): T","com.squareup.workflow1.testing.launchForTestingFromStateWith"]},{"name":"fun StatefulWorkflow.launchForTestingWith(props: PropsT, testParams: WorkflowTestParams = WorkflowTestParams(), context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> T): T","description":"com.squareup.workflow1.testing.launchForTestingWith","location":"workflow-testing/com.squareup.workflow1.testing/launch-for-testing-with.html","searchKeys":["launchForTestingWith","fun StatefulWorkflow.launchForTestingWith(props: PropsT, testParams: WorkflowTestParams = WorkflowTestParams(), context: CoroutineContext = EmptyCoroutineContext, block: WorkflowTestRuntime.() -> T): T","com.squareup.workflow1.testing.launchForTestingWith"]},{"name":"fun Worker.test(timeoutMs: Long = DEFAULT_TIMEOUT_MS, block: suspend WorkerTester.() -> Unit)","description":"com.squareup.workflow1.testing.test","location":"workflow-testing/com.squareup.workflow1.testing/test.html","searchKeys":["test","fun Worker.test(timeoutMs: Long = DEFAULT_TIMEOUT_MS, block: suspend WorkerTester.() -> Unit)","com.squareup.workflow1.testing.test"]},{"name":"fun awaitNextOutput(timeoutMs: Long? = null): OutputT","description":"com.squareup.workflow1.testing.WorkflowTestRuntime.awaitNextOutput","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/await-next-output.html","searchKeys":["awaitNextOutput","fun awaitNextOutput(timeoutMs: Long? = null): OutputT","com.squareup.workflow1.testing.WorkflowTestRuntime.awaitNextOutput"]},{"name":"fun awaitNextRendering(timeoutMs: Long? = null, skipIntermediate: Boolean = true): RenderingT","description":"com.squareup.workflow1.testing.WorkflowTestRuntime.awaitNextRendering","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/await-next-rendering.html","searchKeys":["awaitNextRendering","fun awaitNextRendering(timeoutMs: Long? = null, skipIntermediate: Boolean = true): RenderingT","com.squareup.workflow1.testing.WorkflowTestRuntime.awaitNextRendering"]},{"name":"fun awaitNextSnapshot(timeoutMs: Long? = null, skipIntermediate: Boolean = true): TreeSnapshot","description":"com.squareup.workflow1.testing.WorkflowTestRuntime.awaitNextSnapshot","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/await-next-snapshot.html","searchKeys":["awaitNextSnapshot","fun awaitNextSnapshot(timeoutMs: Long? = null, skipIntermediate: Boolean = true): TreeSnapshot","com.squareup.workflow1.testing.WorkflowTestRuntime.awaitNextSnapshot"]},{"name":"fun send(value: T)","description":"com.squareup.workflow1.testing.WorkerSink.send","location":"workflow-testing/com.squareup.workflow1.testing/-worker-sink/send.html","searchKeys":["send","fun send(value: T)","com.squareup.workflow1.testing.WorkerSink.send"]},{"name":"fun sendProps(input: PropsT)","description":"com.squareup.workflow1.testing.WorkflowTestRuntime.sendProps","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/send-props.html","searchKeys":["sendProps","fun sendProps(input: PropsT)","com.squareup.workflow1.testing.WorkflowTestRuntime.sendProps"]},{"name":"inline fun RenderTester.expectWorkflow(workflowType: KClass>, rendering: ChildRenderingT, key: String = \"\", crossinline assertProps: (props: ChildPropsT) -> Unit = {}, output: WorkflowOutput? = null, description: String = \"\"): RenderTester","description":"com.squareup.workflow1.testing.expectWorkflow","location":"workflow-testing/com.squareup.workflow1.testing/expect-workflow.html","searchKeys":["expectWorkflow","inline fun RenderTester.expectWorkflow(workflowType: KClass>, rendering: ChildRenderingT, key: String = \"\", crossinline assertProps: (props: ChildPropsT) -> Unit = {}, output: WorkflowOutput? = null, description: String = \"\"): RenderTester","com.squareup.workflow1.testing.expectWorkflow"]},{"name":"inline fun RenderTester.expectWorkflow(identifier: WorkflowIdentifier, rendering: ChildRenderingT, key: String = \"\", description: String = \"\", noinline assertProps: (props: Any?) -> Unit = {}): RenderTester","description":"com.squareup.workflow1.testing.expectWorkflow","location":"workflow-testing/com.squareup.workflow1.testing/expect-workflow.html","searchKeys":["expectWorkflow","inline fun RenderTester.expectWorkflow(identifier: WorkflowIdentifier, rendering: ChildRenderingT, key: String = \"\", description: String = \"\", noinline assertProps: (props: Any?) -> Unit = {}): RenderTester","com.squareup.workflow1.testing.expectWorkflow"]},{"name":"inline fun > RenderTester.expectWorker(expected: WorkerT, key: String = \"\", output: WorkflowOutput? = null, description: String = \"\"): RenderTester","description":"com.squareup.workflow1.testing.expectWorker","location":"workflow-testing/com.squareup.workflow1.testing/expect-worker.html","searchKeys":["expectWorker","inline fun > RenderTester.expectWorker(expected: WorkerT, key: String = \"\", output: WorkflowOutput? = null, description: String = \"\"): RenderTester","com.squareup.workflow1.testing.expectWorker"]},{"name":"inline fun > RenderTester.expectWorker(workerClass: KClass, key: String = \"\", crossinline assertWorker: (WorkerT) -> Unit = {}, output: WorkflowOutput? = null, description: String = \"\"): RenderTester","description":"com.squareup.workflow1.testing.expectWorker","location":"workflow-testing/com.squareup.workflow1.testing/expect-worker.html","searchKeys":["expectWorker","inline fun > RenderTester.expectWorker(workerClass: KClass, key: String = \"\", crossinline assertWorker: (WorkerT) -> Unit = {}, output: WorkflowOutput? = null, description: String = \"\"): RenderTester","com.squareup.workflow1.testing.expectWorker"]},{"name":"inline fun RenderTester.expectWorkerOutputting(outputType: KType, key: String = \"\", crossinline assertWorker: (Worker<*>) -> Unit = {}, output: WorkflowOutput<*>? = null, description: String = \"\"): RenderTester","description":"com.squareup.workflow1.testing.expectWorkerOutputting","location":"workflow-testing/com.squareup.workflow1.testing/expect-worker-outputting.html","searchKeys":["expectWorkerOutputting","inline fun RenderTester.expectWorkerOutputting(outputType: KType, key: String = \"\", crossinline assertWorker: (Worker<*>) -> Unit = {}, output: WorkflowOutput<*>? = null, description: String = \"\"): RenderTester","com.squareup.workflow1.testing.expectWorkerOutputting"]},{"name":"inline fun WorkerSink(name: String): WorkerSink","description":"com.squareup.workflow1.testing.WorkerSink","location":"workflow-testing/com.squareup.workflow1.testing/-worker-sink.html","searchKeys":["WorkerSink","inline fun WorkerSink(name: String): WorkerSink","com.squareup.workflow1.testing.WorkerSink"]},{"name":"interface RenderTestResult","description":"com.squareup.workflow1.testing.RenderTestResult","location":"workflow-testing/com.squareup.workflow1.testing/-render-test-result/index.html","searchKeys":["RenderTestResult","interface RenderTestResult","com.squareup.workflow1.testing.RenderTestResult"]},{"name":"interface WorkerTester","description":"com.squareup.workflow1.testing.WorkerTester","location":"workflow-testing/com.squareup.workflow1.testing/-worker-tester/index.html","searchKeys":["WorkerTester","interface WorkerTester","com.squareup.workflow1.testing.WorkerTester"]},{"name":"object Companion","description":"com.squareup.workflow1.testing.WorkflowTestRuntime.Companion","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.testing.WorkflowTestRuntime.Companion"]},{"name":"object Companion","description":"com.squareup.workflow1.testing.WorkflowTurbine.Companion","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-turbine/-companion/index.html","searchKeys":["Companion","object Companion","com.squareup.workflow1.testing.WorkflowTurbine.Companion"]},{"name":"object NotMatched : RenderTester.ChildWorkflowMatch","description":"com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.NotMatched","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-child-workflow-match/-not-matched/index.html","searchKeys":["NotMatched","object NotMatched : RenderTester.ChildWorkflowMatch","com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.NotMatched"]},{"name":"object RenderIdempotencyChecker : WorkflowInterceptor","description":"com.squareup.workflow1.testing.RenderIdempotencyChecker","location":"workflow-testing/com.squareup.workflow1.testing/-render-idempotency-checker/index.html","searchKeys":["RenderIdempotencyChecker","object RenderIdempotencyChecker : WorkflowInterceptor","com.squareup.workflow1.testing.RenderIdempotencyChecker"]},{"name":"object StartFresh : WorkflowTestParams.StartMode ","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFresh","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-fresh/index.html","searchKeys":["StartFresh","object StartFresh : WorkflowTestParams.StartMode ","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFresh"]},{"name":"open override fun onRender(renderProps: P, renderState: S, context: BaseRenderContext, proceed: (P, S, WorkflowInterceptor.RenderContextInterceptor?) -> R, session: WorkflowInterceptor.WorkflowSession): R","description":"com.squareup.workflow1.testing.RenderIdempotencyChecker.onRender","location":"workflow-testing/com.squareup.workflow1.testing/-render-idempotency-checker/on-render.html","searchKeys":["onRender","open override fun onRender(renderProps: P, renderState: S, context: BaseRenderContext, proceed: (P, S, WorkflowInterceptor.RenderContextInterceptor?) -> R, session: WorkflowInterceptor.WorkflowSession): R","com.squareup.workflow1.testing.RenderIdempotencyChecker.onRender"]},{"name":"open override fun doesSameWorkAs(otherWorker: Worker<*>): Boolean","description":"com.squareup.workflow1.testing.WorkerSink.doesSameWorkAs","location":"workflow-testing/com.squareup.workflow1.testing/-worker-sink/does-same-work-as.html","searchKeys":["doesSameWorkAs","open override fun doesSameWorkAs(otherWorker: Worker<*>): Boolean","com.squareup.workflow1.testing.WorkerSink.doesSameWorkAs"]},{"name":"open override fun run(): Flow","description":"com.squareup.workflow1.testing.WorkerSink.run","location":"workflow-testing/com.squareup.workflow1.testing/-worker-sink/run.html","searchKeys":["run","open override fun run(): Flow","com.squareup.workflow1.testing.WorkerSink.run"]},{"name":"open override fun toString(): String","description":"com.squareup.workflow1.testing.WorkerSink.toString","location":"workflow-testing/com.squareup.workflow1.testing/-worker-sink/to-string.html","searchKeys":["toString","open override fun toString(): String","com.squareup.workflow1.testing.WorkerSink.toString"]},{"name":"sealed class ChildWorkflowMatch","description":"com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-child-workflow-match/index.html","searchKeys":["ChildWorkflowMatch","sealed class ChildWorkflowMatch","com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch"]},{"name":"sealed class StartMode","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/index.html","searchKeys":["StartMode","sealed class StartMode","com.squareup.workflow1.testing.WorkflowTestParams.StartMode"]},{"name":"suspend fun awaitNext(precondition: (RenderingT) -> Boolean = { true }, map: (RenderingT) -> T, satisfying: T.() -> Boolean = { true }): T","description":"com.squareup.workflow1.testing.WorkflowTurbine.awaitNext","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-turbine/await-next.html","searchKeys":["awaitNext","suspend fun awaitNext(precondition: (RenderingT) -> Boolean = { true }, map: (RenderingT) -> T, satisfying: T.() -> Boolean = { true }): T","com.squareup.workflow1.testing.WorkflowTurbine.awaitNext"]},{"name":"suspend fun awaitNextRendering(): RenderingT","description":"com.squareup.workflow1.testing.WorkflowTurbine.awaitNextRendering","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-turbine/await-next-rendering.html","searchKeys":["awaitNextRendering","suspend fun awaitNextRendering(): RenderingT","com.squareup.workflow1.testing.WorkflowTurbine.awaitNextRendering"]},{"name":"suspend fun awaitNextRenderingSatisfying(predicate: (RenderingT) -> Boolean): RenderingT","description":"com.squareup.workflow1.testing.WorkflowTurbine.awaitNextRenderingSatisfying","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-turbine/await-next-rendering-satisfying.html","searchKeys":["awaitNextRenderingSatisfying","suspend fun awaitNextRenderingSatisfying(predicate: (RenderingT) -> Boolean): RenderingT","com.squareup.workflow1.testing.WorkflowTurbine.awaitNextRenderingSatisfying"]},{"name":"suspend fun skipRenderings(count: Int)","description":"com.squareup.workflow1.testing.WorkflowTurbine.skipRenderings","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-turbine/skip-renderings.html","searchKeys":["skipRenderings","suspend fun skipRenderings(count: Int)","com.squareup.workflow1.testing.WorkflowTurbine.skipRenderings"]},{"name":"val checkRenderIdempotence: Boolean = true","description":"com.squareup.workflow1.testing.WorkflowTestParams.checkRenderIdempotence","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/check-render-idempotence.html","searchKeys":["checkRenderIdempotence","val checkRenderIdempotence: Boolean = true","com.squareup.workflow1.testing.WorkflowTestParams.checkRenderIdempotence"]},{"name":"val childRendering: Any?","description":"com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.Matched.childRendering","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-child-workflow-match/-matched/child-rendering.html","searchKeys":["childRendering","val childRendering: Any?","com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.Matched.childRendering"]},{"name":"val firstRendering: RenderingT","description":"com.squareup.workflow1.testing.WorkflowTurbine.firstRendering","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-turbine/first-rendering.html","searchKeys":["firstRendering","val firstRendering: RenderingT","com.squareup.workflow1.testing.WorkflowTurbine.firstRendering"]},{"name":"val hasOutput: Boolean","description":"com.squareup.workflow1.testing.WorkflowTestRuntime.hasOutput","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/has-output.html","searchKeys":["hasOutput","val hasOutput: Boolean","com.squareup.workflow1.testing.WorkflowTestRuntime.hasOutput"]},{"name":"val hasRendering: Boolean","description":"com.squareup.workflow1.testing.WorkflowTestRuntime.hasRendering","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/has-rendering.html","searchKeys":["hasRendering","val hasRendering: Boolean","com.squareup.workflow1.testing.WorkflowTestRuntime.hasRendering"]},{"name":"val hasSnapshot: Boolean","description":"com.squareup.workflow1.testing.WorkflowTestRuntime.hasSnapshot","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-runtime/has-snapshot.html","searchKeys":["hasSnapshot","val hasSnapshot: Boolean","com.squareup.workflow1.testing.WorkflowTestRuntime.hasSnapshot"]},{"name":"val output: WorkflowOutput? = null","description":"com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.Matched.output","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-child-workflow-match/-matched/output.html","searchKeys":["output","val output: WorkflowOutput? = null","com.squareup.workflow1.testing.RenderTester.ChildWorkflowMatch.Matched.output"]},{"name":"val outputType: KTypeProjection","description":"com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.outputType","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-render-child-invocation/output-type.html","searchKeys":["outputType","val outputType: KTypeProjection","com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.outputType"]},{"name":"val props: Any?","description":"com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.props","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-render-child-invocation/props.html","searchKeys":["props","val props: Any?","com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.props"]},{"name":"val renderKey: String","description":"com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.renderKey","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-render-child-invocation/render-key.html","searchKeys":["renderKey","val renderKey: String","com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.renderKey"]},{"name":"val renderingType: KTypeProjection","description":"com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.renderingType","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-render-child-invocation/rendering-type.html","searchKeys":["renderingType","val renderingType: KTypeProjection","com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.renderingType"]},{"name":"val snapshot: Snapshot","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromWorkflowSnapshot.snapshot","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-from-workflow-snapshot/snapshot.html","searchKeys":["snapshot","val snapshot: Snapshot","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromWorkflowSnapshot.snapshot"]},{"name":"val snapshot: TreeSnapshot","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromCompleteSnapshot.snapshot","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-from-complete-snapshot/snapshot.html","searchKeys":["snapshot","val snapshot: TreeSnapshot","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromCompleteSnapshot.snapshot"]},{"name":"val startFrom: WorkflowTestParams.StartMode","description":"com.squareup.workflow1.testing.WorkflowTestParams.startFrom","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/start-from.html","searchKeys":["startFrom","val startFrom: WorkflowTestParams.StartMode","com.squareup.workflow1.testing.WorkflowTestParams.startFrom"]},{"name":"val state: StateT","description":"com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromState.state","location":"workflow-testing/com.squareup.workflow1.testing/-workflow-test-params/-start-mode/-start-from-state/state.html","searchKeys":["state","val state: StateT","com.squareup.workflow1.testing.WorkflowTestParams.StartMode.StartFromState.state"]},{"name":"val workflow: Workflow<*, *, *>","description":"com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.workflow","location":"workflow-testing/com.squareup.workflow1.testing/-render-tester/-render-child-invocation/workflow.html","searchKeys":["workflow","val workflow: Workflow<*, *, *>","com.squareup.workflow1.testing.RenderTester.RenderChildInvocation.workflow"]},{"name":"abstract fun freeMemory(): Long","description":"com.squareup.workflow1.diagnostic.tracing.MemoryStats.freeMemory","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-memory-stats/free-memory.html","searchKeys":["freeMemory","abstract fun freeMemory(): Long","com.squareup.workflow1.diagnostic.tracing.MemoryStats.freeMemory"]},{"name":"abstract fun totalMemory(): Long","description":"com.squareup.workflow1.diagnostic.tracing.MemoryStats.totalMemory","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-memory-stats/total-memory.html","searchKeys":["totalMemory","abstract fun totalMemory(): Long","com.squareup.workflow1.diagnostic.tracing.MemoryStats.totalMemory"]},{"name":"class TracingWorkflowInterceptor : WorkflowInterceptor","description":"com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-tracing-workflow-interceptor/index.html","searchKeys":["TracingWorkflowInterceptor","class TracingWorkflowInterceptor : WorkflowInterceptor","com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor"]},{"name":"constructor(memoryStats: MemoryStats = RuntimeMemoryStats, loggerProvider: (workflowScope: CoroutineScope, workflowType: String) -> TraceLogger)","description":"com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.TracingWorkflowInterceptor","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-tracing-workflow-interceptor/-tracing-workflow-interceptor.html","searchKeys":["TracingWorkflowInterceptor","constructor(memoryStats: MemoryStats = RuntimeMemoryStats, loggerProvider: (workflowScope: CoroutineScope, workflowType: String) -> TraceLogger)","com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.TracingWorkflowInterceptor"]},{"name":"fun TracingWorkflowInterceptor(file: File, name: String = \"\"): TracingWorkflowInterceptor","description":"com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-tracing-workflow-interceptor.html","searchKeys":["TracingWorkflowInterceptor","fun TracingWorkflowInterceptor(file: File, name: String = \"\"): TracingWorkflowInterceptor","com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor"]},{"name":"fun TracingWorkflowInterceptor(name: String = \"\", memoryStats: MemoryStats = RuntimeMemoryStats, encoderProvider: (workflowScope: CoroutineScope) -> TraceEncoder): TracingWorkflowInterceptor","description":"com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-tracing-workflow-interceptor.html","searchKeys":["TracingWorkflowInterceptor","fun TracingWorkflowInterceptor(name: String = \"\", memoryStats: MemoryStats = RuntimeMemoryStats, encoderProvider: (workflowScope: CoroutineScope) -> TraceEncoder): TracingWorkflowInterceptor","com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor"]},{"name":"interface MemoryStats","description":"com.squareup.workflow1.diagnostic.tracing.MemoryStats","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-memory-stats/index.html","searchKeys":["MemoryStats","interface MemoryStats","com.squareup.workflow1.diagnostic.tracing.MemoryStats"]},{"name":"object RuntimeMemoryStats : MemoryStats","description":"com.squareup.workflow1.diagnostic.tracing.RuntimeMemoryStats","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-runtime-memory-stats/index.html","searchKeys":["RuntimeMemoryStats","object RuntimeMemoryStats : MemoryStats","com.squareup.workflow1.diagnostic.tracing.RuntimeMemoryStats"]},{"name":"open override fun onRender(renderProps: P, renderState: S, context: BaseRenderContext, proceed: (P, S, WorkflowInterceptor.RenderContextInterceptor?) -> R, session: WorkflowInterceptor.WorkflowSession): R","description":"com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onRender","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-tracing-workflow-interceptor/on-render.html","searchKeys":["onRender","open override fun onRender(renderProps: P, renderState: S, context: BaseRenderContext, proceed: (P, S, WorkflowInterceptor.RenderContextInterceptor?) -> R, session: WorkflowInterceptor.WorkflowSession): R","com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onRender"]},{"name":"open override fun onInitialState(props: P, snapshot: Snapshot?, workflowScope: CoroutineScope, proceed: (P, Snapshot?, CoroutineScope) -> S, session: WorkflowInterceptor.WorkflowSession): S","description":"com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onInitialState","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-tracing-workflow-interceptor/on-initial-state.html","searchKeys":["onInitialState","open override fun onInitialState(props: P, snapshot: Snapshot?, workflowScope: CoroutineScope, proceed: (P, Snapshot?, CoroutineScope) -> S, session: WorkflowInterceptor.WorkflowSession): S","com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onInitialState"]},{"name":"open override fun onPropsChanged(old: P, new: P, state: S, proceed: (P, P, S) -> S, session: WorkflowInterceptor.WorkflowSession): S","description":"com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onPropsChanged","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-tracing-workflow-interceptor/on-props-changed.html","searchKeys":["onPropsChanged","open override fun onPropsChanged(old: P, new: P, state: S, proceed: (P, P, S) -> S, session: WorkflowInterceptor.WorkflowSession): S","com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onPropsChanged"]},{"name":"open override fun onSnapshotState(state: S, proceed: (S) -> Snapshot?, session: WorkflowInterceptor.WorkflowSession): Snapshot?","description":"com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onSnapshotState","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-tracing-workflow-interceptor/on-snapshot-state.html","searchKeys":["onSnapshotState","open override fun onSnapshotState(state: S, proceed: (S) -> Snapshot?, session: WorkflowInterceptor.WorkflowSession): Snapshot?","com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onSnapshotState"]},{"name":"open override fun freeMemory(): Long","description":"com.squareup.workflow1.diagnostic.tracing.RuntimeMemoryStats.freeMemory","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-runtime-memory-stats/free-memory.html","searchKeys":["freeMemory","open override fun freeMemory(): Long","com.squareup.workflow1.diagnostic.tracing.RuntimeMemoryStats.freeMemory"]},{"name":"open override fun onSessionStarted(workflowScope: CoroutineScope, session: WorkflowInterceptor.WorkflowSession)","description":"com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onSessionStarted","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-tracing-workflow-interceptor/on-session-started.html","searchKeys":["onSessionStarted","open override fun onSessionStarted(workflowScope: CoroutineScope, session: WorkflowInterceptor.WorkflowSession)","com.squareup.workflow1.diagnostic.tracing.TracingWorkflowInterceptor.onSessionStarted"]},{"name":"open override fun totalMemory(): Long","description":"com.squareup.workflow1.diagnostic.tracing.RuntimeMemoryStats.totalMemory","location":"workflow-tracing/com.squareup.workflow1.diagnostic.tracing/-runtime-memory-stats/total-memory.html","searchKeys":["totalMemory","open override fun totalMemory(): Long","com.squareup.workflow1.diagnostic.tracing.RuntimeMemoryStats.totalMemory"]},{"name":"fun ScreenComposableFactory.Preview(rendering: RenderingT, modifier: Modifier = Modifier, placeholderModifier: Modifier = Modifier, viewEnvironmentUpdater: (ViewEnvironment) -> ViewEnvironment? = null)","description":"com.squareup.workflow1.ui.compose.tooling.Preview","location":"workflow-ui/compose-tooling/com.squareup.workflow1.ui.compose.tooling/-preview.html","searchKeys":["Preview","fun ScreenComposableFactory.Preview(rendering: RenderingT, modifier: Modifier = Modifier, placeholderModifier: Modifier = Modifier, viewEnvironmentUpdater: (ViewEnvironment) -> ViewEnvironment? = null)","com.squareup.workflow1.ui.compose.tooling.Preview"]},{"name":"fun ScreenViewFactory.Preview(rendering: RenderingT, modifier: Modifier = Modifier, placeholderModifier: Modifier = Modifier, viewEnvironmentUpdater: (ViewEnvironment) -> ViewEnvironment? = null)","description":"com.squareup.workflow1.ui.compose.tooling.Preview","location":"workflow-ui/compose-tooling/com.squareup.workflow1.ui.compose.tooling/-preview.html","searchKeys":["Preview","fun ScreenViewFactory.Preview(rendering: RenderingT, modifier: Modifier = Modifier, placeholderModifier: Modifier = Modifier, viewEnvironmentUpdater: (ViewEnvironment) -> ViewEnvironment? = null)","com.squareup.workflow1.ui.compose.tooling.Preview"]},{"name":"fun Screen.Preview(modifier: Modifier = Modifier, placeholderModifier: Modifier = Modifier, viewEnvironmentUpdater: (ViewEnvironment) -> ViewEnvironment? = null)","description":"com.squareup.workflow1.ui.compose.tooling.Preview","location":"workflow-ui/compose-tooling/com.squareup.workflow1.ui.compose.tooling/-preview.html","searchKeys":["Preview","fun Screen.Preview(modifier: Modifier = Modifier, placeholderModifier: Modifier = Modifier, viewEnvironmentUpdater: (ViewEnvironment) -> ViewEnvironment? = null)","com.squareup.workflow1.ui.compose.tooling.Preview"]},{"name":"GLOBAL","description":"com.squareup.tracing.TraceEvent.Instant.InstantScope.GLOBAL","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/-instant-scope/-g-l-o-b-a-l/index.html","searchKeys":["GLOBAL","GLOBAL","com.squareup.tracing.TraceEvent.Instant.InstantScope.GLOBAL"]},{"name":"PROCESS","description":"com.squareup.tracing.TraceEvent.Instant.InstantScope.PROCESS","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/-instant-scope/-p-r-o-c-e-s-s/index.html","searchKeys":["PROCESS","PROCESS","com.squareup.tracing.TraceEvent.Instant.InstantScope.PROCESS"]},{"name":"THREAD","description":"com.squareup.tracing.TraceEvent.Instant.InstantScope.THREAD","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/-instant-scope/-t-h-r-e-a-d/index.html","searchKeys":["THREAD","THREAD","com.squareup.tracing.TraceEvent.Instant.InstantScope.THREAD"]},{"name":"abstract fun log(event: TraceEvent)","description":"com.squareup.tracing.TraceLogger.log","location":"trace-encoder/com.squareup.tracing/-trace-logger/log.html","searchKeys":["log","abstract fun log(event: TraceEvent)","com.squareup.tracing.TraceLogger.log"]},{"name":"abstract fun log(eventBatch: List)","description":"com.squareup.tracing.TraceLogger.log","location":"trace-encoder/com.squareup.tracing/-trace-logger/log.html","searchKeys":["log","abstract fun log(eventBatch: List)","com.squareup.tracing.TraceLogger.log"]},{"name":"abstract val elapsedNow: Long","description":"com.squareup.tracing.TimeMark.elapsedNow","location":"trace-encoder/com.squareup.tracing/-time-mark/elapsed-now.html","searchKeys":["elapsedNow","abstract val elapsedNow: Long","com.squareup.tracing.TimeMark.elapsedNow"]},{"name":"class TraceEncoder(scope: CoroutineScope, start: TimeMark = TraceEncoderTimeMark, ioDispatcher: CoroutineDispatcher = IO, sinkProvider: () -> BufferedSink) : Closeable","description":"com.squareup.tracing.TraceEncoder","location":"trace-encoder/com.squareup.tracing/-trace-encoder/index.html","searchKeys":["TraceEncoder","class TraceEncoder(scope: CoroutineScope, start: TimeMark = TraceEncoderTimeMark, ioDispatcher: CoroutineDispatcher = IO, sinkProvider: () -> BufferedSink) : Closeable","com.squareup.tracing.TraceEncoder"]},{"name":"constructor(id: Any, name: String, args: Map = emptyMap(), category: String? = null)","description":"com.squareup.tracing.TraceEvent.AsyncDurationBegin.AsyncDurationBegin","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-begin/-async-duration-begin.html","searchKeys":["AsyncDurationBegin","constructor(id: Any, name: String, args: Map = emptyMap(), category: String? = null)","com.squareup.tracing.TraceEvent.AsyncDurationBegin.AsyncDurationBegin"]},{"name":"constructor(id: Any, name: String, args: Map = emptyMap(), category: String? = null)","description":"com.squareup.tracing.TraceEvent.AsyncDurationEnd.AsyncDurationEnd","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-end/-async-duration-end.html","searchKeys":["AsyncDurationEnd","constructor(id: Any, name: String, args: Map = emptyMap(), category: String? = null)","com.squareup.tracing.TraceEvent.AsyncDurationEnd.AsyncDurationEnd"]},{"name":"constructor(id: Long, objectType: String)","description":"com.squareup.tracing.TraceEvent.ObjectCreated.ObjectCreated","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-created/-object-created.html","searchKeys":["ObjectCreated","constructor(id: Long, objectType: String)","com.squareup.tracing.TraceEvent.ObjectCreated.ObjectCreated"]},{"name":"constructor(id: Long, objectType: String)","description":"com.squareup.tracing.TraceEvent.ObjectDestroyed.ObjectDestroyed","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-destroyed/-object-destroyed.html","searchKeys":["ObjectDestroyed","constructor(id: Long, objectType: String)","com.squareup.tracing.TraceEvent.ObjectDestroyed.ObjectDestroyed"]},{"name":"constructor(id: Long, objectType: String, snapshot: Any)","description":"com.squareup.tracing.TraceEvent.ObjectSnapshot.ObjectSnapshot","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-snapshot/-object-snapshot.html","searchKeys":["ObjectSnapshot","constructor(id: Long, objectType: String, snapshot: Any)","com.squareup.tracing.TraceEvent.ObjectSnapshot.ObjectSnapshot"]},{"name":"constructor(name: String, args: Map = emptyMap(), category: String? = null)","description":"com.squareup.tracing.TraceEvent.DurationBegin.DurationBegin","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-begin/-duration-begin.html","searchKeys":["DurationBegin","constructor(name: String, args: Map = emptyMap(), category: String? = null)","com.squareup.tracing.TraceEvent.DurationBegin.DurationBegin"]},{"name":"constructor(name: String, args: Map = emptyMap(), category: String? = null)","description":"com.squareup.tracing.TraceEvent.DurationEnd.DurationEnd","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-end/-duration-end.html","searchKeys":["DurationEnd","constructor(name: String, args: Map = emptyMap(), category: String? = null)","com.squareup.tracing.TraceEvent.DurationEnd.DurationEnd"]},{"name":"constructor(name: String, args: Map = emptyMap(), scope: TraceEvent.Instant.InstantScope = THREAD, category: String? = null)","description":"com.squareup.tracing.TraceEvent.Instant.Instant","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/-instant.html","searchKeys":["Instant","constructor(name: String, args: Map = emptyMap(), scope: TraceEvent.Instant.InstantScope = THREAD, category: String? = null)","com.squareup.tracing.TraceEvent.Instant.Instant"]},{"name":"constructor(name: String, series: Map, id: Long? = null)","description":"com.squareup.tracing.TraceEvent.Counter.Counter","location":"trace-encoder/com.squareup.tracing/-trace-event/-counter/-counter.html","searchKeys":["Counter","constructor(name: String, series: Map, id: Long? = null)","com.squareup.tracing.TraceEvent.Counter.Counter"]},{"name":"constructor(scope: CoroutineScope, start: TimeMark = TraceEncoderTimeMark, ioDispatcher: CoroutineDispatcher = IO, sinkProvider: () -> BufferedSink)","description":"com.squareup.tracing.TraceEncoder.TraceEncoder","location":"trace-encoder/com.squareup.tracing/-trace-encoder/-trace-encoder.html","searchKeys":["TraceEncoder","constructor(scope: CoroutineScope, start: TimeMark = TraceEncoderTimeMark, ioDispatcher: CoroutineDispatcher = IO, sinkProvider: () -> BufferedSink)","com.squareup.tracing.TraceEncoder.TraceEncoder"]},{"name":"data class AsyncDurationBegin(val id: Any, val name: String, val args: Map = emptyMap(), val category: String? = null) : TraceEvent","description":"com.squareup.tracing.TraceEvent.AsyncDurationBegin","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-begin/index.html","searchKeys":["AsyncDurationBegin","data class AsyncDurationBegin(val id: Any, val name: String, val args: Map = emptyMap(), val category: String? = null) : TraceEvent","com.squareup.tracing.TraceEvent.AsyncDurationBegin"]},{"name":"data class AsyncDurationEnd(val id: Any, val name: String, val args: Map = emptyMap(), val category: String? = null) : TraceEvent","description":"com.squareup.tracing.TraceEvent.AsyncDurationEnd","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-end/index.html","searchKeys":["AsyncDurationEnd","data class AsyncDurationEnd(val id: Any, val name: String, val args: Map = emptyMap(), val category: String? = null) : TraceEvent","com.squareup.tracing.TraceEvent.AsyncDurationEnd"]},{"name":"data class Counter(val name: String, val series: Map, val id: Long? = null) : TraceEvent","description":"com.squareup.tracing.TraceEvent.Counter","location":"trace-encoder/com.squareup.tracing/-trace-event/-counter/index.html","searchKeys":["Counter","data class Counter(val name: String, val series: Map, val id: Long? = null) : TraceEvent","com.squareup.tracing.TraceEvent.Counter"]},{"name":"data class DurationBegin(val name: String, val args: Map = emptyMap(), val category: String? = null) : TraceEvent","description":"com.squareup.tracing.TraceEvent.DurationBegin","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-begin/index.html","searchKeys":["DurationBegin","data class DurationBegin(val name: String, val args: Map = emptyMap(), val category: String? = null) : TraceEvent","com.squareup.tracing.TraceEvent.DurationBegin"]},{"name":"data class DurationEnd(val name: String, val args: Map = emptyMap(), val category: String? = null) : TraceEvent","description":"com.squareup.tracing.TraceEvent.DurationEnd","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-end/index.html","searchKeys":["DurationEnd","data class DurationEnd(val name: String, val args: Map = emptyMap(), val category: String? = null) : TraceEvent","com.squareup.tracing.TraceEvent.DurationEnd"]},{"name":"data class Instant(val name: String, val args: Map = emptyMap(), val scope: TraceEvent.Instant.InstantScope = THREAD, val category: String? = null) : TraceEvent","description":"com.squareup.tracing.TraceEvent.Instant","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/index.html","searchKeys":["Instant","data class Instant(val name: String, val args: Map = emptyMap(), val scope: TraceEvent.Instant.InstantScope = THREAD, val category: String? = null) : TraceEvent","com.squareup.tracing.TraceEvent.Instant"]},{"name":"data class ObjectCreated(val id: Long, val objectType: String) : TraceEvent","description":"com.squareup.tracing.TraceEvent.ObjectCreated","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-created/index.html","searchKeys":["ObjectCreated","data class ObjectCreated(val id: Long, val objectType: String) : TraceEvent","com.squareup.tracing.TraceEvent.ObjectCreated"]},{"name":"data class ObjectDestroyed(val id: Long, val objectType: String) : TraceEvent","description":"com.squareup.tracing.TraceEvent.ObjectDestroyed","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-destroyed/index.html","searchKeys":["ObjectDestroyed","data class ObjectDestroyed(val id: Long, val objectType: String) : TraceEvent","com.squareup.tracing.TraceEvent.ObjectDestroyed"]},{"name":"data class ObjectSnapshot(val id: Long, val objectType: String, val snapshot: Any) : TraceEvent","description":"com.squareup.tracing.TraceEvent.ObjectSnapshot","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-snapshot/index.html","searchKeys":["ObjectSnapshot","data class ObjectSnapshot(val id: Long, val objectType: String, val snapshot: Any) : TraceEvent","com.squareup.tracing.TraceEvent.ObjectSnapshot"]},{"name":"enum InstantScope : Enum ","description":"com.squareup.tracing.TraceEvent.Instant.InstantScope","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/-instant-scope/index.html","searchKeys":["InstantScope","enum InstantScope : Enum ","com.squareup.tracing.TraceEvent.Instant.InstantScope"]},{"name":"fun createLogger(processName: String = \"\", threadName: String = \"\"): TraceLogger","description":"com.squareup.tracing.TraceEncoder.createLogger","location":"trace-encoder/com.squareup.tracing/-trace-encoder/create-logger.html","searchKeys":["createLogger","fun createLogger(processName: String = \"\", threadName: String = \"\"): TraceLogger","com.squareup.tracing.TraceEncoder.createLogger"]},{"name":"fun valueOf(value: String): TraceEvent.Instant.InstantScope","description":"com.squareup.tracing.TraceEvent.Instant.InstantScope.valueOf","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/-instant-scope/value-of.html","searchKeys":["valueOf","fun valueOf(value: String): TraceEvent.Instant.InstantScope","com.squareup.tracing.TraceEvent.Instant.InstantScope.valueOf"]},{"name":"fun values(): Array","description":"com.squareup.tracing.TraceEvent.Instant.InstantScope.values","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/-instant-scope/values.html","searchKeys":["values","fun values(): Array","com.squareup.tracing.TraceEvent.Instant.InstantScope.values"]},{"name":"interface TimeMark","description":"com.squareup.tracing.TimeMark","location":"trace-encoder/com.squareup.tracing/-time-mark/index.html","searchKeys":["TimeMark","interface TimeMark","com.squareup.tracing.TimeMark"]},{"name":"interface TraceLogger","description":"com.squareup.tracing.TraceLogger","location":"trace-encoder/com.squareup.tracing/-trace-logger/index.html","searchKeys":["TraceLogger","interface TraceLogger","com.squareup.tracing.TraceLogger"]},{"name":"open override fun close()","description":"com.squareup.tracing.TraceEncoder.close","location":"trace-encoder/com.squareup.tracing/-trace-encoder/close.html","searchKeys":["close","open override fun close()","com.squareup.tracing.TraceEncoder.close"]},{"name":"open override val category: String? = null","description":"com.squareup.tracing.TraceEvent.AsyncDurationBegin.category","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-begin/category.html","searchKeys":["category","open override val category: String? = null","com.squareup.tracing.TraceEvent.AsyncDurationBegin.category"]},{"name":"open override val category: String? = null","description":"com.squareup.tracing.TraceEvent.AsyncDurationEnd.category","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-end/category.html","searchKeys":["category","open override val category: String? = null","com.squareup.tracing.TraceEvent.AsyncDurationEnd.category"]},{"name":"open override val category: String? = null","description":"com.squareup.tracing.TraceEvent.DurationBegin.category","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-begin/category.html","searchKeys":["category","open override val category: String? = null","com.squareup.tracing.TraceEvent.DurationBegin.category"]},{"name":"open override val category: String? = null","description":"com.squareup.tracing.TraceEvent.DurationEnd.category","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-end/category.html","searchKeys":["category","open override val category: String? = null","com.squareup.tracing.TraceEvent.DurationEnd.category"]},{"name":"open override val category: String? = null","description":"com.squareup.tracing.TraceEvent.Instant.category","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/category.html","searchKeys":["category","open override val category: String? = null","com.squareup.tracing.TraceEvent.Instant.category"]},{"name":"open val category: String?","description":"com.squareup.tracing.TraceEvent.category","location":"trace-encoder/com.squareup.tracing/-trace-event/category.html","searchKeys":["category","open val category: String?","com.squareup.tracing.TraceEvent.category"]},{"name":"sealed class TraceEvent","description":"com.squareup.tracing.TraceEvent","location":"trace-encoder/com.squareup.tracing/-trace-event/index.html","searchKeys":["TraceEvent","sealed class TraceEvent","com.squareup.tracing.TraceEvent"]},{"name":"val args: Map","description":"com.squareup.tracing.TraceEvent.AsyncDurationBegin.args","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-begin/args.html","searchKeys":["args","val args: Map","com.squareup.tracing.TraceEvent.AsyncDurationBegin.args"]},{"name":"val args: Map","description":"com.squareup.tracing.TraceEvent.AsyncDurationEnd.args","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-end/args.html","searchKeys":["args","val args: Map","com.squareup.tracing.TraceEvent.AsyncDurationEnd.args"]},{"name":"val args: Map","description":"com.squareup.tracing.TraceEvent.DurationBegin.args","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-begin/args.html","searchKeys":["args","val args: Map","com.squareup.tracing.TraceEvent.DurationBegin.args"]},{"name":"val args: Map","description":"com.squareup.tracing.TraceEvent.DurationEnd.args","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-end/args.html","searchKeys":["args","val args: Map","com.squareup.tracing.TraceEvent.DurationEnd.args"]},{"name":"val args: Map","description":"com.squareup.tracing.TraceEvent.Instant.args","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/args.html","searchKeys":["args","val args: Map","com.squareup.tracing.TraceEvent.Instant.args"]},{"name":"val entries: EnumEntries","description":"com.squareup.tracing.TraceEvent.Instant.InstantScope.entries","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/-instant-scope/entries.html","searchKeys":["entries","val entries: EnumEntries","com.squareup.tracing.TraceEvent.Instant.InstantScope.entries"]},{"name":"val id: Any","description":"com.squareup.tracing.TraceEvent.AsyncDurationBegin.id","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-begin/id.html","searchKeys":["id","val id: Any","com.squareup.tracing.TraceEvent.AsyncDurationBegin.id"]},{"name":"val id: Any","description":"com.squareup.tracing.TraceEvent.AsyncDurationEnd.id","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-end/id.html","searchKeys":["id","val id: Any","com.squareup.tracing.TraceEvent.AsyncDurationEnd.id"]},{"name":"val id: Long","description":"com.squareup.tracing.TraceEvent.ObjectCreated.id","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-created/id.html","searchKeys":["id","val id: Long","com.squareup.tracing.TraceEvent.ObjectCreated.id"]},{"name":"val id: Long","description":"com.squareup.tracing.TraceEvent.ObjectDestroyed.id","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-destroyed/id.html","searchKeys":["id","val id: Long","com.squareup.tracing.TraceEvent.ObjectDestroyed.id"]},{"name":"val id: Long","description":"com.squareup.tracing.TraceEvent.ObjectSnapshot.id","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-snapshot/id.html","searchKeys":["id","val id: Long","com.squareup.tracing.TraceEvent.ObjectSnapshot.id"]},{"name":"val id: Long? = null","description":"com.squareup.tracing.TraceEvent.Counter.id","location":"trace-encoder/com.squareup.tracing/-trace-event/-counter/id.html","searchKeys":["id","val id: Long? = null","com.squareup.tracing.TraceEvent.Counter.id"]},{"name":"val name: String","description":"com.squareup.tracing.TraceEvent.AsyncDurationBegin.name","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-begin/name.html","searchKeys":["name","val name: String","com.squareup.tracing.TraceEvent.AsyncDurationBegin.name"]},{"name":"val name: String","description":"com.squareup.tracing.TraceEvent.AsyncDurationEnd.name","location":"trace-encoder/com.squareup.tracing/-trace-event/-async-duration-end/name.html","searchKeys":["name","val name: String","com.squareup.tracing.TraceEvent.AsyncDurationEnd.name"]},{"name":"val name: String","description":"com.squareup.tracing.TraceEvent.Counter.name","location":"trace-encoder/com.squareup.tracing/-trace-event/-counter/name.html","searchKeys":["name","val name: String","com.squareup.tracing.TraceEvent.Counter.name"]},{"name":"val name: String","description":"com.squareup.tracing.TraceEvent.DurationBegin.name","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-begin/name.html","searchKeys":["name","val name: String","com.squareup.tracing.TraceEvent.DurationBegin.name"]},{"name":"val name: String","description":"com.squareup.tracing.TraceEvent.DurationEnd.name","location":"trace-encoder/com.squareup.tracing/-trace-event/-duration-end/name.html","searchKeys":["name","val name: String","com.squareup.tracing.TraceEvent.DurationEnd.name"]},{"name":"val name: String","description":"com.squareup.tracing.TraceEvent.Instant.name","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/name.html","searchKeys":["name","val name: String","com.squareup.tracing.TraceEvent.Instant.name"]},{"name":"val objectType: String","description":"com.squareup.tracing.TraceEvent.ObjectCreated.objectType","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-created/object-type.html","searchKeys":["objectType","val objectType: String","com.squareup.tracing.TraceEvent.ObjectCreated.objectType"]},{"name":"val objectType: String","description":"com.squareup.tracing.TraceEvent.ObjectDestroyed.objectType","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-destroyed/object-type.html","searchKeys":["objectType","val objectType: String","com.squareup.tracing.TraceEvent.ObjectDestroyed.objectType"]},{"name":"val objectType: String","description":"com.squareup.tracing.TraceEvent.ObjectSnapshot.objectType","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-snapshot/object-type.html","searchKeys":["objectType","val objectType: String","com.squareup.tracing.TraceEvent.ObjectSnapshot.objectType"]},{"name":"val scope: TraceEvent.Instant.InstantScope","description":"com.squareup.tracing.TraceEvent.Instant.scope","location":"trace-encoder/com.squareup.tracing/-trace-event/-instant/scope.html","searchKeys":["scope","val scope: TraceEvent.Instant.InstantScope","com.squareup.tracing.TraceEvent.Instant.scope"]},{"name":"val series: Map","description":"com.squareup.tracing.TraceEvent.Counter.series","location":"trace-encoder/com.squareup.tracing/-trace-event/-counter/series.html","searchKeys":["series","val series: Map","com.squareup.tracing.TraceEvent.Counter.series"]},{"name":"val snapshot: Any","description":"com.squareup.tracing.TraceEvent.ObjectSnapshot.snapshot","location":"trace-encoder/com.squareup.tracing/-trace-event/-object-snapshot/snapshot.html","searchKeys":["snapshot","val snapshot: Any","com.squareup.tracing.TraceEvent.ObjectSnapshot.snapshot"]},{"name":"val WorkflowViewStateRenderer: ViewStateRenderer","description":"com.squareup.workflow1.ui.radiography.WorkflowViewStateRenderer","location":"workflow-ui/radiography/com.squareup.workflow1.ui.radiography/-workflow-view-state-renderer.html","searchKeys":["WorkflowViewStateRenderer","val WorkflowViewStateRenderer: ViewStateRenderer","com.squareup.workflow1.ui.radiography.WorkflowViewStateRenderer"]}] \ No newline at end of file diff --git a/kotlin/api/htmlMultiModule/trace-encoder/navigation.html b/kotlin/api/htmlMultiModule/trace-encoder/navigation.html index 00dff3f82..621255d84 100644 --- a/kotlin/api/htmlMultiModule/trace-encoder/navigation.html +++ b/kotlin/api/htmlMultiModule/trace-encoder/navigation.html @@ -777,29 +777,29 @@
com.squareup.workflow1.ui.compose
-
+ -
+ -
+ -
+ - -
+ + + + + + + -
+
WorkflowRendering()
@@ -832,7 +867,7 @@
com.squareup.workflow1.ui.compose.tooling
-
+
Preview()
@@ -887,97 +922,102 @@ renderWorkflowIn()
-
+ + -
+ -
+
- ScreenViewFactory + ScreenViewFactory
- -
+
- ScreenViewFactoryFinder + ScreenViewFactoryFinder
- -
+
- ScreenViewHolder + ScreenViewHolder
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
WorkflowViewStub
@@ -1197,92 +1237,102 @@ EnvironmentScreen
-
+ -
+
+
+ getFactoryFor() +
+
+ -
+ -
+ -
+ -
+ -
+ -
+
- ViewEnvironment + ViewEnvironment
- -
+ -
+
- ViewRegistry + ViewRegistry
-
+ -
+ +
+
+ Key +
+
-
+ -
+ -
+ -
+ -
+
Wrapper
diff --git a/kotlin/api/htmlMultiModule/workflow-config/config-android/navigation.html b/kotlin/api/htmlMultiModule/workflow-config/config-android/navigation.html index 00dff3f82..621255d84 100644 --- a/kotlin/api/htmlMultiModule/workflow-config/config-android/navigation.html +++ b/kotlin/api/htmlMultiModule/workflow-config/config-android/navigation.html @@ -777,29 +777,29 @@
com.squareup.workflow1.ui.compose
-
+ -
+ -
+ -
+ - -
+ + + + + + + -
+
WorkflowRendering()
@@ -832,7 +867,7 @@
com.squareup.workflow1.ui.compose.tooling
-
+
Preview()
@@ -887,97 +922,102 @@ renderWorkflowIn()
-
+ + -
+ -
+
- ScreenViewFactory + ScreenViewFactory
- -
+
- ScreenViewFactoryFinder + ScreenViewFactoryFinder
- -
+
- ScreenViewHolder + ScreenViewHolder
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
WorkflowViewStub
@@ -1197,92 +1237,102 @@ EnvironmentScreen
-
+ -
+
+
+ getFactoryFor() +
+
+ -
+ -
+ -
+ -
+ -
+ -
+
- ViewEnvironment + ViewEnvironment
- -
+ -
+
- ViewRegistry + ViewRegistry
-
+ -
+ +
+
+ Key +
+
-
+ -
+ -
+ -
+ -
+
Wrapper
diff --git a/kotlin/api/htmlMultiModule/workflow-config/config-jvm/navigation.html b/kotlin/api/htmlMultiModule/workflow-config/config-jvm/navigation.html index 00dff3f82..621255d84 100644 --- a/kotlin/api/htmlMultiModule/workflow-config/config-jvm/navigation.html +++ b/kotlin/api/htmlMultiModule/workflow-config/config-jvm/navigation.html @@ -777,29 +777,29 @@
com.squareup.workflow1.ui.compose
-
+ -
+ -
+ -
+ - -
+ + + + + + + -
+
WorkflowRendering()
@@ -832,7 +867,7 @@
com.squareup.workflow1.ui.compose.tooling
-
+
Preview()
@@ -887,97 +922,102 @@ renderWorkflowIn()
-
+ + -
+ -
+
- ScreenViewFactory + ScreenViewFactory
- -
+
- ScreenViewFactoryFinder + ScreenViewFactoryFinder
- -
+
- ScreenViewHolder + ScreenViewHolder
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
WorkflowViewStub
@@ -1197,92 +1237,102 @@ EnvironmentScreen
-
+ -
+
+
+ getFactoryFor() +
+
+ -
+ -
+ -
+ -
+ -
+ -
+
- ViewEnvironment + ViewEnvironment
- -
+ -
+
- ViewRegistry + ViewRegistry
-
+ -
+ +
+
+ Key +
+
-
+ -
+ -
+ -
+ -
+
Wrapper
diff --git a/kotlin/api/htmlMultiModule/workflow-core/navigation.html b/kotlin/api/htmlMultiModule/workflow-core/navigation.html index 00dff3f82..621255d84 100644 --- a/kotlin/api/htmlMultiModule/workflow-core/navigation.html +++ b/kotlin/api/htmlMultiModule/workflow-core/navigation.html @@ -777,29 +777,29 @@
com.squareup.workflow1.ui.compose
-
+ -
+ -
+ -
+ - -
+ + + + + + + -
+
WorkflowRendering()
@@ -832,7 +867,7 @@
com.squareup.workflow1.ui.compose.tooling
-
+
Preview()
@@ -887,97 +922,102 @@ renderWorkflowIn()
-
+ + -
+ -
+
- ScreenViewFactory + ScreenViewFactory
- -
+
- ScreenViewFactoryFinder + ScreenViewFactoryFinder
- -
+
- ScreenViewHolder + ScreenViewHolder
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
WorkflowViewStub
@@ -1197,92 +1237,102 @@ EnvironmentScreen
-
+ -
+
+
+ getFactoryFor() +
+
+ -
+ -
+ -
+ -
+ -
+ -
+
- ViewEnvironment + ViewEnvironment
- -
+ -
+
- ViewRegistry + ViewRegistry
-
+ -
+ +
+
+ Key +
+
-
+ -
+ -
+ -
+ -
+
Wrapper
diff --git a/kotlin/api/htmlMultiModule/workflow-runtime/navigation.html b/kotlin/api/htmlMultiModule/workflow-runtime/navigation.html index 00dff3f82..621255d84 100644 --- a/kotlin/api/htmlMultiModule/workflow-runtime/navigation.html +++ b/kotlin/api/htmlMultiModule/workflow-runtime/navigation.html @@ -777,29 +777,29 @@
com.squareup.workflow1.ui.compose
-
+ -
+ -
+ -
+ - -
+ + + + + + + -
+
WorkflowRendering()
@@ -832,7 +867,7 @@
com.squareup.workflow1.ui.compose.tooling
-
+
Preview()
@@ -887,97 +922,102 @@ renderWorkflowIn()
-
+ + -
+ -
+
- ScreenViewFactory + ScreenViewFactory
- -
+
- ScreenViewFactoryFinder + ScreenViewFactoryFinder
- -
+
- ScreenViewHolder + ScreenViewHolder
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
WorkflowViewStub
@@ -1197,92 +1237,102 @@ EnvironmentScreen
-
+ -
+
+
+ getFactoryFor() +
+
+ -
+ -
+ -
+ -
+ -
+ -
+
- ViewEnvironment + ViewEnvironment
- -
+ -
+
- ViewRegistry + ViewRegistry
-
+ -
+ +
+
+ Key +
+
-
+ -
+ -
+ -
+ -
+
Wrapper
diff --git a/kotlin/api/htmlMultiModule/workflow-rx2/navigation.html b/kotlin/api/htmlMultiModule/workflow-rx2/navigation.html index 00dff3f82..621255d84 100644 --- a/kotlin/api/htmlMultiModule/workflow-rx2/navigation.html +++ b/kotlin/api/htmlMultiModule/workflow-rx2/navigation.html @@ -777,29 +777,29 @@
com.squareup.workflow1.ui.compose
-
+ -
+ -
+ -
+ - -
+ + + + + + + -
+
WorkflowRendering()
@@ -832,7 +867,7 @@
com.squareup.workflow1.ui.compose.tooling
-
+
Preview()
@@ -887,97 +922,102 @@ renderWorkflowIn()
-
+ + -
+ -
+
- ScreenViewFactory + ScreenViewFactory
- -
+
- ScreenViewFactoryFinder + ScreenViewFactoryFinder
- -
+
- ScreenViewHolder + ScreenViewHolder
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
WorkflowViewStub
@@ -1197,92 +1237,102 @@ EnvironmentScreen
-
+ -
+
+
+ getFactoryFor() +
+
+ -
+ -
+ -
+ -
+ -
+ -
+
- ViewEnvironment + ViewEnvironment
- -
+ -
+
- ViewRegistry + ViewRegistry
-
+ -
+ +
+
+ Key +
+
-
+ -
+ -
+ -
+ -
+
Wrapper
diff --git a/kotlin/api/htmlMultiModule/workflow-testing/navigation.html b/kotlin/api/htmlMultiModule/workflow-testing/navigation.html index 00dff3f82..621255d84 100644 --- a/kotlin/api/htmlMultiModule/workflow-testing/navigation.html +++ b/kotlin/api/htmlMultiModule/workflow-testing/navigation.html @@ -777,29 +777,29 @@
com.squareup.workflow1.ui.compose
-
+ -
+ -
+ -
+ - -
+ + + + + + + -
+
WorkflowRendering()
@@ -832,7 +867,7 @@
com.squareup.workflow1.ui.compose.tooling
-
+
Preview()
@@ -887,97 +922,102 @@ renderWorkflowIn()
-
+ + -
+ -
+
- ScreenViewFactory + ScreenViewFactory
- -
+
- ScreenViewFactoryFinder + ScreenViewFactoryFinder
- -
+
- ScreenViewHolder + ScreenViewHolder
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
WorkflowViewStub
@@ -1197,92 +1237,102 @@ EnvironmentScreen
-
+ -
+
+
+ getFactoryFor() +
+
+ -
+ -
+ -
+ -
+ -
+ -
+
- ViewEnvironment + ViewEnvironment
- -
+ -
+
- ViewRegistry + ViewRegistry
-
+ -
+ +
+
+ Key +
+
-
+ -
+ -
+ -
+ -
+
Wrapper
diff --git a/kotlin/api/htmlMultiModule/workflow-tracing/navigation.html b/kotlin/api/htmlMultiModule/workflow-tracing/navigation.html index 00dff3f82..621255d84 100644 --- a/kotlin/api/htmlMultiModule/workflow-tracing/navigation.html +++ b/kotlin/api/htmlMultiModule/workflow-tracing/navigation.html @@ -777,29 +777,29 @@
com.squareup.workflow1.ui.compose
-
+ -
+ -
+ -
+ - -
+ + + + + + + -
+
WorkflowRendering()
@@ -832,7 +867,7 @@
com.squareup.workflow1.ui.compose.tooling
-
+
Preview()
@@ -887,97 +922,102 @@ renderWorkflowIn()
-
+ + -
+ -
+
- ScreenViewFactory + ScreenViewFactory
- -
+
- ScreenViewFactoryFinder + ScreenViewFactoryFinder
- -
+
- ScreenViewHolder + ScreenViewHolder
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
WorkflowViewStub
@@ -1197,92 +1237,102 @@ EnvironmentScreen
-
+ -
+
+
+ getFactoryFor() +
+
+ -
+ -
+ -
+ -
+ -
+ -
+
- ViewEnvironment + ViewEnvironment
- -
+ -
+
- ViewRegistry + ViewRegistry
-
+ -
+ +
+
+ Key +
+
-
+ -
+ -
+ -
+ -
+
Wrapper
diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose-tooling/com.squareup.workflow1.ui.compose.tooling/-preview.html b/kotlin/api/htmlMultiModule/workflow-ui/compose-tooling/com.squareup.workflow1.ui.compose.tooling/-preview.html index ffe8b43ee..64299cf26 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/compose-tooling/com.squareup.workflow1.ui.compose.tooling/-preview.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose-tooling/com.squareup.workflow1.ui.compose.tooling/-preview.html @@ -58,12 +58,23 @@
-
+
workflow-ui-compose-tooling/com.squareup.workflow1.ui.compose.tooling/Preview

Preview

-
@WorkflowUiExperimentalApi
@Composable
fun <RenderingT : Screen> ScreenViewFactory<RenderingT>.Preview(rendering: RenderingT, modifier: Modifier = Modifier, placeholderModifier: Modifier = Modifier, viewEnvironmentUpdater: (ViewEnvironment) -> ViewEnvironment? = null)

Draws this ScreenViewFactory using a special preview ScreenViewFactoryFinder.

Use inside @Preview Composable functions.

Note: rendering must be the same type as this ScreenViewFactory, even though the type system does not enforce this constraint. This is due to a Compose compiler bug tracked here.

Parameters

modifier

Modifier that will be applied to this ScreenViewFactory.

placeholderModifier

Modifier that will be applied to any nested renderings this factory shows.

viewEnvironmentUpdater

Function that configures the ViewEnvironment passed to this factory.

+
@WorkflowUiExperimentalApi
@Composable
fun Screen.Preview(modifier: Modifier = Modifier, placeholderModifier: Modifier = Modifier, viewEnvironmentUpdater: (ViewEnvironment) -> ViewEnvironment? = null)

Uses ScreenComposableFactory.Preview or ScreenViewFactory.Preview to draw the receiving Screen.

Note that this function can preview any kind of Screen, whether it's bound to UI code implemented via Compose or classic View code.

Use inside @Preview Composable functions:

@Preview(heightDp = 150, showBackground = true)
+@Composable
+fun HelloPreview() {
+  HelloScreen(
+    "Hello!",
+    onClick = {}
+  ).Preview()
+}
Content copied to clipboard
@WorkflowUiExperimentalApi
@Composable
fun <RenderingT : Screen> ScreenComposableFactory<RenderingT>.Preview(rendering: RenderingT, modifier: Modifier = Modifier, placeholderModifier: Modifier = Modifier, viewEnvironmentUpdater: (ViewEnvironment) -> ViewEnvironment? = null)

Draws this ScreenComposableFactory using a special preview ScreenComposableFactoryFinder.

Use inside @Preview Composable functions:

@Preview(heightDp = 150, showBackground = true)
+@Composable
+fun DrawHelloRenderingPreview() {
+  HelloBinding.Preview(HelloScreen("Hello!", onClick = {}))
+}
Content copied to clipboard

Note: rendering must be the same type as this ScreenComposableFactory, even though the type system does not enforce this constraint. This is due to a Compose compiler bug tracked here.

Parameters

modifier

Modifier that will be applied to this ScreenComposableFactory.

placeholderModifier

Modifier that will be applied to any nested renderings this factory shows.

viewEnvironmentUpdater

Function that configures the ViewEnvironment passed to this factory.

@WorkflowUiExperimentalApi
@Composable
fun <RenderingT : Screen> ScreenViewFactory<RenderingT>.Preview(rendering: RenderingT, modifier: Modifier = Modifier, placeholderModifier: Modifier = Modifier, viewEnvironmentUpdater: (ViewEnvironment) -> ViewEnvironment? = null)

Like ScreenComposableFactory.Preview, but for non-Compose ScreenViewFactory instances. Yes, you can preview classic View code this way.

Use inside @Preview Composable functions.

Note: rendering must be the same type as this ScreenViewFactory, even though the type system does not enforce this constraint. This is due to a Compose compiler bug tracked here.

Parameters

modifier

Modifier that will be applied to this ScreenViewFactory.

placeholderModifier

Modifier that will be applied to any nested renderings this factory shows.

viewEnvironmentUpdater

Function that configures the ViewEnvironment passed to this factory.

© 2024 CopyrightGenerated by dokka diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose-tooling/com.squareup.workflow1.ui.compose.tooling/index.html b/kotlin/api/htmlMultiModule/workflow-ui/compose-tooling/com.squareup.workflow1.ui.compose.tooling/index.html index a6d21c15d..968fee99d 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/compose-tooling/com.squareup.workflow1.ui.compose.tooling/index.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose-tooling/com.squareup.workflow1.ui.compose.tooling/index.html @@ -68,17 +68,17 @@

Package-level declaratio

Functions

-
+
- +
Link copied to clipboard
-
@WorkflowUiExperimentalApi
@Composable
fun <RenderingT : Screen> ScreenViewFactory<RenderingT>.Preview(rendering: RenderingT, modifier: Modifier = Modifier, placeholderModifier: Modifier = Modifier, viewEnvironmentUpdater: (ViewEnvironment) -> ViewEnvironment? = null)

Draws this ScreenViewFactory using a special preview ScreenViewFactoryFinder.

+
@WorkflowUiExperimentalApi
@Composable
fun Screen.Preview(modifier: Modifier = Modifier, placeholderModifier: Modifier = Modifier, viewEnvironmentUpdater: (ViewEnvironment) -> ViewEnvironment? = null)

Uses ScreenComposableFactory.Preview or ScreenViewFactory.Preview to draw the receiving Screen.

@WorkflowUiExperimentalApi
@Composable
fun <RenderingT : Screen> ScreenViewFactory<RenderingT>.Preview(rendering: RenderingT, modifier: Modifier = Modifier, placeholderModifier: Modifier = Modifier, viewEnvironmentUpdater: (ViewEnvironment) -> ViewEnvironment? = null)

Like ScreenComposableFactory.Preview, but for non-Compose ScreenViewFactory instances. Yes, you can preview classic View code this way.

@WorkflowUiExperimentalApi
@Composable
fun <RenderingT : Screen> ScreenComposableFactory<RenderingT>.Preview(rendering: RenderingT, modifier: Modifier = Modifier, placeholderModifier: Modifier = Modifier, viewEnvironmentUpdater: (ViewEnvironment) -> ViewEnvironment? = null)

Draws this ScreenComposableFactory using a special preview ScreenComposableFactoryFinder.

diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose-tooling/navigation.html b/kotlin/api/htmlMultiModule/workflow-ui/compose-tooling/navigation.html index 00dff3f82..621255d84 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/compose-tooling/navigation.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose-tooling/navigation.html @@ -777,29 +777,29 @@
com.squareup.workflow1.ui.compose
-
+ -
+ -
+ -
+ - -
+ + + + + + + -
+
WorkflowRendering()
@@ -832,7 +867,7 @@
com.squareup.workflow1.ui.compose.tooling
-
+
Preview()
@@ -887,97 +922,102 @@ renderWorkflowIn()
-
+ + -
+ -
+
- ScreenViewFactory + ScreenViewFactory
- -
+
- ScreenViewFactoryFinder + ScreenViewFactoryFinder
- -
+
- ScreenViewHolder + ScreenViewHolder
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
WorkflowViewStub
@@ -1197,92 +1237,102 @@ EnvironmentScreen
-
+ -
+
+
+ getFactoryFor() +
+
+ -
+ -
+ -
+ -
+ -
+ -
+
- ViewEnvironment + ViewEnvironment
- -
+ -
+
- ViewRegistry + ViewRegistry
-
+ -
+ +
+
+ Key +
+
-
+ -
+ -
+ -
+ -
+
Wrapper
diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-compose-screen/index.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-compose-screen/index.html index d97cc6949..e5c806c9c 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-compose-screen/index.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-compose-screen/index.html @@ -62,30 +62,22 @@
workflow-ui-compose/com.squareup.workflow1.ui.compose/ComposeScreen

ComposeScreen

-
@WorkflowUiExperimentalApi
interface ComposeScreen : AndroidScreen<Nothing>

Interface implemented by a rendering class to allow it to drive a composable UI via an appropriate ComposeScreenViewFactory implementation, by simply overriding the Content method. This is the compose analog to AndroidScreen.

Note that unlike most workflow view functions, Content does not take the rendering as a parameter. Instead, the rendering is the receiver, i.e. the current value of this.

Example:

@OptIn(WorkflowUiExperimentalApi::class)
data class HelloView(
  val message: String,
  val onClick: () -> Unit
) : ComposeScreen {

  @Composable override fun Content(viewEnvironment: ViewEnvironment) {
    Button(onClick) {
      Text(message)
    }
  }
}
Content copied to clipboard

This is the simplest way to bridge the gap between your workflows and the UI, but using it requires your workflows code to reside in Android modules, instead of pure Kotlin. If this is a problem, or you need more flexibility for any other reason, you can use ViewRegistry to bind your renderings to ComposeScreenViewFactory implementations at runtime.

+
@WorkflowUiExperimentalApi
interface ComposeScreen : Screen

Interface implemented by a rendering class to allow it to drive a composable UI via an appropriate ScreenComposableFactory implementation, by simply overriding the Content method.

Note that it is generally an error for a Workflow to declare ComposeScreen as its RenderingT type -- prefer Screen for that. ComposeScreen, like AndroidScreen, is strictly a possible implementation detail of Screen. It is a convenience to minimize the boilerplate required to set up a ScreenComposableFactory. That interface is the fundamental unit of Compose tooling for Workflow UI. But in day to day use, most developer will work with ComposeScreen and be only vaguely aware of the existence of ScreenComposableFactory, so the bulk of our description of working with Compose is here.

NB: A Workflow app that relies on Compose must call withComposeInteropSupport on its top-level ViewEnvironment. See that function for details.

Note that unlike most workflow view functions, Content does not take the rendering as a parameter. Instead, the rendering is the receiver, i.e. the current value of this.

Example:

@OptIn(WorkflowUiExperimentalApi::class)
+data class HelloScreen(
+  val message: String,
+  val onClick: () -> Unit
+) : ComposeScreen {
+
+  @Composable override fun Content(viewEnvironment: ViewEnvironment) {
+    Button(onClick) {
+      Text(message)
+    }
+  }
+}
Content copied to clipboard

This is the simplest way to bridge the gap between your workflows and the UI, but using it requires your workflows code to reside in Android modules and depend upon the Compose runtime, instead of being pure Kotlin. If this is a problem, or you need more flexibility for any other reason, you can use ViewRegistry to bind your renderings to ScreenComposableFactory implementations at runtime.

Nesting child renderings

Workflows can render other workflows, and renderings from one workflow can contain renderings from other workflows. These renderings may all be bound to their own UI factories. A classic ScreenViewFactory can use WorkflowViewStub to recursively show nested renderings.

Compose-based UI may also show nested renderings. Doing so is as simple as calling WorkflowRendering and passing in the nested rendering. See the kdoc on that function for an example.

Nested renderings will have access to any composition locals defined in outer composable, even if there are legacy views in between them, as long as the ViewEnvironment is propagated continuously between the two factories.

Initializing Compose context (Theming)

Often all the ScreenComposableFactory factories in an app need to share some context – for example, certain composition locals need to be provided, such as MaterialTheme. To configure this shared context, call withCompositionRoot on your top-level ViewEnvironment. The first time a ScreenComposableFactory is used to show a rendering, its Content function will be wrapped with the CompositionRoot. See the documentation on CompositionRoot for more information.

-
-

Properties

-
-
-
-
- - -
Link copied to clipboard
-
-
-
-
open override val viewFactory: ScreenViewFactory<Nothing>

Don't override this, override Content instead.

-
-
-
-
-
-

Functions

diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-composition-root/index.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-composition-root/index.html index cc823ac66..0c140ff98 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-composition-root/index.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-composition-root/index.html @@ -62,7 +62,7 @@
workflow-ui-compose/com.squareup.workflow1.ui.compose/CompositionRoot

CompositionRoot

-
typealias CompositionRoot = @Composable (content: @Composable () -> Unit) -> Unit

A composable function that will be used to wrap the first (highest-level) composeScreenViewFactory view factory in a composition. This can be used to setup any composition locals that all composeScreenViewFactory factories need access to, such as UI themes.

This function will called once, to wrap the highest-level composeScreenViewFactory in the tree. However, composition locals are propagated down to child composeScreenViewFactory compositions, so any locals provided here will be available in all composeScreenViewFactory compositions.

+
typealias CompositionRoot = @Composable (content: @Composable () -> Unit) -> Unit

A composable function that will be used to wrap the first (highest-level) ScreenComposableFactory view factory in a composition. This can be used to setup any composition locals that all ScreenComposableFactory factories need access to, such as UI themes.

This function will called once, to wrap the highest-level ScreenComposableFactory in the tree. However, composition locals are propagated down to child ScreenComposableFactory compositions, so any locals provided here will be available in all ScreenComposableFactory compositions.

diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory-finder/-companion/default.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory-finder/-companion/default.html new file mode 100644 index 000000000..9f0f0501a --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory-finder/-companion/default.html @@ -0,0 +1,76 @@ + + + + + default + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-compose/com.squareup.workflow1.ui.compose/ScreenComposableFactoryFinder/Companion/default
+
+

default

+
+
open override val default: ScreenComposableFactoryFinder
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory-finder/-companion/index.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory-finder/-companion/index.html new file mode 100644 index 000000000..6158b72f9 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory-finder/-companion/index.html @@ -0,0 +1,149 @@ + + + + + Companion + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-compose/com.squareup.workflow1.ui.compose/ScreenComposableFactoryFinder/Companion
+
+

Companion

+
object Companion : ViewEnvironmentKey<ScreenComposableFactoryFinder>
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override val default: ScreenComposableFactoryFinder
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+ +
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
operator override fun equals(other: Any?): Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
override fun hashCode(): Int
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory-finder/get-composable-factory-for-rendering.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory-finder/get-composable-factory-for-rendering.html new file mode 100644 index 000000000..9d00100f7 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory-finder/get-composable-factory-for-rendering.html @@ -0,0 +1,76 @@ + + + + + getComposableFactoryForRendering + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-compose/com.squareup.workflow1.ui.compose/ScreenComposableFactoryFinder/getComposableFactoryForRendering
+
+

getComposableFactoryForRendering

+
+
open fun <ScreenT : Screen> getComposableFactoryForRendering(environment: ViewEnvironment, rendering: ScreenT): ScreenComposableFactory<ScreenT>?
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory-finder/index.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory-finder/index.html new file mode 100644 index 000000000..a461c6846 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory-finder/index.html @@ -0,0 +1,149 @@ + + + + + ScreenComposableFactoryFinder + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-compose/com.squareup.workflow1.ui.compose/ScreenComposableFactoryFinder
+
+

ScreenComposableFactoryFinder

+
@WorkflowUiExperimentalApi
interface ScreenComposableFactoryFinder
+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+ +
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+ +
+
+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@WorkflowUiExperimentalApi
fun ScreenComposableFactoryFinder.withCompositionRoot(root: CompositionRoot): ScreenComposableFactoryFinder

Returns a ScreenViewFactoryFinder that ensures that any ScreenComposableFactory factories registered in this registry will be wrapped exactly once with a CompositionRoot wrapper. See CompositionRoot for more information.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory.html new file mode 100644 index 000000000..b312a5157 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory.html @@ -0,0 +1,76 @@ + + + + + ScreenComposableFactory + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-compose/com.squareup.workflow1.ui.compose/ScreenComposableFactory
+
+

ScreenComposableFactory

+
+
@WorkflowUiExperimentalApi
inline fun <ScreenT : Screen> ScreenComposableFactory(noinline content: @Composable (rendering: ScreenT, environment: ViewEnvironment) -> Unit): ScreenComposableFactory<ScreenT>
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory/-content.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory/-content.html new file mode 100644 index 000000000..8d7898f47 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory/-content.html @@ -0,0 +1,76 @@ + + + + + Content + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-compose/com.squareup.workflow1.ui.compose/ScreenComposableFactory/Content
+
+

Content

+
+
@Composable
abstract fun Content(rendering: ScreenT, environment: ViewEnvironment)

The composable content of this ScreenComposableFactory. This method will be called any time rendering or environment change. It is the Compose-based analogue of ScreenViewRunner.showRendering.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory/index.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory/index.html new file mode 100644 index 000000000..4e4dbf5a1 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory/index.html @@ -0,0 +1,158 @@ + + + + + ScreenComposableFactory + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-compose/com.squareup.workflow1.ui.compose/ScreenComposableFactory
+
+

ScreenComposableFactory

+
@WorkflowUiExperimentalApi
interface ScreenComposableFactory<in ScreenT : Screen> : ViewRegistry.Entry<ScreenT>

A ViewRegistry.Entry that uses a Composable function to display ScreenT. This is the fundamental unit of Compose tooling in Workflow UI, the Compose analogue of ScreenViewFactory.

ScreenComposableFactory is also a bit cumbersome to use directly, so ComposeScreen is provided as a convenience. Most developers will have no reason to work with ScreenComposableFactory directly, or even be aware of it.

Use ScreenComposableFactory directly if you need to prevent your Screen rendering classes from depending on Compose at compile time.

Example:

val fooComposableFactory = ScreenComposableFactory { screen, _ ->
+  Text(screen.message)
+}
+
+val viewRegistry = ViewRegistry(fooComposableFactory, …)
+val viewEnvironment = ViewEnvironment.EMPTY + viewRegistry
+
+renderWorkflowIn(
+  workflow = MyWorkflow.mapRendering { it.withEnvironment(viewEnvironment) }
+)
Content copied to clipboard
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override val key: ViewRegistry.Key<ScreenT, ScreenComposableFactory<*>>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
abstract val type: KClass<in ScreenT>
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+ +
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Composable
abstract fun Content(rendering: ScreenT, environment: ViewEnvironment)

The composable content of this ScreenComposableFactory. This method will be called any time rendering or environment change. It is the Compose-based analogue of ScreenViewRunner.showRendering.

+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory/key.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory/key.html new file mode 100644 index 000000000..63736bc51 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory/key.html @@ -0,0 +1,76 @@ + + + + + key + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-compose/com.squareup.workflow1.ui.compose/ScreenComposableFactory/key
+
+

key

+
+
open override val key: ViewRegistry.Key<ScreenT, ScreenComposableFactory<*>>
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory/type.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory/type.html new file mode 100644 index 000000000..fb86d3bbc --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/-screen-composable-factory/type.html @@ -0,0 +1,76 @@ + + + + + type + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-compose/com.squareup.workflow1.ui.compose/ScreenComposableFactory/type
+
+

type

+
+
abstract val type: KClass<in ScreenT>
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/as-composable-factory.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/as-composable-factory.html new file mode 100644 index 000000000..194608f20 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/as-composable-factory.html @@ -0,0 +1,76 @@ + + + + + asComposableFactory + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-compose/com.squareup.workflow1.ui.compose/asComposableFactory
+
+

asComposableFactory

+
+
@WorkflowUiExperimentalApi
fun <ScreenT : Screen> ScreenViewFactory<ScreenT>.asComposableFactory(): ScreenComposableFactory<ScreenT>

Convert a ScreenViewFactory to a ScreenComposableFactory, using AndroidView to host the View it builds.

It is unusual to use this function directly, it is mainly an implementation detail of ViewEnvironment.withComposeInteropSupport.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/as-view-factory.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/as-view-factory.html new file mode 100644 index 000000000..a70f67603 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/as-view-factory.html @@ -0,0 +1,76 @@ + + + + + asViewFactory + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-compose/com.squareup.workflow1.ui.compose/asViewFactory
+
+

asViewFactory

+
+
@WorkflowUiExperimentalApi
fun <ScreenT : Screen> ScreenComposableFactory<ScreenT>.asViewFactory(): ScreenViewFactory<ScreenT>

Convert a ScreenComposableFactory into a ScreenViewFactory by using a ComposeView to host ScreenComposableFactory.Content.

It is unusual to use this function directly, it is mainly an implementation detail of ViewEnvironment.withComposeInteropSupport.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/index.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/index.html index fd1096389..f3e9ffb89 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/index.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/index.html @@ -78,37 +78,52 @@

Types

-
@WorkflowUiExperimentalApi
interface ComposeScreen : AndroidScreen<Nothing>

Interface implemented by a rendering class to allow it to drive a composable UI via an appropriate ComposeScreenViewFactory implementation, by simply overriding the Content method. This is the compose analog to AndroidScreen.

+
@WorkflowUiExperimentalApi
interface ComposeScreen : Screen

Interface implemented by a rendering class to allow it to drive a composable UI via an appropriate ScreenComposableFactory implementation, by simply overriding the Content method.

- +
- - + +
Link copied to clipboard
-
@WorkflowUiExperimentalApi
abstract class ComposeScreenViewFactory<RenderingT : Screen> : ScreenViewFactory<RenderingT>

A ScreenViewFactory that uses a Composable function to display the rendering. It is the Compose-based analogue of ScreenViewRunner.

+
typealias CompositionRoot = @Composable (content: @Composable () -> Unit) -> Unit

A composable function that will be used to wrap the first (highest-level) ScreenComposableFactory view factory in a composition. This can be used to setup any composition locals that all ScreenComposableFactory factories need access to, such as UI themes.

- +
- - + + +
Link copied to clipboard
+
+
+
+
@WorkflowUiExperimentalApi
interface ScreenComposableFactory<in ScreenT : Screen> : ViewRegistry.Entry<ScreenT>

A ViewRegistry.Entry that uses a Composable function to display ScreenT. This is the fundamental unit of Compose tooling in Workflow UI, the Compose analogue of ScreenViewFactory.

+
+
+
+
+ +
+
+
+ +
Link copied to clipboard
-
typealias CompositionRoot = @Composable (content: @Composable () -> Unit) -> Unit

A composable function that will be used to wrap the first (highest-level) composeScreenViewFactory view factory in a composition. This can be used to setup any composition locals that all composeScreenViewFactory factories need access to, such as UI themes.

+
@WorkflowUiExperimentalApi
interface ScreenComposableFactoryFinder
@@ -117,7 +132,22 @@

Types

Functions

-
+
+
+
+
+ + +
Link copied to clipboard
+
+ +
+
+
@@ -132,6 +162,21 @@

Functions

+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
@@ -147,47 +192,92 @@

Functions

- + +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Composable
fun <PropsT, OutputT : Any, RenderingT> Workflow<PropsT, OutputT, RenderingT>.renderAsState(props: PropsT, interceptors: List<WorkflowInterceptor> = emptyList(), scope: CoroutineScope = rememberCoroutineScope(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit): State<RenderingT>

Runs this Workflow as long as this composable is part of the composition, and returns a State object that will be updated whenever the runtime emits a new RenderingT. Note that here, and in the rest of the documentation for this class, the "State" type refers to Compose's snapshot State type, not the concept of the StateT type in a particular workflow.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
+
- - + +
Link copied to clipboard
-
@WorkflowUiExperimentalApi
inline fun <RenderingT : Screen> composeScreenViewFactory(noinline content: @Composable (rendering: RenderingT, environment: ViewEnvironment) -> Unit): ScreenViewFactory<RenderingT>

Creates a ScreenViewFactory that uses a Composable function to display the rendering.

+
@WorkflowUiExperimentalApi
inline fun <ScreenT : Screen> ScreenComposableFactory(noinline content: @Composable (rendering: ScreenT, environment: ViewEnvironment) -> Unit): ScreenComposableFactory<ScreenT>
- +
- - + +
Link copied to clipboard
-
@Composable
fun <PropsT, OutputT : Any, RenderingT> Workflow<PropsT, OutputT, RenderingT>.renderAsState(props: PropsT, interceptors: List<WorkflowInterceptor> = emptyList(), scope: CoroutineScope = rememberCoroutineScope(), runtimeConfig: RuntimeConfig = RuntimeConfigOptions.DEFAULT_CONFIG, onOutput: suspend (OutputT) -> Unit): State<RenderingT>

Runs this Workflow as long as this composable is part of the composition, and returns a State object that will be updated whenever the runtime emits a new RenderingT. Note that here, and in the rest of the documentation for this class, the "State" type refers to Compose's snapshot State type, not the concept of the StateT type in a particular workflow.

+
@WorkflowUiExperimentalApi
fun <ScreenT : Screen> ScreenT.toComposableFactory(environment: ViewEnvironment): ScreenComposableFactory<ScreenT>

It is rare to call this method directly. Instead the most common path is to pass Screen instances to WorkflowRendering, which will apply the ScreenComposableFactory and ScreenComposableFactoryFinder machinery for you.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@WorkflowUiExperimentalApi
fun ViewEnvironment.withComposeInteropSupport(): ViewEnvironment

Replaces the ScreenComposableFactoryFinder and ScreenViewFactoryFinder found in the receiving ViewEnvironment with wrappers that are able to delegate from one platform to the other. Required to allow WorkflowViewStub to handle renderings bound to @Composable functions, and to allow WorkflowRendering to handle renderings bound to ScreenViewFactory.

- +
- +
Link copied to clipboard
-
@WorkflowUiExperimentalApi
fun ScreenViewFactoryFinder.withCompositionRoot(root: CompositionRoot): ScreenViewFactoryFinder

Returns a ScreenViewFactoryFinder that ensures that any composeScreenViewFactory factories registered in this registry will be wrapped exactly once with a CompositionRoot wrapper. See CompositionRoot for more information.

@WorkflowUiExperimentalApi
fun ViewEnvironment.withCompositionRoot(root: CompositionRoot): ViewEnvironment

Convenience function for applying a CompositionRoot to this ViewEnvironment's ScreenViewFactoryFinder. See ScreenViewFactoryFinder.withCompositionRoot.

+
@WorkflowUiExperimentalApi
fun ViewEnvironment.withCompositionRoot(root: CompositionRoot): ViewEnvironment

Convenience function for applying a CompositionRoot to this ViewEnvironment's ScreenComposableFactoryFinder. See ScreenComposableFactoryFinder.withCompositionRoot.

@WorkflowUiExperimentalApi
fun ScreenComposableFactoryFinder.withCompositionRoot(root: CompositionRoot): ScreenComposableFactoryFinder

Returns a ScreenViewFactoryFinder that ensures that any ScreenComposableFactory factories registered in this registry will be wrapped exactly once with a CompositionRoot wrapper. See CompositionRoot for more information.

diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/require-composable-factory-for-rendering.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/require-composable-factory-for-rendering.html new file mode 100644 index 000000000..c347f462f --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/require-composable-factory-for-rendering.html @@ -0,0 +1,76 @@ + + + + + requireComposableFactoryForRendering + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-compose/com.squareup.workflow1.ui.compose/requireComposableFactoryForRendering
+
+

requireComposableFactoryForRendering

+
+
@WorkflowUiExperimentalApi
fun <ScreenT : Screen> ScreenComposableFactoryFinder.requireComposableFactoryForRendering(environment: ViewEnvironment, rendering: ScreenT): ScreenComposableFactory<ScreenT>
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/to-composable-factory.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/to-composable-factory.html new file mode 100644 index 000000000..e16b800f5 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/to-composable-factory.html @@ -0,0 +1,76 @@ + + + + + toComposableFactory + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-compose/com.squareup.workflow1.ui.compose/toComposableFactory
+
+

toComposableFactory

+
+
@WorkflowUiExperimentalApi
fun <ScreenT : Screen> ScreenT.toComposableFactory(environment: ViewEnvironment): ScreenComposableFactory<ScreenT>

It is rare to call this method directly. Instead the most common path is to pass Screen instances to WorkflowRendering, which will apply the ScreenComposableFactory and ScreenComposableFactoryFinder machinery for you.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/with-compose-interop-support.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/with-compose-interop-support.html new file mode 100644 index 000000000..890876406 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/with-compose-interop-support.html @@ -0,0 +1,76 @@ + + + + + withComposeInteropSupport + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-compose/com.squareup.workflow1.ui.compose/withComposeInteropSupport
+
+

withComposeInteropSupport

+
+
@WorkflowUiExperimentalApi
fun ViewEnvironment.withComposeInteropSupport(): ViewEnvironment

Replaces the ScreenComposableFactoryFinder and ScreenViewFactoryFinder found in the receiving ViewEnvironment with wrappers that are able to delegate from one platform to the other. Required to allow WorkflowViewStub to handle renderings bound to @Composable functions, and to allow WorkflowRendering to handle renderings bound to ScreenViewFactory.

Note that the standard navigation related Screen types (e.g. BackStackScreen) are mainly bound to View-based implementations. Until that changes, effectively every Compose-based app must call this method.

App-specific customizations of ScreenComposableFactoryFinder and ScreenViewFactoryFinder must be placed in the ViewEnvironment before calling this method.

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/with-composition-root.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/with-composition-root.html index b1fd51b47..3d4d35179 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/with-composition-root.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/com.squareup.workflow1.ui.compose/with-composition-root.html @@ -63,7 +63,7 @@

withCompositionRoot

-
@WorkflowUiExperimentalApi
fun ViewEnvironment.withCompositionRoot(root: CompositionRoot): ViewEnvironment

Convenience function for applying a CompositionRoot to this ViewEnvironment's ScreenViewFactoryFinder. See ScreenViewFactoryFinder.withCompositionRoot.

@WorkflowUiExperimentalApi
fun ScreenViewFactoryFinder.withCompositionRoot(root: CompositionRoot): ScreenViewFactoryFinder

Returns a ScreenViewFactoryFinder that ensures that any composeScreenViewFactory factories registered in this registry will be wrapped exactly once with a CompositionRoot wrapper. See CompositionRoot for more information.

+
@WorkflowUiExperimentalApi
fun ViewEnvironment.withCompositionRoot(root: CompositionRoot): ViewEnvironment

Convenience function for applying a CompositionRoot to this ViewEnvironment's ScreenComposableFactoryFinder. See ScreenComposableFactoryFinder.withCompositionRoot.

@WorkflowUiExperimentalApi
fun ScreenComposableFactoryFinder.withCompositionRoot(root: CompositionRoot): ScreenComposableFactoryFinder

Returns a ScreenViewFactoryFinder that ensures that any ScreenComposableFactory factories registered in this registry will be wrapped exactly once with a CompositionRoot wrapper. See CompositionRoot for more information.

© 2024 CopyrightGenerated by dokka diff --git a/kotlin/api/htmlMultiModule/workflow-ui/compose/navigation.html b/kotlin/api/htmlMultiModule/workflow-ui/compose/navigation.html index 00dff3f82..621255d84 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/compose/navigation.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/compose/navigation.html @@ -777,29 +777,29 @@
com.squareup.workflow1.ui.compose
-
+ -
+ -
+ -
+ - -
+ + + + + + + -
+
WorkflowRendering()
@@ -832,7 +867,7 @@
com.squareup.workflow1.ui.compose.tooling
-
+
Preview()
@@ -887,97 +922,102 @@ renderWorkflowIn()
-
+ + -
+ -
+
- ScreenViewFactory + ScreenViewFactory
- -
+
- ScreenViewFactoryFinder + ScreenViewFactoryFinder
- -
+
- ScreenViewHolder + ScreenViewHolder
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
WorkflowViewStub
@@ -1197,92 +1237,102 @@ EnvironmentScreen
-
+ -
+
+
+ getFactoryFor() +
+
+ -
+ -
+ -
+ -
+ -
+ -
+
- ViewEnvironment + ViewEnvironment
- -
+ -
+
- ViewRegistry + ViewRegistry
-
+ -
+ +
+
+ Key +
+
-
+ -
+ -
+ -
+ -
+
Wrapper
diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/index.html b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/index.html index dc308a545..deb917e1b 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/index.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/index.html @@ -96,17 +96,32 @@

Types

Properties

-
+
- - + +
Link copied to clipboard
-
abstract val type: KClass<in OverlayT>
+
open override val key: ViewRegistry.Key<OverlayT, *>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
abstract val type: KClass<in OverlayT>
diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/key.html b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/key.html new file mode 100644 index 000000000..3dc2ac1bd --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/key.html @@ -0,0 +1,76 @@ + + + + + key + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-core-android/com.squareup.workflow1.ui.navigation/OverlayDialogFactory/key
+
+

key

+
+
open override val key: ViewRegistry.Key<OverlayT, *>
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/type.html b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/type.html new file mode 100644 index 000000000..f755caf19 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui.navigation/-overlay-dialog-factory/type.html @@ -0,0 +1,76 @@ + + + + + type + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-core-android/com.squareup.workflow1.ui.navigation/OverlayDialogFactory/type
+
+

type

+
+
abstract val type: KClass<in OverlayT>
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-android-screen/index.html b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-android-screen/index.html index d7d7489a9..113ed5652 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-android-screen/index.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-android-screen/index.html @@ -62,7 +62,7 @@
workflow-ui-core-android/com.squareup.workflow1.ui/AndroidScreen

AndroidScreen

-
@WorkflowUiExperimentalApi
interface AndroidScreen<S : AndroidScreen<S>> : Screen

Interface implemented by a rendering class to allow it to drive an Android UI via an appropriate ScreenViewFactory implementation.

You will rarely, if ever, write a ScreenViewFactory yourself. Use one of its companion methods like ScreenViewFactory.fromViewBinding instead.

data class HelloScreen(
+    
@WorkflowUiExperimentalApi
interface AndroidScreen<S : AndroidScreen<S>> : Screen
Interface implemented by a Screen rendering class to minimize the boilerplate required for it to drive an Android UI via an appropriate ScreenViewFactory implementation.
Note that it is generally an error for a Workflow to declare AndroidScreen as its RenderingT type -- prefer Screen for that. AndroidScreen is strictly a possible implementation detail of Screen.
You will rarely, if ever, write a ScreenViewFactory yourself. Use one of its companion methods like ScreenViewFactory.fromViewBinding instead.
data class HelloScreen(
   val message: String,
   val onClick: () -> Unit
 ) : AndroidScreen {
diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory-finder/get-view-factory-for-rendering.html b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory-finder/get-view-factory-for-rendering.html
index b799060d2..0f1536a8d 100644
--- a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory-finder/get-view-factory-for-rendering.html
+++ b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory-finder/get-view-factory-for-rendering.html
@@ -63,7 +63,7 @@
   

     
getViewFactoryForRendering

   

-  
open fun <ScreenT : Screen> getViewFactoryForRendering(environment: ViewEnvironment, rendering: ScreenT): ScreenViewFactory<ScreenT>

+  
open fun <ScreenT : Screen> getViewFactoryForRendering(environment: ViewEnvironment, rendering: ScreenT): ScreenViewFactory<ScreenT>?

 

       

         © 2024 CopyrightGenerated by dokka
diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory-finder/index.html b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory-finder/index.html
index 7fb5f72e3..98525020d 100644
--- a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory-finder/index.html
+++ b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory-finder/index.html
@@ -95,7 +95,7 @@ 
ScreenViewFactory
Content copied to clipboard
-
+

Types

@@ -128,7 +128,22 @@

Functions

+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/index.html b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/index.html index a763b2da5..cc4ab3e87 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/index.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/index.html @@ -62,7 +62,7 @@
workflow-ui-core-android/com.squareup.workflow1.ui/ScreenViewFactory

ScreenViewFactory

-
@WorkflowUiExperimentalApi
interface ScreenViewFactory<in ScreenT : Screen> : ViewRegistry.Entry<ScreenT>

A ViewRegistry.Entry that can build Android View instances, along with functions that can update them to display Screen renderings of a particular type, bundled together in instances of ScreenViewHolder.

Use fromLayout, fromViewBinding, etc., to create a ScreenViewFactory. These helper methods take a layout resource, view binding, or view building function as arguments, along with a factory to create a ScreenViewRunner.showRendering function.

It is rare to call buildView directly. Instead the most common path is to pass Screen instances to WorkflowViewStub.show, which will apply the ScreenViewFactory machinery for you.

If you are building a custom container and for some reason can't delegate to WorkflowViewStub, here is how to do the work yourself:

+
@WorkflowUiExperimentalApi
interface ScreenViewFactory<in ScreenT : Screen> : ViewRegistry.Entry<ScreenT>

A ViewRegistry.Entry that can build Android View instances, along with functions that can update them to display Screen renderings of a particular type, bundled together in instances of ScreenViewHolder.

Use fromLayout, fromViewBinding, etc., to create a ScreenViewFactory. These helper methods take a layout resource, view binding, or view building function as arguments, along with a factory to create a ScreenViewRunner.showRendering function.

It is rare to call buildView directly. Instead the most common path is to pass Screen instances to WorkflowViewStub.show, which will apply the ScreenViewFactory machinery for you.

If you are building a custom container and for some reason can't delegate to WorkflowViewStub, here is how to do the work yourself:

@@ -88,17 +88,32 @@

Types

Properties

-
+
- - + +
Link copied to clipboard
-
abstract val type: KClass<in ScreenT>
+
open override val key: ViewRegistry.Key<ScreenT, ScreenViewFactory<*>>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
abstract val type: KClass<in ScreenT>
diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/key.html b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/key.html new file mode 100644 index 000000000..93cd84f85 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/key.html @@ -0,0 +1,76 @@ + + + + + key + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-core-android/com.squareup.workflow1.ui/ScreenViewFactory/key
+
+

key

+
+
open override val key: ViewRegistry.Key<ScreenT, ScreenViewFactory<*>>
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/type.html b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/type.html new file mode 100644 index 000000000..c50f48bad --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/-screen-view-factory/type.html @@ -0,0 +1,76 @@ + + + + + type + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-core-android/com.squareup.workflow1.ui/ScreenViewFactory/type
+
+

type

+
+
abstract val type: KClass<in ScreenT>
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/index.html b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/index.html index 0cdbb26c9..36c9c43a2 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/index.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/index.html @@ -78,7 +78,7 @@

Types

-
@WorkflowUiExperimentalApi
interface AndroidScreen<S : AndroidScreen<S>> : Screen

Interface implemented by a rendering class to allow it to drive an Android UI via an appropriate ScreenViewFactory implementation.

+
@WorkflowUiExperimentalApi
interface AndroidScreen<S : AndroidScreen<S>> : Screen

Interface implemented by a Screen rendering class to minimize the boilerplate required for it to drive an Android UI via an appropriate ScreenViewFactory implementation.

@@ -108,7 +108,7 @@

Types

-
@WorkflowUiExperimentalApi
interface ScreenViewFactory<in ScreenT : Screen> : ViewRegistry.Entry<ScreenT>

A ViewRegistry.Entry that can build Android View instances, along with functions that can update them to display Screen renderings of a particular type, bundled together in instances of ScreenViewHolder.

+
@WorkflowUiExperimentalApi
interface ScreenViewFactory<in ScreenT : Screen> : ViewRegistry.Entry<ScreenT>

A ViewRegistry.Entry that can build Android View instances, along with functions that can update them to display Screen renderings of a particular type, bundled together in instances of ScreenViewHolder.

@@ -346,6 +346,21 @@

Functions

+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
@@ -416,7 +431,7 @@

Functions

-
@WorkflowUiExperimentalApi
fun <ScreenT : Screen> ScreenT.toViewFactory(environment: ViewEnvironment): ScreenViewFactory<ScreenT>

It is rare to call this method directly. Instead the most common path is to pass Screen instances to WorkflowViewStub.show, which will apply the ScreenViewFactory and ScreenViewHolder machinery for you. See ScreenViewFactory for details.

+
@WorkflowUiExperimentalApi
fun <ScreenT : Screen> ScreenT.toViewFactory(environment: ViewEnvironment): ScreenViewFactory<ScreenT>

It is rare to call this method directly. Instead the most common path is to pass Screen instances to WorkflowViewStub.show, which will apply the ScreenViewFactory, ScreenViewHolder, and ScreenViewFactoryFinder machinery for you.

diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/require-view-factory-for-rendering.html b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/require-view-factory-for-rendering.html new file mode 100644 index 000000000..028c31b7a --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/require-view-factory-for-rendering.html @@ -0,0 +1,76 @@ + + + + + requireViewFactoryForRendering + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-core-android/com.squareup.workflow1.ui/requireViewFactoryForRendering
+
+

requireViewFactoryForRendering

+
+
@WorkflowUiExperimentalApi
fun <ScreenT : Screen> ScreenViewFactoryFinder.requireViewFactoryForRendering(environment: ViewEnvironment, rendering: ScreenT): ScreenViewFactory<ScreenT>
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/to-view-factory.html b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/to-view-factory.html index 6f0c0ec68..c802b83d1 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/to-view-factory.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-android/com.squareup.workflow1.ui/to-view-factory.html @@ -63,7 +63,7 @@

toViewFactory

-
@WorkflowUiExperimentalApi
fun <ScreenT : Screen> ScreenT.toViewFactory(environment: ViewEnvironment): ScreenViewFactory<ScreenT>

It is rare to call this method directly. Instead the most common path is to pass Screen instances to WorkflowViewStub.show, which will apply the ScreenViewFactory and ScreenViewHolder machinery for you. See ScreenViewFactory for details.

+
@WorkflowUiExperimentalApi
fun <ScreenT : Screen> ScreenT.toViewFactory(environment: ViewEnvironment): ScreenViewFactory<ScreenT>

It is rare to call this method directly. Instead the most common path is to pass Screen instances to WorkflowViewStub.show, which will apply the ScreenViewFactory, ScreenViewHolder, and ScreenViewFactoryFinder machinery for you.

See ScreenViewFactory for details.

© 2024 CopyrightGenerated by dokka diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-android/navigation.html b/kotlin/api/htmlMultiModule/workflow-ui/core-android/navigation.html index 00dff3f82..621255d84 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-android/navigation.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-android/navigation.html @@ -777,29 +777,29 @@
com.squareup.workflow1.ui.compose
-
+ -
+ -
+ -
+ - -
+ + + + + + + -
+
WorkflowRendering()
@@ -832,7 +867,7 @@
com.squareup.workflow1.ui.compose.tooling
-
+
Preview()
@@ -887,97 +922,102 @@ renderWorkflowIn()
-
+ + -
+ -
+
- ScreenViewFactory + ScreenViewFactory
- -
+
- ScreenViewFactoryFinder + ScreenViewFactoryFinder
- -
+
- ScreenViewHolder + ScreenViewHolder
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
WorkflowViewStub
@@ -1197,92 +1237,102 @@ EnvironmentScreen
-
+ -
+
+
+ getFactoryFor() +
+
+ -
+ -
+ -
+ -
+ -
+ -
+
- ViewEnvironment + ViewEnvironment
- -
+ -
+
- ViewRegistry + ViewRegistry
-
+ -
+ +
+
+ Key +
+
-
+ -
+ -
+ -
+ -
+
Wrapper
diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/index.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/index.html index 3b218bf6d..bb60a5c3f 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/index.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-back-stack-screen/index.html @@ -276,17 +276,17 @@

Functions

- +
- +
Link copied to clipboard
-
@WorkflowUiExperimentalApi
fun Screen.withEnvironment(environment: ViewEnvironment = ViewEnvironment.EMPTY): EnvironmentScreen<*>

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the values in the given environment.

+
@WorkflowUiExperimentalApi
fun Screen.withEnvironment(environment: ViewEnvironment = ViewEnvironment.EMPTY): EnvironmentScreen<*>

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the values in the given environment.

@WorkflowUiExperimentalApi
fun <T : Any> Screen.withEnvironment(entry: Pair<ViewEnvironmentKey<T>, T>): EnvironmentScreen<*>

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the given entry.

diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/index.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/index.html index 9458e5e99..315c02277 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/index.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui.navigation/-body-and-overlays-screen/index.html @@ -209,17 +209,17 @@

Functions

- +
- +
Link copied to clipboard
-
@WorkflowUiExperimentalApi
fun Screen.withEnvironment(environment: ViewEnvironment = ViewEnvironment.EMPTY): EnvironmentScreen<*>

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the values in the given environment.

+
@WorkflowUiExperimentalApi
fun Screen.withEnvironment(environment: ViewEnvironment = ViewEnvironment.EMPTY): EnvironmentScreen<*>

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the values in the given environment.

@WorkflowUiExperimentalApi
fun <T : Any> Screen.withEnvironment(entry: Pair<ViewEnvironmentKey<T>, T>): EnvironmentScreen<*>

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the given entry.

diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-environment-screen/index.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-environment-screen/index.html index 5e4ba41f4..e97e9edcd 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-environment-screen/index.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-environment-screen/index.html @@ -167,17 +167,17 @@

Functions

- +
- +
Link copied to clipboard
-
@WorkflowUiExperimentalApi
fun Screen.withEnvironment(environment: ViewEnvironment = ViewEnvironment.EMPTY): EnvironmentScreen<*>

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the values in the given environment.

+
@WorkflowUiExperimentalApi
fun Screen.withEnvironment(environment: ViewEnvironment = ViewEnvironment.EMPTY): EnvironmentScreen<*>

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the values in the given environment.

@WorkflowUiExperimentalApi
fun <T : Any> Screen.withEnvironment(entry: Pair<ViewEnvironmentKey<T>, T>): EnvironmentScreen<*>

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the given entry.

diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-named-screen/index.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-named-screen/index.html index e0027c8d5..517637ed1 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-named-screen/index.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-named-screen/index.html @@ -182,17 +182,17 @@

Functions

- +
- +
Link copied to clipboard
-
@WorkflowUiExperimentalApi
fun Screen.withEnvironment(environment: ViewEnvironment = ViewEnvironment.EMPTY): EnvironmentScreen<*>

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the values in the given environment.

+
@WorkflowUiExperimentalApi
fun Screen.withEnvironment(environment: ViewEnvironment = ViewEnvironment.EMPTY): EnvironmentScreen<*>

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the values in the given environment.

@WorkflowUiExperimentalApi
fun <T : Any> Screen.withEnvironment(entry: Pair<ViewEnvironmentKey<T>, T>): EnvironmentScreen<*>

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the given entry.

diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-screen/index.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-screen/index.html index f41f079b8..1470746da 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-screen/index.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-screen/index.html @@ -69,17 +69,17 @@

Screen

Functions

-
+
- +
Link copied to clipboard
-
@WorkflowUiExperimentalApi
fun Screen.withEnvironment(environment: ViewEnvironment = ViewEnvironment.EMPTY): EnvironmentScreen<*>

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the values in the given environment.

+
@WorkflowUiExperimentalApi
fun Screen.withEnvironment(environment: ViewEnvironment = ViewEnvironment.EMPTY): EnvironmentScreen<*>

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the values in the given environment.

@WorkflowUiExperimentalApi
fun <T : Any> Screen.withEnvironment(entry: Pair<ViewEnvironmentKey<T>, T>): EnvironmentScreen<*>

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the given entry.

diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/index.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/index.html index cdf74b205..85af2a5f8 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/index.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-environment/index.html @@ -177,7 +177,7 @@

Functions

diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry.html index 3329110a1..fab08e996 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry.html @@ -63,7 +63,7 @@

ViewRegistry

-
@WorkflowUiExperimentalApi
fun ViewRegistry(vararg bindings: ViewRegistry.Entry<*>): ViewRegistry(source)

@WorkflowUiExperimentalApi
fun ViewRegistry(): ViewRegistry(source)

Returns a ViewRegistry that contains no bindings.

Exists as a separate overload from the other two functions to disambiguate between them.

+
@WorkflowUiExperimentalApi
fun ViewRegistry(vararg bindings: ViewRegistry.Entry<*>): ViewRegistry(source)

@WorkflowUiExperimentalApi
fun ViewRegistry(): ViewRegistry(source)

Returns a ViewRegistry that contains no bindings.

Exists as a separate overload from the other two functions to disambiguate between them.

© 2024 CopyrightGenerated by dokka diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-companion/combine.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-companion/combine.html index b3eb69b1a..6b060cd60 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-companion/combine.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-companion/combine.html @@ -63,7 +63,7 @@

combine

-
open override fun combine(left: ViewRegistry, right: ViewRegistry): ViewRegistry(source)

Applied from ViewEnvironment.plus when the receiving environment already contains a value for this key. The default implementation replaces left with right.

+
open override fun combine(left: ViewRegistry, right: ViewRegistry): ViewRegistry(source)

Applied from ViewEnvironment.plus when the receiving environment already contains a value for this key. The default implementation replaces left with right.

© 2024 CopyrightGenerated by dokka diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-companion/default.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-companion/default.html index 262967c0f..2dc85b24b 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-companion/default.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-companion/default.html @@ -63,7 +63,7 @@

default

-
open override val default: ViewRegistry(source)

Defines the default value for this key. It is a grievous error for this value to be dynamic in any way.

+
open override val default: ViewRegistry(source)

Defines the default value for this key. It is a grievous error for this value to be dynamic in any way.

© 2024 CopyrightGenerated by dokka diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-companion/index.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-companion/index.html index f0960ef1d..7d4641bd2 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-companion/index.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-companion/index.html @@ -62,7 +62,7 @@
workflow-ui-core-common-jvm/com.squareup.workflow1.ui/ViewRegistry/Companion

Companion

-
object Companion : ViewEnvironmentKey<ViewRegistry> (source)
+
object Companion : ViewEnvironmentKey<ViewRegistry> (source)
diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-entry/index.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-entry/index.html index f9a4bcfa2..8155fcc02 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-entry/index.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-entry/index.html @@ -62,24 +62,24 @@
workflow-ui-core-common-jvm/com.squareup.workflow1.ui/ViewRegistry/Entry

Entry

-
interface Entry<in RenderingT : Any>(source)
+
interface Entry<in RenderingT : Any>(source)

Implemented by a factory that can build some kind of UI for view models of type RenderingT, and which can be listed in a ViewRegistry. The Key.factoryType field of key must be the type of this Entry.

Properties

-
+
- - + +
Link copied to clipboard
-
abstract val type: KClass<in RenderingT>
+
abstract val key: ViewRegistry.Key<RenderingT, *>
diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-entry/key.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-entry/key.html new file mode 100644 index 000000000..58c98f0bb --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-entry/key.html @@ -0,0 +1,76 @@ + + + + + key + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-core-common-jvm/com.squareup.workflow1.ui/ViewRegistry/Entry/key
+
+

key

+
+
abstract val key: ViewRegistry.Key<RenderingT, *>(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/-key.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/-key.html new file mode 100644 index 000000000..870db635d --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/-key.html @@ -0,0 +1,76 @@ + + + + + Key + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-core-common-jvm/com.squareup.workflow1.ui/ViewRegistry/Key/Key
+
+

Key

+
+
constructor(renderingType: KClass<in RenderingT>, factoryType: KClass<out FactoryT>)(source)

Parameters

renderingType

the type of view model for which factoryType instances can build UI

factoryType

the type of the UI factory that can build UI for renderingType

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/equals.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/equals.html new file mode 100644 index 000000000..87028edb8 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/equals.html @@ -0,0 +1,76 @@ + + + + + equals + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-core-common-jvm/com.squareup.workflow1.ui/ViewRegistry/Key/equals
+
+

equals

+
+
open operator override fun equals(other: Any?): Boolean(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/factory-type.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/factory-type.html new file mode 100644 index 000000000..d42042311 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/factory-type.html @@ -0,0 +1,76 @@ + + + + + factoryType + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-core-common-jvm/com.squareup.workflow1.ui/ViewRegistry/Key/factoryType
+
+

factoryType

+
+
val factoryType: KClass<out FactoryT>(source)

Parameters

factoryType

the type of the UI factory that can build UI for renderingType

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/hash-code.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/hash-code.html new file mode 100644 index 000000000..5c3030431 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/hash-code.html @@ -0,0 +1,76 @@ + + + + + hashCode + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-core-common-jvm/com.squareup.workflow1.ui/ViewRegistry/Key/hashCode
+
+

hashCode

+
+
open override fun hashCode(): Int(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/index.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/index.html new file mode 100644 index 000000000..49cf59e9d --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/index.html @@ -0,0 +1,183 @@ + + + + + Key + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-core-common-jvm/com.squareup.workflow1.ui/ViewRegistry/Key
+
+

Key

+
class Key<in RenderingT : Any, out FactoryT : Any>(val renderingType: KClass<in RenderingT>, val factoryType: KClass<out FactoryT>)(source)

Identifies a UI factory Entry in a ViewRegistry.

Parameters

renderingType

the type of view model for which factoryType instances can build UI

factoryType

the type of the UI factory that can build UI for renderingType

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(renderingType: KClass<in RenderingT>, factoryType: KClass<out FactoryT>)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val factoryType: KClass<out FactoryT>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val renderingType: KClass<in RenderingT>
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open operator override fun equals(other: Any?): Boolean
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun hashCode(): Int
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun toString(): String
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/rendering-type.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/rendering-type.html new file mode 100644 index 000000000..b67602b19 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/rendering-type.html @@ -0,0 +1,76 @@ + + + + + renderingType + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-core-common-jvm/com.squareup.workflow1.ui/ViewRegistry/Key/renderingType
+
+

renderingType

+
+
val renderingType: KClass<in RenderingT>(source)

Parameters

renderingType

the type of view model for which factoryType instances can build UI

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/to-string.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/to-string.html new file mode 100644 index 000000000..69ebed3b2 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/-key/to-string.html @@ -0,0 +1,76 @@ + + + + + toString + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
workflow-ui-core-common-jvm/com.squareup.workflow1.ui/ViewRegistry/Key/toString
+
+

toString

+
+
open override fun toString(): String(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/get-entry-for.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/get-entry-for.html index 768043f93..246be72fb 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/get-entry-for.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/get-entry-for.html @@ -58,12 +58,12 @@
-
+
workflow-ui-core-common-jvm/com.squareup.workflow1.ui/ViewRegistry/getEntryFor

getEntryFor

-
abstract fun <RenderingT : Any> getEntryFor(renderingType: KClass<out RenderingT>): ViewRegistry.Entry<RenderingT>?(source)

Returns the Entry that was registered for the given renderingType, or null if none was found.

+
abstract fun <RenderingT : Any, FactoryT : Any> getEntryFor(key: ViewRegistry.Key<RenderingT, FactoryT>): ViewRegistry.Entry<RenderingT>?(source)

Returns the Entry that was registered for the given key, or null if none was found.

© 2024 CopyrightGenerated by dokka diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/index.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/index.html index 9dcd57d91..4e7e4f5ae 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/index.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/index.html @@ -62,7 +62,7 @@
workflow-ui-core-common-jvm/com.squareup.workflow1.ui/ViewRegistry

ViewRegistry

-
@WorkflowUiExperimentalApi
interface ViewRegistry(source)

The ViewEnvironment service that can be used to display the stream of renderings from a workflow tree as View instances. This is the engine behind AndroidViewRendering, WorkflowViewStub and ViewFactory. Most apps can ignore ViewRegistry as an implementation detail, by using AndroidViewRendering to tie their rendering classes to view code.

To avoid that coupling between workflow code and the Android runtime, registries can be loaded with ViewFactory instances at runtime, and provided as an optional parameter to WorkflowLayout.start.

For example:

val AuthViewFactories = ViewRegistry(
+    
@WorkflowUiExperimentalApi
interface ViewRegistry(source)
The ViewEnvironment service that can be used to display the stream of renderings from a workflow tree as View instances. This is the engine behind AndroidViewRendering, WorkflowViewStub and ViewFactory. Most apps can ignore ViewRegistry as an implementation detail, by using AndroidViewRendering to tie their rendering classes to view code.
To avoid that coupling between workflow code and the Android runtime, registries can be loaded with ViewFactory instances at runtime, and provided as an optional parameter to WorkflowLayout.start.
For example:
val AuthViewFactories = ViewRegistry(
   AuthorizingLayoutRunner, LoginLayoutRunner, SecondFactorLayoutRunner
 )
 
@@ -130,7 +130,22 @@ 
Types

                   

               

                 

-                  
interface Entry<in RenderingT : Any>

+                  
interface Entry<in RenderingT : Any>
Implemented by a factory that can build some kind of UI for view models of type RenderingT, and which can be listed in a ViewRegistry. The Key.factoryType field of key must be the type of this Entry.

+                

+              

+            

+          

+
+          

+            

+              

+                  
+
+                    
Link copied to clipboard

+                  

+              

+                

+                  
class Key<in RenderingT : Any, out FactoryT : Any>(val renderingType: KClass<in RenderingT>, val factoryType: KClass<out FactoryT>)
Identifies a UI factory Entry in a ViewRegistry.

                 

               

             

@@ -149,7 +164,7 @@ 
Properties

                   

               

                 

-                  
abstract val keys: Set<KClass<*>>
The set of unique keys which this registry can derive from the renderings passed to getEntryFor and for which it knows how to create views.

+                  
abstract val keys: Set<ViewRegistry.Key<*, *>>
The set of unique keys which this registry can derive from the renderings passed to getEntryFor and for which it knows how to create UI.
@@ -158,32 +173,47 @@

Properties

Functions

-
+
- +
Link copied to clipboard
- +
- + +
Link copied to clipboard
+
+
+
+
abstract fun <RenderingT : Any, FactoryT : Any> getEntryFor(key: ViewRegistry.Key<RenderingT, FactoryT>): ViewRegistry.Entry<RenderingT>?

Returns the Entry that was registered for the given key, or null if none was found.

+
+
+
+
+ +
+
+
+ +
Link copied to clipboard
-
abstract fun <RenderingT : Any> getEntryFor(renderingType: KClass<out RenderingT>): ViewRegistry.Entry<RenderingT>?

Returns the Entry that was registered for the given renderingType, or null if none was found.

+
@WorkflowUiExperimentalApi
inline fun <RenderingT : Any, FactoryT : Any> ViewRegistry.getFactoryFor(): FactoryT?
@WorkflowUiExperimentalApi
inline fun <RenderingT : Any, FactoryT : Any> ViewRegistry.getFactoryFor(rendering: RenderingT): FactoryT?
@@ -213,7 +243,7 @@

Functions

-
@WorkflowUiExperimentalApi
operator fun ViewRegistry.plus(other: ViewRegistry): ViewRegistry

Transforms the receiver to add all entries from other, throwing IllegalArgumentException if the receiver already has any matching entry. Use merge to replace existing entries.

@WorkflowUiExperimentalApi
operator fun ViewRegistry.plus(entry: ViewRegistry.Entry<*>): ViewRegistry

Transforms the receiver to add entry, throwing IllegalArgumentException if the receiver already has a matching entry. Use merge to replace an existing entry with a new one.

+
@WorkflowUiExperimentalApi
operator fun ViewRegistry.plus(other: ViewRegistry): ViewRegistry

Transforms the receiver to add all entries from other.

@WorkflowUiExperimentalApi
operator fun ViewRegistry.plus(entry: ViewRegistry.Entry<*>): ViewRegistry

Transforms the receiver to add entry, throwing IllegalArgumentException if the receiver already has a matching entry. Use merge to replace an existing entry with a new one.

diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/keys.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/keys.html index 4094d7dd6..b8cab7c01 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/keys.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/-view-registry/keys.html @@ -63,7 +63,7 @@

keys

-
abstract val keys: Set<KClass<*>>(source)

The set of unique keys which this registry can derive from the renderings passed to getEntryFor and for which it knows how to create views.

Used to ensure that duplicate bindings are never registered.

+
abstract val keys: Set<ViewRegistry.Key<*, *>>(source)

The set of unique keys which this registry can derive from the renderings passed to getEntryFor and for which it knows how to create UI.

Used to ensure that duplicate bindings are never registered.

© 2024 CopyrightGenerated by dokka diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/get-factory-for.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/get-factory-for.html new file mode 100644 index 000000000..1de336da1 --- /dev/null +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/get-factory-for.html @@ -0,0 +1,76 @@ + + + + + getFactoryFor + + + + + + + + + + + + + + + + + +
+ +
+ + +
+
+ + + diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/get.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/get.html index dc86c9d2e..b7d0206a3 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/get.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/get.html @@ -58,12 +58,12 @@
-
+
workflow-ui-core-common-jvm/com.squareup.workflow1.ui/get

get

-
@WorkflowUiExperimentalApi
inline operator fun <RenderingT : Any> ViewRegistry.get(renderingType: KClass<out RenderingT>): ViewRegistry.Entry<RenderingT>?(source)
+
@WorkflowUiExperimentalApi
inline operator fun <RenderingT : Any, FactoryT : Any> ViewRegistry.get(key: ViewRegistry.Key<RenderingT, FactoryT>): FactoryT?(source)
© 2024 CopyrightGenerated by dokka diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/index.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/index.html index 218764794..9adf63f6e 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/index.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/index.html @@ -252,17 +252,32 @@

Functions

- +
- +
Link copied to clipboard
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
@@ -292,7 +307,7 @@

Functions

-
@WorkflowUiExperimentalApi
operator fun ViewEnvironment.plus(registry: ViewRegistry): ViewEnvironment

@WorkflowUiExperimentalApi
operator fun ViewRegistry.plus(other: ViewRegistry): ViewRegistry

Transforms the receiver to add all entries from other, throwing IllegalArgumentException if the receiver already has any matching entry. Use merge to replace existing entries.

@WorkflowUiExperimentalApi
operator fun ViewRegistry.plus(entry: ViewRegistry.Entry<*>): ViewRegistry

Transforms the receiver to add entry, throwing IllegalArgumentException if the receiver already has a matching entry. Use merge to replace an existing entry with a new one.

+
@WorkflowUiExperimentalApi
operator fun ViewEnvironment.plus(registry: ViewRegistry): ViewEnvironment

Returns a new ViewEnvironment that adds registry to the receiver. If the receiver already has a ViewRegistry, ViewEnvironmentKey.combine is applied as usual to merge its entries.

@WorkflowUiExperimentalApi
operator fun ViewRegistry.plus(other: ViewRegistry): ViewRegistry

Transforms the receiver to add all entries from other.

@WorkflowUiExperimentalApi
operator fun ViewRegistry.plus(entry: ViewRegistry.Entry<*>): ViewRegistry

Transforms the receiver to add entry, throwing IllegalArgumentException if the receiver already has a matching entry. Use merge to replace an existing entry with a new one.

@@ -327,17 +342,17 @@

Functions

- +
- +
Link copied to clipboard
-
@WorkflowUiExperimentalApi
fun Screen.withEnvironment(environment: ViewEnvironment = ViewEnvironment.EMPTY): EnvironmentScreen<*>

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the values in the given environment.

+
@WorkflowUiExperimentalApi
fun Screen.withEnvironment(environment: ViewEnvironment = ViewEnvironment.EMPTY): EnvironmentScreen<*>

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the values in the given environment.

@WorkflowUiExperimentalApi
fun <T : Any> Screen.withEnvironment(entry: Pair<ViewEnvironmentKey<T>, T>): EnvironmentScreen<*>

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the given entry.

diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/merge.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/merge.html index 7504e944a..a7dfac0c8 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/merge.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/merge.html @@ -63,7 +63,7 @@

merge

-
@WorkflowUiExperimentalApi
infix fun ViewRegistry.merge(other: ViewRegistry): ViewRegistry(source)

Combines the receiver with other. If there are conflicting entries, those in other are preferred.

+
@WorkflowUiExperimentalApi
infix fun ViewRegistry.merge(other: ViewRegistry): ViewRegistry(source)

Combines the receiver with other. If there are conflicting entries, those in other are preferred.

© 2024 CopyrightGenerated by dokka diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/plus.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/plus.html index 99d354d97..a14c1f33c 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/plus.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/plus.html @@ -63,7 +63,7 @@

plus

-
@WorkflowUiExperimentalApi
operator fun ViewRegistry.plus(entry: ViewRegistry.Entry<*>): ViewRegistry(source)

Transforms the receiver to add entry, throwing IllegalArgumentException if the receiver already has a matching entry. Use merge to replace an existing entry with a new one.

@WorkflowUiExperimentalApi
operator fun ViewRegistry.plus(other: ViewRegistry): ViewRegistry(source)

Transforms the receiver to add all entries from other, throwing IllegalArgumentException if the receiver already has any matching entry. Use merge to replace existing entries.

@WorkflowUiExperimentalApi
operator fun ViewEnvironment.plus(registry: ViewRegistry): ViewEnvironment(source)
+
@WorkflowUiExperimentalApi
operator fun ViewRegistry.plus(entry: ViewRegistry.Entry<*>): ViewRegistry(source)

Transforms the receiver to add entry, throwing IllegalArgumentException if the receiver already has a matching entry. Use merge to replace an existing entry with a new one.

@WorkflowUiExperimentalApi
operator fun ViewRegistry.plus(other: ViewRegistry): ViewRegistry(source)

Transforms the receiver to add all entries from other.

Throws

if the receiver already has an matching Entry. Use merge to replace existing entries instead.

@WorkflowUiExperimentalApi
operator fun ViewEnvironment.plus(registry: ViewRegistry): ViewEnvironment(source)

Returns a new ViewEnvironment that adds registry to the receiver. If the receiver already has a ViewRegistry, ViewEnvironmentKey.combine is applied as usual to merge its entries.

© 2024 CopyrightGenerated by dokka diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/with-environment.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/with-environment.html index faa2328d3..ed4d9ace5 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/with-environment.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/com.squareup.workflow1.ui/with-environment.html @@ -63,7 +63,7 @@

withEnvironment

-
@WorkflowUiExperimentalApi
fun Screen.withEnvironment(environment: ViewEnvironment = ViewEnvironment.EMPTY): EnvironmentScreen<*>(source)

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the values in the given environment.

If the receiver is an EnvironmentScreen, uses ViewRegistry.merge to preserve the ViewRegistry entries of both.

+
@WorkflowUiExperimentalApi
fun Screen.withEnvironment(environment: ViewEnvironment = ViewEnvironment.EMPTY): EnvironmentScreen<*>(source)

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the values in the given environment.

If the receiver is an EnvironmentScreen, uses ViewRegistry.merge to preserve the ViewRegistry entries of both.

@WorkflowUiExperimentalApi
fun <T : Any> Screen.withEnvironment(entry: Pair<ViewEnvironmentKey<T>, T>): EnvironmentScreen<*>(source)

Returns an EnvironmentScreen derived from the receiver, whose EnvironmentScreen.environment includes the given entry.

© 2024 CopyrightGenerated by dokka diff --git a/kotlin/api/htmlMultiModule/workflow-ui/core-common/navigation.html b/kotlin/api/htmlMultiModule/workflow-ui/core-common/navigation.html index 00dff3f82..621255d84 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/core-common/navigation.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/core-common/navigation.html @@ -777,29 +777,29 @@
com.squareup.workflow1.ui.compose
-
+ -
+ -
+ -
+ - -
+ + + + + + + -
+
WorkflowRendering()
@@ -832,7 +867,7 @@
com.squareup.workflow1.ui.compose.tooling
-
+
Preview()
@@ -887,97 +922,102 @@ renderWorkflowIn()
-
+ + -
+ -
+
- ScreenViewFactory + ScreenViewFactory
- -
+
- ScreenViewFactoryFinder + ScreenViewFactoryFinder
- -
+
- ScreenViewHolder + ScreenViewHolder
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
WorkflowViewStub
@@ -1197,92 +1237,102 @@ EnvironmentScreen
-
+ -
+
+
+ getFactoryFor() +
+
+ -
+ -
+ -
+ -
+ -
+ -
+
- ViewEnvironment + ViewEnvironment
- -
+ -
+
- ViewRegistry + ViewRegistry
-
+ -
+ +
+
+ Key +
+
-
+ -
+ -
+ -
+ -
+
Wrapper
diff --git a/kotlin/api/htmlMultiModule/workflow-ui/radiography/navigation.html b/kotlin/api/htmlMultiModule/workflow-ui/radiography/navigation.html index 00dff3f82..621255d84 100644 --- a/kotlin/api/htmlMultiModule/workflow-ui/radiography/navigation.html +++ b/kotlin/api/htmlMultiModule/workflow-ui/radiography/navigation.html @@ -777,29 +777,29 @@
com.squareup.workflow1.ui.compose
-
+ -
+ -
+ -
+ - -
+ + + + + + + -
+
WorkflowRendering()
@@ -832,7 +867,7 @@
com.squareup.workflow1.ui.compose.tooling
-
+
Preview()
@@ -887,97 +922,102 @@ renderWorkflowIn()
-
+ + -
+ -
+
- ScreenViewFactory + ScreenViewFactory
- -
+
- ScreenViewFactoryFinder + ScreenViewFactoryFinder
- -
+
- ScreenViewHolder + ScreenViewHolder
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
WorkflowViewStub
@@ -1197,92 +1237,102 @@ EnvironmentScreen
-
+ -
+
+
+ getFactoryFor() +
+
+ -
+ -
+ -
+ -
+ -
+ -
+
- ViewEnvironment + ViewEnvironment
- -
+ -
+
- ViewRegistry + ViewRegistry
-
+ -
+ +
+
+ Key +
+
-
+ -
+ -
+ -
+ -
+
Wrapper
diff --git a/search/search_index.json b/search/search_index.json index ff971e9cb..e99b10a41 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Overview \u00b6 Workflow is an application framework that provides architectural primitives. Workflow is: Written in and used for Kotlin and Swift A unidirectional data flow library that uses immutable data within each Workflow. Data flows in a single direction from source to UI, and events in a single direction from the UI to the business logic. A library that supports writing business logic and complex UI navigation logic as state machines, thereby enabling confident reasoning about state and validation of correctness. Optimized for composability and scalability of features and screens. Corresponding UI frameworks that bind Rendering data classes for \u201cviews\u201d (including event callbacks) to Mobile UI frameworks for Android and iOS. A corresponding testing framework that facilitates simple-to-write unit tests for all application business logic and helps ensure correctness. Using Workflows in your project \u00b6 Swift \u00b6 See the square/workflow-swift repository. Kotlin \u00b6 See the square/workflow-kotlin repository. Resources \u00b6 Wondering why to use Workflow? See \u201cWhy Workflow\u201d There is a Glossary of Terms We have a User Guide describing core concepts. For Kotlin (and Android), there is a codelab style tutorial in the repo. For Swift (and iOS), there is also a Getting Started tutorial in the repo. There are also a number of Kotlin samples and Swift samples . Support & Contact \u00b6 Workflow discussion happens in the Workflow Community slack. Use this open invitation . Workflow maintainers also hang out in the #squarelibraries channel on the Kotlin Slack . Releasing and Deploying \u00b6 See RELEASING.md . License \u00b6 Copyright 2019 Square Inc. Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.","title":"Overview"},{"location":"#overview","text":"Workflow is an application framework that provides architectural primitives. Workflow is: Written in and used for Kotlin and Swift A unidirectional data flow library that uses immutable data within each Workflow. Data flows in a single direction from source to UI, and events in a single direction from the UI to the business logic. A library that supports writing business logic and complex UI navigation logic as state machines, thereby enabling confident reasoning about state and validation of correctness. Optimized for composability and scalability of features and screens. Corresponding UI frameworks that bind Rendering data classes for \u201cviews\u201d (including event callbacks) to Mobile UI frameworks for Android and iOS. A corresponding testing framework that facilitates simple-to-write unit tests for all application business logic and helps ensure correctness.","title":"Overview"},{"location":"#using-workflows-in-your-project","text":"","title":"Using Workflows in your project"},{"location":"#swift","text":"See the square/workflow-swift repository.","title":"Swift"},{"location":"#kotlin","text":"See the square/workflow-kotlin repository.","title":"Kotlin"},{"location":"#resources","text":"Wondering why to use Workflow? See \u201cWhy Workflow\u201d There is a Glossary of Terms We have a User Guide describing core concepts. For Kotlin (and Android), there is a codelab style tutorial in the repo. For Swift (and iOS), there is also a Getting Started tutorial in the repo. There are also a number of Kotlin samples and Swift samples .","title":"Resources"},{"location":"#support-contact","text":"Workflow discussion happens in the Workflow Community slack. Use this open invitation . Workflow maintainers also hang out in the #squarelibraries channel on the Kotlin Slack .","title":"Support & Contact"},{"location":"#releasing-and-deploying","text":"See RELEASING.md .","title":"Releasing and Deploying"},{"location":"#license","text":"Copyright 2019 Square Inc. Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.","title":"License"},{"location":"CHANGELOG/","text":"Changelog \u00b6 You can find the changelogs for the library in the respective language repositories: Kotlin Swift","title":"Changelog"},{"location":"CHANGELOG/#changelog","text":"You can find the changelogs for the library in the respective language repositories: Kotlin Swift","title":"Changelog"},{"location":"CODE_OF_CONDUCT/","text":"Open Source Code of Conduct \u00b6 At Square, we are committed to contributing to the open source community and simplifying the process of releasing and managing open source software. We\u2019ve seen incredible support and enthusiasm from thousands of people who have already contributed to our projects\u200a\u2014\u200aand we want to ensure ourcommunity continues to be truly open for everyone. This code of conduct outlines our expectations for participants, as well as steps to reporting unacceptable behavior. We are committed to providing a welcoming and inspiring community for all and expect our code of conduct to be honored. Square\u2019s open source community strives to: Be open : We invite anyone to participate in any aspect of our projects. Our community is open, and any responsibility can be carried by a contributor who demonstrates the required capacity and competence. Be considerate : People use our work, and we depend on the work of others. Consider users and colleagues before taking action. For example, changes to code, infrastructure, policy, and documentation may negatively impact others. Be respectful : We expect people to work together to resolve conflict, assume good intentions, and act with empathy. Do not turn disagreements into personal attacks. Be collaborative : Collaboration reduces redundancy and improves the quality of our work. We strive for transparency within our open source community, and we work closely with upstream developers and others in the free software community to coordinate our efforts. Be pragmatic : Questions are encouraged and should be asked early in the process to avoid problems later. Be thoughtful and considerate when seeking out the appropriate forum for your questions. Those who are asked should be responsive and helpful. Step down considerately : Members of every project come and go. When somebody leaves or disengages from the project, they should make it known and take the proper steps to ensure that others can pick up where they left off. This code is not exhaustive or complete. It serves to distill our common understanding of a collaborative, shared environment, and goals. We expect it to be followed in spirit as much as in the letter. Diversity Statement \u00b6 We encourage everyone to participate and are committed to building a community for all. Although we may not be able to satisfy everyone, we all agree that everyone is equal. Whenever a participant has made a mistake, we expect them to take responsibility for it. If someone has been harmed or offended, it is our responsibility to listen carefully and respectfully, and do our best to right the wrong. Although this list cannot be exhaustive, we explicitly honor diversity in age, culture, ethnicity, gender identity or expression, language, national origin, political beliefs, profession, race, religion, sexual orientation, socioeconomic status, and technical ability. We will not tolerate discrimination based on any of the protected characteristics above, including participants with disabilities. Reporting Issues \u00b6 If you experience or witness unacceptable behavior\u200a\u2014\u200aor have any other concerns\u200a\u2014\u200aplease report it by emailing codeofconduct@squareup.com . For more details, please see our Reporting Guidelines below. Thanks \u00b6 Some of the ideas and wording for the statements and guidelines above were based on work by the Twitter , Ubuntu , GDC , and Django communities. We are thankful for their work. Reporting Guide \u00b6 If you experience or witness unacceptable behavior\u200a\u2014\u200aor have any other concerns\u200a\u2014\u200aplease report it by emailing codeofconduct@squareup.com . All reports will be handled with discretion. In your report please include: Your contact information. Names (real, nicknames, or pseudonyms) of any individuals involved. If there are additional witnesses, please include them as well. Your account of what occurred, and if you believe the incident is ongoing. If there is a publicly available record (e.g. a mailing list archive or a public IRC logger), please include a link. Any additional information that may be helpful. After filing a report, a representative from the Square Code of Conduct committee will contact you personally. The committee will then review the incident, follow up with any additional questions, and make a decision as to how to respond. Anyone asked to stop unacceptable behavior is expected to comply immediately. If an individual engages in unacceptable behavior, the Square Code of Conduct committee may take any action they deem appropriate, up to and including a permanent ban from all of Square spaces without warning.","title":"Code of Conduct"},{"location":"CODE_OF_CONDUCT/#open-source-code-of-conduct","text":"At Square, we are committed to contributing to the open source community and simplifying the process of releasing and managing open source software. We\u2019ve seen incredible support and enthusiasm from thousands of people who have already contributed to our projects\u200a\u2014\u200aand we want to ensure ourcommunity continues to be truly open for everyone. This code of conduct outlines our expectations for participants, as well as steps to reporting unacceptable behavior. We are committed to providing a welcoming and inspiring community for all and expect our code of conduct to be honored. Square\u2019s open source community strives to: Be open : We invite anyone to participate in any aspect of our projects. Our community is open, and any responsibility can be carried by a contributor who demonstrates the required capacity and competence. Be considerate : People use our work, and we depend on the work of others. Consider users and colleagues before taking action. For example, changes to code, infrastructure, policy, and documentation may negatively impact others. Be respectful : We expect people to work together to resolve conflict, assume good intentions, and act with empathy. Do not turn disagreements into personal attacks. Be collaborative : Collaboration reduces redundancy and improves the quality of our work. We strive for transparency within our open source community, and we work closely with upstream developers and others in the free software community to coordinate our efforts. Be pragmatic : Questions are encouraged and should be asked early in the process to avoid problems later. Be thoughtful and considerate when seeking out the appropriate forum for your questions. Those who are asked should be responsive and helpful. Step down considerately : Members of every project come and go. When somebody leaves or disengages from the project, they should make it known and take the proper steps to ensure that others can pick up where they left off. This code is not exhaustive or complete. It serves to distill our common understanding of a collaborative, shared environment, and goals. We expect it to be followed in spirit as much as in the letter.","title":"Open Source Code of Conduct"},{"location":"CODE_OF_CONDUCT/#diversity-statement","text":"We encourage everyone to participate and are committed to building a community for all. Although we may not be able to satisfy everyone, we all agree that everyone is equal. Whenever a participant has made a mistake, we expect them to take responsibility for it. If someone has been harmed or offended, it is our responsibility to listen carefully and respectfully, and do our best to right the wrong. Although this list cannot be exhaustive, we explicitly honor diversity in age, culture, ethnicity, gender identity or expression, language, national origin, political beliefs, profession, race, religion, sexual orientation, socioeconomic status, and technical ability. We will not tolerate discrimination based on any of the protected characteristics above, including participants with disabilities.","title":"Diversity Statement"},{"location":"CODE_OF_CONDUCT/#reporting-issues","text":"If you experience or witness unacceptable behavior\u200a\u2014\u200aor have any other concerns\u200a\u2014\u200aplease report it by emailing codeofconduct@squareup.com . For more details, please see our Reporting Guidelines below.","title":"Reporting Issues"},{"location":"CODE_OF_CONDUCT/#thanks","text":"Some of the ideas and wording for the statements and guidelines above were based on work by the Twitter , Ubuntu , GDC , and Django communities. We are thankful for their work.","title":"Thanks"},{"location":"CODE_OF_CONDUCT/#reporting-guide","text":"If you experience or witness unacceptable behavior\u200a\u2014\u200aor have any other concerns\u200a\u2014\u200aplease report it by emailing codeofconduct@squareup.com . All reports will be handled with discretion. In your report please include: Your contact information. Names (real, nicknames, or pseudonyms) of any individuals involved. If there are additional witnesses, please include them as well. Your account of what occurred, and if you believe the incident is ongoing. If there is a publicly available record (e.g. a mailing list archive or a public IRC logger), please include a link. Any additional information that may be helpful. After filing a report, a representative from the Square Code of Conduct committee will contact you personally. The committee will then review the incident, follow up with any additional questions, and make a decision as to how to respond. Anyone asked to stop unacceptable behavior is expected to comply immediately. If an individual engages in unacceptable behavior, the Square Code of Conduct committee may take any action they deem appropriate, up to and including a permanent ban from all of Square spaces without warning.","title":"Reporting Guide"},{"location":"CONTRIBUTING/","text":"Contributing \u00b6 If you would like to contribute code to Workflow you can do so through GitHub by forking the repository and sending a pull request. When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible. Please also make sure your code compiles. Before your code can be accepted into the project you must also sign the Individual Contributor License Agreement (CLA) .","title":"Contributing"},{"location":"CONTRIBUTING/#contributing","text":"If you would like to contribute code to Workflow you can do so through GitHub by forking the repository and sending a pull request. When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible. Please also make sure your code compiles. Before your code can be accepted into the project you must also sign the Individual Contributor License Agreement (CLA) .","title":"Contributing"},{"location":"RELEASING/","text":"Releasing workflow \u00b6 Deploying the documentation website \u00b6 Official Workflow documentation lives at https://square.github.io/workflow . The website content consists of three parts: Markdown documentation: Lives in the docs/ folder, and consists of a set of hand-written Markdown files that document high-level concepts. The static site generator mkdocs (with Material theming) is used to convert the Markdown to static, styled HTML. Kotlin API reference: Kdoc embedded in Kotlin source files is converted to GitHub-flavored Markdown by Dokka and then included in the statically-generated website. Swift API reference: Markup comments from Swift files are converted Markdown by Sourcedocs and then included in the statically-generated website. Note: The documentation site is automatically built and deployed whenever a version tag is pushed. You only need these steps if you want to work on the site locally. Setting up the site generators \u00b6 If you\u2019ve already done this, you can skip to Deploying the website to production below. Kotlin: Dokka \u00b6 Dokka runs as a Gradle plugin, so you need to be able to build the Kotlin source with Gradle, but that\u2019s it. To generate the docs manually, run: cd kotlin ./gradlew dokka Swift: Sourcedocs \u00b6 Sourcedocs generates a Markdown site from Swift files. You need Ruby, rubygems, bundler (2.x), Xcode 10.2+, CocoaPods, and of course Sourcedocs itself, to run it. Assuming you\u2019ve already got Xcode, Ruby, and rubygems set up, install the rest of the dependencies: gem install bundler cocoapods brew install sourcedocs You will also need a checkout of the Swift repo: git clone https://github.com/square/workflow-swift.git cd workflow-swift Then generate an Xcode project before running Sourcedocs: cd Samples/SampleApp/ bundle exec pod install # If this is your first time running CocoaPods, that will fail and you'll need to run this instead: #bundle exec pod install --repo-update You can manually generate the docs to verify everything is working correctly by running: #cd Samples/SampleApp/ sourcedocs generate -- -scheme Workflow -workspace SampleApp.xcworkspace sourcedocs generate -- -scheme WorkflowUI -workspace SampleApp.xcworkspace sourcedocs generate -- -scheme WorkflowTesting -workspace SampleApp.xcworkspace Note that currently sourcedocs only supports Xcode 10, if you run it with Xcode 11 you might see an error about Catalyst and only empty READMEs will get generated. mkdocs \u00b6 Mkdocs is written in Python, so you\u2019ll need Python 3 and pip in order to run it. Assuming those are set up, run: pip install -r requirements.txt Generate the site manually with: mkdocs build While you\u2019re working on the documentation files, you can run the site locally with: mkdocs serve Deploying the website to production \u00b6 Note: The documentation site is automatically built and deployed by a Github Workflow whenever a version tag is pushed. You only need these steps if you want to publish the site manually. Before deploying the website for real, you need to export our Google Analytics key in an environment variable so that it will get added to the HTML. Get the key from one of the project maintainers, then add the following to your .bashrc and re-source it: export WORKFLOW_GOOGLE_ANALYTICS_KEY = UA-__________-1 Now you\u2019re ready to publish the site! Just choose a tag or SHA to deploy from, and run: ./deploy_website.sh TAG_OR_SHA # For example: #./deploy_website.sh v0.18.0 This will clone the repo to a temporary directory, checkout the right SHA, build Kotlin and Swift API docs, generate HTML, and push the newly-generated content to the gh-pages branch on GitHub. Validating Markdown \u00b6 Since all of our high-level documentation is written in Markdown, we run a linter in CI to ensure we use consistent formatting. Lint errors will fail your PR builds, so to run locally, install markdownlint : gem install mdl Run the linter using the lint_docs.sh : ./lint_docs.sh Rules can be configured by editing .markdownlint.rb . Kotlin Notes \u00b6 Development \u00b6 To build and install the current version to your local Maven repository ( ~/.m2 ), run: ./gradlew clean installArchives Deploying \u00b6 Configuration \u00b6 In order to deploy artifacts to a Maven repository, you\u2019ll need to set 4 properties in your private Gradle properties file ( ~/.gradle/gradle.properties ): RELEASE_REPOSITORY_URL= SNAPSHOT_REPOSITORY_URL= SONATYPE_NEXUS_PASSWORD= Snapshot Releases \u00b6 Double-check that gradle.properties correctly contains the -SNAPSHOT suffix, then upload snapshot artifacts to Sonatype just like you would for a production release: ./gradlew clean build && ./gradlew uploadArchives --no-parallel --no-daemon You can verify the artifacts are available by visiting https://oss.sonatype.org/content/repositories/snapshots/com/squareup/workflow/ .","title":"Releasing workflow"},{"location":"RELEASING/#releasing-workflow","text":"","title":"Releasing workflow"},{"location":"RELEASING/#deploying-the-documentation-website","text":"Official Workflow documentation lives at https://square.github.io/workflow . The website content consists of three parts: Markdown documentation: Lives in the docs/ folder, and consists of a set of hand-written Markdown files that document high-level concepts. The static site generator mkdocs (with Material theming) is used to convert the Markdown to static, styled HTML. Kotlin API reference: Kdoc embedded in Kotlin source files is converted to GitHub-flavored Markdown by Dokka and then included in the statically-generated website. Swift API reference: Markup comments from Swift files are converted Markdown by Sourcedocs and then included in the statically-generated website. Note: The documentation site is automatically built and deployed whenever a version tag is pushed. You only need these steps if you want to work on the site locally.","title":"Deploying the documentation website"},{"location":"RELEASING/#setting-up-the-site-generators","text":"If you\u2019ve already done this, you can skip to Deploying the website to production below.","title":"Setting up the site generators"},{"location":"RELEASING/#kotlin-dokka","text":"Dokka runs as a Gradle plugin, so you need to be able to build the Kotlin source with Gradle, but that\u2019s it. To generate the docs manually, run: cd kotlin ./gradlew dokka","title":"Kotlin: Dokka"},{"location":"RELEASING/#swift-sourcedocs","text":"Sourcedocs generates a Markdown site from Swift files. You need Ruby, rubygems, bundler (2.x), Xcode 10.2+, CocoaPods, and of course Sourcedocs itself, to run it. Assuming you\u2019ve already got Xcode, Ruby, and rubygems set up, install the rest of the dependencies: gem install bundler cocoapods brew install sourcedocs You will also need a checkout of the Swift repo: git clone https://github.com/square/workflow-swift.git cd workflow-swift Then generate an Xcode project before running Sourcedocs: cd Samples/SampleApp/ bundle exec pod install # If this is your first time running CocoaPods, that will fail and you'll need to run this instead: #bundle exec pod install --repo-update You can manually generate the docs to verify everything is working correctly by running: #cd Samples/SampleApp/ sourcedocs generate -- -scheme Workflow -workspace SampleApp.xcworkspace sourcedocs generate -- -scheme WorkflowUI -workspace SampleApp.xcworkspace sourcedocs generate -- -scheme WorkflowTesting -workspace SampleApp.xcworkspace Note that currently sourcedocs only supports Xcode 10, if you run it with Xcode 11 you might see an error about Catalyst and only empty READMEs will get generated.","title":"Swift: Sourcedocs"},{"location":"RELEASING/#mkdocs","text":"Mkdocs is written in Python, so you\u2019ll need Python 3 and pip in order to run it. Assuming those are set up, run: pip install -r requirements.txt Generate the site manually with: mkdocs build While you\u2019re working on the documentation files, you can run the site locally with: mkdocs serve","title":"mkdocs"},{"location":"RELEASING/#deploying-the-website-to-production","text":"Note: The documentation site is automatically built and deployed by a Github Workflow whenever a version tag is pushed. You only need these steps if you want to publish the site manually. Before deploying the website for real, you need to export our Google Analytics key in an environment variable so that it will get added to the HTML. Get the key from one of the project maintainers, then add the following to your .bashrc and re-source it: export WORKFLOW_GOOGLE_ANALYTICS_KEY = UA-__________-1 Now you\u2019re ready to publish the site! Just choose a tag or SHA to deploy from, and run: ./deploy_website.sh TAG_OR_SHA # For example: #./deploy_website.sh v0.18.0 This will clone the repo to a temporary directory, checkout the right SHA, build Kotlin and Swift API docs, generate HTML, and push the newly-generated content to the gh-pages branch on GitHub.","title":"Deploying the website to production"},{"location":"RELEASING/#validating-markdown","text":"Since all of our high-level documentation is written in Markdown, we run a linter in CI to ensure we use consistent formatting. Lint errors will fail your PR builds, so to run locally, install markdownlint : gem install mdl Run the linter using the lint_docs.sh : ./lint_docs.sh Rules can be configured by editing .markdownlint.rb .","title":"Validating Markdown"},{"location":"RELEASING/#kotlin-notes","text":"","title":"Kotlin Notes"},{"location":"RELEASING/#development","text":"To build and install the current version to your local Maven repository ( ~/.m2 ), run: ./gradlew clean installArchives","title":"Development"},{"location":"RELEASING/#deploying","text":"","title":"Deploying"},{"location":"RELEASING/#configuration","text":"In order to deploy artifacts to a Maven repository, you\u2019ll need to set 4 properties in your private Gradle properties file ( ~/.gradle/gradle.properties ): RELEASE_REPOSITORY_URL= SNAPSHOT_REPOSITORY_URL= SONATYPE_NEXUS_PASSWORD=","title":"Configuration"},{"location":"RELEASING/#snapshot-releases","text":"Double-check that gradle.properties correctly contains the -SNAPSHOT suffix, then upload snapshot artifacts to Sonatype just like you would for a production release: ./gradlew clean build && ./gradlew uploadArchives --no-parallel --no-daemon You can verify the artifacts are available by visiting https://oss.sonatype.org/content/repositories/snapshots/com/squareup/workflow/ .","title":"Snapshot Releases"},{"location":"code-recipes/","text":"Code Receipes \u00b6 Coming soon!","title":"Code Receipes"},{"location":"code-recipes/#code-receipes","text":"Coming soon!","title":"Code Receipes"},{"location":"development-process/","text":"Development Process \u00b6 Coming soon!","title":"Development Process"},{"location":"development-process/#development-process","text":"Coming soon!","title":"Development Process"},{"location":"faq/","text":"Frequently Asked Questions \u00b6 Why do we need another architecture? \u00b6 We ask this question too! So we wrote a longer answer for it: \u201cWhy Workflow?\u201d . How do I get involved and/or contribute? \u00b6 Workflow is open source! See our CONTRIBUTING doc to get started. Stay tuned! We\u2019re considering hosting a public Slack channel for open source contributors. Isn\u2019t this basically React/Elm? \u00b6 React and the Elm architecture were both strong influences for this library. However both those libraries are written for JavaScript. Workflows are written in and for both Kotlin and Swift, making use of features of those languages, and with usability from those languages as a major design goal. There are some architectural differences which we can see briefly in the following table: React Elm Workflow Modularity Component Module s for code organization, but not \u2018composable\u2019 in the same way. A Workflow is analogous to React\u2019s Component State Each Component has a state property that is read directly and updated via a setState method. State is called Model in Elm. Workflow s have an associated state type. The state can only be updated when the props change, or with a WorkflowAction . Views Component s have a render method that returns a tree of elements. Elm applications have a view function that returns a tree of elements. Since workflows are not tied to any particular UI view layer, they can have an arbitrary rendering type. The render() method returns this type. Injected Dependencies React allows parent components to pass \u201cprops\u201d down to their children. N/A In Swift, Workflow s are often structs that need to be initialized with their dependencies and configuration data from their parent. In Kotlin, they have a separate type parameter ( PropsT ) that is always passed down from the parent. Workflow instances can also inject dependencies, and play nicely with dependency injection frameworks. Composability Component s are composed of other Component s. N/A Workflow s can have children; they control their lifecycle and can choose to incorporate child renderings into their own. Event Handling DOM event listeners are hooked up to functions on the Component . The update function takes a Msg to modify state based on events. action can be sent to the Sink to update State . How is this different than MvRx? \u00b6 Besides being very Android and Rx specific, MvRx solves view modeling problems only per screen. Workflow was mainly inspired by the need to manage and compose navigation in apps with dozens or hundreds of screens. This seems clever. Can I stick with a traditional development approach? \u00b6 Of course! Workflow was designed to make complex application architecture predictable and safe for large development teams. We\u2019re confident that it brings benefits even to smaller projects, but there is never only one right way to build software. We recommend to follow good practices and use an architecture that makes sense for your project .","title":"FAQ"},{"location":"faq/#frequently-asked-questions","text":"","title":"Frequently Asked Questions"},{"location":"faq/#why-do-we-need-another-architecture","text":"We ask this question too! So we wrote a longer answer for it: \u201cWhy Workflow?\u201d .","title":"Why do we need another architecture?"},{"location":"faq/#how-do-i-get-involved-andor-contribute","text":"Workflow is open source! See our CONTRIBUTING doc to get started. Stay tuned! We\u2019re considering hosting a public Slack channel for open source contributors.","title":"How do I get involved and/or contribute?"},{"location":"faq/#isnt-this-basically-reactelm","text":"React and the Elm architecture were both strong influences for this library. However both those libraries are written for JavaScript. Workflows are written in and for both Kotlin and Swift, making use of features of those languages, and with usability from those languages as a major design goal. There are some architectural differences which we can see briefly in the following table: React Elm Workflow Modularity Component Module s for code organization, but not \u2018composable\u2019 in the same way. A Workflow is analogous to React\u2019s Component State Each Component has a state property that is read directly and updated via a setState method. State is called Model in Elm. Workflow s have an associated state type. The state can only be updated when the props change, or with a WorkflowAction . Views Component s have a render method that returns a tree of elements. Elm applications have a view function that returns a tree of elements. Since workflows are not tied to any particular UI view layer, they can have an arbitrary rendering type. The render() method returns this type. Injected Dependencies React allows parent components to pass \u201cprops\u201d down to their children. N/A In Swift, Workflow s are often structs that need to be initialized with their dependencies and configuration data from their parent. In Kotlin, they have a separate type parameter ( PropsT ) that is always passed down from the parent. Workflow instances can also inject dependencies, and play nicely with dependency injection frameworks. Composability Component s are composed of other Component s. N/A Workflow s can have children; they control their lifecycle and can choose to incorporate child renderings into their own. Event Handling DOM event listeners are hooked up to functions on the Component . The update function takes a Msg to modify state based on events. action can be sent to the Sink to update State .","title":"Isn't this basically React/Elm?"},{"location":"faq/#how-is-this-different-than-mvrx","text":"Besides being very Android and Rx specific, MvRx solves view modeling problems only per screen. Workflow was mainly inspired by the need to manage and compose navigation in apps with dozens or hundreds of screens.","title":"How is this different than MvRx?"},{"location":"faq/#this-seems-clever-can-i-stick-with-a-traditional-development-approach","text":"Of course! Workflow was designed to make complex application architecture predictable and safe for large development teams. We\u2019re confident that it brings benefits even to smaller projects, but there is never only one right way to build software. We recommend to follow good practices and use an architecture that makes sense for your project .","title":"This seems clever. Can I stick with a traditional development approach?"},{"location":"glossary/","text":"Glossary of Terms \u00b6 Reactive Programming \u00b6 A style of programming where data or events are pushed to the logic processing them rather than having the logic pull the data and events from a source. A representation of program logic as a series of operations on a stream of data that is performed while a subscription to that stream is active. Unidirectional Data Flow \u00b6 Data travels a single path from business logic to UI, and travels the entirety of that path in a single direction. Events travel a single path from UI to business logic and they travel the entirety of that path in a single direction. There are thus two sets of directed edges in the graph that are handled separately and neither set has any cycles or back edges on its own. Declarative Programming \u00b6 A declarative program declares the state it wants the system to be in rather than how that is accomplished. Imperative Programming \u00b6 An imperative program\u2019s code is a series of statements that directly change a program\u2019s state as a result of certain events. State Machine \u00b6 An abstraction that models a program\u2019s logic as a graph of a set of states and the transitions between them (edges). See: en.wikipedia.org/wiki/Finite-state_machine Idempotent \u00b6 A function whose side effects won\u2019t be repeated with multiple invocations, the result is purely a function of the input. In other words, if called multiple times with the same input, the result is the same. For Workflows, the render() function must be idempotent, as the runtime offers no guarantees for how many times it may be called. Workflow Runtime \u00b6 An event loop that executes a Workflow Tree. On each pass: A Rendering is assembled by calling render() on each Node of the Workflow Tree with each parent Workflow given the option to incorporate the Renderings of its children into its own. The event loop waits for an Action to be sent to the Sink. This Action provides a (possibly updated) State for the Workflow that created it and possibly an Output. Any Output emitted is processed in turn by an Action defined by the updated Workflow\u2019s parent again possibly updating its State and emitting an Output cascading up the hierarchy. A new render() pass is made against the entire Workflow Tree with the updated States. We use the term Workflow Runtime to refer to the core code in the framework that executes this event loop, responding to Actions and invoking render() . Workflow (Instance) \u00b6 An object that defines the transitions and side effects of a state machine as, effectively, two functions: Providing the first state: (Props) -> State Providing a rendering: (Props and State) -> (Rendering and Side Effect Invocations and Child Workflow Invocations) The Child Workflow Invocations declared by the render function result in calls to the children\u2019s render() functions in turn, allowing the parent render function to choose to incorporate child Rendering values into its own. A Workflow is not itself a state machine, and ideally has no state of its own. It is rather a schema that identifies a particular type of state machine that can be started in initialState() by the Workflow Runtime, and advanced by repeated invocations of render() . Note: there is significant fuzziness in using the term \u2018Workflow\u2019, as it can mean at times the class/struct that declares the Workflow behavior as well as the object representing the running Workflow Node. To understand the Runtime behavior, grasping this distinction is necessary and valuable. When using a Workflow, the formal distinction is less valuable than the mental model of how a Workflow will be run. Workflow (Node) \u00b6 An active state machine whose behavior is defined by a Workflow Instance. This is the object that is held by the Workflow Runtime and whose state is updated (or \u201cdriven\u201d) according to the behavior declared in the Workflow Instance. In Kotlin and Swift a Workflow Node is implemented with the private WorkflowNode class/struct. Workflow Lifecycle \u00b6 Every Workflow or Side Effect Node has a lifecycle that is determined by its parent. In the case of the root Workflow, this lifecycle is determined by how long the host of the root chooses to use the stream of Renderings from the root Workflow. In the case of a non-root Workflow or Side Effect \u2014 that is, in the case of a Child \u2014 its lifecycle is determined as follows: Start: the first time its parent invokes the Child in the parent\u2019s own render() pass. End: the first subsequent render() pass that does not invoke the Child. Note that in between Start and End, the Workflow, or Side Effect is not \u201cre-invoked\u201d in the sense of starting again with each render() pass, but rather the originally invoked instance continues to run until a render() call is made without invoking it. Workflow Tree \u00b6 The tree of Workflow Nodes sharing a root. Workflow Nodes can have children and form a hierarchy. Workflow Root \u00b6 The root of a Workflow Tree. This is owned by a host which starts the Workflow Runtime with a particular Workflow instance. RenderContext \u00b6 The object which provides access to the Workflow Runtime from a Workflow render method. Provides three services: a Sink for accepting WorkflowActions recursively rendering Workflow children executing Side Effects Render Pass \u00b6 The portion of the Workflow Runtime event loop which traverses the Workflow tree, calling render() on each Workflow Node. When the RenderContext Sink receives an Action an Action Cascade occurs and at the completion of the Action Cascade the Render Pass occurs. Output Event \u00b6 When a Child Workflow emits an Output value, this is an Output Event. Handlers are registered when a Child Workflow is invoked to transform the child\u2019s Output values to Actions, which can advance the state of the parent. UI Event \u00b6 Any occurrence in the UI of a program \u2014 e.g. click, drag, keypress \u2014 the listener for which has been connected to a callback in the Rendering of a Workflow. UI Event callbacks typically add Actions to the Sink, to advance the state of the Workflow. Action \u00b6 A type associated with a particular Workflow (Instance) that is responsible for transforming a given State into a new State and optionally emitting an Output. Actions are sent to the Sink to be processed by the Workflow Runtime. Action Cascade \u00b6 When an event occurs and the handler provides an Action, this Action may possibly produce an Output for the parent Workflow which in turn has its own handler provide an Action that may produce an Output and onwards up the Workflow Tree. This is an Action Cascade. Sink \u00b6 The handle provided by the RenderContext to send Actions to the Workflow Runtime. These Actions are applied by the Workflow Runtime to advance a Workflow\u2019s State, and optionally produce an Output to be processed by the handler its parent registered. Props \u00b6 The set of input properties for a particular Workflow. This is the public state which is provided to a child Workflow by its parent, or to the root Workflow by its host. For Swift: The set of properties on the struct implementing the Workflow. For Kotlin: Parameter type PropsT in the Workflow signature. In Kotlin there is a formal distinction between Props and other dependencies, typically provided as constructor parameters. State \u00b6 The type of the internal state of a Workflow implementation. \u201cImmutable\u201d State \u00b6 The State object itself is immutable, in other words, its property values cannot be changed. What this means for Workflows is that the Workflow Runtime holds a canonical instance of the internal State of each Workflow. A Workflow\u2019s state is \u201cadvanced\u201d when that canonical instance is atomically replaced by one returned when an Action is invoked. State can only be mutated through WorkflowAction which will trigger a re-render. There are a number of benefits to keeping State immutable in this way: Reasoning about and debugging the Workflow is easier because, for any given State, there is a deterministic Rendering and the State cannot change except as a new parameter value to the render() method. This assists in making render() idempotent as the State will not be modified in the course of the execution of that function. Note that this immutability can be enforced only by convention. It is possible to cheat, but that is strongly discouraged. Rendering \u00b6 The externally available public representation of the state of a Workflow. It may include event handling functions. It is given a concrete type in the Workflow signature. Note that this \u201cRendering\u201d does not have to represent the UI of a program. The \u201cRendering\u201d is simply the published state of the Workflow, and could simply be data. Often that data is used to render UI, but it can be used in other ways \u2014 for example, as the implementation of a service API. Output \u00b6 The type of the object that can optionally be delivered to the Workflow\u2019s parent or the host of the root Workflow by an Action. Child Workflow \u00b6 A Workflow which has a parent. A parent may compose a child Workflow\u2019s Rendering into its own. Side Effect \u00b6 From render() , runningSideEffect() can be called with a given key and a function that will be called once by the Workflow Runtime. For Swift, a Lifetime object is also passed to runningSideEffect() which has an onEnded() closure that can be used for cleanup. For Kotlin, a coroutine scope is used to execute the function so it can be cancelled() at cleanup time. Given that any property (including the Sink) could be captured by the closure of the Side Effect this is the basic building block that can be used to interact with asynchronous (and often imperative) Workflow Children. Worker \u00b6 A Child Workflow that provides only output, with no rendering \u2014 a pattern for doing asynchronous work in Workflows. For Kotlin, this is an actual Interface which provides a convenient way to specify asynchronous work that produces an Output and a handler for that Output which can provide an Action. There are Kotlin extensions to map Rx Observables and Kotlin Flows to create Worker implementations. For Swift, there are at least 3 different Worker types which are convenience wrappers around reactive APIs that facilitate performing work. View \u00b6 A class or function managing a 2d box in a graphical user interface system, able to paint a defined region of the display and respond to user input events within its bounds. Views are arranged in a hierarchical tree, with parents able to lay out children and manage their painting and event handling. Instances supported by Workflow are: For Kotlin: Classic Android: class android.view.View Android JetPack Compose: @Composable fun Box() For Swift: class NSViewController Screen \u00b6 An interface / protocol identifying Renderings that model a View. Workflow UI libraries can map a given Screen type to a View instance that can display a series of such Screens. In Kotlin, Screen is a marker interface. Each type S : Screen is mapped by the Android UI library to a ScreenViewFactory<S> that is able to: create instances of android.view.View or provide a @Composable fun Content(S) function to be called from a Box {} context. Note that the Android UI support is able to interleave Screens bound to View or @Composable seamlessly. In Swift, the Screen protocol defines a single function creating ViewControllerDescription instances, objects which create and update ViewController instances to display Screens of the corresponding type. Overlay (Kotlin only) \u00b6 An interface identifying Renderings that model a plane covering a base Screen, possibly hosting another Screen \u2014 \u201ccovering\u201d in that they have a higher z-index, for visibility and event-handling. In Kotlin, Overlay is a marker interface. Each type O : Overlay is mapped by the Android UI library to an OverlayDialogFactory<O> able to create and update instances of android.app.Dialog Container Screen \u00b6 A design pattern, describing a Screen type whose instances wrap one or more other Screens, commonly to either annotate those Screens or define the relationships between them. Wrapping one Screen in another does not necessarily imply that the derived View hierarchy will change. It is common for the Kotlin ScreenViewFactory or Swift ViewControllerDescription bound to a Container Screen to delegate its construction and updating work to those of the wrapped Screens. Container View \u00b6 A View able to host children that are driven by Screen renderings. A Container View is generally driven by Container Screens of a specific type \u2014 e.g., a BackStackContainer View that can display BackStackScreen values. The exception is a root Container View, which is able to display a series of Screen instances of any type. For Kotlin, the root Container Views are WorkflowLayout : FrameLayout , and @Composable Workflow.renderAsState() . Custom Container Views written to display custom Container Screens can use WorkflowViewStub : FrameLayout or @Composable fun WorkflowRendering() to display wrapped Screens. For Swift, the root Container View is ContainerViewController . Custom Container Views written to render custom Container Screens can be built as subclasses of ScreenViewController , and use DescribedViewController to display wrapped Screens. ViewEnvironment \u00b6 A read-only key/value map passed from a Container View down to its children at update time, similar in spirit to Swift UI EnvironmentValues and Jetpack CompositionLocal . Like them, the ViewEnvironment is primarily intended to allow parents to offer children hints about the context in which they are being displayed \u2014 for example, to allow a child to know if it is a member of a back stack, and so decide whether or not to display a Go Back button. The ViewEnvironment also can be used judiciously as a service provider for UI-specific concerns, like image loaders \u2014 tread carefully.","title":"Glossary"},{"location":"glossary/#glossary-of-terms","text":"","title":"Glossary of Terms"},{"location":"glossary/#reactive-programming","text":"A style of programming where data or events are pushed to the logic processing them rather than having the logic pull the data and events from a source. A representation of program logic as a series of operations on a stream of data that is performed while a subscription to that stream is active.","title":"Reactive Programming"},{"location":"glossary/#unidirectional-data-flow","text":"Data travels a single path from business logic to UI, and travels the entirety of that path in a single direction. Events travel a single path from UI to business logic and they travel the entirety of that path in a single direction. There are thus two sets of directed edges in the graph that are handled separately and neither set has any cycles or back edges on its own.","title":"Unidirectional Data Flow"},{"location":"glossary/#declarative-programming","text":"A declarative program declares the state it wants the system to be in rather than how that is accomplished.","title":"Declarative Programming"},{"location":"glossary/#imperative-programming","text":"An imperative program\u2019s code is a series of statements that directly change a program\u2019s state as a result of certain events.","title":"Imperative Programming"},{"location":"glossary/#state-machine","text":"An abstraction that models a program\u2019s logic as a graph of a set of states and the transitions between them (edges). See: en.wikipedia.org/wiki/Finite-state_machine","title":"State Machine"},{"location":"glossary/#idempotent","text":"A function whose side effects won\u2019t be repeated with multiple invocations, the result is purely a function of the input. In other words, if called multiple times with the same input, the result is the same. For Workflows, the render() function must be idempotent, as the runtime offers no guarantees for how many times it may be called.","title":"Idempotent"},{"location":"glossary/#workflow-runtime","text":"An event loop that executes a Workflow Tree. On each pass: A Rendering is assembled by calling render() on each Node of the Workflow Tree with each parent Workflow given the option to incorporate the Renderings of its children into its own. The event loop waits for an Action to be sent to the Sink. This Action provides a (possibly updated) State for the Workflow that created it and possibly an Output. Any Output emitted is processed in turn by an Action defined by the updated Workflow\u2019s parent again possibly updating its State and emitting an Output cascading up the hierarchy. A new render() pass is made against the entire Workflow Tree with the updated States. We use the term Workflow Runtime to refer to the core code in the framework that executes this event loop, responding to Actions and invoking render() .","title":"Workflow Runtime"},{"location":"glossary/#workflow-instance","text":"An object that defines the transitions and side effects of a state machine as, effectively, two functions: Providing the first state: (Props) -> State Providing a rendering: (Props and State) -> (Rendering and Side Effect Invocations and Child Workflow Invocations) The Child Workflow Invocations declared by the render function result in calls to the children\u2019s render() functions in turn, allowing the parent render function to choose to incorporate child Rendering values into its own. A Workflow is not itself a state machine, and ideally has no state of its own. It is rather a schema that identifies a particular type of state machine that can be started in initialState() by the Workflow Runtime, and advanced by repeated invocations of render() . Note: there is significant fuzziness in using the term \u2018Workflow\u2019, as it can mean at times the class/struct that declares the Workflow behavior as well as the object representing the running Workflow Node. To understand the Runtime behavior, grasping this distinction is necessary and valuable. When using a Workflow, the formal distinction is less valuable than the mental model of how a Workflow will be run.","title":"Workflow (Instance)"},{"location":"glossary/#workflow-node","text":"An active state machine whose behavior is defined by a Workflow Instance. This is the object that is held by the Workflow Runtime and whose state is updated (or \u201cdriven\u201d) according to the behavior declared in the Workflow Instance. In Kotlin and Swift a Workflow Node is implemented with the private WorkflowNode class/struct.","title":"Workflow (Node)"},{"location":"glossary/#workflow-lifecycle","text":"Every Workflow or Side Effect Node has a lifecycle that is determined by its parent. In the case of the root Workflow, this lifecycle is determined by how long the host of the root chooses to use the stream of Renderings from the root Workflow. In the case of a non-root Workflow or Side Effect \u2014 that is, in the case of a Child \u2014 its lifecycle is determined as follows: Start: the first time its parent invokes the Child in the parent\u2019s own render() pass. End: the first subsequent render() pass that does not invoke the Child. Note that in between Start and End, the Workflow, or Side Effect is not \u201cre-invoked\u201d in the sense of starting again with each render() pass, but rather the originally invoked instance continues to run until a render() call is made without invoking it.","title":"Workflow Lifecycle"},{"location":"glossary/#workflow-tree","text":"The tree of Workflow Nodes sharing a root. Workflow Nodes can have children and form a hierarchy.","title":"Workflow Tree"},{"location":"glossary/#workflow-root","text":"The root of a Workflow Tree. This is owned by a host which starts the Workflow Runtime with a particular Workflow instance.","title":"Workflow Root"},{"location":"glossary/#rendercontext","text":"The object which provides access to the Workflow Runtime from a Workflow render method. Provides three services: a Sink for accepting WorkflowActions recursively rendering Workflow children executing Side Effects","title":"RenderContext"},{"location":"glossary/#render-pass","text":"The portion of the Workflow Runtime event loop which traverses the Workflow tree, calling render() on each Workflow Node. When the RenderContext Sink receives an Action an Action Cascade occurs and at the completion of the Action Cascade the Render Pass occurs.","title":"Render Pass"},{"location":"glossary/#output-event","text":"When a Child Workflow emits an Output value, this is an Output Event. Handlers are registered when a Child Workflow is invoked to transform the child\u2019s Output values to Actions, which can advance the state of the parent.","title":"Output Event"},{"location":"glossary/#ui-event","text":"Any occurrence in the UI of a program \u2014 e.g. click, drag, keypress \u2014 the listener for which has been connected to a callback in the Rendering of a Workflow. UI Event callbacks typically add Actions to the Sink, to advance the state of the Workflow.","title":"UI Event"},{"location":"glossary/#action","text":"A type associated with a particular Workflow (Instance) that is responsible for transforming a given State into a new State and optionally emitting an Output. Actions are sent to the Sink to be processed by the Workflow Runtime.","title":"Action"},{"location":"glossary/#action-cascade","text":"When an event occurs and the handler provides an Action, this Action may possibly produce an Output for the parent Workflow which in turn has its own handler provide an Action that may produce an Output and onwards up the Workflow Tree. This is an Action Cascade.","title":"Action Cascade"},{"location":"glossary/#sink","text":"The handle provided by the RenderContext to send Actions to the Workflow Runtime. These Actions are applied by the Workflow Runtime to advance a Workflow\u2019s State, and optionally produce an Output to be processed by the handler its parent registered.","title":"Sink"},{"location":"glossary/#props","text":"The set of input properties for a particular Workflow. This is the public state which is provided to a child Workflow by its parent, or to the root Workflow by its host. For Swift: The set of properties on the struct implementing the Workflow. For Kotlin: Parameter type PropsT in the Workflow signature. In Kotlin there is a formal distinction between Props and other dependencies, typically provided as constructor parameters.","title":"Props"},{"location":"glossary/#state","text":"The type of the internal state of a Workflow implementation.","title":"State"},{"location":"glossary/#immutable-state","text":"The State object itself is immutable, in other words, its property values cannot be changed. What this means for Workflows is that the Workflow Runtime holds a canonical instance of the internal State of each Workflow. A Workflow\u2019s state is \u201cadvanced\u201d when that canonical instance is atomically replaced by one returned when an Action is invoked. State can only be mutated through WorkflowAction which will trigger a re-render. There are a number of benefits to keeping State immutable in this way: Reasoning about and debugging the Workflow is easier because, for any given State, there is a deterministic Rendering and the State cannot change except as a new parameter value to the render() method. This assists in making render() idempotent as the State will not be modified in the course of the execution of that function. Note that this immutability can be enforced only by convention. It is possible to cheat, but that is strongly discouraged.","title":"\"Immutable\" State"},{"location":"glossary/#rendering","text":"The externally available public representation of the state of a Workflow. It may include event handling functions. It is given a concrete type in the Workflow signature. Note that this \u201cRendering\u201d does not have to represent the UI of a program. The \u201cRendering\u201d is simply the published state of the Workflow, and could simply be data. Often that data is used to render UI, but it can be used in other ways \u2014 for example, as the implementation of a service API.","title":"Rendering"},{"location":"glossary/#output","text":"The type of the object that can optionally be delivered to the Workflow\u2019s parent or the host of the root Workflow by an Action.","title":"Output"},{"location":"glossary/#child-workflow","text":"A Workflow which has a parent. A parent may compose a child Workflow\u2019s Rendering into its own.","title":"Child Workflow"},{"location":"glossary/#side-effect","text":"From render() , runningSideEffect() can be called with a given key and a function that will be called once by the Workflow Runtime. For Swift, a Lifetime object is also passed to runningSideEffect() which has an onEnded() closure that can be used for cleanup. For Kotlin, a coroutine scope is used to execute the function so it can be cancelled() at cleanup time. Given that any property (including the Sink) could be captured by the closure of the Side Effect this is the basic building block that can be used to interact with asynchronous (and often imperative) Workflow Children.","title":"Side Effect"},{"location":"glossary/#worker","text":"A Child Workflow that provides only output, with no rendering \u2014 a pattern for doing asynchronous work in Workflows. For Kotlin, this is an actual Interface which provides a convenient way to specify asynchronous work that produces an Output and a handler for that Output which can provide an Action. There are Kotlin extensions to map Rx Observables and Kotlin Flows to create Worker implementations. For Swift, there are at least 3 different Worker types which are convenience wrappers around reactive APIs that facilitate performing work.","title":"Worker"},{"location":"glossary/#view","text":"A class or function managing a 2d box in a graphical user interface system, able to paint a defined region of the display and respond to user input events within its bounds. Views are arranged in a hierarchical tree, with parents able to lay out children and manage their painting and event handling. Instances supported by Workflow are: For Kotlin: Classic Android: class android.view.View Android JetPack Compose: @Composable fun Box() For Swift: class NSViewController","title":"View"},{"location":"glossary/#screen","text":"An interface / protocol identifying Renderings that model a View. Workflow UI libraries can map a given Screen type to a View instance that can display a series of such Screens. In Kotlin, Screen is a marker interface. Each type S : Screen is mapped by the Android UI library to a ScreenViewFactory<S> that is able to: create instances of android.view.View or provide a @Composable fun Content(S) function to be called from a Box {} context. Note that the Android UI support is able to interleave Screens bound to View or @Composable seamlessly. In Swift, the Screen protocol defines a single function creating ViewControllerDescription instances, objects which create and update ViewController instances to display Screens of the corresponding type.","title":"Screen"},{"location":"glossary/#overlay-kotlin-only","text":"An interface identifying Renderings that model a plane covering a base Screen, possibly hosting another Screen \u2014 \u201ccovering\u201d in that they have a higher z-index, for visibility and event-handling. In Kotlin, Overlay is a marker interface. Each type O : Overlay is mapped by the Android UI library to an OverlayDialogFactory<O> able to create and update instances of android.app.Dialog","title":"Overlay (Kotlin only)"},{"location":"glossary/#container-screen","text":"A design pattern, describing a Screen type whose instances wrap one or more other Screens, commonly to either annotate those Screens or define the relationships between them. Wrapping one Screen in another does not necessarily imply that the derived View hierarchy will change. It is common for the Kotlin ScreenViewFactory or Swift ViewControllerDescription bound to a Container Screen to delegate its construction and updating work to those of the wrapped Screens.","title":"Container Screen"},{"location":"glossary/#container-view","text":"A View able to host children that are driven by Screen renderings. A Container View is generally driven by Container Screens of a specific type \u2014 e.g., a BackStackContainer View that can display BackStackScreen values. The exception is a root Container View, which is able to display a series of Screen instances of any type. For Kotlin, the root Container Views are WorkflowLayout : FrameLayout , and @Composable Workflow.renderAsState() . Custom Container Views written to display custom Container Screens can use WorkflowViewStub : FrameLayout or @Composable fun WorkflowRendering() to display wrapped Screens. For Swift, the root Container View is ContainerViewController . Custom Container Views written to render custom Container Screens can be built as subclasses of ScreenViewController , and use DescribedViewController to display wrapped Screens.","title":"Container View"},{"location":"glossary/#viewenvironment","text":"A read-only key/value map passed from a Container View down to its children at update time, similar in spirit to Swift UI EnvironmentValues and Jetpack CompositionLocal . Like them, the ViewEnvironment is primarily intended to allow parents to offer children hints about the context in which they are being displayed \u2014 for example, to allow a child to know if it is a member of a back stack, and so decide whether or not to display a Go Back button. The ViewEnvironment also can be used judiciously as a service provider for UI-specific concerns, like image loaders \u2014 tread carefully.","title":"ViewEnvironment"},{"location":"historical/","text":"Pre-1.0 Presentations and Resources \u00b6 Square Workflow \u2013 Droidcon NYC 2019 ( slides ) SF Android GDG @ Square 2019 - Hello Workflow (live coding) Android Dialogs 5-part Coding Series 1 , 2 , 3 , 4 , 5 Reactive Workflows a Year Later \u2013 Droidcon NYC 2018 The Reactive Workflow Pattern \u2013 Fragmented Podcast The Reactive Workflow Pattern Update \u2013 Droidcon SF 2017 The Rx Workflow Pattern \u2013 Droidcon NYC 2017 ( slides )","title":"Pre-1.0 Resources"},{"location":"historical/#pre-10-presentations-and-resources","text":"Square Workflow \u2013 Droidcon NYC 2019 ( slides ) SF Android GDG @ Square 2019 - Hello Workflow (live coding) Android Dialogs 5-part Coding Series 1 , 2 , 3 , 4 , 5 Reactive Workflows a Year Later \u2013 Droidcon NYC 2018 The Reactive Workflow Pattern \u2013 Fragmented Podcast The Reactive Workflow Pattern Update \u2013 Droidcon SF 2017 The Rx Workflow Pattern \u2013 Droidcon NYC 2017 ( slides )","title":"Pre-1.0 Presentations and Resources"},{"location":"sequence_diagrams/","text":"Sequence Diagrams \u00b6 These are the source files used to generate the sequence diagrams via WebSequenceDiagrams .","title":"Sequence Diagrams"},{"location":"sequence_diagrams/#sequence-diagrams","text":"These are the source files used to generate the sequence diagrams via WebSequenceDiagrams .","title":"Sequence Diagrams"},{"location":"swift/api/Workflow/","text":"Reference Documentation \u00b6 Protocols \u00b6 AnyWorkflowConvertible ObserversInterceptor Workflow WorkflowAction WorkflowDebugger WorkflowObserver Structs \u00b6 AnyWorkflow AnyWorkflowAction Sink StateMutationSink WorkflowHierarchyDebugSnapshot WorkflowHierarchyDebugSnapshot.Child WorkflowLogging.Config WorkflowSession WorkflowSession.Identifier WorkflowUpdateDebugInfo Classes \u00b6 Lifetime RenderContext WorkflowHost Enums \u00b6 Config.RenderLoggingMode WorkflowLogging WorkflowObservation WorkflowUpdateDebugInfo.Kind WorkflowUpdateDebugInfo.Source Extensions \u00b6 AnyWorkflow AnyWorkflowAction AnyWorkflowConvertible DispatchQueue RenderContext Workflow WorkflowLogging WorkflowLogging.Config WorkflowObserver WorkflowUpdateDebugInfo.Kind WorkflowUpdateDebugInfo.Source Typealiases \u00b6 AnyWorkflow.Output AnyWorkflow.Rendering AnyWorkflow.State This file was generated by SourceDocs on 2024-01-22 20:45:37 +0000","title":"Workflow "},{"location":"swift/api/Workflow/#reference-documentation","text":"","title":"Reference Documentation"},{"location":"swift/api/Workflow/#protocols","text":"AnyWorkflowConvertible ObserversInterceptor Workflow WorkflowAction WorkflowDebugger WorkflowObserver","title":"Protocols"},{"location":"swift/api/Workflow/#structs","text":"AnyWorkflow AnyWorkflowAction Sink StateMutationSink WorkflowHierarchyDebugSnapshot WorkflowHierarchyDebugSnapshot.Child WorkflowLogging.Config WorkflowSession WorkflowSession.Identifier WorkflowUpdateDebugInfo","title":"Structs"},{"location":"swift/api/Workflow/#classes","text":"Lifetime RenderContext WorkflowHost","title":"Classes"},{"location":"swift/api/Workflow/#enums","text":"Config.RenderLoggingMode WorkflowLogging WorkflowObservation WorkflowUpdateDebugInfo.Kind WorkflowUpdateDebugInfo.Source","title":"Enums"},{"location":"swift/api/Workflow/#extensions","text":"AnyWorkflow AnyWorkflowAction AnyWorkflowConvertible DispatchQueue RenderContext Workflow WorkflowLogging WorkflowLogging.Config WorkflowObserver WorkflowUpdateDebugInfo.Kind WorkflowUpdateDebugInfo.Source","title":"Extensions"},{"location":"swift/api/Workflow/#typealiases","text":"AnyWorkflow.Output AnyWorkflow.Rendering AnyWorkflow.State This file was generated by SourceDocs on 2024-01-22 20:45:37 +0000","title":"Typealiases"},{"location":"swift/api/Workflow/classes/Lifetime/","text":"CLASS Lifetime \u00b6 Represents the lifetime of an object. Once ended, the onEnded closure is called. Properties \u00b6 hasEnded \u00b6 Methods \u00b6 onEnded(_:) \u00b6 Hook to clean-up after end of lifetime . deinit \u00b6","title":"Lifetime"},{"location":"swift/api/Workflow/classes/Lifetime/#lifetime","text":"Represents the lifetime of an object. Once ended, the onEnded closure is called.","title":"Lifetime"},{"location":"swift/api/Workflow/classes/Lifetime/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/classes/Lifetime/#hasended","text":"","title":"hasEnded"},{"location":"swift/api/Workflow/classes/Lifetime/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/classes/Lifetime/#onended_","text":"Hook to clean-up after end of lifetime .","title":"onEnded(_:)"},{"location":"swift/api/Workflow/classes/Lifetime/#deinit","text":"","title":"deinit"},{"location":"swift/api/Workflow/classes/RenderContext/","text":"CLASS RenderContext \u00b6 RenderContext is the composition point for the workflow tree. During a render pass, a workflow may want to defer to a child workflow to render some portion of its content. For example, a workflow that renders to a split-screen view model might delegate to child A for the left side, and child B for the right side view models. Nesting allows for a fractal tree that is constructed out of many small parts. If a parent wants to delegate to a child workflow, it must first create an instance of that workflow. This can be thought of as the model of the child workflow. It does not contain any active state, it simply contains the data necessary to create or update a workflow node. The parent then calls render(workflow:outputMap:) with two values: - The child workflow. - A closure that transforms the child\u2019s output events into the parent\u2019s Event type so that the parent can respond to events generated by the child. If the parent had previously rendered a child of the same type, the existing child workflow node is updated. If the parent had not rendered a child of the same type in the previous render pass, a new child workflow node is generated. The infrastructure then performs a render pass on the child to obtain its Rendering value, which is then returned to the caller. Methods \u00b6 makeSink(of:) \u00b6 Creates a Sink that can be used to send Action s. Sinks are the primary mechanism for feeding State-changing events into the Workflow runtime. Upon receipt of an action, the associated Workflow (node) in the tree will have its State potentially transformed, and then any subsequent Output will be propagated to its parent node until the root of the Workflow tree is reached. At this point the tree will be re-rendered to reflect any State changes that occurred. Parameter actionType: The type of Action this Sink may process Returns: A Sink capable of relaying Action instances to the Workflow runtime runSideEffect(key:action:) \u00b6 Execute a side-effect action. Note that it is a programmer error to run two side-effects with the same key during the same render pass. action will be executed the first time a side-effect is run with a given key . runSideEffect calls with a given key on subsequent renders are ignored. If after a render pass, a side-effect with a key that was previously used is not used, it\u2019s lifetime ends and the Lifetime object\u2019s onEnded closure will be called. Parameters: key: represents the block of work that needs to be executed. action: a block of work that will be executed.","title":"RenderContext"},{"location":"swift/api/Workflow/classes/RenderContext/#rendercontext","text":"RenderContext is the composition point for the workflow tree. During a render pass, a workflow may want to defer to a child workflow to render some portion of its content. For example, a workflow that renders to a split-screen view model might delegate to child A for the left side, and child B for the right side view models. Nesting allows for a fractal tree that is constructed out of many small parts. If a parent wants to delegate to a child workflow, it must first create an instance of that workflow. This can be thought of as the model of the child workflow. It does not contain any active state, it simply contains the data necessary to create or update a workflow node. The parent then calls render(workflow:outputMap:) with two values: - The child workflow. - A closure that transforms the child\u2019s output events into the parent\u2019s Event type so that the parent can respond to events generated by the child. If the parent had previously rendered a child of the same type, the existing child workflow node is updated. If the parent had not rendered a child of the same type in the previous render pass, a new child workflow node is generated. The infrastructure then performs a render pass on the child to obtain its Rendering value, which is then returned to the caller.","title":"RenderContext"},{"location":"swift/api/Workflow/classes/RenderContext/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/classes/RenderContext/#makesinkof","text":"Creates a Sink that can be used to send Action s. Sinks are the primary mechanism for feeding State-changing events into the Workflow runtime. Upon receipt of an action, the associated Workflow (node) in the tree will have its State potentially transformed, and then any subsequent Output will be propagated to its parent node until the root of the Workflow tree is reached. At this point the tree will be re-rendered to reflect any State changes that occurred. Parameter actionType: The type of Action this Sink may process Returns: A Sink capable of relaying Action instances to the Workflow runtime","title":"makeSink(of:)"},{"location":"swift/api/Workflow/classes/RenderContext/#runsideeffectkeyaction","text":"Execute a side-effect action. Note that it is a programmer error to run two side-effects with the same key during the same render pass. action will be executed the first time a side-effect is run with a given key . runSideEffect calls with a given key on subsequent renders are ignored. If after a render pass, a side-effect with a key that was previously used is not used, it\u2019s lifetime ends and the Lifetime object\u2019s onEnded closure will be called. Parameters: key: represents the block of work that needs to be executed. action: a block of work that will be executed.","title":"runSideEffect(key:action:)"},{"location":"swift/api/Workflow/classes/WorkflowHost/","text":"CLASS WorkflowHost \u00b6 Manages an active workflow hierarchy. Properties \u00b6 rendering \u00b6 Represents the Rendering produced by the root workflow in the hierarchy. New Rendering values are produced as state transitions occur within the hierarchy. output \u00b6 A signal containing output events emitted by the root workflow in the hierarchy. Methods \u00b6 init(workflow:observers:debugger:) \u00b6 Initializes a new host with the given workflow at the root. Parameter workflow: The root workflow in the hierarchy Parameter observers: An optional array of WorkflowObservers that will allow runtime introspection for this WorkflowHost Parameter debugger: An optional debugger. If provided, the host will notify the debugger of updates to the workflow hierarchy as state transitions occur. update(workflow:) \u00b6 Update the input for the workflow. Will cause a render pass.","title":"WorkflowHost"},{"location":"swift/api/Workflow/classes/WorkflowHost/#workflowhost","text":"Manages an active workflow hierarchy.","title":"WorkflowHost"},{"location":"swift/api/Workflow/classes/WorkflowHost/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/classes/WorkflowHost/#rendering","text":"Represents the Rendering produced by the root workflow in the hierarchy. New Rendering values are produced as state transitions occur within the hierarchy.","title":"rendering"},{"location":"swift/api/Workflow/classes/WorkflowHost/#output","text":"A signal containing output events emitted by the root workflow in the hierarchy.","title":"output"},{"location":"swift/api/Workflow/classes/WorkflowHost/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/classes/WorkflowHost/#initworkflowobserversdebugger","text":"Initializes a new host with the given workflow at the root. Parameter workflow: The root workflow in the hierarchy Parameter observers: An optional array of WorkflowObservers that will allow runtime introspection for this WorkflowHost Parameter debugger: An optional debugger. If provided, the host will notify the debugger of updates to the workflow hierarchy as state transitions occur.","title":"init(workflow:observers:debugger:)"},{"location":"swift/api/Workflow/classes/WorkflowHost/#updateworkflow","text":"Update the input for the workflow. Will cause a render pass.","title":"update(workflow:)"},{"location":"swift/api/Workflow/enums/Config.RenderLoggingMode/","text":"ENUM Config.RenderLoggingMode \u00b6 Configuration options to control logging during a render pass. Cases \u00b6 none \u00b6 No data will be recorded for WorkflowNode render timings. rootsOnly \u00b6 Render timings will only be recorded for root nodes in a Workflow tree. allNodes \u00b6 Render timings will be recorded for all nodes in a Workflow tree. N.B. performance may be noticeably impacted when using this option.","title":"Config.RenderLoggingMode"},{"location":"swift/api/Workflow/enums/Config.RenderLoggingMode/#configrenderloggingmode","text":"Configuration options to control logging during a render pass.","title":"Config.RenderLoggingMode"},{"location":"swift/api/Workflow/enums/Config.RenderLoggingMode/#cases","text":"","title":"Cases"},{"location":"swift/api/Workflow/enums/Config.RenderLoggingMode/#none","text":"No data will be recorded for WorkflowNode render timings.","title":"none"},{"location":"swift/api/Workflow/enums/Config.RenderLoggingMode/#rootsonly","text":"Render timings will only be recorded for root nodes in a Workflow tree.","title":"rootsOnly"},{"location":"swift/api/Workflow/enums/Config.RenderLoggingMode/#allnodes","text":"Render timings will be recorded for all nodes in a Workflow tree. N.B. performance may be noticeably impacted when using this option.","title":"allNodes"},{"location":"swift/api/Workflow/enums/WorkflowLogging/","text":"ENUM WorkflowLogging \u00b6 Namespace for specifying logging configuration data.","title":"WorkflowLogging"},{"location":"swift/api/Workflow/enums/WorkflowLogging/#workflowlogging","text":"Namespace for specifying logging configuration data.","title":"WorkflowLogging"},{"location":"swift/api/Workflow/enums/WorkflowObservation/","text":"ENUM WorkflowObservation \u00b6 Properties \u00b6 sharedObserversInterceptor \u00b6 The DefaultObserversProvider used by all runtimes.","title":"WorkflowObservation"},{"location":"swift/api/Workflow/enums/WorkflowObservation/#workflowobservation","text":"","title":"WorkflowObservation"},{"location":"swift/api/Workflow/enums/WorkflowObservation/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/enums/WorkflowObservation/#sharedobserversinterceptor","text":"The DefaultObserversProvider used by all runtimes.","title":"sharedObserversInterceptor"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Kind/","text":"ENUM WorkflowUpdateDebugInfo.Kind \u00b6 Cases \u00b6 didUpdate(source:) \u00b6 childDidUpdate(_:) \u00b6","title":"WorkflowUpdateDebugInfo.Kind"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Kind/#workflowupdatedebuginfokind","text":"","title":"WorkflowUpdateDebugInfo.Kind"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Kind/#cases","text":"","title":"Cases"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Kind/#didupdatesource","text":"","title":"didUpdate(source:)"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Kind/#childdidupdate_","text":"","title":"childDidUpdate(_:)"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Source/","text":"ENUM WorkflowUpdateDebugInfo.Source \u00b6 Cases \u00b6 external \u00b6 worker \u00b6 sideEffect \u00b6 subtree(_:) \u00b6","title":"WorkflowUpdateDebugInfo.Source"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Source/#workflowupdatedebuginfosource","text":"","title":"WorkflowUpdateDebugInfo.Source"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Source/#cases","text":"","title":"Cases"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Source/#external","text":"","title":"external"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Source/#worker","text":"","title":"worker"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Source/#sideeffect","text":"","title":"sideEffect"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Source/#subtree_","text":"","title":"subtree(_:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflow/","text":"EXTENSION AnyWorkflow \u00b6 Methods \u00b6 render(state:context:) \u00b6 asAnyWorkflow() \u00b6 mapOutput(_:) \u00b6 Returns a new AnyWorkflow whose Output type has been transformed into the given type. Parameter transform: An escaping closure that maps the original output type into the new output type. Returns: A type erased workflow with the new output type (the rendering type remains unchanged). mapRendering(_:) \u00b6 Returns a new AnyWorkflow whose Rendering type has been transformed into the given type. Parameter transform: An escaping closure that maps the original rendering type into the new rendering type. Returns: A type erased workflow with the new rendering type (the output type remains unchanged).","title":"AnyWorkflow"},{"location":"swift/api/Workflow/extensions/AnyWorkflow/#anyworkflow","text":"","title":"AnyWorkflow"},{"location":"swift/api/Workflow/extensions/AnyWorkflow/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/extensions/AnyWorkflow/#renderstatecontext","text":"","title":"render(state:context:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflow/#asanyworkflow","text":"","title":"asAnyWorkflow()"},{"location":"swift/api/Workflow/extensions/AnyWorkflow/#mapoutput_","text":"Returns a new AnyWorkflow whose Output type has been transformed into the given type. Parameter transform: An escaping closure that maps the original output type into the new output type. Returns: A type erased workflow with the new output type (the rendering type remains unchanged).","title":"mapOutput(_:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflow/#maprendering_","text":"Returns a new AnyWorkflow whose Rendering type has been transformed into the given type. Parameter transform: An escaping closure that maps the original rendering type into the new rendering type. Returns: A type erased workflow with the new rendering type (the output type remains unchanged).","title":"mapRendering(_:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowAction/","text":"EXTENSION AnyWorkflowAction \u00b6 Properties \u00b6 noAction \u00b6 Creates a type-erased workflow action that does nothing (it leaves state unchanged and does not emit an output event). Methods \u00b6 init(sendingOutput:) \u00b6 Creates a type-erased workflow action that simply sends the given output event. Parameter output: The output event to send when this action is applied.","title":"AnyWorkflowAction"},{"location":"swift/api/Workflow/extensions/AnyWorkflowAction/#anyworkflowaction","text":"","title":"AnyWorkflowAction"},{"location":"swift/api/Workflow/extensions/AnyWorkflowAction/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/extensions/AnyWorkflowAction/#noaction","text":"Creates a type-erased workflow action that does nothing (it leaves state unchanged and does not emit an output event).","title":"noAction"},{"location":"swift/api/Workflow/extensions/AnyWorkflowAction/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/extensions/AnyWorkflowAction/#initsendingoutput","text":"Creates a type-erased workflow action that simply sends the given output event. Parameter output: The output event to send when this action is applied.","title":"init(sendingOutput:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/","text":"EXTENSION AnyWorkflowConvertible \u00b6 Methods \u00b6 mapOutput(_:) \u00b6 mapRendering(_:) \u00b6 rendered(in:key:) \u00b6 Creates or updates a child workflow of the given type, performs a render pass, and returns the result. Note that it is a programmer error to render two instances of a given workflow type with the same key during the same render pass. Parameter context: The context with which the workflow will be rendered. Parameter key: A string that uniquely identifies this workflow. Returns: The Rendering generated by the workflow. rendered(in:key:outputMap:) \u00b6 rendered(in:key:) \u00b6 rendered(in:key:) \u00b6 Creates or updates a child workflow of the given type, performs a render pass, and returns the result. Note that it is a programmer error to render two instances of a given workflow type with the same key during the same render pass. Parameter context: The context with which the workflow will be rendered. Parameter key: A string that uniquely identifies this workflow. Returns: The Rendering generated by the workflow. running(in:key:outputMap:) \u00b6 running(in:key:) \u00b6 onOutput(_:) \u00b6 Process an Output Parameter apply: On Output , mutate State as necessary and return new Output (or nil ). ignoringOutput() \u00b6 Wraps this workflow in a workflow that ignores all outputs. Returns: An AnyWorkflow with the same rendering and no output.","title":"AnyWorkflowConvertible"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#anyworkflowconvertible","text":"","title":"AnyWorkflowConvertible"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#mapoutput_","text":"","title":"mapOutput(_:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#maprendering_","text":"","title":"mapRendering(_:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#renderedinkey","text":"Creates or updates a child workflow of the given type, performs a render pass, and returns the result. Note that it is a programmer error to render two instances of a given workflow type with the same key during the same render pass. Parameter context: The context with which the workflow will be rendered. Parameter key: A string that uniquely identifies this workflow. Returns: The Rendering generated by the workflow.","title":"rendered(in:key:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#renderedinkeyoutputmap","text":"","title":"rendered(in:key:outputMap:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#renderedinkey_1","text":"","title":"rendered(in:key:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#renderedinkey_2","text":"Creates or updates a child workflow of the given type, performs a render pass, and returns the result. Note that it is a programmer error to render two instances of a given workflow type with the same key during the same render pass. Parameter context: The context with which the workflow will be rendered. Parameter key: A string that uniquely identifies this workflow. Returns: The Rendering generated by the workflow.","title":"rendered(in:key:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#runninginkeyoutputmap","text":"","title":"running(in:key:outputMap:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#runninginkey","text":"","title":"running(in:key:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#onoutput_","text":"Process an Output Parameter apply: On Output , mutate State as necessary and return new Output (or nil ).","title":"onOutput(_:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#ignoringoutput","text":"Wraps this workflow in a workflow that ignores all outputs. Returns: An AnyWorkflow with the same rendering and no output.","title":"ignoringOutput()"},{"location":"swift/api/Workflow/extensions/DispatchQueue/","text":"EXTENSION DispatchQueue \u00b6 Properties \u00b6 workflowExecution \u00b6","title":"DispatchQueue"},{"location":"swift/api/Workflow/extensions/DispatchQueue/#dispatchqueue","text":"","title":"DispatchQueue"},{"location":"swift/api/Workflow/extensions/DispatchQueue/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/extensions/DispatchQueue/#workflowexecution","text":"","title":"workflowExecution"},{"location":"swift/api/Workflow/extensions/RenderContext/","text":"EXTENSION RenderContext \u00b6 Methods \u00b6 makeSink(of:onEvent:) \u00b6 makeOutputSink() \u00b6 Generates a sink that allows sending the Workflow\u2019s output wrapped in an AnyWorkflowAction, allowing bypassing an intermediate action. makeStateMutationSink() \u00b6 Creates StateMutationSink . To create a sink: let stateMutationSink = context.makeStateMutationSink() To mutate State on an event: stateMutationSink.send(\\State.value, value: 10)","title":"RenderContext"},{"location":"swift/api/Workflow/extensions/RenderContext/#rendercontext","text":"","title":"RenderContext"},{"location":"swift/api/Workflow/extensions/RenderContext/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/extensions/RenderContext/#makesinkofonevent","text":"","title":"makeSink(of:onEvent:)"},{"location":"swift/api/Workflow/extensions/RenderContext/#makeoutputsink","text":"Generates a sink that allows sending the Workflow\u2019s output wrapped in an AnyWorkflowAction, allowing bypassing an intermediate action.","title":"makeOutputSink()"},{"location":"swift/api/Workflow/extensions/RenderContext/#makestatemutationsink","text":"Creates StateMutationSink . To create a sink: let stateMutationSink = context.makeStateMutationSink() To mutate State on an event: stateMutationSink.send(\\State.value, value: 10)","title":"makeStateMutationSink()"},{"location":"swift/api/Workflow/extensions/Workflow/","text":"EXTENSION Workflow \u00b6 Methods \u00b6 workflowDidChange(from:state:) \u00b6 makeInitialState() \u00b6 workflowDidChange(from:state:) \u00b6 asAnyWorkflow() \u00b6","title":"Workflow"},{"location":"swift/api/Workflow/extensions/Workflow/#workflow","text":"","title":"Workflow"},{"location":"swift/api/Workflow/extensions/Workflow/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/extensions/Workflow/#workflowdidchangefromstate","text":"","title":"workflowDidChange(from:state:)"},{"location":"swift/api/Workflow/extensions/Workflow/#makeinitialstate","text":"","title":"makeInitialState()"},{"location":"swift/api/Workflow/extensions/Workflow/#workflowdidchangefromstate_1","text":"","title":"workflowDidChange(from:state:)"},{"location":"swift/api/Workflow/extensions/Workflow/#asanyworkflow","text":"","title":"asAnyWorkflow()"},{"location":"swift/api/Workflow/extensions/WorkflowLogging.Config/","text":"EXTENSION WorkflowLogging.Config \u00b6 Properties \u00b6 debug \u00b6 Logging config that will output the most information. Will also have the most noticeable effect on performance. rootRendersAndActions \u00b6 Logging config that will record render timings for root nodes as well as action events. This provides a reasonable performance tradeoff if you\u2019re interested in the runtime\u2019s behavior but don\u2019t wan to pay the price of logging everything.","title":"WorkflowLogging.Config"},{"location":"swift/api/Workflow/extensions/WorkflowLogging.Config/#workflowloggingconfig","text":"","title":"WorkflowLogging.Config"},{"location":"swift/api/Workflow/extensions/WorkflowLogging.Config/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/extensions/WorkflowLogging.Config/#debug","text":"Logging config that will output the most information. Will also have the most noticeable effect on performance.","title":"debug"},{"location":"swift/api/Workflow/extensions/WorkflowLogging.Config/#rootrendersandactions","text":"Logging config that will record render timings for root nodes as well as action events. This provides a reasonable performance tradeoff if you\u2019re interested in the runtime\u2019s behavior but don\u2019t wan to pay the price of logging everything.","title":"rootRendersAndActions"},{"location":"swift/api/Workflow/extensions/WorkflowLogging/","text":"EXTENSION WorkflowLogging \u00b6 Properties \u00b6 enabled \u00b6 Global setting to enable or disable logging. Note, this is independent of the specified config value, and simply governs whether the runtime should emit any logs. To enable logging, at a minimum you must set: WorkflowLogging.enabled = true If you wish for more control over what the runtime will log, you may additionally specify a custom value for WorkflowLogging.config . config \u00b6 Configuration options used to determine which activities are logged.","title":"WorkflowLogging"},{"location":"swift/api/Workflow/extensions/WorkflowLogging/#workflowlogging","text":"","title":"WorkflowLogging"},{"location":"swift/api/Workflow/extensions/WorkflowLogging/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/extensions/WorkflowLogging/#enabled","text":"Global setting to enable or disable logging. Note, this is independent of the specified config value, and simply governs whether the runtime should emit any logs. To enable logging, at a minimum you must set: WorkflowLogging.enabled = true If you wish for more control over what the runtime will log, you may additionally specify a custom value for WorkflowLogging.config .","title":"enabled"},{"location":"swift/api/Workflow/extensions/WorkflowLogging/#config","text":"Configuration options used to determine which activities are logged.","title":"config"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/","text":"EXTENSION WorkflowObserver \u00b6 Methods \u00b6 sessionDidBegin(_:) \u00b6 sessionDidEnd(_:) \u00b6 workflowDidMakeInitialState(_:initialState:session:) \u00b6 workflowWillRender(_:state:session:) \u00b6 workflowDidChange(from:to:state:session:) \u00b6 workflowDidReceiveAction(_:workflow:session:) \u00b6 workflowWillApplyAction(_:workflow:state:session:) \u00b6","title":"WorkflowObserver"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/#workflowobserver","text":"","title":"WorkflowObserver"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/#sessiondidbegin_","text":"","title":"sessionDidBegin(_:)"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/#sessiondidend_","text":"","title":"sessionDidEnd(_:)"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/#workflowdidmakeinitialstate_initialstatesession","text":"","title":"workflowDidMakeInitialState(_:initialState:session:)"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/#workflowwillrender_statesession","text":"","title":"workflowWillRender(_:state:session:)"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/#workflowdidchangefromtostatesession","text":"","title":"workflowDidChange(from:to:state:session:)"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/#workflowdidreceiveaction_workflowsession","text":"","title":"workflowDidReceiveAction(_:workflow:session:)"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/#workflowwillapplyaction_workflowstatesession","text":"","title":"workflowWillApplyAction(_:workflow:state:session:)"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Kind/","text":"EXTENSION WorkflowUpdateDebugInfo.Kind \u00b6 Methods \u00b6 encode(to:) \u00b6 init(from:) \u00b6","title":"WorkflowUpdateDebugInfo.Kind"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Kind/#workflowupdatedebuginfokind","text":"","title":"WorkflowUpdateDebugInfo.Kind"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Kind/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Kind/#encodeto","text":"","title":"encode(to:)"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Kind/#initfrom","text":"","title":"init(from:)"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Source/","text":"EXTENSION WorkflowUpdateDebugInfo.Source \u00b6 Methods \u00b6 encode(to:) \u00b6 init(from:) \u00b6","title":"WorkflowUpdateDebugInfo.Source"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Source/#workflowupdatedebuginfosource","text":"","title":"WorkflowUpdateDebugInfo.Source"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Source/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Source/#encodeto","text":"","title":"encode(to:)"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Source/#initfrom","text":"","title":"init(from:)"},{"location":"swift/api/Workflow/protocols/AnyWorkflowConvertible/","text":"PROTOCOL AnyWorkflowConvertible \u00b6 Conforming types can be converted into AnyWorkflow values, allowing them to participate in a workflow hierarchy. Methods \u00b6 asAnyWorkflow() \u00b6 Returns an AnyWorkflow representing this value.","title":"AnyWorkflowConvertible"},{"location":"swift/api/Workflow/protocols/AnyWorkflowConvertible/#anyworkflowconvertible","text":"Conforming types can be converted into AnyWorkflow values, allowing them to participate in a workflow hierarchy.","title":"AnyWorkflowConvertible"},{"location":"swift/api/Workflow/protocols/AnyWorkflowConvertible/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/protocols/AnyWorkflowConvertible/#asanyworkflow","text":"Returns an AnyWorkflow representing this value.","title":"asAnyWorkflow()"},{"location":"swift/api/Workflow/protocols/ObserversInterceptor/","text":"PROTOCOL ObserversInterceptor \u00b6 Methods \u00b6 workflowObservers(for:) \u00b6 Provides a single access point to provide the final list of WorkflowObserver used by the runtime. This may be used to ensure a known set of observers is used in a particular order for all WorkflowHost s created over the life of a program. - Parameter initialObservers: Array of observers passed to a WorkflowHost constructor - Returns: The array of WorkflowObserver s to be used by the WorkflowHost","title":"ObserversInterceptor"},{"location":"swift/api/Workflow/protocols/ObserversInterceptor/#observersinterceptor","text":"","title":"ObserversInterceptor"},{"location":"swift/api/Workflow/protocols/ObserversInterceptor/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/protocols/ObserversInterceptor/#workflowobserversfor","text":"Provides a single access point to provide the final list of WorkflowObserver used by the runtime. This may be used to ensure a known set of observers is used in a particular order for all WorkflowHost s created over the life of a program. - Parameter initialObservers: Array of observers passed to a WorkflowHost constructor - Returns: The array of WorkflowObserver s to be used by the WorkflowHost","title":"workflowObservers(for:)"},{"location":"swift/api/Workflow/protocols/Workflow/","text":"PROTOCOL Workflow \u00b6 Defines a node in the workflow tree. Initialization and Updating A workflow node comes into existence after its parent produces an instance of that workflow and uses it during a render pass (see the render method for more details). If this is the first time the parent has rendered a child of this type, a new workflow node is created. The workflow passed in from the parent will be used to invoke initialState() to obtain an initial state. If the parent had previously rendered a child of this type, the existing workflow node will be updated. workflowDidChange(from:state:) will be invoked to allow the workflow to respond to the change. Render After a workflow node has been created, or any time its state changes, a render pass occurs. The render pass takes the workflow that was passed down from the parent along with the current state and generates a value of type Rendering . In a common case, a workflow might render to a screen model for display. func render(state: State, context: RenderContext) -> MyScreenModel { return MyScreenModel() } Methods \u00b6 makeInitialState() \u00b6 This method is invoked once when a workflow node comes into existence. Returns: The initial state for the workflow. workflowDidChange(from:state:) \u00b6 Called when a new workflow is passed down from the parent to an existing workflow node. Parameter previousWorkflow: The workflow before the update. Parameter state: The current state. render(state:context:) \u00b6 Called by the internal Workflow infrastructure to \u201crender\u201d the current state into Rendering . A workflow\u2019s Rendering type is commonly a view or screen model. Parameter state: The current state. Parameter context: The workflow context is the composition point for the workflow tree. To use a nested workflow, instantiate it based on the current state, then call rendered(in:key:outputMap:) . This will return the child\u2019s Rendering type after creating or updating the nested workflow.","title":"Workflow"},{"location":"swift/api/Workflow/protocols/Workflow/#workflow","text":"Defines a node in the workflow tree. Initialization and Updating A workflow node comes into existence after its parent produces an instance of that workflow and uses it during a render pass (see the render method for more details). If this is the first time the parent has rendered a child of this type, a new workflow node is created. The workflow passed in from the parent will be used to invoke initialState() to obtain an initial state. If the parent had previously rendered a child of this type, the existing workflow node will be updated. workflowDidChange(from:state:) will be invoked to allow the workflow to respond to the change. Render After a workflow node has been created, or any time its state changes, a render pass occurs. The render pass takes the workflow that was passed down from the parent along with the current state and generates a value of type Rendering . In a common case, a workflow might render to a screen model for display. func render(state: State, context: RenderContext) -> MyScreenModel { return MyScreenModel() }","title":"Workflow"},{"location":"swift/api/Workflow/protocols/Workflow/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/protocols/Workflow/#makeinitialstate","text":"This method is invoked once when a workflow node comes into existence. Returns: The initial state for the workflow.","title":"makeInitialState()"},{"location":"swift/api/Workflow/protocols/Workflow/#workflowdidchangefromstate","text":"Called when a new workflow is passed down from the parent to an existing workflow node. Parameter previousWorkflow: The workflow before the update. Parameter state: The current state.","title":"workflowDidChange(from:state:)"},{"location":"swift/api/Workflow/protocols/Workflow/#renderstatecontext","text":"Called by the internal Workflow infrastructure to \u201crender\u201d the current state into Rendering . A workflow\u2019s Rendering type is commonly a view or screen model. Parameter state: The current state. Parameter context: The workflow context is the composition point for the workflow tree. To use a nested workflow, instantiate it based on the current state, then call rendered(in:key:outputMap:) . This will return the child\u2019s Rendering type after creating or updating the nested workflow.","title":"render(state:context:)"},{"location":"swift/api/Workflow/protocols/WorkflowAction/","text":"PROTOCOL WorkflowAction \u00b6 Conforming types represent an action that advances a workflow. When applied, an action emits the next state and / or output for the workflow. Methods \u00b6 apply(toState:) \u00b6 Applies this action to a given state of the workflow, optionally returning an output event. Parameter state: The current state of the workflow. The state is passed as an inout param, allowing actions to modify state during application. Returns: An optional output event for the workflow. If an output event is returned, it will be passed up the workflow hierarchy to this workflow\u2019s parent.","title":"WorkflowAction"},{"location":"swift/api/Workflow/protocols/WorkflowAction/#workflowaction","text":"Conforming types represent an action that advances a workflow. When applied, an action emits the next state and / or output for the workflow.","title":"WorkflowAction"},{"location":"swift/api/Workflow/protocols/WorkflowAction/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/protocols/WorkflowAction/#applytostate","text":"Applies this action to a given state of the workflow, optionally returning an output event. Parameter state: The current state of the workflow. The state is passed as an inout param, allowing actions to modify state during application. Returns: An optional output event for the workflow. If an output event is returned, it will be passed up the workflow hierarchy to this workflow\u2019s parent.","title":"apply(toState:)"},{"location":"swift/api/Workflow/protocols/WorkflowDebugger/","text":"PROTOCOL WorkflowDebugger \u00b6 Defines a type that receives debug information about a running workflow hierarchy. Methods \u00b6 didEnterInitialState(snapshot:) \u00b6 Called once when the workflow hierarchy initializes. Parameter snapshot: Debug information about the workflow hierarchy. didUpdate(snapshot:updateInfo:) \u00b6 Called when an update occurs anywhere within the workflow hierarchy. Parameter snapshot: Debug information about the workflow hierarchy after the update. Parameter updateInfo: Information about the update.","title":"WorkflowDebugger"},{"location":"swift/api/Workflow/protocols/WorkflowDebugger/#workflowdebugger","text":"Defines a type that receives debug information about a running workflow hierarchy.","title":"WorkflowDebugger"},{"location":"swift/api/Workflow/protocols/WorkflowDebugger/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/protocols/WorkflowDebugger/#didenterinitialstatesnapshot","text":"Called once when the workflow hierarchy initializes. Parameter snapshot: Debug information about the workflow hierarchy.","title":"didEnterInitialState(snapshot:)"},{"location":"swift/api/Workflow/protocols/WorkflowDebugger/#didupdatesnapshotupdateinfo","text":"Called when an update occurs anywhere within the workflow hierarchy. Parameter snapshot: Debug information about the workflow hierarchy after the update. Parameter updateInfo: Information about the update.","title":"didUpdate(snapshot:updateInfo:)"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/","text":"PROTOCOL WorkflowObserver \u00b6 The WorkflowObserver protocol provides an interface to receive updates during the runtime\u2019s execution loop. All requirements are optional, and no-ops are provided by default. Methods \u00b6 sessionDidBegin(_:) \u00b6 Indicates the start of a WorkflowSession , which tracks the life of the underlying WorkflowNode used to provide renderings for a given Workflow type and rendering key. - Parameter session: The WorkflowSession that began. sessionDidEnd(_:) \u00b6 Marks the end of a WorkflowSession , indicating that the corresponding WorkflowNode has been removed from the tree of Workflows. - Parameter session: The WorkflowSession that ended. workflowDidMakeInitialState(_:initialState:session:) \u00b6 Indicates a Workflow produced its initial state value. - Parameters: - workflow: The Workflow that just produced its initial state. - initialState: The State that was created. - session: The WorkflowSession corresponding to the backing WorkflowNode workflowWillRender(_:state:session:) \u00b6 Called before a Workflow is queried for its latest Rendering . - Parameters: - workflow: The Workflow that is about to be render. - state: The corresponding State that will be used during the render call. - session: The WorkflowSession corresponding to the backing WorkflowNode . - Returns: An optional closure to be called immediately after the new Rendering is produced, which takes the rendering as the only parameter. workflowDidChange(from:to:state:session:) \u00b6 Called after an existing Workflow is updated. - Parameters: - oldWorkflow: The previous Workflow - newWorkflow: The new Workflow - state: The state after the update has occurred. - session: The WorkflowSession corresponding to the backing WorkflowNode . workflowDidReceiveAction(_:workflow:session:) \u00b6 Called after a WorkflowAction is received, but before it has been handled and propagated up the tree. - Parameters: - action: The action that was received. - session: The WorkflowSession corresponding to the backing WorkflowNode . workflowWillApplyAction(_:workflow:state:session:) \u00b6 Called when a WorkflowAction will be applied to its corresponding Workflow\u2019s State - Parameters: - action: The action that will be applied. - workflow: The action\u2019s corresponding Workflow . - state: The state to which the action will be applied. - session: The WorkflowSession corresponding to the backing WorkflowNode . - Returns: An optional closure to be called immediately after the action is applied to the State , and an optional Output has been produced. The closure takes the updated state and optional output as its arguments.","title":"WorkflowObserver"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/#workflowobserver","text":"The WorkflowObserver protocol provides an interface to receive updates during the runtime\u2019s execution loop. All requirements are optional, and no-ops are provided by default.","title":"WorkflowObserver"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/#sessiondidbegin_","text":"Indicates the start of a WorkflowSession , which tracks the life of the underlying WorkflowNode used to provide renderings for a given Workflow type and rendering key. - Parameter session: The WorkflowSession that began.","title":"sessionDidBegin(_:)"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/#sessiondidend_","text":"Marks the end of a WorkflowSession , indicating that the corresponding WorkflowNode has been removed from the tree of Workflows. - Parameter session: The WorkflowSession that ended.","title":"sessionDidEnd(_:)"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/#workflowdidmakeinitialstate_initialstatesession","text":"Indicates a Workflow produced its initial state value. - Parameters: - workflow: The Workflow that just produced its initial state. - initialState: The State that was created. - session: The WorkflowSession corresponding to the backing WorkflowNode","title":"workflowDidMakeInitialState(_:initialState:session:)"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/#workflowwillrender_statesession","text":"Called before a Workflow is queried for its latest Rendering . - Parameters: - workflow: The Workflow that is about to be render. - state: The corresponding State that will be used during the render call. - session: The WorkflowSession corresponding to the backing WorkflowNode . - Returns: An optional closure to be called immediately after the new Rendering is produced, which takes the rendering as the only parameter.","title":"workflowWillRender(_:state:session:)"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/#workflowdidchangefromtostatesession","text":"Called after an existing Workflow is updated. - Parameters: - oldWorkflow: The previous Workflow - newWorkflow: The new Workflow - state: The state after the update has occurred. - session: The WorkflowSession corresponding to the backing WorkflowNode .","title":"workflowDidChange(from:to:state:session:)"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/#workflowdidreceiveaction_workflowsession","text":"Called after a WorkflowAction is received, but before it has been handled and propagated up the tree. - Parameters: - action: The action that was received. - session: The WorkflowSession corresponding to the backing WorkflowNode .","title":"workflowDidReceiveAction(_:workflow:session:)"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/#workflowwillapplyaction_workflowstatesession","text":"Called when a WorkflowAction will be applied to its corresponding Workflow\u2019s State - Parameters: - action: The action that will be applied. - workflow: The action\u2019s corresponding Workflow . - state: The state to which the action will be applied. - session: The WorkflowSession corresponding to the backing WorkflowNode . - Returns: An optional closure to be called immediately after the action is applied to the State , and an optional Output has been produced. The closure takes the updated state and optional output as its arguments.","title":"workflowWillApplyAction(_:workflow:state:session:)"},{"location":"swift/api/Workflow/structs/AnyWorkflow/","text":"STRUCT AnyWorkflow \u00b6 A type-erased wrapper that contains a workflow with the given Rendering and Output types. Properties \u00b6 base \u00b6 The underlying erased workflow instance workflowType \u00b6 The underlying workflow\u2019s implementation type. Methods \u00b6 init(_:) \u00b6 Initializes a new type-erased wrapper for the given workflow.","title":"AnyWorkflow"},{"location":"swift/api/Workflow/structs/AnyWorkflow/#anyworkflow","text":"A type-erased wrapper that contains a workflow with the given Rendering and Output types.","title":"AnyWorkflow"},{"location":"swift/api/Workflow/structs/AnyWorkflow/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/structs/AnyWorkflow/#base","text":"The underlying erased workflow instance","title":"base"},{"location":"swift/api/Workflow/structs/AnyWorkflow/#workflowtype","text":"The underlying workflow\u2019s implementation type.","title":"workflowType"},{"location":"swift/api/Workflow/structs/AnyWorkflow/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/structs/AnyWorkflow/#init_","text":"Initializes a new type-erased wrapper for the given workflow.","title":"init(_:)"},{"location":"swift/api/Workflow/structs/AnyWorkflowAction/","text":"STRUCT AnyWorkflowAction \u00b6 A type-erased workflow action. The AnyWorkflowAction type forwards apply to an underlying workflow action, hiding its specific underlying type. Properties \u00b6 base \u00b6 The underlying type-erased WorkflowAction isClosureBased \u00b6 True iff the underlying apply implementation is defined by a closure vs wrapping a WorkflowAction conformance Methods \u00b6 init(_:) \u00b6 Creates a type-erased workflow action that wraps the given instance. Parameter base: A workflow action to wrap. init(_:fileID:line:) \u00b6 Creates a type-erased workflow action with the given apply implementation. Parameter apply: the apply function for the resulting action. apply(toState:) \u00b6","title":"AnyWorkflowAction"},{"location":"swift/api/Workflow/structs/AnyWorkflowAction/#anyworkflowaction","text":"A type-erased workflow action. The AnyWorkflowAction type forwards apply to an underlying workflow action, hiding its specific underlying type.","title":"AnyWorkflowAction"},{"location":"swift/api/Workflow/structs/AnyWorkflowAction/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/structs/AnyWorkflowAction/#base","text":"The underlying type-erased WorkflowAction","title":"base"},{"location":"swift/api/Workflow/structs/AnyWorkflowAction/#isclosurebased","text":"True iff the underlying apply implementation is defined by a closure vs wrapping a WorkflowAction conformance","title":"isClosureBased"},{"location":"swift/api/Workflow/structs/AnyWorkflowAction/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/structs/AnyWorkflowAction/#init_","text":"Creates a type-erased workflow action that wraps the given instance. Parameter base: A workflow action to wrap.","title":"init(_:)"},{"location":"swift/api/Workflow/structs/AnyWorkflowAction/#init_fileidline","text":"Creates a type-erased workflow action with the given apply implementation. Parameter apply: the apply function for the resulting action.","title":"init(_:fileID:line:)"},{"location":"swift/api/Workflow/structs/AnyWorkflowAction/#applytostate","text":"","title":"apply(toState:)"},{"location":"swift/api/Workflow/structs/Sink/","text":"STRUCT Sink \u00b6 Sink is a type that receives incoming values (commonly events or WorkflowAction ) Use RenderContext.makeSink to create instances. Methods \u00b6 init(_:) \u00b6 Initializes a new sink with the given closure. send(_:) \u00b6 Sends a new event into the sink. Parameter event: The value to send into the sink. contraMap(_:) \u00b6 Generates a new sink of type NewValue. Given a transform closure, the following code is functionally equivalent: sink.send(transform(value)) sink.contraMap(transform).send(value) Trivia : Why is this called contraMap ? - map turns Type into Type via (T)->U . - contraMap turns Type into Type via (U)->T Another way to think about this is: map transforms a type by changing the output types of its API, while contraMap transforms a type by changing the input types of its API. Parameter transform: An escaping closure that transforms T into Event .","title":"Sink"},{"location":"swift/api/Workflow/structs/Sink/#sink","text":"Sink is a type that receives incoming values (commonly events or WorkflowAction ) Use RenderContext.makeSink to create instances.","title":"Sink"},{"location":"swift/api/Workflow/structs/Sink/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/structs/Sink/#init_","text":"Initializes a new sink with the given closure.","title":"init(_:)"},{"location":"swift/api/Workflow/structs/Sink/#send_","text":"Sends a new event into the sink. Parameter event: The value to send into the sink.","title":"send(_:)"},{"location":"swift/api/Workflow/structs/Sink/#contramap_","text":"Generates a new sink of type NewValue. Given a transform closure, the following code is functionally equivalent: sink.send(transform(value)) sink.contraMap(transform).send(value) Trivia : Why is this called contraMap ? - map turns Type into Type via (T)->U . - contraMap turns Type into Type via (U)->T Another way to think about this is: map transforms a type by changing the output types of its API, while contraMap transforms a type by changing the input types of its API. Parameter transform: An escaping closure that transforms T into Event .","title":"contraMap(_:)"},{"location":"swift/api/Workflow/structs/StateMutationSink/","text":"STRUCT StateMutationSink \u00b6 StateMutationSink provides a Sink that helps mutate State using it\u2019s KeyPath . Methods \u00b6 send(_:) \u00b6 Sends message to StateMutationSink to update State \u2019s value using the provided closure. Parameters: update: The State mutation to perform. send(_:value:) \u00b6 Sends message to StateMutationSink to update State \u2019s value at KeyPath with Value . Parameters: keyPath: Key path of State whose value needs to be mutated. value: Value to update State with.","title":"StateMutationSink"},{"location":"swift/api/Workflow/structs/StateMutationSink/#statemutationsink","text":"StateMutationSink provides a Sink that helps mutate State using it\u2019s KeyPath .","title":"StateMutationSink"},{"location":"swift/api/Workflow/structs/StateMutationSink/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/structs/StateMutationSink/#send_","text":"Sends message to StateMutationSink to update State \u2019s value using the provided closure. Parameters: update: The State mutation to perform.","title":"send(_:)"},{"location":"swift/api/Workflow/structs/StateMutationSink/#send_value","text":"Sends message to StateMutationSink to update State \u2019s value at KeyPath with Value . Parameters: keyPath: Key path of State whose value needs to be mutated. value: Value to update State with.","title":"send(_:value:)"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot.Child/","text":"STRUCT WorkflowHierarchyDebugSnapshot.Child \u00b6 Properties \u00b6 key \u00b6 snapshot \u00b6","title":"WorkflowHierarchyDebugSnapshot.Child"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot.Child/#workflowhierarchydebugsnapshotchild","text":"","title":"WorkflowHierarchyDebugSnapshot.Child"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot.Child/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot.Child/#key","text":"","title":"key"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot.Child/#snapshot","text":"","title":"snapshot"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot/","text":"STRUCT WorkflowHierarchyDebugSnapshot \u00b6 Properties \u00b6 workflowType \u00b6 stateDescription \u00b6 children \u00b6","title":"WorkflowHierarchyDebugSnapshot"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot/#workflowhierarchydebugsnapshot","text":"","title":"WorkflowHierarchyDebugSnapshot"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot/#workflowtype","text":"","title":"workflowType"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot/#statedescription","text":"","title":"stateDescription"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot/#children","text":"","title":"children"},{"location":"swift/api/Workflow/structs/WorkflowLogging.Config/","text":"STRUCT WorkflowLogging.Config \u00b6 Properties \u00b6 renderLoggingMode \u00b6 logLifetimes \u00b6 When true , the interval spanning a WorkflowNode\u2019s lifetime will be recorded. logActions \u00b6 When true , action events will be recorded.","title":"WorkflowLogging.Config"},{"location":"swift/api/Workflow/structs/WorkflowLogging.Config/#workflowloggingconfig","text":"","title":"WorkflowLogging.Config"},{"location":"swift/api/Workflow/structs/WorkflowLogging.Config/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/structs/WorkflowLogging.Config/#renderloggingmode","text":"","title":"renderLoggingMode"},{"location":"swift/api/Workflow/structs/WorkflowLogging.Config/#loglifetimes","text":"When true , the interval spanning a WorkflowNode\u2019s lifetime will be recorded.","title":"logLifetimes"},{"location":"swift/api/Workflow/structs/WorkflowLogging.Config/#logactions","text":"When true , action events will be recorded.","title":"logActions"},{"location":"swift/api/Workflow/structs/WorkflowSession.Identifier/","text":"STRUCT WorkflowSession.Identifier \u00b6","title":"WorkflowSession.Identifier"},{"location":"swift/api/Workflow/structs/WorkflowSession.Identifier/#workflowsessionidentifier","text":"","title":"WorkflowSession.Identifier"},{"location":"swift/api/Workflow/structs/WorkflowSession/","text":"STRUCT WorkflowSession \u00b6 A WorkflowSession encapsulates the information that gives a WorkflowNode its identity. In particular, it captures: - The type of the corresponding Workflow conformance. - The String key used when the workflow was rendered. - An Identifier type that is unique across program execution. - An optional reference to a parent WorkflowSession , to differentiate root nodes. Properties \u00b6 workflowType \u00b6 renderKey \u00b6 sessionID \u00b6 parent \u00b6","title":"WorkflowSession"},{"location":"swift/api/Workflow/structs/WorkflowSession/#workflowsession","text":"A WorkflowSession encapsulates the information that gives a WorkflowNode its identity. In particular, it captures: - The type of the corresponding Workflow conformance. - The String key used when the workflow was rendered. - An Identifier type that is unique across program execution. - An optional reference to a parent WorkflowSession , to differentiate root nodes.","title":"WorkflowSession"},{"location":"swift/api/Workflow/structs/WorkflowSession/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/structs/WorkflowSession/#workflowtype","text":"","title":"workflowType"},{"location":"swift/api/Workflow/structs/WorkflowSession/#renderkey","text":"","title":"renderKey"},{"location":"swift/api/Workflow/structs/WorkflowSession/#sessionid","text":"","title":"sessionID"},{"location":"swift/api/Workflow/structs/WorkflowSession/#parent","text":"","title":"parent"},{"location":"swift/api/Workflow/structs/WorkflowUpdateDebugInfo/","text":"STRUCT WorkflowUpdateDebugInfo \u00b6 Properties \u00b6 workflowType \u00b6 kind \u00b6","title":"WorkflowUpdateDebugInfo"},{"location":"swift/api/Workflow/structs/WorkflowUpdateDebugInfo/#workflowupdatedebuginfo","text":"","title":"WorkflowUpdateDebugInfo"},{"location":"swift/api/Workflow/structs/WorkflowUpdateDebugInfo/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/structs/WorkflowUpdateDebugInfo/#workflowtype","text":"","title":"workflowType"},{"location":"swift/api/Workflow/structs/WorkflowUpdateDebugInfo/#kind","text":"","title":"kind"},{"location":"swift/api/Workflow/typealiases/AnyWorkflow.Output/","text":"TYPEALIAS AnyWorkflow.Output \u00b6","title":"AnyWorkflow.Output"},{"location":"swift/api/Workflow/typealiases/AnyWorkflow.Output/#anyworkflowoutput","text":"","title":"AnyWorkflow.Output"},{"location":"swift/api/Workflow/typealiases/AnyWorkflow.Rendering/","text":"TYPEALIAS AnyWorkflow.Rendering \u00b6","title":"AnyWorkflow.Rendering"},{"location":"swift/api/Workflow/typealiases/AnyWorkflow.Rendering/#anyworkflowrendering","text":"","title":"AnyWorkflow.Rendering"},{"location":"swift/api/Workflow/typealiases/AnyWorkflow.State/","text":"TYPEALIAS AnyWorkflow.State \u00b6","title":"AnyWorkflow.State"},{"location":"swift/api/Workflow/typealiases/AnyWorkflow.State/#anyworkflowstate","text":"","title":"AnyWorkflow.State"},{"location":"swift/api/WorkflowReactiveSwift/","text":"Reference Documentation \u00b6 Protocols \u00b6 Worker Enums \u00b6 WorkerLogging Extensions \u00b6 Signal SignalProducer Worker WorkerLogging Typealiases \u00b6 SignalProducerWorkflow.Output SignalProducerWorkflow.Rendering SignalProducerWorkflow.State This file was generated by SourceDocs on 2024-01-22 20:46:25 +0000","title":"WorkflowReactiveSwift"},{"location":"swift/api/WorkflowReactiveSwift/#reference-documentation","text":"","title":"Reference Documentation"},{"location":"swift/api/WorkflowReactiveSwift/#protocols","text":"Worker","title":"Protocols"},{"location":"swift/api/WorkflowReactiveSwift/#enums","text":"WorkerLogging","title":"Enums"},{"location":"swift/api/WorkflowReactiveSwift/#extensions","text":"Signal SignalProducer Worker WorkerLogging","title":"Extensions"},{"location":"swift/api/WorkflowReactiveSwift/#typealiases","text":"SignalProducerWorkflow.Output SignalProducerWorkflow.Rendering SignalProducerWorkflow.State This file was generated by SourceDocs on 2024-01-22 20:46:25 +0000","title":"Typealiases"},{"location":"swift/api/WorkflowReactiveSwift/enums/WorkerLogging/","text":"ENUM WorkerLogging \u00b6","title":"WorkerLogging"},{"location":"swift/api/WorkflowReactiveSwift/enums/WorkerLogging/#workerlogging","text":"","title":"WorkerLogging"},{"location":"swift/api/WorkflowReactiveSwift/extensions/Signal/","text":"EXTENSION Signal \u00b6 Methods \u00b6 asAnyWorkflow() \u00b6","title":"Signal"},{"location":"swift/api/WorkflowReactiveSwift/extensions/Signal/#signal","text":"","title":"Signal"},{"location":"swift/api/WorkflowReactiveSwift/extensions/Signal/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowReactiveSwift/extensions/Signal/#asanyworkflow","text":"","title":"asAnyWorkflow()"},{"location":"swift/api/WorkflowReactiveSwift/extensions/SignalProducer/","text":"EXTENSION SignalProducer \u00b6 Methods \u00b6 asAnyWorkflow() \u00b6","title":"SignalProducer"},{"location":"swift/api/WorkflowReactiveSwift/extensions/SignalProducer/#signalproducer","text":"","title":"SignalProducer"},{"location":"swift/api/WorkflowReactiveSwift/extensions/SignalProducer/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowReactiveSwift/extensions/SignalProducer/#asanyworkflow","text":"","title":"asAnyWorkflow()"},{"location":"swift/api/WorkflowReactiveSwift/extensions/Worker/","text":"EXTENSION Worker \u00b6 Methods \u00b6 asAnyWorkflow() \u00b6 isEquivalent(to:) \u00b6","title":"Worker"},{"location":"swift/api/WorkflowReactiveSwift/extensions/Worker/#worker","text":"","title":"Worker"},{"location":"swift/api/WorkflowReactiveSwift/extensions/Worker/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowReactiveSwift/extensions/Worker/#asanyworkflow","text":"","title":"asAnyWorkflow()"},{"location":"swift/api/WorkflowReactiveSwift/extensions/Worker/#isequivalentto","text":"","title":"isEquivalent(to:)"},{"location":"swift/api/WorkflowReactiveSwift/extensions/WorkerLogging/","text":"EXTENSION WorkerLogging \u00b6 Properties \u00b6 enabled \u00b6","title":"WorkerLogging"},{"location":"swift/api/WorkflowReactiveSwift/extensions/WorkerLogging/#workerlogging","text":"","title":"WorkerLogging"},{"location":"swift/api/WorkflowReactiveSwift/extensions/WorkerLogging/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowReactiveSwift/extensions/WorkerLogging/#enabled","text":"","title":"enabled"},{"location":"swift/api/WorkflowReactiveSwift/protocols/Worker/","text":"PROTOCOL Worker \u00b6 Workers define a unit of asynchronous work. During a render pass, a workflow can ask the context to await the result of a worker. When this occurs, the context checks to see if there is already a running worker of the same type. If there is, and if the workers are \u2018equivalent\u2019, the context leaves the existing worker running. If there is not an existing worker of this type, the context will kick off the new worker (via run ). Methods \u00b6 run() \u00b6 Returns a signal producer to execute the work represented by this worker. isEquivalent(to:) \u00b6 Returns true if the other worker should be considered equivalent to self . Equivalence should take into account whatever data is meaningful to the task. For example, a worker that loads a user account from a server would not be equivalent to another worker with a different user ID.","title":"Worker"},{"location":"swift/api/WorkflowReactiveSwift/protocols/Worker/#worker","text":"Workers define a unit of asynchronous work. During a render pass, a workflow can ask the context to await the result of a worker. When this occurs, the context checks to see if there is already a running worker of the same type. If there is, and if the workers are \u2018equivalent\u2019, the context leaves the existing worker running. If there is not an existing worker of this type, the context will kick off the new worker (via run ).","title":"Worker"},{"location":"swift/api/WorkflowReactiveSwift/protocols/Worker/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowReactiveSwift/protocols/Worker/#run","text":"Returns a signal producer to execute the work represented by this worker.","title":"run()"},{"location":"swift/api/WorkflowReactiveSwift/protocols/Worker/#isequivalentto","text":"Returns true if the other worker should be considered equivalent to self . Equivalence should take into account whatever data is meaningful to the task. For example, a worker that loads a user account from a server would not be equivalent to another worker with a different user ID.","title":"isEquivalent(to:)"},{"location":"swift/api/WorkflowReactiveSwift/typealiases/SignalProducerWorkflow.Output/","text":"TYPEALIAS SignalProducerWorkflow.Output \u00b6","title":"SignalProducerWorkflow.Output"},{"location":"swift/api/WorkflowReactiveSwift/typealiases/SignalProducerWorkflow.Output/#signalproducerworkflowoutput","text":"","title":"SignalProducerWorkflow.Output"},{"location":"swift/api/WorkflowReactiveSwift/typealiases/SignalProducerWorkflow.Rendering/","text":"TYPEALIAS SignalProducerWorkflow.Rendering \u00b6","title":"SignalProducerWorkflow.Rendering"},{"location":"swift/api/WorkflowReactiveSwift/typealiases/SignalProducerWorkflow.Rendering/#signalproducerworkflowrendering","text":"","title":"SignalProducerWorkflow.Rendering"},{"location":"swift/api/WorkflowReactiveSwift/typealiases/SignalProducerWorkflow.State/","text":"TYPEALIAS SignalProducerWorkflow.State \u00b6","title":"SignalProducerWorkflow.State"},{"location":"swift/api/WorkflowReactiveSwift/typealiases/SignalProducerWorkflow.State/#signalproducerworkflowstate","text":"","title":"SignalProducerWorkflow.State"},{"location":"swift/api/WorkflowTesting/","text":"Reference Documentation \u00b6 Structs \u00b6 RenderTester RenderTesterResult WorkflowActionTester Extensions \u00b6 RenderTesterResult Workflow WorkflowAction WorkflowActionTester This file was generated by SourceDocs on 2024-01-22 20:46:14 +0000","title":"WorkflowTesting "},{"location":"swift/api/WorkflowTesting/#reference-documentation","text":"","title":"Reference Documentation"},{"location":"swift/api/WorkflowTesting/#structs","text":"RenderTester RenderTesterResult WorkflowActionTester","title":"Structs"},{"location":"swift/api/WorkflowTesting/#extensions","text":"RenderTesterResult Workflow WorkflowAction WorkflowActionTester This file was generated by SourceDocs on 2024-01-22 20:46:14 +0000","title":"Extensions"},{"location":"swift/api/WorkflowTesting/extensions/RenderTesterResult/","text":"EXTENSION RenderTesterResult \u00b6 Methods \u00b6 assert(state:file:line:) \u00b6 Verifies that the resulting state is equal to the given state. assertStateModifications(file:line:_:) \u00b6 Exhaustive state testing against the initial state. - Parameters: - modifications: A function that receives the initial state and is expected to mutate it to match the new state. assert(output:file:line:) \u00b6 Verifies that the resulting output is equal to the given output.","title":"RenderTesterResult"},{"location":"swift/api/WorkflowTesting/extensions/RenderTesterResult/#rendertesterresult","text":"","title":"RenderTesterResult"},{"location":"swift/api/WorkflowTesting/extensions/RenderTesterResult/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowTesting/extensions/RenderTesterResult/#assertstatefileline","text":"Verifies that the resulting state is equal to the given state.","title":"assert(state:file:line:)"},{"location":"swift/api/WorkflowTesting/extensions/RenderTesterResult/#assertstatemodificationsfileline_","text":"Exhaustive state testing against the initial state. - Parameters: - modifications: A function that receives the initial state and is expected to mutate it to match the new state.","title":"assertStateModifications(file:line:_:)"},{"location":"swift/api/WorkflowTesting/extensions/RenderTesterResult/#assertoutputfileline","text":"Verifies that the resulting output is equal to the given output.","title":"assert(output:file:line:)"},{"location":"swift/api/WorkflowTesting/extensions/Workflow/","text":"EXTENSION Workflow \u00b6 Methods \u00b6 renderTester(initialState:) \u00b6 Returns a RenderTester with a specified initial state. renderTester() \u00b6 Returns a RenderTester with an initial state provided by self.makeInitialState()","title":"Workflow"},{"location":"swift/api/WorkflowTesting/extensions/Workflow/#workflow","text":"","title":"Workflow"},{"location":"swift/api/WorkflowTesting/extensions/Workflow/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowTesting/extensions/Workflow/#rendertesterinitialstate","text":"Returns a RenderTester with a specified initial state.","title":"renderTester(initialState:)"},{"location":"swift/api/WorkflowTesting/extensions/Workflow/#rendertester","text":"Returns a RenderTester with an initial state provided by self.makeInitialState()","title":"renderTester()"},{"location":"swift/api/WorkflowTesting/extensions/WorkflowAction/","text":"EXTENSION WorkflowAction \u00b6 Methods \u00b6 tester(withState:) \u00b6 Returns a state tester containing self .","title":"WorkflowAction"},{"location":"swift/api/WorkflowTesting/extensions/WorkflowAction/#workflowaction","text":"","title":"WorkflowAction"},{"location":"swift/api/WorkflowTesting/extensions/WorkflowAction/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowTesting/extensions/WorkflowAction/#testerwithstate","text":"Returns a state tester containing self .","title":"tester(withState:)"},{"location":"swift/api/WorkflowTesting/extensions/WorkflowActionTester/","text":"EXTENSION WorkflowActionTester \u00b6 Methods \u00b6 assert(state:file:line:) \u00b6 Triggers a test failure if the current state does not match the given expected state Parameters: expectedState: The expected state returns: A tester containing the current state and output. assert(output:file:line:) \u00b6 Triggers a test failure if the produced output does not match the given expected output Parameters: expectedState: The expected output returns: A tester containing the current state and output.","title":"WorkflowActionTester"},{"location":"swift/api/WorkflowTesting/extensions/WorkflowActionTester/#workflowactiontester","text":"","title":"WorkflowActionTester"},{"location":"swift/api/WorkflowTesting/extensions/WorkflowActionTester/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowTesting/extensions/WorkflowActionTester/#assertstatefileline","text":"Triggers a test failure if the current state does not match the given expected state Parameters: expectedState: The expected state returns: A tester containing the current state and output.","title":"assert(state:file:line:)"},{"location":"swift/api/WorkflowTesting/extensions/WorkflowActionTester/#assertoutputfileline","text":"Triggers a test failure if the produced output does not match the given expected output Parameters: expectedState: The expected output returns: A tester containing the current state and output.","title":"assert(output:file:line:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTester/","text":"STRUCT RenderTester \u00b6 Testing helper for validating the behavior of calls to render . Usage: expect workflows and side effects then validate with a call to render and the resulting RenderTesterResult . Side-effects may be performed against the rendering to validate the behavior of actions. To directly test actions and their effects, use the WorkflowActionTester . workflow .renderTester(initialState: TestWorkflow.State()) .expect( worker: TestWorker(), producingOutput: TestWorker.Output.success ) .expectWorkflow( type: ChildWorkflow.self, key: \"key\", rendering: \"rendering\", // \u26a0\ufe0f N.B. Only one output per call to `render` may be produced, // even if multiple child Workflows are expected in a call // to `render`. This is an invariant enforced by `RenderTester` // and the real runtime. producingOutput: nil ) .render { rendering in XCTAssertEqual(\"expected text on rendering\", rendering.text) } .assert(state: TestWorkflow.State()) .assert(output: TestWorkflow.Output.finished) Validating the rendering only from the initial state provided by the workflow: workflow .renderTester() .render { rendering in XCTAssertEqual(\"expected text on rendering\", rendering.text) } Validate the state was updated from a callback on the rendering: workflow .renderTester() .render { rendering in XCTAssertEqual(\"expected text on rendering\", rendering.text) rendering.updateText(\"updated\") } .assert( state: TestWorkflow.State(text: \"updated\") ) Validate an output was received from the workflow. The action() on the rendering will cause an action that will return an output. workflow .renderTester() .render { rendering in rendering.action() } .assert( output: .success ) Validate a worker is running, and simulate the effect of its output: workflow .renderTester(initialState: TestWorkflow.State(loadingState: .loading)) .expect( worker: TestWorker(), output: TestWorker.Output.success ) .render { _ in } Validate a child workflow is run, and simulate the effect of its output: workflow .renderTester(initialState: TestWorkflow.State(loadingState: .loading)) .expectWorkflow( type: ChildWorkflow.self, rendering: \"rendering\", producingOutput: ChildWorkflow.Output.success ) .render { _ in } Methods \u00b6 expectWorkflow(type:key:producingRendering:producingOutput:file:line:assertions:) \u00b6 Expect the given workflow type in the next rendering. Parameters: type: The type of the expected workflow. key: The key of the expected workflow (if specified). rendering: The rendering result that should be returned when the workflow of this type is rendered. output: An output that should be returned after the workflow of this type is rendered, if any. assertions: Additional assertions for the given workflow, if any. You may use this to assert the properties of the requested workflow are as expected. expectWorkflowIgnoringOutput(type:key:producingRendering:file:line:assertions:) \u00b6 Expect the given workflow type in the next rendering, with its output being ignored by a call to ignoringOutput() . Parameters: type: The type of the expected workflow. key: The key of the expected workflow (if specified). rendering: The rendering result that should be returned when the workflow of this type is rendered. assertions: Additional assertions for the given workflow, if any. You may use this to assert the properties of the requested workflow are as expected. expectSideEffect(key:file:line:) \u00b6 Expect a side-effect for the given key. Parameter key: The key to expect. expectSideEffect(key:producingAction:file:line:) \u00b6 Expect a side-effect for the given key, and produce the given action when it is requested. Parameters: key: The key to expect. action: The action to produce when this side-effect is requested. render(file:line:assertions:) \u00b6 Render the workflow under test. At this point, you should have set up all expectations. The given assertions closure will be called with the produced rendering, allowing you to assert its properties or perform actions on it (such as closures that are wired up to a Sink inside the workflow. Parameters: assertions: A closure called with the produced rendering for verification Returns: A RenderTesterResult that can be used to verify expected resulting state or outputs.","title":"RenderTester"},{"location":"swift/api/WorkflowTesting/structs/RenderTester/#rendertester","text":"Testing helper for validating the behavior of calls to render . Usage: expect workflows and side effects then validate with a call to render and the resulting RenderTesterResult . Side-effects may be performed against the rendering to validate the behavior of actions. To directly test actions and their effects, use the WorkflowActionTester . workflow .renderTester(initialState: TestWorkflow.State()) .expect( worker: TestWorker(), producingOutput: TestWorker.Output.success ) .expectWorkflow( type: ChildWorkflow.self, key: \"key\", rendering: \"rendering\", // \u26a0\ufe0f N.B. Only one output per call to `render` may be produced, // even if multiple child Workflows are expected in a call // to `render`. This is an invariant enforced by `RenderTester` // and the real runtime. producingOutput: nil ) .render { rendering in XCTAssertEqual(\"expected text on rendering\", rendering.text) } .assert(state: TestWorkflow.State()) .assert(output: TestWorkflow.Output.finished) Validating the rendering only from the initial state provided by the workflow: workflow .renderTester() .render { rendering in XCTAssertEqual(\"expected text on rendering\", rendering.text) } Validate the state was updated from a callback on the rendering: workflow .renderTester() .render { rendering in XCTAssertEqual(\"expected text on rendering\", rendering.text) rendering.updateText(\"updated\") } .assert( state: TestWorkflow.State(text: \"updated\") ) Validate an output was received from the workflow. The action() on the rendering will cause an action that will return an output. workflow .renderTester() .render { rendering in rendering.action() } .assert( output: .success ) Validate a worker is running, and simulate the effect of its output: workflow .renderTester(initialState: TestWorkflow.State(loadingState: .loading)) .expect( worker: TestWorker(), output: TestWorker.Output.success ) .render { _ in } Validate a child workflow is run, and simulate the effect of its output: workflow .renderTester(initialState: TestWorkflow.State(loadingState: .loading)) .expectWorkflow( type: ChildWorkflow.self, rendering: \"rendering\", producingOutput: ChildWorkflow.Output.success ) .render { _ in }","title":"RenderTester"},{"location":"swift/api/WorkflowTesting/structs/RenderTester/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowTesting/structs/RenderTester/#expectworkflowtypekeyproducingrenderingproducingoutputfilelineassertions","text":"Expect the given workflow type in the next rendering. Parameters: type: The type of the expected workflow. key: The key of the expected workflow (if specified). rendering: The rendering result that should be returned when the workflow of this type is rendered. output: An output that should be returned after the workflow of this type is rendered, if any. assertions: Additional assertions for the given workflow, if any. You may use this to assert the properties of the requested workflow are as expected.","title":"expectWorkflow(type:key:producingRendering:producingOutput:file:line:assertions:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTester/#expectworkflowignoringoutputtypekeyproducingrenderingfilelineassertions","text":"Expect the given workflow type in the next rendering, with its output being ignored by a call to ignoringOutput() . Parameters: type: The type of the expected workflow. key: The key of the expected workflow (if specified). rendering: The rendering result that should be returned when the workflow of this type is rendered. assertions: Additional assertions for the given workflow, if any. You may use this to assert the properties of the requested workflow are as expected.","title":"expectWorkflowIgnoringOutput(type:key:producingRendering:file:line:assertions:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTester/#expectsideeffectkeyfileline","text":"Expect a side-effect for the given key. Parameter key: The key to expect.","title":"expectSideEffect(key:file:line:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTester/#expectsideeffectkeyproducingactionfileline","text":"Expect a side-effect for the given key, and produce the given action when it is requested. Parameters: key: The key to expect. action: The action to produce when this side-effect is requested.","title":"expectSideEffect(key:producingAction:file:line:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTester/#renderfilelineassertions","text":"Render the workflow under test. At this point, you should have set up all expectations. The given assertions closure will be called with the produced rendering, allowing you to assert its properties or perform actions on it (such as closures that are wired up to a Sink inside the workflow. Parameters: assertions: A closure called with the produced rendering for verification Returns: A RenderTesterResult that can be used to verify expected resulting state or outputs.","title":"render(file:line:assertions:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTesterResult/","text":"STRUCT RenderTesterResult \u00b6 The result of a RenderTester rendering. Used to verify state, output, and actions that were produced as a result of actions performed during the render (such as child workflow output being produced). Methods \u00b6 verifyState(file:line:assertions:) \u00b6 Allows for assertions against the resulting state. assertNoAction(file:line:) \u00b6 Asserts that no actions were produced verifyAction(type:file:line:assertions:) \u00b6 Allows for assertions agains the resulting action assert(action:file:line:) \u00b6 Asserts that the resulting action is equal to the given action. assertNoOutput(file:line:) \u00b6 Asserts that no output was produced. verifyOutput(file:line:assertions:) \u00b6 Allows for assertions agains the resulting output","title":"RenderTesterResult"},{"location":"swift/api/WorkflowTesting/structs/RenderTesterResult/#rendertesterresult","text":"The result of a RenderTester rendering. Used to verify state, output, and actions that were produced as a result of actions performed during the render (such as child workflow output being produced).","title":"RenderTesterResult"},{"location":"swift/api/WorkflowTesting/structs/RenderTesterResult/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowTesting/structs/RenderTesterResult/#verifystatefilelineassertions","text":"Allows for assertions against the resulting state.","title":"verifyState(file:line:assertions:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTesterResult/#assertnoactionfileline","text":"Asserts that no actions were produced","title":"assertNoAction(file:line:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTesterResult/#verifyactiontypefilelineassertions","text":"Allows for assertions agains the resulting action","title":"verifyAction(type:file:line:assertions:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTesterResult/#assertactionfileline","text":"Asserts that the resulting action is equal to the given action.","title":"assert(action:file:line:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTesterResult/#assertnooutputfileline","text":"Asserts that no output was produced.","title":"assertNoOutput(file:line:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTesterResult/#verifyoutputfilelineassertions","text":"Allows for assertions agains the resulting output","title":"verifyOutput(file:line:assertions:)"},{"location":"swift/api/WorkflowTesting/structs/WorkflowActionTester/","text":"STRUCT WorkflowActionTester \u00b6 Testing helper that chains action sending and state/output assertions to make tests easier to write. MyWorkflow.Action .tester(withState: .firstState) .send(action: .exampleAction) .verifyOutput { output in XCTAssertEqual(.finished, output) } .verifyState { state in XCTAssertEqual(.differentState, state) } Or to assert that an action produces no output: MyWorkflow.Action .tester(withState: .firstState) .send(action: .actionProducingNoOutput) .assertNoOutput() .verifyState { state in XCTAssertEqual(.differentState, state) } If your State or Output are Equatable , you can use the convenience assertion methods: MyWorkflow.Action .tester(withState: .firstState) .send(action: .exampleAction) .assert(output: .finished) .assert(state: .differentState) Methods \u00b6 send(action:) \u00b6 Sends an action to the reducer. parameter action: The action to send. returns: A new state tester containing the state and output (if any) after the update. assertNoOutput(file:line:) \u00b6 Asserts that the action produced no output returns: A tester containing the current state and output. verifyOutput(file:line:_:) \u00b6 Invokes the given closure (which is intended to contain test assertions) with the produced output. If the previous action produced no output, the triggers a test failure and does not execute the closure. parameter assertions: A closure that accepts a single output value. returns: A tester containing the current state and output. verifyState(_:) \u00b6 Invokes the given closure (which is intended to contain test assertions) with the current state. parameter assertions: A closure that accepts a single state value. returns: A tester containing the current state and output.","title":"WorkflowActionTester"},{"location":"swift/api/WorkflowTesting/structs/WorkflowActionTester/#workflowactiontester","text":"Testing helper that chains action sending and state/output assertions to make tests easier to write. MyWorkflow.Action .tester(withState: .firstState) .send(action: .exampleAction) .verifyOutput { output in XCTAssertEqual(.finished, output) } .verifyState { state in XCTAssertEqual(.differentState, state) } Or to assert that an action produces no output: MyWorkflow.Action .tester(withState: .firstState) .send(action: .actionProducingNoOutput) .assertNoOutput() .verifyState { state in XCTAssertEqual(.differentState, state) } If your State or Output are Equatable , you can use the convenience assertion methods: MyWorkflow.Action .tester(withState: .firstState) .send(action: .exampleAction) .assert(output: .finished) .assert(state: .differentState)","title":"WorkflowActionTester"},{"location":"swift/api/WorkflowTesting/structs/WorkflowActionTester/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowTesting/structs/WorkflowActionTester/#sendaction","text":"Sends an action to the reducer. parameter action: The action to send. returns: A new state tester containing the state and output (if any) after the update.","title":"send(action:)"},{"location":"swift/api/WorkflowTesting/structs/WorkflowActionTester/#assertnooutputfileline","text":"Asserts that the action produced no output returns: A tester containing the current state and output.","title":"assertNoOutput(file:line:)"},{"location":"swift/api/WorkflowTesting/structs/WorkflowActionTester/#verifyoutputfileline_","text":"Invokes the given closure (which is intended to contain test assertions) with the produced output. If the previous action produced no output, the triggers a test failure and does not execute the closure. parameter assertions: A closure that accepts a single output value. returns: A tester containing the current state and output.","title":"verifyOutput(file:line:_:)"},{"location":"swift/api/WorkflowTesting/structs/WorkflowActionTester/#verifystate_","text":"Invokes the given closure (which is intended to contain test assertions) with the current state. parameter assertions: A closure that accepts a single state value. returns: A tester containing the current state and output.","title":"verifyState(_:)"},{"location":"swift/api/WorkflowUI/","text":"Reference Documentation \u00b6 Protocols \u00b6 Screen SingleScreenContaining UpdateChildScreenViewController WorkflowUIEvent WorkflowUIObserver Structs \u00b6 AdaptedEnvironmentScreen AnyScreen ViewControllerDescription ViewControllerDescription.KindIdentifier ViewDidAppearEvent ViewDidDisappearEvent ViewDidLayoutSubviewsEvent ViewWillAppearEvent ViewWillDisappearEvent ViewWillLayoutSubviewsEvent Classes \u00b6 DescribedViewController ScreenViewController WorkflowHostingController WorkflowUIViewController Enums \u00b6 WorkflowUIObservation Extensions \u00b6 AdaptedEnvironmentScreen AnyScreen Screen ScreenViewController SingleScreenContaining UpdateChildScreenViewController WorkflowHostingController Typealiases \u00b6 AdaptedEnvironmentScreen.Adapter WorkflowHostingController.CustomizeEnvironment This file was generated by SourceDocs on 2024-01-22 20:45:49 +0000","title":"WorkflowUI "},{"location":"swift/api/WorkflowUI/#reference-documentation","text":"","title":"Reference Documentation"},{"location":"swift/api/WorkflowUI/#protocols","text":"Screen SingleScreenContaining UpdateChildScreenViewController WorkflowUIEvent WorkflowUIObserver","title":"Protocols"},{"location":"swift/api/WorkflowUI/#structs","text":"AdaptedEnvironmentScreen AnyScreen ViewControllerDescription ViewControllerDescription.KindIdentifier ViewDidAppearEvent ViewDidDisappearEvent ViewDidLayoutSubviewsEvent ViewWillAppearEvent ViewWillDisappearEvent ViewWillLayoutSubviewsEvent","title":"Structs"},{"location":"swift/api/WorkflowUI/#classes","text":"DescribedViewController ScreenViewController WorkflowHostingController WorkflowUIViewController","title":"Classes"},{"location":"swift/api/WorkflowUI/#enums","text":"WorkflowUIObservation","title":"Enums"},{"location":"swift/api/WorkflowUI/#extensions","text":"AdaptedEnvironmentScreen AnyScreen Screen ScreenViewController SingleScreenContaining UpdateChildScreenViewController WorkflowHostingController","title":"Extensions"},{"location":"swift/api/WorkflowUI/#typealiases","text":"AdaptedEnvironmentScreen.Adapter WorkflowHostingController.CustomizeEnvironment This file was generated by SourceDocs on 2024-01-22 20:45:49 +0000","title":"Typealiases"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/","text":"CLASS DescribedViewController \u00b6 Properties \u00b6 childForStatusBarStyle \u00b6 childForStatusBarHidden \u00b6 childForHomeIndicatorAutoHidden \u00b6 childForScreenEdgesDeferringSystemGestures \u00b6 supportedInterfaceOrientations \u00b6 preferredStatusBarUpdateAnimation \u00b6 childViewControllerForPointerLock \u00b6 Methods \u00b6 init(description:) \u00b6 init(screen:environment:) \u00b6 update(description:) \u00b6 update(screen:environment:) \u00b6 viewDidLoad() \u00b6 viewDidLayoutSubviews() \u00b6 preferredContentSizeDidChange(forChildContentContainer:) \u00b6","title":"DescribedViewController"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#describedviewcontroller","text":"","title":"DescribedViewController"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#childforstatusbarstyle","text":"","title":"childForStatusBarStyle"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#childforstatusbarhidden","text":"","title":"childForStatusBarHidden"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#childforhomeindicatorautohidden","text":"","title":"childForHomeIndicatorAutoHidden"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#childforscreenedgesdeferringsystemgestures","text":"","title":"childForScreenEdgesDeferringSystemGestures"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#supportedinterfaceorientations","text":"","title":"supportedInterfaceOrientations"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#preferredstatusbarupdateanimation","text":"","title":"preferredStatusBarUpdateAnimation"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#childviewcontrollerforpointerlock","text":"","title":"childViewControllerForPointerLock"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#initdescription","text":"","title":"init(description:)"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#initscreenenvironment","text":"","title":"init(screen:environment:)"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#updatedescription","text":"","title":"update(description:)"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#updatescreenenvironment","text":"","title":"update(screen:environment:)"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#viewdidload","text":"","title":"viewDidLoad()"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#viewdidlayoutsubviews","text":"","title":"viewDidLayoutSubviews()"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#preferredcontentsizedidchangeforchildcontentcontainer","text":"","title":"preferredContentSizeDidChange(forChildContentContainer:)"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/","text":"CLASS ScreenViewController \u00b6 Generic base class that can be subclassed in order to to define a UI implementation that is powered by the given screen type. Using this base class, a screen can be implemented as: struct MyScreen: Screen { func viewControllerDescription(environment: ViewEnvironment) -> ViewControllerDescription { return MyScreenViewController.description(for: self, environment: environment) } } private class MyScreenViewController: ScreenViewController { override func screenDidChange(from previousScreen: MyScreen, previousEnvironment: ViewEnvironment) { // \u2026 update views as necessary } } Properties \u00b6 screen \u00b6 screenType \u00b6 Methods \u00b6 init(screen:environment:) \u00b6 init(coder:) \u00b6 update(screen:) \u00b6 screenDidChange(from:previousEnvironment:) \u00b6 Subclasses should override this method in order to update any relevant UI bits when the screen model changes.","title":"ScreenViewController"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/#screenviewcontroller","text":"Generic base class that can be subclassed in order to to define a UI implementation that is powered by the given screen type. Using this base class, a screen can be implemented as: struct MyScreen: Screen { func viewControllerDescription(environment: ViewEnvironment) -> ViewControllerDescription { return MyScreenViewController.description(for: self, environment: environment) } } private class MyScreenViewController: ScreenViewController { override func screenDidChange(from previousScreen: MyScreen, previousEnvironment: ViewEnvironment) { // \u2026 update views as necessary } }","title":"ScreenViewController"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/#screen","text":"","title":"screen"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/#screentype","text":"","title":"screenType"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/#initscreenenvironment","text":"","title":"init(screen:environment:)"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/#initcoder","text":"","title":"init(coder:)"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/#updatescreen","text":"","title":"update(screen:)"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/#screendidchangefrompreviousenvironment","text":"Subclasses should override this method in order to update any relevant UI bits when the screen model changes.","title":"screenDidChange(from:previousEnvironment:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/","text":"CLASS WorkflowHostingController \u00b6 Drives view controllers from a root Workflow. Properties \u00b6 output \u00b6 Emits output events from the bound workflow. customizeEnvironment \u00b6 An environment customization that will be applied to the environment of the root screen. screen \u00b6 The currently displayed screen - the most recent rendering from the hosted workflow childForStatusBarStyle \u00b6 childForStatusBarHidden \u00b6 childForHomeIndicatorAutoHidden \u00b6 childForScreenEdgesDeferringSystemGestures \u00b6 supportedInterfaceOrientations \u00b6 preferredStatusBarUpdateAnimation \u00b6 childViewControllerForPointerLock \u00b6 Methods \u00b6 init(workflow:customizeEnvironment:observers:) \u00b6 update(workflow:) \u00b6 Updates the root Workflow in this container. init(coder:) \u00b6 viewDidLoad() \u00b6 viewWillLayoutSubviews() \u00b6 viewDidLayoutSubviews() \u00b6 preferredContentSizeDidChange(forChildContentContainer:) \u00b6","title":"WorkflowHostingController"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#workflowhostingcontroller","text":"Drives view controllers from a root Workflow.","title":"WorkflowHostingController"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#output","text":"Emits output events from the bound workflow.","title":"output"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#customizeenvironment","text":"An environment customization that will be applied to the environment of the root screen.","title":"customizeEnvironment"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#screen","text":"The currently displayed screen - the most recent rendering from the hosted workflow","title":"screen"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#childforstatusbarstyle","text":"","title":"childForStatusBarStyle"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#childforstatusbarhidden","text":"","title":"childForStatusBarHidden"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#childforhomeindicatorautohidden","text":"","title":"childForHomeIndicatorAutoHidden"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#childforscreenedgesdeferringsystemgestures","text":"","title":"childForScreenEdgesDeferringSystemGestures"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#supportedinterfaceorientations","text":"","title":"supportedInterfaceOrientations"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#preferredstatusbarupdateanimation","text":"","title":"preferredStatusBarUpdateAnimation"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#childviewcontrollerforpointerlock","text":"","title":"childViewControllerForPointerLock"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#initworkflowcustomizeenvironmentobservers","text":"","title":"init(workflow:customizeEnvironment:observers:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#updateworkflow","text":"Updates the root Workflow in this container.","title":"update(workflow:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#initcoder","text":"","title":"init(coder:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#viewdidload","text":"","title":"viewDidLoad()"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#viewwilllayoutsubviews","text":"","title":"viewWillLayoutSubviews()"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#viewdidlayoutsubviews","text":"","title":"viewDidLayoutSubviews()"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#preferredcontentsizedidchangeforchildcontentcontainer","text":"","title":"preferredContentSizeDidChange(forChildContentContainer:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/","text":"CLASS WorkflowUIViewController \u00b6 Ancestor type from which all ViewControllers in WorkflowUI inherit. Properties \u00b6 hasViewAppeared \u00b6 Set to true once viewDidAppear has been called Methods \u00b6 sendObservationEvent(_:) \u00b6 Observation event emission point. - Parameter event: The event forwarded to any observers. viewWillAppear(_:) \u00b6 viewDidAppear(_:) \u00b6 viewWillDisappear(_:) \u00b6 viewDidDisappear(_:) \u00b6 viewWillLayoutSubviews() \u00b6 viewDidLayoutSubviews() \u00b6","title":"WorkflowUIViewController"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#workflowuiviewcontroller","text":"Ancestor type from which all ViewControllers in WorkflowUI inherit.","title":"WorkflowUIViewController"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#hasviewappeared","text":"Set to true once viewDidAppear has been called","title":"hasViewAppeared"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#sendobservationevent_","text":"Observation event emission point. - Parameter event: The event forwarded to any observers.","title":"sendObservationEvent(_:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#viewwillappear_","text":"","title":"viewWillAppear(_:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#viewdidappear_","text":"","title":"viewDidAppear(_:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#viewwilldisappear_","text":"","title":"viewWillDisappear(_:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#viewdiddisappear_","text":"","title":"viewDidDisappear(_:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#viewwilllayoutsubviews","text":"","title":"viewWillLayoutSubviews()"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#viewdidlayoutsubviews","text":"","title":"viewDidLayoutSubviews()"},{"location":"swift/api/WorkflowUI/enums/WorkflowUIObservation/","text":"ENUM WorkflowUIObservation \u00b6 Properties \u00b6 sharedUIObserver \u00b6 The shared WorkflowUIObserver instance to which all WorkflowUIEvent s will be forwarded.","title":"WorkflowUIObservation"},{"location":"swift/api/WorkflowUI/enums/WorkflowUIObservation/#workflowuiobservation","text":"","title":"WorkflowUIObservation"},{"location":"swift/api/WorkflowUI/enums/WorkflowUIObservation/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/enums/WorkflowUIObservation/#shareduiobserver","text":"The shared WorkflowUIObserver instance to which all WorkflowUIEvent s will be forwarded.","title":"sharedUIObserver"},{"location":"swift/api/WorkflowUI/extensions/AdaptedEnvironmentScreen/","text":"EXTENSION AdaptedEnvironmentScreen \u00b6 Methods \u00b6 viewControllerDescription(environment:) \u00b6","title":"AdaptedEnvironmentScreen"},{"location":"swift/api/WorkflowUI/extensions/AdaptedEnvironmentScreen/#adaptedenvironmentscreen","text":"","title":"AdaptedEnvironmentScreen"},{"location":"swift/api/WorkflowUI/extensions/AdaptedEnvironmentScreen/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/extensions/AdaptedEnvironmentScreen/#viewcontrollerdescriptionenvironment","text":"","title":"viewControllerDescription(environment:)"},{"location":"swift/api/WorkflowUI/extensions/AnyScreen/","text":"EXTENSION AnyScreen \u00b6 Properties \u00b6 primaryScreen \u00b6","title":"AnyScreen"},{"location":"swift/api/WorkflowUI/extensions/AnyScreen/#anyscreen","text":"","title":"AnyScreen"},{"location":"swift/api/WorkflowUI/extensions/AnyScreen/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/extensions/AnyScreen/#primaryscreen","text":"","title":"primaryScreen"},{"location":"swift/api/WorkflowUI/extensions/Screen/","text":"EXTENSION Screen \u00b6 Methods \u00b6 adaptedEnvironment(key:value:) \u00b6 Wraps this screen in an AdaptedEnvironmentScreen with the given environment key and value. adaptedEnvironment(keyPath:value:) \u00b6 Wraps this screen in an AdaptedEnvironmentScreen with the given keypath and value. adaptedEnvironment(adapting:) \u00b6 Wraps this screen in an AdaptedEnvironmentScreen with the given configuration block. asAnyScreen() \u00b6 Wraps the screen in an AnyScreen canUpdate(viewController:with:) \u00b6 If the given view controller is of the correct type to be updated by this screen. If your view controller type can change between updates, call this method before invoking update(viewController:with:) . update(viewController:with:) \u00b6 Update the given view controller with the content from the screen. Note \u00b6 You must pass a view controller previously created by a compatible ViewControllerDescription that passes canUpdate(viewController:with:) . Failure to do so will result in a fatal precondition. buildViewController(in:) \u00b6 Construct and update a new view controller as described by this Screen. The view controller will be updated before it is returned, so it is fully configured and prepared for display.","title":"Screen"},{"location":"swift/api/WorkflowUI/extensions/Screen/#screen","text":"","title":"Screen"},{"location":"swift/api/WorkflowUI/extensions/Screen/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/extensions/Screen/#adaptedenvironmentkeyvalue","text":"Wraps this screen in an AdaptedEnvironmentScreen with the given environment key and value.","title":"adaptedEnvironment(key:value:)"},{"location":"swift/api/WorkflowUI/extensions/Screen/#adaptedenvironmentkeypathvalue","text":"Wraps this screen in an AdaptedEnvironmentScreen with the given keypath and value.","title":"adaptedEnvironment(keyPath:value:)"},{"location":"swift/api/WorkflowUI/extensions/Screen/#adaptedenvironmentadapting","text":"Wraps this screen in an AdaptedEnvironmentScreen with the given configuration block.","title":"adaptedEnvironment(adapting:)"},{"location":"swift/api/WorkflowUI/extensions/Screen/#asanyscreen","text":"Wraps the screen in an AnyScreen","title":"asAnyScreen()"},{"location":"swift/api/WorkflowUI/extensions/Screen/#canupdateviewcontrollerwith","text":"If the given view controller is of the correct type to be updated by this screen. If your view controller type can change between updates, call this method before invoking update(viewController:with:) .","title":"canUpdate(viewController:with:)"},{"location":"swift/api/WorkflowUI/extensions/Screen/#updateviewcontrollerwith","text":"Update the given view controller with the content from the screen.","title":"update(viewController:with:)"},{"location":"swift/api/WorkflowUI/extensions/Screen/#note","text":"You must pass a view controller previously created by a compatible ViewControllerDescription that passes canUpdate(viewController:with:) . Failure to do so will result in a fatal precondition.","title":"Note"},{"location":"swift/api/WorkflowUI/extensions/Screen/#buildviewcontrollerin","text":"Construct and update a new view controller as described by this Screen. The view controller will be updated before it is returned, so it is fully configured and prepared for display.","title":"buildViewController(in:)"},{"location":"swift/api/WorkflowUI/extensions/ScreenViewController/","text":"EXTENSION ScreenViewController \u00b6 Properties \u00b6 primaryScreen \u00b6 Methods \u00b6 description(for:environment:performInitialUpdate:) \u00b6 Convenience to create a view controller description for the given screen value. See the example on the comment for ScreenViewController for usage.","title":"ScreenViewController"},{"location":"swift/api/WorkflowUI/extensions/ScreenViewController/#screenviewcontroller","text":"","title":"ScreenViewController"},{"location":"swift/api/WorkflowUI/extensions/ScreenViewController/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/extensions/ScreenViewController/#primaryscreen","text":"","title":"primaryScreen"},{"location":"swift/api/WorkflowUI/extensions/ScreenViewController/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/extensions/ScreenViewController/#descriptionforenvironmentperforminitialupdate","text":"Convenience to create a view controller description for the given screen value. See the example on the comment for ScreenViewController for usage.","title":"description(for:environment:performInitialUpdate:)"},{"location":"swift/api/WorkflowUI/extensions/SingleScreenContaining/","text":"EXTENSION SingleScreenContaining \u00b6 Methods \u00b6 findInnermostPrimaryScreen() \u00b6 Iteratively traverses a sequence of primaryScreen values until one is found that does not conform to SingleScreenContaining . Put another way, this returns the first primaryScreen that is a Screen and not a SingleScreenContaining type.","title":"SingleScreenContaining"},{"location":"swift/api/WorkflowUI/extensions/SingleScreenContaining/#singlescreencontaining","text":"","title":"SingleScreenContaining"},{"location":"swift/api/WorkflowUI/extensions/SingleScreenContaining/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/extensions/SingleScreenContaining/#findinnermostprimaryscreen","text":"Iteratively traverses a sequence of primaryScreen values until one is found that does not conform to SingleScreenContaining . Put another way, this returns the first primaryScreen that is a Screen and not a SingleScreenContaining type.","title":"findInnermostPrimaryScreen()"},{"location":"swift/api/WorkflowUI/extensions/UpdateChildScreenViewController/","text":"EXTENSION UpdateChildScreenViewController \u00b6 Methods \u00b6 update(child:with:in:onChange:) \u00b6 Updates the view controller at the given child key path with the ViewControllerDescription from screen . If the type of the underlying view controller changes between update passes, this method will remove the old view controller, create a new one, update it, and insert it into the view controller hierarchy. The view controller at child must be a child of self . Parameters: parameter child: The KeyPath which describes what view controller to update. This view controller must be a direct child of self . parameter screen: The Screen instance to apply to the view controller. parameter environment: The environment to used when updating the view controller. parameter onChange: A callback called if the view controller instance changed.","title":"UpdateChildScreenViewController"},{"location":"swift/api/WorkflowUI/extensions/UpdateChildScreenViewController/#updatechildscreenviewcontroller","text":"","title":"UpdateChildScreenViewController"},{"location":"swift/api/WorkflowUI/extensions/UpdateChildScreenViewController/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/extensions/UpdateChildScreenViewController/#updatechildwithinonchange","text":"Updates the view controller at the given child key path with the ViewControllerDescription from screen . If the type of the underlying view controller changes between update passes, this method will remove the old view controller, create a new one, update it, and insert it into the view controller hierarchy. The view controller at child must be a child of self . Parameters: parameter child: The KeyPath which describes what view controller to update. This view controller must be a direct child of self . parameter screen: The Screen instance to apply to the view controller. parameter environment: The environment to used when updating the view controller. parameter onChange: A callback called if the view controller instance changed.","title":"update(child:with:in:onChange:)"},{"location":"swift/api/WorkflowUI/extensions/WorkflowHostingController/","text":"EXTENSION WorkflowHostingController \u00b6 Properties \u00b6 primaryScreen \u00b6 Methods \u00b6 customize(environment:) \u00b6 environmentDidChange() \u00b6","title":"WorkflowHostingController"},{"location":"swift/api/WorkflowUI/extensions/WorkflowHostingController/#workflowhostingcontroller","text":"","title":"WorkflowHostingController"},{"location":"swift/api/WorkflowUI/extensions/WorkflowHostingController/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/extensions/WorkflowHostingController/#primaryscreen","text":"","title":"primaryScreen"},{"location":"swift/api/WorkflowUI/extensions/WorkflowHostingController/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/extensions/WorkflowHostingController/#customizeenvironment","text":"","title":"customize(environment:)"},{"location":"swift/api/WorkflowUI/extensions/WorkflowHostingController/#environmentdidchange","text":"","title":"environmentDidChange()"},{"location":"swift/api/WorkflowUI/protocols/Screen/","text":"PROTOCOL Screen \u00b6 Screens are the building blocks of an interactive application. Conforming types contain any information needed to populate a screen: data, styling, event handlers, etc. Methods \u00b6 viewControllerDescription(environment:) \u00b6 A view controller description that acts as a recipe to either build or update a previously-built view controller to match this screen.","title":"Screen"},{"location":"swift/api/WorkflowUI/protocols/Screen/#screen","text":"Screens are the building blocks of an interactive application. Conforming types contain any information needed to populate a screen: data, styling, event handlers, etc.","title":"Screen"},{"location":"swift/api/WorkflowUI/protocols/Screen/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/protocols/Screen/#viewcontrollerdescriptionenvironment","text":"A view controller description that acts as a recipe to either build or update a previously-built view controller to match this screen.","title":"viewControllerDescription(environment:)"},{"location":"swift/api/WorkflowUI/protocols/SingleScreenContaining/","text":"PROTOCOL SingleScreenContaining \u00b6 Defines a type that semantically \u2018contains\u2019 a Screen instance. The motivating use case for this protocol is to expose a means of unifying various types that provide access to Screen s in a way that can be used without knowing their static type. For example, without this protocol, we cannot identify that a UIViewController is an instance of ScreenViewController without specifying the associated screen\u2019s type. func makeUninspectableScreenVC () -> UIViewController { struct LocalScreen : Screen { ... } // `LocalScreen` symbol is only visible in this function return ScreenViewController ( screen : LocalScreen (), environment : . empty ) } let isSVC = makeUninspectableScreenVC () is ScreenViewController // no generic can be specified here that makes this true Conceptually this API is intended to enable runtime traversal of a hierarchy of SingleScreenContaining instances such that an \u2018inner\u2019 Screen value can be found at runtime. For example, if we had an instance of ScreenViewController but only statically knew it was a UIViewController , we can use the conformances to this protocol to conditionally cast & traverse the contained screens to find the inner wrappedScreen . Properties \u00b6 primaryScreen \u00b6 The primary Screen the conforming type contains. Note that this may be ambiguous in some cases, for instance, if the conforming type logically contains multiple screens. Implementors should return the Screen which most appropriately reflects the \u2018primary\u2019 one for a given domain.","title":"SingleScreenContaining"},{"location":"swift/api/WorkflowUI/protocols/SingleScreenContaining/#singlescreencontaining","text":"Defines a type that semantically \u2018contains\u2019 a Screen instance. The motivating use case for this protocol is to expose a means of unifying various types that provide access to Screen s in a way that can be used without knowing their static type. For example, without this protocol, we cannot identify that a UIViewController is an instance of ScreenViewController without specifying the associated screen\u2019s type. func makeUninspectableScreenVC () -> UIViewController { struct LocalScreen : Screen { ... } // `LocalScreen` symbol is only visible in this function return ScreenViewController ( screen : LocalScreen (), environment : . empty ) } let isSVC = makeUninspectableScreenVC () is ScreenViewController // no generic can be specified here that makes this true Conceptually this API is intended to enable runtime traversal of a hierarchy of SingleScreenContaining instances such that an \u2018inner\u2019 Screen value can be found at runtime. For example, if we had an instance of ScreenViewController but only statically knew it was a UIViewController , we can use the conformances to this protocol to conditionally cast & traverse the contained screens to find the inner wrappedScreen .","title":"SingleScreenContaining"},{"location":"swift/api/WorkflowUI/protocols/SingleScreenContaining/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/protocols/SingleScreenContaining/#primaryscreen","text":"The primary Screen the conforming type contains. Note that this may be ambiguous in some cases, for instance, if the conforming type logically contains multiple screens. Implementors should return the Screen which most appropriately reflects the \u2018primary\u2019 one for a given domain.","title":"primaryScreen"},{"location":"swift/api/WorkflowUI/protocols/UpdateChildScreenViewController/","text":"PROTOCOL UpdateChildScreenViewController \u00b6","title":"UpdateChildScreenViewController"},{"location":"swift/api/WorkflowUI/protocols/UpdateChildScreenViewController/#updatechildscreenviewcontroller","text":"","title":"UpdateChildScreenViewController"},{"location":"swift/api/WorkflowUI/protocols/WorkflowUIEvent/","text":"PROTOCOL WorkflowUIEvent \u00b6 Protocol that describes an observable \u2018event\u2019 that may be emitted from WorkflowUI . Properties \u00b6 viewController \u00b6","title":"WorkflowUIEvent"},{"location":"swift/api/WorkflowUI/protocols/WorkflowUIEvent/#workflowuievent","text":"Protocol that describes an observable \u2018event\u2019 that may be emitted from WorkflowUI .","title":"WorkflowUIEvent"},{"location":"swift/api/WorkflowUI/protocols/WorkflowUIEvent/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/protocols/WorkflowUIEvent/#viewcontroller","text":"","title":"viewController"},{"location":"swift/api/WorkflowUI/protocols/WorkflowUIObserver/","text":"PROTOCOL WorkflowUIObserver \u00b6 Protocol to observe events emitted from WorkflowUI. N.B. This is currently part of an experimental interface, and may have breaking changes in the future. Methods \u00b6 observeEvent(_:) \u00b6","title":"WorkflowUIObserver"},{"location":"swift/api/WorkflowUI/protocols/WorkflowUIObserver/#workflowuiobserver","text":"Protocol to observe events emitted from WorkflowUI. N.B. This is currently part of an experimental interface, and may have breaking changes in the future.","title":"WorkflowUIObserver"},{"location":"swift/api/WorkflowUI/protocols/WorkflowUIObserver/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/protocols/WorkflowUIObserver/#observeevent_","text":"","title":"observeEvent(_:)"},{"location":"swift/api/WorkflowUI/structs/AdaptedEnvironmentScreen/","text":"STRUCT AdaptedEnvironmentScreen \u00b6 Wraps a Screen tree with a modified ViewEnvironment . By specifying environmental values with this Screen , all child screens nested will inherit those values automatically. Values can be changed anywhere in a sub-tree by inserting another AdaptedEnvironmentScreen . MyScreen (...) . adaptedEnvironment ( keyPath : \\ . myValue , to : newValue ) Properties \u00b6 wrapped \u00b6 The screen wrapped by this screen. Methods \u00b6 init(wrapping:adapting:) \u00b6 Wraps a Screen with an environment that is modified using the given configuration block. Parameters: wrapping: The screen to be wrapped. adapting: A block that will set environmental values. init(wrapping:key:value:) \u00b6 Wraps a Screen with an environment that is modified for a single key and value. Parameters: wrapping: The screen to be wrapped. key: The environment key to modify. value: The new environment value to cascade. init(wrapping:keyPath:value:) \u00b6 Wraps a Screen with an environment that is modified for a single value. Parameters: wrapping: The screen to be wrapped. keyPath: The keypath of the environment value to modify. value: The new environment value to cascade.","title":"AdaptedEnvironmentScreen"},{"location":"swift/api/WorkflowUI/structs/AdaptedEnvironmentScreen/#adaptedenvironmentscreen","text":"Wraps a Screen tree with a modified ViewEnvironment . By specifying environmental values with this Screen , all child screens nested will inherit those values automatically. Values can be changed anywhere in a sub-tree by inserting another AdaptedEnvironmentScreen . MyScreen (...) . adaptedEnvironment ( keyPath : \\ . myValue , to : newValue )","title":"AdaptedEnvironmentScreen"},{"location":"swift/api/WorkflowUI/structs/AdaptedEnvironmentScreen/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/structs/AdaptedEnvironmentScreen/#wrapped","text":"The screen wrapped by this screen.","title":"wrapped"},{"location":"swift/api/WorkflowUI/structs/AdaptedEnvironmentScreen/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/structs/AdaptedEnvironmentScreen/#initwrappingadapting","text":"Wraps a Screen with an environment that is modified using the given configuration block. Parameters: wrapping: The screen to be wrapped. adapting: A block that will set environmental values.","title":"init(wrapping:adapting:)"},{"location":"swift/api/WorkflowUI/structs/AdaptedEnvironmentScreen/#initwrappingkeyvalue","text":"Wraps a Screen with an environment that is modified for a single key and value. Parameters: wrapping: The screen to be wrapped. key: The environment key to modify. value: The new environment value to cascade.","title":"init(wrapping:key:value:)"},{"location":"swift/api/WorkflowUI/structs/AdaptedEnvironmentScreen/#initwrappingkeypathvalue","text":"Wraps a Screen with an environment that is modified for a single value. Parameters: wrapping: The screen to be wrapped. keyPath: The keypath of the environment value to modify. value: The new environment value to cascade.","title":"init(wrapping:keyPath:value:)"},{"location":"swift/api/WorkflowUI/structs/AnyScreen/","text":"STRUCT AnyScreen \u00b6 Properties \u00b6 wrappedScreen \u00b6 The original screen, retained for debugging Methods \u00b6 init(_:) \u00b6 viewControllerDescription(environment:) \u00b6","title":"AnyScreen"},{"location":"swift/api/WorkflowUI/structs/AnyScreen/#anyscreen","text":"","title":"AnyScreen"},{"location":"swift/api/WorkflowUI/structs/AnyScreen/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/structs/AnyScreen/#wrappedscreen","text":"The original screen, retained for debugging","title":"wrappedScreen"},{"location":"swift/api/WorkflowUI/structs/AnyScreen/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/structs/AnyScreen/#init_","text":"","title":"init(_:)"},{"location":"swift/api/WorkflowUI/structs/AnyScreen/#viewcontrollerdescriptionenvironment","text":"","title":"viewControllerDescription(environment:)"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription.KindIdentifier/","text":"STRUCT ViewControllerDescription.KindIdentifier \u00b6 Describes the UIViewController type that backs the ViewControllerDescription in a way that is Equatable and Hashable . When implementing view controller updating and diffing, you can use this type to identify if the backing view controller type changed. Methods \u00b6 init(_:) \u00b6 Creates a new kind for the given view controller type. canUpdate(viewController:) \u00b6 If the given view controller is of the correct type to be updated by this view controller description. If your view controller type can change between updates, call this method before invoking update(viewController:) . hash(into:) \u00b6 ==(_:_:) \u00b6","title":"ViewControllerDescription.KindIdentifier"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription.KindIdentifier/#viewcontrollerdescriptionkindidentifier","text":"Describes the UIViewController type that backs the ViewControllerDescription in a way that is Equatable and Hashable . When implementing view controller updating and diffing, you can use this type to identify if the backing view controller type changed.","title":"ViewControllerDescription.KindIdentifier"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription.KindIdentifier/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription.KindIdentifier/#init_","text":"Creates a new kind for the given view controller type.","title":"init(_:)"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription.KindIdentifier/#canupdateviewcontroller","text":"If the given view controller is of the correct type to be updated by this view controller description. If your view controller type can change between updates, call this method before invoking update(viewController:) .","title":"canUpdate(viewController:)"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription.KindIdentifier/#hashinto","text":"","title":"hash(into:)"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription.KindIdentifier/#__","text":"","title":"==(_:_:)"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/","text":"STRUCT ViewControllerDescription \u00b6 A ViewControllerDescription acts as a \u201crecipe\u201d for building and updating a specific UIViewController . It describes how to create and later update a given view controller instance, without creating one itself. This means it is a lightweight currency you can create and pass around to describe a view controller, without needing to create one. The most common use case for a ViewControllerDescription is to return it from your Screen \u2019s viewControllerDescription(environment:) method. The WorkflowUI machinery (or your custom container view controller) will then use this view controller description to create or update the on-screen presented view controller. As a creator of a custom container view controller, you will usually pass this view controller description to a DescribedViewController , which will internally create and manage the described view controller for its current view controller description. However, you can also directly invoke the public methods such as buildViewController() , update(viewController:) , if you are manually managing your own view controller hierarchy. Properties \u00b6 performInitialUpdate \u00b6 If an initial call to update(viewController:) will be performed when the view controller is created. Defaults to true . Note \u00b6 When creating container view controllers that contain other view controllers (eg, a navigation stack), you usually want to set this value to false to avoid duplicate updates to your children if they are created in init . kind \u00b6 Describes the UIViewController type that backs the ViewControllerDescription in a way that is Equatable and Hashable . When implementing view controller updating and diffing, you can use this type to identify if the backing view controller type changed. Methods \u00b6 init(performInitialUpdate:type:environment:build:update:) \u00b6 Constructs a view controller description by providing closures used to build and update a specific view controller type. Parameters: performInitialUpdate: If an initial call to update(viewController:) will be performed when the view controller is created. Defaults to true . environment: The ViewEnvironment that should be injected above the described view controller for ViewEnvironmentUI environment propagation. This is typically passed in from a Screen in its viewControllerDescription(environment:) method. type: The type of view controller produced by this description. Typically, should should be able to omit this parameter, but in cases where type inference has trouble, it\u2019s offered as an escape hatch. build: Closure that produces a new instance of the view controller update: Closure that updates the given view controller buildViewController() \u00b6 Construct and update a new view controller as described by this view controller description. The view controller will be updated before it is returned, so it is fully configured and prepared for display. canUpdate(viewController:) \u00b6 If the given view controller is of the correct type to be updated by this view controller description. If your view controller type can change between updates, call this method before invoking update(viewController:) . update(viewController:) \u00b6 Update the given view controller with the content from the view controller description. Parameters: viewController: The view controller to update. Note \u00b6 You must pass a view controller previously created by a compatible ViewControllerDescription that passes canUpdate(viewController:) . Failure to do so will result in a fatal precondition.","title":"ViewControllerDescription"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#viewcontrollerdescription","text":"A ViewControllerDescription acts as a \u201crecipe\u201d for building and updating a specific UIViewController . It describes how to create and later update a given view controller instance, without creating one itself. This means it is a lightweight currency you can create and pass around to describe a view controller, without needing to create one. The most common use case for a ViewControllerDescription is to return it from your Screen \u2019s viewControllerDescription(environment:) method. The WorkflowUI machinery (or your custom container view controller) will then use this view controller description to create or update the on-screen presented view controller. As a creator of a custom container view controller, you will usually pass this view controller description to a DescribedViewController , which will internally create and manage the described view controller for its current view controller description. However, you can also directly invoke the public methods such as buildViewController() , update(viewController:) , if you are manually managing your own view controller hierarchy.","title":"ViewControllerDescription"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#performinitialupdate","text":"If an initial call to update(viewController:) will be performed when the view controller is created. Defaults to true .","title":"performInitialUpdate"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#note","text":"When creating container view controllers that contain other view controllers (eg, a navigation stack), you usually want to set this value to false to avoid duplicate updates to your children if they are created in init .","title":"Note"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#kind","text":"Describes the UIViewController type that backs the ViewControllerDescription in a way that is Equatable and Hashable . When implementing view controller updating and diffing, you can use this type to identify if the backing view controller type changed.","title":"kind"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#initperforminitialupdatetypeenvironmentbuildupdate","text":"Constructs a view controller description by providing closures used to build and update a specific view controller type. Parameters: performInitialUpdate: If an initial call to update(viewController:) will be performed when the view controller is created. Defaults to true . environment: The ViewEnvironment that should be injected above the described view controller for ViewEnvironmentUI environment propagation. This is typically passed in from a Screen in its viewControllerDescription(environment:) method. type: The type of view controller produced by this description. Typically, should should be able to omit this parameter, but in cases where type inference has trouble, it\u2019s offered as an escape hatch. build: Closure that produces a new instance of the view controller update: Closure that updates the given view controller","title":"init(performInitialUpdate:type:environment:build:update:)"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#buildviewcontroller","text":"Construct and update a new view controller as described by this view controller description. The view controller will be updated before it is returned, so it is fully configured and prepared for display.","title":"buildViewController()"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#canupdateviewcontroller","text":"If the given view controller is of the correct type to be updated by this view controller description. If your view controller type can change between updates, call this method before invoking update(viewController:) .","title":"canUpdate(viewController:)"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#updateviewcontroller","text":"Update the given view controller with the content from the view controller description. Parameters: viewController: The view controller to update.","title":"update(viewController:)"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#note_1","text":"You must pass a view controller previously created by a compatible ViewControllerDescription that passes canUpdate(viewController:) . Failure to do so will result in a fatal precondition.","title":"Note"},{"location":"swift/api/WorkflowUI/structs/ViewDidAppearEvent/","text":"STRUCT ViewDidAppearEvent \u00b6 Event emitted from a WorkflowUIViewController \u2019s viewDidAppear method. Properties \u00b6 viewController \u00b6 animated \u00b6 isFirstAppearance \u00b6","title":"ViewDidAppearEvent"},{"location":"swift/api/WorkflowUI/structs/ViewDidAppearEvent/#viewdidappearevent","text":"Event emitted from a WorkflowUIViewController \u2019s viewDidAppear method.","title":"ViewDidAppearEvent"},{"location":"swift/api/WorkflowUI/structs/ViewDidAppearEvent/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/structs/ViewDidAppearEvent/#viewcontroller","text":"","title":"viewController"},{"location":"swift/api/WorkflowUI/structs/ViewDidAppearEvent/#animated","text":"","title":"animated"},{"location":"swift/api/WorkflowUI/structs/ViewDidAppearEvent/#isfirstappearance","text":"","title":"isFirstAppearance"},{"location":"swift/api/WorkflowUI/structs/ViewDidDisappearEvent/","text":"STRUCT ViewDidDisappearEvent \u00b6 Event emitted from a WorkflowUIViewController \u2019s viewDidDisappear method. Properties \u00b6 viewController \u00b6 animated \u00b6","title":"ViewDidDisappearEvent"},{"location":"swift/api/WorkflowUI/structs/ViewDidDisappearEvent/#viewdiddisappearevent","text":"Event emitted from a WorkflowUIViewController \u2019s viewDidDisappear method.","title":"ViewDidDisappearEvent"},{"location":"swift/api/WorkflowUI/structs/ViewDidDisappearEvent/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/structs/ViewDidDisappearEvent/#viewcontroller","text":"","title":"viewController"},{"location":"swift/api/WorkflowUI/structs/ViewDidDisappearEvent/#animated","text":"","title":"animated"},{"location":"swift/api/WorkflowUI/structs/ViewDidLayoutSubviewsEvent/","text":"STRUCT ViewDidLayoutSubviewsEvent \u00b6 Event emitted from a WorkflowUIViewController \u2019s viewDidLayoutSubviews method. Properties \u00b6 viewController \u00b6","title":"ViewDidLayoutSubviewsEvent"},{"location":"swift/api/WorkflowUI/structs/ViewDidLayoutSubviewsEvent/#viewdidlayoutsubviewsevent","text":"Event emitted from a WorkflowUIViewController \u2019s viewDidLayoutSubviews method.","title":"ViewDidLayoutSubviewsEvent"},{"location":"swift/api/WorkflowUI/structs/ViewDidLayoutSubviewsEvent/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/structs/ViewDidLayoutSubviewsEvent/#viewcontroller","text":"","title":"viewController"},{"location":"swift/api/WorkflowUI/structs/ViewWillAppearEvent/","text":"STRUCT ViewWillAppearEvent \u00b6 Event emitted from a WorkflowUIViewController \u2019s viewWillAppear method. Properties \u00b6 viewController \u00b6 animated \u00b6 isFirstAppearance \u00b6","title":"ViewWillAppearEvent"},{"location":"swift/api/WorkflowUI/structs/ViewWillAppearEvent/#viewwillappearevent","text":"Event emitted from a WorkflowUIViewController \u2019s viewWillAppear method.","title":"ViewWillAppearEvent"},{"location":"swift/api/WorkflowUI/structs/ViewWillAppearEvent/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/structs/ViewWillAppearEvent/#viewcontroller","text":"","title":"viewController"},{"location":"swift/api/WorkflowUI/structs/ViewWillAppearEvent/#animated","text":"","title":"animated"},{"location":"swift/api/WorkflowUI/structs/ViewWillAppearEvent/#isfirstappearance","text":"","title":"isFirstAppearance"},{"location":"swift/api/WorkflowUI/structs/ViewWillDisappearEvent/","text":"STRUCT ViewWillDisappearEvent \u00b6 Event emitted from a WorkflowUIViewController \u2019s viewWillDisappear method. Properties \u00b6 viewController \u00b6 animated \u00b6","title":"ViewWillDisappearEvent"},{"location":"swift/api/WorkflowUI/structs/ViewWillDisappearEvent/#viewwilldisappearevent","text":"Event emitted from a WorkflowUIViewController \u2019s viewWillDisappear method.","title":"ViewWillDisappearEvent"},{"location":"swift/api/WorkflowUI/structs/ViewWillDisappearEvent/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/structs/ViewWillDisappearEvent/#viewcontroller","text":"","title":"viewController"},{"location":"swift/api/WorkflowUI/structs/ViewWillDisappearEvent/#animated","text":"","title":"animated"},{"location":"swift/api/WorkflowUI/structs/ViewWillLayoutSubviewsEvent/","text":"STRUCT ViewWillLayoutSubviewsEvent \u00b6 Event emitted from a WorkflowUIViewController \u2019s viewWillLayoutSubviews method. Properties \u00b6 viewController \u00b6","title":"ViewWillLayoutSubviewsEvent"},{"location":"swift/api/WorkflowUI/structs/ViewWillLayoutSubviewsEvent/#viewwilllayoutsubviewsevent","text":"Event emitted from a WorkflowUIViewController \u2019s viewWillLayoutSubviews method.","title":"ViewWillLayoutSubviewsEvent"},{"location":"swift/api/WorkflowUI/structs/ViewWillLayoutSubviewsEvent/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/structs/ViewWillLayoutSubviewsEvent/#viewcontroller","text":"","title":"viewController"},{"location":"swift/api/WorkflowUI/typealiases/AdaptedEnvironmentScreen.Adapter/","text":"TYPEALIAS AdaptedEnvironmentScreen.Adapter \u00b6 Takes in a mutable ViewEnvironment which can be mutated to add or override values.","title":"AdaptedEnvironmentScreen.Adapter"},{"location":"swift/api/WorkflowUI/typealiases/AdaptedEnvironmentScreen.Adapter/#adaptedenvironmentscreenadapter","text":"Takes in a mutable ViewEnvironment which can be mutated to add or override values.","title":"AdaptedEnvironmentScreen.Adapter"},{"location":"swift/api/WorkflowUI/typealiases/WorkflowHostingController.CustomizeEnvironment/","text":"TYPEALIAS WorkflowHostingController.CustomizeEnvironment \u00b6","title":"WorkflowHostingController.CustomizeEnvironment"},{"location":"swift/api/WorkflowUI/typealiases/WorkflowHostingController.CustomizeEnvironment/#workflowhostingcontrollercustomizeenvironment","text":"","title":"WorkflowHostingController.CustomizeEnvironment"},{"location":"userguide/common-patterns/","text":"Common Patterns \u00b6 There are a lot associated/generic types in workflow code \u2013 that doesn\u2019t mean you always need to use all of them. Here are some common configurations we\u2019ve seen. Stateless Workflows \u00b6 Remember that workflow state is made up of public and private parts. When a workflow\u2019s state consists entirely of public state (i.e. it\u2019s initializer arguments in Swift or PropsT in Kotlin), it can ignore all the machinery for private state. In Swift, the State type can be Void , and in Kotlin it can be Unit \u2013 such workflows are often referred to as \u201cstateless\u201d, since they have no state of their own. Props-less Workflows \u00b6 Some workflows manage all of their state internally, and have no public state (aka props). In Swift, this just means the workflow implementation has no parameters (although this is rare, see Injecting Dependencies below). In Kotlin, the PropsT type can be Unit . RenderContext has convenience overloads of most of its functions to implicitly pass Unit for these workflows. Outputless Workflows \u00b6 Workflows that only talk to their parent via their Rendering , and never emit any output, are encouraged to indicate that by using the bottom type as their Output type. In addition to documenting the fact that the workflow will never output, using the bottom type also lets the compiler enforce it \u2013 code that tries to emit outputs will not compile. In Swift, the Output type is specified as Never . In Kotlin, use Nothing . Composite Workflows \u00b6 Composition is a powerful tool for working with Workflows. A workflow can often accomplish a lot simply by rendering various children. It may just combine the renderings of multiple children, or use its props to determine which of a set of children to render. Such workflows can often be stateless. One-and-done Workflows (RenderingT v. OutputT) \u00b6 A common question is \u201cwhy can\u2019t I emit output from initialState ,\u201d or \u201cwhat if my Workflow realizes it doesn\u2019t actually need to run? The most efficient, and most expressive, way to handle this is to use an optional or conditional Rendering type, and an Output of Never / Nothing . Imagine a PromptForPermissionMaybeWorkflow , that renders a UI to get a passcode, but only if that permission has not already been granted. If you make its RenderingT nullable (e.g. Screen? ), it can return null to indicate that its job is done. Its callers will be synchronously informed that the coast is clear, and can immediately render what they actually care about. Another variation of this pattern is to use a sealed class / enum type for Rendering , with a Working type that implements Screen , and a unviewable Finished type that carries the work product. A good rule of thumb for choosing between using Rendering or Output is to remember that Output is event-like, and is always asynchronous. A parent waiting for an output must be given something to render in the meantime. Using Rendering is a great idiom for a one-and-done workflow tasked with providing a single product, especially one that might be available instantly. Props values v. Injected Dependencies \u00b6 Dependency injection is a technique for making code less coupled and more testable. In short, it\u2019s better for classes/structs to accept their dependencies when they\u2019re created instead of hard-coding them. Workflows typically have dependencies like specific Workers they need to perform some tasks, child workflows to delegate rendering to, or helpers for things like network requests, formatting and logging. Swift \u00b6 A Swift workflow typically receives its dependencies as initializer arguments, just like its input values, and is normally instantiated anew by its parent in each call to the parent\u2019s render method. The factory pattern can be employed to keep knowledge of children\u2019s implementation details from leaking into their parents. Kotlin \u00b6 Kotlin workflows make a more formal distinction between dependencies and props, via the PropsT parameter type on the Kotlin Workflow interface. Dependencies (e.g. a network service) are typically provided as constructor parameters, while props values (e.g. a record locator) are provided by the parent as an argument to the RenderContext.renderChild method. This works seamlessly with DI libraries like Dagger . The careful reader will note that this is technically storing \u201cstate\u201d in the workflow instance \u2013 something that is generally discouraged. However, since this \u201cstate\u201d is never changed, we can make an exception for this case. If a workflow has properties, they should only be used to store injected dependencies or dependencies derived from injected ones (e.g. Worker s created from Observable s). Info This difference between Swift and Kotlin practices is a side effect of Kotlin\u2019s lack of a parallel to Swift\u2019s Self type. Kotlin has no practical way to provide a method like Swift\u2019s Workflow.workflowDidChange , which accepts a strongly typed reference to the instance from the previous run of a parent\u2019s Render method. Kotlin\u2019s alternative, StatefulWorkflow.onPropsChanged , requires the extra PropsT type parameter.","title":"Common Patterns"},{"location":"userguide/common-patterns/#common-patterns","text":"There are a lot associated/generic types in workflow code \u2013 that doesn\u2019t mean you always need to use all of them. Here are some common configurations we\u2019ve seen.","title":"Common Patterns"},{"location":"userguide/common-patterns/#stateless-workflows","text":"Remember that workflow state is made up of public and private parts. When a workflow\u2019s state consists entirely of public state (i.e. it\u2019s initializer arguments in Swift or PropsT in Kotlin), it can ignore all the machinery for private state. In Swift, the State type can be Void , and in Kotlin it can be Unit \u2013 such workflows are often referred to as \u201cstateless\u201d, since they have no state of their own.","title":"Stateless Workflows"},{"location":"userguide/common-patterns/#props-less-workflows","text":"Some workflows manage all of their state internally, and have no public state (aka props). In Swift, this just means the workflow implementation has no parameters (although this is rare, see Injecting Dependencies below). In Kotlin, the PropsT type can be Unit . RenderContext has convenience overloads of most of its functions to implicitly pass Unit for these workflows.","title":"Props-less Workflows"},{"location":"userguide/common-patterns/#outputless-workflows","text":"Workflows that only talk to their parent via their Rendering , and never emit any output, are encouraged to indicate that by using the bottom type as their Output type. In addition to documenting the fact that the workflow will never output, using the bottom type also lets the compiler enforce it \u2013 code that tries to emit outputs will not compile. In Swift, the Output type is specified as Never . In Kotlin, use Nothing .","title":"Outputless Workflows"},{"location":"userguide/common-patterns/#composite-workflows","text":"Composition is a powerful tool for working with Workflows. A workflow can often accomplish a lot simply by rendering various children. It may just combine the renderings of multiple children, or use its props to determine which of a set of children to render. Such workflows can often be stateless.","title":"Composite Workflows"},{"location":"userguide/common-patterns/#one-and-done-workflows-renderingt-v-outputt","text":"A common question is \u201cwhy can\u2019t I emit output from initialState ,\u201d or \u201cwhat if my Workflow realizes it doesn\u2019t actually need to run? The most efficient, and most expressive, way to handle this is to use an optional or conditional Rendering type, and an Output of Never / Nothing . Imagine a PromptForPermissionMaybeWorkflow , that renders a UI to get a passcode, but only if that permission has not already been granted. If you make its RenderingT nullable (e.g. Screen? ), it can return null to indicate that its job is done. Its callers will be synchronously informed that the coast is clear, and can immediately render what they actually care about. Another variation of this pattern is to use a sealed class / enum type for Rendering , with a Working type that implements Screen , and a unviewable Finished type that carries the work product. A good rule of thumb for choosing between using Rendering or Output is to remember that Output is event-like, and is always asynchronous. A parent waiting for an output must be given something to render in the meantime. Using Rendering is a great idiom for a one-and-done workflow tasked with providing a single product, especially one that might be available instantly.","title":"One-and-done Workflows (RenderingT v. OutputT)"},{"location":"userguide/common-patterns/#props-values-v-injected-dependencies","text":"Dependency injection is a technique for making code less coupled and more testable. In short, it\u2019s better for classes/structs to accept their dependencies when they\u2019re created instead of hard-coding them. Workflows typically have dependencies like specific Workers they need to perform some tasks, child workflows to delegate rendering to, or helpers for things like network requests, formatting and logging.","title":"Props values v. Injected Dependencies"},{"location":"userguide/common-patterns/#swift","text":"A Swift workflow typically receives its dependencies as initializer arguments, just like its input values, and is normally instantiated anew by its parent in each call to the parent\u2019s render method. The factory pattern can be employed to keep knowledge of children\u2019s implementation details from leaking into their parents.","title":"Swift"},{"location":"userguide/common-patterns/#kotlin","text":"Kotlin workflows make a more formal distinction between dependencies and props, via the PropsT parameter type on the Kotlin Workflow interface. Dependencies (e.g. a network service) are typically provided as constructor parameters, while props values (e.g. a record locator) are provided by the parent as an argument to the RenderContext.renderChild method. This works seamlessly with DI libraries like Dagger . The careful reader will note that this is technically storing \u201cstate\u201d in the workflow instance \u2013 something that is generally discouraged. However, since this \u201cstate\u201d is never changed, we can make an exception for this case. If a workflow has properties, they should only be used to store injected dependencies or dependencies derived from injected ones (e.g. Worker s created from Observable s). Info This difference between Swift and Kotlin practices is a side effect of Kotlin\u2019s lack of a parallel to Swift\u2019s Self type. Kotlin has no practical way to provide a method like Swift\u2019s Workflow.workflowDidChange , which accepts a strongly typed reference to the instance from the previous run of a parent\u2019s Render method. Kotlin\u2019s alternative, StatefulWorkflow.onPropsChanged , requires the extra PropsT type parameter.","title":"Kotlin"},{"location":"userguide/concepts/","text":"Workflow Core \u00b6 This page provides a high level overview of Workflow Core, the UI-agnostic Swift and Kotlin runtimes at the heart of the Workflow libraries. See Workflow UI to learn about the companion Android and iOS specific modules. What is a Workflow? \u00b6 A Workflow defines the possible states and behaviors of components of a particular type. The overall state of a Workflow has two parts: Props , configuration information provided by whatever is running the Workflow And the private State managed by the Workflow itself At any time, a Workflow can be asked to transform its current Props and State into a Rendering that is suitable for external consumption. A Rendering is typically a simple struct with display data, and event handler functions that can enqueue Workflow Actions \u2014 functions that update State, and which may at the same time emit Output events. For example, a Workflow running a simple game might be configured with a description of the participating Players as its Props, build GameScreen structs when asked to render, and emit a GameOver event as Output to signal that is finished. A workflow Rendering usually serves as a view model in iOS or Android apps, but that is not a requirement. Again, this page includes no details about how platform specific UI code is driven. See Workflow UI for that discussion. Note Readers with an Android background should note the lower case v and m of \u201cview model\u201d \u2014 this notion has nothing to do with Jetpack ViewModel . Composing Workflows \u00b6 Workflows run in a tree, with a single root Workflow declaring it has any number of children for a particular state, each of which can declare children of their own, and so on. The most common reason to compose Workflows this way is to build big view models (Renderings) out of small ones. For example, consider an overview / detail split screen, like an email app with a list of messages on the left, and the body of the selected message on the right. This could be modeled as a trio of Workflows: InboxWorkflow Expects a List as its Props Rendering is an InboxScreen , a struct with displayable information derived from its Props, and an onMessageSelected() function When onMessageSelected() is called, a WorkflowAction is executed which emits the given MessageId as Output Has no private State MessageWorkflow Requires a MessageId Props value to produce a MessageScreen Rendering Has no private State, and emits no Output EmailBrowserWorkflow State includes a List , and the selected MessageId Rendering is a SplitScreen view model, to be assembled from the renderings of the other two Workflows Accepts no Props, and emits no Output When EmailBrowserWorkflow is asked to provide its Rendering, it in turn asks for Renderings from its two children. It provides the List from its state as the Props for EmailInboxWorkflow and receives an InBoxScreen rendering in return. That InboxScreen becomes the left pane of a SplitScreen Rendering. For the SplitScreen \u2019s right pane, the browser Workflow provides the currently selected MessageId as input to EmailMessageWorkflow , to get a MessageScreen rendering. Note Note that the two children, EmailInboxWorkflow and EmailMessageWorkflow , have no knowledge of each other, nor of the context in which they are run. The InboxScreen rendering includes an onMessageSelected(MessageId) function. When that is called, EmailInboxWorkflow enqueues an Action function that emits the given MessageId as Output. EmailBrowserWorkflow receives that Output, and enqueues another Action that updates the selection: MessageId of its State accordingly. Whenever such a Workflow Action cascade fires, the root Workflow is asked for a new Rendering. Just as before, EmailBrowserWorkflow delegates to its two children for their Renderings, this time providing the new value of selection as the updated Props for MessageWorkflow . Why does Workflow work this way? \u00b6 Workflow was built to tame the composition and navigation challenges presented by Square\u2019s massive Android and iOS apps. It lets us write intricate, centralized, well tested code encapsulating the flow through literally hundreds of individual screens. These days we are able to see and shape the forest, despite all of the trees. We built it with two core design principals in mind: Unidirectional data flow is the best way to stay sane when building UI Declarative programming is the best way to define unidirectional data flows What does that actually mean? Unidirectional Data Flow \u00b6 There is a wealth of information on the web about Unidirectional Data Flow , but it very simply means that there is a single path along which data travel from your business logic to your UI, and events travel to your business logic from your UI, and they always and only travel in one direction along that path. For Workflow, this also implies that the UI is (almost) stateless, and that the interesting state for your app is centralized and not duplicated. In practice, this makes program flow much easier to reason about because anytime something happens in an app, it removes the questions of where the state came from that caused it, which components got which events, and which sequences of cause and effect actually occurred. It makes unit testing easier because state and events are explicit, and always live in the same place and flow through the same APIs, so unit tests only need to test state transitions, for the most part. Declarative vs Imperative \u00b6 Traditionally, most mobile code is \u201cimperative\u201d \u2013 it consists of instructions for how to build and display the UI. These instructions can include control flow like loops. Imperative code is usually stateful, state is usually sprinkled all over the place, and tends to care about instances and identity. When reading imperative code, you almost have to run an interpreter and keep all the pieces of state in your head to figure out what it does. Web UI is traditionally declarative \u2013 it describes what to render, and some aspects of how to render it (style), but doesn\u2019t say how to actually draw it. Declarative code is usually easier to read than imperative code. It describes what it produces, not how to generate it. Declarative code usually cares more about pure values than instance identities. However, since computers still need actual instructions at some point, declarative code requires something else, usually imperative, either a compiler or interpreter, to actually do something with it. Workflow code is written in regular Kotlin or Swift, which are both imperative languages, but the library encourages you to write your logic in a declarative and functional style. The library manages state and wiring up event handling for you, so the only code you need to write is code that is actually interesting for your particular problem. A note about functional programming Kotlin and Swift are not strictly functional programming languages, but both have features that allow you to write functional -style code. Functional code discourages side effects and is generally much easier to test than object-oriented code. Functional and declarative programming go very well together, and Workflow encourages you to write such code.","title":"Workflow Core"},{"location":"userguide/concepts/#workflow-core","text":"This page provides a high level overview of Workflow Core, the UI-agnostic Swift and Kotlin runtimes at the heart of the Workflow libraries. See Workflow UI to learn about the companion Android and iOS specific modules.","title":"Workflow Core"},{"location":"userguide/concepts/#what-is-a-workflow","text":"A Workflow defines the possible states and behaviors of components of a particular type. The overall state of a Workflow has two parts: Props , configuration information provided by whatever is running the Workflow And the private State managed by the Workflow itself At any time, a Workflow can be asked to transform its current Props and State into a Rendering that is suitable for external consumption. A Rendering is typically a simple struct with display data, and event handler functions that can enqueue Workflow Actions \u2014 functions that update State, and which may at the same time emit Output events. For example, a Workflow running a simple game might be configured with a description of the participating Players as its Props, build GameScreen structs when asked to render, and emit a GameOver event as Output to signal that is finished. A workflow Rendering usually serves as a view model in iOS or Android apps, but that is not a requirement. Again, this page includes no details about how platform specific UI code is driven. See Workflow UI for that discussion. Note Readers with an Android background should note the lower case v and m of \u201cview model\u201d \u2014 this notion has nothing to do with Jetpack ViewModel .","title":"What is a Workflow?"},{"location":"userguide/concepts/#composing-workflows","text":"Workflows run in a tree, with a single root Workflow declaring it has any number of children for a particular state, each of which can declare children of their own, and so on. The most common reason to compose Workflows this way is to build big view models (Renderings) out of small ones. For example, consider an overview / detail split screen, like an email app with a list of messages on the left, and the body of the selected message on the right. This could be modeled as a trio of Workflows: InboxWorkflow Expects a List as its Props Rendering is an InboxScreen , a struct with displayable information derived from its Props, and an onMessageSelected() function When onMessageSelected() is called, a WorkflowAction is executed which emits the given MessageId as Output Has no private State MessageWorkflow Requires a MessageId Props value to produce a MessageScreen Rendering Has no private State, and emits no Output EmailBrowserWorkflow State includes a List , and the selected MessageId Rendering is a SplitScreen view model, to be assembled from the renderings of the other two Workflows Accepts no Props, and emits no Output When EmailBrowserWorkflow is asked to provide its Rendering, it in turn asks for Renderings from its two children. It provides the List from its state as the Props for EmailInboxWorkflow and receives an InBoxScreen rendering in return. That InboxScreen becomes the left pane of a SplitScreen Rendering. For the SplitScreen \u2019s right pane, the browser Workflow provides the currently selected MessageId as input to EmailMessageWorkflow , to get a MessageScreen rendering. Note Note that the two children, EmailInboxWorkflow and EmailMessageWorkflow , have no knowledge of each other, nor of the context in which they are run. The InboxScreen rendering includes an onMessageSelected(MessageId) function. When that is called, EmailInboxWorkflow enqueues an Action function that emits the given MessageId as Output. EmailBrowserWorkflow receives that Output, and enqueues another Action that updates the selection: MessageId of its State accordingly. Whenever such a Workflow Action cascade fires, the root Workflow is asked for a new Rendering. Just as before, EmailBrowserWorkflow delegates to its two children for their Renderings, this time providing the new value of selection as the updated Props for MessageWorkflow .","title":"Composing Workflows"},{"location":"userguide/concepts/#why-does-workflow-work-this-way","text":"Workflow was built to tame the composition and navigation challenges presented by Square\u2019s massive Android and iOS apps. It lets us write intricate, centralized, well tested code encapsulating the flow through literally hundreds of individual screens. These days we are able to see and shape the forest, despite all of the trees. We built it with two core design principals in mind: Unidirectional data flow is the best way to stay sane when building UI Declarative programming is the best way to define unidirectional data flows What does that actually mean?","title":"Why does Workflow work this way?"},{"location":"userguide/concepts/#unidirectional-data-flow","text":"There is a wealth of information on the web about Unidirectional Data Flow , but it very simply means that there is a single path along which data travel from your business logic to your UI, and events travel to your business logic from your UI, and they always and only travel in one direction along that path. For Workflow, this also implies that the UI is (almost) stateless, and that the interesting state for your app is centralized and not duplicated. In practice, this makes program flow much easier to reason about because anytime something happens in an app, it removes the questions of where the state came from that caused it, which components got which events, and which sequences of cause and effect actually occurred. It makes unit testing easier because state and events are explicit, and always live in the same place and flow through the same APIs, so unit tests only need to test state transitions, for the most part.","title":"Unidirectional Data Flow"},{"location":"userguide/concepts/#declarative-vs-imperative","text":"Traditionally, most mobile code is \u201cimperative\u201d \u2013 it consists of instructions for how to build and display the UI. These instructions can include control flow like loops. Imperative code is usually stateful, state is usually sprinkled all over the place, and tends to care about instances and identity. When reading imperative code, you almost have to run an interpreter and keep all the pieces of state in your head to figure out what it does. Web UI is traditionally declarative \u2013 it describes what to render, and some aspects of how to render it (style), but doesn\u2019t say how to actually draw it. Declarative code is usually easier to read than imperative code. It describes what it produces, not how to generate it. Declarative code usually cares more about pure values than instance identities. However, since computers still need actual instructions at some point, declarative code requires something else, usually imperative, either a compiler or interpreter, to actually do something with it. Workflow code is written in regular Kotlin or Swift, which are both imperative languages, but the library encourages you to write your logic in a declarative and functional style. The library manages state and wiring up event handling for you, so the only code you need to write is code that is actually interesting for your particular problem. A note about functional programming Kotlin and Swift are not strictly functional programming languages, but both have features that allow you to write functional -style code. Functional code discourages side effects and is generally much easier to test than object-oriented code. Functional and declarative programming go very well together, and Workflow encourages you to write such code.","title":"Declarative vs Imperative"},{"location":"userguide/implementation/","text":"Implementation Notes \u00b6 Work in progress\u2026 So far we only have notes on the implementation of the Swift runtime. They\u2019re actually pretty close to what goes on in Kotlin, the WorkflowNode and SubtreeManager classes in particular. Swift \u00b6 The Render loop \u00b6 Initial pass \u00b6 The root of your workflow hierarchy gets put into a WorkflowHost (if you\u2019re using ContainerViewController this is created for you). As part of its initializer, WorkflowHost creates a WorkflowNode that wraps the given root Workflow (and keeps track of the Workflow \u2019s State ). It then calls render() on the node: // WorkflowHost public init ( workflow : WorkflowType , debugger : WorkflowDebugger ? = nil ) { self . debugger = debugger self . rootNode = WorkflowNode ( workflow : workflow ) // 1. Create the node self . mutableRendering = MutableProperty ( self . rootNode . render ()) // 2. Call render() WorkflowNode contains a SubtreeManager , whose primary purpose is to manage child workflows (more on this later). When render() gets invoked on the node, it calls render on the SubtreeManager and passes a closure that takes a RenderContext and returns a Rendering for the Workflow associated with the node. // WorkflowNode func render () -> WorkflowType . Rendering { return subtreeManager . render { context in return workflow . render ( state : state , context : context ) } } The SubtreeManager instantiates a RenderContext and invokes the closure that was passed in. This last step generates the Rendering . This Rendering then gets passed back up the call stack until it reaches the WorkflowHost . Composition \u00b6 In cases where a Workflow has child Workflow s, the render sequence is similar. The [tutorial] (../tutorial/building-a-workflow/#the-render-context) goes through this in more detail. Essentially, a Workflow containing child Workflow s calls render(context:key:outputMap:) on each child Workflow and passes in the RenderContext . The context does some bookkeeping for the child Workflow (creating or updating a ChildWorkflow ) and then calls render() . ChildWorkflow.render() calls render() on its WorkflowNode and we recurse back to step 2.","title":"Implementation Notes"},{"location":"userguide/implementation/#implementation-notes","text":"Work in progress\u2026 So far we only have notes on the implementation of the Swift runtime. They\u2019re actually pretty close to what goes on in Kotlin, the WorkflowNode and SubtreeManager classes in particular.","title":"Implementation Notes"},{"location":"userguide/implementation/#swift","text":"","title":"Swift"},{"location":"userguide/implementation/#the-render-loop","text":"","title":"The Render loop"},{"location":"userguide/implementation/#initial-pass","text":"The root of your workflow hierarchy gets put into a WorkflowHost (if you\u2019re using ContainerViewController this is created for you). As part of its initializer, WorkflowHost creates a WorkflowNode that wraps the given root Workflow (and keeps track of the Workflow \u2019s State ). It then calls render() on the node: // WorkflowHost public init ( workflow : WorkflowType , debugger : WorkflowDebugger ? = nil ) { self . debugger = debugger self . rootNode = WorkflowNode ( workflow : workflow ) // 1. Create the node self . mutableRendering = MutableProperty ( self . rootNode . render ()) // 2. Call render() WorkflowNode contains a SubtreeManager , whose primary purpose is to manage child workflows (more on this later). When render() gets invoked on the node, it calls render on the SubtreeManager and passes a closure that takes a RenderContext and returns a Rendering for the Workflow associated with the node. // WorkflowNode func render () -> WorkflowType . Rendering { return subtreeManager . render { context in return workflow . render ( state : state , context : context ) } } The SubtreeManager instantiates a RenderContext and invokes the closure that was passed in. This last step generates the Rendering . This Rendering then gets passed back up the call stack until it reaches the WorkflowHost .","title":"Initial pass"},{"location":"userguide/implementation/#composition","text":"In cases where a Workflow has child Workflow s, the render sequence is similar. The [tutorial] (../tutorial/building-a-workflow/#the-render-context) goes through this in more detail. Essentially, a Workflow containing child Workflow s calls render(context:key:outputMap:) on each child Workflow and passes in the RenderContext . The context does some bookkeeping for the child Workflow (creating or updating a ChildWorkflow ) and then calls render() . ChildWorkflow.render() calls render() on its WorkflowNode and we recurse back to step 2.","title":"Composition"},{"location":"userguide/testing-concepts/","text":"Workflow Testing \u00b6 Coming soon!","title":"Testing (TBD)"},{"location":"userguide/testing-concepts/#workflow-testing","text":"Coming soon!","title":"Workflow Testing"},{"location":"userguide/ui-concepts/","text":"Workflow UI \u00b6 This page provides a high level overview of Workflow UI, the companion that allows Workflow Core to drive Android and iOS apps. To see how these ideas are realized in code, move on to Coding Workflow UI . Warning The Screen interface that is so central to this discussion has reached Kotlin very recently, via v1.8.0-beta01 . Thus, if you are working against the most recent non-beta release, you will find the code blocks here don\u2019t match what you\u2019re seeing. Square is using the Screen machinery introduced with the beta at the heart of our Android app suite, and we expect the beta period to be a short one. The Swift Screen protocol et al. have been in steady use for years. What\u2019s a Screen? \u00b6 Most Workflow implementations produce struct / data class renderings that can serve as view models. Such a rendering provides enough data to paint a complete UI, including functions to be called in response to UI events. These view model renderings implement the Screen protocol / interface to advertise that this is their intended use. The core service provided by Workflow UI is to transform Screen types into platform-specific view objects, and to keep those views updated as new Screen renderings are emitted. Screen is the lynch pin that ties the Workflow Core and Workflow UI worlds together, the basic UI building block for Workflow-driven apps. A Screen is an object that can be presented as a basic 2D UI box, like an android.view.View or a UIViewController . And Workflow UI provides the glue that allows you to declare (at compile time!) that instances of FooScreen : Screen are used to drive FooViewController , layout/foo_screen.xml , or @Composable fun Content(FooScreen, ViewEnvironment) . Why \"Screen\"? We chose the name \u201cScreen\u201d because \u201cView\u201d would invite confusion with the like-named Android and iOS classes, and because \u201cBox\u201d didn\u2019t occur to us. (No one seems to have been bothered by the fact that Screen and iOS\u2019s UIScreen are unrelated.) And really, we went with \u201cScreen\u201d because it\u2019s the nebulous term that we and our users have always used to discuss our apps: \u201cGo to the Settings screen.\u201d \u201cHow do I get to the Tipping screen?\u201d \u201cThe Cart screen is shown in a modal over the Home screen on tablets.\u201d It\u2019s a safe bet you understood each of those sentences. Workflow Tree, Rendering Tree, View Tree \u00b6 In the Workflow Core page we discussed how Workflows can be composed as trees , like this email app driven by a trio of Workflows that assemble a composite SplitScreen rendering. Let\u2019s take a look at how Workflow UI transforms such a container screen into a container view . The main connection between the Workflow Core runtime and a native view system is the stream of Rendering objects from the root Workflow, EmailBrowserWorkflow in this discussion. From that point on, the flow of control is entirely in view-land. The precise details of that journey vary between Android and iOS in terms of naming, subclassing v. delegating, and so on, mainly to ensure that the API is idiomatic for each audience. None the less, the broad strokes are the same. (Move on to Coding Workflow UI to drill into the platform-specific details.) Each flavor of Workflow UI provides two core container helpers, both pictured below: A \u201cworkflow container\u201d, able to instantiate and update a view that can display Screen instances of the given type In iOS this is DescribedViewController For Android Classic we provide WorkflowViewStub , very similar to android.view.ViewStub . Android Jetpack Compose code can call @Compose fun WorkflowRendering() . A \u201cworkflow root container\u201d, able to field a stream of renderings from the Workflow Core runtime, and pass them on to a workflow container ContainerViewController for iOS WorkflowLayout for Android Classic @Compose fun Workflow.renderAsState() for Android Jetpack Compose When the runtime in our example is started, the flow is something like this: EmailBrowserWorkflow is asked for its first Rendering, a SplitScreen wrapping an InboxScreen and a MessageScreen . The Workflow root container receives that, and hands it off to its Workflow container . The container is able to resolve that SplitScreen instances can be displayed by views of the associated type Custom split view . The container builds that view, and passes it the SplitScreen . Custom split view is written with two Workflow containers of its own, one for the left side and for the right. The left hand container resolves InboxScreen to Custom inbox view , builds one, and hands the rendering that new view. The right hand container does the same for the MessageScreen , creating a Custom message view to display it. Sooner or later the state of EmailBrowserWorkflow or one of its children will change. Perhaps a new message has been received. Perhaps an event handler function on InboxScreen has been called because the user wants to read something else now. Regardless of where in the Workflow hierarchy the update happens, the entire tree will be re-rendered: EmailBrowserWorkflow will be asked for a new Rendering, it will ask its children for the same, and so on. Yes, everything renders when anything changes New Workflow developers generally freak out when they hear that the entire tree is re-rendered when any state anywhere updates. Remember that render() implementations are expected to be idempotent, and that their job is strictly declarative: render() effectively means \u201cI assume these children are running, and that I am subscribed to these work streams. Please make sure that stays the case, or fire up some new ones if needed.\u201d Another way is to think of them as declaring how to adapt the internal State into the external Rendering. These calls should be cheap, with all real work happening outside of the render() call. Optimizations may prevent rendering calls that are clearly redundant from being made, but semantically one should assume that the whole world is rendered when any part of the world changes. Once the runtime\u2019s Workflow tree finishes re-rendering, the new SplitScreen is passed through the native view system like so: The Workflow root container once again passes the new SplitScreen to its Workflow container , because that is the only trick it knows. That container recognizes that SplitScreen can be accepted by the Custom split view it created last time, and so there is no work to be done. The existing Custom split view receives the new SplitScreen . Just like last time, Custom split view passes InboxScreen to the Workflow container on its left, and MessageScreen to that on its right. The left hand Workflow container sees that it is already showing a Custom inbox view and passes InboxScreen rendering through. The same things happens with MessageScreen , and the Custom message view previously built by the right hand Workflow container . As is always the case with view code, Custom inbox view and Custom message view should be written with care to avoid redundant work, comparing what they are already showing with what they are being asked to show now. (A simple way to do this is to keep a Screen type\u2019s display data in a separate object from its event handlers, as an Equatable Swift struct, or as a Kotlin data class. Always hold on to the latest Screen in a var , and write UI click handlers and to reference it.) The update scenario would be different if the types of any of the Screen Renderings changed. Suppose our email app is able to host both email and voice mail in its inbox, and that the MessageScreen from the previous update is replaced with a VoicemailScreen this time. In that case, Custom message view would refuse the new Rendering, and the right hand Workflow container that created it would destroy it. A Custom voicemail view would be created in its stead, and that new view would paint itself with the information from the VoicemailScreen . So just how do these containers know what views to create for what Screen types? Those details are very language and platform specific, and are covered in the next page, under Building views from Screens . ViewEnvironment \u00b6 TK","title":"Workflow UI (in progress)"},{"location":"userguide/ui-concepts/#workflow-ui","text":"This page provides a high level overview of Workflow UI, the companion that allows Workflow Core to drive Android and iOS apps. To see how these ideas are realized in code, move on to Coding Workflow UI . Warning The Screen interface that is so central to this discussion has reached Kotlin very recently, via v1.8.0-beta01 . Thus, if you are working against the most recent non-beta release, you will find the code blocks here don\u2019t match what you\u2019re seeing. Square is using the Screen machinery introduced with the beta at the heart of our Android app suite, and we expect the beta period to be a short one. The Swift Screen protocol et al. have been in steady use for years.","title":"Workflow UI"},{"location":"userguide/ui-concepts/#whats-a-screen","text":"Most Workflow implementations produce struct / data class renderings that can serve as view models. Such a rendering provides enough data to paint a complete UI, including functions to be called in response to UI events. These view model renderings implement the Screen protocol / interface to advertise that this is their intended use. The core service provided by Workflow UI is to transform Screen types into platform-specific view objects, and to keep those views updated as new Screen renderings are emitted. Screen is the lynch pin that ties the Workflow Core and Workflow UI worlds together, the basic UI building block for Workflow-driven apps. A Screen is an object that can be presented as a basic 2D UI box, like an android.view.View or a UIViewController . And Workflow UI provides the glue that allows you to declare (at compile time!) that instances of FooScreen : Screen are used to drive FooViewController , layout/foo_screen.xml , or @Composable fun Content(FooScreen, ViewEnvironment) . Why \"Screen\"? We chose the name \u201cScreen\u201d because \u201cView\u201d would invite confusion with the like-named Android and iOS classes, and because \u201cBox\u201d didn\u2019t occur to us. (No one seems to have been bothered by the fact that Screen and iOS\u2019s UIScreen are unrelated.) And really, we went with \u201cScreen\u201d because it\u2019s the nebulous term that we and our users have always used to discuss our apps: \u201cGo to the Settings screen.\u201d \u201cHow do I get to the Tipping screen?\u201d \u201cThe Cart screen is shown in a modal over the Home screen on tablets.\u201d It\u2019s a safe bet you understood each of those sentences.","title":"What's a Screen?"},{"location":"userguide/ui-concepts/#workflow-tree-rendering-tree-view-tree","text":"In the Workflow Core page we discussed how Workflows can be composed as trees , like this email app driven by a trio of Workflows that assemble a composite SplitScreen rendering. Let\u2019s take a look at how Workflow UI transforms such a container screen into a container view . The main connection between the Workflow Core runtime and a native view system is the stream of Rendering objects from the root Workflow, EmailBrowserWorkflow in this discussion. From that point on, the flow of control is entirely in view-land. The precise details of that journey vary between Android and iOS in terms of naming, subclassing v. delegating, and so on, mainly to ensure that the API is idiomatic for each audience. None the less, the broad strokes are the same. (Move on to Coding Workflow UI to drill into the platform-specific details.) Each flavor of Workflow UI provides two core container helpers, both pictured below: A \u201cworkflow container\u201d, able to instantiate and update a view that can display Screen instances of the given type In iOS this is DescribedViewController For Android Classic we provide WorkflowViewStub , very similar to android.view.ViewStub . Android Jetpack Compose code can call @Compose fun WorkflowRendering() . A \u201cworkflow root container\u201d, able to field a stream of renderings from the Workflow Core runtime, and pass them on to a workflow container ContainerViewController for iOS WorkflowLayout for Android Classic @Compose fun Workflow.renderAsState() for Android Jetpack Compose When the runtime in our example is started, the flow is something like this: EmailBrowserWorkflow is asked for its first Rendering, a SplitScreen wrapping an InboxScreen and a MessageScreen . The Workflow root container receives that, and hands it off to its Workflow container . The container is able to resolve that SplitScreen instances can be displayed by views of the associated type Custom split view . The container builds that view, and passes it the SplitScreen . Custom split view is written with two Workflow containers of its own, one for the left side and for the right. The left hand container resolves InboxScreen to Custom inbox view , builds one, and hands the rendering that new view. The right hand container does the same for the MessageScreen , creating a Custom message view to display it. Sooner or later the state of EmailBrowserWorkflow or one of its children will change. Perhaps a new message has been received. Perhaps an event handler function on InboxScreen has been called because the user wants to read something else now. Regardless of where in the Workflow hierarchy the update happens, the entire tree will be re-rendered: EmailBrowserWorkflow will be asked for a new Rendering, it will ask its children for the same, and so on. Yes, everything renders when anything changes New Workflow developers generally freak out when they hear that the entire tree is re-rendered when any state anywhere updates. Remember that render() implementations are expected to be idempotent, and that their job is strictly declarative: render() effectively means \u201cI assume these children are running, and that I am subscribed to these work streams. Please make sure that stays the case, or fire up some new ones if needed.\u201d Another way is to think of them as declaring how to adapt the internal State into the external Rendering. These calls should be cheap, with all real work happening outside of the render() call. Optimizations may prevent rendering calls that are clearly redundant from being made, but semantically one should assume that the whole world is rendered when any part of the world changes. Once the runtime\u2019s Workflow tree finishes re-rendering, the new SplitScreen is passed through the native view system like so: The Workflow root container once again passes the new SplitScreen to its Workflow container , because that is the only trick it knows. That container recognizes that SplitScreen can be accepted by the Custom split view it created last time, and so there is no work to be done. The existing Custom split view receives the new SplitScreen . Just like last time, Custom split view passes InboxScreen to the Workflow container on its left, and MessageScreen to that on its right. The left hand Workflow container sees that it is already showing a Custom inbox view and passes InboxScreen rendering through. The same things happens with MessageScreen , and the Custom message view previously built by the right hand Workflow container . As is always the case with view code, Custom inbox view and Custom message view should be written with care to avoid redundant work, comparing what they are already showing with what they are being asked to show now. (A simple way to do this is to keep a Screen type\u2019s display data in a separate object from its event handlers, as an Equatable Swift struct, or as a Kotlin data class. Always hold on to the latest Screen in a var , and write UI click handlers and to reference it.) The update scenario would be different if the types of any of the Screen Renderings changed. Suppose our email app is able to host both email and voice mail in its inbox, and that the MessageScreen from the previous update is replaced with a VoicemailScreen this time. In that case, Custom message view would refuse the new Rendering, and the right hand Workflow container that created it would destroy it. A Custom voicemail view would be created in its stead, and that new view would paint itself with the information from the VoicemailScreen . So just how do these containers know what views to create for what Screen types? Those details are very language and platform specific, and are covered in the next page, under Building views from Screens .","title":"Workflow Tree, Rendering Tree, View Tree"},{"location":"userguide/ui-concepts/#viewenvironment","text":"TK","title":"ViewEnvironment"},{"location":"userguide/ui-in-code/","text":"Coding Workflow UI \u00b6 This page translates the high level discussion of Workflow UI into Android and iOS code. Separation of Concerns \u00b6 Workflow maintains a rigid separation between its core runtime and its UI support. The Workflow Core modules are strictly Swift and Kotlin, with no dependencies on any UI framework. Dependencies on Android and iOS are restricted to the Workflow UI modules, as you would expect. This innate separation naturally puts developers on a path to avoid entangling view concerns with their app logic. And note that we say \u201capp logic\u201d rather than \u201cbusiness logic.\u201d In any interesting app, the code that manages navigation and other UI-releated behavior is likely to dwarf that for what we typically think of as model concerns, in both size and complexity. We\u2019re all pretty good at capturing business concerns in tidy object-oriented models of items for sale, shopping carts, payment cards and the like, nicely decoupled from the UI world. But the rest of the app, and in particular the bits about how our users navigate it? Traditionally it\u2019s hard to keep that app-specific logic centralized, so that you can see what\u2019s going on; and even harder to keep it decoupled from your view system, so that it\u2019s easy to test. The strict divide between Workflow UI and Workflow Core leads you to maintain that separation by accident. Bootstrapping \u00b6 The following snippets demonstrate using Workflow to drive the root views of iOS and Android apps. But really, you can host a Workflow driven UI anywhere you can show a view, whatever \u201cview\u201d means on your platform. iOS @UIApplicationMain class AppDelegate : UIResponder , UIApplicationDelegate { var window : UIWindow ? func application ( _ application : UIApplication , didFinishLaunchingWithOptions launchOptions : [ UIApplication . LaunchOptionsKey : Any ]?) -> Bool { window = UIWindow ( frame : UIScreen . main . bounds ) window ?. rootViewController = ContainerViewController ( workflow : RootWorkflow ()) window ?. makeKeyAndVisible () return true } } Android Classic Android classic makes things a little complicated (naturally), as your Workflow runtime has to survive configuration changes. Our habit is use a Jetpack ViewModel to solve that problem, on what is typically the only line of code in a Workflow app that deals with the Jetpack Lifecycle at all. HelloWorkflowActivity.kt class HelloWorkflowActivity : AppCompatActivity () { override fun onCreate ( savedInstanceState : Bundle?) { super . onCreate ( savedInstanceState ) // This ViewModel will survive configuration changes. It's instantiated // by the first call to androidx.activity.viewModels(), and that // original instance is returned by succeeding calls. val model : HelloViewModel by viewModels () setContentView ( WorkflowLayout ( this ). apply { take ( lifecycle , model . renderings ) } ) } } class HelloViewModel ( savedState : SavedStateHandle ) : ViewModel () { val renderings : StateFlow < HelloRendering > by lazy { renderWorkflowIn ( workflow = HelloWorkflow , scope = viewModelScope , savedStateHandle = savedState ) } } Android Jetpack Compose HelloComposeActivity.kt class HelloComposeActivity : AppCompatActivity () { override fun onCreate ( savedInstanceState : Bundle?) { super . onCreate ( savedInstanceState ) setContent { val rendering by HelloWorkflow . renderAsState ( props = Unit , onOutput = {}) WorkflowRendering ( rendering , ViewEnvironment . EMPTY ) } } } Android developers should note that classic and Compose bootstrapping are completely interchangeable. Each style is able to display Screens of any type, regardless of whether they are set up to inflate View instances or to run @Composeable functions. Building views from Screens \u00b6 Hello, Screen world. iOS WelcomeScreen.swift struct WelcomeScreen : Screen { var name : String var onNameChanged : ( String ) -> Void var onLoginTapped : () -> Void func viewControllerDescription ( environment : ViewEnvironment ) -> ViewControllerDescription { return WelcomeViewController . description ( for : self , environment : environment ) } } private final class WelcomeViewController : ScreenViewController < WelcomeScreen > { override func viewDidLoad () { \u2026 } override func viewDidLayoutSubviews () { \u2026 } override func screenDidChange ( from previousScreen : WelcomeScreen , previousEnvironment : ViewEnvironment ) { super . screenDidChange ( from : previousScreen , previousEnvironment : previousEnvironment ) nameField . text = screen . name } } iOS Screen classes are expected to provide matching ViewControllerDescription instances. A ViewControllerDescription can build a UIViewController on demand, or update an existing one if it\u2019s recognized by ViewControllerDescription.canUpdate(UIViewController) . These duties are all fullfilled by the provided open class ScreenViewController . It\u2019s like any other ViewController , with the addition of: an open screenDidChange() method that the Workflow UI runtime calls with a series of Screen instances of the specified type a description() class method, perfect for calling from Screen.viewcontrollerDescription() Android Classic HelloScreen.kt data class HelloScreen ( val message : String , val onClick : () -> Unit ) : AndroidScreen < HelloScreen > { override val viewFactory : ScreenViewFactory < HelloScreen > = fromViewBinding ( HelloViewBinding :: inflate ) { helloScreen , viewEnvironment -> helloMessage . text = helloScreen . message helloMessage . setOnClickListener { helloScreen . onClick () } } } The Android Screen interface is purely a marker type. It defines no Android-specific methods to ensure you have the option of keeping your app logic pure. If you don\u2019t need that rigor, life is simpler (and safer, no runtime errors) if your Screen renderings implement AndroidScreen instead. An AndroidScreen is required to provide a matching ScreenViewFactory . ScreenViewFactory returns View instances wrapped in ScreenViewHolder objects. ScreenViewHolder.show is called by the Workflow UI runtime to update the view with Screen instances that are deemed acceptible by ScreenViewHolder.canShow . In this example the fromViewBinding function creates a ScreenViewFactory that builds View instances using a Jetpack View Binding , HelloViewBinding , presumably derived from hello_view_binding.xml . The lamda argument to the fromViewBinding provides the implementation for ScreenViewHolder.show , and is guaranteed that the given helloScreen parameter is of the appropriate type. Other factory functions are provided to work with layout resources directly, or to build views entirely from code. Android Jetpack Compose HelloScreen.kt data class HelloScreen ( val message : String , val onClick : () -> Unit ) : ComposeScreen < HelloScreen > { @Composable override fun Content ( viewEnvironment : ViewEnvironment ) { Button ( onClick ) { Text ( message ) } } } Here, HelloScreen is implementing ComposeScreen . ComposeScreen extends the same AndroidScreen class used for classic Android, defining @Composable fun Content() to get its work done. Content is always called from a @Composable Box() context. It\u2019s context aware Even though AndroidScreen provides a thing called ScreenViewFactory to do its work, the factories built by ComposeScreen are able to recognize whether they\u2019re being called from a classic View or from a @Composeable function, and do the right thing. Workflow UI only creates ComposeView instances as needed: when a @Composeable needs to be shown in a View . If the factory is to be used in a @Composable context, Content() is called directly. Where is that \u201cseparation of concerns\u201d you promised? \u00b6 After all the chest-thumping above about Separation of Concerns , the code samples above probably look pretty entangled. That\u2019s because, while the Workflow libraries themselves are completely decoupled, they don\u2019t force that strict rigor on your app code. If you aren\u2019t building, say, a core Workflow module that you want to ship separately from its Android and command line interfaces, you\u2019d probably gain nothing from enforced separation but boilerplate and runtime errors. And in practice, your Workflow unit tests won\u2019t call viewFactory and will build and run just fine against the JVM. Likewise, at this point we\u2019ve been building apps this way for hundreds of engineering years, and so far no one has called viewControllerDescription() and stashed a UIViewController in their workflow state. (This is not a challenge.) If you are one of the few who truly do need impermeable boundaries between your core and UI modules, they aren\u2019t hard to get. Your Screen implementations can be defined completely separately from their view code and bound later. iOS WelcomeScreen.swift struct WelcomeScreen { var name : String var onNameChanged : ( String ) -> Void var onLoginTapped : () -> Void } WelcomeViewController.swift extension WelcomeScreen : Screen { func viewControllerDescription ( environment : ViewEnvironment ) -> ViewControllerDescription { return WelcomeViewController . description ( for : self , environment : environment ) } } private final class WelcomeViewController : ScreenViewController < WelcomeScreen > { // ... Android HelloScreen.kt data class HelloScreen ( val message : String , val onClick : () -> Unit ) : Screen HelloWorkflowGreenTheme.kt private object HelloScreenGreenThemeViewFactory : ScreenViewFactory < HelloScreen > by ScreenViewFactory . fromViewBinding ( GreenHelloViewBinding :: inflate ) { r , _ -> helloMessage . text = r . message helloMessage . setOnClickListener { r . onClick () } } } private val viewRegistry = ViewRegistry ( HelloScreenGreenThemeViewFactory ) val HelloWorkflowGreenTheme = HelloWorkflow . mapRenderings { it . withRegistry ( viewRegistry ) } Container screens make container views \u00b6 A container screen is one that is built out of other Screens. And naturally enough, the thing that a container screen drives is a container view : one that is able to host child views that are driven by Screen instances of arbitrary type. Workflow UI provides two root container views out of the box, the ContainerViewController and WorkflowLayout classes discussed above, under Bootstrapping . They do most of their work by delegating to another pair of support view classes: ScreenViewController for iOS and WorkflowViewStub for Android. Android also provides @Composable fun WorkflowRendering() for use with Jetpack Compose. For something like a SplitScreen rendering, you\u2019ll write your own view code that does the same. iOS SplitScreen.swift public struct SplitScreen < LeadingScreenType : Screen , TrailingScreenType : Screen >: Screen { public let leadingScreen : LeadingScreenType public let trailingScreen : TrailingScreenType public func viewControllerDescription ( environment : ViewEnvironment ) -> ViewControllerDescription { return SplitScreenViewController . description ( for : self , environment : environment ) } SplitScreenViewController.swift internal final class SplitScreenViewController < LeadingScreenType : Screen , TrailingScreenType : Screen >: ScreenViewController < SplitScreenViewController . ContainerScreen > { internal typealias ContainerScreen = SplitScreen < LeadingScreenType , TrailingScreenType > private var leadingContentViewController : DescribedViewController private lazy var leadingContainerView : ContainerView = . init () private lazy var separatorView : UIView = . init () private var trailingContentViewController : DescribedViewController private lazy var trailingContainerView : ContainerView = . init () required init ( screen : ContainerScreen , environment : ViewEnvironment ) { self . leadingContentViewController = DescribedViewController ( screen : screen . leadingScreen , environment : environment ) self . trailingContentViewController = DescribedViewController ( screen : screen . trailingScreen , environment : environment ) super . init ( screen : screen , environment : environment ) } override internal func screenDidChange ( from previousScreen : ContainerScreen , previousEnvironment : ViewEnvironment ) { super . screenDidChange ( from : previousScreen , previousEnvironment : previousEnvironment ) update ( with : screen ) } private func update ( with screen : ContainerScreen ) { leadingContentViewController . update ( screen : screen . leadingScreen , environment : environment ) trailingContentViewController . update ( screen : screen . trailingScreen , environment : environment ) // Intentional force of layout pass after updating the child view controllers view . layoutIfNeeded () } override internal func viewDidLoad () { /** Lay out the two children horizontally, nothing workflow specific here. */ update ( with : screen ) } override internal func viewDidLayoutSubviews () { /** Calculate the layout, nothing workflow specific here. */ } The interesting thing here is the use of DescribedViewController to display the nested leadingContent and trailingContent Screens. DescribedViewController uses Screen.viewControllerDescription to build a new UIViewController if it needs to, or update an existing one if it can. Everything else is just run of the mill iOS view code. Android Classic SplitScreen.kt data class SplitScreen < L : Screen , T : Screen > ( val leadingScreen : L , val trailingScreen : T ): AndroidScreen < SplitScreen < L , T >> { override val viewFactory : ScreenViewFactory < SplitScreen < L , T >> = fromViewBinding ( SplitScreenBinding :: inflate ) { screen , _ -> leadingStub . show ( leadingScreen ) trailingStub . show ( trailingScreen ) } } split_screen.xml Android Jetpack Compose SplitScreen.kt data class SplitScreen < L : Screen , T : Screen > ( val leadingScreen : L , val trailingScreen : T ): ComposeScreen < SplitScreen < L , T >> { @Composable override fun Content ( viewEnvironment : ViewEnvironment ) { Row { WorkflowRendering ( rendering = leadingScreen , modifier = Modifier . weight ( 1 / 3f ) . fillMaxHeight () ) WorkflowRendering ( rendering = trailingScreen , modifier = Modifier . weight ( 2 / 3f ) . fillMaxHeight () ) } } }","title":"Coding Workflow UI (in progress)"},{"location":"userguide/ui-in-code/#coding-workflow-ui","text":"This page translates the high level discussion of Workflow UI into Android and iOS code.","title":"Coding Workflow UI"},{"location":"userguide/ui-in-code/#separation-of-concerns","text":"Workflow maintains a rigid separation between its core runtime and its UI support. The Workflow Core modules are strictly Swift and Kotlin, with no dependencies on any UI framework. Dependencies on Android and iOS are restricted to the Workflow UI modules, as you would expect. This innate separation naturally puts developers on a path to avoid entangling view concerns with their app logic. And note that we say \u201capp logic\u201d rather than \u201cbusiness logic.\u201d In any interesting app, the code that manages navigation and other UI-releated behavior is likely to dwarf that for what we typically think of as model concerns, in both size and complexity. We\u2019re all pretty good at capturing business concerns in tidy object-oriented models of items for sale, shopping carts, payment cards and the like, nicely decoupled from the UI world. But the rest of the app, and in particular the bits about how our users navigate it? Traditionally it\u2019s hard to keep that app-specific logic centralized, so that you can see what\u2019s going on; and even harder to keep it decoupled from your view system, so that it\u2019s easy to test. The strict divide between Workflow UI and Workflow Core leads you to maintain that separation by accident.","title":"Separation of Concerns"},{"location":"userguide/ui-in-code/#bootstrapping","text":"The following snippets demonstrate using Workflow to drive the root views of iOS and Android apps. But really, you can host a Workflow driven UI anywhere you can show a view, whatever \u201cview\u201d means on your platform. iOS @UIApplicationMain class AppDelegate : UIResponder , UIApplicationDelegate { var window : UIWindow ? func application ( _ application : UIApplication , didFinishLaunchingWithOptions launchOptions : [ UIApplication . LaunchOptionsKey : Any ]?) -> Bool { window = UIWindow ( frame : UIScreen . main . bounds ) window ?. rootViewController = ContainerViewController ( workflow : RootWorkflow ()) window ?. makeKeyAndVisible () return true } } Android Classic Android classic makes things a little complicated (naturally), as your Workflow runtime has to survive configuration changes. Our habit is use a Jetpack ViewModel to solve that problem, on what is typically the only line of code in a Workflow app that deals with the Jetpack Lifecycle at all. HelloWorkflowActivity.kt class HelloWorkflowActivity : AppCompatActivity () { override fun onCreate ( savedInstanceState : Bundle?) { super . onCreate ( savedInstanceState ) // This ViewModel will survive configuration changes. It's instantiated // by the first call to androidx.activity.viewModels(), and that // original instance is returned by succeeding calls. val model : HelloViewModel by viewModels () setContentView ( WorkflowLayout ( this ). apply { take ( lifecycle , model . renderings ) } ) } } class HelloViewModel ( savedState : SavedStateHandle ) : ViewModel () { val renderings : StateFlow < HelloRendering > by lazy { renderWorkflowIn ( workflow = HelloWorkflow , scope = viewModelScope , savedStateHandle = savedState ) } } Android Jetpack Compose HelloComposeActivity.kt class HelloComposeActivity : AppCompatActivity () { override fun onCreate ( savedInstanceState : Bundle?) { super . onCreate ( savedInstanceState ) setContent { val rendering by HelloWorkflow . renderAsState ( props = Unit , onOutput = {}) WorkflowRendering ( rendering , ViewEnvironment . EMPTY ) } } } Android developers should note that classic and Compose bootstrapping are completely interchangeable. Each style is able to display Screens of any type, regardless of whether they are set up to inflate View instances or to run @Composeable functions.","title":"Bootstrapping"},{"location":"userguide/ui-in-code/#building-views-from-screens","text":"Hello, Screen world. iOS WelcomeScreen.swift struct WelcomeScreen : Screen { var name : String var onNameChanged : ( String ) -> Void var onLoginTapped : () -> Void func viewControllerDescription ( environment : ViewEnvironment ) -> ViewControllerDescription { return WelcomeViewController . description ( for : self , environment : environment ) } } private final class WelcomeViewController : ScreenViewController < WelcomeScreen > { override func viewDidLoad () { \u2026 } override func viewDidLayoutSubviews () { \u2026 } override func screenDidChange ( from previousScreen : WelcomeScreen , previousEnvironment : ViewEnvironment ) { super . screenDidChange ( from : previousScreen , previousEnvironment : previousEnvironment ) nameField . text = screen . name } } iOS Screen classes are expected to provide matching ViewControllerDescription instances. A ViewControllerDescription can build a UIViewController on demand, or update an existing one if it\u2019s recognized by ViewControllerDescription.canUpdate(UIViewController) . These duties are all fullfilled by the provided open class ScreenViewController . It\u2019s like any other ViewController , with the addition of: an open screenDidChange() method that the Workflow UI runtime calls with a series of Screen instances of the specified type a description() class method, perfect for calling from Screen.viewcontrollerDescription() Android Classic HelloScreen.kt data class HelloScreen ( val message : String , val onClick : () -> Unit ) : AndroidScreen < HelloScreen > { override val viewFactory : ScreenViewFactory < HelloScreen > = fromViewBinding ( HelloViewBinding :: inflate ) { helloScreen , viewEnvironment -> helloMessage . text = helloScreen . message helloMessage . setOnClickListener { helloScreen . onClick () } } } The Android Screen interface is purely a marker type. It defines no Android-specific methods to ensure you have the option of keeping your app logic pure. If you don\u2019t need that rigor, life is simpler (and safer, no runtime errors) if your Screen renderings implement AndroidScreen instead. An AndroidScreen is required to provide a matching ScreenViewFactory . ScreenViewFactory returns View instances wrapped in ScreenViewHolder objects. ScreenViewHolder.show is called by the Workflow UI runtime to update the view with Screen instances that are deemed acceptible by ScreenViewHolder.canShow . In this example the fromViewBinding function creates a ScreenViewFactory that builds View instances using a Jetpack View Binding , HelloViewBinding , presumably derived from hello_view_binding.xml . The lamda argument to the fromViewBinding provides the implementation for ScreenViewHolder.show , and is guaranteed that the given helloScreen parameter is of the appropriate type. Other factory functions are provided to work with layout resources directly, or to build views entirely from code. Android Jetpack Compose HelloScreen.kt data class HelloScreen ( val message : String , val onClick : () -> Unit ) : ComposeScreen < HelloScreen > { @Composable override fun Content ( viewEnvironment : ViewEnvironment ) { Button ( onClick ) { Text ( message ) } } } Here, HelloScreen is implementing ComposeScreen . ComposeScreen extends the same AndroidScreen class used for classic Android, defining @Composable fun Content() to get its work done. Content is always called from a @Composable Box() context. It\u2019s context aware Even though AndroidScreen provides a thing called ScreenViewFactory to do its work, the factories built by ComposeScreen are able to recognize whether they\u2019re being called from a classic View or from a @Composeable function, and do the right thing. Workflow UI only creates ComposeView instances as needed: when a @Composeable needs to be shown in a View . If the factory is to be used in a @Composable context, Content() is called directly.","title":"Building views from Screens"},{"location":"userguide/ui-in-code/#where-is-that-separation-of-concerns-you-promised","text":"After all the chest-thumping above about Separation of Concerns , the code samples above probably look pretty entangled. That\u2019s because, while the Workflow libraries themselves are completely decoupled, they don\u2019t force that strict rigor on your app code. If you aren\u2019t building, say, a core Workflow module that you want to ship separately from its Android and command line interfaces, you\u2019d probably gain nothing from enforced separation but boilerplate and runtime errors. And in practice, your Workflow unit tests won\u2019t call viewFactory and will build and run just fine against the JVM. Likewise, at this point we\u2019ve been building apps this way for hundreds of engineering years, and so far no one has called viewControllerDescription() and stashed a UIViewController in their workflow state. (This is not a challenge.) If you are one of the few who truly do need impermeable boundaries between your core and UI modules, they aren\u2019t hard to get. Your Screen implementations can be defined completely separately from their view code and bound later. iOS WelcomeScreen.swift struct WelcomeScreen { var name : String var onNameChanged : ( String ) -> Void var onLoginTapped : () -> Void } WelcomeViewController.swift extension WelcomeScreen : Screen { func viewControllerDescription ( environment : ViewEnvironment ) -> ViewControllerDescription { return WelcomeViewController . description ( for : self , environment : environment ) } } private final class WelcomeViewController : ScreenViewController < WelcomeScreen > { // ... Android HelloScreen.kt data class HelloScreen ( val message : String , val onClick : () -> Unit ) : Screen HelloWorkflowGreenTheme.kt private object HelloScreenGreenThemeViewFactory : ScreenViewFactory < HelloScreen > by ScreenViewFactory . fromViewBinding ( GreenHelloViewBinding :: inflate ) { r , _ -> helloMessage . text = r . message helloMessage . setOnClickListener { r . onClick () } } } private val viewRegistry = ViewRegistry ( HelloScreenGreenThemeViewFactory ) val HelloWorkflowGreenTheme = HelloWorkflow . mapRenderings { it . withRegistry ( viewRegistry ) }","title":"Where is that \"separation of concerns\" you promised?"},{"location":"userguide/ui-in-code/#container-screens-make-container-views","text":"A container screen is one that is built out of other Screens. And naturally enough, the thing that a container screen drives is a container view : one that is able to host child views that are driven by Screen instances of arbitrary type. Workflow UI provides two root container views out of the box, the ContainerViewController and WorkflowLayout classes discussed above, under Bootstrapping . They do most of their work by delegating to another pair of support view classes: ScreenViewController for iOS and WorkflowViewStub for Android. Android also provides @Composable fun WorkflowRendering() for use with Jetpack Compose. For something like a SplitScreen rendering, you\u2019ll write your own view code that does the same. iOS SplitScreen.swift public struct SplitScreen < LeadingScreenType : Screen , TrailingScreenType : Screen >: Screen { public let leadingScreen : LeadingScreenType public let trailingScreen : TrailingScreenType public func viewControllerDescription ( environment : ViewEnvironment ) -> ViewControllerDescription { return SplitScreenViewController . description ( for : self , environment : environment ) } SplitScreenViewController.swift internal final class SplitScreenViewController < LeadingScreenType : Screen , TrailingScreenType : Screen >: ScreenViewController < SplitScreenViewController . ContainerScreen > { internal typealias ContainerScreen = SplitScreen < LeadingScreenType , TrailingScreenType > private var leadingContentViewController : DescribedViewController private lazy var leadingContainerView : ContainerView = . init () private lazy var separatorView : UIView = . init () private var trailingContentViewController : DescribedViewController private lazy var trailingContainerView : ContainerView = . init () required init ( screen : ContainerScreen , environment : ViewEnvironment ) { self . leadingContentViewController = DescribedViewController ( screen : screen . leadingScreen , environment : environment ) self . trailingContentViewController = DescribedViewController ( screen : screen . trailingScreen , environment : environment ) super . init ( screen : screen , environment : environment ) } override internal func screenDidChange ( from previousScreen : ContainerScreen , previousEnvironment : ViewEnvironment ) { super . screenDidChange ( from : previousScreen , previousEnvironment : previousEnvironment ) update ( with : screen ) } private func update ( with screen : ContainerScreen ) { leadingContentViewController . update ( screen : screen . leadingScreen , environment : environment ) trailingContentViewController . update ( screen : screen . trailingScreen , environment : environment ) // Intentional force of layout pass after updating the child view controllers view . layoutIfNeeded () } override internal func viewDidLoad () { /** Lay out the two children horizontally, nothing workflow specific here. */ update ( with : screen ) } override internal func viewDidLayoutSubviews () { /** Calculate the layout, nothing workflow specific here. */ } The interesting thing here is the use of DescribedViewController to display the nested leadingContent and trailingContent Screens. DescribedViewController uses Screen.viewControllerDescription to build a new UIViewController if it needs to, or update an existing one if it can. Everything else is just run of the mill iOS view code. Android Classic SplitScreen.kt data class SplitScreen < L : Screen , T : Screen > ( val leadingScreen : L , val trailingScreen : T ): AndroidScreen < SplitScreen < L , T >> { override val viewFactory : ScreenViewFactory < SplitScreen < L , T >> = fromViewBinding ( SplitScreenBinding :: inflate ) { screen , _ -> leadingStub . show ( leadingScreen ) trailingStub . show ( trailingScreen ) } } split_screen.xml Android Jetpack Compose SplitScreen.kt data class SplitScreen < L : Screen , T : Screen > ( val leadingScreen : L , val trailingScreen : T ): ComposeScreen < SplitScreen < L , T >> { @Composable override fun Content ( viewEnvironment : ViewEnvironment ) { Row { WorkflowRendering ( rendering = leadingScreen , modifier = Modifier . weight ( 1 / 3f ) . fillMaxHeight () ) WorkflowRendering ( rendering = trailingScreen , modifier = Modifier . weight ( 2 / 3f ) . fillMaxHeight () ) } } }","title":"Container screens make container views"},{"location":"userguide/whyworkflow/","text":"Why Workflow? \u00b6 So you want me to take the application feature I have to develop and break it down into separate components? And then enumerate every possible state for each of those components? As well as writing classes or structs that represent each of these states in addition to the collection of objects that each component might pass to another? That sounds like a lot of work just to help the seller order a set of gift cards! Why make something simple so complicated? Why should I use Workflow? I think even those of us who use Workflow all the time end up asking this question. It\u2019s a very reasonable question that we try to answer here. At the heart of the matter, there are two complementary justifications for Workflow, which we will expand on below: Software clarity, correctness, and testability (especially at scale). Encouraging programming paradigms that are best practices for the mobile domain. Software clarity, correctness, and testability (at scale) \u00b6 I like to think that most of us have been there: It\u2019s our second straight day staring at the logs from over 200 customers. We know what the problem is : the user gets to screen Y and object foo\u2019s state is bar, but foo should not be bar while in screen Y. Why is foo bar? Unfortunately we don\u2019t have any debug log for foo\u2019s state at the time we start screen Y. We only have one when the user tries to click on button Z, and at that point the state is already bar even though it should only ever be baz or buz. What happened? How did foo get to state bar on screen Y? Looking at the code, foo is shared state with 15 other screens, and it is mutable in all of them. The logic to update foo\u2019s state in screen Y happens in code that is coupled to interaction with button Z, so we cannot simply add a unit test for this, we need a complex UI test to reproduce screen Y. We don\u2019t know how the problem happened and it almost seems like we can\u2019t know how without significant effort! The story above is a little dramatic but I hope the feeling it invokes is familiar. It is a daunting task to reason through application code and build up a sufficient mental model of all possible side effects in any one feature area. Now scale up the numbers a bit \u2014 foo is shared by 150 other screens \u2014 and the once daunting task seems almost impossible. All mobile developers face some form of the above problem, and at Square within our Point of Sale applications we face the scaled up version every day. What do we want? \u00b6 Clear boundaries between each feature\u2019s software components that can be instrumented with logs and that have contracts that can be tested. Clear expectations for outcomes within a particular feature\u2019s software component that can be verified for correctness with tests. Immutable State within any particular scope (e.g. Screen Y in the context above) so that the code handling mutations to provide a new State as a result of some event is in a \u201cprotected area\u201d that can be instrumented and tested. A clear separation of the State updates from the presentation of the UI. We want the conditions above because we want: Not to have bugs like the one we started this discussion with. In other words, we want our tests to give us confidence in our application logic. In the inevitable case that we do have a bug, we want to be able to isolate the scenario, reproduce the exact conditions, fix the bug and write a test so that it doesn\u2019t happen again. Workflow facilitates these goals for native mobile applications by providing a pattern (and a supporting application Runtime) similar to React, Elm, or any number of other web application JavaScript frameworks (not to mention forthcoming native mobile frameworks such as Jetpack Compose and SwiftUI). Each logical component area is separated into a Workflow with a finite set of states and the logic to transition between them. Workflows can be composed together for a full feature with each Workflow\u2019s signature specifying a clear contract. The Workflow Runtime\u2019s event loop handles the production of new immutable states for each Workflow so that within the Workflow render logic it is immutable. Workflows can be executed and instrumented in a testable way with extra hooks for simple verification of outcomes in unit tests. On an even simpler level Workflow improves clarity by giving a large team of developers a shared idiom of software components with which to discuss business logic across feature areas, and across mobile platforms (Android, iOS). Further, as the application is composed with multiple Workflows, the framework enables loose coupling between features to focus the impact of code changes. Encouraging programming paradigms that are best practices for the mobile domain \u00b6 Mobile applications receive and display a lot of data! Our applications at Square certainly do. As a result of this, there is a growing trend towards reactive programming for mobile applications. In this paradigm, the application logic subscribes to a stream of data which is then pushed to the logic rather than having to be periodically pulled and operated on. This has the profound effect of ensuring that the data shown to the application user is never stale. This style of programming also makes clear that most mobile applications are a series of mapping operations on a stream of data that is eventually mapped into some UI. Another mobile programming best practice (arising out of a long tradition) is to favor declarative programming over imperative programming . With this style choice, the code for a feature declares what should be occurring for a particular state, rather than consisting of a series of statements that are essentially how to make that occur. This is a best practice because when a program\u2019s logic is defined in this way, it is very simple to test (so more likely to be tested!): \u201cFor state Y we expect Rendering Z;\u201d \u201cFrom state Y given input A we expect Rendering Z+.\u201d Possibly more important, it is easier to read, comprehend quickly, and to reason about than a series of complex commands for the computer. Workflows encourage a declarative style because each state of a particular component must be enumerated and then the Rendering (representation that gets passed to the UI framework) is declared for that particular state, alongside a declaration of what children and side effects should be running in that state. The well-tested and reliable Workflow runtime loop itself handles how to start and stop the children and side effects, reducing resource leaks. By requiring these formal definitions of each State, Rendering, and the Actions that will change the current state, Workflow naturally encourages declarative programming. While reactive and declarative programming may be current best practices, there is one Software Engineering principle that has proven over and over again to be the most universal and the most important for systems of scale: Separation of Concerns . Any system of scale requires multiple separate components that can be worked on, tested, improved, and refactored independently by multiple teams of people. A system of multiple components requires communication and any good communication begs explicit structure and contracts. For mobile applications at Square we have settled on the Model-View-ViewModel (MVVM) architecture as the structure for the topical separation of concerns of the layers of the application. MVVM\u2019s unidirectional layered communication is the same as that of Model-View-Presenter (MVP), as opposed to the \u2018circular\u2019 communication of Model-View-Controller (MVC). MVVM\u2019s use of a strict binding between the ViewModel and the View is the same as MVC, as opposed to the imperative interpretation of the Model in MVP. MVVM provides the reasoning and comprehension benefits of unidirectional data flow while also eliminating as much business logic as possible from the view layer and encouraging declarative ViewModels. At Square this works well because we have UI design frameworks that change infrequently (so keeping bindings up-to-date is not much overhead), but business logic that is constantly being updated (so emphasizing low coupling is important). Workflows embrace MVVM because the Rendering produced by a Workflow tree is the ViewModel, which can then be bound to any native mobile UI framework. For feature based separation of concerns we lean on Workflow\u2019s facility for composition at scale via strong parent-child contracts and a hierarchical tree organization. While building a Hello World Workflow may seem like overkill (although it\u2019s really not that bad!), the explicitness and contracts that Workflows require of the developer lay the structure for good communication. The composability of Workflows encourages reuse and encourages separation of concerns into the most appropriate reusable components. There are even more platform-specific best practices that Workflow dovetails well with, such as structured concurrency with Kotlin coroutines, as each Worker or side effect can define a specific coroutine scope for the operations. What about the next 10 years? Jetpack Compose UI and SwiftUI are establishing themselves as the native mobile UI toolkits of the future. They both embrace the same MVVM approach that Workflow does, and encourage thinking about the \u201ccomposability\u201d of separate components of your application. With this resonance, Workflows help you to prepare your mental model to adapt to these new UI toolkits, and shapes our codebase in a way that will ease our adoption of them. To learn more about Compose and Workflow see this post .","title":"Why Workflow?"},{"location":"userguide/whyworkflow/#why-workflow","text":"So you want me to take the application feature I have to develop and break it down into separate components? And then enumerate every possible state for each of those components? As well as writing classes or structs that represent each of these states in addition to the collection of objects that each component might pass to another? That sounds like a lot of work just to help the seller order a set of gift cards! Why make something simple so complicated? Why should I use Workflow? I think even those of us who use Workflow all the time end up asking this question. It\u2019s a very reasonable question that we try to answer here. At the heart of the matter, there are two complementary justifications for Workflow, which we will expand on below: Software clarity, correctness, and testability (especially at scale). Encouraging programming paradigms that are best practices for the mobile domain.","title":"Why Workflow?"},{"location":"userguide/whyworkflow/#software-clarity-correctness-and-testability-at-scale","text":"I like to think that most of us have been there: It\u2019s our second straight day staring at the logs from over 200 customers. We know what the problem is : the user gets to screen Y and object foo\u2019s state is bar, but foo should not be bar while in screen Y. Why is foo bar? Unfortunately we don\u2019t have any debug log for foo\u2019s state at the time we start screen Y. We only have one when the user tries to click on button Z, and at that point the state is already bar even though it should only ever be baz or buz. What happened? How did foo get to state bar on screen Y? Looking at the code, foo is shared state with 15 other screens, and it is mutable in all of them. The logic to update foo\u2019s state in screen Y happens in code that is coupled to interaction with button Z, so we cannot simply add a unit test for this, we need a complex UI test to reproduce screen Y. We don\u2019t know how the problem happened and it almost seems like we can\u2019t know how without significant effort! The story above is a little dramatic but I hope the feeling it invokes is familiar. It is a daunting task to reason through application code and build up a sufficient mental model of all possible side effects in any one feature area. Now scale up the numbers a bit \u2014 foo is shared by 150 other screens \u2014 and the once daunting task seems almost impossible. All mobile developers face some form of the above problem, and at Square within our Point of Sale applications we face the scaled up version every day.","title":"Software clarity, correctness, and testability (at scale)"},{"location":"userguide/whyworkflow/#what-do-we-want","text":"Clear boundaries between each feature\u2019s software components that can be instrumented with logs and that have contracts that can be tested. Clear expectations for outcomes within a particular feature\u2019s software component that can be verified for correctness with tests. Immutable State within any particular scope (e.g. Screen Y in the context above) so that the code handling mutations to provide a new State as a result of some event is in a \u201cprotected area\u201d that can be instrumented and tested. A clear separation of the State updates from the presentation of the UI. We want the conditions above because we want: Not to have bugs like the one we started this discussion with. In other words, we want our tests to give us confidence in our application logic. In the inevitable case that we do have a bug, we want to be able to isolate the scenario, reproduce the exact conditions, fix the bug and write a test so that it doesn\u2019t happen again. Workflow facilitates these goals for native mobile applications by providing a pattern (and a supporting application Runtime) similar to React, Elm, or any number of other web application JavaScript frameworks (not to mention forthcoming native mobile frameworks such as Jetpack Compose and SwiftUI). Each logical component area is separated into a Workflow with a finite set of states and the logic to transition between them. Workflows can be composed together for a full feature with each Workflow\u2019s signature specifying a clear contract. The Workflow Runtime\u2019s event loop handles the production of new immutable states for each Workflow so that within the Workflow render logic it is immutable. Workflows can be executed and instrumented in a testable way with extra hooks for simple verification of outcomes in unit tests. On an even simpler level Workflow improves clarity by giving a large team of developers a shared idiom of software components with which to discuss business logic across feature areas, and across mobile platforms (Android, iOS). Further, as the application is composed with multiple Workflows, the framework enables loose coupling between features to focus the impact of code changes.","title":"What do we want?"},{"location":"userguide/whyworkflow/#encouraging-programming-paradigms-that-are-best-practices-for-the-mobile-domain","text":"Mobile applications receive and display a lot of data! Our applications at Square certainly do. As a result of this, there is a growing trend towards reactive programming for mobile applications. In this paradigm, the application logic subscribes to a stream of data which is then pushed to the logic rather than having to be periodically pulled and operated on. This has the profound effect of ensuring that the data shown to the application user is never stale. This style of programming also makes clear that most mobile applications are a series of mapping operations on a stream of data that is eventually mapped into some UI. Another mobile programming best practice (arising out of a long tradition) is to favor declarative programming over imperative programming . With this style choice, the code for a feature declares what should be occurring for a particular state, rather than consisting of a series of statements that are essentially how to make that occur. This is a best practice because when a program\u2019s logic is defined in this way, it is very simple to test (so more likely to be tested!): \u201cFor state Y we expect Rendering Z;\u201d \u201cFrom state Y given input A we expect Rendering Z+.\u201d Possibly more important, it is easier to read, comprehend quickly, and to reason about than a series of complex commands for the computer. Workflows encourage a declarative style because each state of a particular component must be enumerated and then the Rendering (representation that gets passed to the UI framework) is declared for that particular state, alongside a declaration of what children and side effects should be running in that state. The well-tested and reliable Workflow runtime loop itself handles how to start and stop the children and side effects, reducing resource leaks. By requiring these formal definitions of each State, Rendering, and the Actions that will change the current state, Workflow naturally encourages declarative programming. While reactive and declarative programming may be current best practices, there is one Software Engineering principle that has proven over and over again to be the most universal and the most important for systems of scale: Separation of Concerns . Any system of scale requires multiple separate components that can be worked on, tested, improved, and refactored independently by multiple teams of people. A system of multiple components requires communication and any good communication begs explicit structure and contracts. For mobile applications at Square we have settled on the Model-View-ViewModel (MVVM) architecture as the structure for the topical separation of concerns of the layers of the application. MVVM\u2019s unidirectional layered communication is the same as that of Model-View-Presenter (MVP), as opposed to the \u2018circular\u2019 communication of Model-View-Controller (MVC). MVVM\u2019s use of a strict binding between the ViewModel and the View is the same as MVC, as opposed to the imperative interpretation of the Model in MVP. MVVM provides the reasoning and comprehension benefits of unidirectional data flow while also eliminating as much business logic as possible from the view layer and encouraging declarative ViewModels. At Square this works well because we have UI design frameworks that change infrequently (so keeping bindings up-to-date is not much overhead), but business logic that is constantly being updated (so emphasizing low coupling is important). Workflows embrace MVVM because the Rendering produced by a Workflow tree is the ViewModel, which can then be bound to any native mobile UI framework. For feature based separation of concerns we lean on Workflow\u2019s facility for composition at scale via strong parent-child contracts and a hierarchical tree organization. While building a Hello World Workflow may seem like overkill (although it\u2019s really not that bad!), the explicitness and contracts that Workflows require of the developer lay the structure for good communication. The composability of Workflows encourages reuse and encourages separation of concerns into the most appropriate reusable components. There are even more platform-specific best practices that Workflow dovetails well with, such as structured concurrency with Kotlin coroutines, as each Worker or side effect can define a specific coroutine scope for the operations. What about the next 10 years? Jetpack Compose UI and SwiftUI are establishing themselves as the native mobile UI toolkits of the future. They both embrace the same MVVM approach that Workflow does, and encourage thinking about the \u201ccomposability\u201d of separate components of your application. With this resonance, Workflows help you to prepare your mental model to adapt to these new UI toolkits, and shapes our codebase in a way that will ease our adoption of them. To learn more about Compose and Workflow see this post .","title":"Encouraging programming paradigms that are best practices for the mobile domain"},{"location":"userguide/worker-in-code/","text":"Coding a Worker \u00b6 Worker is a protocol (in Swift) and interface (in Kotlin) that defines an asynchronous task that can be performed by a Workflow . Worker s only emit outputs, they do not have a Rendering type. They are similar to child workflows with Void / Unit rendering types. A workflow can ask the infrastructure to await the result of a worker by passing that worker to the RenderContext.runningWorker method within a call to the render method. A workflow can handle outputs from a Worker . Workers provide a declarative window into the imperative world \u00b6 As nice as it is to write declarative code, real apps need to interact with imperative APIs. Workers allow wrapping imperative APIs so that Workflows can interact with them in a declarative fashion. Instead of making imperative \u201cstart this, do that, now stop\u201d calls, a Workflow can say \u201cI declare that this task should now be running\u201d and let the infrastructure worry about ensuring the task is actually started when necessary, continues running if it was already in flight, and torn down when it\u2019s not needed anymore. Workers can perform side effects \u00b6 Unlike workflows\u2019 render method, which can be called many times and must be idempotent, workers are started and then ran until completion (or cancellation) \u2013 independently of how many times the workflow running them is actually rendered. This means that side effects that should be performed only once when a workflow enters a particular state, for example, should be placed into a Worker that the workflow runs while in that state. Workers are cold reactive streams \u00b6 Workers are effectively simple wrappers around asynchronous streams with explicit equivalence. In Swift, workers are backed by ReactiveSwift SignalProducer s . In Kotlin, they\u2019re backed by Kotlin Flow s . They are also easily derived from Reactive Streams Publishers , including RxJava Observable , Flowable , or Single instances. Worker subscriptions are managed automatically \u00b6 While Workers are backed by reactive streams with library-specific subscription APIs, you never actually subscribe directly to a worker yourself. Instead, a Workflow asks the infrastructure to run a worker, and the infrastructure will take care of initializing and tearing down the subscription as appropriate \u2013 much like how child workflows\u2019 lifetimes are automatically managed by the runtime. This makes it impossible to accidentally leak a subscription to a worker. Workers manage their own internal state \u00b6 Unlike Workflows, which are effectively collections of functions defining state transitions, Workers represent long-running tasks. For example, Workers commonly execute network requests. The worker\u2019s stream will open a socket and, either blocking on a background thread or asynchronously, read from that socket and eventually emit data to the workflow that is running it. Workers define their own equivalence \u00b6 Since Workers represent ongoing tasks, the infrastructure needs to be able to tell when two workers represent the same task (so it doesn\u2019t perform the task twice), or when a worker has changed between render passes such that it needs to be torn down and re-started for the new work. For these reasons, any time a workflow requests that a worker be run in sequential render passes, it is asked to compare itself with its last instance and determine if they are equivalent. In Swift, this is determined by the Worker isEquivalent:to: method. Worker s that conform to Equatable will automatically get an isEquivalent:to: method based on the Equatable implementation. In Kotlin, the Worker interface defines the doesSameWorkAs method which is passed the previous worker. Kotlin: Why don\u2019t Workers use equals ? Worker equivalence is a key part of the Worker API. The default implementation of equals , which just compares object identity, is almost always incorrect for workers. Defining a separate method forces implementers to think about how equivalence is defined. Workers are lifecycle-aware \u00b6 Workers are aware of when they\u2019re started (just like Workflows), but they are also aware of when they are torn down. This makes them handy for managing resources as well.","title":"Coding a Worker (stale)"},{"location":"userguide/worker-in-code/#coding-a-worker","text":"Worker is a protocol (in Swift) and interface (in Kotlin) that defines an asynchronous task that can be performed by a Workflow . Worker s only emit outputs, they do not have a Rendering type. They are similar to child workflows with Void / Unit rendering types. A workflow can ask the infrastructure to await the result of a worker by passing that worker to the RenderContext.runningWorker method within a call to the render method. A workflow can handle outputs from a Worker .","title":"Coding a Worker"},{"location":"userguide/worker-in-code/#workers-provide-a-declarative-window-into-the-imperative-world","text":"As nice as it is to write declarative code, real apps need to interact with imperative APIs. Workers allow wrapping imperative APIs so that Workflows can interact with them in a declarative fashion. Instead of making imperative \u201cstart this, do that, now stop\u201d calls, a Workflow can say \u201cI declare that this task should now be running\u201d and let the infrastructure worry about ensuring the task is actually started when necessary, continues running if it was already in flight, and torn down when it\u2019s not needed anymore.","title":"Workers provide a declarative window into the imperative world"},{"location":"userguide/worker-in-code/#workers-can-perform-side-effects","text":"Unlike workflows\u2019 render method, which can be called many times and must be idempotent, workers are started and then ran until completion (or cancellation) \u2013 independently of how many times the workflow running them is actually rendered. This means that side effects that should be performed only once when a workflow enters a particular state, for example, should be placed into a Worker that the workflow runs while in that state.","title":"Workers can perform side effects"},{"location":"userguide/worker-in-code/#workers-are-cold-reactive-streams","text":"Workers are effectively simple wrappers around asynchronous streams with explicit equivalence. In Swift, workers are backed by ReactiveSwift SignalProducer s . In Kotlin, they\u2019re backed by Kotlin Flow s . They are also easily derived from Reactive Streams Publishers , including RxJava Observable , Flowable , or Single instances.","title":"Workers are cold reactive streams"},{"location":"userguide/worker-in-code/#worker-subscriptions-are-managed-automatically","text":"While Workers are backed by reactive streams with library-specific subscription APIs, you never actually subscribe directly to a worker yourself. Instead, a Workflow asks the infrastructure to run a worker, and the infrastructure will take care of initializing and tearing down the subscription as appropriate \u2013 much like how child workflows\u2019 lifetimes are automatically managed by the runtime. This makes it impossible to accidentally leak a subscription to a worker.","title":"Worker subscriptions are managed automatically"},{"location":"userguide/worker-in-code/#workers-manage-their-own-internal-state","text":"Unlike Workflows, which are effectively collections of functions defining state transitions, Workers represent long-running tasks. For example, Workers commonly execute network requests. The worker\u2019s stream will open a socket and, either blocking on a background thread or asynchronously, read from that socket and eventually emit data to the workflow that is running it.","title":"Workers manage their own internal state"},{"location":"userguide/worker-in-code/#workers-define-their-own-equivalence","text":"Since Workers represent ongoing tasks, the infrastructure needs to be able to tell when two workers represent the same task (so it doesn\u2019t perform the task twice), or when a worker has changed between render passes such that it needs to be torn down and re-started for the new work. For these reasons, any time a workflow requests that a worker be run in sequential render passes, it is asked to compare itself with its last instance and determine if they are equivalent. In Swift, this is determined by the Worker isEquivalent:to: method. Worker s that conform to Equatable will automatically get an isEquivalent:to: method based on the Equatable implementation. In Kotlin, the Worker interface defines the doesSameWorkAs method which is passed the previous worker. Kotlin: Why don\u2019t Workers use equals ? Worker equivalence is a key part of the Worker API. The default implementation of equals , which just compares object identity, is almost always incorrect for workers. Defining a separate method forces implementers to think about how equivalence is defined.","title":"Workers define their own equivalence"},{"location":"userguide/worker-in-code/#workers-are-lifecycle-aware","text":"Workers are aware of when they\u2019re started (just like Workflows), but they are also aware of when they are torn down. This makes them handy for managing resources as well.","title":"Workers are lifecycle-aware"},{"location":"userguide/workflow-in-code/","text":"Coding a Workflow \u00b6 In code, Workflow is a Swift protocol or Kotlin interface with State, Rendering and Output parameter types. The Kotlin interface also defines a Props type. In Swift, props are implicit as properties of the struct implementing Workflow. Swift public protocol Workflow : AnyWorkflowConvertible { associatedtype State associatedtype Output = Never associatedtype Rendering func makeInitialState () -> State func workflowDidChange ( from previousWorkflow : Self , state : inout State ) func render ( state : State , context : RenderContext < Self >) -> Rendering } Kotlin abstract class StatefulWorkflow < in PropsT , StateT , out OutputT : Any , out RenderingT > : Workflow < PropsT , OutputT , RenderingT > { abstract fun initialState ( props : PropsT , initialSnapshot : Snapshot? ): StateT open fun onPropsChanged ( old : PropsT , new : PropsT , state : StateT ): StateT = state abstract fun render ( props : PropsT , state : StateT , context : RenderContext < StateT , OutputT > ): RenderingT abstract fun snapshotState ( state : StateT ): Snapshot } Swift: What is AnyWorkflowConvertible ? When a protocol has an associated Self type, Swift requires the use of a type-erasing wrapper to store references to instances of that protocol. AnyWorkflow is such a wrapper for Workflow . AnyWorkflowConvertible is a protocol with a single method that returns an AnyWorkflow . It is useful as a base type because it allows instances of Workflow to be used directly by any code that requires the type-erased AnyWorkflow . Kotlin: StatefulWorkflow vs Workflow It is a common practice in Kotlin to divide types into two parts: an interface for public API, and a class for private implementation. The Workflow library defines a Workflow interface, which should be used as the type of properties and parameters by code that needs to refer to a particular Workflow interface. The Workflow interface contains a single method, which simply returns a StatefulWorkflow \u2013 a Workflow can be described as \u201canything that can be expressed as a StatefulWorkflow .\u201d The library also defines two abstract classes which define the contract for workflows and should be subclassed to implement your workflows: StatefulWorkflow should be subclassed to implement Workflows that have private state . StatelessWorkflow should be subclassed to implement Workflows that don\u2019t have any private state. See Stateless Workflows . Workflows have several responsibilities: Workflows have state \u00b6 Once a Workflow has been started, it always operates in the context of some state. This state is divided into two parts: private state, which only the Workflow implementation itself knows about, which is defined by the State type, and properties (or \u201cprops\u201d), which is passed to the Workflow from its parent (more on hierarchical workflows below). Private state \u00b6 Every Workflow implementation defines a State type to maintain any necessary state while the workflow is running. For example, a tic-tac-toe game might have a state like this: Swift struct State { enum Player { case x case o } enum Space { case unfilled filled ( Player ) } // 3 rows * 3 columns = 9 spaces var spaces : [ Space ] = Array ( repeating : . unfilled , count : 9 ) var currentTurn : Player = . x } Kotlin data class State ( // 3 rows * 3 columns = 9 spaces val spaces : List < Space > = List ( 9 ) { Unfilled }, val currentTurn : Player = X ) { enum class Player { X , O } sealed class Space { object Unfilled : Space () data class Filled ( val player : Player ) : Space () } } When the workflow is first started, it is queried for an initial state value. From that point forward, the workflow may advance to a new state as the result of events occurring from various sources (which will be covered below). Stateless Workflows If a workflow does not have any private state, it is often referred to as a \u201cstateless workflow\u201d. A stateless Workflow is simply a Workflow that has a Void or Unit State type. See more . Public Props \u00b6 Every Workflow implementation also defines data that is passed into it. The Workflow is not able to modify this state itself, but it may change between render passes. This public state is called Props . In Swift, the props are simply defined as properties of the struct implementing Workflow itself. In Kotlin, the Workflow interface defines a separate PropsT type parameter. (This additional type parameter is necessary due to Kotlin\u2019s lack of the Self type that Swift workflow\u2019s workflowDidChange method relies upon.) Swift TK Kotlin data class Props ( val playerXName : String val playerOName : String ) Workflows are advanced by WorkflowAction s \u00b6 Any time something happens that should advance a workflow \u2013 a UI event, a network response, a child\u2019s output event \u2013 actions are used to perform the update. For example, a workflow may respond to UI events by mapping those events into a type conforming to/implementing WorkflowAction . These types implement the logic to advance a workflow by: Advancing to a new state (Optionally) emitting an output event up the tree. WorkflowAction s are typically defined as enums with associated types (Swift) or sealed classes (Kotlin), and can include data from the event \u2013 for example, the ID of the item in the list that was clicked. Side effects such as logging button clicks to an analytics framework are also typically performed in actions. If you\u2019re familiar with React/Redux, WorkflowAction s are essentially reducers. Workflows can emit output events up the hierarchy to their parent \u00b6 When a workflow is advanced by an action, an optional output event can be sent up the workflow hierarchy. This is the opportunity for a workflow to notify its parent that something has happened (and the parent\u2019s opportunity to respond to that event by dispatching its own action, continuing up the tree as long as output events are emitted). Workflows produce an external representation of their state via Rendering \u00b6 Immediately after starting up, or after a state transition occurs, a workflow will have its render method called. This method is responsible for creating and returning a value of type Rendering . You can think of Rendering as the \u201cexternal published state\u201d of the workflow, and the render function as a map of ( Props + State + childrens\u2019 Rendering s) -> Rendering . While a workflow\u2019s internal state may contain more detailed or comprehensive state, the Rendering (external state) is a type that is useful outside of the workflow. Because a workflow\u2019s render method may be called by infrastructure for a variety of reasons, it\u2019s important to not perform side effects when rendering \u2014 render methods must be idempotent. Event-based side effects should use Actions and state-based side effects should use Workers. When building an interactive application, the Rendering type is commonly (but not always) a view model that will drive the UI layer. Workflows can respond to UI events \u00b6 The RenderContext that is passed into render as the last parameter provides some useful tools to assist in creating the Rendering value. If a workflow is producing a view model, it is common to need an event handler to respond to UI events. The RenderContext has API to create an event handler, called a Sink , that when called will advance the workflow by dispatching an action back to the workflow (for more on actions, see above ). Swift func render ( state : State , context : RenderContext < DemoWorkflow >) -> DemoScreen { // Create a sink of our Action type so we can send actions back to the workflow. let sink = context . makeSink ( of : Action . self ) return DemoScreen ( title : \"A nice title\" , onTap : { sink . send ( Action . refreshButtonTapped ) } } Kotlin TK Workflows form a hierarchy (they may have children) \u00b6 As they produce a Rendering value, it is common for workflows to delegate some portion of that work to a child workflow . This is done via the RenderContext that is passed into the render method. In order to delegate to a child, the parent calls renderChild on the context, with the child workflow as the single argument. The infrastructure will spin up the child workflow (including initializing its initial state) if this is the first time this child has been used, or, if the child was also used on the previous render pass, the existing child will be updated. Either way, render will immediately be called on the child (by the Workflow infrastructure), and the resulting child\u2019s Rendering value will be returned to the parent. This allows a parent to return complex Rendering types (such as a view model representing the entire UI state of an application) without needing to model all of that complexity within a single workflow. Workflow Identity The Workflow infrastructure automatically detects the first time and the last subsequent time you\u2019ve asked to render a child workflow, and will automatically initialize the child and clean it up. In both Swift and Kotlin, this is done using the workflow\u2019s concrete type. Both languages use reflection to do this comparison (e.g. in Kotlin, the workflows\u2019 KClass es are compared). It is an error to render workflows of the same type more than once in the same render pass. Since type is used for workflow identity, the child rendering APIs take an optional string key to differentiate between multiple child workflows of the same type. Workflows can subscribe to external event sources \u00b6 If a workflow needs to respond to some external event source (e.g. push notifications), the workflow can ask the context to listen to those events from within the render method. Swift vs Kotlin In the Swift library, there is a special API for subscribing to hot streams ( Signal in ReactiveSwift). The Kotlin library does not have any special API for subscribing to hot streams (channels), though it does have extension methods to convert ReceiveChannel s , and RxJava Flowable s and Observables , to Worker s . The reason for this discrepancy is simply that we don\u2019t have any uses of channels yet in production, and so we\u2019ve decided to keep the API simpler. If we start using channels in the future, it may make sense to make subscribing to them a first-class API like in Swift. Workflows can perform asynchronous tasks (Workers) \u00b6 Workers are very similar in concept to child workflows. Unlike child workflows, however, workers do not have a Rendering type; they only exist to perform a single asynchronous task before sending zero or more output events back up the tree to their parent. For more information about workers, see the Worker section below. Workflows can be saved to and restored from a snapshot (Kotlin only) \u00b6 On every render pass, each workflow is asked to create a \u201csnapshot\u201d of its state \u2013 a lazily-produced serialization of the workflow\u2019s State as a binary blob. These Snapshot s are aggregated into a single Snapshot for the entire workflow tree and emitted along with the root workflow\u2019s Rendering . When the workflow runtime is started, it can be passed an optional Snapshot to restore the tree from. When non-null, the root workflow\u2019s snapshot is extracted and passed to the root workflow\u2019s initialState . The workflow can choose to either ignore the snapshot or use it to restore its State . On the first render pass, if the root workflow renders any children that were also being rendered when the snapshot was taken, those children\u2019s snapshots are also extracted from the aggregate and used to initialize their states. Why don\u2019t Swift Workflows support snapshotting? Snapshotting was built into Kotlin workflows specifically to support Android\u2019s app lifecycle, which requires apps to serialize their current state before being backgrounded so that they can be restored in case the system needs to kill the hosting process. iOS apps don\u2019t have this requirement, so the Swift library doesn\u2019t need to support it.","title":"Coding a Workflow (stale)"},{"location":"userguide/workflow-in-code/#coding-a-workflow","text":"In code, Workflow is a Swift protocol or Kotlin interface with State, Rendering and Output parameter types. The Kotlin interface also defines a Props type. In Swift, props are implicit as properties of the struct implementing Workflow. Swift public protocol Workflow : AnyWorkflowConvertible { associatedtype State associatedtype Output = Never associatedtype Rendering func makeInitialState () -> State func workflowDidChange ( from previousWorkflow : Self , state : inout State ) func render ( state : State , context : RenderContext < Self >) -> Rendering } Kotlin abstract class StatefulWorkflow < in PropsT , StateT , out OutputT : Any , out RenderingT > : Workflow < PropsT , OutputT , RenderingT > { abstract fun initialState ( props : PropsT , initialSnapshot : Snapshot? ): StateT open fun onPropsChanged ( old : PropsT , new : PropsT , state : StateT ): StateT = state abstract fun render ( props : PropsT , state : StateT , context : RenderContext < StateT , OutputT > ): RenderingT abstract fun snapshotState ( state : StateT ): Snapshot } Swift: What is AnyWorkflowConvertible ? When a protocol has an associated Self type, Swift requires the use of a type-erasing wrapper to store references to instances of that protocol. AnyWorkflow is such a wrapper for Workflow . AnyWorkflowConvertible is a protocol with a single method that returns an AnyWorkflow . It is useful as a base type because it allows instances of Workflow to be used directly by any code that requires the type-erased AnyWorkflow . Kotlin: StatefulWorkflow vs Workflow It is a common practice in Kotlin to divide types into two parts: an interface for public API, and a class for private implementation. The Workflow library defines a Workflow interface, which should be used as the type of properties and parameters by code that needs to refer to a particular Workflow interface. The Workflow interface contains a single method, which simply returns a StatefulWorkflow \u2013 a Workflow can be described as \u201canything that can be expressed as a StatefulWorkflow .\u201d The library also defines two abstract classes which define the contract for workflows and should be subclassed to implement your workflows: StatefulWorkflow should be subclassed to implement Workflows that have private state . StatelessWorkflow should be subclassed to implement Workflows that don\u2019t have any private state. See Stateless Workflows . Workflows have several responsibilities:","title":"Coding a Workflow"},{"location":"userguide/workflow-in-code/#workflows-have-state","text":"Once a Workflow has been started, it always operates in the context of some state. This state is divided into two parts: private state, which only the Workflow implementation itself knows about, which is defined by the State type, and properties (or \u201cprops\u201d), which is passed to the Workflow from its parent (more on hierarchical workflows below).","title":"Workflows have state"},{"location":"userguide/workflow-in-code/#private-state","text":"Every Workflow implementation defines a State type to maintain any necessary state while the workflow is running. For example, a tic-tac-toe game might have a state like this: Swift struct State { enum Player { case x case o } enum Space { case unfilled filled ( Player ) } // 3 rows * 3 columns = 9 spaces var spaces : [ Space ] = Array ( repeating : . unfilled , count : 9 ) var currentTurn : Player = . x } Kotlin data class State ( // 3 rows * 3 columns = 9 spaces val spaces : List < Space > = List ( 9 ) { Unfilled }, val currentTurn : Player = X ) { enum class Player { X , O } sealed class Space { object Unfilled : Space () data class Filled ( val player : Player ) : Space () } } When the workflow is first started, it is queried for an initial state value. From that point forward, the workflow may advance to a new state as the result of events occurring from various sources (which will be covered below). Stateless Workflows If a workflow does not have any private state, it is often referred to as a \u201cstateless workflow\u201d. A stateless Workflow is simply a Workflow that has a Void or Unit State type. See more .","title":"Private state"},{"location":"userguide/workflow-in-code/#public-props","text":"Every Workflow implementation also defines data that is passed into it. The Workflow is not able to modify this state itself, but it may change between render passes. This public state is called Props . In Swift, the props are simply defined as properties of the struct implementing Workflow itself. In Kotlin, the Workflow interface defines a separate PropsT type parameter. (This additional type parameter is necessary due to Kotlin\u2019s lack of the Self type that Swift workflow\u2019s workflowDidChange method relies upon.) Swift TK Kotlin data class Props ( val playerXName : String val playerOName : String )","title":"Public Props"},{"location":"userguide/workflow-in-code/#workflows-are-advanced-by-workflowactions","text":"Any time something happens that should advance a workflow \u2013 a UI event, a network response, a child\u2019s output event \u2013 actions are used to perform the update. For example, a workflow may respond to UI events by mapping those events into a type conforming to/implementing WorkflowAction . These types implement the logic to advance a workflow by: Advancing to a new state (Optionally) emitting an output event up the tree. WorkflowAction s are typically defined as enums with associated types (Swift) or sealed classes (Kotlin), and can include data from the event \u2013 for example, the ID of the item in the list that was clicked. Side effects such as logging button clicks to an analytics framework are also typically performed in actions. If you\u2019re familiar with React/Redux, WorkflowAction s are essentially reducers.","title":"Workflows are advanced by WorkflowActions"},{"location":"userguide/workflow-in-code/#workflows-can-emit-output-events-up-the-hierarchy-to-their-parent","text":"When a workflow is advanced by an action, an optional output event can be sent up the workflow hierarchy. This is the opportunity for a workflow to notify its parent that something has happened (and the parent\u2019s opportunity to respond to that event by dispatching its own action, continuing up the tree as long as output events are emitted).","title":"Workflows can emit output events up the hierarchy to their parent"},{"location":"userguide/workflow-in-code/#workflows-produce-an-external-representation-of-their-state-via-rendering","text":"Immediately after starting up, or after a state transition occurs, a workflow will have its render method called. This method is responsible for creating and returning a value of type Rendering . You can think of Rendering as the \u201cexternal published state\u201d of the workflow, and the render function as a map of ( Props + State + childrens\u2019 Rendering s) -> Rendering . While a workflow\u2019s internal state may contain more detailed or comprehensive state, the Rendering (external state) is a type that is useful outside of the workflow. Because a workflow\u2019s render method may be called by infrastructure for a variety of reasons, it\u2019s important to not perform side effects when rendering \u2014 render methods must be idempotent. Event-based side effects should use Actions and state-based side effects should use Workers. When building an interactive application, the Rendering type is commonly (but not always) a view model that will drive the UI layer.","title":"Workflows produce an external representation of their state via Rendering"},{"location":"userguide/workflow-in-code/#workflows-can-respond-to-ui-events","text":"The RenderContext that is passed into render as the last parameter provides some useful tools to assist in creating the Rendering value. If a workflow is producing a view model, it is common to need an event handler to respond to UI events. The RenderContext has API to create an event handler, called a Sink , that when called will advance the workflow by dispatching an action back to the workflow (for more on actions, see above ). Swift func render ( state : State , context : RenderContext < DemoWorkflow >) -> DemoScreen { // Create a sink of our Action type so we can send actions back to the workflow. let sink = context . makeSink ( of : Action . self ) return DemoScreen ( title : \"A nice title\" , onTap : { sink . send ( Action . refreshButtonTapped ) } } Kotlin TK","title":"Workflows can respond to UI events"},{"location":"userguide/workflow-in-code/#workflows-form-a-hierarchy-they-may-have-children","text":"As they produce a Rendering value, it is common for workflows to delegate some portion of that work to a child workflow . This is done via the RenderContext that is passed into the render method. In order to delegate to a child, the parent calls renderChild on the context, with the child workflow as the single argument. The infrastructure will spin up the child workflow (including initializing its initial state) if this is the first time this child has been used, or, if the child was also used on the previous render pass, the existing child will be updated. Either way, render will immediately be called on the child (by the Workflow infrastructure), and the resulting child\u2019s Rendering value will be returned to the parent. This allows a parent to return complex Rendering types (such as a view model representing the entire UI state of an application) without needing to model all of that complexity within a single workflow. Workflow Identity The Workflow infrastructure automatically detects the first time and the last subsequent time you\u2019ve asked to render a child workflow, and will automatically initialize the child and clean it up. In both Swift and Kotlin, this is done using the workflow\u2019s concrete type. Both languages use reflection to do this comparison (e.g. in Kotlin, the workflows\u2019 KClass es are compared). It is an error to render workflows of the same type more than once in the same render pass. Since type is used for workflow identity, the child rendering APIs take an optional string key to differentiate between multiple child workflows of the same type.","title":"Workflows form a hierarchy (they may have children)"},{"location":"userguide/workflow-in-code/#workflows-can-subscribe-to-external-event-sources","text":"If a workflow needs to respond to some external event source (e.g. push notifications), the workflow can ask the context to listen to those events from within the render method. Swift vs Kotlin In the Swift library, there is a special API for subscribing to hot streams ( Signal in ReactiveSwift). The Kotlin library does not have any special API for subscribing to hot streams (channels), though it does have extension methods to convert ReceiveChannel s , and RxJava Flowable s and Observables , to Worker s . The reason for this discrepancy is simply that we don\u2019t have any uses of channels yet in production, and so we\u2019ve decided to keep the API simpler. If we start using channels in the future, it may make sense to make subscribing to them a first-class API like in Swift.","title":"Workflows can subscribe to external event sources"},{"location":"userguide/workflow-in-code/#workflows-can-perform-asynchronous-tasks-workers","text":"Workers are very similar in concept to child workflows. Unlike child workflows, however, workers do not have a Rendering type; they only exist to perform a single asynchronous task before sending zero or more output events back up the tree to their parent. For more information about workers, see the Worker section below.","title":"Workflows can perform asynchronous tasks (Workers)"},{"location":"userguide/workflow-in-code/#workflows-can-be-saved-to-and-restored-from-a-snapshot-kotlin-only","text":"On every render pass, each workflow is asked to create a \u201csnapshot\u201d of its state \u2013 a lazily-produced serialization of the workflow\u2019s State as a binary blob. These Snapshot s are aggregated into a single Snapshot for the entire workflow tree and emitted along with the root workflow\u2019s Rendering . When the workflow runtime is started, it can be passed an optional Snapshot to restore the tree from. When non-null, the root workflow\u2019s snapshot is extracted and passed to the root workflow\u2019s initialState . The workflow can choose to either ignore the snapshot or use it to restore its State . On the first render pass, if the root workflow renders any children that were also being rendered when the snapshot was taken, those children\u2019s snapshots are also extracted from the aggregate and used to initialize their states. Why don\u2019t Swift Workflows support snapshotting? Snapshotting was built into Kotlin workflows specifically to support Android\u2019s app lifecycle, which requires apps to serialize their current state before being backgrounded so that they can be restored in case the system needs to kill the hosting process. iOS apps don\u2019t have this requirement, so the Swift library doesn\u2019t need to support it.","title":"Workflows can be saved to and restored from a snapshot (Kotlin only)"}]} \ No newline at end of file +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Overview \u00b6 Workflow is an application framework that provides architectural primitives. Workflow is: Written in and used for Kotlin and Swift A unidirectional data flow library that uses immutable data within each Workflow. Data flows in a single direction from source to UI, and events in a single direction from the UI to the business logic. A library that supports writing business logic and complex UI navigation logic as state machines, thereby enabling confident reasoning about state and validation of correctness. Optimized for composability and scalability of features and screens. Corresponding UI frameworks that bind Rendering data classes for \u201cviews\u201d (including event callbacks) to Mobile UI frameworks for Android and iOS. A corresponding testing framework that facilitates simple-to-write unit tests for all application business logic and helps ensure correctness. Using Workflows in your project \u00b6 Swift \u00b6 See the square/workflow-swift repository. Kotlin \u00b6 See the square/workflow-kotlin repository. Resources \u00b6 Wondering why to use Workflow? See \u201cWhy Workflow\u201d There is a Glossary of Terms We have a User Guide describing core concepts. For Kotlin (and Android), there is a codelab style tutorial in the repo. For Swift (and iOS), there is also a Getting Started tutorial in the repo. There are also a number of Kotlin samples and Swift samples . Support & Contact \u00b6 Workflow discussion happens in the Workflow Community slack. Use this open invitation . Workflow maintainers also hang out in the #squarelibraries channel on the Kotlin Slack . Releasing and Deploying \u00b6 See RELEASING.md . License \u00b6 Copyright 2019 Square Inc. Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.","title":"Overview"},{"location":"#overview","text":"Workflow is an application framework that provides architectural primitives. Workflow is: Written in and used for Kotlin and Swift A unidirectional data flow library that uses immutable data within each Workflow. Data flows in a single direction from source to UI, and events in a single direction from the UI to the business logic. A library that supports writing business logic and complex UI navigation logic as state machines, thereby enabling confident reasoning about state and validation of correctness. Optimized for composability and scalability of features and screens. Corresponding UI frameworks that bind Rendering data classes for \u201cviews\u201d (including event callbacks) to Mobile UI frameworks for Android and iOS. A corresponding testing framework that facilitates simple-to-write unit tests for all application business logic and helps ensure correctness.","title":"Overview"},{"location":"#using-workflows-in-your-project","text":"","title":"Using Workflows in your project"},{"location":"#swift","text":"See the square/workflow-swift repository.","title":"Swift"},{"location":"#kotlin","text":"See the square/workflow-kotlin repository.","title":"Kotlin"},{"location":"#resources","text":"Wondering why to use Workflow? See \u201cWhy Workflow\u201d There is a Glossary of Terms We have a User Guide describing core concepts. For Kotlin (and Android), there is a codelab style tutorial in the repo. For Swift (and iOS), there is also a Getting Started tutorial in the repo. There are also a number of Kotlin samples and Swift samples .","title":"Resources"},{"location":"#support-contact","text":"Workflow discussion happens in the Workflow Community slack. Use this open invitation . Workflow maintainers also hang out in the #squarelibraries channel on the Kotlin Slack .","title":"Support & Contact"},{"location":"#releasing-and-deploying","text":"See RELEASING.md .","title":"Releasing and Deploying"},{"location":"#license","text":"Copyright 2019 Square Inc. Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.","title":"License"},{"location":"CHANGELOG/","text":"Changelog \u00b6 You can find the changelogs for the library in the respective language repositories: Kotlin Swift","title":"Changelog"},{"location":"CHANGELOG/#changelog","text":"You can find the changelogs for the library in the respective language repositories: Kotlin Swift","title":"Changelog"},{"location":"CODE_OF_CONDUCT/","text":"Open Source Code of Conduct \u00b6 At Square, we are committed to contributing to the open source community and simplifying the process of releasing and managing open source software. We\u2019ve seen incredible support and enthusiasm from thousands of people who have already contributed to our projects\u200a\u2014\u200aand we want to ensure ourcommunity continues to be truly open for everyone. This code of conduct outlines our expectations for participants, as well as steps to reporting unacceptable behavior. We are committed to providing a welcoming and inspiring community for all and expect our code of conduct to be honored. Square\u2019s open source community strives to: Be open : We invite anyone to participate in any aspect of our projects. Our community is open, and any responsibility can be carried by a contributor who demonstrates the required capacity and competence. Be considerate : People use our work, and we depend on the work of others. Consider users and colleagues before taking action. For example, changes to code, infrastructure, policy, and documentation may negatively impact others. Be respectful : We expect people to work together to resolve conflict, assume good intentions, and act with empathy. Do not turn disagreements into personal attacks. Be collaborative : Collaboration reduces redundancy and improves the quality of our work. We strive for transparency within our open source community, and we work closely with upstream developers and others in the free software community to coordinate our efforts. Be pragmatic : Questions are encouraged and should be asked early in the process to avoid problems later. Be thoughtful and considerate when seeking out the appropriate forum for your questions. Those who are asked should be responsive and helpful. Step down considerately : Members of every project come and go. When somebody leaves or disengages from the project, they should make it known and take the proper steps to ensure that others can pick up where they left off. This code is not exhaustive or complete. It serves to distill our common understanding of a collaborative, shared environment, and goals. We expect it to be followed in spirit as much as in the letter. Diversity Statement \u00b6 We encourage everyone to participate and are committed to building a community for all. Although we may not be able to satisfy everyone, we all agree that everyone is equal. Whenever a participant has made a mistake, we expect them to take responsibility for it. If someone has been harmed or offended, it is our responsibility to listen carefully and respectfully, and do our best to right the wrong. Although this list cannot be exhaustive, we explicitly honor diversity in age, culture, ethnicity, gender identity or expression, language, national origin, political beliefs, profession, race, religion, sexual orientation, socioeconomic status, and technical ability. We will not tolerate discrimination based on any of the protected characteristics above, including participants with disabilities. Reporting Issues \u00b6 If you experience or witness unacceptable behavior\u200a\u2014\u200aor have any other concerns\u200a\u2014\u200aplease report it by emailing codeofconduct@squareup.com . For more details, please see our Reporting Guidelines below. Thanks \u00b6 Some of the ideas and wording for the statements and guidelines above were based on work by the Twitter , Ubuntu , GDC , and Django communities. We are thankful for their work. Reporting Guide \u00b6 If you experience or witness unacceptable behavior\u200a\u2014\u200aor have any other concerns\u200a\u2014\u200aplease report it by emailing codeofconduct@squareup.com . All reports will be handled with discretion. In your report please include: Your contact information. Names (real, nicknames, or pseudonyms) of any individuals involved. If there are additional witnesses, please include them as well. Your account of what occurred, and if you believe the incident is ongoing. If there is a publicly available record (e.g. a mailing list archive or a public IRC logger), please include a link. Any additional information that may be helpful. After filing a report, a representative from the Square Code of Conduct committee will contact you personally. The committee will then review the incident, follow up with any additional questions, and make a decision as to how to respond. Anyone asked to stop unacceptable behavior is expected to comply immediately. If an individual engages in unacceptable behavior, the Square Code of Conduct committee may take any action they deem appropriate, up to and including a permanent ban from all of Square spaces without warning.","title":"Code of Conduct"},{"location":"CODE_OF_CONDUCT/#open-source-code-of-conduct","text":"At Square, we are committed to contributing to the open source community and simplifying the process of releasing and managing open source software. We\u2019ve seen incredible support and enthusiasm from thousands of people who have already contributed to our projects\u200a\u2014\u200aand we want to ensure ourcommunity continues to be truly open for everyone. This code of conduct outlines our expectations for participants, as well as steps to reporting unacceptable behavior. We are committed to providing a welcoming and inspiring community for all and expect our code of conduct to be honored. Square\u2019s open source community strives to: Be open : We invite anyone to participate in any aspect of our projects. Our community is open, and any responsibility can be carried by a contributor who demonstrates the required capacity and competence. Be considerate : People use our work, and we depend on the work of others. Consider users and colleagues before taking action. For example, changes to code, infrastructure, policy, and documentation may negatively impact others. Be respectful : We expect people to work together to resolve conflict, assume good intentions, and act with empathy. Do not turn disagreements into personal attacks. Be collaborative : Collaboration reduces redundancy and improves the quality of our work. We strive for transparency within our open source community, and we work closely with upstream developers and others in the free software community to coordinate our efforts. Be pragmatic : Questions are encouraged and should be asked early in the process to avoid problems later. Be thoughtful and considerate when seeking out the appropriate forum for your questions. Those who are asked should be responsive and helpful. Step down considerately : Members of every project come and go. When somebody leaves or disengages from the project, they should make it known and take the proper steps to ensure that others can pick up where they left off. This code is not exhaustive or complete. It serves to distill our common understanding of a collaborative, shared environment, and goals. We expect it to be followed in spirit as much as in the letter.","title":"Open Source Code of Conduct"},{"location":"CODE_OF_CONDUCT/#diversity-statement","text":"We encourage everyone to participate and are committed to building a community for all. Although we may not be able to satisfy everyone, we all agree that everyone is equal. Whenever a participant has made a mistake, we expect them to take responsibility for it. If someone has been harmed or offended, it is our responsibility to listen carefully and respectfully, and do our best to right the wrong. Although this list cannot be exhaustive, we explicitly honor diversity in age, culture, ethnicity, gender identity or expression, language, national origin, political beliefs, profession, race, religion, sexual orientation, socioeconomic status, and technical ability. We will not tolerate discrimination based on any of the protected characteristics above, including participants with disabilities.","title":"Diversity Statement"},{"location":"CODE_OF_CONDUCT/#reporting-issues","text":"If you experience or witness unacceptable behavior\u200a\u2014\u200aor have any other concerns\u200a\u2014\u200aplease report it by emailing codeofconduct@squareup.com . For more details, please see our Reporting Guidelines below.","title":"Reporting Issues"},{"location":"CODE_OF_CONDUCT/#thanks","text":"Some of the ideas and wording for the statements and guidelines above were based on work by the Twitter , Ubuntu , GDC , and Django communities. We are thankful for their work.","title":"Thanks"},{"location":"CODE_OF_CONDUCT/#reporting-guide","text":"If you experience or witness unacceptable behavior\u200a\u2014\u200aor have any other concerns\u200a\u2014\u200aplease report it by emailing codeofconduct@squareup.com . All reports will be handled with discretion. In your report please include: Your contact information. Names (real, nicknames, or pseudonyms) of any individuals involved. If there are additional witnesses, please include them as well. Your account of what occurred, and if you believe the incident is ongoing. If there is a publicly available record (e.g. a mailing list archive or a public IRC logger), please include a link. Any additional information that may be helpful. After filing a report, a representative from the Square Code of Conduct committee will contact you personally. The committee will then review the incident, follow up with any additional questions, and make a decision as to how to respond. Anyone asked to stop unacceptable behavior is expected to comply immediately. If an individual engages in unacceptable behavior, the Square Code of Conduct committee may take any action they deem appropriate, up to and including a permanent ban from all of Square spaces without warning.","title":"Reporting Guide"},{"location":"CONTRIBUTING/","text":"Contributing \u00b6 If you would like to contribute code to Workflow you can do so through GitHub by forking the repository and sending a pull request. When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible. Please also make sure your code compiles. Before your code can be accepted into the project you must also sign the Individual Contributor License Agreement (CLA) .","title":"Contributing"},{"location":"CONTRIBUTING/#contributing","text":"If you would like to contribute code to Workflow you can do so through GitHub by forking the repository and sending a pull request. When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible. Please also make sure your code compiles. Before your code can be accepted into the project you must also sign the Individual Contributor License Agreement (CLA) .","title":"Contributing"},{"location":"RELEASING/","text":"Releasing workflow \u00b6 Deploying the documentation website \u00b6 Official Workflow documentation lives at https://square.github.io/workflow . The website content consists of three parts: Markdown documentation: Lives in the docs/ folder, and consists of a set of hand-written Markdown files that document high-level concepts. The static site generator mkdocs (with Material theming) is used to convert the Markdown to static, styled HTML. Kotlin API reference: Kdoc embedded in Kotlin source files is converted to GitHub-flavored Markdown by Dokka and then included in the statically-generated website. Swift API reference: Markup comments from Swift files are converted Markdown by Sourcedocs and then included in the statically-generated website. Note: The documentation site is automatically built and deployed whenever a version tag is pushed. You only need these steps if you want to work on the site locally. Setting up the site generators \u00b6 If you\u2019ve already done this, you can skip to Deploying the website to production below. Kotlin: Dokka \u00b6 Dokka runs as a Gradle plugin, so you need to be able to build the Kotlin source with Gradle, but that\u2019s it. To generate the docs manually, run: cd kotlin ./gradlew dokka Swift: Sourcedocs \u00b6 Sourcedocs generates a Markdown site from Swift files. You need Ruby, rubygems, bundler (2.x), Xcode 10.2+, CocoaPods, and of course Sourcedocs itself, to run it. Assuming you\u2019ve already got Xcode, Ruby, and rubygems set up, install the rest of the dependencies: gem install bundler cocoapods brew install sourcedocs You will also need a checkout of the Swift repo: git clone https://github.com/square/workflow-swift.git cd workflow-swift Then generate an Xcode project before running Sourcedocs: cd Samples/SampleApp/ bundle exec pod install # If this is your first time running CocoaPods, that will fail and you'll need to run this instead: #bundle exec pod install --repo-update You can manually generate the docs to verify everything is working correctly by running: #cd Samples/SampleApp/ sourcedocs generate -- -scheme Workflow -workspace SampleApp.xcworkspace sourcedocs generate -- -scheme WorkflowUI -workspace SampleApp.xcworkspace sourcedocs generate -- -scheme WorkflowTesting -workspace SampleApp.xcworkspace Note that currently sourcedocs only supports Xcode 10, if you run it with Xcode 11 you might see an error about Catalyst and only empty READMEs will get generated. mkdocs \u00b6 Mkdocs is written in Python, so you\u2019ll need Python 3 and pip in order to run it. Assuming those are set up, run: pip install -r requirements.txt Generate the site manually with: mkdocs build While you\u2019re working on the documentation files, you can run the site locally with: mkdocs serve Deploying the website to production \u00b6 Note: The documentation site is automatically built and deployed by a Github Workflow whenever a version tag is pushed. You only need these steps if you want to publish the site manually. Before deploying the website for real, you need to export our Google Analytics key in an environment variable so that it will get added to the HTML. Get the key from one of the project maintainers, then add the following to your .bashrc and re-source it: export WORKFLOW_GOOGLE_ANALYTICS_KEY = UA-__________-1 Now you\u2019re ready to publish the site! Just choose a tag or SHA to deploy from, and run: ./deploy_website.sh TAG_OR_SHA # For example: #./deploy_website.sh v0.18.0 This will clone the repo to a temporary directory, checkout the right SHA, build Kotlin and Swift API docs, generate HTML, and push the newly-generated content to the gh-pages branch on GitHub. Validating Markdown \u00b6 Since all of our high-level documentation is written in Markdown, we run a linter in CI to ensure we use consistent formatting. Lint errors will fail your PR builds, so to run locally, install markdownlint : gem install mdl Run the linter using the lint_docs.sh : ./lint_docs.sh Rules can be configured by editing .markdownlint.rb . Kotlin Notes \u00b6 Development \u00b6 To build and install the current version to your local Maven repository ( ~/.m2 ), run: ./gradlew clean installArchives Deploying \u00b6 Configuration \u00b6 In order to deploy artifacts to a Maven repository, you\u2019ll need to set 4 properties in your private Gradle properties file ( ~/.gradle/gradle.properties ): RELEASE_REPOSITORY_URL= SNAPSHOT_REPOSITORY_URL= SONATYPE_NEXUS_PASSWORD= Snapshot Releases \u00b6 Double-check that gradle.properties correctly contains the -SNAPSHOT suffix, then upload snapshot artifacts to Sonatype just like you would for a production release: ./gradlew clean build && ./gradlew uploadArchives --no-parallel --no-daemon You can verify the artifacts are available by visiting https://oss.sonatype.org/content/repositories/snapshots/com/squareup/workflow/ .","title":"Releasing workflow"},{"location":"RELEASING/#releasing-workflow","text":"","title":"Releasing workflow"},{"location":"RELEASING/#deploying-the-documentation-website","text":"Official Workflow documentation lives at https://square.github.io/workflow . The website content consists of three parts: Markdown documentation: Lives in the docs/ folder, and consists of a set of hand-written Markdown files that document high-level concepts. The static site generator mkdocs (with Material theming) is used to convert the Markdown to static, styled HTML. Kotlin API reference: Kdoc embedded in Kotlin source files is converted to GitHub-flavored Markdown by Dokka and then included in the statically-generated website. Swift API reference: Markup comments from Swift files are converted Markdown by Sourcedocs and then included in the statically-generated website. Note: The documentation site is automatically built and deployed whenever a version tag is pushed. You only need these steps if you want to work on the site locally.","title":"Deploying the documentation website"},{"location":"RELEASING/#setting-up-the-site-generators","text":"If you\u2019ve already done this, you can skip to Deploying the website to production below.","title":"Setting up the site generators"},{"location":"RELEASING/#kotlin-dokka","text":"Dokka runs as a Gradle plugin, so you need to be able to build the Kotlin source with Gradle, but that\u2019s it. To generate the docs manually, run: cd kotlin ./gradlew dokka","title":"Kotlin: Dokka"},{"location":"RELEASING/#swift-sourcedocs","text":"Sourcedocs generates a Markdown site from Swift files. You need Ruby, rubygems, bundler (2.x), Xcode 10.2+, CocoaPods, and of course Sourcedocs itself, to run it. Assuming you\u2019ve already got Xcode, Ruby, and rubygems set up, install the rest of the dependencies: gem install bundler cocoapods brew install sourcedocs You will also need a checkout of the Swift repo: git clone https://github.com/square/workflow-swift.git cd workflow-swift Then generate an Xcode project before running Sourcedocs: cd Samples/SampleApp/ bundle exec pod install # If this is your first time running CocoaPods, that will fail and you'll need to run this instead: #bundle exec pod install --repo-update You can manually generate the docs to verify everything is working correctly by running: #cd Samples/SampleApp/ sourcedocs generate -- -scheme Workflow -workspace SampleApp.xcworkspace sourcedocs generate -- -scheme WorkflowUI -workspace SampleApp.xcworkspace sourcedocs generate -- -scheme WorkflowTesting -workspace SampleApp.xcworkspace Note that currently sourcedocs only supports Xcode 10, if you run it with Xcode 11 you might see an error about Catalyst and only empty READMEs will get generated.","title":"Swift: Sourcedocs"},{"location":"RELEASING/#mkdocs","text":"Mkdocs is written in Python, so you\u2019ll need Python 3 and pip in order to run it. Assuming those are set up, run: pip install -r requirements.txt Generate the site manually with: mkdocs build While you\u2019re working on the documentation files, you can run the site locally with: mkdocs serve","title":"mkdocs"},{"location":"RELEASING/#deploying-the-website-to-production","text":"Note: The documentation site is automatically built and deployed by a Github Workflow whenever a version tag is pushed. You only need these steps if you want to publish the site manually. Before deploying the website for real, you need to export our Google Analytics key in an environment variable so that it will get added to the HTML. Get the key from one of the project maintainers, then add the following to your .bashrc and re-source it: export WORKFLOW_GOOGLE_ANALYTICS_KEY = UA-__________-1 Now you\u2019re ready to publish the site! Just choose a tag or SHA to deploy from, and run: ./deploy_website.sh TAG_OR_SHA # For example: #./deploy_website.sh v0.18.0 This will clone the repo to a temporary directory, checkout the right SHA, build Kotlin and Swift API docs, generate HTML, and push the newly-generated content to the gh-pages branch on GitHub.","title":"Deploying the website to production"},{"location":"RELEASING/#validating-markdown","text":"Since all of our high-level documentation is written in Markdown, we run a linter in CI to ensure we use consistent formatting. Lint errors will fail your PR builds, so to run locally, install markdownlint : gem install mdl Run the linter using the lint_docs.sh : ./lint_docs.sh Rules can be configured by editing .markdownlint.rb .","title":"Validating Markdown"},{"location":"RELEASING/#kotlin-notes","text":"","title":"Kotlin Notes"},{"location":"RELEASING/#development","text":"To build and install the current version to your local Maven repository ( ~/.m2 ), run: ./gradlew clean installArchives","title":"Development"},{"location":"RELEASING/#deploying","text":"","title":"Deploying"},{"location":"RELEASING/#configuration","text":"In order to deploy artifacts to a Maven repository, you\u2019ll need to set 4 properties in your private Gradle properties file ( ~/.gradle/gradle.properties ): RELEASE_REPOSITORY_URL= SNAPSHOT_REPOSITORY_URL= SONATYPE_NEXUS_PASSWORD=","title":"Configuration"},{"location":"RELEASING/#snapshot-releases","text":"Double-check that gradle.properties correctly contains the -SNAPSHOT suffix, then upload snapshot artifacts to Sonatype just like you would for a production release: ./gradlew clean build && ./gradlew uploadArchives --no-parallel --no-daemon You can verify the artifacts are available by visiting https://oss.sonatype.org/content/repositories/snapshots/com/squareup/workflow/ .","title":"Snapshot Releases"},{"location":"code-recipes/","text":"Code Receipes \u00b6 Coming soon!","title":"Code Receipes"},{"location":"code-recipes/#code-receipes","text":"Coming soon!","title":"Code Receipes"},{"location":"development-process/","text":"Development Process \u00b6 Coming soon!","title":"Development Process"},{"location":"development-process/#development-process","text":"Coming soon!","title":"Development Process"},{"location":"faq/","text":"Frequently Asked Questions \u00b6 Why do we need another architecture? \u00b6 We ask this question too! So we wrote a longer answer for it: \u201cWhy Workflow?\u201d . How do I get involved and/or contribute? \u00b6 Workflow is open source! See our CONTRIBUTING doc to get started. Stay tuned! We\u2019re considering hosting a public Slack channel for open source contributors. Isn\u2019t this basically React/Elm? \u00b6 React and the Elm architecture were both strong influences for this library. However both those libraries are written for JavaScript. Workflows are written in and for both Kotlin and Swift, making use of features of those languages, and with usability from those languages as a major design goal. There are some architectural differences which we can see briefly in the following table: React Elm Workflow Modularity Component Module s for code organization, but not \u2018composable\u2019 in the same way. A Workflow is analogous to React\u2019s Component State Each Component has a state property that is read directly and updated via a setState method. State is called Model in Elm. Workflow s have an associated state type. The state can only be updated when the props change, or with a WorkflowAction . Views Component s have a render method that returns a tree of elements. Elm applications have a view function that returns a tree of elements. Since workflows are not tied to any particular UI view layer, they can have an arbitrary rendering type. The render() method returns this type. Injected Dependencies React allows parent components to pass \u201cprops\u201d down to their children. N/A In Swift, Workflow s are often structs that need to be initialized with their dependencies and configuration data from their parent. In Kotlin, they have a separate type parameter ( PropsT ) that is always passed down from the parent. Workflow instances can also inject dependencies, and play nicely with dependency injection frameworks. Composability Component s are composed of other Component s. N/A Workflow s can have children; they control their lifecycle and can choose to incorporate child renderings into their own. Event Handling DOM event listeners are hooked up to functions on the Component . The update function takes a Msg to modify state based on events. action can be sent to the Sink to update State . How is this different than MvRx? \u00b6 Besides being very Android and Rx specific, MvRx solves view modeling problems only per screen. Workflow was mainly inspired by the need to manage and compose navigation in apps with dozens or hundreds of screens. This seems clever. Can I stick with a traditional development approach? \u00b6 Of course! Workflow was designed to make complex application architecture predictable and safe for large development teams. We\u2019re confident that it brings benefits even to smaller projects, but there is never only one right way to build software. We recommend to follow good practices and use an architecture that makes sense for your project .","title":"FAQ"},{"location":"faq/#frequently-asked-questions","text":"","title":"Frequently Asked Questions"},{"location":"faq/#why-do-we-need-another-architecture","text":"We ask this question too! So we wrote a longer answer for it: \u201cWhy Workflow?\u201d .","title":"Why do we need another architecture?"},{"location":"faq/#how-do-i-get-involved-andor-contribute","text":"Workflow is open source! See our CONTRIBUTING doc to get started. Stay tuned! We\u2019re considering hosting a public Slack channel for open source contributors.","title":"How do I get involved and/or contribute?"},{"location":"faq/#isnt-this-basically-reactelm","text":"React and the Elm architecture were both strong influences for this library. However both those libraries are written for JavaScript. Workflows are written in and for both Kotlin and Swift, making use of features of those languages, and with usability from those languages as a major design goal. There are some architectural differences which we can see briefly in the following table: React Elm Workflow Modularity Component Module s for code organization, but not \u2018composable\u2019 in the same way. A Workflow is analogous to React\u2019s Component State Each Component has a state property that is read directly and updated via a setState method. State is called Model in Elm. Workflow s have an associated state type. The state can only be updated when the props change, or with a WorkflowAction . Views Component s have a render method that returns a tree of elements. Elm applications have a view function that returns a tree of elements. Since workflows are not tied to any particular UI view layer, they can have an arbitrary rendering type. The render() method returns this type. Injected Dependencies React allows parent components to pass \u201cprops\u201d down to their children. N/A In Swift, Workflow s are often structs that need to be initialized with their dependencies and configuration data from their parent. In Kotlin, they have a separate type parameter ( PropsT ) that is always passed down from the parent. Workflow instances can also inject dependencies, and play nicely with dependency injection frameworks. Composability Component s are composed of other Component s. N/A Workflow s can have children; they control their lifecycle and can choose to incorporate child renderings into their own. Event Handling DOM event listeners are hooked up to functions on the Component . The update function takes a Msg to modify state based on events. action can be sent to the Sink to update State .","title":"Isn't this basically React/Elm?"},{"location":"faq/#how-is-this-different-than-mvrx","text":"Besides being very Android and Rx specific, MvRx solves view modeling problems only per screen. Workflow was mainly inspired by the need to manage and compose navigation in apps with dozens or hundreds of screens.","title":"How is this different than MvRx?"},{"location":"faq/#this-seems-clever-can-i-stick-with-a-traditional-development-approach","text":"Of course! Workflow was designed to make complex application architecture predictable and safe for large development teams. We\u2019re confident that it brings benefits even to smaller projects, but there is never only one right way to build software. We recommend to follow good practices and use an architecture that makes sense for your project .","title":"This seems clever. Can I stick with a traditional development approach?"},{"location":"glossary/","text":"Glossary of Terms \u00b6 Reactive Programming \u00b6 A style of programming where data or events are pushed to the logic processing them rather than having the logic pull the data and events from a source. A representation of program logic as a series of operations on a stream of data that is performed while a subscription to that stream is active. Unidirectional Data Flow \u00b6 Data travels a single path from business logic to UI, and travels the entirety of that path in a single direction. Events travel a single path from UI to business logic and they travel the entirety of that path in a single direction. There are thus two sets of directed edges in the graph that are handled separately and neither set has any cycles or back edges on its own. Declarative Programming \u00b6 A declarative program declares the state it wants the system to be in rather than how that is accomplished. Imperative Programming \u00b6 An imperative program\u2019s code is a series of statements that directly change a program\u2019s state as a result of certain events. State Machine \u00b6 An abstraction that models a program\u2019s logic as a graph of a set of states and the transitions between them (edges). See: en.wikipedia.org/wiki/Finite-state_machine Idempotent \u00b6 A function whose side effects won\u2019t be repeated with multiple invocations, the result is purely a function of the input. In other words, if called multiple times with the same input, the result is the same. For Workflows, the render() function must be idempotent, as the runtime offers no guarantees for how many times it may be called. Workflow Runtime \u00b6 An event loop that executes a Workflow Tree. On each pass: A Rendering is assembled by calling render() on each Node of the Workflow Tree with each parent Workflow given the option to incorporate the Renderings of its children into its own. The event loop waits for an Action to be sent to the Sink. This Action provides a (possibly updated) State for the Workflow that created it and possibly an Output. Any Output emitted is processed in turn by an Action defined by the updated Workflow\u2019s parent again possibly updating its State and emitting an Output cascading up the hierarchy. A new render() pass is made against the entire Workflow Tree with the updated States. We use the term Workflow Runtime to refer to the core code in the framework that executes this event loop, responding to Actions and invoking render() . Workflow (Instance) \u00b6 An object that defines the transitions and side effects of a state machine as, effectively, two functions: Providing the first state: (Props) -> State Providing a rendering: (Props and State) -> (Rendering and Side Effect Invocations and Child Workflow Invocations) The Child Workflow Invocations declared by the render function result in calls to the children\u2019s render() functions in turn, allowing the parent render function to choose to incorporate child Rendering values into its own. A Workflow is not itself a state machine, and ideally has no state of its own. It is rather a schema that identifies a particular type of state machine that can be started in initialState() by the Workflow Runtime, and advanced by repeated invocations of render() . Note: there is significant fuzziness in using the term \u2018Workflow\u2019, as it can mean at times the class/struct that declares the Workflow behavior as well as the object representing the running Workflow Node. To understand the Runtime behavior, grasping this distinction is necessary and valuable. When using a Workflow, the formal distinction is less valuable than the mental model of how a Workflow will be run. Workflow (Node) \u00b6 An active state machine whose behavior is defined by a Workflow Instance. This is the object that is held by the Workflow Runtime and whose state is updated (or \u201cdriven\u201d) according to the behavior declared in the Workflow Instance. In Kotlin and Swift a Workflow Node is implemented with the private WorkflowNode class/struct. Workflow Lifecycle \u00b6 Every Workflow or Side Effect Node has a lifecycle that is determined by its parent. In the case of the root Workflow, this lifecycle is determined by how long the host of the root chooses to use the stream of Renderings from the root Workflow. In the case of a non-root Workflow or Side Effect \u2014 that is, in the case of a Child \u2014 its lifecycle is determined as follows: Start: the first time its parent invokes the Child in the parent\u2019s own render() pass. End: the first subsequent render() pass that does not invoke the Child. Note that in between Start and End, the Workflow, or Side Effect is not \u201cre-invoked\u201d in the sense of starting again with each render() pass, but rather the originally invoked instance continues to run until a render() call is made without invoking it. Workflow Tree \u00b6 The tree of Workflow Nodes sharing a root. Workflow Nodes can have children and form a hierarchy. Workflow Root \u00b6 The root of a Workflow Tree. This is owned by a host which starts the Workflow Runtime with a particular Workflow instance. RenderContext \u00b6 The object which provides access to the Workflow Runtime from a Workflow render method. Provides three services: a Sink for accepting WorkflowActions recursively rendering Workflow children executing Side Effects Render Pass \u00b6 The portion of the Workflow Runtime event loop which traverses the Workflow tree, calling render() on each Workflow Node. When the RenderContext Sink receives an Action an Action Cascade occurs and at the completion of the Action Cascade the Render Pass occurs. Output Event \u00b6 When a Child Workflow emits an Output value, this is an Output Event. Handlers are registered when a Child Workflow is invoked to transform the child\u2019s Output values to Actions, which can advance the state of the parent. UI Event \u00b6 Any occurrence in the UI of a program \u2014 e.g. click, drag, keypress \u2014 the listener for which has been connected to a callback in the Rendering of a Workflow. UI Event callbacks typically add Actions to the Sink, to advance the state of the Workflow. Action \u00b6 A type associated with a particular Workflow (Instance) that is responsible for transforming a given State into a new State and optionally emitting an Output. Actions are sent to the Sink to be processed by the Workflow Runtime. Action Cascade \u00b6 When an event occurs and the handler provides an Action, this Action may possibly produce an Output for the parent Workflow which in turn has its own handler provide an Action that may produce an Output and onwards up the Workflow Tree. This is an Action Cascade. Sink \u00b6 The handle provided by the RenderContext to send Actions to the Workflow Runtime. These Actions are applied by the Workflow Runtime to advance a Workflow\u2019s State, and optionally produce an Output to be processed by the handler its parent registered. Props \u00b6 The set of input properties for a particular Workflow. This is the public state which is provided to a child Workflow by its parent, or to the root Workflow by its host. For Swift: The set of properties on the struct implementing the Workflow. For Kotlin: Parameter type PropsT in the Workflow signature. In Kotlin there is a formal distinction between Props and other dependencies, typically provided as constructor parameters. State \u00b6 The type of the internal state of a Workflow implementation. \u201cImmutable\u201d State \u00b6 The State object itself is immutable, in other words, its property values cannot be changed. What this means for Workflows is that the Workflow Runtime holds a canonical instance of the internal State of each Workflow. A Workflow\u2019s state is \u201cadvanced\u201d when that canonical instance is atomically replaced by one returned when an Action is invoked. State can only be mutated through WorkflowAction which will trigger a re-render. There are a number of benefits to keeping State immutable in this way: Reasoning about and debugging the Workflow is easier because, for any given State, there is a deterministic Rendering and the State cannot change except as a new parameter value to the render() method. This assists in making render() idempotent as the State will not be modified in the course of the execution of that function. Note that this immutability can be enforced only by convention. It is possible to cheat, but that is strongly discouraged. Rendering \u00b6 The externally available public representation of the state of a Workflow. It may include event handling functions. It is given a concrete type in the Workflow signature. Note that this \u201cRendering\u201d does not have to represent the UI of a program. The \u201cRendering\u201d is simply the published state of the Workflow, and could simply be data. Often that data is used to render UI, but it can be used in other ways \u2014 for example, as the implementation of a service API. Output \u00b6 The type of the object that can optionally be delivered to the Workflow\u2019s parent or the host of the root Workflow by an Action. Child Workflow \u00b6 A Workflow which has a parent. A parent may compose a child Workflow\u2019s Rendering into its own. Side Effect \u00b6 From render() , runningSideEffect() can be called with a given key and a function that will be called once by the Workflow Runtime. For Swift, a Lifetime object is also passed to runningSideEffect() which has an onEnded() closure that can be used for cleanup. For Kotlin, a coroutine scope is used to execute the function so it can be cancelled() at cleanup time. Given that any property (including the Sink) could be captured by the closure of the Side Effect this is the basic building block that can be used to interact with asynchronous (and often imperative) Workflow Children. Worker \u00b6 A Child Workflow that provides only output, with no rendering \u2014 a pattern for doing asynchronous work in Workflows. For Kotlin, this is an actual Interface which provides a convenient way to specify asynchronous work that produces an Output and a handler for that Output which can provide an Action. There are Kotlin extensions to map Rx Observables and Kotlin Flows to create Worker implementations. For Swift, there are at least 3 different Worker types which are convenience wrappers around reactive APIs that facilitate performing work. View \u00b6 A class or function managing a 2d box in a graphical user interface system, able to paint a defined region of the display and respond to user input events within its bounds. Views are arranged in a hierarchical tree, with parents able to lay out children and manage their painting and event handling. Instances supported by Workflow are: For Kotlin: Classic Android: class android.view.View Android JetPack Compose: @Composable fun Box() For Swift: class NSViewController Screen \u00b6 An interface / protocol identifying Renderings that model a View. Workflow UI libraries can map a given Screen type to a View instance that can display a series of such Screens. In Kotlin, Screen is a marker interface. Each type S : Screen is mapped by the Android UI library to a ScreenViewFactory<S> that is able to: create instances of android.view.View or provide a @Composable fun Content(S) function to be called from a Box {} context. Note that the Android UI support is able to interleave Screens bound to View or @Composable seamlessly. In Swift, the Screen protocol defines a single function creating ViewControllerDescription instances, objects which create and update ViewController instances to display Screens of the corresponding type. Overlay (Kotlin only) \u00b6 An interface identifying Renderings that model a plane covering a base Screen, possibly hosting another Screen \u2014 \u201ccovering\u201d in that they have a higher z-index, for visibility and event-handling. In Kotlin, Overlay is a marker interface. Each type O : Overlay is mapped by the Android UI library to an OverlayDialogFactory<O> able to create and update instances of android.app.Dialog Container Screen \u00b6 A design pattern, describing a Screen type whose instances wrap one or more other Screens, commonly to either annotate those Screens or define the relationships between them. Wrapping one Screen in another does not necessarily imply that the derived View hierarchy will change. It is common for the Kotlin ScreenViewFactory or Swift ViewControllerDescription bound to a Container Screen to delegate its construction and updating work to those of the wrapped Screens. Container View \u00b6 A View able to host children that are driven by Screen renderings. A Container View is generally driven by Container Screens of a specific type \u2014 e.g., a BackStackContainer View that can display BackStackScreen values. The exception is a root Container View, which is able to display a series of Screen instances of any type. For Kotlin, the root Container Views are WorkflowLayout : FrameLayout , and @Composable Workflow.renderAsState() . Custom Container Views written to display custom Container Screens can use WorkflowViewStub : FrameLayout or @Composable fun WorkflowRendering() to display wrapped Screens. For Swift, the root Container View is ContainerViewController . Custom Container Views written to render custom Container Screens can be built as subclasses of ScreenViewController , and use DescribedViewController to display wrapped Screens. ViewEnvironment \u00b6 A read-only key/value map passed from a Container View down to its children at update time, similar in spirit to Swift UI EnvironmentValues and Jetpack CompositionLocal . Like them, the ViewEnvironment is primarily intended to allow parents to offer children hints about the context in which they are being displayed \u2014 for example, to allow a child to know if it is a member of a back stack, and so decide whether or not to display a Go Back button. The ViewEnvironment also can be used judiciously as a service provider for UI-specific concerns, like image loaders \u2014 tread carefully.","title":"Glossary"},{"location":"glossary/#glossary-of-terms","text":"","title":"Glossary of Terms"},{"location":"glossary/#reactive-programming","text":"A style of programming where data or events are pushed to the logic processing them rather than having the logic pull the data and events from a source. A representation of program logic as a series of operations on a stream of data that is performed while a subscription to that stream is active.","title":"Reactive Programming"},{"location":"glossary/#unidirectional-data-flow","text":"Data travels a single path from business logic to UI, and travels the entirety of that path in a single direction. Events travel a single path from UI to business logic and they travel the entirety of that path in a single direction. There are thus two sets of directed edges in the graph that are handled separately and neither set has any cycles or back edges on its own.","title":"Unidirectional Data Flow"},{"location":"glossary/#declarative-programming","text":"A declarative program declares the state it wants the system to be in rather than how that is accomplished.","title":"Declarative Programming"},{"location":"glossary/#imperative-programming","text":"An imperative program\u2019s code is a series of statements that directly change a program\u2019s state as a result of certain events.","title":"Imperative Programming"},{"location":"glossary/#state-machine","text":"An abstraction that models a program\u2019s logic as a graph of a set of states and the transitions between them (edges). See: en.wikipedia.org/wiki/Finite-state_machine","title":"State Machine"},{"location":"glossary/#idempotent","text":"A function whose side effects won\u2019t be repeated with multiple invocations, the result is purely a function of the input. In other words, if called multiple times with the same input, the result is the same. For Workflows, the render() function must be idempotent, as the runtime offers no guarantees for how many times it may be called.","title":"Idempotent"},{"location":"glossary/#workflow-runtime","text":"An event loop that executes a Workflow Tree. On each pass: A Rendering is assembled by calling render() on each Node of the Workflow Tree with each parent Workflow given the option to incorporate the Renderings of its children into its own. The event loop waits for an Action to be sent to the Sink. This Action provides a (possibly updated) State for the Workflow that created it and possibly an Output. Any Output emitted is processed in turn by an Action defined by the updated Workflow\u2019s parent again possibly updating its State and emitting an Output cascading up the hierarchy. A new render() pass is made against the entire Workflow Tree with the updated States. We use the term Workflow Runtime to refer to the core code in the framework that executes this event loop, responding to Actions and invoking render() .","title":"Workflow Runtime"},{"location":"glossary/#workflow-instance","text":"An object that defines the transitions and side effects of a state machine as, effectively, two functions: Providing the first state: (Props) -> State Providing a rendering: (Props and State) -> (Rendering and Side Effect Invocations and Child Workflow Invocations) The Child Workflow Invocations declared by the render function result in calls to the children\u2019s render() functions in turn, allowing the parent render function to choose to incorporate child Rendering values into its own. A Workflow is not itself a state machine, and ideally has no state of its own. It is rather a schema that identifies a particular type of state machine that can be started in initialState() by the Workflow Runtime, and advanced by repeated invocations of render() . Note: there is significant fuzziness in using the term \u2018Workflow\u2019, as it can mean at times the class/struct that declares the Workflow behavior as well as the object representing the running Workflow Node. To understand the Runtime behavior, grasping this distinction is necessary and valuable. When using a Workflow, the formal distinction is less valuable than the mental model of how a Workflow will be run.","title":"Workflow (Instance)"},{"location":"glossary/#workflow-node","text":"An active state machine whose behavior is defined by a Workflow Instance. This is the object that is held by the Workflow Runtime and whose state is updated (or \u201cdriven\u201d) according to the behavior declared in the Workflow Instance. In Kotlin and Swift a Workflow Node is implemented with the private WorkflowNode class/struct.","title":"Workflow (Node)"},{"location":"glossary/#workflow-lifecycle","text":"Every Workflow or Side Effect Node has a lifecycle that is determined by its parent. In the case of the root Workflow, this lifecycle is determined by how long the host of the root chooses to use the stream of Renderings from the root Workflow. In the case of a non-root Workflow or Side Effect \u2014 that is, in the case of a Child \u2014 its lifecycle is determined as follows: Start: the first time its parent invokes the Child in the parent\u2019s own render() pass. End: the first subsequent render() pass that does not invoke the Child. Note that in between Start and End, the Workflow, or Side Effect is not \u201cre-invoked\u201d in the sense of starting again with each render() pass, but rather the originally invoked instance continues to run until a render() call is made without invoking it.","title":"Workflow Lifecycle"},{"location":"glossary/#workflow-tree","text":"The tree of Workflow Nodes sharing a root. Workflow Nodes can have children and form a hierarchy.","title":"Workflow Tree"},{"location":"glossary/#workflow-root","text":"The root of a Workflow Tree. This is owned by a host which starts the Workflow Runtime with a particular Workflow instance.","title":"Workflow Root"},{"location":"glossary/#rendercontext","text":"The object which provides access to the Workflow Runtime from a Workflow render method. Provides three services: a Sink for accepting WorkflowActions recursively rendering Workflow children executing Side Effects","title":"RenderContext"},{"location":"glossary/#render-pass","text":"The portion of the Workflow Runtime event loop which traverses the Workflow tree, calling render() on each Workflow Node. When the RenderContext Sink receives an Action an Action Cascade occurs and at the completion of the Action Cascade the Render Pass occurs.","title":"Render Pass"},{"location":"glossary/#output-event","text":"When a Child Workflow emits an Output value, this is an Output Event. Handlers are registered when a Child Workflow is invoked to transform the child\u2019s Output values to Actions, which can advance the state of the parent.","title":"Output Event"},{"location":"glossary/#ui-event","text":"Any occurrence in the UI of a program \u2014 e.g. click, drag, keypress \u2014 the listener for which has been connected to a callback in the Rendering of a Workflow. UI Event callbacks typically add Actions to the Sink, to advance the state of the Workflow.","title":"UI Event"},{"location":"glossary/#action","text":"A type associated with a particular Workflow (Instance) that is responsible for transforming a given State into a new State and optionally emitting an Output. Actions are sent to the Sink to be processed by the Workflow Runtime.","title":"Action"},{"location":"glossary/#action-cascade","text":"When an event occurs and the handler provides an Action, this Action may possibly produce an Output for the parent Workflow which in turn has its own handler provide an Action that may produce an Output and onwards up the Workflow Tree. This is an Action Cascade.","title":"Action Cascade"},{"location":"glossary/#sink","text":"The handle provided by the RenderContext to send Actions to the Workflow Runtime. These Actions are applied by the Workflow Runtime to advance a Workflow\u2019s State, and optionally produce an Output to be processed by the handler its parent registered.","title":"Sink"},{"location":"glossary/#props","text":"The set of input properties for a particular Workflow. This is the public state which is provided to a child Workflow by its parent, or to the root Workflow by its host. For Swift: The set of properties on the struct implementing the Workflow. For Kotlin: Parameter type PropsT in the Workflow signature. In Kotlin there is a formal distinction between Props and other dependencies, typically provided as constructor parameters.","title":"Props"},{"location":"glossary/#state","text":"The type of the internal state of a Workflow implementation.","title":"State"},{"location":"glossary/#immutable-state","text":"The State object itself is immutable, in other words, its property values cannot be changed. What this means for Workflows is that the Workflow Runtime holds a canonical instance of the internal State of each Workflow. A Workflow\u2019s state is \u201cadvanced\u201d when that canonical instance is atomically replaced by one returned when an Action is invoked. State can only be mutated through WorkflowAction which will trigger a re-render. There are a number of benefits to keeping State immutable in this way: Reasoning about and debugging the Workflow is easier because, for any given State, there is a deterministic Rendering and the State cannot change except as a new parameter value to the render() method. This assists in making render() idempotent as the State will not be modified in the course of the execution of that function. Note that this immutability can be enforced only by convention. It is possible to cheat, but that is strongly discouraged.","title":"\"Immutable\" State"},{"location":"glossary/#rendering","text":"The externally available public representation of the state of a Workflow. It may include event handling functions. It is given a concrete type in the Workflow signature. Note that this \u201cRendering\u201d does not have to represent the UI of a program. The \u201cRendering\u201d is simply the published state of the Workflow, and could simply be data. Often that data is used to render UI, but it can be used in other ways \u2014 for example, as the implementation of a service API.","title":"Rendering"},{"location":"glossary/#output","text":"The type of the object that can optionally be delivered to the Workflow\u2019s parent or the host of the root Workflow by an Action.","title":"Output"},{"location":"glossary/#child-workflow","text":"A Workflow which has a parent. A parent may compose a child Workflow\u2019s Rendering into its own.","title":"Child Workflow"},{"location":"glossary/#side-effect","text":"From render() , runningSideEffect() can be called with a given key and a function that will be called once by the Workflow Runtime. For Swift, a Lifetime object is also passed to runningSideEffect() which has an onEnded() closure that can be used for cleanup. For Kotlin, a coroutine scope is used to execute the function so it can be cancelled() at cleanup time. Given that any property (including the Sink) could be captured by the closure of the Side Effect this is the basic building block that can be used to interact with asynchronous (and often imperative) Workflow Children.","title":"Side Effect"},{"location":"glossary/#worker","text":"A Child Workflow that provides only output, with no rendering \u2014 a pattern for doing asynchronous work in Workflows. For Kotlin, this is an actual Interface which provides a convenient way to specify asynchronous work that produces an Output and a handler for that Output which can provide an Action. There are Kotlin extensions to map Rx Observables and Kotlin Flows to create Worker implementations. For Swift, there are at least 3 different Worker types which are convenience wrappers around reactive APIs that facilitate performing work.","title":"Worker"},{"location":"glossary/#view","text":"A class or function managing a 2d box in a graphical user interface system, able to paint a defined region of the display and respond to user input events within its bounds. Views are arranged in a hierarchical tree, with parents able to lay out children and manage their painting and event handling. Instances supported by Workflow are: For Kotlin: Classic Android: class android.view.View Android JetPack Compose: @Composable fun Box() For Swift: class NSViewController","title":"View"},{"location":"glossary/#screen","text":"An interface / protocol identifying Renderings that model a View. Workflow UI libraries can map a given Screen type to a View instance that can display a series of such Screens. In Kotlin, Screen is a marker interface. Each type S : Screen is mapped by the Android UI library to a ScreenViewFactory<S> that is able to: create instances of android.view.View or provide a @Composable fun Content(S) function to be called from a Box {} context. Note that the Android UI support is able to interleave Screens bound to View or @Composable seamlessly. In Swift, the Screen protocol defines a single function creating ViewControllerDescription instances, objects which create and update ViewController instances to display Screens of the corresponding type.","title":"Screen"},{"location":"glossary/#overlay-kotlin-only","text":"An interface identifying Renderings that model a plane covering a base Screen, possibly hosting another Screen \u2014 \u201ccovering\u201d in that they have a higher z-index, for visibility and event-handling. In Kotlin, Overlay is a marker interface. Each type O : Overlay is mapped by the Android UI library to an OverlayDialogFactory<O> able to create and update instances of android.app.Dialog","title":"Overlay (Kotlin only)"},{"location":"glossary/#container-screen","text":"A design pattern, describing a Screen type whose instances wrap one or more other Screens, commonly to either annotate those Screens or define the relationships between them. Wrapping one Screen in another does not necessarily imply that the derived View hierarchy will change. It is common for the Kotlin ScreenViewFactory or Swift ViewControllerDescription bound to a Container Screen to delegate its construction and updating work to those of the wrapped Screens.","title":"Container Screen"},{"location":"glossary/#container-view","text":"A View able to host children that are driven by Screen renderings. A Container View is generally driven by Container Screens of a specific type \u2014 e.g., a BackStackContainer View that can display BackStackScreen values. The exception is a root Container View, which is able to display a series of Screen instances of any type. For Kotlin, the root Container Views are WorkflowLayout : FrameLayout , and @Composable Workflow.renderAsState() . Custom Container Views written to display custom Container Screens can use WorkflowViewStub : FrameLayout or @Composable fun WorkflowRendering() to display wrapped Screens. For Swift, the root Container View is ContainerViewController . Custom Container Views written to render custom Container Screens can be built as subclasses of ScreenViewController , and use DescribedViewController to display wrapped Screens.","title":"Container View"},{"location":"glossary/#viewenvironment","text":"A read-only key/value map passed from a Container View down to its children at update time, similar in spirit to Swift UI EnvironmentValues and Jetpack CompositionLocal . Like them, the ViewEnvironment is primarily intended to allow parents to offer children hints about the context in which they are being displayed \u2014 for example, to allow a child to know if it is a member of a back stack, and so decide whether or not to display a Go Back button. The ViewEnvironment also can be used judiciously as a service provider for UI-specific concerns, like image loaders \u2014 tread carefully.","title":"ViewEnvironment"},{"location":"historical/","text":"Pre-1.0 Presentations and Resources \u00b6 Square Workflow \u2013 Droidcon NYC 2019 ( slides ) SF Android GDG @ Square 2019 - Hello Workflow (live coding) Android Dialogs 5-part Coding Series 1 , 2 , 3 , 4 , 5 Reactive Workflows a Year Later \u2013 Droidcon NYC 2018 The Reactive Workflow Pattern \u2013 Fragmented Podcast The Reactive Workflow Pattern Update \u2013 Droidcon SF 2017 The Rx Workflow Pattern \u2013 Droidcon NYC 2017 ( slides )","title":"Pre-1.0 Resources"},{"location":"historical/#pre-10-presentations-and-resources","text":"Square Workflow \u2013 Droidcon NYC 2019 ( slides ) SF Android GDG @ Square 2019 - Hello Workflow (live coding) Android Dialogs 5-part Coding Series 1 , 2 , 3 , 4 , 5 Reactive Workflows a Year Later \u2013 Droidcon NYC 2018 The Reactive Workflow Pattern \u2013 Fragmented Podcast The Reactive Workflow Pattern Update \u2013 Droidcon SF 2017 The Rx Workflow Pattern \u2013 Droidcon NYC 2017 ( slides )","title":"Pre-1.0 Presentations and Resources"},{"location":"sequence_diagrams/","text":"Sequence Diagrams \u00b6 These are the source files used to generate the sequence diagrams via WebSequenceDiagrams .","title":"Sequence Diagrams"},{"location":"sequence_diagrams/#sequence-diagrams","text":"These are the source files used to generate the sequence diagrams via WebSequenceDiagrams .","title":"Sequence Diagrams"},{"location":"swift/api/Workflow/","text":"Reference Documentation \u00b6 Protocols \u00b6 AnyWorkflowConvertible ObserversInterceptor Workflow WorkflowAction WorkflowDebugger WorkflowObserver Structs \u00b6 AnyWorkflow AnyWorkflowAction Sink StateMutationSink WorkflowHierarchyDebugSnapshot WorkflowHierarchyDebugSnapshot.Child WorkflowLogging.Config WorkflowSession WorkflowSession.Identifier WorkflowUpdateDebugInfo Classes \u00b6 Lifetime RenderContext WorkflowHost Enums \u00b6 Config.RenderLoggingMode WorkflowLogging WorkflowObservation WorkflowUpdateDebugInfo.Kind WorkflowUpdateDebugInfo.Source Extensions \u00b6 AnyWorkflow AnyWorkflowAction AnyWorkflowConvertible DispatchQueue RenderContext Workflow WorkflowLogging WorkflowLogging.Config WorkflowObserver WorkflowUpdateDebugInfo.Kind WorkflowUpdateDebugInfo.Source Typealiases \u00b6 AnyWorkflow.Output AnyWorkflow.Rendering AnyWorkflow.State This file was generated by SourceDocs on 2024-02-09 02:29:04 +0000","title":"Workflow "},{"location":"swift/api/Workflow/#reference-documentation","text":"","title":"Reference Documentation"},{"location":"swift/api/Workflow/#protocols","text":"AnyWorkflowConvertible ObserversInterceptor Workflow WorkflowAction WorkflowDebugger WorkflowObserver","title":"Protocols"},{"location":"swift/api/Workflow/#structs","text":"AnyWorkflow AnyWorkflowAction Sink StateMutationSink WorkflowHierarchyDebugSnapshot WorkflowHierarchyDebugSnapshot.Child WorkflowLogging.Config WorkflowSession WorkflowSession.Identifier WorkflowUpdateDebugInfo","title":"Structs"},{"location":"swift/api/Workflow/#classes","text":"Lifetime RenderContext WorkflowHost","title":"Classes"},{"location":"swift/api/Workflow/#enums","text":"Config.RenderLoggingMode WorkflowLogging WorkflowObservation WorkflowUpdateDebugInfo.Kind WorkflowUpdateDebugInfo.Source","title":"Enums"},{"location":"swift/api/Workflow/#extensions","text":"AnyWorkflow AnyWorkflowAction AnyWorkflowConvertible DispatchQueue RenderContext Workflow WorkflowLogging WorkflowLogging.Config WorkflowObserver WorkflowUpdateDebugInfo.Kind WorkflowUpdateDebugInfo.Source","title":"Extensions"},{"location":"swift/api/Workflow/#typealiases","text":"AnyWorkflow.Output AnyWorkflow.Rendering AnyWorkflow.State This file was generated by SourceDocs on 2024-02-09 02:29:04 +0000","title":"Typealiases"},{"location":"swift/api/Workflow/classes/Lifetime/","text":"CLASS Lifetime \u00b6 Represents the lifetime of an object. Once ended, the onEnded closure is called. Properties \u00b6 hasEnded \u00b6 Methods \u00b6 onEnded(_:) \u00b6 Hook to clean-up after end of lifetime . deinit \u00b6","title":"Lifetime"},{"location":"swift/api/Workflow/classes/Lifetime/#lifetime","text":"Represents the lifetime of an object. Once ended, the onEnded closure is called.","title":"Lifetime"},{"location":"swift/api/Workflow/classes/Lifetime/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/classes/Lifetime/#hasended","text":"","title":"hasEnded"},{"location":"swift/api/Workflow/classes/Lifetime/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/classes/Lifetime/#onended_","text":"Hook to clean-up after end of lifetime .","title":"onEnded(_:)"},{"location":"swift/api/Workflow/classes/Lifetime/#deinit","text":"","title":"deinit"},{"location":"swift/api/Workflow/classes/RenderContext/","text":"CLASS RenderContext \u00b6 RenderContext is the composition point for the workflow tree. During a render pass, a workflow may want to defer to a child workflow to render some portion of its content. For example, a workflow that renders to a split-screen view model might delegate to child A for the left side, and child B for the right side view models. Nesting allows for a fractal tree that is constructed out of many small parts. If a parent wants to delegate to a child workflow, it must first create an instance of that workflow. This can be thought of as the model of the child workflow. It does not contain any active state, it simply contains the data necessary to create or update a workflow node. The parent then calls render(workflow:outputMap:) with two values: - The child workflow. - A closure that transforms the child\u2019s output events into the parent\u2019s Event type so that the parent can respond to events generated by the child. If the parent had previously rendered a child of the same type, the existing child workflow node is updated. If the parent had not rendered a child of the same type in the previous render pass, a new child workflow node is generated. The infrastructure then performs a render pass on the child to obtain its Rendering value, which is then returned to the caller. Methods \u00b6 makeSink(of:) \u00b6 Creates a Sink that can be used to send Action s. Sinks are the primary mechanism for feeding State-changing events into the Workflow runtime. Upon receipt of an action, the associated Workflow (node) in the tree will have its State potentially transformed, and then any subsequent Output will be propagated to its parent node until the root of the Workflow tree is reached. At this point the tree will be re-rendered to reflect any State changes that occurred. Parameter actionType: The type of Action this Sink may process Returns: A Sink capable of relaying Action instances to the Workflow runtime runSideEffect(key:action:) \u00b6 Execute a side-effect action. Note that it is a programmer error to run two side-effects with the same key during the same render pass. action will be executed the first time a side-effect is run with a given key . runSideEffect calls with a given key on subsequent renders are ignored. If after a render pass, a side-effect with a key that was previously used is not used, it\u2019s lifetime ends and the Lifetime object\u2019s onEnded closure will be called. Parameters: key: represents the block of work that needs to be executed. action: a block of work that will be executed.","title":"RenderContext"},{"location":"swift/api/Workflow/classes/RenderContext/#rendercontext","text":"RenderContext is the composition point for the workflow tree. During a render pass, a workflow may want to defer to a child workflow to render some portion of its content. For example, a workflow that renders to a split-screen view model might delegate to child A for the left side, and child B for the right side view models. Nesting allows for a fractal tree that is constructed out of many small parts. If a parent wants to delegate to a child workflow, it must first create an instance of that workflow. This can be thought of as the model of the child workflow. It does not contain any active state, it simply contains the data necessary to create or update a workflow node. The parent then calls render(workflow:outputMap:) with two values: - The child workflow. - A closure that transforms the child\u2019s output events into the parent\u2019s Event type so that the parent can respond to events generated by the child. If the parent had previously rendered a child of the same type, the existing child workflow node is updated. If the parent had not rendered a child of the same type in the previous render pass, a new child workflow node is generated. The infrastructure then performs a render pass on the child to obtain its Rendering value, which is then returned to the caller.","title":"RenderContext"},{"location":"swift/api/Workflow/classes/RenderContext/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/classes/RenderContext/#makesinkof","text":"Creates a Sink that can be used to send Action s. Sinks are the primary mechanism for feeding State-changing events into the Workflow runtime. Upon receipt of an action, the associated Workflow (node) in the tree will have its State potentially transformed, and then any subsequent Output will be propagated to its parent node until the root of the Workflow tree is reached. At this point the tree will be re-rendered to reflect any State changes that occurred. Parameter actionType: The type of Action this Sink may process Returns: A Sink capable of relaying Action instances to the Workflow runtime","title":"makeSink(of:)"},{"location":"swift/api/Workflow/classes/RenderContext/#runsideeffectkeyaction","text":"Execute a side-effect action. Note that it is a programmer error to run two side-effects with the same key during the same render pass. action will be executed the first time a side-effect is run with a given key . runSideEffect calls with a given key on subsequent renders are ignored. If after a render pass, a side-effect with a key that was previously used is not used, it\u2019s lifetime ends and the Lifetime object\u2019s onEnded closure will be called. Parameters: key: represents the block of work that needs to be executed. action: a block of work that will be executed.","title":"runSideEffect(key:action:)"},{"location":"swift/api/Workflow/classes/WorkflowHost/","text":"CLASS WorkflowHost \u00b6 Manages an active workflow hierarchy. Properties \u00b6 rendering \u00b6 Represents the Rendering produced by the root workflow in the hierarchy. New Rendering values are produced as state transitions occur within the hierarchy. output \u00b6 A signal containing output events emitted by the root workflow in the hierarchy. Methods \u00b6 init(workflow:observers:debugger:) \u00b6 Initializes a new host with the given workflow at the root. Parameter workflow: The root workflow in the hierarchy Parameter observers: An optional array of WorkflowObservers that will allow runtime introspection for this WorkflowHost Parameter debugger: An optional debugger. If provided, the host will notify the debugger of updates to the workflow hierarchy as state transitions occur. update(workflow:) \u00b6 Update the input for the workflow. Will cause a render pass.","title":"WorkflowHost"},{"location":"swift/api/Workflow/classes/WorkflowHost/#workflowhost","text":"Manages an active workflow hierarchy.","title":"WorkflowHost"},{"location":"swift/api/Workflow/classes/WorkflowHost/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/classes/WorkflowHost/#rendering","text":"Represents the Rendering produced by the root workflow in the hierarchy. New Rendering values are produced as state transitions occur within the hierarchy.","title":"rendering"},{"location":"swift/api/Workflow/classes/WorkflowHost/#output","text":"A signal containing output events emitted by the root workflow in the hierarchy.","title":"output"},{"location":"swift/api/Workflow/classes/WorkflowHost/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/classes/WorkflowHost/#initworkflowobserversdebugger","text":"Initializes a new host with the given workflow at the root. Parameter workflow: The root workflow in the hierarchy Parameter observers: An optional array of WorkflowObservers that will allow runtime introspection for this WorkflowHost Parameter debugger: An optional debugger. If provided, the host will notify the debugger of updates to the workflow hierarchy as state transitions occur.","title":"init(workflow:observers:debugger:)"},{"location":"swift/api/Workflow/classes/WorkflowHost/#updateworkflow","text":"Update the input for the workflow. Will cause a render pass.","title":"update(workflow:)"},{"location":"swift/api/Workflow/enums/Config.RenderLoggingMode/","text":"ENUM Config.RenderLoggingMode \u00b6 Configuration options to control logging during a render pass. Cases \u00b6 none \u00b6 No data will be recorded for WorkflowNode render timings. rootsOnly \u00b6 Render timings will only be recorded for root nodes in a Workflow tree. allNodes \u00b6 Render timings will be recorded for all nodes in a Workflow tree. N.B. performance may be noticeably impacted when using this option.","title":"Config.RenderLoggingMode"},{"location":"swift/api/Workflow/enums/Config.RenderLoggingMode/#configrenderloggingmode","text":"Configuration options to control logging during a render pass.","title":"Config.RenderLoggingMode"},{"location":"swift/api/Workflow/enums/Config.RenderLoggingMode/#cases","text":"","title":"Cases"},{"location":"swift/api/Workflow/enums/Config.RenderLoggingMode/#none","text":"No data will be recorded for WorkflowNode render timings.","title":"none"},{"location":"swift/api/Workflow/enums/Config.RenderLoggingMode/#rootsonly","text":"Render timings will only be recorded for root nodes in a Workflow tree.","title":"rootsOnly"},{"location":"swift/api/Workflow/enums/Config.RenderLoggingMode/#allnodes","text":"Render timings will be recorded for all nodes in a Workflow tree. N.B. performance may be noticeably impacted when using this option.","title":"allNodes"},{"location":"swift/api/Workflow/enums/WorkflowLogging/","text":"ENUM WorkflowLogging \u00b6 Namespace for specifying logging configuration data.","title":"WorkflowLogging"},{"location":"swift/api/Workflow/enums/WorkflowLogging/#workflowlogging","text":"Namespace for specifying logging configuration data.","title":"WorkflowLogging"},{"location":"swift/api/Workflow/enums/WorkflowObservation/","text":"ENUM WorkflowObservation \u00b6 Properties \u00b6 sharedObserversInterceptor \u00b6 The DefaultObserversProvider used by all runtimes.","title":"WorkflowObservation"},{"location":"swift/api/Workflow/enums/WorkflowObservation/#workflowobservation","text":"","title":"WorkflowObservation"},{"location":"swift/api/Workflow/enums/WorkflowObservation/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/enums/WorkflowObservation/#sharedobserversinterceptor","text":"The DefaultObserversProvider used by all runtimes.","title":"sharedObserversInterceptor"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Kind/","text":"ENUM WorkflowUpdateDebugInfo.Kind \u00b6 Cases \u00b6 didUpdate(source:) \u00b6 childDidUpdate(_:) \u00b6","title":"WorkflowUpdateDebugInfo.Kind"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Kind/#workflowupdatedebuginfokind","text":"","title":"WorkflowUpdateDebugInfo.Kind"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Kind/#cases","text":"","title":"Cases"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Kind/#didupdatesource","text":"","title":"didUpdate(source:)"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Kind/#childdidupdate_","text":"","title":"childDidUpdate(_:)"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Source/","text":"ENUM WorkflowUpdateDebugInfo.Source \u00b6 Cases \u00b6 external \u00b6 worker \u00b6 sideEffect \u00b6 subtree(_:) \u00b6","title":"WorkflowUpdateDebugInfo.Source"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Source/#workflowupdatedebuginfosource","text":"","title":"WorkflowUpdateDebugInfo.Source"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Source/#cases","text":"","title":"Cases"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Source/#external","text":"","title":"external"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Source/#worker","text":"","title":"worker"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Source/#sideeffect","text":"","title":"sideEffect"},{"location":"swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Source/#subtree_","text":"","title":"subtree(_:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflow/","text":"EXTENSION AnyWorkflow \u00b6 Methods \u00b6 render(state:context:) \u00b6 asAnyWorkflow() \u00b6 mapOutput(_:) \u00b6 Returns a new AnyWorkflow whose Output type has been transformed into the given type. Parameter transform: An escaping closure that maps the original output type into the new output type. Returns: A type erased workflow with the new output type (the rendering type remains unchanged). mapRendering(_:) \u00b6 Returns a new AnyWorkflow whose Rendering type has been transformed into the given type. Parameter transform: An escaping closure that maps the original rendering type into the new rendering type. Returns: A type erased workflow with the new rendering type (the output type remains unchanged).","title":"AnyWorkflow"},{"location":"swift/api/Workflow/extensions/AnyWorkflow/#anyworkflow","text":"","title":"AnyWorkflow"},{"location":"swift/api/Workflow/extensions/AnyWorkflow/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/extensions/AnyWorkflow/#renderstatecontext","text":"","title":"render(state:context:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflow/#asanyworkflow","text":"","title":"asAnyWorkflow()"},{"location":"swift/api/Workflow/extensions/AnyWorkflow/#mapoutput_","text":"Returns a new AnyWorkflow whose Output type has been transformed into the given type. Parameter transform: An escaping closure that maps the original output type into the new output type. Returns: A type erased workflow with the new output type (the rendering type remains unchanged).","title":"mapOutput(_:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflow/#maprendering_","text":"Returns a new AnyWorkflow whose Rendering type has been transformed into the given type. Parameter transform: An escaping closure that maps the original rendering type into the new rendering type. Returns: A type erased workflow with the new rendering type (the output type remains unchanged).","title":"mapRendering(_:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowAction/","text":"EXTENSION AnyWorkflowAction \u00b6 Properties \u00b6 noAction \u00b6 Creates a type-erased workflow action that does nothing (it leaves state unchanged and does not emit an output event). Methods \u00b6 init(sendingOutput:) \u00b6 Creates a type-erased workflow action that simply sends the given output event. Parameter output: The output event to send when this action is applied.","title":"AnyWorkflowAction"},{"location":"swift/api/Workflow/extensions/AnyWorkflowAction/#anyworkflowaction","text":"","title":"AnyWorkflowAction"},{"location":"swift/api/Workflow/extensions/AnyWorkflowAction/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/extensions/AnyWorkflowAction/#noaction","text":"Creates a type-erased workflow action that does nothing (it leaves state unchanged and does not emit an output event).","title":"noAction"},{"location":"swift/api/Workflow/extensions/AnyWorkflowAction/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/extensions/AnyWorkflowAction/#initsendingoutput","text":"Creates a type-erased workflow action that simply sends the given output event. Parameter output: The output event to send when this action is applied.","title":"init(sendingOutput:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/","text":"EXTENSION AnyWorkflowConvertible \u00b6 Methods \u00b6 mapOutput(_:) \u00b6 mapRendering(_:) \u00b6 rendered(in:key:) \u00b6 Creates or updates a child workflow of the given type, performs a render pass, and returns the result. Note that it is a programmer error to render two instances of a given workflow type with the same key during the same render pass. Parameter context: The context with which the workflow will be rendered. Parameter key: A string that uniquely identifies this workflow. Returns: The Rendering generated by the workflow. rendered(in:key:outputMap:) \u00b6 rendered(in:key:) \u00b6 rendered(in:key:) \u00b6 Creates or updates a child workflow of the given type, performs a render pass, and returns the result. Note that it is a programmer error to render two instances of a given workflow type with the same key during the same render pass. Parameter context: The context with which the workflow will be rendered. Parameter key: A string that uniquely identifies this workflow. Returns: The Rendering generated by the workflow. running(in:key:outputMap:) \u00b6 running(in:key:) \u00b6 onOutput(_:) \u00b6 Process an Output Parameter apply: On Output , mutate State as necessary and return new Output (or nil ). ignoringOutput() \u00b6 Wraps this workflow in a workflow that ignores all outputs. Returns: An AnyWorkflow with the same rendering and no output.","title":"AnyWorkflowConvertible"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#anyworkflowconvertible","text":"","title":"AnyWorkflowConvertible"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#mapoutput_","text":"","title":"mapOutput(_:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#maprendering_","text":"","title":"mapRendering(_:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#renderedinkey","text":"Creates or updates a child workflow of the given type, performs a render pass, and returns the result. Note that it is a programmer error to render two instances of a given workflow type with the same key during the same render pass. Parameter context: The context with which the workflow will be rendered. Parameter key: A string that uniquely identifies this workflow. Returns: The Rendering generated by the workflow.","title":"rendered(in:key:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#renderedinkeyoutputmap","text":"","title":"rendered(in:key:outputMap:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#renderedinkey_1","text":"","title":"rendered(in:key:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#renderedinkey_2","text":"Creates or updates a child workflow of the given type, performs a render pass, and returns the result. Note that it is a programmer error to render two instances of a given workflow type with the same key during the same render pass. Parameter context: The context with which the workflow will be rendered. Parameter key: A string that uniquely identifies this workflow. Returns: The Rendering generated by the workflow.","title":"rendered(in:key:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#runninginkeyoutputmap","text":"","title":"running(in:key:outputMap:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#runninginkey","text":"","title":"running(in:key:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#onoutput_","text":"Process an Output Parameter apply: On Output , mutate State as necessary and return new Output (or nil ).","title":"onOutput(_:)"},{"location":"swift/api/Workflow/extensions/AnyWorkflowConvertible/#ignoringoutput","text":"Wraps this workflow in a workflow that ignores all outputs. Returns: An AnyWorkflow with the same rendering and no output.","title":"ignoringOutput()"},{"location":"swift/api/Workflow/extensions/DispatchQueue/","text":"EXTENSION DispatchQueue \u00b6 Properties \u00b6 workflowExecution \u00b6","title":"DispatchQueue"},{"location":"swift/api/Workflow/extensions/DispatchQueue/#dispatchqueue","text":"","title":"DispatchQueue"},{"location":"swift/api/Workflow/extensions/DispatchQueue/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/extensions/DispatchQueue/#workflowexecution","text":"","title":"workflowExecution"},{"location":"swift/api/Workflow/extensions/RenderContext/","text":"EXTENSION RenderContext \u00b6 Methods \u00b6 makeSink(of:onEvent:) \u00b6 makeOutputSink() \u00b6 Generates a sink that allows sending the Workflow\u2019s output wrapped in an AnyWorkflowAction, allowing bypassing an intermediate action. makeStateMutationSink() \u00b6 Creates StateMutationSink . To create a sink: let stateMutationSink = context.makeStateMutationSink() To mutate State on an event: stateMutationSink.send(\\State.value, value: 10)","title":"RenderContext"},{"location":"swift/api/Workflow/extensions/RenderContext/#rendercontext","text":"","title":"RenderContext"},{"location":"swift/api/Workflow/extensions/RenderContext/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/extensions/RenderContext/#makesinkofonevent","text":"","title":"makeSink(of:onEvent:)"},{"location":"swift/api/Workflow/extensions/RenderContext/#makeoutputsink","text":"Generates a sink that allows sending the Workflow\u2019s output wrapped in an AnyWorkflowAction, allowing bypassing an intermediate action.","title":"makeOutputSink()"},{"location":"swift/api/Workflow/extensions/RenderContext/#makestatemutationsink","text":"Creates StateMutationSink . To create a sink: let stateMutationSink = context.makeStateMutationSink() To mutate State on an event: stateMutationSink.send(\\State.value, value: 10)","title":"makeStateMutationSink()"},{"location":"swift/api/Workflow/extensions/Workflow/","text":"EXTENSION Workflow \u00b6 Methods \u00b6 workflowDidChange(from:state:) \u00b6 makeInitialState() \u00b6 workflowDidChange(from:state:) \u00b6 asAnyWorkflow() \u00b6","title":"Workflow"},{"location":"swift/api/Workflow/extensions/Workflow/#workflow","text":"","title":"Workflow"},{"location":"swift/api/Workflow/extensions/Workflow/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/extensions/Workflow/#workflowdidchangefromstate","text":"","title":"workflowDidChange(from:state:)"},{"location":"swift/api/Workflow/extensions/Workflow/#makeinitialstate","text":"","title":"makeInitialState()"},{"location":"swift/api/Workflow/extensions/Workflow/#workflowdidchangefromstate_1","text":"","title":"workflowDidChange(from:state:)"},{"location":"swift/api/Workflow/extensions/Workflow/#asanyworkflow","text":"","title":"asAnyWorkflow()"},{"location":"swift/api/Workflow/extensions/WorkflowLogging.Config/","text":"EXTENSION WorkflowLogging.Config \u00b6 Properties \u00b6 debug \u00b6 Logging config that will output the most information. Will also have the most noticeable effect on performance. rootRendersAndActions \u00b6 Logging config that will record render timings for root nodes as well as action events. This provides a reasonable performance tradeoff if you\u2019re interested in the runtime\u2019s behavior but don\u2019t wan to pay the price of logging everything.","title":"WorkflowLogging.Config"},{"location":"swift/api/Workflow/extensions/WorkflowLogging.Config/#workflowloggingconfig","text":"","title":"WorkflowLogging.Config"},{"location":"swift/api/Workflow/extensions/WorkflowLogging.Config/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/extensions/WorkflowLogging.Config/#debug","text":"Logging config that will output the most information. Will also have the most noticeable effect on performance.","title":"debug"},{"location":"swift/api/Workflow/extensions/WorkflowLogging.Config/#rootrendersandactions","text":"Logging config that will record render timings for root nodes as well as action events. This provides a reasonable performance tradeoff if you\u2019re interested in the runtime\u2019s behavior but don\u2019t wan to pay the price of logging everything.","title":"rootRendersAndActions"},{"location":"swift/api/Workflow/extensions/WorkflowLogging/","text":"EXTENSION WorkflowLogging \u00b6 Properties \u00b6 enabled \u00b6 Global setting to enable or disable logging. Note, this is independent of the specified config value, and simply governs whether the runtime should emit any logs. To enable logging, at a minimum you must set: WorkflowLogging.enabled = true If you wish for more control over what the runtime will log, you may additionally specify a custom value for WorkflowLogging.config . config \u00b6 Configuration options used to determine which activities are logged.","title":"WorkflowLogging"},{"location":"swift/api/Workflow/extensions/WorkflowLogging/#workflowlogging","text":"","title":"WorkflowLogging"},{"location":"swift/api/Workflow/extensions/WorkflowLogging/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/extensions/WorkflowLogging/#enabled","text":"Global setting to enable or disable logging. Note, this is independent of the specified config value, and simply governs whether the runtime should emit any logs. To enable logging, at a minimum you must set: WorkflowLogging.enabled = true If you wish for more control over what the runtime will log, you may additionally specify a custom value for WorkflowLogging.config .","title":"enabled"},{"location":"swift/api/Workflow/extensions/WorkflowLogging/#config","text":"Configuration options used to determine which activities are logged.","title":"config"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/","text":"EXTENSION WorkflowObserver \u00b6 Methods \u00b6 sessionDidBegin(_:) \u00b6 sessionDidEnd(_:) \u00b6 workflowDidMakeInitialState(_:initialState:session:) \u00b6 workflowWillRender(_:state:session:) \u00b6 workflowDidChange(from:to:state:session:) \u00b6 workflowDidReceiveAction(_:workflow:session:) \u00b6 workflowWillApplyAction(_:workflow:state:session:) \u00b6","title":"WorkflowObserver"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/#workflowobserver","text":"","title":"WorkflowObserver"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/#sessiondidbegin_","text":"","title":"sessionDidBegin(_:)"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/#sessiondidend_","text":"","title":"sessionDidEnd(_:)"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/#workflowdidmakeinitialstate_initialstatesession","text":"","title":"workflowDidMakeInitialState(_:initialState:session:)"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/#workflowwillrender_statesession","text":"","title":"workflowWillRender(_:state:session:)"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/#workflowdidchangefromtostatesession","text":"","title":"workflowDidChange(from:to:state:session:)"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/#workflowdidreceiveaction_workflowsession","text":"","title":"workflowDidReceiveAction(_:workflow:session:)"},{"location":"swift/api/Workflow/extensions/WorkflowObserver/#workflowwillapplyaction_workflowstatesession","text":"","title":"workflowWillApplyAction(_:workflow:state:session:)"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Kind/","text":"EXTENSION WorkflowUpdateDebugInfo.Kind \u00b6 Methods \u00b6 encode(to:) \u00b6 init(from:) \u00b6","title":"WorkflowUpdateDebugInfo.Kind"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Kind/#workflowupdatedebuginfokind","text":"","title":"WorkflowUpdateDebugInfo.Kind"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Kind/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Kind/#encodeto","text":"","title":"encode(to:)"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Kind/#initfrom","text":"","title":"init(from:)"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Source/","text":"EXTENSION WorkflowUpdateDebugInfo.Source \u00b6 Methods \u00b6 encode(to:) \u00b6 init(from:) \u00b6","title":"WorkflowUpdateDebugInfo.Source"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Source/#workflowupdatedebuginfosource","text":"","title":"WorkflowUpdateDebugInfo.Source"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Source/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Source/#encodeto","text":"","title":"encode(to:)"},{"location":"swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Source/#initfrom","text":"","title":"init(from:)"},{"location":"swift/api/Workflow/protocols/AnyWorkflowConvertible/","text":"PROTOCOL AnyWorkflowConvertible \u00b6 Conforming types can be converted into AnyWorkflow values, allowing them to participate in a workflow hierarchy. Methods \u00b6 asAnyWorkflow() \u00b6 Returns an AnyWorkflow representing this value.","title":"AnyWorkflowConvertible"},{"location":"swift/api/Workflow/protocols/AnyWorkflowConvertible/#anyworkflowconvertible","text":"Conforming types can be converted into AnyWorkflow values, allowing them to participate in a workflow hierarchy.","title":"AnyWorkflowConvertible"},{"location":"swift/api/Workflow/protocols/AnyWorkflowConvertible/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/protocols/AnyWorkflowConvertible/#asanyworkflow","text":"Returns an AnyWorkflow representing this value.","title":"asAnyWorkflow()"},{"location":"swift/api/Workflow/protocols/ObserversInterceptor/","text":"PROTOCOL ObserversInterceptor \u00b6 Methods \u00b6 workflowObservers(for:) \u00b6 Provides a single access point to provide the final list of WorkflowObserver used by the runtime. This may be used to ensure a known set of observers is used in a particular order for all WorkflowHost s created over the life of a program. - Parameter initialObservers: Array of observers passed to a WorkflowHost constructor - Returns: The array of WorkflowObserver s to be used by the WorkflowHost","title":"ObserversInterceptor"},{"location":"swift/api/Workflow/protocols/ObserversInterceptor/#observersinterceptor","text":"","title":"ObserversInterceptor"},{"location":"swift/api/Workflow/protocols/ObserversInterceptor/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/protocols/ObserversInterceptor/#workflowobserversfor","text":"Provides a single access point to provide the final list of WorkflowObserver used by the runtime. This may be used to ensure a known set of observers is used in a particular order for all WorkflowHost s created over the life of a program. - Parameter initialObservers: Array of observers passed to a WorkflowHost constructor - Returns: The array of WorkflowObserver s to be used by the WorkflowHost","title":"workflowObservers(for:)"},{"location":"swift/api/Workflow/protocols/Workflow/","text":"PROTOCOL Workflow \u00b6 Defines a node in the workflow tree. Initialization and Updating A workflow node comes into existence after its parent produces an instance of that workflow and uses it during a render pass (see the render method for more details). If this is the first time the parent has rendered a child of this type, a new workflow node is created. The workflow passed in from the parent will be used to invoke initialState() to obtain an initial state. If the parent had previously rendered a child of this type, the existing workflow node will be updated. workflowDidChange(from:state:) will be invoked to allow the workflow to respond to the change. Render After a workflow node has been created, or any time its state changes, a render pass occurs. The render pass takes the workflow that was passed down from the parent along with the current state and generates a value of type Rendering . In a common case, a workflow might render to a screen model for display. func render(state: State, context: RenderContext) -> MyScreenModel { return MyScreenModel() } Methods \u00b6 makeInitialState() \u00b6 This method is invoked once when a workflow node comes into existence. Returns: The initial state for the workflow. workflowDidChange(from:state:) \u00b6 Called when a new workflow is passed down from the parent to an existing workflow node. Parameter previousWorkflow: The workflow before the update. Parameter state: The current state. render(state:context:) \u00b6 Called by the internal Workflow infrastructure to \u201crender\u201d the current state into Rendering . A workflow\u2019s Rendering type is commonly a view or screen model. Parameter state: The current state. Parameter context: The workflow context is the composition point for the workflow tree. To use a nested workflow, instantiate it based on the current state, then call rendered(in:key:outputMap:) . This will return the child\u2019s Rendering type after creating or updating the nested workflow.","title":"Workflow"},{"location":"swift/api/Workflow/protocols/Workflow/#workflow","text":"Defines a node in the workflow tree. Initialization and Updating A workflow node comes into existence after its parent produces an instance of that workflow and uses it during a render pass (see the render method for more details). If this is the first time the parent has rendered a child of this type, a new workflow node is created. The workflow passed in from the parent will be used to invoke initialState() to obtain an initial state. If the parent had previously rendered a child of this type, the existing workflow node will be updated. workflowDidChange(from:state:) will be invoked to allow the workflow to respond to the change. Render After a workflow node has been created, or any time its state changes, a render pass occurs. The render pass takes the workflow that was passed down from the parent along with the current state and generates a value of type Rendering . In a common case, a workflow might render to a screen model for display. func render(state: State, context: RenderContext) -> MyScreenModel { return MyScreenModel() }","title":"Workflow"},{"location":"swift/api/Workflow/protocols/Workflow/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/protocols/Workflow/#makeinitialstate","text":"This method is invoked once when a workflow node comes into existence. Returns: The initial state for the workflow.","title":"makeInitialState()"},{"location":"swift/api/Workflow/protocols/Workflow/#workflowdidchangefromstate","text":"Called when a new workflow is passed down from the parent to an existing workflow node. Parameter previousWorkflow: The workflow before the update. Parameter state: The current state.","title":"workflowDidChange(from:state:)"},{"location":"swift/api/Workflow/protocols/Workflow/#renderstatecontext","text":"Called by the internal Workflow infrastructure to \u201crender\u201d the current state into Rendering . A workflow\u2019s Rendering type is commonly a view or screen model. Parameter state: The current state. Parameter context: The workflow context is the composition point for the workflow tree. To use a nested workflow, instantiate it based on the current state, then call rendered(in:key:outputMap:) . This will return the child\u2019s Rendering type after creating or updating the nested workflow.","title":"render(state:context:)"},{"location":"swift/api/Workflow/protocols/WorkflowAction/","text":"PROTOCOL WorkflowAction \u00b6 Conforming types represent an action that advances a workflow. When applied, an action emits the next state and / or output for the workflow. Methods \u00b6 apply(toState:) \u00b6 Applies this action to a given state of the workflow, optionally returning an output event. Parameter state: The current state of the workflow. The state is passed as an inout param, allowing actions to modify state during application. Returns: An optional output event for the workflow. If an output event is returned, it will be passed up the workflow hierarchy to this workflow\u2019s parent.","title":"WorkflowAction"},{"location":"swift/api/Workflow/protocols/WorkflowAction/#workflowaction","text":"Conforming types represent an action that advances a workflow. When applied, an action emits the next state and / or output for the workflow.","title":"WorkflowAction"},{"location":"swift/api/Workflow/protocols/WorkflowAction/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/protocols/WorkflowAction/#applytostate","text":"Applies this action to a given state of the workflow, optionally returning an output event. Parameter state: The current state of the workflow. The state is passed as an inout param, allowing actions to modify state during application. Returns: An optional output event for the workflow. If an output event is returned, it will be passed up the workflow hierarchy to this workflow\u2019s parent.","title":"apply(toState:)"},{"location":"swift/api/Workflow/protocols/WorkflowDebugger/","text":"PROTOCOL WorkflowDebugger \u00b6 Defines a type that receives debug information about a running workflow hierarchy. Methods \u00b6 didEnterInitialState(snapshot:) \u00b6 Called once when the workflow hierarchy initializes. Parameter snapshot: Debug information about the workflow hierarchy. didUpdate(snapshot:updateInfo:) \u00b6 Called when an update occurs anywhere within the workflow hierarchy. Parameter snapshot: Debug information about the workflow hierarchy after the update. Parameter updateInfo: Information about the update.","title":"WorkflowDebugger"},{"location":"swift/api/Workflow/protocols/WorkflowDebugger/#workflowdebugger","text":"Defines a type that receives debug information about a running workflow hierarchy.","title":"WorkflowDebugger"},{"location":"swift/api/Workflow/protocols/WorkflowDebugger/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/protocols/WorkflowDebugger/#didenterinitialstatesnapshot","text":"Called once when the workflow hierarchy initializes. Parameter snapshot: Debug information about the workflow hierarchy.","title":"didEnterInitialState(snapshot:)"},{"location":"swift/api/Workflow/protocols/WorkflowDebugger/#didupdatesnapshotupdateinfo","text":"Called when an update occurs anywhere within the workflow hierarchy. Parameter snapshot: Debug information about the workflow hierarchy after the update. Parameter updateInfo: Information about the update.","title":"didUpdate(snapshot:updateInfo:)"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/","text":"PROTOCOL WorkflowObserver \u00b6 The WorkflowObserver protocol provides an interface to receive updates during the runtime\u2019s execution loop. All requirements are optional, and no-ops are provided by default. Methods \u00b6 sessionDidBegin(_:) \u00b6 Indicates the start of a WorkflowSession , which tracks the life of the underlying WorkflowNode used to provide renderings for a given Workflow type and rendering key. - Parameter session: The WorkflowSession that began. sessionDidEnd(_:) \u00b6 Marks the end of a WorkflowSession , indicating that the corresponding WorkflowNode has been removed from the tree of Workflows. - Parameter session: The WorkflowSession that ended. workflowDidMakeInitialState(_:initialState:session:) \u00b6 Indicates a Workflow produced its initial state value. - Parameters: - workflow: The Workflow that just produced its initial state. - initialState: The State that was created. - session: The WorkflowSession corresponding to the backing WorkflowNode workflowWillRender(_:state:session:) \u00b6 Called before a Workflow is queried for its latest Rendering . - Parameters: - workflow: The Workflow that is about to be render. - state: The corresponding State that will be used during the render call. - session: The WorkflowSession corresponding to the backing WorkflowNode . - Returns: An optional closure to be called immediately after the new Rendering is produced, which takes the rendering as the only parameter. workflowDidChange(from:to:state:session:) \u00b6 Called after an existing Workflow is updated. - Parameters: - oldWorkflow: The previous Workflow - newWorkflow: The new Workflow - state: The state after the update has occurred. - session: The WorkflowSession corresponding to the backing WorkflowNode . workflowDidReceiveAction(_:workflow:session:) \u00b6 Called after a WorkflowAction is received, but before it has been handled and propagated up the tree. - Parameters: - action: The action that was received. - session: The WorkflowSession corresponding to the backing WorkflowNode . workflowWillApplyAction(_:workflow:state:session:) \u00b6 Called when a WorkflowAction will be applied to its corresponding Workflow\u2019s State - Parameters: - action: The action that will be applied. - workflow: The action\u2019s corresponding Workflow . - state: The state to which the action will be applied. - session: The WorkflowSession corresponding to the backing WorkflowNode . - Returns: An optional closure to be called immediately after the action is applied to the State , and an optional Output has been produced. The closure takes the updated state and optional output as its arguments.","title":"WorkflowObserver"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/#workflowobserver","text":"The WorkflowObserver protocol provides an interface to receive updates during the runtime\u2019s execution loop. All requirements are optional, and no-ops are provided by default.","title":"WorkflowObserver"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/#sessiondidbegin_","text":"Indicates the start of a WorkflowSession , which tracks the life of the underlying WorkflowNode used to provide renderings for a given Workflow type and rendering key. - Parameter session: The WorkflowSession that began.","title":"sessionDidBegin(_:)"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/#sessiondidend_","text":"Marks the end of a WorkflowSession , indicating that the corresponding WorkflowNode has been removed from the tree of Workflows. - Parameter session: The WorkflowSession that ended.","title":"sessionDidEnd(_:)"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/#workflowdidmakeinitialstate_initialstatesession","text":"Indicates a Workflow produced its initial state value. - Parameters: - workflow: The Workflow that just produced its initial state. - initialState: The State that was created. - session: The WorkflowSession corresponding to the backing WorkflowNode","title":"workflowDidMakeInitialState(_:initialState:session:)"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/#workflowwillrender_statesession","text":"Called before a Workflow is queried for its latest Rendering . - Parameters: - workflow: The Workflow that is about to be render. - state: The corresponding State that will be used during the render call. - session: The WorkflowSession corresponding to the backing WorkflowNode . - Returns: An optional closure to be called immediately after the new Rendering is produced, which takes the rendering as the only parameter.","title":"workflowWillRender(_:state:session:)"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/#workflowdidchangefromtostatesession","text":"Called after an existing Workflow is updated. - Parameters: - oldWorkflow: The previous Workflow - newWorkflow: The new Workflow - state: The state after the update has occurred. - session: The WorkflowSession corresponding to the backing WorkflowNode .","title":"workflowDidChange(from:to:state:session:)"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/#workflowdidreceiveaction_workflowsession","text":"Called after a WorkflowAction is received, but before it has been handled and propagated up the tree. - Parameters: - action: The action that was received. - session: The WorkflowSession corresponding to the backing WorkflowNode .","title":"workflowDidReceiveAction(_:workflow:session:)"},{"location":"swift/api/Workflow/protocols/WorkflowObserver/#workflowwillapplyaction_workflowstatesession","text":"Called when a WorkflowAction will be applied to its corresponding Workflow\u2019s State - Parameters: - action: The action that will be applied. - workflow: The action\u2019s corresponding Workflow . - state: The state to which the action will be applied. - session: The WorkflowSession corresponding to the backing WorkflowNode . - Returns: An optional closure to be called immediately after the action is applied to the State , and an optional Output has been produced. The closure takes the updated state and optional output as its arguments.","title":"workflowWillApplyAction(_:workflow:state:session:)"},{"location":"swift/api/Workflow/structs/AnyWorkflow/","text":"STRUCT AnyWorkflow \u00b6 A type-erased wrapper that contains a workflow with the given Rendering and Output types. Properties \u00b6 base \u00b6 The underlying erased workflow instance workflowType \u00b6 The underlying workflow\u2019s implementation type. Methods \u00b6 init(_:) \u00b6 Initializes a new type-erased wrapper for the given workflow.","title":"AnyWorkflow"},{"location":"swift/api/Workflow/structs/AnyWorkflow/#anyworkflow","text":"A type-erased wrapper that contains a workflow with the given Rendering and Output types.","title":"AnyWorkflow"},{"location":"swift/api/Workflow/structs/AnyWorkflow/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/structs/AnyWorkflow/#base","text":"The underlying erased workflow instance","title":"base"},{"location":"swift/api/Workflow/structs/AnyWorkflow/#workflowtype","text":"The underlying workflow\u2019s implementation type.","title":"workflowType"},{"location":"swift/api/Workflow/structs/AnyWorkflow/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/structs/AnyWorkflow/#init_","text":"Initializes a new type-erased wrapper for the given workflow.","title":"init(_:)"},{"location":"swift/api/Workflow/structs/AnyWorkflowAction/","text":"STRUCT AnyWorkflowAction \u00b6 A type-erased workflow action. The AnyWorkflowAction type forwards apply to an underlying workflow action, hiding its specific underlying type. Properties \u00b6 base \u00b6 The underlying type-erased WorkflowAction isClosureBased \u00b6 True iff the underlying apply implementation is defined by a closure vs wrapping a WorkflowAction conformance Methods \u00b6 init(_:) \u00b6 Creates a type-erased workflow action that wraps the given instance. Parameter base: A workflow action to wrap. init(_:fileID:line:) \u00b6 Creates a type-erased workflow action with the given apply implementation. Parameter apply: the apply function for the resulting action. apply(toState:) \u00b6","title":"AnyWorkflowAction"},{"location":"swift/api/Workflow/structs/AnyWorkflowAction/#anyworkflowaction","text":"A type-erased workflow action. The AnyWorkflowAction type forwards apply to an underlying workflow action, hiding its specific underlying type.","title":"AnyWorkflowAction"},{"location":"swift/api/Workflow/structs/AnyWorkflowAction/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/structs/AnyWorkflowAction/#base","text":"The underlying type-erased WorkflowAction","title":"base"},{"location":"swift/api/Workflow/structs/AnyWorkflowAction/#isclosurebased","text":"True iff the underlying apply implementation is defined by a closure vs wrapping a WorkflowAction conformance","title":"isClosureBased"},{"location":"swift/api/Workflow/structs/AnyWorkflowAction/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/structs/AnyWorkflowAction/#init_","text":"Creates a type-erased workflow action that wraps the given instance. Parameter base: A workflow action to wrap.","title":"init(_:)"},{"location":"swift/api/Workflow/structs/AnyWorkflowAction/#init_fileidline","text":"Creates a type-erased workflow action with the given apply implementation. Parameter apply: the apply function for the resulting action.","title":"init(_:fileID:line:)"},{"location":"swift/api/Workflow/structs/AnyWorkflowAction/#applytostate","text":"","title":"apply(toState:)"},{"location":"swift/api/Workflow/structs/Sink/","text":"STRUCT Sink \u00b6 Sink is a type that receives incoming values (commonly events or WorkflowAction ) Use RenderContext.makeSink to create instances. Methods \u00b6 init(_:) \u00b6 Initializes a new sink with the given closure. send(_:) \u00b6 Sends a new event into the sink. Parameter event: The value to send into the sink. contraMap(_:) \u00b6 Generates a new sink of type NewValue. Given a transform closure, the following code is functionally equivalent: sink.send(transform(value)) sink.contraMap(transform).send(value) Trivia : Why is this called contraMap ? - map turns Type into Type via (T)->U . - contraMap turns Type into Type via (U)->T Another way to think about this is: map transforms a type by changing the output types of its API, while contraMap transforms a type by changing the input types of its API. Parameter transform: An escaping closure that transforms T into Event .","title":"Sink"},{"location":"swift/api/Workflow/structs/Sink/#sink","text":"Sink is a type that receives incoming values (commonly events or WorkflowAction ) Use RenderContext.makeSink to create instances.","title":"Sink"},{"location":"swift/api/Workflow/structs/Sink/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/structs/Sink/#init_","text":"Initializes a new sink with the given closure.","title":"init(_:)"},{"location":"swift/api/Workflow/structs/Sink/#send_","text":"Sends a new event into the sink. Parameter event: The value to send into the sink.","title":"send(_:)"},{"location":"swift/api/Workflow/structs/Sink/#contramap_","text":"Generates a new sink of type NewValue. Given a transform closure, the following code is functionally equivalent: sink.send(transform(value)) sink.contraMap(transform).send(value) Trivia : Why is this called contraMap ? - map turns Type into Type via (T)->U . - contraMap turns Type into Type via (U)->T Another way to think about this is: map transforms a type by changing the output types of its API, while contraMap transforms a type by changing the input types of its API. Parameter transform: An escaping closure that transforms T into Event .","title":"contraMap(_:)"},{"location":"swift/api/Workflow/structs/StateMutationSink/","text":"STRUCT StateMutationSink \u00b6 StateMutationSink provides a Sink that helps mutate State using it\u2019s KeyPath . Methods \u00b6 send(_:) \u00b6 Sends message to StateMutationSink to update State \u2019s value using the provided closure. Parameters: update: The State mutation to perform. send(_:value:) \u00b6 Sends message to StateMutationSink to update State \u2019s value at KeyPath with Value . Parameters: keyPath: Key path of State whose value needs to be mutated. value: Value to update State with.","title":"StateMutationSink"},{"location":"swift/api/Workflow/structs/StateMutationSink/#statemutationsink","text":"StateMutationSink provides a Sink that helps mutate State using it\u2019s KeyPath .","title":"StateMutationSink"},{"location":"swift/api/Workflow/structs/StateMutationSink/#methods","text":"","title":"Methods"},{"location":"swift/api/Workflow/structs/StateMutationSink/#send_","text":"Sends message to StateMutationSink to update State \u2019s value using the provided closure. Parameters: update: The State mutation to perform.","title":"send(_:)"},{"location":"swift/api/Workflow/structs/StateMutationSink/#send_value","text":"Sends message to StateMutationSink to update State \u2019s value at KeyPath with Value . Parameters: keyPath: Key path of State whose value needs to be mutated. value: Value to update State with.","title":"send(_:value:)"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot.Child/","text":"STRUCT WorkflowHierarchyDebugSnapshot.Child \u00b6 Properties \u00b6 key \u00b6 snapshot \u00b6","title":"WorkflowHierarchyDebugSnapshot.Child"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot.Child/#workflowhierarchydebugsnapshotchild","text":"","title":"WorkflowHierarchyDebugSnapshot.Child"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot.Child/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot.Child/#key","text":"","title":"key"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot.Child/#snapshot","text":"","title":"snapshot"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot/","text":"STRUCT WorkflowHierarchyDebugSnapshot \u00b6 Properties \u00b6 workflowType \u00b6 stateDescription \u00b6 children \u00b6","title":"WorkflowHierarchyDebugSnapshot"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot/#workflowhierarchydebugsnapshot","text":"","title":"WorkflowHierarchyDebugSnapshot"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot/#workflowtype","text":"","title":"workflowType"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot/#statedescription","text":"","title":"stateDescription"},{"location":"swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot/#children","text":"","title":"children"},{"location":"swift/api/Workflow/structs/WorkflowLogging.Config/","text":"STRUCT WorkflowLogging.Config \u00b6 Properties \u00b6 renderLoggingMode \u00b6 logLifetimes \u00b6 When true , the interval spanning a WorkflowNode\u2019s lifetime will be recorded. logActions \u00b6 When true , action events will be recorded.","title":"WorkflowLogging.Config"},{"location":"swift/api/Workflow/structs/WorkflowLogging.Config/#workflowloggingconfig","text":"","title":"WorkflowLogging.Config"},{"location":"swift/api/Workflow/structs/WorkflowLogging.Config/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/structs/WorkflowLogging.Config/#renderloggingmode","text":"","title":"renderLoggingMode"},{"location":"swift/api/Workflow/structs/WorkflowLogging.Config/#loglifetimes","text":"When true , the interval spanning a WorkflowNode\u2019s lifetime will be recorded.","title":"logLifetimes"},{"location":"swift/api/Workflow/structs/WorkflowLogging.Config/#logactions","text":"When true , action events will be recorded.","title":"logActions"},{"location":"swift/api/Workflow/structs/WorkflowSession.Identifier/","text":"STRUCT WorkflowSession.Identifier \u00b6","title":"WorkflowSession.Identifier"},{"location":"swift/api/Workflow/structs/WorkflowSession.Identifier/#workflowsessionidentifier","text":"","title":"WorkflowSession.Identifier"},{"location":"swift/api/Workflow/structs/WorkflowSession/","text":"STRUCT WorkflowSession \u00b6 A WorkflowSession encapsulates the information that gives a WorkflowNode its identity. In particular, it captures: - The type of the corresponding Workflow conformance. - The String key used when the workflow was rendered. - An Identifier type that is unique across program execution. - An optional reference to a parent WorkflowSession , to differentiate root nodes. Properties \u00b6 workflowType \u00b6 renderKey \u00b6 sessionID \u00b6 parent \u00b6","title":"WorkflowSession"},{"location":"swift/api/Workflow/structs/WorkflowSession/#workflowsession","text":"A WorkflowSession encapsulates the information that gives a WorkflowNode its identity. In particular, it captures: - The type of the corresponding Workflow conformance. - The String key used when the workflow was rendered. - An Identifier type that is unique across program execution. - An optional reference to a parent WorkflowSession , to differentiate root nodes.","title":"WorkflowSession"},{"location":"swift/api/Workflow/structs/WorkflowSession/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/structs/WorkflowSession/#workflowtype","text":"","title":"workflowType"},{"location":"swift/api/Workflow/structs/WorkflowSession/#renderkey","text":"","title":"renderKey"},{"location":"swift/api/Workflow/structs/WorkflowSession/#sessionid","text":"","title":"sessionID"},{"location":"swift/api/Workflow/structs/WorkflowSession/#parent","text":"","title":"parent"},{"location":"swift/api/Workflow/structs/WorkflowUpdateDebugInfo/","text":"STRUCT WorkflowUpdateDebugInfo \u00b6 Properties \u00b6 workflowType \u00b6 kind \u00b6","title":"WorkflowUpdateDebugInfo"},{"location":"swift/api/Workflow/structs/WorkflowUpdateDebugInfo/#workflowupdatedebuginfo","text":"","title":"WorkflowUpdateDebugInfo"},{"location":"swift/api/Workflow/structs/WorkflowUpdateDebugInfo/#properties","text":"","title":"Properties"},{"location":"swift/api/Workflow/structs/WorkflowUpdateDebugInfo/#workflowtype","text":"","title":"workflowType"},{"location":"swift/api/Workflow/structs/WorkflowUpdateDebugInfo/#kind","text":"","title":"kind"},{"location":"swift/api/Workflow/typealiases/AnyWorkflow.Output/","text":"TYPEALIAS AnyWorkflow.Output \u00b6","title":"AnyWorkflow.Output"},{"location":"swift/api/Workflow/typealiases/AnyWorkflow.Output/#anyworkflowoutput","text":"","title":"AnyWorkflow.Output"},{"location":"swift/api/Workflow/typealiases/AnyWorkflow.Rendering/","text":"TYPEALIAS AnyWorkflow.Rendering \u00b6","title":"AnyWorkflow.Rendering"},{"location":"swift/api/Workflow/typealiases/AnyWorkflow.Rendering/#anyworkflowrendering","text":"","title":"AnyWorkflow.Rendering"},{"location":"swift/api/Workflow/typealiases/AnyWorkflow.State/","text":"TYPEALIAS AnyWorkflow.State \u00b6","title":"AnyWorkflow.State"},{"location":"swift/api/Workflow/typealiases/AnyWorkflow.State/#anyworkflowstate","text":"","title":"AnyWorkflow.State"},{"location":"swift/api/WorkflowReactiveSwift/","text":"Reference Documentation \u00b6 Protocols \u00b6 Worker Enums \u00b6 WorkerLogging Extensions \u00b6 Signal SignalProducer Worker WorkerLogging Typealiases \u00b6 SignalProducerWorkflow.Output SignalProducerWorkflow.Rendering SignalProducerWorkflow.State This file was generated by SourceDocs on 2024-02-09 02:30:04 +0000","title":"WorkflowReactiveSwift"},{"location":"swift/api/WorkflowReactiveSwift/#reference-documentation","text":"","title":"Reference Documentation"},{"location":"swift/api/WorkflowReactiveSwift/#protocols","text":"Worker","title":"Protocols"},{"location":"swift/api/WorkflowReactiveSwift/#enums","text":"WorkerLogging","title":"Enums"},{"location":"swift/api/WorkflowReactiveSwift/#extensions","text":"Signal SignalProducer Worker WorkerLogging","title":"Extensions"},{"location":"swift/api/WorkflowReactiveSwift/#typealiases","text":"SignalProducerWorkflow.Output SignalProducerWorkflow.Rendering SignalProducerWorkflow.State This file was generated by SourceDocs on 2024-02-09 02:30:04 +0000","title":"Typealiases"},{"location":"swift/api/WorkflowReactiveSwift/enums/WorkerLogging/","text":"ENUM WorkerLogging \u00b6","title":"WorkerLogging"},{"location":"swift/api/WorkflowReactiveSwift/enums/WorkerLogging/#workerlogging","text":"","title":"WorkerLogging"},{"location":"swift/api/WorkflowReactiveSwift/extensions/Signal/","text":"EXTENSION Signal \u00b6 Methods \u00b6 asAnyWorkflow() \u00b6","title":"Signal"},{"location":"swift/api/WorkflowReactiveSwift/extensions/Signal/#signal","text":"","title":"Signal"},{"location":"swift/api/WorkflowReactiveSwift/extensions/Signal/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowReactiveSwift/extensions/Signal/#asanyworkflow","text":"","title":"asAnyWorkflow()"},{"location":"swift/api/WorkflowReactiveSwift/extensions/SignalProducer/","text":"EXTENSION SignalProducer \u00b6 Methods \u00b6 asAnyWorkflow() \u00b6","title":"SignalProducer"},{"location":"swift/api/WorkflowReactiveSwift/extensions/SignalProducer/#signalproducer","text":"","title":"SignalProducer"},{"location":"swift/api/WorkflowReactiveSwift/extensions/SignalProducer/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowReactiveSwift/extensions/SignalProducer/#asanyworkflow","text":"","title":"asAnyWorkflow()"},{"location":"swift/api/WorkflowReactiveSwift/extensions/Worker/","text":"EXTENSION Worker \u00b6 Methods \u00b6 asAnyWorkflow() \u00b6 isEquivalent(to:) \u00b6","title":"Worker"},{"location":"swift/api/WorkflowReactiveSwift/extensions/Worker/#worker","text":"","title":"Worker"},{"location":"swift/api/WorkflowReactiveSwift/extensions/Worker/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowReactiveSwift/extensions/Worker/#asanyworkflow","text":"","title":"asAnyWorkflow()"},{"location":"swift/api/WorkflowReactiveSwift/extensions/Worker/#isequivalentto","text":"","title":"isEquivalent(to:)"},{"location":"swift/api/WorkflowReactiveSwift/extensions/WorkerLogging/","text":"EXTENSION WorkerLogging \u00b6 Properties \u00b6 enabled \u00b6","title":"WorkerLogging"},{"location":"swift/api/WorkflowReactiveSwift/extensions/WorkerLogging/#workerlogging","text":"","title":"WorkerLogging"},{"location":"swift/api/WorkflowReactiveSwift/extensions/WorkerLogging/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowReactiveSwift/extensions/WorkerLogging/#enabled","text":"","title":"enabled"},{"location":"swift/api/WorkflowReactiveSwift/protocols/Worker/","text":"PROTOCOL Worker \u00b6 Workers define a unit of asynchronous work. During a render pass, a workflow can ask the context to await the result of a worker. When this occurs, the context checks to see if there is already a running worker of the same type. If there is, and if the workers are \u2018equivalent\u2019, the context leaves the existing worker running. If there is not an existing worker of this type, the context will kick off the new worker (via run ). Methods \u00b6 run() \u00b6 Returns a signal producer to execute the work represented by this worker. isEquivalent(to:) \u00b6 Returns true if the other worker should be considered equivalent to self . Equivalence should take into account whatever data is meaningful to the task. For example, a worker that loads a user account from a server would not be equivalent to another worker with a different user ID.","title":"Worker"},{"location":"swift/api/WorkflowReactiveSwift/protocols/Worker/#worker","text":"Workers define a unit of asynchronous work. During a render pass, a workflow can ask the context to await the result of a worker. When this occurs, the context checks to see if there is already a running worker of the same type. If there is, and if the workers are \u2018equivalent\u2019, the context leaves the existing worker running. If there is not an existing worker of this type, the context will kick off the new worker (via run ).","title":"Worker"},{"location":"swift/api/WorkflowReactiveSwift/protocols/Worker/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowReactiveSwift/protocols/Worker/#run","text":"Returns a signal producer to execute the work represented by this worker.","title":"run()"},{"location":"swift/api/WorkflowReactiveSwift/protocols/Worker/#isequivalentto","text":"Returns true if the other worker should be considered equivalent to self . Equivalence should take into account whatever data is meaningful to the task. For example, a worker that loads a user account from a server would not be equivalent to another worker with a different user ID.","title":"isEquivalent(to:)"},{"location":"swift/api/WorkflowReactiveSwift/typealiases/SignalProducerWorkflow.Output/","text":"TYPEALIAS SignalProducerWorkflow.Output \u00b6","title":"SignalProducerWorkflow.Output"},{"location":"swift/api/WorkflowReactiveSwift/typealiases/SignalProducerWorkflow.Output/#signalproducerworkflowoutput","text":"","title":"SignalProducerWorkflow.Output"},{"location":"swift/api/WorkflowReactiveSwift/typealiases/SignalProducerWorkflow.Rendering/","text":"TYPEALIAS SignalProducerWorkflow.Rendering \u00b6","title":"SignalProducerWorkflow.Rendering"},{"location":"swift/api/WorkflowReactiveSwift/typealiases/SignalProducerWorkflow.Rendering/#signalproducerworkflowrendering","text":"","title":"SignalProducerWorkflow.Rendering"},{"location":"swift/api/WorkflowReactiveSwift/typealiases/SignalProducerWorkflow.State/","text":"TYPEALIAS SignalProducerWorkflow.State \u00b6","title":"SignalProducerWorkflow.State"},{"location":"swift/api/WorkflowReactiveSwift/typealiases/SignalProducerWorkflow.State/#signalproducerworkflowstate","text":"","title":"SignalProducerWorkflow.State"},{"location":"swift/api/WorkflowTesting/","text":"Reference Documentation \u00b6 Structs \u00b6 RenderTester RenderTesterResult WorkflowActionTester Extensions \u00b6 RenderTesterResult Workflow WorkflowAction WorkflowActionTester This file was generated by SourceDocs on 2024-02-09 02:29:50 +0000","title":"WorkflowTesting "},{"location":"swift/api/WorkflowTesting/#reference-documentation","text":"","title":"Reference Documentation"},{"location":"swift/api/WorkflowTesting/#structs","text":"RenderTester RenderTesterResult WorkflowActionTester","title":"Structs"},{"location":"swift/api/WorkflowTesting/#extensions","text":"RenderTesterResult Workflow WorkflowAction WorkflowActionTester This file was generated by SourceDocs on 2024-02-09 02:29:50 +0000","title":"Extensions"},{"location":"swift/api/WorkflowTesting/extensions/RenderTesterResult/","text":"EXTENSION RenderTesterResult \u00b6 Methods \u00b6 assert(state:file:line:) \u00b6 Verifies that the resulting state is equal to the given state. assertStateModifications(file:line:_:) \u00b6 Exhaustive state testing against the initial state. - Parameters: - modifications: A function that receives the initial state and is expected to mutate it to match the new state. assert(output:file:line:) \u00b6 Verifies that the resulting output is equal to the given output.","title":"RenderTesterResult"},{"location":"swift/api/WorkflowTesting/extensions/RenderTesterResult/#rendertesterresult","text":"","title":"RenderTesterResult"},{"location":"swift/api/WorkflowTesting/extensions/RenderTesterResult/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowTesting/extensions/RenderTesterResult/#assertstatefileline","text":"Verifies that the resulting state is equal to the given state.","title":"assert(state:file:line:)"},{"location":"swift/api/WorkflowTesting/extensions/RenderTesterResult/#assertstatemodificationsfileline_","text":"Exhaustive state testing against the initial state. - Parameters: - modifications: A function that receives the initial state and is expected to mutate it to match the new state.","title":"assertStateModifications(file:line:_:)"},{"location":"swift/api/WorkflowTesting/extensions/RenderTesterResult/#assertoutputfileline","text":"Verifies that the resulting output is equal to the given output.","title":"assert(output:file:line:)"},{"location":"swift/api/WorkflowTesting/extensions/Workflow/","text":"EXTENSION Workflow \u00b6 Methods \u00b6 renderTester(initialState:) \u00b6 Returns a RenderTester with a specified initial state. renderTester() \u00b6 Returns a RenderTester with an initial state provided by self.makeInitialState()","title":"Workflow"},{"location":"swift/api/WorkflowTesting/extensions/Workflow/#workflow","text":"","title":"Workflow"},{"location":"swift/api/WorkflowTesting/extensions/Workflow/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowTesting/extensions/Workflow/#rendertesterinitialstate","text":"Returns a RenderTester with a specified initial state.","title":"renderTester(initialState:)"},{"location":"swift/api/WorkflowTesting/extensions/Workflow/#rendertester","text":"Returns a RenderTester with an initial state provided by self.makeInitialState()","title":"renderTester()"},{"location":"swift/api/WorkflowTesting/extensions/WorkflowAction/","text":"EXTENSION WorkflowAction \u00b6 Methods \u00b6 tester(withState:) \u00b6 Returns a state tester containing self .","title":"WorkflowAction"},{"location":"swift/api/WorkflowTesting/extensions/WorkflowAction/#workflowaction","text":"","title":"WorkflowAction"},{"location":"swift/api/WorkflowTesting/extensions/WorkflowAction/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowTesting/extensions/WorkflowAction/#testerwithstate","text":"Returns a state tester containing self .","title":"tester(withState:)"},{"location":"swift/api/WorkflowTesting/extensions/WorkflowActionTester/","text":"EXTENSION WorkflowActionTester \u00b6 Methods \u00b6 assert(state:file:line:) \u00b6 Triggers a test failure if the current state does not match the given expected state Parameters: expectedState: The expected state returns: A tester containing the current state and output. assert(output:file:line:) \u00b6 Triggers a test failure if the produced output does not match the given expected output Parameters: expectedState: The expected output returns: A tester containing the current state and output.","title":"WorkflowActionTester"},{"location":"swift/api/WorkflowTesting/extensions/WorkflowActionTester/#workflowactiontester","text":"","title":"WorkflowActionTester"},{"location":"swift/api/WorkflowTesting/extensions/WorkflowActionTester/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowTesting/extensions/WorkflowActionTester/#assertstatefileline","text":"Triggers a test failure if the current state does not match the given expected state Parameters: expectedState: The expected state returns: A tester containing the current state and output.","title":"assert(state:file:line:)"},{"location":"swift/api/WorkflowTesting/extensions/WorkflowActionTester/#assertoutputfileline","text":"Triggers a test failure if the produced output does not match the given expected output Parameters: expectedState: The expected output returns: A tester containing the current state and output.","title":"assert(output:file:line:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTester/","text":"STRUCT RenderTester \u00b6 Testing helper for validating the behavior of calls to render . Usage: expect workflows and side effects then validate with a call to render and the resulting RenderTesterResult . Side-effects may be performed against the rendering to validate the behavior of actions. To directly test actions and their effects, use the WorkflowActionTester . workflow .renderTester(initialState: TestWorkflow.State()) .expect( worker: TestWorker(), producingOutput: TestWorker.Output.success ) .expectWorkflow( type: ChildWorkflow.self, key: \"key\", rendering: \"rendering\", // \u26a0\ufe0f N.B. Only one output per call to `render` may be produced, // even if multiple child Workflows are expected in a call // to `render`. This is an invariant enforced by `RenderTester` // and the real runtime. producingOutput: nil ) .render { rendering in XCTAssertEqual(\"expected text on rendering\", rendering.text) } .assert(state: TestWorkflow.State()) .assert(output: TestWorkflow.Output.finished) Validating the rendering only from the initial state provided by the workflow: workflow .renderTester() .render { rendering in XCTAssertEqual(\"expected text on rendering\", rendering.text) } Validate the state was updated from a callback on the rendering: workflow .renderTester() .render { rendering in XCTAssertEqual(\"expected text on rendering\", rendering.text) rendering.updateText(\"updated\") } .assert( state: TestWorkflow.State(text: \"updated\") ) Validate an output was received from the workflow. The action() on the rendering will cause an action that will return an output. workflow .renderTester() .render { rendering in rendering.action() } .assert( output: .success ) Validate a worker is running, and simulate the effect of its output: workflow .renderTester(initialState: TestWorkflow.State(loadingState: .loading)) .expect( worker: TestWorker(), output: TestWorker.Output.success ) .render { _ in } Validate a child workflow is run, and simulate the effect of its output: workflow .renderTester(initialState: TestWorkflow.State(loadingState: .loading)) .expectWorkflow( type: ChildWorkflow.self, rendering: \"rendering\", producingOutput: ChildWorkflow.Output.success ) .render { _ in } Methods \u00b6 expectWorkflow(type:key:producingRendering:producingOutput:file:line:assertions:) \u00b6 Expect the given workflow type in the next rendering. Parameters: type: The type of the expected workflow. key: The key of the expected workflow (if specified). rendering: The rendering result that should be returned when the workflow of this type is rendered. output: An output that should be returned after the workflow of this type is rendered, if any. assertions: Additional assertions for the given workflow, if any. You may use this to assert the properties of the requested workflow are as expected. expectWorkflowIgnoringOutput(type:key:producingRendering:file:line:assertions:) \u00b6 Expect the given workflow type in the next rendering, with its output being ignored by a call to ignoringOutput() . Parameters: type: The type of the expected workflow. key: The key of the expected workflow (if specified). rendering: The rendering result that should be returned when the workflow of this type is rendered. assertions: Additional assertions for the given workflow, if any. You may use this to assert the properties of the requested workflow are as expected. expectSideEffect(key:file:line:) \u00b6 Expect a side-effect for the given key. Parameter key: The key to expect. expectSideEffect(key:producingAction:file:line:) \u00b6 Expect a side-effect for the given key, and produce the given action when it is requested. Parameters: key: The key to expect. action: The action to produce when this side-effect is requested. render(file:line:assertions:) \u00b6 Render the workflow under test. At this point, you should have set up all expectations. The given assertions closure will be called with the produced rendering, allowing you to assert its properties or perform actions on it (such as closures that are wired up to a Sink inside the workflow. Parameters: assertions: A closure called with the produced rendering for verification Returns: A RenderTesterResult that can be used to verify expected resulting state or outputs.","title":"RenderTester"},{"location":"swift/api/WorkflowTesting/structs/RenderTester/#rendertester","text":"Testing helper for validating the behavior of calls to render . Usage: expect workflows and side effects then validate with a call to render and the resulting RenderTesterResult . Side-effects may be performed against the rendering to validate the behavior of actions. To directly test actions and their effects, use the WorkflowActionTester . workflow .renderTester(initialState: TestWorkflow.State()) .expect( worker: TestWorker(), producingOutput: TestWorker.Output.success ) .expectWorkflow( type: ChildWorkflow.self, key: \"key\", rendering: \"rendering\", // \u26a0\ufe0f N.B. Only one output per call to `render` may be produced, // even if multiple child Workflows are expected in a call // to `render`. This is an invariant enforced by `RenderTester` // and the real runtime. producingOutput: nil ) .render { rendering in XCTAssertEqual(\"expected text on rendering\", rendering.text) } .assert(state: TestWorkflow.State()) .assert(output: TestWorkflow.Output.finished) Validating the rendering only from the initial state provided by the workflow: workflow .renderTester() .render { rendering in XCTAssertEqual(\"expected text on rendering\", rendering.text) } Validate the state was updated from a callback on the rendering: workflow .renderTester() .render { rendering in XCTAssertEqual(\"expected text on rendering\", rendering.text) rendering.updateText(\"updated\") } .assert( state: TestWorkflow.State(text: \"updated\") ) Validate an output was received from the workflow. The action() on the rendering will cause an action that will return an output. workflow .renderTester() .render { rendering in rendering.action() } .assert( output: .success ) Validate a worker is running, and simulate the effect of its output: workflow .renderTester(initialState: TestWorkflow.State(loadingState: .loading)) .expect( worker: TestWorker(), output: TestWorker.Output.success ) .render { _ in } Validate a child workflow is run, and simulate the effect of its output: workflow .renderTester(initialState: TestWorkflow.State(loadingState: .loading)) .expectWorkflow( type: ChildWorkflow.self, rendering: \"rendering\", producingOutput: ChildWorkflow.Output.success ) .render { _ in }","title":"RenderTester"},{"location":"swift/api/WorkflowTesting/structs/RenderTester/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowTesting/structs/RenderTester/#expectworkflowtypekeyproducingrenderingproducingoutputfilelineassertions","text":"Expect the given workflow type in the next rendering. Parameters: type: The type of the expected workflow. key: The key of the expected workflow (if specified). rendering: The rendering result that should be returned when the workflow of this type is rendered. output: An output that should be returned after the workflow of this type is rendered, if any. assertions: Additional assertions for the given workflow, if any. You may use this to assert the properties of the requested workflow are as expected.","title":"expectWorkflow(type:key:producingRendering:producingOutput:file:line:assertions:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTester/#expectworkflowignoringoutputtypekeyproducingrenderingfilelineassertions","text":"Expect the given workflow type in the next rendering, with its output being ignored by a call to ignoringOutput() . Parameters: type: The type of the expected workflow. key: The key of the expected workflow (if specified). rendering: The rendering result that should be returned when the workflow of this type is rendered. assertions: Additional assertions for the given workflow, if any. You may use this to assert the properties of the requested workflow are as expected.","title":"expectWorkflowIgnoringOutput(type:key:producingRendering:file:line:assertions:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTester/#expectsideeffectkeyfileline","text":"Expect a side-effect for the given key. Parameter key: The key to expect.","title":"expectSideEffect(key:file:line:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTester/#expectsideeffectkeyproducingactionfileline","text":"Expect a side-effect for the given key, and produce the given action when it is requested. Parameters: key: The key to expect. action: The action to produce when this side-effect is requested.","title":"expectSideEffect(key:producingAction:file:line:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTester/#renderfilelineassertions","text":"Render the workflow under test. At this point, you should have set up all expectations. The given assertions closure will be called with the produced rendering, allowing you to assert its properties or perform actions on it (such as closures that are wired up to a Sink inside the workflow. Parameters: assertions: A closure called with the produced rendering for verification Returns: A RenderTesterResult that can be used to verify expected resulting state or outputs.","title":"render(file:line:assertions:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTesterResult/","text":"STRUCT RenderTesterResult \u00b6 The result of a RenderTester rendering. Used to verify state, output, and actions that were produced as a result of actions performed during the render (such as child workflow output being produced). Methods \u00b6 verifyState(file:line:assertions:) \u00b6 Allows for assertions against the resulting state. assertNoAction(file:line:) \u00b6 Asserts that no actions were produced verifyAction(type:file:line:assertions:) \u00b6 Allows for assertions agains the resulting action assert(action:file:line:) \u00b6 Asserts that the resulting action is equal to the given action. assertNoOutput(file:line:) \u00b6 Asserts that no output was produced. verifyOutput(file:line:assertions:) \u00b6 Allows for assertions agains the resulting output","title":"RenderTesterResult"},{"location":"swift/api/WorkflowTesting/structs/RenderTesterResult/#rendertesterresult","text":"The result of a RenderTester rendering. Used to verify state, output, and actions that were produced as a result of actions performed during the render (such as child workflow output being produced).","title":"RenderTesterResult"},{"location":"swift/api/WorkflowTesting/structs/RenderTesterResult/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowTesting/structs/RenderTesterResult/#verifystatefilelineassertions","text":"Allows for assertions against the resulting state.","title":"verifyState(file:line:assertions:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTesterResult/#assertnoactionfileline","text":"Asserts that no actions were produced","title":"assertNoAction(file:line:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTesterResult/#verifyactiontypefilelineassertions","text":"Allows for assertions agains the resulting action","title":"verifyAction(type:file:line:assertions:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTesterResult/#assertactionfileline","text":"Asserts that the resulting action is equal to the given action.","title":"assert(action:file:line:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTesterResult/#assertnooutputfileline","text":"Asserts that no output was produced.","title":"assertNoOutput(file:line:)"},{"location":"swift/api/WorkflowTesting/structs/RenderTesterResult/#verifyoutputfilelineassertions","text":"Allows for assertions agains the resulting output","title":"verifyOutput(file:line:assertions:)"},{"location":"swift/api/WorkflowTesting/structs/WorkflowActionTester/","text":"STRUCT WorkflowActionTester \u00b6 Testing helper that chains action sending and state/output assertions to make tests easier to write. MyWorkflow.Action .tester(withState: .firstState) .send(action: .exampleAction) .verifyOutput { output in XCTAssertEqual(.finished, output) } .verifyState { state in XCTAssertEqual(.differentState, state) } Or to assert that an action produces no output: MyWorkflow.Action .tester(withState: .firstState) .send(action: .actionProducingNoOutput) .assertNoOutput() .verifyState { state in XCTAssertEqual(.differentState, state) } If your State or Output are Equatable , you can use the convenience assertion methods: MyWorkflow.Action .tester(withState: .firstState) .send(action: .exampleAction) .assert(output: .finished) .assert(state: .differentState) Methods \u00b6 send(action:) \u00b6 Sends an action to the reducer. parameter action: The action to send. returns: A new state tester containing the state and output (if any) after the update. assertNoOutput(file:line:) \u00b6 Asserts that the action produced no output returns: A tester containing the current state and output. verifyOutput(file:line:_:) \u00b6 Invokes the given closure (which is intended to contain test assertions) with the produced output. If the previous action produced no output, the triggers a test failure and does not execute the closure. parameter assertions: A closure that accepts a single output value. returns: A tester containing the current state and output. verifyState(_:) \u00b6 Invokes the given closure (which is intended to contain test assertions) with the current state. parameter assertions: A closure that accepts a single state value. returns: A tester containing the current state and output.","title":"WorkflowActionTester"},{"location":"swift/api/WorkflowTesting/structs/WorkflowActionTester/#workflowactiontester","text":"Testing helper that chains action sending and state/output assertions to make tests easier to write. MyWorkflow.Action .tester(withState: .firstState) .send(action: .exampleAction) .verifyOutput { output in XCTAssertEqual(.finished, output) } .verifyState { state in XCTAssertEqual(.differentState, state) } Or to assert that an action produces no output: MyWorkflow.Action .tester(withState: .firstState) .send(action: .actionProducingNoOutput) .assertNoOutput() .verifyState { state in XCTAssertEqual(.differentState, state) } If your State or Output are Equatable , you can use the convenience assertion methods: MyWorkflow.Action .tester(withState: .firstState) .send(action: .exampleAction) .assert(output: .finished) .assert(state: .differentState)","title":"WorkflowActionTester"},{"location":"swift/api/WorkflowTesting/structs/WorkflowActionTester/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowTesting/structs/WorkflowActionTester/#sendaction","text":"Sends an action to the reducer. parameter action: The action to send. returns: A new state tester containing the state and output (if any) after the update.","title":"send(action:)"},{"location":"swift/api/WorkflowTesting/structs/WorkflowActionTester/#assertnooutputfileline","text":"Asserts that the action produced no output returns: A tester containing the current state and output.","title":"assertNoOutput(file:line:)"},{"location":"swift/api/WorkflowTesting/structs/WorkflowActionTester/#verifyoutputfileline_","text":"Invokes the given closure (which is intended to contain test assertions) with the produced output. If the previous action produced no output, the triggers a test failure and does not execute the closure. parameter assertions: A closure that accepts a single output value. returns: A tester containing the current state and output.","title":"verifyOutput(file:line:_:)"},{"location":"swift/api/WorkflowTesting/structs/WorkflowActionTester/#verifystate_","text":"Invokes the given closure (which is intended to contain test assertions) with the current state. parameter assertions: A closure that accepts a single state value. returns: A tester containing the current state and output.","title":"verifyState(_:)"},{"location":"swift/api/WorkflowUI/","text":"Reference Documentation \u00b6 Protocols \u00b6 Screen SingleScreenContaining UpdateChildScreenViewController WorkflowUIEvent WorkflowUIObserver Structs \u00b6 AdaptedEnvironmentScreen AnyScreen ViewControllerDescription ViewControllerDescription.KindIdentifier ViewDidAppearEvent ViewDidDisappearEvent ViewDidLayoutSubviewsEvent ViewWillAppearEvent ViewWillDisappearEvent ViewWillLayoutSubviewsEvent Classes \u00b6 DescribedViewController ScreenViewController WorkflowHostingController WorkflowUIViewController Enums \u00b6 WorkflowUIObservation Extensions \u00b6 AdaptedEnvironmentScreen AnyScreen Screen ScreenViewController SingleScreenContaining UpdateChildScreenViewController WorkflowHostingController Typealiases \u00b6 AdaptedEnvironmentScreen.Adapter WorkflowHostingController.CustomizeEnvironment This file was generated by SourceDocs on 2024-02-09 02:29:22 +0000","title":"WorkflowUI "},{"location":"swift/api/WorkflowUI/#reference-documentation","text":"","title":"Reference Documentation"},{"location":"swift/api/WorkflowUI/#protocols","text":"Screen SingleScreenContaining UpdateChildScreenViewController WorkflowUIEvent WorkflowUIObserver","title":"Protocols"},{"location":"swift/api/WorkflowUI/#structs","text":"AdaptedEnvironmentScreen AnyScreen ViewControllerDescription ViewControllerDescription.KindIdentifier ViewDidAppearEvent ViewDidDisappearEvent ViewDidLayoutSubviewsEvent ViewWillAppearEvent ViewWillDisappearEvent ViewWillLayoutSubviewsEvent","title":"Structs"},{"location":"swift/api/WorkflowUI/#classes","text":"DescribedViewController ScreenViewController WorkflowHostingController WorkflowUIViewController","title":"Classes"},{"location":"swift/api/WorkflowUI/#enums","text":"WorkflowUIObservation","title":"Enums"},{"location":"swift/api/WorkflowUI/#extensions","text":"AdaptedEnvironmentScreen AnyScreen Screen ScreenViewController SingleScreenContaining UpdateChildScreenViewController WorkflowHostingController","title":"Extensions"},{"location":"swift/api/WorkflowUI/#typealiases","text":"AdaptedEnvironmentScreen.Adapter WorkflowHostingController.CustomizeEnvironment This file was generated by SourceDocs on 2024-02-09 02:29:22 +0000","title":"Typealiases"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/","text":"CLASS DescribedViewController \u00b6 Properties \u00b6 childForStatusBarStyle \u00b6 childForStatusBarHidden \u00b6 childForHomeIndicatorAutoHidden \u00b6 childForScreenEdgesDeferringSystemGestures \u00b6 supportedInterfaceOrientations \u00b6 preferredStatusBarUpdateAnimation \u00b6 childViewControllerForPointerLock \u00b6 Methods \u00b6 init(description:) \u00b6 init(screen:environment:) \u00b6 update(description:) \u00b6 update(screen:environment:) \u00b6 viewDidLoad() \u00b6 viewDidLayoutSubviews() \u00b6 preferredContentSizeDidChange(forChildContentContainer:) \u00b6","title":"DescribedViewController"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#describedviewcontroller","text":"","title":"DescribedViewController"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#childforstatusbarstyle","text":"","title":"childForStatusBarStyle"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#childforstatusbarhidden","text":"","title":"childForStatusBarHidden"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#childforhomeindicatorautohidden","text":"","title":"childForHomeIndicatorAutoHidden"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#childforscreenedgesdeferringsystemgestures","text":"","title":"childForScreenEdgesDeferringSystemGestures"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#supportedinterfaceorientations","text":"","title":"supportedInterfaceOrientations"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#preferredstatusbarupdateanimation","text":"","title":"preferredStatusBarUpdateAnimation"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#childviewcontrollerforpointerlock","text":"","title":"childViewControllerForPointerLock"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#initdescription","text":"","title":"init(description:)"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#initscreenenvironment","text":"","title":"init(screen:environment:)"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#updatedescription","text":"","title":"update(description:)"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#updatescreenenvironment","text":"","title":"update(screen:environment:)"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#viewdidload","text":"","title":"viewDidLoad()"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#viewdidlayoutsubviews","text":"","title":"viewDidLayoutSubviews()"},{"location":"swift/api/WorkflowUI/classes/DescribedViewController/#preferredcontentsizedidchangeforchildcontentcontainer","text":"","title":"preferredContentSizeDidChange(forChildContentContainer:)"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/","text":"CLASS ScreenViewController \u00b6 Generic base class that can be subclassed in order to to define a UI implementation that is powered by the given screen type. Using this base class, a screen can be implemented as: struct MyScreen: Screen { func viewControllerDescription(environment: ViewEnvironment) -> ViewControllerDescription { return MyScreenViewController.description(for: self, environment: environment) } } private class MyScreenViewController: ScreenViewController { override func screenDidChange(from previousScreen: MyScreen, previousEnvironment: ViewEnvironment) { // \u2026 update views as necessary } } Properties \u00b6 screen \u00b6 screenType \u00b6 Methods \u00b6 init(screen:environment:) \u00b6 init(coder:) \u00b6 update(screen:) \u00b6 screenDidChange(from:previousEnvironment:) \u00b6 Subclasses should override this method in order to update any relevant UI bits when the screen model changes.","title":"ScreenViewController"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/#screenviewcontroller","text":"Generic base class that can be subclassed in order to to define a UI implementation that is powered by the given screen type. Using this base class, a screen can be implemented as: struct MyScreen: Screen { func viewControllerDescription(environment: ViewEnvironment) -> ViewControllerDescription { return MyScreenViewController.description(for: self, environment: environment) } } private class MyScreenViewController: ScreenViewController { override func screenDidChange(from previousScreen: MyScreen, previousEnvironment: ViewEnvironment) { // \u2026 update views as necessary } }","title":"ScreenViewController"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/#screen","text":"","title":"screen"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/#screentype","text":"","title":"screenType"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/#initscreenenvironment","text":"","title":"init(screen:environment:)"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/#initcoder","text":"","title":"init(coder:)"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/#updatescreen","text":"","title":"update(screen:)"},{"location":"swift/api/WorkflowUI/classes/ScreenViewController/#screendidchangefrompreviousenvironment","text":"Subclasses should override this method in order to update any relevant UI bits when the screen model changes.","title":"screenDidChange(from:previousEnvironment:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/","text":"CLASS WorkflowHostingController \u00b6 Drives view controllers from a root Workflow. Properties \u00b6 output \u00b6 Emits output events from the bound workflow. customizeEnvironment \u00b6 An environment customization that will be applied to the environment of the root screen. screen \u00b6 The currently displayed screen - the most recent rendering from the hosted workflow childForStatusBarStyle \u00b6 childForStatusBarHidden \u00b6 childForHomeIndicatorAutoHidden \u00b6 childForScreenEdgesDeferringSystemGestures \u00b6 supportedInterfaceOrientations \u00b6 preferredStatusBarUpdateAnimation \u00b6 childViewControllerForPointerLock \u00b6 Methods \u00b6 init(workflow:customizeEnvironment:observers:) \u00b6 update(workflow:) \u00b6 Updates the root Workflow in this container. init(coder:) \u00b6 viewDidLoad() \u00b6 viewWillLayoutSubviews() \u00b6 viewDidLayoutSubviews() \u00b6 preferredContentSizeDidChange(forChildContentContainer:) \u00b6","title":"WorkflowHostingController"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#workflowhostingcontroller","text":"Drives view controllers from a root Workflow.","title":"WorkflowHostingController"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#output","text":"Emits output events from the bound workflow.","title":"output"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#customizeenvironment","text":"An environment customization that will be applied to the environment of the root screen.","title":"customizeEnvironment"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#screen","text":"The currently displayed screen - the most recent rendering from the hosted workflow","title":"screen"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#childforstatusbarstyle","text":"","title":"childForStatusBarStyle"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#childforstatusbarhidden","text":"","title":"childForStatusBarHidden"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#childforhomeindicatorautohidden","text":"","title":"childForHomeIndicatorAutoHidden"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#childforscreenedgesdeferringsystemgestures","text":"","title":"childForScreenEdgesDeferringSystemGestures"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#supportedinterfaceorientations","text":"","title":"supportedInterfaceOrientations"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#preferredstatusbarupdateanimation","text":"","title":"preferredStatusBarUpdateAnimation"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#childviewcontrollerforpointerlock","text":"","title":"childViewControllerForPointerLock"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#initworkflowcustomizeenvironmentobservers","text":"","title":"init(workflow:customizeEnvironment:observers:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#updateworkflow","text":"Updates the root Workflow in this container.","title":"update(workflow:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#initcoder","text":"","title":"init(coder:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#viewdidload","text":"","title":"viewDidLoad()"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#viewwilllayoutsubviews","text":"","title":"viewWillLayoutSubviews()"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#viewdidlayoutsubviews","text":"","title":"viewDidLayoutSubviews()"},{"location":"swift/api/WorkflowUI/classes/WorkflowHostingController/#preferredcontentsizedidchangeforchildcontentcontainer","text":"","title":"preferredContentSizeDidChange(forChildContentContainer:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/","text":"CLASS WorkflowUIViewController \u00b6 Ancestor type from which all ViewControllers in WorkflowUI inherit. Properties \u00b6 hasViewAppeared \u00b6 Set to true once viewDidAppear has been called Methods \u00b6 sendObservationEvent(_:) \u00b6 Observation event emission point. - Parameter event: The event forwarded to any observers. viewWillAppear(_:) \u00b6 viewDidAppear(_:) \u00b6 viewWillDisappear(_:) \u00b6 viewDidDisappear(_:) \u00b6 viewWillLayoutSubviews() \u00b6 viewDidLayoutSubviews() \u00b6","title":"WorkflowUIViewController"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#workflowuiviewcontroller","text":"Ancestor type from which all ViewControllers in WorkflowUI inherit.","title":"WorkflowUIViewController"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#hasviewappeared","text":"Set to true once viewDidAppear has been called","title":"hasViewAppeared"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#sendobservationevent_","text":"Observation event emission point. - Parameter event: The event forwarded to any observers.","title":"sendObservationEvent(_:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#viewwillappear_","text":"","title":"viewWillAppear(_:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#viewdidappear_","text":"","title":"viewDidAppear(_:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#viewwilldisappear_","text":"","title":"viewWillDisappear(_:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#viewdiddisappear_","text":"","title":"viewDidDisappear(_:)"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#viewwilllayoutsubviews","text":"","title":"viewWillLayoutSubviews()"},{"location":"swift/api/WorkflowUI/classes/WorkflowUIViewController/#viewdidlayoutsubviews","text":"","title":"viewDidLayoutSubviews()"},{"location":"swift/api/WorkflowUI/enums/WorkflowUIObservation/","text":"ENUM WorkflowUIObservation \u00b6 Properties \u00b6 sharedUIObserver \u00b6 The shared WorkflowUIObserver instance to which all WorkflowUIEvent s will be forwarded.","title":"WorkflowUIObservation"},{"location":"swift/api/WorkflowUI/enums/WorkflowUIObservation/#workflowuiobservation","text":"","title":"WorkflowUIObservation"},{"location":"swift/api/WorkflowUI/enums/WorkflowUIObservation/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/enums/WorkflowUIObservation/#shareduiobserver","text":"The shared WorkflowUIObserver instance to which all WorkflowUIEvent s will be forwarded.","title":"sharedUIObserver"},{"location":"swift/api/WorkflowUI/extensions/AdaptedEnvironmentScreen/","text":"EXTENSION AdaptedEnvironmentScreen \u00b6 Methods \u00b6 viewControllerDescription(environment:) \u00b6","title":"AdaptedEnvironmentScreen"},{"location":"swift/api/WorkflowUI/extensions/AdaptedEnvironmentScreen/#adaptedenvironmentscreen","text":"","title":"AdaptedEnvironmentScreen"},{"location":"swift/api/WorkflowUI/extensions/AdaptedEnvironmentScreen/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/extensions/AdaptedEnvironmentScreen/#viewcontrollerdescriptionenvironment","text":"","title":"viewControllerDescription(environment:)"},{"location":"swift/api/WorkflowUI/extensions/AnyScreen/","text":"EXTENSION AnyScreen \u00b6 Properties \u00b6 primaryScreen \u00b6","title":"AnyScreen"},{"location":"swift/api/WorkflowUI/extensions/AnyScreen/#anyscreen","text":"","title":"AnyScreen"},{"location":"swift/api/WorkflowUI/extensions/AnyScreen/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/extensions/AnyScreen/#primaryscreen","text":"","title":"primaryScreen"},{"location":"swift/api/WorkflowUI/extensions/Screen/","text":"EXTENSION Screen \u00b6 Methods \u00b6 adaptedEnvironment(key:value:) \u00b6 Wraps this screen in an AdaptedEnvironmentScreen with the given environment key and value. adaptedEnvironment(keyPath:value:) \u00b6 Wraps this screen in an AdaptedEnvironmentScreen with the given keypath and value. adaptedEnvironment(adapting:) \u00b6 Wraps this screen in an AdaptedEnvironmentScreen with the given configuration block. asAnyScreen() \u00b6 Wraps the screen in an AnyScreen canUpdate(viewController:with:) \u00b6 If the given view controller is of the correct type to be updated by this screen. If your view controller type can change between updates, call this method before invoking update(viewController:with:) . update(viewController:with:) \u00b6 Update the given view controller with the content from the screen. Note \u00b6 You must pass a view controller previously created by a compatible ViewControllerDescription that passes canUpdate(viewController:with:) . Failure to do so will result in a fatal precondition. buildViewController(in:) \u00b6 Construct and update a new view controller as described by this Screen. The view controller will be updated before it is returned, so it is fully configured and prepared for display.","title":"Screen"},{"location":"swift/api/WorkflowUI/extensions/Screen/#screen","text":"","title":"Screen"},{"location":"swift/api/WorkflowUI/extensions/Screen/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/extensions/Screen/#adaptedenvironmentkeyvalue","text":"Wraps this screen in an AdaptedEnvironmentScreen with the given environment key and value.","title":"adaptedEnvironment(key:value:)"},{"location":"swift/api/WorkflowUI/extensions/Screen/#adaptedenvironmentkeypathvalue","text":"Wraps this screen in an AdaptedEnvironmentScreen with the given keypath and value.","title":"adaptedEnvironment(keyPath:value:)"},{"location":"swift/api/WorkflowUI/extensions/Screen/#adaptedenvironmentadapting","text":"Wraps this screen in an AdaptedEnvironmentScreen with the given configuration block.","title":"adaptedEnvironment(adapting:)"},{"location":"swift/api/WorkflowUI/extensions/Screen/#asanyscreen","text":"Wraps the screen in an AnyScreen","title":"asAnyScreen()"},{"location":"swift/api/WorkflowUI/extensions/Screen/#canupdateviewcontrollerwith","text":"If the given view controller is of the correct type to be updated by this screen. If your view controller type can change between updates, call this method before invoking update(viewController:with:) .","title":"canUpdate(viewController:with:)"},{"location":"swift/api/WorkflowUI/extensions/Screen/#updateviewcontrollerwith","text":"Update the given view controller with the content from the screen.","title":"update(viewController:with:)"},{"location":"swift/api/WorkflowUI/extensions/Screen/#note","text":"You must pass a view controller previously created by a compatible ViewControllerDescription that passes canUpdate(viewController:with:) . Failure to do so will result in a fatal precondition.","title":"Note"},{"location":"swift/api/WorkflowUI/extensions/Screen/#buildviewcontrollerin","text":"Construct and update a new view controller as described by this Screen. The view controller will be updated before it is returned, so it is fully configured and prepared for display.","title":"buildViewController(in:)"},{"location":"swift/api/WorkflowUI/extensions/ScreenViewController/","text":"EXTENSION ScreenViewController \u00b6 Properties \u00b6 primaryScreen \u00b6 Methods \u00b6 description(for:environment:performInitialUpdate:) \u00b6 Convenience to create a view controller description for the given screen value. See the example on the comment for ScreenViewController for usage.","title":"ScreenViewController"},{"location":"swift/api/WorkflowUI/extensions/ScreenViewController/#screenviewcontroller","text":"","title":"ScreenViewController"},{"location":"swift/api/WorkflowUI/extensions/ScreenViewController/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/extensions/ScreenViewController/#primaryscreen","text":"","title":"primaryScreen"},{"location":"swift/api/WorkflowUI/extensions/ScreenViewController/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/extensions/ScreenViewController/#descriptionforenvironmentperforminitialupdate","text":"Convenience to create a view controller description for the given screen value. See the example on the comment for ScreenViewController for usage.","title":"description(for:environment:performInitialUpdate:)"},{"location":"swift/api/WorkflowUI/extensions/SingleScreenContaining/","text":"EXTENSION SingleScreenContaining \u00b6 Methods \u00b6 findInnermostPrimaryScreen() \u00b6 Iteratively traverses a sequence of primaryScreen values until one is found that does not conform to SingleScreenContaining . Put another way, this returns the first primaryScreen that is a Screen and not a SingleScreenContaining type.","title":"SingleScreenContaining"},{"location":"swift/api/WorkflowUI/extensions/SingleScreenContaining/#singlescreencontaining","text":"","title":"SingleScreenContaining"},{"location":"swift/api/WorkflowUI/extensions/SingleScreenContaining/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/extensions/SingleScreenContaining/#findinnermostprimaryscreen","text":"Iteratively traverses a sequence of primaryScreen values until one is found that does not conform to SingleScreenContaining . Put another way, this returns the first primaryScreen that is a Screen and not a SingleScreenContaining type.","title":"findInnermostPrimaryScreen()"},{"location":"swift/api/WorkflowUI/extensions/UpdateChildScreenViewController/","text":"EXTENSION UpdateChildScreenViewController \u00b6 Methods \u00b6 update(child:with:in:onChange:) \u00b6 Updates the view controller at the given child key path with the ViewControllerDescription from screen . If the type of the underlying view controller changes between update passes, this method will remove the old view controller, create a new one, update it, and insert it into the view controller hierarchy. The view controller at child must be a child of self . Parameters: parameter child: The KeyPath which describes what view controller to update. This view controller must be a direct child of self . parameter screen: The Screen instance to apply to the view controller. parameter environment: The environment to used when updating the view controller. parameter onChange: A callback called if the view controller instance changed.","title":"UpdateChildScreenViewController"},{"location":"swift/api/WorkflowUI/extensions/UpdateChildScreenViewController/#updatechildscreenviewcontroller","text":"","title":"UpdateChildScreenViewController"},{"location":"swift/api/WorkflowUI/extensions/UpdateChildScreenViewController/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/extensions/UpdateChildScreenViewController/#updatechildwithinonchange","text":"Updates the view controller at the given child key path with the ViewControllerDescription from screen . If the type of the underlying view controller changes between update passes, this method will remove the old view controller, create a new one, update it, and insert it into the view controller hierarchy. The view controller at child must be a child of self . Parameters: parameter child: The KeyPath which describes what view controller to update. This view controller must be a direct child of self . parameter screen: The Screen instance to apply to the view controller. parameter environment: The environment to used when updating the view controller. parameter onChange: A callback called if the view controller instance changed.","title":"update(child:with:in:onChange:)"},{"location":"swift/api/WorkflowUI/extensions/WorkflowHostingController/","text":"EXTENSION WorkflowHostingController \u00b6 Properties \u00b6 primaryScreen \u00b6 Methods \u00b6 customize(environment:) \u00b6 environmentDidChange() \u00b6","title":"WorkflowHostingController"},{"location":"swift/api/WorkflowUI/extensions/WorkflowHostingController/#workflowhostingcontroller","text":"","title":"WorkflowHostingController"},{"location":"swift/api/WorkflowUI/extensions/WorkflowHostingController/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/extensions/WorkflowHostingController/#primaryscreen","text":"","title":"primaryScreen"},{"location":"swift/api/WorkflowUI/extensions/WorkflowHostingController/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/extensions/WorkflowHostingController/#customizeenvironment","text":"","title":"customize(environment:)"},{"location":"swift/api/WorkflowUI/extensions/WorkflowHostingController/#environmentdidchange","text":"","title":"environmentDidChange()"},{"location":"swift/api/WorkflowUI/protocols/Screen/","text":"PROTOCOL Screen \u00b6 Screens are the building blocks of an interactive application. Conforming types contain any information needed to populate a screen: data, styling, event handlers, etc. Methods \u00b6 viewControllerDescription(environment:) \u00b6 A view controller description that acts as a recipe to either build or update a previously-built view controller to match this screen.","title":"Screen"},{"location":"swift/api/WorkflowUI/protocols/Screen/#screen","text":"Screens are the building blocks of an interactive application. Conforming types contain any information needed to populate a screen: data, styling, event handlers, etc.","title":"Screen"},{"location":"swift/api/WorkflowUI/protocols/Screen/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/protocols/Screen/#viewcontrollerdescriptionenvironment","text":"A view controller description that acts as a recipe to either build or update a previously-built view controller to match this screen.","title":"viewControllerDescription(environment:)"},{"location":"swift/api/WorkflowUI/protocols/SingleScreenContaining/","text":"PROTOCOL SingleScreenContaining \u00b6 Defines a type that semantically \u2018contains\u2019 a Screen instance. The motivating use case for this protocol is to expose a means of unifying various types that provide access to Screen s in a way that can be used without knowing their static type. For example, without this protocol, we cannot identify that a UIViewController is an instance of ScreenViewController without specifying the associated screen\u2019s type. func makeUninspectableScreenVC () -> UIViewController { struct LocalScreen : Screen { ... } // `LocalScreen` symbol is only visible in this function return ScreenViewController ( screen : LocalScreen (), environment : . empty ) } let isSVC = makeUninspectableScreenVC () is ScreenViewController // no generic can be specified here that makes this true Conceptually this API is intended to enable runtime traversal of a hierarchy of SingleScreenContaining instances such that an \u2018inner\u2019 Screen value can be found at runtime. For example, if we had an instance of ScreenViewController but only statically knew it was a UIViewController , we can use the conformances to this protocol to conditionally cast & traverse the contained screens to find the inner wrappedScreen . Properties \u00b6 primaryScreen \u00b6 The primary Screen the conforming type contains. Note that this may be ambiguous in some cases, for instance, if the conforming type logically contains multiple screens. Implementors should return the Screen which most appropriately reflects the \u2018primary\u2019 one for a given domain.","title":"SingleScreenContaining"},{"location":"swift/api/WorkflowUI/protocols/SingleScreenContaining/#singlescreencontaining","text":"Defines a type that semantically \u2018contains\u2019 a Screen instance. The motivating use case for this protocol is to expose a means of unifying various types that provide access to Screen s in a way that can be used without knowing their static type. For example, without this protocol, we cannot identify that a UIViewController is an instance of ScreenViewController without specifying the associated screen\u2019s type. func makeUninspectableScreenVC () -> UIViewController { struct LocalScreen : Screen { ... } // `LocalScreen` symbol is only visible in this function return ScreenViewController ( screen : LocalScreen (), environment : . empty ) } let isSVC = makeUninspectableScreenVC () is ScreenViewController // no generic can be specified here that makes this true Conceptually this API is intended to enable runtime traversal of a hierarchy of SingleScreenContaining instances such that an \u2018inner\u2019 Screen value can be found at runtime. For example, if we had an instance of ScreenViewController but only statically knew it was a UIViewController , we can use the conformances to this protocol to conditionally cast & traverse the contained screens to find the inner wrappedScreen .","title":"SingleScreenContaining"},{"location":"swift/api/WorkflowUI/protocols/SingleScreenContaining/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/protocols/SingleScreenContaining/#primaryscreen","text":"The primary Screen the conforming type contains. Note that this may be ambiguous in some cases, for instance, if the conforming type logically contains multiple screens. Implementors should return the Screen which most appropriately reflects the \u2018primary\u2019 one for a given domain.","title":"primaryScreen"},{"location":"swift/api/WorkflowUI/protocols/UpdateChildScreenViewController/","text":"PROTOCOL UpdateChildScreenViewController \u00b6","title":"UpdateChildScreenViewController"},{"location":"swift/api/WorkflowUI/protocols/UpdateChildScreenViewController/#updatechildscreenviewcontroller","text":"","title":"UpdateChildScreenViewController"},{"location":"swift/api/WorkflowUI/protocols/WorkflowUIEvent/","text":"PROTOCOL WorkflowUIEvent \u00b6 Protocol that describes an observable \u2018event\u2019 that may be emitted from WorkflowUI . Properties \u00b6 viewController \u00b6","title":"WorkflowUIEvent"},{"location":"swift/api/WorkflowUI/protocols/WorkflowUIEvent/#workflowuievent","text":"Protocol that describes an observable \u2018event\u2019 that may be emitted from WorkflowUI .","title":"WorkflowUIEvent"},{"location":"swift/api/WorkflowUI/protocols/WorkflowUIEvent/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/protocols/WorkflowUIEvent/#viewcontroller","text":"","title":"viewController"},{"location":"swift/api/WorkflowUI/protocols/WorkflowUIObserver/","text":"PROTOCOL WorkflowUIObserver \u00b6 Protocol to observe events emitted from WorkflowUI. N.B. This is currently part of an experimental interface, and may have breaking changes in the future. Methods \u00b6 observeEvent(_:) \u00b6","title":"WorkflowUIObserver"},{"location":"swift/api/WorkflowUI/protocols/WorkflowUIObserver/#workflowuiobserver","text":"Protocol to observe events emitted from WorkflowUI. N.B. This is currently part of an experimental interface, and may have breaking changes in the future.","title":"WorkflowUIObserver"},{"location":"swift/api/WorkflowUI/protocols/WorkflowUIObserver/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/protocols/WorkflowUIObserver/#observeevent_","text":"","title":"observeEvent(_:)"},{"location":"swift/api/WorkflowUI/structs/AdaptedEnvironmentScreen/","text":"STRUCT AdaptedEnvironmentScreen \u00b6 Wraps a Screen tree with a modified ViewEnvironment . By specifying environmental values with this Screen , all child screens nested will inherit those values automatically. Values can be changed anywhere in a sub-tree by inserting another AdaptedEnvironmentScreen . MyScreen (...) . adaptedEnvironment ( keyPath : \\ . myValue , to : newValue ) Properties \u00b6 wrapped \u00b6 The screen wrapped by this screen. Methods \u00b6 init(wrapping:adapting:) \u00b6 Wraps a Screen with an environment that is modified using the given configuration block. Parameters: wrapping: The screen to be wrapped. adapting: A block that will set environmental values. init(wrapping:key:value:) \u00b6 Wraps a Screen with an environment that is modified for a single key and value. Parameters: wrapping: The screen to be wrapped. key: The environment key to modify. value: The new environment value to cascade. init(wrapping:keyPath:value:) \u00b6 Wraps a Screen with an environment that is modified for a single value. Parameters: wrapping: The screen to be wrapped. keyPath: The keypath of the environment value to modify. value: The new environment value to cascade.","title":"AdaptedEnvironmentScreen"},{"location":"swift/api/WorkflowUI/structs/AdaptedEnvironmentScreen/#adaptedenvironmentscreen","text":"Wraps a Screen tree with a modified ViewEnvironment . By specifying environmental values with this Screen , all child screens nested will inherit those values automatically. Values can be changed anywhere in a sub-tree by inserting another AdaptedEnvironmentScreen . MyScreen (...) . adaptedEnvironment ( keyPath : \\ . myValue , to : newValue )","title":"AdaptedEnvironmentScreen"},{"location":"swift/api/WorkflowUI/structs/AdaptedEnvironmentScreen/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/structs/AdaptedEnvironmentScreen/#wrapped","text":"The screen wrapped by this screen.","title":"wrapped"},{"location":"swift/api/WorkflowUI/structs/AdaptedEnvironmentScreen/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/structs/AdaptedEnvironmentScreen/#initwrappingadapting","text":"Wraps a Screen with an environment that is modified using the given configuration block. Parameters: wrapping: The screen to be wrapped. adapting: A block that will set environmental values.","title":"init(wrapping:adapting:)"},{"location":"swift/api/WorkflowUI/structs/AdaptedEnvironmentScreen/#initwrappingkeyvalue","text":"Wraps a Screen with an environment that is modified for a single key and value. Parameters: wrapping: The screen to be wrapped. key: The environment key to modify. value: The new environment value to cascade.","title":"init(wrapping:key:value:)"},{"location":"swift/api/WorkflowUI/structs/AdaptedEnvironmentScreen/#initwrappingkeypathvalue","text":"Wraps a Screen with an environment that is modified for a single value. Parameters: wrapping: The screen to be wrapped. keyPath: The keypath of the environment value to modify. value: The new environment value to cascade.","title":"init(wrapping:keyPath:value:)"},{"location":"swift/api/WorkflowUI/structs/AnyScreen/","text":"STRUCT AnyScreen \u00b6 Properties \u00b6 wrappedScreen \u00b6 The original screen, retained for debugging Methods \u00b6 init(_:) \u00b6 viewControllerDescription(environment:) \u00b6","title":"AnyScreen"},{"location":"swift/api/WorkflowUI/structs/AnyScreen/#anyscreen","text":"","title":"AnyScreen"},{"location":"swift/api/WorkflowUI/structs/AnyScreen/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/structs/AnyScreen/#wrappedscreen","text":"The original screen, retained for debugging","title":"wrappedScreen"},{"location":"swift/api/WorkflowUI/structs/AnyScreen/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/structs/AnyScreen/#init_","text":"","title":"init(_:)"},{"location":"swift/api/WorkflowUI/structs/AnyScreen/#viewcontrollerdescriptionenvironment","text":"","title":"viewControllerDescription(environment:)"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription.KindIdentifier/","text":"STRUCT ViewControllerDescription.KindIdentifier \u00b6 Describes the UIViewController type that backs the ViewControllerDescription in a way that is Equatable and Hashable . When implementing view controller updating and diffing, you can use this type to identify if the backing view controller type changed. Methods \u00b6 init(_:) \u00b6 Creates a new kind for the given view controller type. canUpdate(viewController:) \u00b6 If the given view controller is of the correct type to be updated by this view controller description. If your view controller type can change between updates, call this method before invoking update(viewController:) . hash(into:) \u00b6 ==(_:_:) \u00b6","title":"ViewControllerDescription.KindIdentifier"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription.KindIdentifier/#viewcontrollerdescriptionkindidentifier","text":"Describes the UIViewController type that backs the ViewControllerDescription in a way that is Equatable and Hashable . When implementing view controller updating and diffing, you can use this type to identify if the backing view controller type changed.","title":"ViewControllerDescription.KindIdentifier"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription.KindIdentifier/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription.KindIdentifier/#init_","text":"Creates a new kind for the given view controller type.","title":"init(_:)"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription.KindIdentifier/#canupdateviewcontroller","text":"If the given view controller is of the correct type to be updated by this view controller description. If your view controller type can change between updates, call this method before invoking update(viewController:) .","title":"canUpdate(viewController:)"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription.KindIdentifier/#hashinto","text":"","title":"hash(into:)"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription.KindIdentifier/#__","text":"","title":"==(_:_:)"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/","text":"STRUCT ViewControllerDescription \u00b6 A ViewControllerDescription acts as a \u201crecipe\u201d for building and updating a specific UIViewController . It describes how to create and later update a given view controller instance, without creating one itself. This means it is a lightweight currency you can create and pass around to describe a view controller, without needing to create one. The most common use case for a ViewControllerDescription is to return it from your Screen \u2019s viewControllerDescription(environment:) method. The WorkflowUI machinery (or your custom container view controller) will then use this view controller description to create or update the on-screen presented view controller. As a creator of a custom container view controller, you will usually pass this view controller description to a DescribedViewController , which will internally create and manage the described view controller for its current view controller description. However, you can also directly invoke the public methods such as buildViewController() , update(viewController:) , if you are manually managing your own view controller hierarchy. Properties \u00b6 performInitialUpdate \u00b6 If an initial call to update(viewController:) will be performed when the view controller is created. Defaults to true . Note \u00b6 When creating container view controllers that contain other view controllers (eg, a navigation stack), you usually want to set this value to false to avoid duplicate updates to your children if they are created in init . kind \u00b6 Describes the UIViewController type that backs the ViewControllerDescription in a way that is Equatable and Hashable . When implementing view controller updating and diffing, you can use this type to identify if the backing view controller type changed. Methods \u00b6 init(performInitialUpdate:type:environment:build:update:) \u00b6 Constructs a view controller description by providing closures used to build and update a specific view controller type. Parameters: performInitialUpdate: If an initial call to update(viewController:) will be performed when the view controller is created. Defaults to true . environment: The ViewEnvironment that should be injected above the described view controller for ViewEnvironmentUI environment propagation. This is typically passed in from a Screen in its viewControllerDescription(environment:) method. type: The type of view controller produced by this description. Typically, should should be able to omit this parameter, but in cases where type inference has trouble, it\u2019s offered as an escape hatch. build: Closure that produces a new instance of the view controller update: Closure that updates the given view controller buildViewController() \u00b6 Construct and update a new view controller as described by this view controller description. The view controller will be updated before it is returned, so it is fully configured and prepared for display. canUpdate(viewController:) \u00b6 If the given view controller is of the correct type to be updated by this view controller description. If your view controller type can change between updates, call this method before invoking update(viewController:) . update(viewController:) \u00b6 Update the given view controller with the content from the view controller description. Parameters: viewController: The view controller to update. Note \u00b6 You must pass a view controller previously created by a compatible ViewControllerDescription that passes canUpdate(viewController:) . Failure to do so will result in a fatal precondition.","title":"ViewControllerDescription"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#viewcontrollerdescription","text":"A ViewControllerDescription acts as a \u201crecipe\u201d for building and updating a specific UIViewController . It describes how to create and later update a given view controller instance, without creating one itself. This means it is a lightweight currency you can create and pass around to describe a view controller, without needing to create one. The most common use case for a ViewControllerDescription is to return it from your Screen \u2019s viewControllerDescription(environment:) method. The WorkflowUI machinery (or your custom container view controller) will then use this view controller description to create or update the on-screen presented view controller. As a creator of a custom container view controller, you will usually pass this view controller description to a DescribedViewController , which will internally create and manage the described view controller for its current view controller description. However, you can also directly invoke the public methods such as buildViewController() , update(viewController:) , if you are manually managing your own view controller hierarchy.","title":"ViewControllerDescription"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#performinitialupdate","text":"If an initial call to update(viewController:) will be performed when the view controller is created. Defaults to true .","title":"performInitialUpdate"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#note","text":"When creating container view controllers that contain other view controllers (eg, a navigation stack), you usually want to set this value to false to avoid duplicate updates to your children if they are created in init .","title":"Note"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#kind","text":"Describes the UIViewController type that backs the ViewControllerDescription in a way that is Equatable and Hashable . When implementing view controller updating and diffing, you can use this type to identify if the backing view controller type changed.","title":"kind"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#methods","text":"","title":"Methods"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#initperforminitialupdatetypeenvironmentbuildupdate","text":"Constructs a view controller description by providing closures used to build and update a specific view controller type. Parameters: performInitialUpdate: If an initial call to update(viewController:) will be performed when the view controller is created. Defaults to true . environment: The ViewEnvironment that should be injected above the described view controller for ViewEnvironmentUI environment propagation. This is typically passed in from a Screen in its viewControllerDescription(environment:) method. type: The type of view controller produced by this description. Typically, should should be able to omit this parameter, but in cases where type inference has trouble, it\u2019s offered as an escape hatch. build: Closure that produces a new instance of the view controller update: Closure that updates the given view controller","title":"init(performInitialUpdate:type:environment:build:update:)"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#buildviewcontroller","text":"Construct and update a new view controller as described by this view controller description. The view controller will be updated before it is returned, so it is fully configured and prepared for display.","title":"buildViewController()"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#canupdateviewcontroller","text":"If the given view controller is of the correct type to be updated by this view controller description. If your view controller type can change between updates, call this method before invoking update(viewController:) .","title":"canUpdate(viewController:)"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#updateviewcontroller","text":"Update the given view controller with the content from the view controller description. Parameters: viewController: The view controller to update.","title":"update(viewController:)"},{"location":"swift/api/WorkflowUI/structs/ViewControllerDescription/#note_1","text":"You must pass a view controller previously created by a compatible ViewControllerDescription that passes canUpdate(viewController:) . Failure to do so will result in a fatal precondition.","title":"Note"},{"location":"swift/api/WorkflowUI/structs/ViewDidAppearEvent/","text":"STRUCT ViewDidAppearEvent \u00b6 Event emitted from a WorkflowUIViewController \u2019s viewDidAppear method. Properties \u00b6 viewController \u00b6 animated \u00b6 isFirstAppearance \u00b6","title":"ViewDidAppearEvent"},{"location":"swift/api/WorkflowUI/structs/ViewDidAppearEvent/#viewdidappearevent","text":"Event emitted from a WorkflowUIViewController \u2019s viewDidAppear method.","title":"ViewDidAppearEvent"},{"location":"swift/api/WorkflowUI/structs/ViewDidAppearEvent/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/structs/ViewDidAppearEvent/#viewcontroller","text":"","title":"viewController"},{"location":"swift/api/WorkflowUI/structs/ViewDidAppearEvent/#animated","text":"","title":"animated"},{"location":"swift/api/WorkflowUI/structs/ViewDidAppearEvent/#isfirstappearance","text":"","title":"isFirstAppearance"},{"location":"swift/api/WorkflowUI/structs/ViewDidDisappearEvent/","text":"STRUCT ViewDidDisappearEvent \u00b6 Event emitted from a WorkflowUIViewController \u2019s viewDidDisappear method. Properties \u00b6 viewController \u00b6 animated \u00b6","title":"ViewDidDisappearEvent"},{"location":"swift/api/WorkflowUI/structs/ViewDidDisappearEvent/#viewdiddisappearevent","text":"Event emitted from a WorkflowUIViewController \u2019s viewDidDisappear method.","title":"ViewDidDisappearEvent"},{"location":"swift/api/WorkflowUI/structs/ViewDidDisappearEvent/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/structs/ViewDidDisappearEvent/#viewcontroller","text":"","title":"viewController"},{"location":"swift/api/WorkflowUI/structs/ViewDidDisappearEvent/#animated","text":"","title":"animated"},{"location":"swift/api/WorkflowUI/structs/ViewDidLayoutSubviewsEvent/","text":"STRUCT ViewDidLayoutSubviewsEvent \u00b6 Event emitted from a WorkflowUIViewController \u2019s viewDidLayoutSubviews method. Properties \u00b6 viewController \u00b6","title":"ViewDidLayoutSubviewsEvent"},{"location":"swift/api/WorkflowUI/structs/ViewDidLayoutSubviewsEvent/#viewdidlayoutsubviewsevent","text":"Event emitted from a WorkflowUIViewController \u2019s viewDidLayoutSubviews method.","title":"ViewDidLayoutSubviewsEvent"},{"location":"swift/api/WorkflowUI/structs/ViewDidLayoutSubviewsEvent/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/structs/ViewDidLayoutSubviewsEvent/#viewcontroller","text":"","title":"viewController"},{"location":"swift/api/WorkflowUI/structs/ViewWillAppearEvent/","text":"STRUCT ViewWillAppearEvent \u00b6 Event emitted from a WorkflowUIViewController \u2019s viewWillAppear method. Properties \u00b6 viewController \u00b6 animated \u00b6 isFirstAppearance \u00b6","title":"ViewWillAppearEvent"},{"location":"swift/api/WorkflowUI/structs/ViewWillAppearEvent/#viewwillappearevent","text":"Event emitted from a WorkflowUIViewController \u2019s viewWillAppear method.","title":"ViewWillAppearEvent"},{"location":"swift/api/WorkflowUI/structs/ViewWillAppearEvent/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/structs/ViewWillAppearEvent/#viewcontroller","text":"","title":"viewController"},{"location":"swift/api/WorkflowUI/structs/ViewWillAppearEvent/#animated","text":"","title":"animated"},{"location":"swift/api/WorkflowUI/structs/ViewWillAppearEvent/#isfirstappearance","text":"","title":"isFirstAppearance"},{"location":"swift/api/WorkflowUI/structs/ViewWillDisappearEvent/","text":"STRUCT ViewWillDisappearEvent \u00b6 Event emitted from a WorkflowUIViewController \u2019s viewWillDisappear method. Properties \u00b6 viewController \u00b6 animated \u00b6","title":"ViewWillDisappearEvent"},{"location":"swift/api/WorkflowUI/structs/ViewWillDisappearEvent/#viewwilldisappearevent","text":"Event emitted from a WorkflowUIViewController \u2019s viewWillDisappear method.","title":"ViewWillDisappearEvent"},{"location":"swift/api/WorkflowUI/structs/ViewWillDisappearEvent/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/structs/ViewWillDisappearEvent/#viewcontroller","text":"","title":"viewController"},{"location":"swift/api/WorkflowUI/structs/ViewWillDisappearEvent/#animated","text":"","title":"animated"},{"location":"swift/api/WorkflowUI/structs/ViewWillLayoutSubviewsEvent/","text":"STRUCT ViewWillLayoutSubviewsEvent \u00b6 Event emitted from a WorkflowUIViewController \u2019s viewWillLayoutSubviews method. Properties \u00b6 viewController \u00b6","title":"ViewWillLayoutSubviewsEvent"},{"location":"swift/api/WorkflowUI/structs/ViewWillLayoutSubviewsEvent/#viewwilllayoutsubviewsevent","text":"Event emitted from a WorkflowUIViewController \u2019s viewWillLayoutSubviews method.","title":"ViewWillLayoutSubviewsEvent"},{"location":"swift/api/WorkflowUI/structs/ViewWillLayoutSubviewsEvent/#properties","text":"","title":"Properties"},{"location":"swift/api/WorkflowUI/structs/ViewWillLayoutSubviewsEvent/#viewcontroller","text":"","title":"viewController"},{"location":"swift/api/WorkflowUI/typealiases/AdaptedEnvironmentScreen.Adapter/","text":"TYPEALIAS AdaptedEnvironmentScreen.Adapter \u00b6 Takes in a mutable ViewEnvironment which can be mutated to add or override values.","title":"AdaptedEnvironmentScreen.Adapter"},{"location":"swift/api/WorkflowUI/typealiases/AdaptedEnvironmentScreen.Adapter/#adaptedenvironmentscreenadapter","text":"Takes in a mutable ViewEnvironment which can be mutated to add or override values.","title":"AdaptedEnvironmentScreen.Adapter"},{"location":"swift/api/WorkflowUI/typealiases/WorkflowHostingController.CustomizeEnvironment/","text":"TYPEALIAS WorkflowHostingController.CustomizeEnvironment \u00b6","title":"WorkflowHostingController.CustomizeEnvironment"},{"location":"swift/api/WorkflowUI/typealiases/WorkflowHostingController.CustomizeEnvironment/#workflowhostingcontrollercustomizeenvironment","text":"","title":"WorkflowHostingController.CustomizeEnvironment"},{"location":"userguide/common-patterns/","text":"Common Patterns \u00b6 There are a lot associated/generic types in workflow code \u2013 that doesn\u2019t mean you always need to use all of them. Here are some common configurations we\u2019ve seen. Stateless Workflows \u00b6 Remember that workflow state is made up of public and private parts. When a workflow\u2019s state consists entirely of public state (i.e. it\u2019s initializer arguments in Swift or PropsT in Kotlin), it can ignore all the machinery for private state. In Swift, the State type can be Void , and in Kotlin it can be Unit \u2013 such workflows are often referred to as \u201cstateless\u201d, since they have no state of their own. Props-less Workflows \u00b6 Some workflows manage all of their state internally, and have no public state (aka props). In Swift, this just means the workflow implementation has no parameters (although this is rare, see Injecting Dependencies below). In Kotlin, the PropsT type can be Unit . RenderContext has convenience overloads of most of its functions to implicitly pass Unit for these workflows. Outputless Workflows \u00b6 Workflows that only talk to their parent via their Rendering , and never emit any output, are encouraged to indicate that by using the bottom type as their Output type. In addition to documenting the fact that the workflow will never output, using the bottom type also lets the compiler enforce it \u2013 code that tries to emit outputs will not compile. In Swift, the Output type is specified as Never . In Kotlin, use Nothing . Composite Workflows \u00b6 Composition is a powerful tool for working with Workflows. A workflow can often accomplish a lot simply by rendering various children. It may just combine the renderings of multiple children, or use its props to determine which of a set of children to render. Such workflows can often be stateless. One-and-done Workflows (RenderingT v. OutputT) \u00b6 A common question is \u201cwhy can\u2019t I emit output from initialState ,\u201d or \u201cwhat if my Workflow realizes it doesn\u2019t actually need to run? The most efficient, and most expressive, way to handle this is to use an optional or conditional Rendering type, and an Output of Never / Nothing . Imagine a PromptForPermissionMaybeWorkflow , that renders a UI to get a passcode, but only if that permission has not already been granted. If you make its RenderingT nullable (e.g. Screen? ), it can return null to indicate that its job is done. Its callers will be synchronously informed that the coast is clear, and can immediately render what they actually care about. Another variation of this pattern is to use a sealed class / enum type for Rendering , with a Working type that implements Screen , and a unviewable Finished type that carries the work product. A good rule of thumb for choosing between using Rendering or Output is to remember that Output is event-like, and is always asynchronous. A parent waiting for an output must be given something to render in the meantime. Using Rendering is a great idiom for a one-and-done workflow tasked with providing a single product, especially one that might be available instantly. Props values v. Injected Dependencies \u00b6 Dependency injection is a technique for making code less coupled and more testable. In short, it\u2019s better for classes/structs to accept their dependencies when they\u2019re created instead of hard-coding them. Workflows typically have dependencies like specific Workers they need to perform some tasks, child workflows to delegate rendering to, or helpers for things like network requests, formatting and logging. Swift \u00b6 A Swift workflow typically receives its dependencies as initializer arguments, just like its input values, and is normally instantiated anew by its parent in each call to the parent\u2019s render method. The factory pattern can be employed to keep knowledge of children\u2019s implementation details from leaking into their parents. Kotlin \u00b6 Kotlin workflows make a more formal distinction between dependencies and props, via the PropsT parameter type on the Kotlin Workflow interface. Dependencies (e.g. a network service) are typically provided as constructor parameters, while props values (e.g. a record locator) are provided by the parent as an argument to the RenderContext.renderChild method. This works seamlessly with DI libraries like Dagger . The careful reader will note that this is technically storing \u201cstate\u201d in the workflow instance \u2013 something that is generally discouraged. However, since this \u201cstate\u201d is never changed, we can make an exception for this case. If a workflow has properties, they should only be used to store injected dependencies or dependencies derived from injected ones (e.g. Worker s created from Observable s). Info This difference between Swift and Kotlin practices is a side effect of Kotlin\u2019s lack of a parallel to Swift\u2019s Self type. Kotlin has no practical way to provide a method like Swift\u2019s Workflow.workflowDidChange , which accepts a strongly typed reference to the instance from the previous run of a parent\u2019s Render method. Kotlin\u2019s alternative, StatefulWorkflow.onPropsChanged , requires the extra PropsT type parameter.","title":"Common Patterns"},{"location":"userguide/common-patterns/#common-patterns","text":"There are a lot associated/generic types in workflow code \u2013 that doesn\u2019t mean you always need to use all of them. Here are some common configurations we\u2019ve seen.","title":"Common Patterns"},{"location":"userguide/common-patterns/#stateless-workflows","text":"Remember that workflow state is made up of public and private parts. When a workflow\u2019s state consists entirely of public state (i.e. it\u2019s initializer arguments in Swift or PropsT in Kotlin), it can ignore all the machinery for private state. In Swift, the State type can be Void , and in Kotlin it can be Unit \u2013 such workflows are often referred to as \u201cstateless\u201d, since they have no state of their own.","title":"Stateless Workflows"},{"location":"userguide/common-patterns/#props-less-workflows","text":"Some workflows manage all of their state internally, and have no public state (aka props). In Swift, this just means the workflow implementation has no parameters (although this is rare, see Injecting Dependencies below). In Kotlin, the PropsT type can be Unit . RenderContext has convenience overloads of most of its functions to implicitly pass Unit for these workflows.","title":"Props-less Workflows"},{"location":"userguide/common-patterns/#outputless-workflows","text":"Workflows that only talk to their parent via their Rendering , and never emit any output, are encouraged to indicate that by using the bottom type as their Output type. In addition to documenting the fact that the workflow will never output, using the bottom type also lets the compiler enforce it \u2013 code that tries to emit outputs will not compile. In Swift, the Output type is specified as Never . In Kotlin, use Nothing .","title":"Outputless Workflows"},{"location":"userguide/common-patterns/#composite-workflows","text":"Composition is a powerful tool for working with Workflows. A workflow can often accomplish a lot simply by rendering various children. It may just combine the renderings of multiple children, or use its props to determine which of a set of children to render. Such workflows can often be stateless.","title":"Composite Workflows"},{"location":"userguide/common-patterns/#one-and-done-workflows-renderingt-v-outputt","text":"A common question is \u201cwhy can\u2019t I emit output from initialState ,\u201d or \u201cwhat if my Workflow realizes it doesn\u2019t actually need to run? The most efficient, and most expressive, way to handle this is to use an optional or conditional Rendering type, and an Output of Never / Nothing . Imagine a PromptForPermissionMaybeWorkflow , that renders a UI to get a passcode, but only if that permission has not already been granted. If you make its RenderingT nullable (e.g. Screen? ), it can return null to indicate that its job is done. Its callers will be synchronously informed that the coast is clear, and can immediately render what they actually care about. Another variation of this pattern is to use a sealed class / enum type for Rendering , with a Working type that implements Screen , and a unviewable Finished type that carries the work product. A good rule of thumb for choosing between using Rendering or Output is to remember that Output is event-like, and is always asynchronous. A parent waiting for an output must be given something to render in the meantime. Using Rendering is a great idiom for a one-and-done workflow tasked with providing a single product, especially one that might be available instantly.","title":"One-and-done Workflows (RenderingT v. OutputT)"},{"location":"userguide/common-patterns/#props-values-v-injected-dependencies","text":"Dependency injection is a technique for making code less coupled and more testable. In short, it\u2019s better for classes/structs to accept their dependencies when they\u2019re created instead of hard-coding them. Workflows typically have dependencies like specific Workers they need to perform some tasks, child workflows to delegate rendering to, or helpers for things like network requests, formatting and logging.","title":"Props values v. Injected Dependencies"},{"location":"userguide/common-patterns/#swift","text":"A Swift workflow typically receives its dependencies as initializer arguments, just like its input values, and is normally instantiated anew by its parent in each call to the parent\u2019s render method. The factory pattern can be employed to keep knowledge of children\u2019s implementation details from leaking into their parents.","title":"Swift"},{"location":"userguide/common-patterns/#kotlin","text":"Kotlin workflows make a more formal distinction between dependencies and props, via the PropsT parameter type on the Kotlin Workflow interface. Dependencies (e.g. a network service) are typically provided as constructor parameters, while props values (e.g. a record locator) are provided by the parent as an argument to the RenderContext.renderChild method. This works seamlessly with DI libraries like Dagger . The careful reader will note that this is technically storing \u201cstate\u201d in the workflow instance \u2013 something that is generally discouraged. However, since this \u201cstate\u201d is never changed, we can make an exception for this case. If a workflow has properties, they should only be used to store injected dependencies or dependencies derived from injected ones (e.g. Worker s created from Observable s). Info This difference between Swift and Kotlin practices is a side effect of Kotlin\u2019s lack of a parallel to Swift\u2019s Self type. Kotlin has no practical way to provide a method like Swift\u2019s Workflow.workflowDidChange , which accepts a strongly typed reference to the instance from the previous run of a parent\u2019s Render method. Kotlin\u2019s alternative, StatefulWorkflow.onPropsChanged , requires the extra PropsT type parameter.","title":"Kotlin"},{"location":"userguide/concepts/","text":"Workflow Core \u00b6 This page provides a high level overview of Workflow Core, the UI-agnostic Swift and Kotlin runtimes at the heart of the Workflow libraries. See Workflow UI to learn about the companion Android and iOS specific modules. What is a Workflow? \u00b6 A Workflow defines the possible states and behaviors of components of a particular type. The overall state of a Workflow has two parts: Props , configuration information provided by whatever is running the Workflow And the private State managed by the Workflow itself At any time, a Workflow can be asked to transform its current Props and State into a Rendering that is suitable for external consumption. A Rendering is typically a simple struct with display data, and event handler functions that can enqueue Workflow Actions \u2014 functions that update State, and which may at the same time emit Output events. For example, a Workflow running a simple game might be configured with a description of the participating Players as its Props, build GameScreen structs when asked to render, and emit a GameOver event as Output to signal that is finished. A workflow Rendering usually serves as a view model in iOS or Android apps, but that is not a requirement. Again, this page includes no details about how platform specific UI code is driven. See Workflow UI for that discussion. Note Readers with an Android background should note the lower case v and m of \u201cview model\u201d \u2014 this notion has nothing to do with Jetpack ViewModel . Composing Workflows \u00b6 Workflows run in a tree, with a single root Workflow declaring it has any number of children for a particular state, each of which can declare children of their own, and so on. The most common reason to compose Workflows this way is to build big view models (Renderings) out of small ones. For example, consider an overview / detail split screen, like an email app with a list of messages on the left, and the body of the selected message on the right. This could be modeled as a trio of Workflows: InboxWorkflow Expects a List as its Props Rendering is an InboxScreen , a struct with displayable information derived from its Props, and an onMessageSelected() function When onMessageSelected() is called, a WorkflowAction is executed which emits the given MessageId as Output Has no private State MessageWorkflow Requires a MessageId Props value to produce a MessageScreen Rendering Has no private State, and emits no Output EmailBrowserWorkflow State includes a List , and the selected MessageId Rendering is a SplitScreen view model, to be assembled from the renderings of the other two Workflows Accepts no Props, and emits no Output When EmailBrowserWorkflow is asked to provide its Rendering, it in turn asks for Renderings from its two children. It provides the List from its state as the Props for EmailInboxWorkflow and receives an InBoxScreen rendering in return. That InboxScreen becomes the left pane of a SplitScreen Rendering. For the SplitScreen \u2019s right pane, the browser Workflow provides the currently selected MessageId as input to EmailMessageWorkflow , to get a MessageScreen rendering. Note Note that the two children, EmailInboxWorkflow and EmailMessageWorkflow , have no knowledge of each other, nor of the context in which they are run. The InboxScreen rendering includes an onMessageSelected(MessageId) function. When that is called, EmailInboxWorkflow enqueues an Action function that emits the given MessageId as Output. EmailBrowserWorkflow receives that Output, and enqueues another Action that updates the selection: MessageId of its State accordingly. Whenever such a Workflow Action cascade fires, the root Workflow is asked for a new Rendering. Just as before, EmailBrowserWorkflow delegates to its two children for their Renderings, this time providing the new value of selection as the updated Props for MessageWorkflow . Why does Workflow work this way? \u00b6 Workflow was built to tame the composition and navigation challenges presented by Square\u2019s massive Android and iOS apps. It lets us write intricate, centralized, well tested code encapsulating the flow through literally hundreds of individual screens. These days we are able to see and shape the forest, despite all of the trees. We built it with two core design principals in mind: Unidirectional data flow is the best way to stay sane when building UI Declarative programming is the best way to define unidirectional data flows What does that actually mean? Unidirectional Data Flow \u00b6 There is a wealth of information on the web about Unidirectional Data Flow , but it very simply means that there is a single path along which data travel from your business logic to your UI, and events travel to your business logic from your UI, and they always and only travel in one direction along that path. For Workflow, this also implies that the UI is (almost) stateless, and that the interesting state for your app is centralized and not duplicated. In practice, this makes program flow much easier to reason about because anytime something happens in an app, it removes the questions of where the state came from that caused it, which components got which events, and which sequences of cause and effect actually occurred. It makes unit testing easier because state and events are explicit, and always live in the same place and flow through the same APIs, so unit tests only need to test state transitions, for the most part. Declarative vs Imperative \u00b6 Traditionally, most mobile code is \u201cimperative\u201d \u2013 it consists of instructions for how to build and display the UI. These instructions can include control flow like loops. Imperative code is usually stateful, state is usually sprinkled all over the place, and tends to care about instances and identity. When reading imperative code, you almost have to run an interpreter and keep all the pieces of state in your head to figure out what it does. Web UI is traditionally declarative \u2013 it describes what to render, and some aspects of how to render it (style), but doesn\u2019t say how to actually draw it. Declarative code is usually easier to read than imperative code. It describes what it produces, not how to generate it. Declarative code usually cares more about pure values than instance identities. However, since computers still need actual instructions at some point, declarative code requires something else, usually imperative, either a compiler or interpreter, to actually do something with it. Workflow code is written in regular Kotlin or Swift, which are both imperative languages, but the library encourages you to write your logic in a declarative and functional style. The library manages state and wiring up event handling for you, so the only code you need to write is code that is actually interesting for your particular problem. A note about functional programming Kotlin and Swift are not strictly functional programming languages, but both have features that allow you to write functional -style code. Functional code discourages side effects and is generally much easier to test than object-oriented code. Functional and declarative programming go very well together, and Workflow encourages you to write such code.","title":"Workflow Core"},{"location":"userguide/concepts/#workflow-core","text":"This page provides a high level overview of Workflow Core, the UI-agnostic Swift and Kotlin runtimes at the heart of the Workflow libraries. See Workflow UI to learn about the companion Android and iOS specific modules.","title":"Workflow Core"},{"location":"userguide/concepts/#what-is-a-workflow","text":"A Workflow defines the possible states and behaviors of components of a particular type. The overall state of a Workflow has two parts: Props , configuration information provided by whatever is running the Workflow And the private State managed by the Workflow itself At any time, a Workflow can be asked to transform its current Props and State into a Rendering that is suitable for external consumption. A Rendering is typically a simple struct with display data, and event handler functions that can enqueue Workflow Actions \u2014 functions that update State, and which may at the same time emit Output events. For example, a Workflow running a simple game might be configured with a description of the participating Players as its Props, build GameScreen structs when asked to render, and emit a GameOver event as Output to signal that is finished. A workflow Rendering usually serves as a view model in iOS or Android apps, but that is not a requirement. Again, this page includes no details about how platform specific UI code is driven. See Workflow UI for that discussion. Note Readers with an Android background should note the lower case v and m of \u201cview model\u201d \u2014 this notion has nothing to do with Jetpack ViewModel .","title":"What is a Workflow?"},{"location":"userguide/concepts/#composing-workflows","text":"Workflows run in a tree, with a single root Workflow declaring it has any number of children for a particular state, each of which can declare children of their own, and so on. The most common reason to compose Workflows this way is to build big view models (Renderings) out of small ones. For example, consider an overview / detail split screen, like an email app with a list of messages on the left, and the body of the selected message on the right. This could be modeled as a trio of Workflows: InboxWorkflow Expects a List as its Props Rendering is an InboxScreen , a struct with displayable information derived from its Props, and an onMessageSelected() function When onMessageSelected() is called, a WorkflowAction is executed which emits the given MessageId as Output Has no private State MessageWorkflow Requires a MessageId Props value to produce a MessageScreen Rendering Has no private State, and emits no Output EmailBrowserWorkflow State includes a List , and the selected MessageId Rendering is a SplitScreen view model, to be assembled from the renderings of the other two Workflows Accepts no Props, and emits no Output When EmailBrowserWorkflow is asked to provide its Rendering, it in turn asks for Renderings from its two children. It provides the List from its state as the Props for EmailInboxWorkflow and receives an InBoxScreen rendering in return. That InboxScreen becomes the left pane of a SplitScreen Rendering. For the SplitScreen \u2019s right pane, the browser Workflow provides the currently selected MessageId as input to EmailMessageWorkflow , to get a MessageScreen rendering. Note Note that the two children, EmailInboxWorkflow and EmailMessageWorkflow , have no knowledge of each other, nor of the context in which they are run. The InboxScreen rendering includes an onMessageSelected(MessageId) function. When that is called, EmailInboxWorkflow enqueues an Action function that emits the given MessageId as Output. EmailBrowserWorkflow receives that Output, and enqueues another Action that updates the selection: MessageId of its State accordingly. Whenever such a Workflow Action cascade fires, the root Workflow is asked for a new Rendering. Just as before, EmailBrowserWorkflow delegates to its two children for their Renderings, this time providing the new value of selection as the updated Props for MessageWorkflow .","title":"Composing Workflows"},{"location":"userguide/concepts/#why-does-workflow-work-this-way","text":"Workflow was built to tame the composition and navigation challenges presented by Square\u2019s massive Android and iOS apps. It lets us write intricate, centralized, well tested code encapsulating the flow through literally hundreds of individual screens. These days we are able to see and shape the forest, despite all of the trees. We built it with two core design principals in mind: Unidirectional data flow is the best way to stay sane when building UI Declarative programming is the best way to define unidirectional data flows What does that actually mean?","title":"Why does Workflow work this way?"},{"location":"userguide/concepts/#unidirectional-data-flow","text":"There is a wealth of information on the web about Unidirectional Data Flow , but it very simply means that there is a single path along which data travel from your business logic to your UI, and events travel to your business logic from your UI, and they always and only travel in one direction along that path. For Workflow, this also implies that the UI is (almost) stateless, and that the interesting state for your app is centralized and not duplicated. In practice, this makes program flow much easier to reason about because anytime something happens in an app, it removes the questions of where the state came from that caused it, which components got which events, and which sequences of cause and effect actually occurred. It makes unit testing easier because state and events are explicit, and always live in the same place and flow through the same APIs, so unit tests only need to test state transitions, for the most part.","title":"Unidirectional Data Flow"},{"location":"userguide/concepts/#declarative-vs-imperative","text":"Traditionally, most mobile code is \u201cimperative\u201d \u2013 it consists of instructions for how to build and display the UI. These instructions can include control flow like loops. Imperative code is usually stateful, state is usually sprinkled all over the place, and tends to care about instances and identity. When reading imperative code, you almost have to run an interpreter and keep all the pieces of state in your head to figure out what it does. Web UI is traditionally declarative \u2013 it describes what to render, and some aspects of how to render it (style), but doesn\u2019t say how to actually draw it. Declarative code is usually easier to read than imperative code. It describes what it produces, not how to generate it. Declarative code usually cares more about pure values than instance identities. However, since computers still need actual instructions at some point, declarative code requires something else, usually imperative, either a compiler or interpreter, to actually do something with it. Workflow code is written in regular Kotlin or Swift, which are both imperative languages, but the library encourages you to write your logic in a declarative and functional style. The library manages state and wiring up event handling for you, so the only code you need to write is code that is actually interesting for your particular problem. A note about functional programming Kotlin and Swift are not strictly functional programming languages, but both have features that allow you to write functional -style code. Functional code discourages side effects and is generally much easier to test than object-oriented code. Functional and declarative programming go very well together, and Workflow encourages you to write such code.","title":"Declarative vs Imperative"},{"location":"userguide/implementation/","text":"Implementation Notes \u00b6 Work in progress\u2026 So far we only have notes on the implementation of the Swift runtime. They\u2019re actually pretty close to what goes on in Kotlin, the WorkflowNode and SubtreeManager classes in particular. Swift \u00b6 The Render loop \u00b6 Initial pass \u00b6 The root of your workflow hierarchy gets put into a WorkflowHost (if you\u2019re using ContainerViewController this is created for you). As part of its initializer, WorkflowHost creates a WorkflowNode that wraps the given root Workflow (and keeps track of the Workflow \u2019s State ). It then calls render() on the node: // WorkflowHost public init ( workflow : WorkflowType , debugger : WorkflowDebugger ? = nil ) { self . debugger = debugger self . rootNode = WorkflowNode ( workflow : workflow ) // 1. Create the node self . mutableRendering = MutableProperty ( self . rootNode . render ()) // 2. Call render() WorkflowNode contains a SubtreeManager , whose primary purpose is to manage child workflows (more on this later). When render() gets invoked on the node, it calls render on the SubtreeManager and passes a closure that takes a RenderContext and returns a Rendering for the Workflow associated with the node. // WorkflowNode func render () -> WorkflowType . Rendering { return subtreeManager . render { context in return workflow . render ( state : state , context : context ) } } The SubtreeManager instantiates a RenderContext and invokes the closure that was passed in. This last step generates the Rendering . This Rendering then gets passed back up the call stack until it reaches the WorkflowHost . Composition \u00b6 In cases where a Workflow has child Workflow s, the render sequence is similar. The [tutorial] (../tutorial/building-a-workflow/#the-render-context) goes through this in more detail. Essentially, a Workflow containing child Workflow s calls render(context:key:outputMap:) on each child Workflow and passes in the RenderContext . The context does some bookkeeping for the child Workflow (creating or updating a ChildWorkflow ) and then calls render() . ChildWorkflow.render() calls render() on its WorkflowNode and we recurse back to step 2.","title":"Implementation Notes"},{"location":"userguide/implementation/#implementation-notes","text":"Work in progress\u2026 So far we only have notes on the implementation of the Swift runtime. They\u2019re actually pretty close to what goes on in Kotlin, the WorkflowNode and SubtreeManager classes in particular.","title":"Implementation Notes"},{"location":"userguide/implementation/#swift","text":"","title":"Swift"},{"location":"userguide/implementation/#the-render-loop","text":"","title":"The Render loop"},{"location":"userguide/implementation/#initial-pass","text":"The root of your workflow hierarchy gets put into a WorkflowHost (if you\u2019re using ContainerViewController this is created for you). As part of its initializer, WorkflowHost creates a WorkflowNode that wraps the given root Workflow (and keeps track of the Workflow \u2019s State ). It then calls render() on the node: // WorkflowHost public init ( workflow : WorkflowType , debugger : WorkflowDebugger ? = nil ) { self . debugger = debugger self . rootNode = WorkflowNode ( workflow : workflow ) // 1. Create the node self . mutableRendering = MutableProperty ( self . rootNode . render ()) // 2. Call render() WorkflowNode contains a SubtreeManager , whose primary purpose is to manage child workflows (more on this later). When render() gets invoked on the node, it calls render on the SubtreeManager and passes a closure that takes a RenderContext and returns a Rendering for the Workflow associated with the node. // WorkflowNode func render () -> WorkflowType . Rendering { return subtreeManager . render { context in return workflow . render ( state : state , context : context ) } } The SubtreeManager instantiates a RenderContext and invokes the closure that was passed in. This last step generates the Rendering . This Rendering then gets passed back up the call stack until it reaches the WorkflowHost .","title":"Initial pass"},{"location":"userguide/implementation/#composition","text":"In cases where a Workflow has child Workflow s, the render sequence is similar. The [tutorial] (../tutorial/building-a-workflow/#the-render-context) goes through this in more detail. Essentially, a Workflow containing child Workflow s calls render(context:key:outputMap:) on each child Workflow and passes in the RenderContext . The context does some bookkeeping for the child Workflow (creating or updating a ChildWorkflow ) and then calls render() . ChildWorkflow.render() calls render() on its WorkflowNode and we recurse back to step 2.","title":"Composition"},{"location":"userguide/testing-concepts/","text":"Workflow Testing \u00b6 Coming soon!","title":"Testing (TBD)"},{"location":"userguide/testing-concepts/#workflow-testing","text":"Coming soon!","title":"Workflow Testing"},{"location":"userguide/ui-concepts/","text":"Workflow UI \u00b6 This page provides a high level overview of Workflow UI, the companion that allows Workflow Core to drive Android and iOS apps. To see how these ideas are realized in code, move on to Coding Workflow UI . Warning The Screen interface that is so central to this discussion has reached Kotlin very recently, via v1.8.0-beta01 . Thus, if you are working against the most recent non-beta release, you will find the code blocks here don\u2019t match what you\u2019re seeing. Square is using the Screen machinery introduced with the beta at the heart of our Android app suite, and we expect the beta period to be a short one. The Swift Screen protocol et al. have been in steady use for years. What\u2019s a Screen? \u00b6 Most Workflow implementations produce struct / data class renderings that can serve as view models. Such a rendering provides enough data to paint a complete UI, including functions to be called in response to UI events. These view model renderings implement the Screen protocol / interface to advertise that this is their intended use. The core service provided by Workflow UI is to transform Screen types into platform-specific view objects, and to keep those views updated as new Screen renderings are emitted. Screen is the lynch pin that ties the Workflow Core and Workflow UI worlds together, the basic UI building block for Workflow-driven apps. A Screen is an object that can be presented as a basic 2D UI box, like an android.view.View or a UIViewController . And Workflow UI provides the glue that allows you to declare (at compile time!) that instances of FooScreen : Screen are used to drive FooViewController , layout/foo_screen.xml , or @Composable fun Content(FooScreen, ViewEnvironment) . Why \"Screen\"? We chose the name \u201cScreen\u201d because \u201cView\u201d would invite confusion with the like-named Android and iOS classes, and because \u201cBox\u201d didn\u2019t occur to us. (No one seems to have been bothered by the fact that Screen and iOS\u2019s UIScreen are unrelated.) And really, we went with \u201cScreen\u201d because it\u2019s the nebulous term that we and our users have always used to discuss our apps: \u201cGo to the Settings screen.\u201d \u201cHow do I get to the Tipping screen?\u201d \u201cThe Cart screen is shown in a modal over the Home screen on tablets.\u201d It\u2019s a safe bet you understood each of those sentences. Workflow Tree, Rendering Tree, View Tree \u00b6 In the Workflow Core page we discussed how Workflows can be composed as trees , like this email app driven by a trio of Workflows that assemble a composite SplitScreen rendering. Let\u2019s take a look at how Workflow UI transforms such a container screen into a container view . The main connection between the Workflow Core runtime and a native view system is the stream of Rendering objects from the root Workflow, EmailBrowserWorkflow in this discussion. From that point on, the flow of control is entirely in view-land. The precise details of that journey vary between Android and iOS in terms of naming, subclassing v. delegating, and so on, mainly to ensure that the API is idiomatic for each audience. None the less, the broad strokes are the same. (Move on to Coding Workflow UI to drill into the platform-specific details.) Each flavor of Workflow UI provides two core container helpers, both pictured below: A \u201cworkflow container\u201d, able to instantiate and update a view that can display Screen instances of the given type In iOS this is DescribedViewController For Android Classic we provide WorkflowViewStub , very similar to android.view.ViewStub . Android Jetpack Compose code can call @Compose fun WorkflowRendering() . A \u201cworkflow root container\u201d, able to field a stream of renderings from the Workflow Core runtime, and pass them on to a workflow container ContainerViewController for iOS WorkflowLayout for Android Classic @Compose fun Workflow.renderAsState() for Android Jetpack Compose When the runtime in our example is started, the flow is something like this: EmailBrowserWorkflow is asked for its first Rendering, a SplitScreen wrapping an InboxScreen and a MessageScreen . The Workflow root container receives that, and hands it off to its Workflow container . The container is able to resolve that SplitScreen instances can be displayed by views of the associated type Custom split view . The container builds that view, and passes it the SplitScreen . Custom split view is written with two Workflow containers of its own, one for the left side and for the right. The left hand container resolves InboxScreen to Custom inbox view , builds one, and hands the rendering that new view. The right hand container does the same for the MessageScreen , creating a Custom message view to display it. Sooner or later the state of EmailBrowserWorkflow or one of its children will change. Perhaps a new message has been received. Perhaps an event handler function on InboxScreen has been called because the user wants to read something else now. Regardless of where in the Workflow hierarchy the update happens, the entire tree will be re-rendered: EmailBrowserWorkflow will be asked for a new Rendering, it will ask its children for the same, and so on. Yes, everything renders when anything changes New Workflow developers generally freak out when they hear that the entire tree is re-rendered when any state anywhere updates. Remember that render() implementations are expected to be idempotent, and that their job is strictly declarative: render() effectively means \u201cI assume these children are running, and that I am subscribed to these work streams. Please make sure that stays the case, or fire up some new ones if needed.\u201d Another way is to think of them as declaring how to adapt the internal State into the external Rendering. These calls should be cheap, with all real work happening outside of the render() call. Optimizations may prevent rendering calls that are clearly redundant from being made, but semantically one should assume that the whole world is rendered when any part of the world changes. Once the runtime\u2019s Workflow tree finishes re-rendering, the new SplitScreen is passed through the native view system like so: The Workflow root container once again passes the new SplitScreen to its Workflow container , because that is the only trick it knows. That container recognizes that SplitScreen can be accepted by the Custom split view it created last time, and so there is no work to be done. The existing Custom split view receives the new SplitScreen . Just like last time, Custom split view passes InboxScreen to the Workflow container on its left, and MessageScreen to that on its right. The left hand Workflow container sees that it is already showing a Custom inbox view and passes InboxScreen rendering through. The same things happens with MessageScreen , and the Custom message view previously built by the right hand Workflow container . As is always the case with view code, Custom inbox view and Custom message view should be written with care to avoid redundant work, comparing what they are already showing with what they are being asked to show now. (A simple way to do this is to keep a Screen type\u2019s display data in a separate object from its event handlers, as an Equatable Swift struct, or as a Kotlin data class. Always hold on to the latest Screen in a var , and write UI click handlers and to reference it.) The update scenario would be different if the types of any of the Screen Renderings changed. Suppose our email app is able to host both email and voice mail in its inbox, and that the MessageScreen from the previous update is replaced with a VoicemailScreen this time. In that case, Custom message view would refuse the new Rendering, and the right hand Workflow container that created it would destroy it. A Custom voicemail view would be created in its stead, and that new view would paint itself with the information from the VoicemailScreen . So just how do these containers know what views to create for what Screen types? Those details are very language and platform specific, and are covered in the next page, under Building views from Screens . ViewEnvironment \u00b6 TK","title":"Workflow UI (in progress)"},{"location":"userguide/ui-concepts/#workflow-ui","text":"This page provides a high level overview of Workflow UI, the companion that allows Workflow Core to drive Android and iOS apps. To see how these ideas are realized in code, move on to Coding Workflow UI . Warning The Screen interface that is so central to this discussion has reached Kotlin very recently, via v1.8.0-beta01 . Thus, if you are working against the most recent non-beta release, you will find the code blocks here don\u2019t match what you\u2019re seeing. Square is using the Screen machinery introduced with the beta at the heart of our Android app suite, and we expect the beta period to be a short one. The Swift Screen protocol et al. have been in steady use for years.","title":"Workflow UI"},{"location":"userguide/ui-concepts/#whats-a-screen","text":"Most Workflow implementations produce struct / data class renderings that can serve as view models. Such a rendering provides enough data to paint a complete UI, including functions to be called in response to UI events. These view model renderings implement the Screen protocol / interface to advertise that this is their intended use. The core service provided by Workflow UI is to transform Screen types into platform-specific view objects, and to keep those views updated as new Screen renderings are emitted. Screen is the lynch pin that ties the Workflow Core and Workflow UI worlds together, the basic UI building block for Workflow-driven apps. A Screen is an object that can be presented as a basic 2D UI box, like an android.view.View or a UIViewController . And Workflow UI provides the glue that allows you to declare (at compile time!) that instances of FooScreen : Screen are used to drive FooViewController , layout/foo_screen.xml , or @Composable fun Content(FooScreen, ViewEnvironment) . Why \"Screen\"? We chose the name \u201cScreen\u201d because \u201cView\u201d would invite confusion with the like-named Android and iOS classes, and because \u201cBox\u201d didn\u2019t occur to us. (No one seems to have been bothered by the fact that Screen and iOS\u2019s UIScreen are unrelated.) And really, we went with \u201cScreen\u201d because it\u2019s the nebulous term that we and our users have always used to discuss our apps: \u201cGo to the Settings screen.\u201d \u201cHow do I get to the Tipping screen?\u201d \u201cThe Cart screen is shown in a modal over the Home screen on tablets.\u201d It\u2019s a safe bet you understood each of those sentences.","title":"What's a Screen?"},{"location":"userguide/ui-concepts/#workflow-tree-rendering-tree-view-tree","text":"In the Workflow Core page we discussed how Workflows can be composed as trees , like this email app driven by a trio of Workflows that assemble a composite SplitScreen rendering. Let\u2019s take a look at how Workflow UI transforms such a container screen into a container view . The main connection between the Workflow Core runtime and a native view system is the stream of Rendering objects from the root Workflow, EmailBrowserWorkflow in this discussion. From that point on, the flow of control is entirely in view-land. The precise details of that journey vary between Android and iOS in terms of naming, subclassing v. delegating, and so on, mainly to ensure that the API is idiomatic for each audience. None the less, the broad strokes are the same. (Move on to Coding Workflow UI to drill into the platform-specific details.) Each flavor of Workflow UI provides two core container helpers, both pictured below: A \u201cworkflow container\u201d, able to instantiate and update a view that can display Screen instances of the given type In iOS this is DescribedViewController For Android Classic we provide WorkflowViewStub , very similar to android.view.ViewStub . Android Jetpack Compose code can call @Compose fun WorkflowRendering() . A \u201cworkflow root container\u201d, able to field a stream of renderings from the Workflow Core runtime, and pass them on to a workflow container ContainerViewController for iOS WorkflowLayout for Android Classic @Compose fun Workflow.renderAsState() for Android Jetpack Compose When the runtime in our example is started, the flow is something like this: EmailBrowserWorkflow is asked for its first Rendering, a SplitScreen wrapping an InboxScreen and a MessageScreen . The Workflow root container receives that, and hands it off to its Workflow container . The container is able to resolve that SplitScreen instances can be displayed by views of the associated type Custom split view . The container builds that view, and passes it the SplitScreen . Custom split view is written with two Workflow containers of its own, one for the left side and for the right. The left hand container resolves InboxScreen to Custom inbox view , builds one, and hands the rendering that new view. The right hand container does the same for the MessageScreen , creating a Custom message view to display it. Sooner or later the state of EmailBrowserWorkflow or one of its children will change. Perhaps a new message has been received. Perhaps an event handler function on InboxScreen has been called because the user wants to read something else now. Regardless of where in the Workflow hierarchy the update happens, the entire tree will be re-rendered: EmailBrowserWorkflow will be asked for a new Rendering, it will ask its children for the same, and so on. Yes, everything renders when anything changes New Workflow developers generally freak out when they hear that the entire tree is re-rendered when any state anywhere updates. Remember that render() implementations are expected to be idempotent, and that their job is strictly declarative: render() effectively means \u201cI assume these children are running, and that I am subscribed to these work streams. Please make sure that stays the case, or fire up some new ones if needed.\u201d Another way is to think of them as declaring how to adapt the internal State into the external Rendering. These calls should be cheap, with all real work happening outside of the render() call. Optimizations may prevent rendering calls that are clearly redundant from being made, but semantically one should assume that the whole world is rendered when any part of the world changes. Once the runtime\u2019s Workflow tree finishes re-rendering, the new SplitScreen is passed through the native view system like so: The Workflow root container once again passes the new SplitScreen to its Workflow container , because that is the only trick it knows. That container recognizes that SplitScreen can be accepted by the Custom split view it created last time, and so there is no work to be done. The existing Custom split view receives the new SplitScreen . Just like last time, Custom split view passes InboxScreen to the Workflow container on its left, and MessageScreen to that on its right. The left hand Workflow container sees that it is already showing a Custom inbox view and passes InboxScreen rendering through. The same things happens with MessageScreen , and the Custom message view previously built by the right hand Workflow container . As is always the case with view code, Custom inbox view and Custom message view should be written with care to avoid redundant work, comparing what they are already showing with what they are being asked to show now. (A simple way to do this is to keep a Screen type\u2019s display data in a separate object from its event handlers, as an Equatable Swift struct, or as a Kotlin data class. Always hold on to the latest Screen in a var , and write UI click handlers and to reference it.) The update scenario would be different if the types of any of the Screen Renderings changed. Suppose our email app is able to host both email and voice mail in its inbox, and that the MessageScreen from the previous update is replaced with a VoicemailScreen this time. In that case, Custom message view would refuse the new Rendering, and the right hand Workflow container that created it would destroy it. A Custom voicemail view would be created in its stead, and that new view would paint itself with the information from the VoicemailScreen . So just how do these containers know what views to create for what Screen types? Those details are very language and platform specific, and are covered in the next page, under Building views from Screens .","title":"Workflow Tree, Rendering Tree, View Tree"},{"location":"userguide/ui-concepts/#viewenvironment","text":"TK","title":"ViewEnvironment"},{"location":"userguide/ui-in-code/","text":"Coding Workflow UI \u00b6 This page translates the high level discussion of Workflow UI into Android and iOS code. Separation of Concerns \u00b6 Workflow maintains a rigid separation between its core runtime and its UI support. The Workflow Core modules are strictly Swift and Kotlin, with no dependencies on any UI framework. Dependencies on Android and iOS are restricted to the Workflow UI modules, as you would expect. This innate separation naturally puts developers on a path to avoid entangling view concerns with their app logic. And note that we say \u201capp logic\u201d rather than \u201cbusiness logic.\u201d In any interesting app, the code that manages navigation and other UI-releated behavior is likely to dwarf that for what we typically think of as model concerns, in both size and complexity. We\u2019re all pretty good at capturing business concerns in tidy object-oriented models of items for sale, shopping carts, payment cards and the like, nicely decoupled from the UI world. But the rest of the app, and in particular the bits about how our users navigate it? Traditionally it\u2019s hard to keep that app-specific logic centralized, so that you can see what\u2019s going on; and even harder to keep it decoupled from your view system, so that it\u2019s easy to test. The strict divide between Workflow UI and Workflow Core leads you to maintain that separation by accident. Bootstrapping \u00b6 The following snippets demonstrate using Workflow to drive the root views of iOS and Android apps. But really, you can host a Workflow driven UI anywhere you can show a view, whatever \u201cview\u201d means on your platform. iOS @UIApplicationMain class AppDelegate : UIResponder , UIApplicationDelegate { var window : UIWindow ? func application ( _ application : UIApplication , didFinishLaunchingWithOptions launchOptions : [ UIApplication . LaunchOptionsKey : Any ]?) -> Bool { window = UIWindow ( frame : UIScreen . main . bounds ) window ?. rootViewController = ContainerViewController ( workflow : RootWorkflow ()) window ?. makeKeyAndVisible () return true } } Android Classic Android classic makes things a little complicated (naturally), as your Workflow runtime has to survive configuration changes. Our habit is use a Jetpack ViewModel to solve that problem, on what is typically the only line of code in a Workflow app that deals with the Jetpack Lifecycle at all. HelloWorkflowActivity.kt class HelloWorkflowActivity : AppCompatActivity () { override fun onCreate ( savedInstanceState : Bundle?) { super . onCreate ( savedInstanceState ) // This ViewModel will survive configuration changes. It's instantiated // by the first call to androidx.activity.viewModels(), and that // original instance is returned by succeeding calls. val model : HelloViewModel by viewModels () setContentView ( WorkflowLayout ( this ). apply { take ( lifecycle , model . renderings ) } ) } } class HelloViewModel ( savedState : SavedStateHandle ) : ViewModel () { val renderings : StateFlow < HelloRendering > by lazy { renderWorkflowIn ( workflow = HelloWorkflow , scope = viewModelScope , savedStateHandle = savedState ) } } Android Jetpack Compose HelloComposeActivity.kt class HelloComposeActivity : AppCompatActivity () { override fun onCreate ( savedInstanceState : Bundle?) { super . onCreate ( savedInstanceState ) setContent { val rendering by HelloWorkflow . renderAsState ( props = Unit , onOutput = {}) WorkflowRendering ( rendering , ViewEnvironment . EMPTY ) } } } Android developers should note that classic and Compose bootstrapping are completely interchangeable. Each style is able to display Screens of any type, regardless of whether they are set up to inflate View instances or to run @Composeable functions. Building views from Screens \u00b6 Hello, Screen world. iOS WelcomeScreen.swift struct WelcomeScreen : Screen { var name : String var onNameChanged : ( String ) -> Void var onLoginTapped : () -> Void func viewControllerDescription ( environment : ViewEnvironment ) -> ViewControllerDescription { return WelcomeViewController . description ( for : self , environment : environment ) } } private final class WelcomeViewController : ScreenViewController < WelcomeScreen > { override func viewDidLoad () { \u2026 } override func viewDidLayoutSubviews () { \u2026 } override func screenDidChange ( from previousScreen : WelcomeScreen , previousEnvironment : ViewEnvironment ) { super . screenDidChange ( from : previousScreen , previousEnvironment : previousEnvironment ) nameField . text = screen . name } } iOS Screen classes are expected to provide matching ViewControllerDescription instances. A ViewControllerDescription can build a UIViewController on demand, or update an existing one if it\u2019s recognized by ViewControllerDescription.canUpdate(UIViewController) . These duties are all fullfilled by the provided open class ScreenViewController . It\u2019s like any other ViewController , with the addition of: an open screenDidChange() method that the Workflow UI runtime calls with a series of Screen instances of the specified type a description() class method, perfect for calling from Screen.viewcontrollerDescription() Android Classic HelloScreen.kt data class HelloScreen ( val message : String , val onClick : () -> Unit ) : AndroidScreen < HelloScreen > { override val viewFactory : ScreenViewFactory < HelloScreen > = fromViewBinding ( HelloViewBinding :: inflate ) { helloScreen , viewEnvironment -> helloMessage . text = helloScreen . message helloMessage . setOnClickListener { helloScreen . onClick () } } } The Android Screen interface is purely a marker type. It defines no Android-specific methods to ensure you have the option of keeping your app logic pure. If you don\u2019t need that rigor, life is simpler (and safer, no runtime errors) if your Screen renderings implement AndroidScreen instead. An AndroidScreen is required to provide a matching ScreenViewFactory . ScreenViewFactory returns View instances wrapped in ScreenViewHolder objects. ScreenViewHolder.show is called by the Workflow UI runtime to update the view with Screen instances that are deemed acceptible by ScreenViewHolder.canShow . In this example the fromViewBinding function creates a ScreenViewFactory that builds View instances using a Jetpack View Binding , HelloViewBinding , presumably derived from hello_view_binding.xml . The lamda argument to the fromViewBinding provides the implementation for ScreenViewHolder.show , and is guaranteed that the given helloScreen parameter is of the appropriate type. Other factory functions are provided to work with layout resources directly, or to build views entirely from code. Android Jetpack Compose HelloScreen.kt data class HelloScreen ( val message : String , val onClick : () -> Unit ) : ComposeScreen < HelloScreen > { @Composable override fun Content ( viewEnvironment : ViewEnvironment ) { Button ( onClick ) { Text ( message ) } } } Here, HelloScreen is implementing ComposeScreen . ComposeScreen extends the same AndroidScreen class used for classic Android, defining @Composable fun Content() to get its work done. Content is always called from a @Composable Box() context. It\u2019s context aware Even though AndroidScreen provides a thing called ScreenViewFactory to do its work, the factories built by ComposeScreen are able to recognize whether they\u2019re being called from a classic View or from a @Composeable function, and do the right thing. Workflow UI only creates ComposeView instances as needed: when a @Composeable needs to be shown in a View . If the factory is to be used in a @Composable context, Content() is called directly. Where is that \u201cseparation of concerns\u201d you promised? \u00b6 After all the chest-thumping above about Separation of Concerns , the code samples above probably look pretty entangled. That\u2019s because, while the Workflow libraries themselves are completely decoupled, they don\u2019t force that strict rigor on your app code. If you aren\u2019t building, say, a core Workflow module that you want to ship separately from its Android and command line interfaces, you\u2019d probably gain nothing from enforced separation but boilerplate and runtime errors. And in practice, your Workflow unit tests won\u2019t call viewFactory and will build and run just fine against the JVM. Likewise, at this point we\u2019ve been building apps this way for hundreds of engineering years, and so far no one has called viewControllerDescription() and stashed a UIViewController in their workflow state. (This is not a challenge.) If you are one of the few who truly do need impermeable boundaries between your core and UI modules, they aren\u2019t hard to get. Your Screen implementations can be defined completely separately from their view code and bound later. iOS WelcomeScreen.swift struct WelcomeScreen { var name : String var onNameChanged : ( String ) -> Void var onLoginTapped : () -> Void } WelcomeViewController.swift extension WelcomeScreen : Screen { func viewControllerDescription ( environment : ViewEnvironment ) -> ViewControllerDescription { return WelcomeViewController . description ( for : self , environment : environment ) } } private final class WelcomeViewController : ScreenViewController < WelcomeScreen > { // ... Android HelloScreen.kt data class HelloScreen ( val message : String , val onClick : () -> Unit ) : Screen HelloWorkflowGreenTheme.kt private object HelloScreenGreenThemeViewFactory : ScreenViewFactory < HelloScreen > by ScreenViewFactory . fromViewBinding ( GreenHelloViewBinding :: inflate ) { r , _ -> helloMessage . text = r . message helloMessage . setOnClickListener { r . onClick () } } } private val viewRegistry = ViewRegistry ( HelloScreenGreenThemeViewFactory ) val HelloWorkflowGreenTheme = HelloWorkflow . mapRenderings { it . withRegistry ( viewRegistry ) } Container screens make container views \u00b6 A container screen is one that is built out of other Screens. And naturally enough, the thing that a container screen drives is a container view : one that is able to host child views that are driven by Screen instances of arbitrary type. Workflow UI provides two root container views out of the box, the ContainerViewController and WorkflowLayout classes discussed above, under Bootstrapping . They do most of their work by delegating to another pair of support view classes: ScreenViewController for iOS and WorkflowViewStub for Android. Android also provides @Composable fun WorkflowRendering() for use with Jetpack Compose. For something like a SplitScreen rendering, you\u2019ll write your own view code that does the same. iOS SplitScreen.swift public struct SplitScreen < LeadingScreenType : Screen , TrailingScreenType : Screen >: Screen { public let leadingScreen : LeadingScreenType public let trailingScreen : TrailingScreenType public func viewControllerDescription ( environment : ViewEnvironment ) -> ViewControllerDescription { return SplitScreenViewController . description ( for : self , environment : environment ) } SplitScreenViewController.swift internal final class SplitScreenViewController < LeadingScreenType : Screen , TrailingScreenType : Screen >: ScreenViewController < SplitScreenViewController . ContainerScreen > { internal typealias ContainerScreen = SplitScreen < LeadingScreenType , TrailingScreenType > private var leadingContentViewController : DescribedViewController private lazy var leadingContainerView : ContainerView = . init () private lazy var separatorView : UIView = . init () private var trailingContentViewController : DescribedViewController private lazy var trailingContainerView : ContainerView = . init () required init ( screen : ContainerScreen , environment : ViewEnvironment ) { self . leadingContentViewController = DescribedViewController ( screen : screen . leadingScreen , environment : environment ) self . trailingContentViewController = DescribedViewController ( screen : screen . trailingScreen , environment : environment ) super . init ( screen : screen , environment : environment ) } override internal func screenDidChange ( from previousScreen : ContainerScreen , previousEnvironment : ViewEnvironment ) { super . screenDidChange ( from : previousScreen , previousEnvironment : previousEnvironment ) update ( with : screen ) } private func update ( with screen : ContainerScreen ) { leadingContentViewController . update ( screen : screen . leadingScreen , environment : environment ) trailingContentViewController . update ( screen : screen . trailingScreen , environment : environment ) // Intentional force of layout pass after updating the child view controllers view . layoutIfNeeded () } override internal func viewDidLoad () { /** Lay out the two children horizontally, nothing workflow specific here. */ update ( with : screen ) } override internal func viewDidLayoutSubviews () { /** Calculate the layout, nothing workflow specific here. */ } The interesting thing here is the use of DescribedViewController to display the nested leadingContent and trailingContent Screens. DescribedViewController uses Screen.viewControllerDescription to build a new UIViewController if it needs to, or update an existing one if it can. Everything else is just run of the mill iOS view code. Android Classic SplitScreen.kt data class SplitScreen < L : Screen , T : Screen > ( val leadingScreen : L , val trailingScreen : T ): AndroidScreen < SplitScreen < L , T >> { override val viewFactory : ScreenViewFactory < SplitScreen < L , T >> = fromViewBinding ( SplitScreenBinding :: inflate ) { screen , _ -> leadingStub . show ( leadingScreen ) trailingStub . show ( trailingScreen ) } } split_screen.xml Android Jetpack Compose SplitScreen.kt data class SplitScreen < L : Screen , T : Screen > ( val leadingScreen : L , val trailingScreen : T ): ComposeScreen < SplitScreen < L , T >> { @Composable override fun Content ( viewEnvironment : ViewEnvironment ) { Row { WorkflowRendering ( rendering = leadingScreen , modifier = Modifier . weight ( 1 / 3f ) . fillMaxHeight () ) WorkflowRendering ( rendering = trailingScreen , modifier = Modifier . weight ( 2 / 3f ) . fillMaxHeight () ) } } }","title":"Coding Workflow UI (in progress)"},{"location":"userguide/ui-in-code/#coding-workflow-ui","text":"This page translates the high level discussion of Workflow UI into Android and iOS code.","title":"Coding Workflow UI"},{"location":"userguide/ui-in-code/#separation-of-concerns","text":"Workflow maintains a rigid separation between its core runtime and its UI support. The Workflow Core modules are strictly Swift and Kotlin, with no dependencies on any UI framework. Dependencies on Android and iOS are restricted to the Workflow UI modules, as you would expect. This innate separation naturally puts developers on a path to avoid entangling view concerns with their app logic. And note that we say \u201capp logic\u201d rather than \u201cbusiness logic.\u201d In any interesting app, the code that manages navigation and other UI-releated behavior is likely to dwarf that for what we typically think of as model concerns, in both size and complexity. We\u2019re all pretty good at capturing business concerns in tidy object-oriented models of items for sale, shopping carts, payment cards and the like, nicely decoupled from the UI world. But the rest of the app, and in particular the bits about how our users navigate it? Traditionally it\u2019s hard to keep that app-specific logic centralized, so that you can see what\u2019s going on; and even harder to keep it decoupled from your view system, so that it\u2019s easy to test. The strict divide between Workflow UI and Workflow Core leads you to maintain that separation by accident.","title":"Separation of Concerns"},{"location":"userguide/ui-in-code/#bootstrapping","text":"The following snippets demonstrate using Workflow to drive the root views of iOS and Android apps. But really, you can host a Workflow driven UI anywhere you can show a view, whatever \u201cview\u201d means on your platform. iOS @UIApplicationMain class AppDelegate : UIResponder , UIApplicationDelegate { var window : UIWindow ? func application ( _ application : UIApplication , didFinishLaunchingWithOptions launchOptions : [ UIApplication . LaunchOptionsKey : Any ]?) -> Bool { window = UIWindow ( frame : UIScreen . main . bounds ) window ?. rootViewController = ContainerViewController ( workflow : RootWorkflow ()) window ?. makeKeyAndVisible () return true } } Android Classic Android classic makes things a little complicated (naturally), as your Workflow runtime has to survive configuration changes. Our habit is use a Jetpack ViewModel to solve that problem, on what is typically the only line of code in a Workflow app that deals with the Jetpack Lifecycle at all. HelloWorkflowActivity.kt class HelloWorkflowActivity : AppCompatActivity () { override fun onCreate ( savedInstanceState : Bundle?) { super . onCreate ( savedInstanceState ) // This ViewModel will survive configuration changes. It's instantiated // by the first call to androidx.activity.viewModels(), and that // original instance is returned by succeeding calls. val model : HelloViewModel by viewModels () setContentView ( WorkflowLayout ( this ). apply { take ( lifecycle , model . renderings ) } ) } } class HelloViewModel ( savedState : SavedStateHandle ) : ViewModel () { val renderings : StateFlow < HelloRendering > by lazy { renderWorkflowIn ( workflow = HelloWorkflow , scope = viewModelScope , savedStateHandle = savedState ) } } Android Jetpack Compose HelloComposeActivity.kt class HelloComposeActivity : AppCompatActivity () { override fun onCreate ( savedInstanceState : Bundle?) { super . onCreate ( savedInstanceState ) setContent { val rendering by HelloWorkflow . renderAsState ( props = Unit , onOutput = {}) WorkflowRendering ( rendering , ViewEnvironment . EMPTY ) } } } Android developers should note that classic and Compose bootstrapping are completely interchangeable. Each style is able to display Screens of any type, regardless of whether they are set up to inflate View instances or to run @Composeable functions.","title":"Bootstrapping"},{"location":"userguide/ui-in-code/#building-views-from-screens","text":"Hello, Screen world. iOS WelcomeScreen.swift struct WelcomeScreen : Screen { var name : String var onNameChanged : ( String ) -> Void var onLoginTapped : () -> Void func viewControllerDescription ( environment : ViewEnvironment ) -> ViewControllerDescription { return WelcomeViewController . description ( for : self , environment : environment ) } } private final class WelcomeViewController : ScreenViewController < WelcomeScreen > { override func viewDidLoad () { \u2026 } override func viewDidLayoutSubviews () { \u2026 } override func screenDidChange ( from previousScreen : WelcomeScreen , previousEnvironment : ViewEnvironment ) { super . screenDidChange ( from : previousScreen , previousEnvironment : previousEnvironment ) nameField . text = screen . name } } iOS Screen classes are expected to provide matching ViewControllerDescription instances. A ViewControllerDescription can build a UIViewController on demand, or update an existing one if it\u2019s recognized by ViewControllerDescription.canUpdate(UIViewController) . These duties are all fullfilled by the provided open class ScreenViewController . It\u2019s like any other ViewController , with the addition of: an open screenDidChange() method that the Workflow UI runtime calls with a series of Screen instances of the specified type a description() class method, perfect for calling from Screen.viewcontrollerDescription() Android Classic HelloScreen.kt data class HelloScreen ( val message : String , val onClick : () -> Unit ) : AndroidScreen < HelloScreen > { override val viewFactory : ScreenViewFactory < HelloScreen > = fromViewBinding ( HelloViewBinding :: inflate ) { helloScreen , viewEnvironment -> helloMessage . text = helloScreen . message helloMessage . setOnClickListener { helloScreen . onClick () } } } The Android Screen interface is purely a marker type. It defines no Android-specific methods to ensure you have the option of keeping your app logic pure. If you don\u2019t need that rigor, life is simpler (and safer, no runtime errors) if your Screen renderings implement AndroidScreen instead. An AndroidScreen is required to provide a matching ScreenViewFactory . ScreenViewFactory returns View instances wrapped in ScreenViewHolder objects. ScreenViewHolder.show is called by the Workflow UI runtime to update the view with Screen instances that are deemed acceptible by ScreenViewHolder.canShow . In this example the fromViewBinding function creates a ScreenViewFactory that builds View instances using a Jetpack View Binding , HelloViewBinding , presumably derived from hello_view_binding.xml . The lamda argument to the fromViewBinding provides the implementation for ScreenViewHolder.show , and is guaranteed that the given helloScreen parameter is of the appropriate type. Other factory functions are provided to work with layout resources directly, or to build views entirely from code. Android Jetpack Compose HelloScreen.kt data class HelloScreen ( val message : String , val onClick : () -> Unit ) : ComposeScreen < HelloScreen > { @Composable override fun Content ( viewEnvironment : ViewEnvironment ) { Button ( onClick ) { Text ( message ) } } } Here, HelloScreen is implementing ComposeScreen . ComposeScreen extends the same AndroidScreen class used for classic Android, defining @Composable fun Content() to get its work done. Content is always called from a @Composable Box() context. It\u2019s context aware Even though AndroidScreen provides a thing called ScreenViewFactory to do its work, the factories built by ComposeScreen are able to recognize whether they\u2019re being called from a classic View or from a @Composeable function, and do the right thing. Workflow UI only creates ComposeView instances as needed: when a @Composeable needs to be shown in a View . If the factory is to be used in a @Composable context, Content() is called directly.","title":"Building views from Screens"},{"location":"userguide/ui-in-code/#where-is-that-separation-of-concerns-you-promised","text":"After all the chest-thumping above about Separation of Concerns , the code samples above probably look pretty entangled. That\u2019s because, while the Workflow libraries themselves are completely decoupled, they don\u2019t force that strict rigor on your app code. If you aren\u2019t building, say, a core Workflow module that you want to ship separately from its Android and command line interfaces, you\u2019d probably gain nothing from enforced separation but boilerplate and runtime errors. And in practice, your Workflow unit tests won\u2019t call viewFactory and will build and run just fine against the JVM. Likewise, at this point we\u2019ve been building apps this way for hundreds of engineering years, and so far no one has called viewControllerDescription() and stashed a UIViewController in their workflow state. (This is not a challenge.) If you are one of the few who truly do need impermeable boundaries between your core and UI modules, they aren\u2019t hard to get. Your Screen implementations can be defined completely separately from their view code and bound later. iOS WelcomeScreen.swift struct WelcomeScreen { var name : String var onNameChanged : ( String ) -> Void var onLoginTapped : () -> Void } WelcomeViewController.swift extension WelcomeScreen : Screen { func viewControllerDescription ( environment : ViewEnvironment ) -> ViewControllerDescription { return WelcomeViewController . description ( for : self , environment : environment ) } } private final class WelcomeViewController : ScreenViewController < WelcomeScreen > { // ... Android HelloScreen.kt data class HelloScreen ( val message : String , val onClick : () -> Unit ) : Screen HelloWorkflowGreenTheme.kt private object HelloScreenGreenThemeViewFactory : ScreenViewFactory < HelloScreen > by ScreenViewFactory . fromViewBinding ( GreenHelloViewBinding :: inflate ) { r , _ -> helloMessage . text = r . message helloMessage . setOnClickListener { r . onClick () } } } private val viewRegistry = ViewRegistry ( HelloScreenGreenThemeViewFactory ) val HelloWorkflowGreenTheme = HelloWorkflow . mapRenderings { it . withRegistry ( viewRegistry ) }","title":"Where is that \"separation of concerns\" you promised?"},{"location":"userguide/ui-in-code/#container-screens-make-container-views","text":"A container screen is one that is built out of other Screens. And naturally enough, the thing that a container screen drives is a container view : one that is able to host child views that are driven by Screen instances of arbitrary type. Workflow UI provides two root container views out of the box, the ContainerViewController and WorkflowLayout classes discussed above, under Bootstrapping . They do most of their work by delegating to another pair of support view classes: ScreenViewController for iOS and WorkflowViewStub for Android. Android also provides @Composable fun WorkflowRendering() for use with Jetpack Compose. For something like a SplitScreen rendering, you\u2019ll write your own view code that does the same. iOS SplitScreen.swift public struct SplitScreen < LeadingScreenType : Screen , TrailingScreenType : Screen >: Screen { public let leadingScreen : LeadingScreenType public let trailingScreen : TrailingScreenType public func viewControllerDescription ( environment : ViewEnvironment ) -> ViewControllerDescription { return SplitScreenViewController . description ( for : self , environment : environment ) } SplitScreenViewController.swift internal final class SplitScreenViewController < LeadingScreenType : Screen , TrailingScreenType : Screen >: ScreenViewController < SplitScreenViewController . ContainerScreen > { internal typealias ContainerScreen = SplitScreen < LeadingScreenType , TrailingScreenType > private var leadingContentViewController : DescribedViewController private lazy var leadingContainerView : ContainerView = . init () private lazy var separatorView : UIView = . init () private var trailingContentViewController : DescribedViewController private lazy var trailingContainerView : ContainerView = . init () required init ( screen : ContainerScreen , environment : ViewEnvironment ) { self . leadingContentViewController = DescribedViewController ( screen : screen . leadingScreen , environment : environment ) self . trailingContentViewController = DescribedViewController ( screen : screen . trailingScreen , environment : environment ) super . init ( screen : screen , environment : environment ) } override internal func screenDidChange ( from previousScreen : ContainerScreen , previousEnvironment : ViewEnvironment ) { super . screenDidChange ( from : previousScreen , previousEnvironment : previousEnvironment ) update ( with : screen ) } private func update ( with screen : ContainerScreen ) { leadingContentViewController . update ( screen : screen . leadingScreen , environment : environment ) trailingContentViewController . update ( screen : screen . trailingScreen , environment : environment ) // Intentional force of layout pass after updating the child view controllers view . layoutIfNeeded () } override internal func viewDidLoad () { /** Lay out the two children horizontally, nothing workflow specific here. */ update ( with : screen ) } override internal func viewDidLayoutSubviews () { /** Calculate the layout, nothing workflow specific here. */ } The interesting thing here is the use of DescribedViewController to display the nested leadingContent and trailingContent Screens. DescribedViewController uses Screen.viewControllerDescription to build a new UIViewController if it needs to, or update an existing one if it can. Everything else is just run of the mill iOS view code. Android Classic SplitScreen.kt data class SplitScreen < L : Screen , T : Screen > ( val leadingScreen : L , val trailingScreen : T ): AndroidScreen < SplitScreen < L , T >> { override val viewFactory : ScreenViewFactory < SplitScreen < L , T >> = fromViewBinding ( SplitScreenBinding :: inflate ) { screen , _ -> leadingStub . show ( leadingScreen ) trailingStub . show ( trailingScreen ) } } split_screen.xml Android Jetpack Compose SplitScreen.kt data class SplitScreen < L : Screen , T : Screen > ( val leadingScreen : L , val trailingScreen : T ): ComposeScreen < SplitScreen < L , T >> { @Composable override fun Content ( viewEnvironment : ViewEnvironment ) { Row { WorkflowRendering ( rendering = leadingScreen , modifier = Modifier . weight ( 1 / 3f ) . fillMaxHeight () ) WorkflowRendering ( rendering = trailingScreen , modifier = Modifier . weight ( 2 / 3f ) . fillMaxHeight () ) } } }","title":"Container screens make container views"},{"location":"userguide/whyworkflow/","text":"Why Workflow? \u00b6 So you want me to take the application feature I have to develop and break it down into separate components? And then enumerate every possible state for each of those components? As well as writing classes or structs that represent each of these states in addition to the collection of objects that each component might pass to another? That sounds like a lot of work just to help the seller order a set of gift cards! Why make something simple so complicated? Why should I use Workflow? I think even those of us who use Workflow all the time end up asking this question. It\u2019s a very reasonable question that we try to answer here. At the heart of the matter, there are two complementary justifications for Workflow, which we will expand on below: Software clarity, correctness, and testability (especially at scale). Encouraging programming paradigms that are best practices for the mobile domain. Software clarity, correctness, and testability (at scale) \u00b6 I like to think that most of us have been there: It\u2019s our second straight day staring at the logs from over 200 customers. We know what the problem is : the user gets to screen Y and object foo\u2019s state is bar, but foo should not be bar while in screen Y. Why is foo bar? Unfortunately we don\u2019t have any debug log for foo\u2019s state at the time we start screen Y. We only have one when the user tries to click on button Z, and at that point the state is already bar even though it should only ever be baz or buz. What happened? How did foo get to state bar on screen Y? Looking at the code, foo is shared state with 15 other screens, and it is mutable in all of them. The logic to update foo\u2019s state in screen Y happens in code that is coupled to interaction with button Z, so we cannot simply add a unit test for this, we need a complex UI test to reproduce screen Y. We don\u2019t know how the problem happened and it almost seems like we can\u2019t know how without significant effort! The story above is a little dramatic but I hope the feeling it invokes is familiar. It is a daunting task to reason through application code and build up a sufficient mental model of all possible side effects in any one feature area. Now scale up the numbers a bit \u2014 foo is shared by 150 other screens \u2014 and the once daunting task seems almost impossible. All mobile developers face some form of the above problem, and at Square within our Point of Sale applications we face the scaled up version every day. What do we want? \u00b6 Clear boundaries between each feature\u2019s software components that can be instrumented with logs and that have contracts that can be tested. Clear expectations for outcomes within a particular feature\u2019s software component that can be verified for correctness with tests. Immutable State within any particular scope (e.g. Screen Y in the context above) so that the code handling mutations to provide a new State as a result of some event is in a \u201cprotected area\u201d that can be instrumented and tested. A clear separation of the State updates from the presentation of the UI. We want the conditions above because we want: Not to have bugs like the one we started this discussion with. In other words, we want our tests to give us confidence in our application logic. In the inevitable case that we do have a bug, we want to be able to isolate the scenario, reproduce the exact conditions, fix the bug and write a test so that it doesn\u2019t happen again. Workflow facilitates these goals for native mobile applications by providing a pattern (and a supporting application Runtime) similar to React, Elm, or any number of other web application JavaScript frameworks (not to mention forthcoming native mobile frameworks such as Jetpack Compose and SwiftUI). Each logical component area is separated into a Workflow with a finite set of states and the logic to transition between them. Workflows can be composed together for a full feature with each Workflow\u2019s signature specifying a clear contract. The Workflow Runtime\u2019s event loop handles the production of new immutable states for each Workflow so that within the Workflow render logic it is immutable. Workflows can be executed and instrumented in a testable way with extra hooks for simple verification of outcomes in unit tests. On an even simpler level Workflow improves clarity by giving a large team of developers a shared idiom of software components with which to discuss business logic across feature areas, and across mobile platforms (Android, iOS). Further, as the application is composed with multiple Workflows, the framework enables loose coupling between features to focus the impact of code changes. Encouraging programming paradigms that are best practices for the mobile domain \u00b6 Mobile applications receive and display a lot of data! Our applications at Square certainly do. As a result of this, there is a growing trend towards reactive programming for mobile applications. In this paradigm, the application logic subscribes to a stream of data which is then pushed to the logic rather than having to be periodically pulled and operated on. This has the profound effect of ensuring that the data shown to the application user is never stale. This style of programming also makes clear that most mobile applications are a series of mapping operations on a stream of data that is eventually mapped into some UI. Another mobile programming best practice (arising out of a long tradition) is to favor declarative programming over imperative programming . With this style choice, the code for a feature declares what should be occurring for a particular state, rather than consisting of a series of statements that are essentially how to make that occur. This is a best practice because when a program\u2019s logic is defined in this way, it is very simple to test (so more likely to be tested!): \u201cFor state Y we expect Rendering Z;\u201d \u201cFrom state Y given input A we expect Rendering Z+.\u201d Possibly more important, it is easier to read, comprehend quickly, and to reason about than a series of complex commands for the computer. Workflows encourage a declarative style because each state of a particular component must be enumerated and then the Rendering (representation that gets passed to the UI framework) is declared for that particular state, alongside a declaration of what children and side effects should be running in that state. The well-tested and reliable Workflow runtime loop itself handles how to start and stop the children and side effects, reducing resource leaks. By requiring these formal definitions of each State, Rendering, and the Actions that will change the current state, Workflow naturally encourages declarative programming. While reactive and declarative programming may be current best practices, there is one Software Engineering principle that has proven over and over again to be the most universal and the most important for systems of scale: Separation of Concerns . Any system of scale requires multiple separate components that can be worked on, tested, improved, and refactored independently by multiple teams of people. A system of multiple components requires communication and any good communication begs explicit structure and contracts. For mobile applications at Square we have settled on the Model-View-ViewModel (MVVM) architecture as the structure for the topical separation of concerns of the layers of the application. MVVM\u2019s unidirectional layered communication is the same as that of Model-View-Presenter (MVP), as opposed to the \u2018circular\u2019 communication of Model-View-Controller (MVC). MVVM\u2019s use of a strict binding between the ViewModel and the View is the same as MVC, as opposed to the imperative interpretation of the Model in MVP. MVVM provides the reasoning and comprehension benefits of unidirectional data flow while also eliminating as much business logic as possible from the view layer and encouraging declarative ViewModels. At Square this works well because we have UI design frameworks that change infrequently (so keeping bindings up-to-date is not much overhead), but business logic that is constantly being updated (so emphasizing low coupling is important). Workflows embrace MVVM because the Rendering produced by a Workflow tree is the ViewModel, which can then be bound to any native mobile UI framework. For feature based separation of concerns we lean on Workflow\u2019s facility for composition at scale via strong parent-child contracts and a hierarchical tree organization. While building a Hello World Workflow may seem like overkill (although it\u2019s really not that bad!), the explicitness and contracts that Workflows require of the developer lay the structure for good communication. The composability of Workflows encourages reuse and encourages separation of concerns into the most appropriate reusable components. There are even more platform-specific best practices that Workflow dovetails well with, such as structured concurrency with Kotlin coroutines, as each Worker or side effect can define a specific coroutine scope for the operations. What about the next 10 years? Jetpack Compose UI and SwiftUI are establishing themselves as the native mobile UI toolkits of the future. They both embrace the same MVVM approach that Workflow does, and encourage thinking about the \u201ccomposability\u201d of separate components of your application. With this resonance, Workflows help you to prepare your mental model to adapt to these new UI toolkits, and shapes our codebase in a way that will ease our adoption of them. To learn more about Compose and Workflow see this post .","title":"Why Workflow?"},{"location":"userguide/whyworkflow/#why-workflow","text":"So you want me to take the application feature I have to develop and break it down into separate components? And then enumerate every possible state for each of those components? As well as writing classes or structs that represent each of these states in addition to the collection of objects that each component might pass to another? That sounds like a lot of work just to help the seller order a set of gift cards! Why make something simple so complicated? Why should I use Workflow? I think even those of us who use Workflow all the time end up asking this question. It\u2019s a very reasonable question that we try to answer here. At the heart of the matter, there are two complementary justifications for Workflow, which we will expand on below: Software clarity, correctness, and testability (especially at scale). Encouraging programming paradigms that are best practices for the mobile domain.","title":"Why Workflow?"},{"location":"userguide/whyworkflow/#software-clarity-correctness-and-testability-at-scale","text":"I like to think that most of us have been there: It\u2019s our second straight day staring at the logs from over 200 customers. We know what the problem is : the user gets to screen Y and object foo\u2019s state is bar, but foo should not be bar while in screen Y. Why is foo bar? Unfortunately we don\u2019t have any debug log for foo\u2019s state at the time we start screen Y. We only have one when the user tries to click on button Z, and at that point the state is already bar even though it should only ever be baz or buz. What happened? How did foo get to state bar on screen Y? Looking at the code, foo is shared state with 15 other screens, and it is mutable in all of them. The logic to update foo\u2019s state in screen Y happens in code that is coupled to interaction with button Z, so we cannot simply add a unit test for this, we need a complex UI test to reproduce screen Y. We don\u2019t know how the problem happened and it almost seems like we can\u2019t know how without significant effort! The story above is a little dramatic but I hope the feeling it invokes is familiar. It is a daunting task to reason through application code and build up a sufficient mental model of all possible side effects in any one feature area. Now scale up the numbers a bit \u2014 foo is shared by 150 other screens \u2014 and the once daunting task seems almost impossible. All mobile developers face some form of the above problem, and at Square within our Point of Sale applications we face the scaled up version every day.","title":"Software clarity, correctness, and testability (at scale)"},{"location":"userguide/whyworkflow/#what-do-we-want","text":"Clear boundaries between each feature\u2019s software components that can be instrumented with logs and that have contracts that can be tested. Clear expectations for outcomes within a particular feature\u2019s software component that can be verified for correctness with tests. Immutable State within any particular scope (e.g. Screen Y in the context above) so that the code handling mutations to provide a new State as a result of some event is in a \u201cprotected area\u201d that can be instrumented and tested. A clear separation of the State updates from the presentation of the UI. We want the conditions above because we want: Not to have bugs like the one we started this discussion with. In other words, we want our tests to give us confidence in our application logic. In the inevitable case that we do have a bug, we want to be able to isolate the scenario, reproduce the exact conditions, fix the bug and write a test so that it doesn\u2019t happen again. Workflow facilitates these goals for native mobile applications by providing a pattern (and a supporting application Runtime) similar to React, Elm, or any number of other web application JavaScript frameworks (not to mention forthcoming native mobile frameworks such as Jetpack Compose and SwiftUI). Each logical component area is separated into a Workflow with a finite set of states and the logic to transition between them. Workflows can be composed together for a full feature with each Workflow\u2019s signature specifying a clear contract. The Workflow Runtime\u2019s event loop handles the production of new immutable states for each Workflow so that within the Workflow render logic it is immutable. Workflows can be executed and instrumented in a testable way with extra hooks for simple verification of outcomes in unit tests. On an even simpler level Workflow improves clarity by giving a large team of developers a shared idiom of software components with which to discuss business logic across feature areas, and across mobile platforms (Android, iOS). Further, as the application is composed with multiple Workflows, the framework enables loose coupling between features to focus the impact of code changes.","title":"What do we want?"},{"location":"userguide/whyworkflow/#encouraging-programming-paradigms-that-are-best-practices-for-the-mobile-domain","text":"Mobile applications receive and display a lot of data! Our applications at Square certainly do. As a result of this, there is a growing trend towards reactive programming for mobile applications. In this paradigm, the application logic subscribes to a stream of data which is then pushed to the logic rather than having to be periodically pulled and operated on. This has the profound effect of ensuring that the data shown to the application user is never stale. This style of programming also makes clear that most mobile applications are a series of mapping operations on a stream of data that is eventually mapped into some UI. Another mobile programming best practice (arising out of a long tradition) is to favor declarative programming over imperative programming . With this style choice, the code for a feature declares what should be occurring for a particular state, rather than consisting of a series of statements that are essentially how to make that occur. This is a best practice because when a program\u2019s logic is defined in this way, it is very simple to test (so more likely to be tested!): \u201cFor state Y we expect Rendering Z;\u201d \u201cFrom state Y given input A we expect Rendering Z+.\u201d Possibly more important, it is easier to read, comprehend quickly, and to reason about than a series of complex commands for the computer. Workflows encourage a declarative style because each state of a particular component must be enumerated and then the Rendering (representation that gets passed to the UI framework) is declared for that particular state, alongside a declaration of what children and side effects should be running in that state. The well-tested and reliable Workflow runtime loop itself handles how to start and stop the children and side effects, reducing resource leaks. By requiring these formal definitions of each State, Rendering, and the Actions that will change the current state, Workflow naturally encourages declarative programming. While reactive and declarative programming may be current best practices, there is one Software Engineering principle that has proven over and over again to be the most universal and the most important for systems of scale: Separation of Concerns . Any system of scale requires multiple separate components that can be worked on, tested, improved, and refactored independently by multiple teams of people. A system of multiple components requires communication and any good communication begs explicit structure and contracts. For mobile applications at Square we have settled on the Model-View-ViewModel (MVVM) architecture as the structure for the topical separation of concerns of the layers of the application. MVVM\u2019s unidirectional layered communication is the same as that of Model-View-Presenter (MVP), as opposed to the \u2018circular\u2019 communication of Model-View-Controller (MVC). MVVM\u2019s use of a strict binding between the ViewModel and the View is the same as MVC, as opposed to the imperative interpretation of the Model in MVP. MVVM provides the reasoning and comprehension benefits of unidirectional data flow while also eliminating as much business logic as possible from the view layer and encouraging declarative ViewModels. At Square this works well because we have UI design frameworks that change infrequently (so keeping bindings up-to-date is not much overhead), but business logic that is constantly being updated (so emphasizing low coupling is important). Workflows embrace MVVM because the Rendering produced by a Workflow tree is the ViewModel, which can then be bound to any native mobile UI framework. For feature based separation of concerns we lean on Workflow\u2019s facility for composition at scale via strong parent-child contracts and a hierarchical tree organization. While building a Hello World Workflow may seem like overkill (although it\u2019s really not that bad!), the explicitness and contracts that Workflows require of the developer lay the structure for good communication. The composability of Workflows encourages reuse and encourages separation of concerns into the most appropriate reusable components. There are even more platform-specific best practices that Workflow dovetails well with, such as structured concurrency with Kotlin coroutines, as each Worker or side effect can define a specific coroutine scope for the operations. What about the next 10 years? Jetpack Compose UI and SwiftUI are establishing themselves as the native mobile UI toolkits of the future. They both embrace the same MVVM approach that Workflow does, and encourage thinking about the \u201ccomposability\u201d of separate components of your application. With this resonance, Workflows help you to prepare your mental model to adapt to these new UI toolkits, and shapes our codebase in a way that will ease our adoption of them. To learn more about Compose and Workflow see this post .","title":"Encouraging programming paradigms that are best practices for the mobile domain"},{"location":"userguide/worker-in-code/","text":"Coding a Worker \u00b6 Worker is a protocol (in Swift) and interface (in Kotlin) that defines an asynchronous task that can be performed by a Workflow . Worker s only emit outputs, they do not have a Rendering type. They are similar to child workflows with Void / Unit rendering types. A workflow can ask the infrastructure to await the result of a worker by passing that worker to the RenderContext.runningWorker method within a call to the render method. A workflow can handle outputs from a Worker . Workers provide a declarative window into the imperative world \u00b6 As nice as it is to write declarative code, real apps need to interact with imperative APIs. Workers allow wrapping imperative APIs so that Workflows can interact with them in a declarative fashion. Instead of making imperative \u201cstart this, do that, now stop\u201d calls, a Workflow can say \u201cI declare that this task should now be running\u201d and let the infrastructure worry about ensuring the task is actually started when necessary, continues running if it was already in flight, and torn down when it\u2019s not needed anymore. Workers can perform side effects \u00b6 Unlike workflows\u2019 render method, which can be called many times and must be idempotent, workers are started and then ran until completion (or cancellation) \u2013 independently of how many times the workflow running them is actually rendered. This means that side effects that should be performed only once when a workflow enters a particular state, for example, should be placed into a Worker that the workflow runs while in that state. Workers are cold reactive streams \u00b6 Workers are effectively simple wrappers around asynchronous streams with explicit equivalence. In Swift, workers are backed by ReactiveSwift SignalProducer s . In Kotlin, they\u2019re backed by Kotlin Flow s . They are also easily derived from Reactive Streams Publishers , including RxJava Observable , Flowable , or Single instances. Worker subscriptions are managed automatically \u00b6 While Workers are backed by reactive streams with library-specific subscription APIs, you never actually subscribe directly to a worker yourself. Instead, a Workflow asks the infrastructure to run a worker, and the infrastructure will take care of initializing and tearing down the subscription as appropriate \u2013 much like how child workflows\u2019 lifetimes are automatically managed by the runtime. This makes it impossible to accidentally leak a subscription to a worker. Workers manage their own internal state \u00b6 Unlike Workflows, which are effectively collections of functions defining state transitions, Workers represent long-running tasks. For example, Workers commonly execute network requests. The worker\u2019s stream will open a socket and, either blocking on a background thread or asynchronously, read from that socket and eventually emit data to the workflow that is running it. Workers define their own equivalence \u00b6 Since Workers represent ongoing tasks, the infrastructure needs to be able to tell when two workers represent the same task (so it doesn\u2019t perform the task twice), or when a worker has changed between render passes such that it needs to be torn down and re-started for the new work. For these reasons, any time a workflow requests that a worker be run in sequential render passes, it is asked to compare itself with its last instance and determine if they are equivalent. In Swift, this is determined by the Worker isEquivalent:to: method. Worker s that conform to Equatable will automatically get an isEquivalent:to: method based on the Equatable implementation. In Kotlin, the Worker interface defines the doesSameWorkAs method which is passed the previous worker. Kotlin: Why don\u2019t Workers use equals ? Worker equivalence is a key part of the Worker API. The default implementation of equals , which just compares object identity, is almost always incorrect for workers. Defining a separate method forces implementers to think about how equivalence is defined. Workers are lifecycle-aware \u00b6 Workers are aware of when they\u2019re started (just like Workflows), but they are also aware of when they are torn down. This makes them handy for managing resources as well.","title":"Coding a Worker (stale)"},{"location":"userguide/worker-in-code/#coding-a-worker","text":"Worker is a protocol (in Swift) and interface (in Kotlin) that defines an asynchronous task that can be performed by a Workflow . Worker s only emit outputs, they do not have a Rendering type. They are similar to child workflows with Void / Unit rendering types. A workflow can ask the infrastructure to await the result of a worker by passing that worker to the RenderContext.runningWorker method within a call to the render method. A workflow can handle outputs from a Worker .","title":"Coding a Worker"},{"location":"userguide/worker-in-code/#workers-provide-a-declarative-window-into-the-imperative-world","text":"As nice as it is to write declarative code, real apps need to interact with imperative APIs. Workers allow wrapping imperative APIs so that Workflows can interact with them in a declarative fashion. Instead of making imperative \u201cstart this, do that, now stop\u201d calls, a Workflow can say \u201cI declare that this task should now be running\u201d and let the infrastructure worry about ensuring the task is actually started when necessary, continues running if it was already in flight, and torn down when it\u2019s not needed anymore.","title":"Workers provide a declarative window into the imperative world"},{"location":"userguide/worker-in-code/#workers-can-perform-side-effects","text":"Unlike workflows\u2019 render method, which can be called many times and must be idempotent, workers are started and then ran until completion (or cancellation) \u2013 independently of how many times the workflow running them is actually rendered. This means that side effects that should be performed only once when a workflow enters a particular state, for example, should be placed into a Worker that the workflow runs while in that state.","title":"Workers can perform side effects"},{"location":"userguide/worker-in-code/#workers-are-cold-reactive-streams","text":"Workers are effectively simple wrappers around asynchronous streams with explicit equivalence. In Swift, workers are backed by ReactiveSwift SignalProducer s . In Kotlin, they\u2019re backed by Kotlin Flow s . They are also easily derived from Reactive Streams Publishers , including RxJava Observable , Flowable , or Single instances.","title":"Workers are cold reactive streams"},{"location":"userguide/worker-in-code/#worker-subscriptions-are-managed-automatically","text":"While Workers are backed by reactive streams with library-specific subscription APIs, you never actually subscribe directly to a worker yourself. Instead, a Workflow asks the infrastructure to run a worker, and the infrastructure will take care of initializing and tearing down the subscription as appropriate \u2013 much like how child workflows\u2019 lifetimes are automatically managed by the runtime. This makes it impossible to accidentally leak a subscription to a worker.","title":"Worker subscriptions are managed automatically"},{"location":"userguide/worker-in-code/#workers-manage-their-own-internal-state","text":"Unlike Workflows, which are effectively collections of functions defining state transitions, Workers represent long-running tasks. For example, Workers commonly execute network requests. The worker\u2019s stream will open a socket and, either blocking on a background thread or asynchronously, read from that socket and eventually emit data to the workflow that is running it.","title":"Workers manage their own internal state"},{"location":"userguide/worker-in-code/#workers-define-their-own-equivalence","text":"Since Workers represent ongoing tasks, the infrastructure needs to be able to tell when two workers represent the same task (so it doesn\u2019t perform the task twice), or when a worker has changed between render passes such that it needs to be torn down and re-started for the new work. For these reasons, any time a workflow requests that a worker be run in sequential render passes, it is asked to compare itself with its last instance and determine if they are equivalent. In Swift, this is determined by the Worker isEquivalent:to: method. Worker s that conform to Equatable will automatically get an isEquivalent:to: method based on the Equatable implementation. In Kotlin, the Worker interface defines the doesSameWorkAs method which is passed the previous worker. Kotlin: Why don\u2019t Workers use equals ? Worker equivalence is a key part of the Worker API. The default implementation of equals , which just compares object identity, is almost always incorrect for workers. Defining a separate method forces implementers to think about how equivalence is defined.","title":"Workers define their own equivalence"},{"location":"userguide/worker-in-code/#workers-are-lifecycle-aware","text":"Workers are aware of when they\u2019re started (just like Workflows), but they are also aware of when they are torn down. This makes them handy for managing resources as well.","title":"Workers are lifecycle-aware"},{"location":"userguide/workflow-in-code/","text":"Coding a Workflow \u00b6 In code, Workflow is a Swift protocol or Kotlin interface with State, Rendering and Output parameter types. The Kotlin interface also defines a Props type. In Swift, props are implicit as properties of the struct implementing Workflow. Swift public protocol Workflow : AnyWorkflowConvertible { associatedtype State associatedtype Output = Never associatedtype Rendering func makeInitialState () -> State func workflowDidChange ( from previousWorkflow : Self , state : inout State ) func render ( state : State , context : RenderContext < Self >) -> Rendering } Kotlin abstract class StatefulWorkflow < in PropsT , StateT , out OutputT : Any , out RenderingT > : Workflow < PropsT , OutputT , RenderingT > { abstract fun initialState ( props : PropsT , initialSnapshot : Snapshot? ): StateT open fun onPropsChanged ( old : PropsT , new : PropsT , state : StateT ): StateT = state abstract fun render ( props : PropsT , state : StateT , context : RenderContext < StateT , OutputT > ): RenderingT abstract fun snapshotState ( state : StateT ): Snapshot } Swift: What is AnyWorkflowConvertible ? When a protocol has an associated Self type, Swift requires the use of a type-erasing wrapper to store references to instances of that protocol. AnyWorkflow is such a wrapper for Workflow . AnyWorkflowConvertible is a protocol with a single method that returns an AnyWorkflow . It is useful as a base type because it allows instances of Workflow to be used directly by any code that requires the type-erased AnyWorkflow . Kotlin: StatefulWorkflow vs Workflow It is a common practice in Kotlin to divide types into two parts: an interface for public API, and a class for private implementation. The Workflow library defines a Workflow interface, which should be used as the type of properties and parameters by code that needs to refer to a particular Workflow interface. The Workflow interface contains a single method, which simply returns a StatefulWorkflow \u2013 a Workflow can be described as \u201canything that can be expressed as a StatefulWorkflow .\u201d The library also defines two abstract classes which define the contract for workflows and should be subclassed to implement your workflows: StatefulWorkflow should be subclassed to implement Workflows that have private state . StatelessWorkflow should be subclassed to implement Workflows that don\u2019t have any private state. See Stateless Workflows . Workflows have several responsibilities: Workflows have state \u00b6 Once a Workflow has been started, it always operates in the context of some state. This state is divided into two parts: private state, which only the Workflow implementation itself knows about, which is defined by the State type, and properties (or \u201cprops\u201d), which is passed to the Workflow from its parent (more on hierarchical workflows below). Private state \u00b6 Every Workflow implementation defines a State type to maintain any necessary state while the workflow is running. For example, a tic-tac-toe game might have a state like this: Swift struct State { enum Player { case x case o } enum Space { case unfilled filled ( Player ) } // 3 rows * 3 columns = 9 spaces var spaces : [ Space ] = Array ( repeating : . unfilled , count : 9 ) var currentTurn : Player = . x } Kotlin data class State ( // 3 rows * 3 columns = 9 spaces val spaces : List < Space > = List ( 9 ) { Unfilled }, val currentTurn : Player = X ) { enum class Player { X , O } sealed class Space { object Unfilled : Space () data class Filled ( val player : Player ) : Space () } } When the workflow is first started, it is queried for an initial state value. From that point forward, the workflow may advance to a new state as the result of events occurring from various sources (which will be covered below). Stateless Workflows If a workflow does not have any private state, it is often referred to as a \u201cstateless workflow\u201d. A stateless Workflow is simply a Workflow that has a Void or Unit State type. See more . Public Props \u00b6 Every Workflow implementation also defines data that is passed into it. The Workflow is not able to modify this state itself, but it may change between render passes. This public state is called Props . In Swift, the props are simply defined as properties of the struct implementing Workflow itself. In Kotlin, the Workflow interface defines a separate PropsT type parameter. (This additional type parameter is necessary due to Kotlin\u2019s lack of the Self type that Swift workflow\u2019s workflowDidChange method relies upon.) Swift TK Kotlin data class Props ( val playerXName : String val playerOName : String ) Workflows are advanced by WorkflowAction s \u00b6 Any time something happens that should advance a workflow \u2013 a UI event, a network response, a child\u2019s output event \u2013 actions are used to perform the update. For example, a workflow may respond to UI events by mapping those events into a type conforming to/implementing WorkflowAction . These types implement the logic to advance a workflow by: Advancing to a new state (Optionally) emitting an output event up the tree. WorkflowAction s are typically defined as enums with associated types (Swift) or sealed classes (Kotlin), and can include data from the event \u2013 for example, the ID of the item in the list that was clicked. Side effects such as logging button clicks to an analytics framework are also typically performed in actions. If you\u2019re familiar with React/Redux, WorkflowAction s are essentially reducers. Workflows can emit output events up the hierarchy to their parent \u00b6 When a workflow is advanced by an action, an optional output event can be sent up the workflow hierarchy. This is the opportunity for a workflow to notify its parent that something has happened (and the parent\u2019s opportunity to respond to that event by dispatching its own action, continuing up the tree as long as output events are emitted). Workflows produce an external representation of their state via Rendering \u00b6 Immediately after starting up, or after a state transition occurs, a workflow will have its render method called. This method is responsible for creating and returning a value of type Rendering . You can think of Rendering as the \u201cexternal published state\u201d of the workflow, and the render function as a map of ( Props + State + childrens\u2019 Rendering s) -> Rendering . While a workflow\u2019s internal state may contain more detailed or comprehensive state, the Rendering (external state) is a type that is useful outside of the workflow. Because a workflow\u2019s render method may be called by infrastructure for a variety of reasons, it\u2019s important to not perform side effects when rendering \u2014 render methods must be idempotent. Event-based side effects should use Actions and state-based side effects should use Workers. When building an interactive application, the Rendering type is commonly (but not always) a view model that will drive the UI layer. Workflows can respond to UI events \u00b6 The RenderContext that is passed into render as the last parameter provides some useful tools to assist in creating the Rendering value. If a workflow is producing a view model, it is common to need an event handler to respond to UI events. The RenderContext has API to create an event handler, called a Sink , that when called will advance the workflow by dispatching an action back to the workflow (for more on actions, see above ). Swift func render ( state : State , context : RenderContext < DemoWorkflow >) -> DemoScreen { // Create a sink of our Action type so we can send actions back to the workflow. let sink = context . makeSink ( of : Action . self ) return DemoScreen ( title : \"A nice title\" , onTap : { sink . send ( Action . refreshButtonTapped ) } } Kotlin TK Workflows form a hierarchy (they may have children) \u00b6 As they produce a Rendering value, it is common for workflows to delegate some portion of that work to a child workflow . This is done via the RenderContext that is passed into the render method. In order to delegate to a child, the parent calls renderChild on the context, with the child workflow as the single argument. The infrastructure will spin up the child workflow (including initializing its initial state) if this is the first time this child has been used, or, if the child was also used on the previous render pass, the existing child will be updated. Either way, render will immediately be called on the child (by the Workflow infrastructure), and the resulting child\u2019s Rendering value will be returned to the parent. This allows a parent to return complex Rendering types (such as a view model representing the entire UI state of an application) without needing to model all of that complexity within a single workflow. Workflow Identity The Workflow infrastructure automatically detects the first time and the last subsequent time you\u2019ve asked to render a child workflow, and will automatically initialize the child and clean it up. In both Swift and Kotlin, this is done using the workflow\u2019s concrete type. Both languages use reflection to do this comparison (e.g. in Kotlin, the workflows\u2019 KClass es are compared). It is an error to render workflows of the same type more than once in the same render pass. Since type is used for workflow identity, the child rendering APIs take an optional string key to differentiate between multiple child workflows of the same type. Workflows can subscribe to external event sources \u00b6 If a workflow needs to respond to some external event source (e.g. push notifications), the workflow can ask the context to listen to those events from within the render method. Swift vs Kotlin In the Swift library, there is a special API for subscribing to hot streams ( Signal in ReactiveSwift). The Kotlin library does not have any special API for subscribing to hot streams (channels), though it does have extension methods to convert ReceiveChannel s , and RxJava Flowable s and Observables , to Worker s . The reason for this discrepancy is simply that we don\u2019t have any uses of channels yet in production, and so we\u2019ve decided to keep the API simpler. If we start using channels in the future, it may make sense to make subscribing to them a first-class API like in Swift. Workflows can perform asynchronous tasks (Workers) \u00b6 Workers are very similar in concept to child workflows. Unlike child workflows, however, workers do not have a Rendering type; they only exist to perform a single asynchronous task before sending zero or more output events back up the tree to their parent. For more information about workers, see the Worker section below. Workflows can be saved to and restored from a snapshot (Kotlin only) \u00b6 On every render pass, each workflow is asked to create a \u201csnapshot\u201d of its state \u2013 a lazily-produced serialization of the workflow\u2019s State as a binary blob. These Snapshot s are aggregated into a single Snapshot for the entire workflow tree and emitted along with the root workflow\u2019s Rendering . When the workflow runtime is started, it can be passed an optional Snapshot to restore the tree from. When non-null, the root workflow\u2019s snapshot is extracted and passed to the root workflow\u2019s initialState . The workflow can choose to either ignore the snapshot or use it to restore its State . On the first render pass, if the root workflow renders any children that were also being rendered when the snapshot was taken, those children\u2019s snapshots are also extracted from the aggregate and used to initialize their states. Why don\u2019t Swift Workflows support snapshotting? Snapshotting was built into Kotlin workflows specifically to support Android\u2019s app lifecycle, which requires apps to serialize their current state before being backgrounded so that they can be restored in case the system needs to kill the hosting process. iOS apps don\u2019t have this requirement, so the Swift library doesn\u2019t need to support it.","title":"Coding a Workflow (stale)"},{"location":"userguide/workflow-in-code/#coding-a-workflow","text":"In code, Workflow is a Swift protocol or Kotlin interface with State, Rendering and Output parameter types. The Kotlin interface also defines a Props type. In Swift, props are implicit as properties of the struct implementing Workflow. Swift public protocol Workflow : AnyWorkflowConvertible { associatedtype State associatedtype Output = Never associatedtype Rendering func makeInitialState () -> State func workflowDidChange ( from previousWorkflow : Self , state : inout State ) func render ( state : State , context : RenderContext < Self >) -> Rendering } Kotlin abstract class StatefulWorkflow < in PropsT , StateT , out OutputT : Any , out RenderingT > : Workflow < PropsT , OutputT , RenderingT > { abstract fun initialState ( props : PropsT , initialSnapshot : Snapshot? ): StateT open fun onPropsChanged ( old : PropsT , new : PropsT , state : StateT ): StateT = state abstract fun render ( props : PropsT , state : StateT , context : RenderContext < StateT , OutputT > ): RenderingT abstract fun snapshotState ( state : StateT ): Snapshot } Swift: What is AnyWorkflowConvertible ? When a protocol has an associated Self type, Swift requires the use of a type-erasing wrapper to store references to instances of that protocol. AnyWorkflow is such a wrapper for Workflow . AnyWorkflowConvertible is a protocol with a single method that returns an AnyWorkflow . It is useful as a base type because it allows instances of Workflow to be used directly by any code that requires the type-erased AnyWorkflow . Kotlin: StatefulWorkflow vs Workflow It is a common practice in Kotlin to divide types into two parts: an interface for public API, and a class for private implementation. The Workflow library defines a Workflow interface, which should be used as the type of properties and parameters by code that needs to refer to a particular Workflow interface. The Workflow interface contains a single method, which simply returns a StatefulWorkflow \u2013 a Workflow can be described as \u201canything that can be expressed as a StatefulWorkflow .\u201d The library also defines two abstract classes which define the contract for workflows and should be subclassed to implement your workflows: StatefulWorkflow should be subclassed to implement Workflows that have private state . StatelessWorkflow should be subclassed to implement Workflows that don\u2019t have any private state. See Stateless Workflows . Workflows have several responsibilities:","title":"Coding a Workflow"},{"location":"userguide/workflow-in-code/#workflows-have-state","text":"Once a Workflow has been started, it always operates in the context of some state. This state is divided into two parts: private state, which only the Workflow implementation itself knows about, which is defined by the State type, and properties (or \u201cprops\u201d), which is passed to the Workflow from its parent (more on hierarchical workflows below).","title":"Workflows have state"},{"location":"userguide/workflow-in-code/#private-state","text":"Every Workflow implementation defines a State type to maintain any necessary state while the workflow is running. For example, a tic-tac-toe game might have a state like this: Swift struct State { enum Player { case x case o } enum Space { case unfilled filled ( Player ) } // 3 rows * 3 columns = 9 spaces var spaces : [ Space ] = Array ( repeating : . unfilled , count : 9 ) var currentTurn : Player = . x } Kotlin data class State ( // 3 rows * 3 columns = 9 spaces val spaces : List < Space > = List ( 9 ) { Unfilled }, val currentTurn : Player = X ) { enum class Player { X , O } sealed class Space { object Unfilled : Space () data class Filled ( val player : Player ) : Space () } } When the workflow is first started, it is queried for an initial state value. From that point forward, the workflow may advance to a new state as the result of events occurring from various sources (which will be covered below). Stateless Workflows If a workflow does not have any private state, it is often referred to as a \u201cstateless workflow\u201d. A stateless Workflow is simply a Workflow that has a Void or Unit State type. See more .","title":"Private state"},{"location":"userguide/workflow-in-code/#public-props","text":"Every Workflow implementation also defines data that is passed into it. The Workflow is not able to modify this state itself, but it may change between render passes. This public state is called Props . In Swift, the props are simply defined as properties of the struct implementing Workflow itself. In Kotlin, the Workflow interface defines a separate PropsT type parameter. (This additional type parameter is necessary due to Kotlin\u2019s lack of the Self type that Swift workflow\u2019s workflowDidChange method relies upon.) Swift TK Kotlin data class Props ( val playerXName : String val playerOName : String )","title":"Public Props"},{"location":"userguide/workflow-in-code/#workflows-are-advanced-by-workflowactions","text":"Any time something happens that should advance a workflow \u2013 a UI event, a network response, a child\u2019s output event \u2013 actions are used to perform the update. For example, a workflow may respond to UI events by mapping those events into a type conforming to/implementing WorkflowAction . These types implement the logic to advance a workflow by: Advancing to a new state (Optionally) emitting an output event up the tree. WorkflowAction s are typically defined as enums with associated types (Swift) or sealed classes (Kotlin), and can include data from the event \u2013 for example, the ID of the item in the list that was clicked. Side effects such as logging button clicks to an analytics framework are also typically performed in actions. If you\u2019re familiar with React/Redux, WorkflowAction s are essentially reducers.","title":"Workflows are advanced by WorkflowActions"},{"location":"userguide/workflow-in-code/#workflows-can-emit-output-events-up-the-hierarchy-to-their-parent","text":"When a workflow is advanced by an action, an optional output event can be sent up the workflow hierarchy. This is the opportunity for a workflow to notify its parent that something has happened (and the parent\u2019s opportunity to respond to that event by dispatching its own action, continuing up the tree as long as output events are emitted).","title":"Workflows can emit output events up the hierarchy to their parent"},{"location":"userguide/workflow-in-code/#workflows-produce-an-external-representation-of-their-state-via-rendering","text":"Immediately after starting up, or after a state transition occurs, a workflow will have its render method called. This method is responsible for creating and returning a value of type Rendering . You can think of Rendering as the \u201cexternal published state\u201d of the workflow, and the render function as a map of ( Props + State + childrens\u2019 Rendering s) -> Rendering . While a workflow\u2019s internal state may contain more detailed or comprehensive state, the Rendering (external state) is a type that is useful outside of the workflow. Because a workflow\u2019s render method may be called by infrastructure for a variety of reasons, it\u2019s important to not perform side effects when rendering \u2014 render methods must be idempotent. Event-based side effects should use Actions and state-based side effects should use Workers. When building an interactive application, the Rendering type is commonly (but not always) a view model that will drive the UI layer.","title":"Workflows produce an external representation of their state via Rendering"},{"location":"userguide/workflow-in-code/#workflows-can-respond-to-ui-events","text":"The RenderContext that is passed into render as the last parameter provides some useful tools to assist in creating the Rendering value. If a workflow is producing a view model, it is common to need an event handler to respond to UI events. The RenderContext has API to create an event handler, called a Sink , that when called will advance the workflow by dispatching an action back to the workflow (for more on actions, see above ). Swift func render ( state : State , context : RenderContext < DemoWorkflow >) -> DemoScreen { // Create a sink of our Action type so we can send actions back to the workflow. let sink = context . makeSink ( of : Action . self ) return DemoScreen ( title : \"A nice title\" , onTap : { sink . send ( Action . refreshButtonTapped ) } } Kotlin TK","title":"Workflows can respond to UI events"},{"location":"userguide/workflow-in-code/#workflows-form-a-hierarchy-they-may-have-children","text":"As they produce a Rendering value, it is common for workflows to delegate some portion of that work to a child workflow . This is done via the RenderContext that is passed into the render method. In order to delegate to a child, the parent calls renderChild on the context, with the child workflow as the single argument. The infrastructure will spin up the child workflow (including initializing its initial state) if this is the first time this child has been used, or, if the child was also used on the previous render pass, the existing child will be updated. Either way, render will immediately be called on the child (by the Workflow infrastructure), and the resulting child\u2019s Rendering value will be returned to the parent. This allows a parent to return complex Rendering types (such as a view model representing the entire UI state of an application) without needing to model all of that complexity within a single workflow. Workflow Identity The Workflow infrastructure automatically detects the first time and the last subsequent time you\u2019ve asked to render a child workflow, and will automatically initialize the child and clean it up. In both Swift and Kotlin, this is done using the workflow\u2019s concrete type. Both languages use reflection to do this comparison (e.g. in Kotlin, the workflows\u2019 KClass es are compared). It is an error to render workflows of the same type more than once in the same render pass. Since type is used for workflow identity, the child rendering APIs take an optional string key to differentiate between multiple child workflows of the same type.","title":"Workflows form a hierarchy (they may have children)"},{"location":"userguide/workflow-in-code/#workflows-can-subscribe-to-external-event-sources","text":"If a workflow needs to respond to some external event source (e.g. push notifications), the workflow can ask the context to listen to those events from within the render method. Swift vs Kotlin In the Swift library, there is a special API for subscribing to hot streams ( Signal in ReactiveSwift). The Kotlin library does not have any special API for subscribing to hot streams (channels), though it does have extension methods to convert ReceiveChannel s , and RxJava Flowable s and Observables , to Worker s . The reason for this discrepancy is simply that we don\u2019t have any uses of channels yet in production, and so we\u2019ve decided to keep the API simpler. If we start using channels in the future, it may make sense to make subscribing to them a first-class API like in Swift.","title":"Workflows can subscribe to external event sources"},{"location":"userguide/workflow-in-code/#workflows-can-perform-asynchronous-tasks-workers","text":"Workers are very similar in concept to child workflows. Unlike child workflows, however, workers do not have a Rendering type; they only exist to perform a single asynchronous task before sending zero or more output events back up the tree to their parent. For more information about workers, see the Worker section below.","title":"Workflows can perform asynchronous tasks (Workers)"},{"location":"userguide/workflow-in-code/#workflows-can-be-saved-to-and-restored-from-a-snapshot-kotlin-only","text":"On every render pass, each workflow is asked to create a \u201csnapshot\u201d of its state \u2013 a lazily-produced serialization of the workflow\u2019s State as a binary blob. These Snapshot s are aggregated into a single Snapshot for the entire workflow tree and emitted along with the root workflow\u2019s Rendering . When the workflow runtime is started, it can be passed an optional Snapshot to restore the tree from. When non-null, the root workflow\u2019s snapshot is extracted and passed to the root workflow\u2019s initialState . The workflow can choose to either ignore the snapshot or use it to restore its State . On the first render pass, if the root workflow renders any children that were also being rendered when the snapshot was taken, those children\u2019s snapshots are also extracted from the aggregate and used to initialize their states. Why don\u2019t Swift Workflows support snapshotting? Snapshotting was built into Kotlin workflows specifically to support Android\u2019s app lifecycle, which requires apps to serialize their current state before being backgrounded so that they can be restored in case the system needs to kill the hosting process. iOS apps don\u2019t have this requirement, so the Swift library doesn\u2019t need to support it.","title":"Workflows can be saved to and restored from a snapshot (Kotlin only)"}]} \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index e4e7d99d8..7ea85c509 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,537 +2,537 @@ https://square.github.io/workflow/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/CHANGELOG/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/CODE_OF_CONDUCT/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/CONTRIBUTING/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/RELEASING/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/code-recipes/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/development-process/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/faq/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/glossary/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/historical/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/sequence_diagrams/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/classes/Lifetime/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/classes/RenderContext/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/classes/WorkflowHost/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/enums/Config.RenderLoggingMode/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/enums/WorkflowLogging/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/enums/WorkflowObservation/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Kind/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/enums/WorkflowUpdateDebugInfo.Source/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/extensions/AnyWorkflow/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/extensions/AnyWorkflowAction/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/extensions/AnyWorkflowConvertible/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/extensions/DispatchQueue/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/extensions/RenderContext/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/extensions/Workflow/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/extensions/WorkflowLogging.Config/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/extensions/WorkflowLogging/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/extensions/WorkflowObserver/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Kind/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/extensions/WorkflowUpdateDebugInfo.Source/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/protocols/AnyWorkflowConvertible/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/protocols/ObserversInterceptor/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/protocols/Workflow/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/protocols/WorkflowAction/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/protocols/WorkflowDebugger/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/protocols/WorkflowObserver/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/structs/AnyWorkflow/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/structs/AnyWorkflowAction/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/structs/Sink/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/structs/StateMutationSink/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot.Child/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/structs/WorkflowHierarchyDebugSnapshot/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/structs/WorkflowLogging.Config/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/structs/WorkflowSession.Identifier/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/structs/WorkflowSession/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/structs/WorkflowUpdateDebugInfo/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/typealiases/AnyWorkflow.Output/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/typealiases/AnyWorkflow.Rendering/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/Workflow/typealiases/AnyWorkflow.State/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowReactiveSwift/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowReactiveSwift/enums/WorkerLogging/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowReactiveSwift/extensions/Signal/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowReactiveSwift/extensions/SignalProducer/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowReactiveSwift/extensions/Worker/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowReactiveSwift/extensions/WorkerLogging/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowReactiveSwift/protocols/Worker/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowReactiveSwift/typealiases/SignalProducerWorkflow.Output/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowReactiveSwift/typealiases/SignalProducerWorkflow.Rendering/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowReactiveSwift/typealiases/SignalProducerWorkflow.State/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowTesting/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowTesting/extensions/RenderTesterResult/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowTesting/extensions/Workflow/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowTesting/extensions/WorkflowAction/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowTesting/extensions/WorkflowActionTester/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowTesting/structs/RenderTester/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowTesting/structs/RenderTesterResult/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowTesting/structs/WorkflowActionTester/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/classes/DescribedViewController/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/classes/ScreenViewController/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/classes/WorkflowHostingController/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/classes/WorkflowUIViewController/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/enums/WorkflowUIObservation/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/extensions/AdaptedEnvironmentScreen/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/extensions/AnyScreen/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/extensions/Screen/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/extensions/ScreenViewController/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/extensions/SingleScreenContaining/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/extensions/UpdateChildScreenViewController/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/extensions/WorkflowHostingController/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/protocols/Screen/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/protocols/SingleScreenContaining/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/protocols/UpdateChildScreenViewController/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/protocols/WorkflowUIEvent/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/protocols/WorkflowUIObserver/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/structs/AdaptedEnvironmentScreen/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/structs/AnyScreen/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/structs/ViewControllerDescription.KindIdentifier/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/structs/ViewControllerDescription/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/structs/ViewDidAppearEvent/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/structs/ViewDidDisappearEvent/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/structs/ViewDidLayoutSubviewsEvent/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/structs/ViewWillAppearEvent/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/structs/ViewWillDisappearEvent/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/structs/ViewWillLayoutSubviewsEvent/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/typealiases/AdaptedEnvironmentScreen.Adapter/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/swift/api/WorkflowUI/typealiases/WorkflowHostingController.CustomizeEnvironment/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/userguide/common-patterns/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/userguide/concepts/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/userguide/implementation/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/userguide/testing-concepts/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/userguide/ui-concepts/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/userguide/ui-in-code/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/userguide/whyworkflow/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/userguide/worker-in-code/ - 2024-01-22 + 2024-02-09 daily https://square.github.io/workflow/userguide/workflow-in-code/ - 2024-01-22 + 2024-02-09 daily \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index 2d12b95cf..c5b497e1b 100644 Binary files a/sitemap.xml.gz and b/sitemap.xml.gz differ diff --git a/swift/api/Workflow/index.html b/swift/api/Workflow/index.html index 3575dcbec..fd6037d7f 100644 --- a/swift/api/Workflow/index.html +++ b/swift/api/Workflow/index.html @@ -920,7 +920,7 @@

TypealiasesAnyWorkflow.Rendering
  • AnyWorkflow.State
    • -

    This file was generated by SourceDocs on 2024-01-22 20:45:37 +0000

    +

    This file was generated by SourceDocs on 2024-02-09 02:29:04 +0000

    diff --git a/swift/api/WorkflowReactiveSwift/index.html b/swift/api/WorkflowReactiveSwift/index.html index d98992b22..6aabb6785 100644 --- a/swift/api/WorkflowReactiveSwift/index.html +++ b/swift/api/WorkflowReactiveSwift/index.html @@ -857,7 +857,7 @@

    TypealiasesSignalProducerWorkflow.Rendering
  • SignalProducerWorkflow.State
    • -

    This file was generated by SourceDocs on 2024-01-22 20:46:25 +0000

    +

    This file was generated by SourceDocs on 2024-02-09 02:30:04 +0000

    diff --git a/swift/api/WorkflowTesting/index.html b/swift/api/WorkflowTesting/index.html index 6b604927e..3989e4c5f 100644 --- a/swift/api/WorkflowTesting/index.html +++ b/swift/api/WorkflowTesting/index.html @@ -821,7 +821,7 @@

    ExtensionsWorkflowAction
  • WorkflowActionTester
    • -

    This file was generated by SourceDocs on 2024-01-22 20:46:14 +0000

    +

    This file was generated by SourceDocs on 2024-02-09 02:29:50 +0000

    diff --git a/swift/api/WorkflowUI/index.html b/swift/api/WorkflowUI/index.html index 7b274a7ce..5378f4aa0 100644 --- a/swift/api/WorkflowUI/index.html +++ b/swift/api/WorkflowUI/index.html @@ -911,7 +911,7 @@

    TypealiasesAdaptedEnvironmentScreen.Adapter
  • WorkflowHostingController.CustomizeEnvironment
    • -

    This file was generated by SourceDocs on 2024-01-22 20:45:49 +0000

    +

    This file was generated by SourceDocs on 2024-02-09 02:29:22 +0000