purchases/com.revenuecat.purchases/Offering

Offering

data class Offering @JvmOverloads constructor(val identifier: String, val serverDescription: String, val metadata: Map<String, Any>, val availablePackages: List<Package>, val paywall: PaywallData? = null)

An offering is a collection of Package available for the user to purchase. For more info see https://docs.revenuecat.com/docs/entitlements

Constructors

constructor(identifier: String, serverDescription: String, metadata: Map<String, Any>, availablePackages: List<Package>, paywall: PaywallData? = null)

Functions

operator fun get(s: String): Package

Retrieves a specific package by identifier, use this to access custom package types configured in the RevenueCat dashboard. Equivalent to calling getPackage.

getMetadataString

fun getMetadataString(key: String, default: String): String

Returns the metadata value associated to key for the expected String type or default if not found, or it's not the expected String type.

fun getPackage(identifier: String): Package

Retrieves a specific package by identifier, use this to access custom package types configured in the RevenueCat dashboard

Properties

val annual: Package?

Annual package type configured in the RevenueCat dashboard, if available.

availablePackages

val availablePackages: List<Package>

Array of Package objects available for purchase.

val identifier: String

Unique identifier defined in RevenueCat dashboard.

val lifetime: Package?

Lifetime package type configured in the RevenueCat dashboard, if available.

val metadata: Map<String, Any>

Offering metadata defined in RevenueCat dashboard.

val monthly: Package?

Monthly package type configured in the RevenueCat dashboard, if available.

val paywall: PaywallData? = null

serverDescription

val serverDescription: String

Offering description defined in RevenueCat dashboard.

val sixMonth: Package?

Six month package type configured in the RevenueCat dashboard, if available.

val threeMonth: Package?

Three month package type configured in the RevenueCat dashboard, if available.

val twoMonth: Package?

Two month package type configured in the RevenueCat dashboard, if available.

val weekly: Package?

Weekly package type configured in the RevenueCat dashboard, if available.