revenuecatui/com.revenuecat.purchases.ui.revenuecatui

Package-level declarations

Types

ExperimentalPreviewRevenueCatUIPurchasesAPI

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class ExperimentalPreviewRevenueCatUIPurchasesAPI

This annotation marks the experimental preview of the RevenueCat UI Purchases API. This API is in a preview state and has a very high chance of being changed in the near future.

PaywallDialogOptions

data class PaywallDialogOptions

PaywallListener

interface PaywallListener

PaywallOptions

data class PaywallOptions

PurchaseLogic

interface PurchaseLogic

Interface for handling in-app purchases and restorations directly by the application rather than by RevenueCat. These suspend methods are called by a RevenueCat Paywall in order to execute you app's custom purchase/restore code. These functions are only called when Purchases.purchasesAreCompletedBy is set to MY_APP.

PurchaseLogicResult

interface PurchaseLogicResult

Represents the result of a purchase attempt made by custom app-based code (not RevenueCat).

PurchaseLogicWithCallback

abstract class PurchaseLogicWithCallback : PurchaseLogic

Abstract class extending PurchaseLogic, providing methods for handling in-app purchases and restorations with completion callbacks rather than co-routines.

Functions

OriginalTemplatePaywallFooter

@Composable

fun OriginalTemplatePaywallFooter(options: PaywallOptions, condensed: Boolean = false, mainContent: @Composable (PaddingValues) -> Unit? = null)

Composable offering a minified screen Paywall UI configured from the RevenueCat dashboard. You can pass in your own Composables to be displayed in the main content area. Only compatible with original Paywalls. If using v2 Paywalls, this will display a fallback paywall instead.

Paywall

@Composable

fun Paywall(options: PaywallOptions)

Composable offering a full screen Paywall UI configured from the RevenueCat dashboard.

PaywallDialog

@Composable

fun PaywallDialog(paywallDialogOptions: PaywallDialogOptions)

Composable offering a dialog screen Paywall UI configured from the RevenueCat dashboard. This dialog will be shown as a full screen dialog in compact devices and a normal dialog otherwise.