public/com.revenuecat.purchases

Package-level declarations

Types

data class CustomerInfo(val entitlements: EntitlementInfos, val allExpirationDatesByProduct: Map<String, Date?>, val allPurchaseDatesByProduct: Map<String, Date?>, val requestDate: Date, val schemaVersion: Int, val firstSeen: Date, val originalAppUserId: String, val managementURL: Uri?, val originalPurchaseDate: Date?, jsonObject: JSONObject) : Parcelable, RawDataContainer<JSONObject>

Class containing all information regarding the customer

DangerousSettings

data class DangerousSettings(val autoSyncPurchases: Boolean = true)

Only use a Dangerous Setting if suggested by RevenueCat support team.

EntitlementInfo

data class EntitlementInfo(val identifier: String, val isActive: Boolean, val willRenew: Boolean, val periodType: PeriodType, val latestPurchaseDate: Date, val originalPurchaseDate: Date, val expirationDate: Date?, val store: Store, val productIdentifier: String, val productPlanIdentifier: String?, val isSandbox: Boolean, val unsubscribeDetectedAt: Date?, val billingIssueDetectedAt: Date?, val ownershipType: OwnershipType, jsonObject: JSONObject, val verification: VerificationResult = VerificationResult.NOT_REQUESTED) : Parcelable, RawDataContainer<JSONObject>

This object gives you access to all of the information about the status of a user's entitlements.

EntitlementInfos

class EntitlementInfos(val all: Map<String, EntitlementInfo>, val verification: VerificationResult) : Parcelable

This class contains all the entitlements associated to the user.

EntitlementVerificationMode

enum EntitlementVerificationMode : Enum<EntitlementVerificationMode>

Verification strictness levels for EntitlementInfo.

ExperimentalPreviewRevenueCatPurchasesAPI

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

annotation class ExperimentalPreviewRevenueCatPurchasesAPI

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

LogHandler

interface LogHandler

Interface that allows handling logs manually. See also Purchases.logHandler

LogLevel

enum LogLevel : Enum<LogLevel>

Offering

data class Offering(val identifier: String, val serverDescription: String, val metadata: Map<String, Any>, val availablePackages: List<Package>)

An offering is a collection of Package available for the user to purchase. For more info see https://docs.revenuecat.com/docs/entitlements

Offerings

data class Offerings(val current: Offering?, val all: Map<String, Offering>)

This class contains all the offerings configured in RevenueCat dashboard. For more info see https://docs.revenuecat.com/docs/entitlements

OwnershipType

enum OwnershipType : Enum<OwnershipType>

Enum of supported ownership types for an entitlement.

Package

data class Package(val identifier: String, val packageType: PackageType, val product: StoreProduct, val offering: String)

Contains information about the product available for the user to purchase. For more info see https://docs.revenuecat.com/docs/entitlements

PackageType

enum PackageType : Enum<PackageType>

Enumeration of all possible Package types.

PeriodType

enum PeriodType : Enum<PeriodType>

Enum of supported period types for an entitlement.

ProductType

enum ProductType : Enum<ProductType>

ProrationMode

interface ProrationMode : Parcelable

Contains information about the proration mode to use in case of a product upgrade. Use the platform specific subclasses in each implementation.

PurchasesError

class PurchasesError(val code: PurchasesErrorCode, val underlyingErrorMessage: String? = null)

This class represents an error

PurchasesErrorCallback

typealias PurchasesErrorCallback = (PurchasesError) -> Unit

PurchasesErrorCode

enum PurchasesErrorCode : Enum<PurchasesErrorCode>

Store

enum Store : Enum<Store>

Enum of supported stores

VerificationResult

enum VerificationResult : Enum<VerificationResult>

The result of the verification process.