jchucomponents-pay/com.jeluchu.pay.revenuecat/Payment/Companion

Companion

object Companion

Properties

billingError

val billingError: StateFlow<PurchasesError>

billingInfo

val billingInfo: StateFlow<BillingInfo>

userId

val userId: String

Functions

getProducts

fun getProducts()

This function will be used to obtain all available products declared in RevenueCat. It is important that you have initialized the configuration from the function: Context.initPayment in your Application class.

isSubscriptionActive

fun isSubscriptionActive(onChecked: (Boolean, String) -> Unit = { _, _ -> })

Checks whether the user is subscribed or not.

loadBillingInfo

suspend fun loadBillingInfo(): BillingInfo

Loads the current RevenueCat offering and the user's subscription information as a suspendable operation.

purchase

fun purchase(context: Context, type: Payment.ProductsType, onSuccess: (Boolean, String) -> Unit = { _, _ -> }, onFailure: (PurchasesError, Boolean) -> Unit = { _, _ -> }): List<RevenueCatPackage>?

This function is used to make a purchase request for our products/subscriptions. Remember that in addition to having the products/offers declared in RevenueCat, you must also have them included in the Store.

purchaseResult

suspend fun purchaseResult(context: Context, type: Payment.ProductsType): Pair<Boolean, String>

Purchases a monthly or annual package using the configured RevenueCat offering.

restorePurchases

fun restorePurchases(onRestored: (Boolean, String) -> Unit = { _, _ -> })

Restoring purchases is a mechanism by which your user can restore their in-app purchases, reactivating any content that had previously been purchased from the same store account

restorePurchasesResult

suspend fun restorePurchasesResult(): Pair<Boolean, String>

Restores the purchases associated with the current store account.

setSubscriptionName

fun setSubscriptionName(name: String)

upgradeDownGrade

fun upgradeDownGrade(context: Context, onSuccess: (Boolean, String) -> Unit = { _, _ -> }, onFailure: (PurchasesError, Boolean) -> Unit = { _, _ -> })

If a person is already a subscriber, you can upgrade the subscription status from Annual to Monthly, or from Monthly to Annual. However, cancellations can only be made through the Store.