Superwall Android SDK/com.superwall.sdk.models.paywall/Paywall

Paywall

@Serializable

data class Paywall(val databaseId: String, var identifier: PaywallIdentifier, val name: String, val url: PaywallURL, val htmlSubstitutions: String, presentationStyle: String?, expandedPresentationStyle: PaywallPresentationStyle?, presentationDelay: Long, presentationCondition: String, var presentation: PaywallPresentationInfo = PaywallPresentationInfo( style = expandedPresentationStyle ?: PaywallPresentationStyle.None.also { Logger.debug( LogLevel.warn, LogScope.paywallPresentation, "Unknown or unsupported presentation style: $presentationStyle", ) }, delay = presentationDelay, ), val backgroundColorHex: String, val darkBackgroundColorHex: String? = null, _products: List<ProductItem> = emptyList(), _productItemsV3: List<CrossplatformProduct> = emptyList(), _productItems: List<ProductItem> = emptyList(), var productIds: List<String> = _productItems.map { it.compositeId }.ifEmpty { _productItemsV3.map { it.fullProductId } }, var responseLoadingInfo: Paywall.LoadingInfo = LoadingInfo(), var webviewLoadingInfo: Paywall.LoadingInfo = LoadingInfo(), var productsLoadingInfo: Paywall.LoadingInfo = LoadingInfo(), var shimmerLoadingInfo: Paywall.LoadingInfo = LoadingInfo(), var productVariables: List<ProductVariable>? = null, var swProductVariablesTemplate: List<ProductVariable>? = null, var paywalljsVersion: String? = null, var isFreeTrialAvailable: Boolean = false, var presentationSourceType: String? = null, var featureGating: FeatureGatingBehavior = FeatureGatingBehavior.NonGated, var computedPropertyRequests: List<ComputedPropertyRequest> = emptyList(), var localNotifications: List<LocalNotification> = emptyList(), var onDeviceCache: OnDeviceCaching = OnDeviceCaching.Disabled, var experiment: Experiment? = null, var closeReason: PaywallCloseReason = PaywallCloseReason.None, var state: Map<String, Any> = emptyMap(), var presentationId: String? = null, val urlConfig: PaywallWebviewUrl.Config? = null, val cacheKey: CacheKey, val buildId: String, var surveys: List<Survey> = emptyList(), val isScrollEnabled: Boolean? = true, val rerouteBackButton: Paywall.ToggleMode? = null, val introOfferEligibility: IntroOfferEligibility = IntroOfferEligibility.AUTOMATIC) : SerializableEntity(source)

Constructors

Paywall

constructor(databaseId: String, identifier: PaywallIdentifier, name: String, url: PaywallURL, htmlSubstitutions: String, presentationStyle: String?, expandedPresentationStyle: PaywallPresentationStyle?, presentationDelay: Long, presentationCondition: String, presentation: PaywallPresentationInfo = PaywallPresentationInfo( style = expandedPresentationStyle ?: PaywallPresentationStyle.None.also { Logger.debug( LogLevel.warn, LogScope.paywallPresentation, "Unknown or unsupported presentation style: $presentationStyle", ) }, delay = presentationDelay, ), backgroundColorHex: String, darkBackgroundColorHex: String? = null, _products: List<ProductItem> = emptyList(), _productItemsV3: List<CrossplatformProduct> = emptyList(), _productItems: List<ProductItem> = emptyList(), productIds: List<String> = _productItems.map { it.compositeId }.ifEmpty { _productItemsV3.map { it.fullProductId } }, responseLoadingInfo: Paywall.LoadingInfo = LoadingInfo(), webviewLoadingInfo: Paywall.LoadingInfo = LoadingInfo(), productsLoadingInfo: Paywall.LoadingInfo = LoadingInfo(), shimmerLoadingInfo: Paywall.LoadingInfo = LoadingInfo(), productVariables: List<ProductVariable>? = null, swProductVariablesTemplate: List<ProductVariable>? = null, paywalljsVersion: String? = null, isFreeTrialAvailable: Boolean = false, presentationSourceType: String? = null, featureGating: FeatureGatingBehavior = FeatureGatingBehavior.NonGated, computedPropertyRequests: List<ComputedPropertyRequest> = emptyList(), localNotifications: List<LocalNotification> = emptyList(), onDeviceCache: OnDeviceCaching = OnDeviceCaching.Disabled, experiment: Experiment? = null, closeReason: PaywallCloseReason = PaywallCloseReason.None, state: Map<String, Any> = emptyMap(), presentationId: String? = null, urlConfig: PaywallWebviewUrl.Config? = null, cacheKey: CacheKey, buildId: String, surveys: List<Survey> = emptyList(), isScrollEnabled: Boolean? = true, rerouteBackButton: Paywall.ToggleMode? = null, introOfferEligibility: IntroOfferEligibility = IntroOfferEligibility.AUTOMATIC)

Types

Companion

object Companion

LoadingInfo

@Serializable

data class LoadingInfo(var startAt: Date? = null, var endAt: Date? = null, var failAt: Date? = null)

ToggleMode

@Serializable

enum ToggleMode : Enum<Paywall.ToggleMode>

Properties

backgroundColor

val backgroundColor: Int

backgroundColorHex

@SerialName(value = "background_color_hex")

val backgroundColorHex: String

buildId

@Serializable

@SerialName(value = "build_id")

val buildId: String

cacheKey

@Serializable

@SerialName(value = "cache_key")

val cacheKey: CacheKey

closeReason

@Transient

var closeReason: PaywallCloseReason

computedPropertyRequests

@SerialName(value = "computed_properties")

var computedPropertyRequests: List<ComputedPropertyRequest>

customProducts

val customProducts: List<CrossplatformProduct>

darkBackgroundColor

val darkBackgroundColor: Int?

darkBackgroundColorHex

@SerialName(value = "dark_background_color_hex")

val darkBackgroundColorHex: String?

databaseId

@SerialName(value = "id")

val databaseId: String

experiment

@Transient

var experiment: Experiment?

featureGating

@SerialName(value = "feature_gating")

var featureGating: FeatureGatingBehavior

htmlSubstitutions

@SerialName(value = "paywalljs_event")

val htmlSubstitutions: String

identifier

@SerialName(value = "identifier")

var identifier: PaywallIdentifier

introOfferEligibility

@SerialName(value = "intro_offer_eligibility")

val introOfferEligibility: IntroOfferEligibility

isFreeTrialAvailable

var isFreeTrialAvailable: Boolean

isScrollEnabled

@SerialName(value = "is_scroll_enabled")

val isScrollEnabled: Boolean?

localNotifications

@SerialName(value = "local_notifications")

var localNotifications: List<LocalNotification>

name

@SerialName(value = "name")

val name: String

onDeviceCache

@SerialName(value = "on_device_cache")

var onDeviceCache: OnDeviceCaching

Indicates whether the caching of the paywall is enabled or not.

paddleProducts

val paddleProducts: List<CrossplatformProduct>

paywalljsVersion

var paywalljsVersion: String?

playStoreProducts

val playStoreProducts: List<CrossplatformProduct>

presentation

@Transient

var presentation: PaywallPresentationInfo

presentationId

@Transient

var presentationId: String?

A unique identifier minted for each distinct presentation of this paywall, used to correlate the events tracked during that presentation (e.g. page views).

presentationSourceType

var presentationSourceType: String?

productIds

@Transient

var productIds: List<String>

productItems