public/com.revenuecat.purchases/Offering

Offering

data class Offering(val identifier: String, val serverDescription: String, val metadata: Map<String, Any>, val availablePackages: List<Package>)

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

Constructors

Link copied to clipboard
constructor(identifier: String, serverDescription: String, metadata: Map<String, Any>, availablePackages: List<Package>)

Functions

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
fun getPackage(identifier: String): Package

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

Properties

Link copied to clipboard
val annual: Package?

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

Link copied to clipboard
val availablePackages: List<Package>

Array of Package objects available for purchase.

Link copied to clipboard
val identifier: String

Unique identifier defined in RevenueCat dashboard.

Link copied to clipboard
val lifetime: Package?

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

Link copied to clipboard
val metadata: Map<String, Any>

Offering metadata defined in RevenueCat dashboard.

Link copied to clipboard
val monthly: Package?

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

Link copied to clipboard
val serverDescription: String

Offering description defined in RevenueCat dashboard.

Link copied to clipboard
val sixMonth: Package?

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

Link copied to clipboard
val threeMonth: Package?

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

Link copied to clipboard
val twoMonth: Package?

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

Link copied to clipboard
val weekly: Package?

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