onboarding-api/com.duckduckgo.onboarding.api/LinearOnboardingStep

LinearOnboardingStep

interface LinearOnboardingStep

The least the orchestrator needs to walk a plan. Concrete steps live with the plan provider. Anything a renderer needs, like which dialog to show, goes on host-specific subtypes that the renderer downcasts to.

Properties

Link copied to clipboard
abstract val host: LinearOnboardingHost
Link copied to clipboard
abstract val id: LinearOnboardingStepId
Link copied to clipboard
abstract val precondition: suspend () -> Boolean

Checked as the orchestrator advances. When it returns false the step is skipped and not shown.

Link copied to clipboard
abstract val transition: suspend (LinearOnboardingEvent) -> LinearOnboardingTransition

Turns an incoming event into the next LinearOnboardingTransition. Return LinearOnboardingTransition.Stay to ignore the event.