core/com.revenuecat.purchases.kmp/Purchases/Companion

Companion

actual object Companion

expect object Companion

actual object Companion

Properties

forceUniversalAppStore

@JvmStatic

actual var forceUniversalAppStore: Boolean

expect var forceUniversalAppStore: Boolean

App Store only. Set this property to true only if you’re transitioning an existing Mac app from the Legacy Mac App Store into the Universal Store, and you’ve configured your RevenueCat app accordingly. Contact RevenueCat support before using this.

actual var forceUniversalAppStore: Boolean

frameworkVersion

val Purchases.Companion.frameworkVersion: String

Current version of the Purchases SDK

isConfigured

@JvmStatic

actual val isConfigured: Boolean

expect val isConfigured: Boolean

True if configure has been called and sharedInstance is set

actual val isConfigured: Boolean

logHandler

@JvmStatic

actual var logHandler: LogHandler

expect var logHandler: LogHandler

Set a custom log handler for redirecting logs to your own logging system.

actual var logHandler: LogHandler

logLevel

@JvmStatic

actual var logLevel: LogLevel

expect var logLevel: LogLevel

Configure log level. Useful for debugging issues with the lovely team @RevenueCat By default, LogLevel.DEBUG in debug builds, and LogLevel.INFO in release builds.

actual var logLevel: LogLevel

proxyURL

@JvmStatic

actual var proxyURL: String?

expect var proxyURL: String?

Set this property to your proxy URL before configuring Purchases only if you've received a proxy key value from your RevenueCat contact.

actual var proxyURL: String?

sharedInstance

@JvmStatic

actual val sharedInstance: Purchases

expect val sharedInstance: Purchases

Singleton instance of Purchases. configure will set this. Will throw an exception if the shared instance has not been configured.

actual val sharedInstance: Purchases

simulatesAskToBuyInSandbox

@JvmStatic

actual var simulatesAskToBuyInSandbox: Boolean

expect var simulatesAskToBuyInSandbox: Boolean

App Store only. Set this property to true only when testing the ask-to-buy / SCA purchases flow. More information available here.

actual var simulatesAskToBuyInSandbox: Boolean

Functions

awaitCanMakePayments

suspend fun Purchases.Companion.awaitCanMakePayments(features: List<<Error class: unknown class>> = listOf()): Boolean

Check if billing is supported for the current Play user (meaning IN-APP purchases are supported) and optionally, whether all features in the list of specified feature types are supported. This method is asynchronous since it requires a connected BillingClient.

canMakePayments

expect fun canMakePayments(features: List<<Error class: unknown class>> = listOf(), callback: (Boolean) -> Unit)

Note: This method only works for the Google Play Store and App Store. There is no Amazon equivalent at this time. Calling from an Amazon-configured app will return true.

actual fun canMakePayments(features: List<<Error class: unknown class>>, callback: (Boolean) -> Unit)

configure

@JvmStatic

actual fun configure(configuration: PurchasesConfiguration): Purchases

expect fun configure(configuration: PurchasesConfiguration): Purchases

Configures an instance of the SDK with the specified configuration. The instance will be set as a singleton. You should access the singleton instance using sharedInstance.

configure

fun Purchases.Companion.configure(apiKey: String, builder: PurchasesConfiguration.Builder.() -> Unit = { }): Purchases

Configures an instance of the SDK with the specified configuration builder. The instance will be set as a singleton. You should access the singleton instance using sharedInstance.

parseAsWebPurchaseRedemption

actual fun parseAsWebPurchaseRedemption(url: String): <Error class: unknown class>?

expect fun parseAsWebPurchaseRedemption(url: String): <Error class: unknown class>?

Given a url string, parses it and returns a WebPurchaseRedemption, which can be used to redeem a web purchase using Purchases.redeemWebPurchase

actual fun parseAsWebPurchaseRedemption(url: String): <Error class: unknown class>?