purchases/com.revenuecat.purchases/Purchases

Purchases

Entry point for Purchases. It should be instantiated as soon as your app has a unique user id for your user. This can be when a user logs in if you have accounts or on launch if you can generate a random user identifier. Make sure you follow the quickstart guide to setup your RevenueCat account.

Types

Companion

object Companion

Functions

fun close()

Call close when you are done with this instance of Purchases

collectDeviceIdentifiers

fun collectDeviceIdentifiers()

Automatically collect subscriber attributes associated with the device identifiers $gpsAdId, $androidId, $ip

getCustomerInfo

fun getCustomerInfo(callback: ReceiveCustomerInfoCallback)

fun getCustomerInfo(fetchPolicy: CacheFetchPolicy, callback: ReceiveCustomerInfoCallback)

Get latest available purchaser info.

getNonSubscriptionSkus

fun getNonSubscriptionSkus(skus: List<String>, callback: GetStoreProductsCallback)

Gets the SKUDetails for the given list of non-subscription skus.

getOfferings

fun getOfferings(listener: ReceiveOfferingsCallback)

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.

getSubscriptionSkus

fun getSubscriptionSkus(skus: List<String>, callback: GetStoreProductsCallback)

Gets the StoreProduct for the given list of subscription skus.

invalidateCustomerInfoCache

fun invalidateCustomerInfoCache()

Invalidates the cache for customer information.

@JvmOverloads

fun logIn(newAppUserID: String, callback: LogInCallback? = null)

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

logOut

@JvmOverloads

fun logOut(callback: ReceiveCustomerInfoCallback? = null)

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

purchasePackage

fun purchasePackage( activity: Activity, packageToPurchase: Package, listener: PurchaseCallback)

Make a purchase.

fun purchasePackage( activity: Activity, packageToPurchase: Package, upgradeInfo: UpgradeInfo, callback: ProductChangeCallback)

Make a purchase upgrading from a previous sku.

purchaseProduct

fun purchaseProduct( activity: Activity, storeProduct: StoreProduct, callback: PurchaseCallback)

Make a purchase.

fun purchaseProduct( activity: Activity, storeProduct: StoreProduct, upgradeInfo: UpgradeInfo, listener: ProductChangeCallback)

Make a purchase upgrading from a previous sku.

removeUpdatedCustomerInfoListener

fun removeUpdatedCustomerInfoListener()

Call this when you are finished using the UpdatedCustomerInfoListener. You should call this to avoid memory leaks.

restorePurchases

fun restorePurchases(callback: ReceiveCustomerInfoCallback)

Restores purchases made with the current Play Store account for the current user. This method will post all purchases associated with the current Play 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.

setAd

fun setAd(ad: String?)

Subscriber attribute associated with the install ad for the user

setAdGroup

fun setAdGroup(adGroup: String?)

Subscriber attribute associated with the install ad group for the user

setAdjustID

fun setAdjustID(adjustID: String?)

Subscriber attribute associated with the Adjust Id for the user Required for the RevenueCat Adjust integration

setAirshipChannelID

fun setAirshipChannelID(airshipChannelID: String?)

Subscriber attribute associated with the Airship Channel ID Required for the RevenueCat Airship integration

setAppsflyerID

fun setAppsflyerID(appsflyerID: String?)

Subscriber attribute associated with the AppsFlyer Id for the user Required for the RevenueCat AppsFlyer integration

setAttributes

fun setAttributes(attributes: Map<String, String?>)

Subscriber attributes are useful for storing additional, structured information on a user. Since attributes are writable using a public key they should not be used for managing secure or sensitive information such as subscription status, coins, etc.

setCampaign

fun setCampaign(campaign: String?)

Subscriber attribute associated with the install campaign for the user

setCleverTapID

fun setCleverTapID(cleverTapID: String?)

Subscriber attribute associated with the CleverTap ID for the user Required for the RevenueCat CleverTap integration

setCreative

fun setCreative(creative: String?)

Subscriber attribute associated with the install ad creative for the user

setDisplayName

fun setDisplayName(displayName: String?)

Subscriber attribute associated with the display name for the user

setEmail

fun setEmail(email: String?)

Subscriber attribute associated with the Email address for the user

setFBAnonymousID

fun setFBAnonymousID(fbAnonymousID: String?)

Subscriber attribute associated with the Facebook SDK Anonymous Id for the user Recommended for the RevenueCat Facebook integration

setFirebaseAppInstanceID

fun setFirebaseAppInstanceID(firebaseAppInstanceID: String?)

Subscriber attribute associated with the Firebase App Instance ID for the user Required for the RevenueCat Firebase integration

setKeyword

fun setKeyword(keyword: String?)

Subscriber attribute associated with the install keyword for the user

setMediaSource

fun setMediaSource(mediaSource: String?)

Subscriber attribute associated with the install media source for the user

setMixpanelDistinctID

fun setMixpanelDistinctID(mixpanelDistinctID: String?)

Subscriber attribute associated with the Mixpanel Distinct ID for the user

setMparticleID

fun setMparticleID(mparticleID: String?)

Subscriber attribute associated with the mParticle Id for the user Recommended for the RevenueCat mParticle integration

setOnesignalID

fun setOnesignalID(onesignalID: String?)

Subscriber attribute associated with the OneSignal Player Id for the user Required for the RevenueCat OneSignal integration

setPhoneNumber

fun setPhoneNumber(phoneNumber: String?)

Subscriber attribute associated with the phone number for the user

setPushToken

fun setPushToken(fcmToken: String?)

Subscriber attribute associated with the push token for the user

syncObserverModeAmazonPurchase

fun syncObserverModeAmazonPurchase( productID: String, receiptID: String, amazonUserID: String, isoCurrencyCode: String?, price: Double?)

This method will send a purchase to the RevenueCat backend. This function should only be called if you are in Amazon observer mode or performing a client side migration of your current users to RevenueCat.

syncPurchases

fun syncPurchases()

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, like after a successful purchase, or when migrating existing users to RevenueCat

Properties

appUserID

@get:Synchronized

val appUserID: String

The passed in or generated app user ID

finishTransactions

@get:Synchronized

@set:Synchronized

var finishTransactions: Boolean

Default to TRUE, set this to FALSE if you are consuming and acknowledging transactions outside of the Purchases SDK.

isAnonymous

val isAnonymous: Boolean

If the appUserID has been generated by RevenueCat

updatedCustomerInfoListener

@get:Synchronized

@set:Synchronized

var updatedCustomerInfoListener: UpdatedCustomerInfoListener?

The listener is responsible for handling changes to customer information. Make sure removeUpdatedCustomerInfoListener is called when the listener needs to be destroyed.

Extensions

getCustomerInfoWith

fun Purchases.getCustomerInfoWith(onError: (error: PurchasesError) -> Unit = ON_ERROR_STUB, onSuccess: (customerInfo: CustomerInfo) -> Unit)

Get latest available customer info.

fun Purchases.getCustomerInfoWith( fetchPolicy: CacheFetchPolicy, onError: (error: PurchasesError) -> Unit = ON_ERROR_STUB, onSuccess: (customerInfo: CustomerInfo) -> Unit)

Get customer info from cache or network depending on fetch policy.

getNonSubscriptionSkusWith

fun Purchases.getNonSubscriptionSkusWith( skus: List<String>, onError: (error: PurchasesError) -> Unit, onReceiveSkus: (storeProducts: List<StoreProduct>) -> Unit)

Gets the SKUDetails for the given list of non-subscription skus.

getOfferingsWith

fun Purchases.getOfferingsWith(onError: (error: PurchasesError) -> Unit = ON_ERROR_STUB, onSuccess: (offerings: Offerings) -> Unit)

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.

getSubscriptionSkusWith

fun Purchases.getSubscriptionSkusWith( skus: List<String>, onError: (error: PurchasesError) -> Unit = ON_ERROR_STUB, onReceiveSkus: (storeProducts: List<StoreProduct>) -> Unit)

Gets the SKUDetails for the given list of subscription skus.

logInWith

fun Purchases.logInWith( appUserID: String, onError: (error: PurchasesError) -> Unit = ON_ERROR_STUB, onSuccess: (customerInfo: CustomerInfo, created: Boolean) -> Unit)

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

logOutWith

fun Purchases.logOutWith(onError: (error: PurchasesError) -> Unit = ON_ERROR_STUB, onSuccess: (customerInfo: CustomerInfo) -> Unit)

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

purchasePackageWith

fun Purchases.purchasePackageWith( activity: Activity, packageToPurchase: Package, upgradeInfo: UpgradeInfo, onError: (error: PurchasesError, userCancelled: Boolean) -> Unit = ON_PURCHASE_ERROR_STUB, onSuccess: (purchase: StoreTransaction?, customerInfo: CustomerInfo) -> Unit)

Make a purchase upgrading from a previous sku.

fun Purchases.purchasePackageWith( activity: Activity, packageToPurchase: Package, onError: (error: PurchasesError, userCancelled: Boolean) -> Unit = ON_PURCHASE_ERROR_STUB, onSuccess: (purchase: StoreTransaction, customerInfo: CustomerInfo) -> Unit)

Make a purchase.

purchaseProductWith

fun Purchases.purchaseProductWith( activity: Activity, storeProduct: StoreProduct, onError: (error: PurchasesError, userCancelled: Boolean) -> Unit = ON_PURCHASE_ERROR_STUB, onSuccess: (purchase: StoreTransaction, customerInfo: CustomerInfo) -> Unit)

Purchase product.

fun Purchases.purchaseProductWith( activity: Activity, storeProduct: StoreProduct, upgradeInfo: UpgradeInfo, onError: (error: PurchasesError, userCancelled: Boolean) -> Unit = ON_PURCHASE_ERROR_STUB, onSuccess: (purchase: StoreTransaction?, customerInfo: CustomerInfo) -> Unit)

Make a purchase upgrading from a previous sku.

restorePurchasesWith

fun Purchases.restorePurchasesWith(onError: (error: PurchasesError) -> Unit = ON_ERROR_STUB, onSuccess: (customerInfo: CustomerInfo) -> Unit)

Sources

androidJvm source