libux/io.mimi.sdk.ux.flow/FlowCoordinator

FlowCoordinator

class FlowCoordinator

FlowCoordinator is responsible for coordinating the navigation_profile inside a Flow. It will step back and forth in Flow and dequeue the current Step. The current StepFragment is passed to the fragmentManager so the Step is in control of that fragment.

Properties

wasRestoredAfterProcessDeath

var wasRestoredAfterProcessDeath: Boolean

True when this coordinator was created to replace one lost to process death, i.e. the host was recreated with a saved coordinator id but the in-memory Flow state was gone. Hosts can read this to recover gracefully (e.g. restart the flow or finish) instead of relying on unrecoverable state.

Functions

fun currentStep(): Step

The actual step where the current flow is pointing to. This method will be returning the new updated Step as soon as the jumpTo method is finished

fun goBack(): Boolean

It will go back to the previous Step if possible.

fun goingForward(): Boolean

fun isAtRoot(): Boolean

fun jumpTo(flowLocation: FlowLocation)

Jump to the specified flowLocation.

fun startFlow(flow: Flow, flowListener: FlowListener? = null)

Starts the flow by displaying its first step in the containerLayout

fun startFlowIfNew(flow: Flow, flowListener: FlowListener? = null)

Starts the specified flow if there was none set previously. Otherwise just updates the flowListener

fun startSubFlow(subFlow: Flow)

Starts the subFlow by displaying its first step in the containerLayout. Fails with a IllegalStateException if no root flow is not available.