//workflow/com.squareup.workflow1.ui.container/AndroidOverlay
AndroidOverlay¶
[androidJvm] @WorkflowUiExperimentalApi()
interface AndroidOverlay<O : AndroidOverlay<O>> : Overlay
Interface implemented by a rendering class to allow it to drive an Android UI via an appropriate OverlayDialogFactory implementation.
This is the simplest way to introduce a Dialog workflow driven 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 OverlayDialogFactory implementations at runtime. Also note that a ViewRegistry entry will override the dialogFactory returned by an AndroidOverlay.
See also¶
androidJvm
| com.squareup.workflow1.ui.AndroidScreen |
Properties¶
| Name | Summary |
|---|---|
| dialogFactory | [androidJvm] abstract val dialogFactory: OverlayDialogFactory<O> |