purchases/com.revenuecat.purchases.paywalls/PaywallData/Configuration

Configuration

@Serializable

data class Configuration(val packageIds: List<String>, val defaultPackage: String? = null, imagesWebp: PaywallData.Configuration.Images? = null, legacyImages: PaywallData.Configuration.Images? = null, val blurredBackgroundImage: Boolean = false, val displayRestorePurchases: Boolean = true, val termsOfServiceURL: URL? = null, val privacyURL: URL? = null, val colors: PaywallData.Configuration.ColorInformation)

Generic configuration for any paywall.

Constructors

constructor(packageIds: List<String>, defaultPackage: String? = null, images: PaywallData.Configuration.Images, colors: PaywallData.Configuration.ColorInformation, blurredBackgroundImage: Boolean = false, displayRestorePurchases: Boolean = true, termsOfServiceURL: URL? = null, privacyURL: URL? = null)

constructor(packageIds: List<String>, defaultPackage: String? = null, imagesWebp: PaywallData.Configuration.Images? = null, legacyImages: PaywallData.Configuration.Images? = null, blurredBackgroundImage: Boolean = false, displayRestorePurchases: Boolean = true, termsOfServiceURL: URL? = null, privacyURL: URL? = null, colors: PaywallData.Configuration.ColorInformation)

Types

ColorInformation

@Serializable

data class ColorInformation(val light: PaywallData.Configuration.Colors, val dark: PaywallData.Configuration.Colors? = null)

@Serializable

data class Colors(val background: PaywallColor, val text1: PaywallColor, val text2: PaywallColor? = null, val text3: PaywallColor? = null, val callToActionBackground: PaywallColor, val callToActionForeground: PaywallColor, val callToActionSecondaryBackground: PaywallColor? = null, val accent1: PaywallColor? = null, val accent2: PaywallColor? = null, val accent3: PaywallColor? = null, val closeButton: PaywallColor? = null)

@Serializable

data class Images(val header: String? = null, val background: String? = null, val icon: String? = null)

Properties

blurredBackgroundImage

val blurredBackgroundImage: Boolean = false

Whether the background image will be blurred (in templates with one).

val colors: PaywallData.Configuration.ColorInformation

The set of colors used.

val defaultPackage: String? = null

The package to be selected by default.

displayRestorePurchases

val displayRestorePurchases: Boolean = true

Whether a restore purchases button should be displayed.

val images: PaywallData.Configuration.Images

The images for this template.

val packageIds: List<String>

The list of package identifiers this paywall will display.

@Serializable(with = OptionalURLSerializer::class)

val privacyURL: URL? = null

If set, the paywall will display a privacy policy link.

termsOfServiceURL

@Serializable(with = OptionalURLSerializer::class)

val termsOfServiceURL: URL? = null

If set, the paywall will display a terms of service link.