LinearOnboardingPlan

data class LinearOnboardingPlan(val id: LinearOnboardingPlanId, val steps: List<LinearOnboardingStep>, val onCompleted: suspend () -> Unit = {}, val onSkipped: suspend () -> Unit = {}, val result: suspend () -> LinearOnboardingResult? = { null })

An ordered list of steps with callbacks for the end of the run. onCompleted and onSkipped run just before the matching terminal state, and on completion result is passed into LinearOnboardingState.Completed.result. Only the root plan's callbacks and result run. When a side plan aborts or runs out of steps, that outcome surfaces through the root.

Constructors

Link copied to clipboard
constructor(id: LinearOnboardingPlanId, steps: List<LinearOnboardingStep>, onCompleted: suspend () -> Unit = {}, onSkipped: suspend () -> Unit = {}, result: suspend () -> LinearOnboardingResult? = { null })

Properties

Link copied to clipboard
Link copied to clipboard
val onCompleted: suspend () -> Unit
Link copied to clipboard
val onSkipped: suspend () -> Unit
Link copied to clipboard
val result: suspend () -> LinearOnboardingResult?
Link copied to clipboard

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int