data class AdaptyPaywallProductReference(val vendorId: String, adaptyProductId: String, val productType: String, val accessLevelId: String, val promotionalOfferId: String? = null, val winBackOfferId: String? = null, val basePlanId: String? = null, val offerId: String? = null)

Represents a reference to a product associated with a paywall.

AdaptyPaywallProductSubscription

data class AdaptyPaywallProductSubscription

Represents detailed subscription information for a paywall product.

AdaptyPaywallViewConfiguration

data class AdaptyPaywallViewConfiguration

Configuration details for a paywall created using the Adapty Paywall Builder.

AdaptyPeriodUnit

enum AdaptyPeriodUnit : Enum<AdaptyPeriodUnit>

Units of time used for subscription periods.

AdaptyPlacement

data class AdaptyPlacement

Represents a paywall or onboarding placement in the Adapty system.

AdaptyPrice

data class AdaptyPrice

Represents a product price in the store, including optional localized formatting.

AdaptyProductIdentifier

data class AdaptyProductIdentifier

Represents a unique identifier for a product across platforms.

AdaptyProfile

data class AdaptyProfile

Represents a user profile in Adapty.

AdaptyProfileParameters

class AdaptyProfileParameters

Represents parameters for updating or creating an Adapty profile.

AdaptyPurchaseParameters

class AdaptyPurchaseParameters

Parameters used when making a purchase or updating a subscription in Adapty.

AdaptyPurchaseResult

sealed interface AdaptyPurchaseResult

Represents the result of a purchase operation in Adapty.

AdaptyRemoteConfig

data class AdaptyRemoteConfig(val locale: String, val dataJsonString: String, val dataMap: Map<String, Any>)

Represents a remote configuration for a paywall or onboarding, fetched from Adapty.

AdaptyRenewalType

enum AdaptyRenewalType : Enum<AdaptyRenewalType>

Represents the type of subscription renewal.

AdaptyResult

sealed interface AdaptyResult<out T>

A wrapper class representing the result of an operation.

AdaptySubscriptionOffer

data class AdaptySubscriptionOffer

Represents an offer for a subscription product.

AdaptySubscriptionOfferIdentifier

data class AdaptySubscriptionOfferIdentifier

Represents the unique identifier and type of a subscription offer.

AdaptySubscriptionOfferPaymentMode

enum AdaptySubscriptionOfferPaymentMode : Enum<AdaptySubscriptionOfferPaymentMode>

The payment mode of a subscription offer.

AdaptySubscriptionOfferPhase

data class AdaptySubscriptionOfferPhase

Represents a single phase of a subscription offer, such as an introductory or promotional phase.

AdaptySubscriptionOfferType

enum AdaptySubscriptionOfferType : Enum<AdaptySubscriptionOfferType>

The type of a subscription offer.

AdaptySubscriptionPeriod

data class AdaptySubscriptionPeriod

Represents the duration of a subscription period.

AdaptyUIAction

sealed interface AdaptyUIAction

Represents a UI action performed by the user on Adapty paywalls or onboarding screens.

AdaptyUIDialog

data class AdaptyUIDialog(val primaryActionTitle: String, val title: String? = null, val content: String? = null, val secondaryActionTitle: String? = null)

Represents a dialog that can be shown in the UI, typically for alerts, confirmations, or information.

AdaptyUIDialogActionType

enum AdaptyUIDialogActionType : Enum<AdaptyUIDialogActionType>

Represents the type of action taken by the user on an AdaptyUIDialog.

AdaptyUIIOSPresentationStyle

enum AdaptyUIIOSPresentationStyle : Enum<AdaptyUIIOSPresentationStyle>

Defines the presentation styles available for displaying Adapty UI screens on iOS.

AdaptyUIOnboardingMeta

data class AdaptyUIOnboardingMeta(val onboardingId: String, val screenClientId: String, val screenIndex: Int, val screensTotal: Int)

Contains metadata about the current onboarding flow and screen.

AdaptyUIOnboardingView

data class AdaptyUIOnboardingView

Represents an onboarding view in the Adapty UI.

AdaptyUIPaywallView

data class AdaptyUIPaywallView

Represents a paywall view in the Adapty UI.

AdaptyWebPresentation

enum AdaptyWebPresentation : Enum<AdaptyWebPresentation>

Defines how a web-based Adapty paywall should be presented to the user.

Properties

isError

val <T> AdaptyResult<T>.isError: Boolean

Returns true if this is an AdaptyResult.Error result.

isSuccess

val <T> AdaptyResult<T>.isSuccess: Boolean

Returns true if this is a AdaptyResult.Success result.

Functions

exceptionOrNull

inline fun <T> AdaptyResult<T>.exceptionOrNull(): AdaptyError?

Returns the AdaptyError if this is AdaptyResult.Error, or null if it is AdaptyResult.Success.

fold

inline fun <T, R> AdaptyResult<T>.fold(onSuccess: (T) -> R, onError: (AdaptyError) -> R): R

Transforms the AdaptyResult into a value of type R using onSuccess if successful or onError if it is an error.

getOrNull

inline fun <T> AdaptyResult<T>.getOrNull(): T?

Returns the value if this is AdaptyResult.Success, or null if it is AdaptyResult.Error.

onError

inline fun <T> AdaptyResult<T>.onError(action: (AdaptyError) -> Unit): AdaptyResult<T>

Executes action if this is an AdaptyResult.Error result, then returns the receiver.

onSuccess

inline fun <T> AdaptyResult<T>.onSuccess(action: (T) -> Unit): AdaptyResult<T>

Executes action if this is a AdaptyResult.Success result, then returns the receiver.