revenuecatui/com.revenuecat.purchases.kmp.ui.revenuecatui/PaywallOptions/Builder

Builder

class Builder(var dismissRequest: () -> Unit)

Use this builder to create an instance of PaywallOptions.

Constructors

Builder

constructor(dismissRequest: () -> Unit)

Properties

customVariables

var customVariables: Map<String, CustomVariableValue>

Custom variables to be applied to the paywall. These allow you to dynamically set text on your paywall from your app. Keys must match the variable names defined in your paywall configuration.

dismissRequest

var dismissRequest: () -> Unit

Dismiss the paywall, i.e. remove the view, navigate to another screen, etc. Will be called when the close button is pressed (if enabled) or when a purchase succeeds.

listener

var listener: PaywallListener?

Optional listener, called for various purchase and restore events.

offering

var offering: <Error class: unknown class>?

Optional Offering object obtained through getOfferings().

purchaseLogic

var purchaseLogic: PaywallPurchaseLogic?

Optional purchase logic for handling purchases and restores directly by your app instead of RevenueCat. Only used when purchasesAreCompletedBy is set to MY_APP.

shouldDisplayDismissButton

var shouldDisplayDismissButton: Boolean

Whether to display a close button on the paywall screen. Only available when using Paywall and original template paywalls. Ignored when using OriginalTemplatePaywallFooter or V2 Paywalls. Defaults to false.

Functions

build

fun build(): PaywallOptions

Creates a PaywallOptions instance with the specified properties.