Skip to main content
Version: 8.11.x

bfgPurchaseObject Class

Data for a particular In-App Purchase. More...#import <bfgPurchaseObject.h>

Instance Methods

(BOOL) - isEqualToPurchaseObject:
 
(NSString *) - productId
 

Properties

NSDictionary * productInfo
 
BOOL canceled
 
SKPaymentTransaction * paymentTransaction
 
NSInteger quantity
 
BOOL restore
 
BOOL sandbox
 
BOOL success
 
NSError * error
 
NSData * iOS7Receipt
 

Detailed Description

Data for a particular In-App Purchase. Contains definitions for the following constants, which are keys to productInfo dictionaries:
  • PRODUCT_INFO_PRODUCT_ID
  • PRODUCT_INFO_PRICE
  • PRODUCT_INFO_PRICE_STR
  • PRODUCT_INFO_TITLE
  • PRODUCT_INFO_DESCRIPTION
  • PRODUCT_INFO_CURRENCY
  • MORE_INFO_EVENTDETAILS1
  • MORE_INFO_EVENTDETAILS2
  • MORE_INFO_EVENTDETAILS3
  • MORE_INFO_GAMEDATA

Method Documentation

◆ isEqualToPurchaseObject:

- (BOOL) isEqualToPurchaseObject: (bfgPurchaseObject *) other
Returns
YES if all fields are of equal value.

◆ productId

- (NSString *) productId
Returns
productId referenced by this purchaseObject. Derived from productInfo.

Property Documentation

◆ canceled

- (BOOL) canceled
readwritenonatomicassign
Returns
YES if purchase was actively canceled by the user.

◆ error

- (NSError*) error
readwritenonatomicstrong
Specific error associated with a failed purchase.

◆ iOS7Receipt

- (NSData*) iOS7Receipt
readwritenonatomiccopy
Holds the Apple iOS7+ receipt for this transaction.
Note
We hold on to this receipt in case we are dealing with the purchase of a consumable because the value could be purged from the receipt during a subsequent purchase.
Since
5.2

◆ paymentTransaction

- (SKPaymentTransaction*) paymentTransaction
readwritenonatomicstrong
Returns
The SKPaymentTransaction object associated with the current purchase / restore.
Since
4.7

◆ productInfo

- (NSDictionary*) productInfo
readwritenonatomicstrong
Contains meta-data on the purchase. Much of this data is populated when the product information is acquired (using [bfgPurchase acquireProductInfoForProducts:(NSSet *)productIds]).

◆ quantity

- (NSInteger) quantity
readwritenonatomicassign
Always set to 1 for the current implementation of the SDK.

◆ restore

- (BOOL) restore
readwritenonatomicassign
YES when a purchase is being re-downloaded (either due to a restore action or the purchase of a non-consumable that has previously been purchased).

◆ sandbox

- (BOOL) sandbox
readwritenonatomicassign
YES when a purchase / restore has been made with an iTunes test user.

◆ success

- (BOOL) success
readwritenonatomicassign
YES when a purchase / restore has been verified successfully.
Data for a particular In-App Purchase. More...#import <bfgPurchaseObject.h>

Instance Methods

(BOOL) - isEqualToPurchaseObject:
 
(NSString *) - productId
 

Properties

NSDictionary * productInfo
 
BOOL canceled
 
SKPaymentTransaction * paymentTransaction
 
NSInteger quantity
 
BOOL restore
 
BOOL sandbox
 
BOOL success
 
NSError * error
 
NSData * iOS7Receipt
 

Detailed Description

Data for a particular In-App Purchase. Contains definitions for the following constants, which are keys to productInfo dictionaries:
  • PRODUCT_INFO_PRODUCT_ID
  • PRODUCT_INFO_PRICE
  • PRODUCT_INFO_PRICE_STR
  • PRODUCT_INFO_TITLE
  • PRODUCT_INFO_DESCRIPTION
  • PRODUCT_INFO_CURRENCY
  • MORE_INFO_EVENTDETAILS1
  • MORE_INFO_EVENTDETAILS2
  • MORE_INFO_EVENTDETAILS3
  • MORE_INFO_GAMEDATA

Method Documentation

◆ isEqualToPurchaseObject:

- (BOOL) isEqualToPurchaseObject: (bfgPurchaseObject *) other
Returns
YES if all fields are of equal value.

◆ productId

- (NSString *) productId
Returns
productId referenced by this purchaseObject. Derived from productInfo.

Property Documentation

◆ canceled

- (BOOL) canceled
readwritenonatomicassign
Returns
YES if purchase was actively canceled by the user.

◆ error

- (NSError*) error
readwritenonatomicstrong
Specific error associated with a failed purchase.

◆ iOS7Receipt

- (NSData*) iOS7Receipt
readwritenonatomiccopy
Holds the Apple iOS7+ receipt for this transaction.
Note
We hold on to this receipt in case we are dealing with the purchase of a consumable because the value could be purged from the receipt during a subsequent purchase.
Since
5.2

◆ paymentTransaction

- (SKPaymentTransaction*) paymentTransaction
readwritenonatomicstrong
Returns
The SKPaymentTransaction object associated with the current purchase / restore.
Since
4.7

◆ productInfo

- (NSDictionary*) productInfo
readwritenonatomicstrong
Contains meta-data on the purchase. Much of this data is populated when the product information is acquired (using [bfgPurchase acquireProductInfoForProducts:(NSSet *)productIds]).

◆ quantity

- (NSInteger) quantity
readwritenonatomicassign
Always set to 1 for the current implementation of the SDK.

◆ restore

- (BOOL) restore
readwritenonatomicassign
YES when a purchase is being re-downloaded (either due to a restore action or the purchase of a non-consumable that has previously been purchased).

◆ sandbox

- (BOOL) sandbox
readwritenonatomicassign
YES when a purchase / restore has been made with an iTunes test user.

◆ success

- (BOOL) success
readwritenonatomicassign
YES when a purchase / restore has been verified successfully.