admanagekit-billing/com.i2hammad.admanagekit.billing/PurchaseResult

PurchaseResult

open class PurchaseResult

Represents the result of a purchase transaction with comprehensive details. This class wraps all information from Google Play Billing Library's Purchase object.

Constructors

constructor()

Default constructor for manual creation.

constructor(orderId: String, packageName: String, productIds: List<String>, purchaseTime: Long, purchaseState: Int, purchaseToken: String, quantity: Int, autoRenewing: Boolean, acknowledged: Boolean)

Legacy constructor for backward compatibility.

constructor(orderId: String, packageName: String, productIds: List<String>, purchaseTime: Long, purchaseState: Int, purchaseToken: String, quantity: Int, autoRenewing: Boolean, acknowledged: Boolean, originalJson: String, signature: String, obfuscatedAccountId: String, obfuscatedProfileId: String)

Full constructor with all fields.

Types

open class State

Purchase states from Google Play Billing.

SubscriptionState

enum SubscriptionState

Subscription lifecycle states.

Properties

open var consumedTime: Long

open var isConsumed: Boolean

obfuscatedAccountId

open var obfuscatedAccountId: String

obfuscatedProfileId

open var obfuscatedProfileId: String

open var orderId: String

open var originalJson: String

open var packageName: String

open var productIds: List<String>

open var productType: String

open var purchaseState: Int

open var purchaseTime: Long

open var purchaseToken: String

open var quantity: Int

open var signature: String

Functions

containsProduct

open fun containsProduct(productId: String): Boolean

Checks if this purchase contains a specific product ID.

open fun equals(o: Any): Boolean

open fun fromPurchase(@NonNull purchase: Purchase): PurchaseResult

Creates a PurchaseResult from a Google Play Purchase object.

getConsumedTimeFormatted

open fun getConsumedTimeFormatted(): String

Gets the consumed time as a formatted date string.

getFirstProductId

open fun getFirstProductId(): String

Gets the first (primary) product ID.

open fun ~~getProductId~~(): List<String>

getProductIdsString

open fun getProductIdsString(): String

Gets the product IDs as a comma-separated string.

getPurchaseDate

open fun getPurchaseDate(): Date

Gets the purchase time as a Date object.

getPurchaseStateString

open fun getPurchaseStateString(): String

Gets the purchase state as a readable string.

getPurchaseTimeFormatted

open fun getPurchaseTimeFormatted(): String

Gets the purchase time as a formatted date string in default format.

open fun getPurchaseTimeFormatted(pattern: String): String

Gets the purchase time as a formatted date string.

getSubscriptionState

open fun getSubscriptionState(): PurchaseResult.SubscriptionState

Gets the subscription state based on available client-side data.

getSubscriptionStateString

open fun getSubscriptionStateString(): String

Gets a human-readable subscription status string.

hasAccountIdentifiers

open fun hasAccountIdentifiers(): Boolean

Checks if account identifiers are available.

open fun hashCode(): Int

hasVerificationData

open fun hasVerificationData(): Boolean

Checks if this purchase has the necessary data for server-side verification.

open fun isAcknowledged(): Boolean

open fun isAutoRenewing(): Boolean

open fun isInApp(): Boolean

Checks if this is an in-app (one-time) purchase.

open fun isPending(): Boolean

Checks if the purchase is in PENDING state.

open fun isPurchased(): Boolean

Checks if the purchase is in PURCHASED state.

open fun isSubscription(): Boolean

Checks if this is a subscription purchase.

isSubscriptionActive

open fun isSubscriptionActive(): Boolean

Checks if the subscription is active (user has access).

isSubscriptionCancelled

open fun isSubscriptionCancelled(): Boolean

Checks if the user cancelled their subscription.

open fun markAsConsumed()

Marks this purchase as consumed.

setAcknowledged

open fun setAcknowledged(acknowledged: Boolean)

setAutoRenewing

open fun setAutoRenewing(autoRenewing: Boolean)

open fun ~~setProductId~~(productIds: List<String>)

open fun toString(): String

willSubscriptionRenew

open fun willSubscriptionRenew(): Boolean

Checks if the subscription will renew.