purchases/com.revenuecat.purchases.paywalls/PaywallData/LocalizedConfiguration

LocalizedConfiguration

@Serializable

data class LocalizedConfiguration(val title: String, val subtitle: String? = null, val callToAction: String, val callToActionWithIntroOffer: String? = null, val callToActionWithMultipleIntroOffers: String? = null, val offerDetails: String? = null, val offerDetailsWithIntroOffer: String? = null, val offerDetailsWithMultipleIntroOffers: String? = null, val offerName: String? = null, val features: List<PaywallData.LocalizedConfiguration.Feature> = emptyList(), val tierName: String? = null, val offerOverrides: Map<String, PaywallData.LocalizedConfiguration.OfferOverride> = emptyMap())

Defines the necessary localized information for a paywall.

Constructors

constructor(title: String, subtitle: String? = null, callToAction: String, callToActionWithIntroOffer: String? = null, callToActionWithMultipleIntroOffers: String? = null, offerDetails: String? = null, offerDetailsWithIntroOffer: String? = null, offerDetailsWithMultipleIntroOffers: String? = null, offerName: String? = null, features: List<PaywallData.LocalizedConfiguration.Feature> = emptyList(), tierName: String? = null, offerOverrides: Map<String, PaywallData.LocalizedConfiguration.OfferOverride> = emptyMap())

Types

Feature

@Serializable

data class Feature(val title: String, val content: String? = null, val iconID: String? = null)

An item to be showcased in a paywall.

OfferOverride

@Serializable

data class OfferOverride(val offerName: String, val offerDetails: String, val offerDetailsWithIntroOffer: String? = null, val offerDetailsWithMultipleIntroOffers: String? = null, val offerBadge: String? = null)

Properties

callToAction

val callToAction: String

The content of the main action button for purchasing a subscription.

callToActionWithIntroOffer

@Serializable(with = EmptyStringToNullSerializer::class)

val callToActionWithIntroOffer: String? = null

The content of the main action button for purchasing a subscription when an intro offer is available. If null, no information regarding trial eligibility will be displayed.

callToActionWithMultipleIntroOffers

@Serializable(with = EmptyStringToNullSerializer::class)

val callToActionWithMultipleIntroOffers: String? = null

The content of the main action button for purchasing a subscription when multiple intro offer are available. This may happen in Google Play, if you have an offer with both a free trial and a discounted price. If null, no information regarding trial eligibility will be displayed.

features

val features: List<PaywallData.LocalizedConfiguration.Feature>

An optional list of features that describe this paywall.

offerDetails

@Serializable(with = EmptyStringToNullSerializer::class)

val offerDetails: String? = null

Description for the offer to be purchased.

offerDetailsWithIntroOffer

@Serializable(with = EmptyStringToNullSerializer::class)

val offerDetailsWithIntroOffer: String? = null

Description for the offer to be purchased when an intro offer is available. If null, no information regarding trial eligibility will be displayed.

offerDetailsWithMultipleIntroOffers

@Serializable(with = EmptyStringToNullSerializer::class)

val offerDetailsWithMultipleIntroOffers: String? = null

Description for the offer to be purchased when multiple intro offers are available. This may happen in Google Play, if you have an offer with both a free trial and a discounted price. If null, no information regarding trial eligibility will be displayed.

offerName

@Serializable(with = EmptyStringToNullSerializer::class)

val offerName: String? = null

The name representing each of the packages, most commonly a variable.

offerOverrides

val offerOverrides: Map<String, PaywallData.LocalizedConfiguration.OfferOverride>

subtitle

@Serializable(with = EmptyStringToNullSerializer::class)

val subtitle: String? = null

The subtitle of the paywall screen.

tierName

@Serializable(with = EmptyStringToNullSerializer::class)

val tierName: String? = null

title

val title: String

The title of the paywall screen.