core/com.revenuecat.purchases.kmp.ktx

Package-level declarations

Types

class SuccessfulLogin(val customerInfo: <Error class: unknown class>, val created: Boolean)

The result of a successful login operation. Used in coroutines.

class SuccessfulPurchase(val storeTransaction: <Error class: unknown class>, val customerInfo: <Error class: unknown class>)

The result of a successful purchase operation. Used in coroutines.

Functions

awaitCustomerInfo

suspend fun Purchases.awaitCustomerInfo(fetchPolicy: <Error class: unknown class> = CacheFetchPolicy.default()): <Error class: unknown class>

Get the latest available customer info.

awaitGetProducts

suspend fun Purchases.awaitGetProducts(productIds: List<String>): List<<Error class: unknown class>>

Gets the StoreProducts for the given list of product ids for all product types.

awaitLogIn

suspend fun Purchases.awaitLogIn(newAppUserID: String): SuccessfulLogin

This function will change the current Purchases.appUserID. Typically this would be used after a log out to identify a new user without calling Purchases.configure.

awaitLogOut

suspend fun Purchases.awaitLogOut(): <Error class: unknown class>

Resets the Purchases client clearing the save Purchases.appUserID. This will generate a random user id and save it in the cache.

awaitOfferings

suspend fun Purchases.awaitOfferings(): <Error class: unknown class>

Fetch the configured offerings for this users. Offerings allows you to configure your in-app products vis RevenueCat and greatly simplifies management. See the guide for more info.

awaitPromotionalOffer

suspend fun Purchases.awaitPromotionalOffer(discount: <Error class: unknown class>, storeProduct: <Error class: unknown class>): <Error class: unknown class>

App Store only. Use this method to fetch a PromotionalOffer to use with awaitPurchase.

awaitPurchase

suspend fun Purchases.awaitPurchase(packageToPurchase: <Error class: unknown class>, promotionalOffer: <Error class: unknown class>): SuccessfulPurchase

App Store only. Purchases packageToPurchase. Call this method when a user has decided to purchase a product with an applied discount. Only call this in direct response to user input. From here Purchases will handle the purchase with StoreKit.

suspend fun Purchases.awaitPurchase(storeProduct: <Error class: unknown class>, promotionalOffer: <Error class: unknown class>): SuccessfulPurchase

App Store only. Use this function if you are not using the Offerings system to purchase a StoreProduct with an applied PromotionalOffer. If you are using the Offerings system, use the overload with a Package parameter instead.

suspend fun Purchases.awaitPurchase(packageToPurchase: <Error class: unknown class>, isPersonalizedPrice: Boolean? = null, oldProductId: String? = null, replacementMode: <Error class: unknown class> = GoogleReplacementMode.WITHOUT_PRORATION): SuccessfulPurchase

Purchases packageToPurchase. On the Play Store, if packageToPurchase represents a subscription, upgrades from the subscription specified by oldProductId and chooses the default SubscriptionOption from packageToPurchase.

suspend fun Purchases.awaitPurchase(storeProduct: <Error class: unknown class>, isPersonalizedPrice: Boolean? = null, oldProductId: String? = null, replacementMode: <Error class: unknown class> = GoogleReplacementMode.WITHOUT_PRORATION): SuccessfulPurchase

Purchases storeProduct. On the Play Store, if storeProduct represents a subscription, upgrades from the subscription specified by oldProductId and chooses storeProduct's default SubscriptionOption.

suspend fun Purchases.awaitPurchase(subscriptionOption: <Error class: unknown class>, isPersonalizedPrice: Boolean? = null, oldProductId: String? = null, replacementMode: <Error class: unknown class> = GoogleReplacementMode.WITHOUT_PRORATION): SuccessfulPurchase

Play Store only. Purchases subscriptionOption.

awaitRestore

suspend fun Purchases.awaitRestore(): <Error class: unknown class>

Restores purchases made with the current Store account for the current user. This method will post all purchases associated with the current Store account to RevenueCat and become associated with the current appUserID. If the receipt token is being used by an existing user, the current appUserID will be aliased together with the appUserID of the existing user. Going forward, either appUserID will be able to reference the same user.

awaitSyncAttributesAndOfferingsIfNeeded

suspend fun Purchases.awaitSyncAttributesAndOfferingsIfNeeded(): <Error class: unknown class>

Syncs subscriber attributes and then fetches the configured offerings for this user. This method is intended to be called when using Targeting Rules with Custom Attributes. Any subscriber attributes should be set before calling this method to ensure the returned offerings are applied with the latest subscriber attributes.

awaitSyncPurchases

suspend fun Purchases.awaitSyncPurchases(): <Error class: unknown class>

This method will send all the purchases to the RevenueCat backend. Call this when using your own implementation for subscriptions anytime a sync is needed, such as when migrating existing users to RevenueCat.