adapty/com.adapty.kmp.models/AdaptyUIOnboardingView

AdaptyUIOnboardingView

data class AdaptyUIOnboardingView

Represents an onboarding view in the Adapty UI.

An onboarding can be presented either as a standalone screen (modal) or embedded as a platform view inside your UI.

Standalone screens allow users to dismiss using native gestures (swipe down on iOS, back button on Android) and are ideal for optional onboardings. Embedded platform views give full control over dismissal and are ideal for required flows.

Properties

Link copied to clipboard
val id: String

The unique identifier of this onboarding view instance.

Link copied to clipboard
val isStandaloneView: Boolean

Returns true if this onboarding is a standalone modal screen. false indicates it is an embedded platform view.

Link copied to clipboard
val placementId: String

The identifier of the placement where this onboarding is assigned.

Link copied to clipboard
val variationId: String

The variation identifier of the onboarding.

Functions

Link copied to clipboard
suspend fun dismiss(): AdaptyResult<Unit>

Dismisses the currently presented onboarding view.

Link copied to clipboard
suspend fun present(iosPresentationStyle: AdaptyUIIOSPresentationStyle = AdaptyUIIOSPresentationStyle.FULLSCREEN): AdaptyResult<Unit>

Presents the onboarding view to the user as a standalone screen.

Link copied to clipboard
suspend fun showDialog(title: String, content: String, primaryActionTitle: String, secondaryActionTitle: String? = null): AdaptyResult<AdaptyUIDialogActionType>

Presents a dialog on top of the onboarding view.